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