Merge from vendor branch GCC:
[dragonfly.git] / contrib / bind-9.2.4rc7 / lib / bind / include / resolv.h
1 /*
2  * Copyright (c) 1983, 1987, 1989
3  *    The Regents of the University of California.  All rights reserved.
4  * 
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *      This product includes software developed by the University of
16  *      California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  * 
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33
34 /*
35  * Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC")
36  * Portions Copyright (c) 1996-1999 by Internet Software Consortium.
37  *
38  * Permission to use, copy, modify, and distribute this software for any
39  * purpose with or without fee is hereby granted, provided that the above
40  * copyright notice and this permission notice appear in all copies.
41  *
42  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES
43  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
44  * MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR
45  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
46  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
47  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
48  * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
49  */
50
51 /*
52  *      @(#)resolv.h    8.1 (Berkeley) 6/2/93
53  *      $Id: resolv.h,v 1.7.2.13 2004/06/25 00:39:31 marka Exp $
54  */
55
56 #ifndef _RESOLV_H_
57 #define _RESOLV_H_
58
59 #include <sys/param.h>
60 #if (!defined(BSD)) || (BSD < 199306)
61 # include <sys/bitypes.h>
62 #else
63 # include <sys/types.h>
64 #endif
65 #include <sys/cdefs.h>
66 #include <sys/socket.h>
67 #include <stdio.h>
68 #include <arpa/nameser.h>
69
70 /*
71  * Revision information.  This is the release date in YYYYMMDD format.
72  * It can change every day so the right thing to do with it is use it
73  * in preprocessor commands such as "#if (__RES > 19931104)".  Do not
74  * compare for equality; rather, use it to determine whether your resolver
75  * is new enough to contain a certain feature.
76  */
77
78 #define __RES   20030124
79
80 /*
81  * This used to be defined in res_query.c, now it's in herror.c.
82  * [XXX no it's not.  It's in irs/irs_data.c]
83  * It was
84  * never extern'd by any *.h file before it was placed here.  For thread
85  * aware programs, the last h_errno value set is stored in res->h_errno.
86  *
87  * XXX: There doesn't seem to be a good reason for exposing RES_SET_H_ERRNO
88  *      (and __h_errno_set) to the public via <resolv.h>.
89  * XXX: __h_errno_set is really part of IRS, not part of the resolver.
90  *      If somebody wants to build and use a resolver that doesn't use IRS,
91  *      what do they do?  Perhaps something like
92  *              #ifdef WANT_IRS
93  *              # define RES_SET_H_ERRNO(r,x) __h_errno_set(r,x)
94  *              #else
95  *              # define RES_SET_H_ERRNO(r,x) (h_errno = (r)->res_h_errno = (x))
96  *              #endif
97  */
98
99 #define RES_SET_H_ERRNO(r,x) __h_errno_set(r,x)
100 struct __res_state; /* forward */
101 __BEGIN_DECLS
102 void __h_errno_set(struct __res_state *res, int err);
103 __END_DECLS
104
105 /*
106  * Resolver configuration file.
107  * Normally not present, but may contain the address of the
108  * initial name server(s) to query and the domain search list.
109  */
110
111 #ifndef _PATH_RESCONF
112 #define _PATH_RESCONF        "/etc/resolv.conf"
113 #endif
114
115 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
116         res_sendhookact;
117
118 #ifndef __PMT
119 #if defined(__STDC__) || defined(__cplusplus)
120 #define __PMT(args) args
121 #else
122 #define __PMT(args) ()
123 #endif
124 #endif
125
126 typedef res_sendhookact (*res_send_qhook)__PMT((struct sockaddr * const *,
127                                                 const u_char **, int *,
128                                                 u_char *, int, int *));
129
130 typedef res_sendhookact (*res_send_rhook)__PMT((const struct sockaddr *,
131                                                 const u_char *, int, u_char *,
132                                                 int, int *));
133
134 struct res_sym {
135         int             number;    /* Identifying number, like T_MX */
136         const char *    name;      /* Its symbolic name, like "MX" */
137         const char *    humanname; /* Its fun name, like "mail exchanger" */
138 };
139
140 /*
141  * Global defines and variables for resolver stub.
142  */
143 #define MAXNS                   3       /* max # name servers we'll track */
144 #define MAXDFLSRCH              3       /* # default domain levels to try */
145 #define MAXDNSRCH               6       /* max # domains in search path */
146 #define LOCALDOMAINPARTS        2       /* min levels in name that is "local" */
147
148 #define RES_TIMEOUT             5       /* min. seconds between retries */
149 #define MAXRESOLVSORT           10      /* number of net to sort on */
150 #define RES_MAXNDOTS            15      /* should reflect bit field size */
151 #define RES_MAXRETRANS          30      /* only for resolv.conf/RES_OPTIONS */
152 #define RES_MAXRETRY            5       /* only for resolv.conf/RES_OPTIONS */
153 #define RES_DFLRETRY            2       /* Default #/tries. */
154 #define RES_MAXTIME             65535   /* Infinity, in milliseconds. */
155
156 struct __res_state_ext;
157
158 struct __res_state {
159         int     retrans;                /* retransmission time interval */
160         int     retry;                  /* number of times to retransmit */
161 #ifdef sun
162         u_int   options;                /* option flags - see below. */
163 #else
164         u_long  options;                /* option flags - see below. */
165 #endif
166         int     nscount;                /* number of name servers */
167         struct sockaddr_in
168                 nsaddr_list[MAXNS];     /* address of name server */
169 #define nsaddr  nsaddr_list[0]          /* for backward compatibility */
170         u_short id;                     /* current message id */
171         char    *dnsrch[MAXDNSRCH+1];   /* components of domain to search */
172         char    defdname[256];          /* default domain (deprecated) */
173 #ifdef sun
174         u_int   pfcode;                 /* RES_PRF_ flags - see below. */
175 #else
176         u_long  pfcode;                 /* RES_PRF_ flags - see below. */
177 #endif
178         unsigned ndots:4;               /* threshold for initial abs. query */
179         unsigned nsort:4;               /* number of elements in sort_list[] */
180         char    unused[3];
181         struct {
182                 struct in_addr  addr;
183                 u_int32_t       mask;
184         } sort_list[MAXRESOLVSORT];
185         res_send_qhook qhook;           /* query hook */
186         res_send_rhook rhook;           /* response hook */
187         int     res_h_errno;            /* last one set for this context */
188         int     _vcsock;                /* PRIVATE: for res_send VC i/o */
189         u_int   _flags;                 /* PRIVATE: see below */
190         u_int   _pad;                   /* make _u 64 bit aligned */
191         union {
192                 /* On an 32-bit arch this means 512b total. */
193                 char    pad[72 - 4*sizeof (int) - 2*sizeof (void *)];
194                 struct {
195                         u_int16_t               nscount;
196                         u_int16_t               nstimes[MAXNS]; /* ms. */
197                         int                     nssocks[MAXNS];
198                         struct __res_state_ext *ext;    /* extention for IPv6 */
199                 } _ext;
200         } _u;
201 };
202
203 typedef struct __res_state *res_state;
204
205 union res_sockaddr_union {
206         struct sockaddr_in      sin;
207 #ifdef IN6ADDR_ANY_INIT
208         struct sockaddr_in6     sin6;
209 #endif
210 #ifdef ISC_ALIGN64
211         int64_t                 __align64;      /* 64bit alignment */
212 #else
213         int32_t                 __align32;      /* 32bit alignment */
214 #endif
215         char                    __space[128];   /* max size */
216 };
217
218 /*
219  * Resolver flags (used to be discrete per-module statics ints).
220  */
221 #define RES_F_VC        0x00000001      /* socket is TCP */
222 #define RES_F_CONN      0x00000002      /* socket is connected */
223 #define RES_F_EDNS0ERR  0x00000004      /* EDNS0 caused errors */
224 #define RES_F__UNUSED   0x00000008      /* (unused) */
225 #define RES_F_LASTMASK  0x000000F0      /* ordinal server of last res_nsend */
226 #define RES_F_LASTSHIFT 4               /* bit position of LASTMASK "flag" */
227 #define RES_GETLAST(res) (((res)._flags & RES_F_LASTMASK) >> RES_F_LASTSHIFT)
228
229 /* res_findzonecut2() options */
230 #define RES_EXHAUSTIVE  0x00000001      /* always do all queries */
231 #define RES_IPV4ONLY    0x00000002      /* IPv4 only */
232 #define RES_IPV6ONLY    0x00000004      /* IPv6 only */
233
234 /*
235  * Resolver options (keep these in synch with res_debug.c, please)
236  */
237 #define RES_INIT        0x00000001      /* address initialized */
238 #define RES_DEBUG       0x00000002      /* print debug messages */
239 #define RES_AAONLY      0x00000004      /* authoritative answers only (!IMPL)*/
240 #define RES_USEVC       0x00000008      /* use virtual circuit */
241 #define RES_PRIMARY     0x00000010      /* query primary server only (!IMPL) */
242 #define RES_IGNTC       0x00000020      /* ignore trucation errors */
243 #define RES_RECURSE     0x00000040      /* recursion desired */
244 #define RES_DEFNAMES    0x00000080      /* use default domain name */
245 #define RES_STAYOPEN    0x00000100      /* Keep TCP socket open */
246 #define RES_DNSRCH      0x00000200      /* search up local domain tree */
247 #define RES_INSECURE1   0x00000400      /* type 1 security disabled */
248 #define RES_INSECURE2   0x00000800      /* type 2 security disabled */
249 #define RES_NOALIASES   0x00001000      /* shuts off HOSTALIASES feature */
250 #define RES_USE_INET6   0x00002000      /* use/map IPv6 in gethostbyname() */
251 #define RES_ROTATE      0x00004000      /* rotate ns list after each query */
252 #define RES_NOCHECKNAME 0x00008000      /* do not check names for sanity. */
253 #define RES_KEEPTSIG    0x00010000      /* do not strip TSIG records */
254 #define RES_BLAST       0x00020000      /* blast all recursive servers */
255 #define RES_NOTLDQUERY  0x00100000      /* don't unqualified name as a tld */
256 #define RES_USE_DNSSEC  0x00200000      /* use DNSSEC using OK bit in OPT */
257 /* #define RES_DEBUG2   0x00400000 */   /* nslookup internal */
258 /* KAME extensions: use higher bit to avoid conflict with ISC use */
259 #define RES_USE_DNAME   0x10000000      /* use DNAME */
260 #define RES_USE_EDNS0   0x40000000      /* use EDNS0 if configured */
261 #define RES_NO_NIBBLE2  0x80000000      /* disable alternate nibble lookup */
262
263 #define RES_DEFAULT     (RES_RECURSE | RES_DEFNAMES | \
264                          RES_DNSRCH | RES_NO_NIBBLE2)
265
266 /*
267  * Resolver "pfcode" values.  Used by dig.
268  */
269 #define RES_PRF_STATS   0x00000001
270 #define RES_PRF_UPDATE  0x00000002
271 #define RES_PRF_CLASS   0x00000004
272 #define RES_PRF_CMD     0x00000008
273 #define RES_PRF_QUES    0x00000010
274 #define RES_PRF_ANS     0x00000020
275 #define RES_PRF_AUTH    0x00000040
276 #define RES_PRF_ADD     0x00000080
277 #define RES_PRF_HEAD1   0x00000100
278 #define RES_PRF_HEAD2   0x00000200
279 #define RES_PRF_TTLID   0x00000400
280 #define RES_PRF_HEADX   0x00000800
281 #define RES_PRF_QUERY   0x00001000
282 #define RES_PRF_REPLY   0x00002000
283 #define RES_PRF_INIT    0x00004000
284 #define RES_PRF_TRUNC   0x00008000
285 /*                      0x00010000      */
286
287 /* Things involving an internal (static) resolver context. */
288 #ifdef _REENTRANT
289 __BEGIN_DECLS
290 extern struct __res_state *__res_state(void);
291 __END_DECLS
292 #define _res (*__res_state())
293 #else
294 #ifndef __BIND_NOSTATIC
295 extern struct __res_state _res;
296 #endif
297 #endif
298
299 #ifndef __BIND_NOSTATIC
300 #define fp_nquery               __fp_nquery
301 #define fp_query                __fp_query
302 #define hostalias               __hostalias
303 #define p_query                 __p_query
304 #define res_close               __res_close
305 #define res_init                __res_init
306 #define res_isourserver         __res_isourserver
307 #define res_mkquery             __res_mkquery
308 #define res_query               __res_query
309 #define res_querydomain         __res_querydomain
310 #define res_search              __res_search
311 #define res_send                __res_send
312 #define res_sendsigned          __res_sendsigned
313
314 __BEGIN_DECLS
315 void            fp_nquery __P((const u_char *, int, FILE *));
316 void            fp_query __P((const u_char *, FILE *));
317 const char *    hostalias __P((const char *));
318 void            p_query __P((const u_char *));
319 void            res_close __P((void));
320 int             res_init __P((void));
321 int             res_isourserver __P((const struct sockaddr_in *));
322 int             res_mkquery __P((int, const char *, int, int, const u_char *,
323                                  int, const u_char *, u_char *, int));
324 int             res_query __P((const char *, int, int, u_char *, int));
325 int             res_querydomain __P((const char *, const char *, int, int,
326                                      u_char *, int));
327 int             res_search __P((const char *, int, int, u_char *, int));
328 int             res_send __P((const u_char *, int, u_char *, int));
329 int             res_sendsigned __P((const u_char *, int, ns_tsig_key *,
330                                     u_char *, int));
331 __END_DECLS
332 #endif
333
334 #if !defined(SHARED_LIBBIND) || defined(LIB)
335 /*
336  * If libbind is a shared object (well, DLL anyway)
337  * these externs break the linker when resolv.h is 
338  * included by a lib client (like named)
339  * Make them go away if a client is including this
340  *
341  */
342 extern const struct res_sym __p_key_syms[];
343 extern const struct res_sym __p_cert_syms[];
344 extern const struct res_sym __p_class_syms[];
345 extern const struct res_sym __p_type_syms[];
346 extern const struct res_sym __p_rcode_syms[];
347 #endif /* SHARED_LIBBIND */
348
349 #define b64_ntop                __b64_ntop
350 #define b64_pton                __b64_pton
351 #define dn_comp                 __dn_comp
352 #define dn_count_labels         __dn_count_labels
353 #define dn_expand               __dn_expand
354 #define dn_skipname             __dn_skipname
355 #define fp_resstat              __fp_resstat
356 #define loc_aton                __loc_aton
357 #define loc_ntoa                __loc_ntoa
358 #define p_cdname                __p_cdname
359 #define p_cdnname               __p_cdnname
360 #define p_class                 __p_class
361 #define p_fqname                __p_fqname
362 #define p_fqnname               __p_fqnname
363 #define p_option                __p_option
364 #define p_secstodate            __p_secstodate
365 #define p_section               __p_section
366 #define p_time                  __p_time
367 #define p_type                  __p_type
368 #define p_rcode                 __p_rcode
369 #define p_sockun                __p_sockun
370 #define putlong                 __putlong
371 #define putshort                __putshort
372 #define res_dnok                __res_dnok
373 #define res_findzonecut         __res_findzonecut
374 #define res_findzonecut2        __res_findzonecut2
375 #define res_hnok                __res_hnok
376 #define res_hostalias           __res_hostalias
377 #define res_mailok              __res_mailok
378 #define res_nameinquery         __res_nameinquery
379 #define res_nclose              __res_nclose
380 #define res_ninit               __res_ninit
381 #define res_nmkquery            __res_nmkquery
382 #define res_pquery              __res_pquery
383 #define res_nquery              __res_nquery
384 #define res_nquerydomain        __res_nquerydomain
385 #define res_nsearch             __res_nsearch
386 #define res_nsend               __res_nsend
387 #define res_nsendsigned         __res_nsendsigned
388 #define res_nisourserver        __res_nisourserver
389 #define res_ownok               __res_ownok
390 #define res_queriesmatch        __res_queriesmatch
391 #define res_randomid            __res_randomid
392 #define sym_ntop                __sym_ntop
393 #define sym_ntos                __sym_ntos
394 #define sym_ston                __sym_ston
395 #define res_nopt                __res_nopt
396 #define res_ndestroy            __res_ndestroy
397 #define res_nametoclass         __res_nametoclass
398 #define res_nametotype          __res_nametotype
399 #define res_setservers          __res_setservers
400 #define res_getservers          __res_getservers
401 #define res_buildprotolist      __res_buildprotolist
402 #define res_destroyprotolist    __res_destroyprotolist
403 #define res_destroyservicelist  __res_destroyservicelist
404 #define res_get_nibblesuffix    __res_get_nibblesuffix
405 #define res_get_nibblesuffix2   __res_get_nibblesuffix2
406 #define res_ourserver_p         __res_ourserver_p
407 #define res_protocolname        __res_protocolname
408 #define res_protocolnumber      __res_protocolnumber
409 #define res_send_setqhook       __res_send_setqhook
410 #define res_send_setrhook       __res_send_setrhook
411 #define res_servicename         __res_servicename
412 #define res_servicenumber       __res_servicenumber
413 __BEGIN_DECLS
414 int             res_hnok __P((const char *));
415 int             res_ownok __P((const char *));
416 int             res_mailok __P((const char *));
417 int             res_dnok __P((const char *));
418 int             sym_ston __P((const struct res_sym *, const char *, int *));
419 const char *    sym_ntos __P((const struct res_sym *, int, int *));
420 const char *    sym_ntop __P((const struct res_sym *, int, int *));
421 int             b64_ntop __P((u_char const *, size_t, char *, size_t));
422 int             b64_pton __P((char const *, u_char *, size_t));
423 int             loc_aton __P((const char *, u_char *));
424 const char *    loc_ntoa __P((const u_char *, char *));
425 int             dn_skipname __P((const u_char *, const u_char *));
426 void            putlong __P((u_int32_t, u_char *));
427 void            putshort __P((u_int16_t, u_char *));
428 #ifndef __ultrix__
429 u_int16_t       _getshort __P((const u_char *));
430 u_int32_t       _getlong __P((const u_char *));
431 #endif
432 const char *    p_class __P((int));
433 const char *    p_time __P((u_int32_t));
434 const char *    p_type __P((int));
435 const char *    p_rcode __P((int));
436 const char *    p_sockun __P((union res_sockaddr_union, char *, size_t));
437 const u_char *  p_cdnname __P((const u_char *, const u_char *, int, FILE *));
438 const u_char *  p_cdname __P((const u_char *, const u_char *, FILE *));
439 const u_char *  p_fqnname __P((const u_char *, const u_char *,
440                                int, char *, int));
441 const u_char *  p_fqname __P((const u_char *, const u_char *, FILE *));
442 const char *    p_option __P((u_long));
443 char *          p_secstodate __P((u_long));
444 int             dn_count_labels __P((const char *));
445 int             dn_comp __P((const char *, u_char *, int,
446                              u_char **, u_char **));
447 int             dn_expand __P((const u_char *, const u_char *, const u_char *,
448                                char *, int));
449 u_int           res_randomid __P((void));
450 int             res_nameinquery __P((const char *, int, int, const u_char *,
451                                      const u_char *));
452 int             res_queriesmatch __P((const u_char *, const u_char *,
453                                       const u_char *, const u_char *));
454 const char *    p_section __P((int, int));
455 /* Things involving a resolver context. */
456 int             res_ninit __P((res_state));
457 int             res_nisourserver __P((const res_state,
458                                       const struct sockaddr_in *));
459 void            fp_resstat __P((const res_state, FILE *));
460 void            res_pquery __P((const res_state, const u_char *, int, FILE *));
461 const char *    res_hostalias __P((const res_state, const char *,
462                                    char *, size_t));
463 int             res_nquery __P((res_state, const char *, int, int,
464                                 u_char *, int));
465 int             res_nsearch __P((res_state, const char *, int, int, u_char *,
466                                  int));
467 int             res_nquerydomain __P((res_state, const char *, const char *,
468                                       int, int, u_char *, int));
469 int             res_nmkquery __P((res_state, int, const char *, int, int,
470                                   const u_char *, int, const u_char *,
471                                   u_char *, int));
472 int             res_nsend __P((res_state, const u_char *, int, u_char *, int));
473 int             res_nsendsigned __P((res_state, const u_char *, int,
474                                      ns_tsig_key *, u_char *, int));
475 int             res_findzonecut __P((res_state, const char *, ns_class, int,
476                                      char *, size_t, struct in_addr *, int));
477 int             res_findzonecut2 __P((res_state, const char *, ns_class, int,
478                                       char *, size_t,
479                                       union res_sockaddr_union *, int));
480 void            res_nclose __P((res_state));
481 int             res_nopt __P((res_state, int, u_char *, int, int));
482 void            res_send_setqhook __P((res_send_qhook));
483 void            res_send_setrhook __P((res_send_rhook));
484 int             __res_vinit __P((res_state, int));
485 void            res_destroyservicelist __P((void));
486 const char *    res_servicename __P((u_int16_t, const char *));
487 const char *    res_protocolname __P((int));
488 void            res_destroyprotolist __P((void));
489 void            res_buildprotolist __P((void));
490 const char *    res_get_nibblesuffix __P((res_state));
491 const char *    res_get_nibblesuffix2 __P((res_state));
492 void            res_ndestroy __P((res_state));
493 u_int16_t       res_nametoclass __P((const char *, int *));
494 u_int16_t       res_nametotype __P((const char *, int *));
495 void            res_setservers __P((res_state,
496                                     const union res_sockaddr_union *, int));
497 int             res_getservers __P((res_state,
498                                     union res_sockaddr_union *, int));
499 __END_DECLS
500
501 #endif /* !_RESOLV_H_ */