]> git.ipfire.org Git - thirdparty/glibc.git/blame - resolv/resolv.h
* sysdeps/generic/bits/ustat.h: Comment fix.
[thirdparty/glibc.git] / resolv / resolv.h
CommitLineData
28f540f4 1/*
e685e07d 2 * Copyright (c) 1983, 1987, 1989
28f540f4 3 * The Regents of the University of California. All rights reserved.
835bf8e0 4 *
28f540f4
RM
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.
28f540f4
RM
13 * 4. Neither the name of the University nor the names of its contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
835bf8e0 16 *
28f540f4
RM
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28f540f4
RM
28 */
29
b43b13ac
UD
30/*
31 * Portions Copyright (c) 1996-1999 by Internet Software Consortium.
32 *
33 * Permission to use, copy, modify, and distribute this software for any
34 * purpose with or without fee is hereby granted, provided that the above
35 * copyright notice and this permission notice appear in all copies.
36 *
37 * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
38 * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
39 * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
40 * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
41 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
42 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
43 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
44 * SOFTWARE.
45 */
46
28f540f4
RM
47/*
48 * @(#)resolv.h 8.1 (Berkeley) 6/2/93
e685e07d 49 * $BINDId: resolv.h,v 8.31 2000/03/30 20:16:50 vixie Exp $
28f540f4
RM
50 */
51
e685e07d 52#ifndef _RESOLV_H_
535b764d
UD
53#ifndef __need_res_state
54# define _RESOLV_H_
a5a0310d 55
535b764d
UD
56# include <sys/param.h>
57# if (!defined(BSD)) || (BSD < 199306)
58# include <sys/bitypes.h>
59# else
60# include <sys/types.h>
61# endif
62# include <sys/cdefs.h>
63# include <stdio.h>
64# include <arpa/nameser.h>
28f540f4 65#endif
e685e07d 66
a5a0310d 67#include <netinet/in.h>
28f540f4 68
535b764d
UD
69#ifndef __res_state_defined
70# define __res_state_defined
28f540f4 71
b43b13ac
UD
72typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
73 res_sendhookact;
74
3452aba8
UD
75typedef res_sendhookact (*res_send_qhook) (struct sockaddr_in * const *ns,
76 const u_char **query,
77 int *querylen,
78 u_char *ans,
79 int anssiz,
80 int *resplen);
b43b13ac 81
3452aba8
UD
82typedef res_sendhookact (*res_send_rhook) (const struct sockaddr_in *ns,
83 const u_char *query,
84 int querylen,
85 u_char *ans,
86 int anssiz,
87 int *resplen);
b43b13ac 88
28f540f4
RM
89/*
90 * Global defines and variables for resolver stub.
91 */
535b764d
UD
92# define MAXNS 3 /* max # name servers we'll track */
93# define MAXDFLSRCH 3 /* # default domain levels to try */
94# define MAXDNSRCH 6 /* max # domains in search path */
95# define LOCALDOMAINPARTS 2 /* min levels in name that is "local" */
28f540f4 96
535b764d
UD
97# define RES_TIMEOUT 5 /* min. seconds between retries */
98# define MAXRESOLVSORT 10 /* number of net to sort on */
99# define RES_MAXNDOTS 15 /* should reflect bit field size */
100# define RES_MAXRETRANS 30 /* only for resolv.conf/RES_OPTIONS */
101# define RES_MAXRETRY 5 /* only for resolv.conf/RES_OPTIONS */
102# define RES_DFLRETRY 2 /* Default #/tries. */
103# define RES_MAXTIME 65535 /* Infinity, in milliseconds. */
28f540f4
RM
104
105struct __res_state {
e685e07d 106 int retrans; /* retransmition time interval */
28f540f4
RM
107 int retry; /* number of times to retransmit */
108 u_long options; /* option flags - see below. */
109 int nscount; /* number of name servers */
110 struct sockaddr_in
111 nsaddr_list[MAXNS]; /* address of name server */
535b764d 112# define nsaddr nsaddr_list[0] /* for backward compatibility */
1f64ac13 113 u_short id; /* current message id */
28f540f4 114 char *dnsrch[MAXDNSRCH+1]; /* components of domain to search */
845dcb57 115 char defdname[256]; /* default domain (deprecated) */
28f540f4
RM
116 u_long pfcode; /* RES_PRF_ flags - see below. */
117 unsigned ndots:4; /* threshold for initial abs. query */
118 unsigned nsort:4; /* number of elements in sort_list[] */
119 char unused[3];
120 struct {
121 struct in_addr addr;
122 u_int32_t mask;
123 } sort_list[MAXRESOLVSORT];
b43b13ac
UD
124 res_send_qhook qhook; /* query hook */
125 res_send_rhook rhook; /* response hook */
126 int res_h_errno; /* last one set for this context */
e685e07d 127 int _vcsock; /* PRIVATE: for res_send VC i/o */
b43b13ac 128 u_int _flags; /* PRIVATE: see below */
e685e07d
UD
129 union {
130 char pad[52]; /* On an i386 this means 512b total. */
131 struct {
132 u_int16_t nscount;
b64e1566 133 u_int16_t nsmap[MAXNS];
e685e07d 134 int nssocks[MAXNS];
438e8239 135 u_int16_t nscount6;
03fbfeb5 136 u_int16_t nsinit;
438e8239 137 struct sockaddr_in6 *nsaddrs[MAXNS];
e685e07d
UD
138 } _ext;
139 } _u;
28f540f4
RM
140};
141
b43b13ac 142typedef struct __res_state *res_state;
535b764d
UD
143# undef __need_res_state
144#endif
145
146#ifdef _RESOLV_H_
147/*
148 * Revision information. This is the release date in YYYYMMDD format.
149 * It can change every day so the right thing to do with it is use it
150 * in preprocessor commands such as "#if (__RES > 19931104)". Do not
151 * compare for equality; rather, use it to determine whether your resolver
152 * is new enough to contain a certain feature.
153 */
154
155#define __RES 19991006
156
157/*
158 * Resolver configuration file.
159 * Normally not present, but may contain the address of the
160 * inital name server(s) to query and the domain search list.
161 */
162
163#ifndef _PATH_RESCONF
164#define _PATH_RESCONF "/etc/resolv.conf"
165#endif
166
167struct res_sym {
168 int number; /* Identifying number, like T_MX */
169 char * name; /* Its symbolic name, like "MX" */
170 char * humanname; /* Its fun name, like "mail exchanger" */
171};
b43b13ac
UD
172
173/*
174 * Resolver flags (used to be discrete per-module statics ints).
175 */
176#define RES_F_VC 0x00000001 /* socket is TCP */
177#define RES_F_CONN 0x00000002 /* socket is connected */
178
179/* res_findzonecut() options */
180#define RES_EXHAUSTIVE 0x00000001 /* always do all queries */
181
28f540f4
RM
182/*
183 * Resolver options (keep these in synch with res_debug.c, please)
184 */
185#define RES_INIT 0x00000001 /* address initialized */
186#define RES_DEBUG 0x00000002 /* print debug messages */
3d61b63c 187#define RES_AAONLY 0x00000004 /* authoritative answers only (!IMPL)*/
28f540f4 188#define RES_USEVC 0x00000008 /* use virtual circuit */
3d61b63c 189#define RES_PRIMARY 0x00000010 /* query primary server only (!IMPL) */
28f540f4
RM
190#define RES_IGNTC 0x00000020 /* ignore trucation errors */
191#define RES_RECURSE 0x00000040 /* recursion desired */
192#define RES_DEFNAMES 0x00000080 /* use default domain name */
193#define RES_STAYOPEN 0x00000100 /* Keep TCP socket open */
194#define RES_DNSRCH 0x00000200 /* search up local domain tree */
195#define RES_INSECURE1 0x00000400 /* type 1 security disabled */
196#define RES_INSECURE2 0x00000800 /* type 2 security disabled */
3d61b63c 197#define RES_NOALIASES 0x00001000 /* shuts off HOSTALIASES feature */
fa0bc87c 198#define RES_USE_INET6 0x00002000 /* use/map IPv6 in gethostbyname() */
b43b13ac
UD
199#define RES_ROTATE 0x00004000 /* rotate ns list after each query */
200#define RES_NOCHECKNAME 0x00008000 /* do not check names for sanity. */
201#define RES_KEEPTSIG 0x00010000 /* do not strip TSIG records */
e685e07d 202#define RES_BLAST 0x00020000 /* blast all recursive servers */
28f540f4
RM
203
204#define RES_DEFAULT (RES_RECURSE | RES_DEFNAMES | RES_DNSRCH)
205
206/*
207 * Resolver "pfcode" values. Used by dig.
208 */
209#define RES_PRF_STATS 0x00000001
b43b13ac 210#define RES_PRF_UPDATE 0x00000002
e685e07d 211#define RES_PRF_CLASS 0x00000004
28f540f4
RM
212#define RES_PRF_CMD 0x00000008
213#define RES_PRF_QUES 0x00000010
214#define RES_PRF_ANS 0x00000020
215#define RES_PRF_AUTH 0x00000040
216#define RES_PRF_ADD 0x00000080
217#define RES_PRF_HEAD1 0x00000100
218#define RES_PRF_HEAD2 0x00000200
219#define RES_PRF_TTLID 0x00000400
220#define RES_PRF_HEADX 0x00000800
221#define RES_PRF_QUERY 0x00001000
222#define RES_PRF_REPLY 0x00002000
b43b13ac 223#define RES_PRF_INIT 0x00004000
28f540f4
RM
224/* 0x00008000 */
225
b43b13ac 226/* Things involving an internal (static) resolver context. */
835bf8e0 227__BEGIN_DECLS
f14273c5 228extern struct __res_state *__res_state(void) __attribute__ ((__const__));
835bf8e0 229__END_DECLS
e685e07d 230#define _res (*__res_state())
fdacb17d 231
e685e07d 232#ifndef __BIND_NOSTATIC
b43b13ac
UD
233#define fp_nquery __fp_nquery
234#define fp_query __fp_query
235#define hostalias __hostalias
236#define p_query __p_query
237#define res_close __res_close
e685e07d 238#define res_init __res_init
b43b13ac 239#define res_isourserver __res_isourserver
e685e07d
UD
240#define res_mkquery __res_mkquery
241#define res_query __res_query
242#define res_querydomain __res_querydomain
243#define res_search __res_search
b43b13ac 244#define res_send __res_send
28f540f4 245
b43b13ac 246__BEGIN_DECLS
e685e07d
UD
247void fp_nquery __P((const u_char *, int, FILE *));
248void fp_query __P((const u_char *, FILE *));
249const char * hostalias __P((const char *));
250void p_query __P((const u_char *));
251void res_close __P((void));
252int res_init __P((void));
253int res_isourserver __P((const struct sockaddr_in *));
254int res_mkquery __P((int, const char *, int, int, const u_char *,
255 int, const u_char *, u_char *, int));
256int res_query __P((const char *, int, int, u_char *, int));
257int res_querydomain __P((const char *, const char *, int, int,
258 u_char *, int));
259int res_search __P((const char *, int, int, u_char *, int));
260int res_send __P((const u_char *, int, u_char *, int));
b43b13ac 261__END_DECLS
e685e07d 262#endif
df21c858 263
e685e07d 264#if !defined(SHARED_LIBBIND) || defined(LIB)
b43b13ac
UD
265/*
266 * If libbind is a shared object (well, DLL anyway)
835bf8e0 267 * these externs break the linker when resolv.h is
b43b13ac
UD
268 * included by a lib client (like named)
269 * Make them go away if a client is including this
270 *
271 */
272extern const struct res_sym __p_key_syms[];
273extern const struct res_sym __p_cert_syms[];
df21c858
UD
274extern const struct res_sym __p_class_syms[];
275extern const struct res_sym __p_type_syms[];
b43b13ac
UD
276extern const struct res_sym __p_rcode_syms[];
277#endif /* SHARED_LIBBIND */
28f540f4 278
b43b13ac
UD
279#define b64_ntop __b64_ntop
280#define b64_pton __b64_pton
281#define dn_comp __dn_comp
282#define dn_count_labels __dn_count_labels
e685e07d 283#define dn_expand __dn_expand
b43b13ac
UD
284#define dn_skipname __dn_skipname
285#define fp_resstat __fp_resstat
286#define loc_aton __loc_aton
287#define loc_ntoa __loc_ntoa
288#define p_cdname __p_cdname
289#define p_cdnname __p_cdnname
290#define p_class __p_class
291#define p_fqname __p_fqname
292#define p_fqnname __p_fqnname
293#define p_option __p_option
294#define p_secstodate __p_secstodate
295#define p_section __p_section
296#define p_time __p_time
297#define p_type __p_type
298#define p_rcode __p_rcode
299#define putlong __putlong
300#define putshort __putshort
301#define res_dnok __res_dnok
b43b13ac
UD
302#define res_hnok __res_hnok
303#define res_hostalias __res_hostalias
304#define res_mailok __res_mailok
305#define res_nameinquery __res_nameinquery
306#define res_nclose __res_nclose
307#define res_ninit __res_ninit
308#define res_nmkquery __res_nmkquery
309#define res_npquery __res_npquery
310#define res_nquery __res_nquery
311#define res_nquerydomain __res_nquerydomain
312#define res_nsearch __res_nsearch
313#define res_nsend __res_nsend
314#define res_nisourserver __res_nisourserver
315#define res_ownok __res_ownok
316#define res_queriesmatch __res_queriesmatch
317#define res_randomid __res_randomid
318#define sym_ntop __sym_ntop
319#define sym_ntos __sym_ntos
320#define sym_ston __sym_ston
28f540f4 321__BEGIN_DECLS
e685e07d
UD
322int res_hnok __P((const char *));
323int res_ownok __P((const char *));
324int res_mailok __P((const char *));
325int res_dnok __P((const char *));
326int sym_ston __P((const struct res_sym *, const char *, int *));
327const char * sym_ntos __P((const struct res_sym *, int, int *));
328const char * sym_ntop __P((const struct res_sym *, int, int *));
329int b64_ntop __P((u_char const *, size_t, char *, size_t));
330int b64_pton __P((char const *, u_char *, size_t));
331int loc_aton __P((const char *ascii, u_char *binary));
332const char * loc_ntoa __P((const u_char *binary, char *ascii));
333int dn_skipname __P((const u_char *, const u_char *));
334void putlong __P((u_int32_t, u_char *));
335void putshort __P((u_int16_t, u_char *));
336const char * p_class __P((int));
337const char * p_time __P((u_int32_t));
338const char * p_type __P((int));
339const char * p_rcode __P((int));
340const u_char * p_cdnname __P((const u_char *, const u_char *, int, FILE *));
341const u_char * p_cdname __P((const u_char *, const u_char *, FILE *));
342const u_char * p_fqnname __P((const u_char *cp, const u_char *msg,
343 int, char *, int));
344const u_char * p_fqname __P((const u_char *, const u_char *, FILE *));
345const char * p_option __P((u_long option));
346char * p_secstodate __P((u_long));
347int dn_count_labels __P((const char *));
348int dn_comp __P((const char *, u_char *, int,
349 u_char **, u_char **));
350int dn_expand __P((const u_char *, const u_char *, const u_char *,
351 char *, int));
352u_int res_randomid __P((void));
353int res_nameinquery __P((const char *, int, int,
354 const u_char *, const u_char *));
355int res_queriesmatch __P((const u_char *, const u_char *,
356 const u_char *, const u_char *));
357const char * p_section __P((int section, int opcode));
b43b13ac 358/* Things involving a resolver context. */
e685e07d
UD
359int res_ninit __P((res_state));
360int res_nisourserver __P((const res_state,
361 const struct sockaddr_in *));
362void fp_resstat __P((const res_state, FILE *));
363void res_npquery __P((const res_state, const u_char *, int, FILE *));
364const char * res_hostalias __P((const res_state, const char *,
365 char *, size_t));
366int res_nquery __P((res_state,
367 const char *, int, int, u_char *, int));
368int res_nsearch __P((res_state, const char *, int,
369 int, u_char *, int));
370int res_nquerydomain __P((res_state,
371 const char *, const char *, int, int,
372 u_char *, int));
373int res_nmkquery __P((res_state,
374 int, const char *, int, int, const u_char *,
375 int, const u_char *, u_char *, int));
376int res_nsend __P((res_state, const u_char *, int, u_char *, int));
377void res_nclose __P((res_state));
28f540f4 378__END_DECLS
535b764d 379#endif
28f540f4 380
b43b13ac 381#endif /* !_RESOLV_H_ */