Remove Name_Service definition.
[kopensolaris-gnu/glibc.git] / resolv / 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  * 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.
16  *
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.
28  */
29
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
47 /*
48  *      @(#)resolv.h    8.1 (Berkeley) 6/2/93
49  *      $BINDId: resolv.h,v 8.31 2000/03/30 20:16:50 vixie Exp $
50  */
51
52 #ifndef _RESOLV_H_
53
54 /* These headers are needed for types used in the `struct res_state'
55    declaration.  */
56 #include <sys/types.h>
57 #include <netinet/in.h>
58
59 #ifndef __need_res_state
60 # define _RESOLV_H_
61
62 # include <sys/param.h>
63 # include <sys/cdefs.h>
64 # include <stdio.h>
65 # include <arpa/nameser.h>
66 #endif
67
68 #ifndef __res_state_defined
69 # define __res_state_defined
70
71 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
72         res_sendhookact;
73
74 typedef res_sendhookact (*res_send_qhook) (struct sockaddr_in * const *ns,
75                                            const u_char **query,
76                                            int *querylen,
77                                            u_char *ans,
78                                            int anssiz,
79                                            int *resplen);
80
81 typedef res_sendhookact (*res_send_rhook) (const struct sockaddr_in *ns,
82                                            const u_char *query,
83                                            int querylen,
84                                            u_char *ans,
85                                            int anssiz,
86                                            int *resplen);
87
88 /*
89  * Global defines and variables for resolver stub.
90  */
91 # define MAXNS                  3       /* max # name servers we'll track */
92 # define MAXDFLSRCH             3       /* # default domain levels to try */
93 # define MAXDNSRCH              6       /* max # domains in search path */
94 # define LOCALDOMAINPARTS       2       /* min levels in name that is "local" */
95
96 # define RES_TIMEOUT            5       /* min. seconds between retries */
97 # define MAXRESOLVSORT          10      /* number of net to sort on */
98 # define RES_MAXNDOTS           15      /* should reflect bit field size */
99 # define RES_MAXRETRANS         30      /* only for resolv.conf/RES_OPTIONS */
100 # define RES_MAXRETRY           5       /* only for resolv.conf/RES_OPTIONS */
101 # define RES_DFLRETRY           2       /* Default #/tries. */
102 # define RES_MAXTIME            65535   /* Infinity, in milliseconds. */
103
104 struct __res_state {
105         int     retrans;                /* retransmition time interval */
106         int     retry;                  /* number of times to retransmit */
107         u_long  options;                /* option flags - see below. */
108         int     nscount;                /* number of name servers */
109         struct sockaddr_in
110                 nsaddr_list[MAXNS];     /* address of name server */
111 # define nsaddr nsaddr_list[0]          /* for backward compatibility */
112         u_short id;                     /* current message id */
113         char    *dnsrch[MAXDNSRCH+1];   /* components of domain to search */
114         char    defdname[256];          /* default domain (deprecated) */
115         u_long  pfcode;                 /* RES_PRF_ flags - see below. */
116         unsigned ndots:4;               /* threshold for initial abs. query */
117         unsigned nsort:4;               /* number of elements in sort_list[] */
118         char    unused[3];
119         struct {
120                 struct in_addr  addr;
121                 u_int32_t       mask;
122         } sort_list[MAXRESOLVSORT];
123         res_send_qhook qhook;           /* query hook */
124         res_send_rhook rhook;           /* response hook */
125         int     res_h_errno;            /* last one set for this context */
126         int     _vcsock;                /* PRIVATE: for res_send VC i/o */
127         u_int   _flags;                 /* PRIVATE: see below */
128         union {
129                 char    pad[52];        /* On an i386 this means 512b total. */
130                 struct {
131                         u_int16_t               nscount;
132                         u_int16_t               nsmap[MAXNS];
133                         int                     nssocks[MAXNS];
134                         u_int16_t               nscount6;
135                         u_int16_t               nsinit;
136                         struct sockaddr_in6     *nsaddrs[MAXNS];
137 #ifdef _LIBC
138                         unsigned long long int  initstamp
139                           __attribute__((packed));
140 #else
141                         unsigned int            _initstamp[2];
142 #endif
143                 } _ext;
144         } _u;
145 };
146
147 typedef struct __res_state *res_state;
148 # undef __need_res_state
149 #endif
150
151 #ifdef _RESOLV_H_
152 /*
153  * Revision information.  This is the release date in YYYYMMDD format.
154  * It can change every day so the right thing to do with it is use it
155  * in preprocessor commands such as "#if (__RES > 19931104)".  Do not
156  * compare for equality; rather, use it to determine whether your resolver
157  * is new enough to contain a certain feature.
158  */
159
160 #define __RES   19991006
161
162 /*
163  * Resolver configuration file.
164  * Normally not present, but may contain the address of the
165  * inital name server(s) to query and the domain search list.
166  */
167
168 #ifndef _PATH_RESCONF
169 #define _PATH_RESCONF        "/etc/resolv.conf"
170 #endif
171
172 struct res_sym {
173         int     number;         /* Identifying number, like T_MX */
174         char *  name;           /* Its symbolic name, like "MX" */
175         char *  humanname;      /* Its fun name, like "mail exchanger" */
176 };
177
178 /*
179  * Resolver flags (used to be discrete per-module statics ints).
180  */
181 #define RES_F_VC        0x00000001      /* socket is TCP */
182 #define RES_F_CONN      0x00000002      /* socket is connected */
183
184 /* res_findzonecut() options */
185 #define RES_EXHAUSTIVE  0x00000001      /* always do all queries */
186
187 /*
188  * Resolver options (keep these in synch with res_debug.c, please)
189  */
190 #define RES_INIT        0x00000001      /* address initialized */
191 #define RES_DEBUG       0x00000002      /* print debug messages */
192 #define RES_AAONLY      0x00000004      /* authoritative answers only (!IMPL)*/
193 #define RES_USEVC       0x00000008      /* use virtual circuit */
194 #define RES_PRIMARY     0x00000010      /* query primary server only (!IMPL) */
195 #define RES_IGNTC       0x00000020      /* ignore trucation errors */
196 #define RES_RECURSE     0x00000040      /* recursion desired */
197 #define RES_DEFNAMES    0x00000080      /* use default domain name */
198 #define RES_STAYOPEN    0x00000100      /* Keep TCP socket open */
199 #define RES_DNSRCH      0x00000200      /* search up local domain tree */
200 #define RES_INSECURE1   0x00000400      /* type 1 security disabled */
201 #define RES_INSECURE2   0x00000800      /* type 2 security disabled */
202 #define RES_NOALIASES   0x00001000      /* shuts off HOSTALIASES feature */
203 #define RES_USE_INET6   0x00002000      /* use/map IPv6 in gethostbyname() */
204 #define RES_ROTATE      0x00004000      /* rotate ns list after each query */
205 #define RES_NOCHECKNAME 0x00008000      /* do not check names for sanity. */
206 #define RES_KEEPTSIG    0x00010000      /* do not strip TSIG records */
207 #define RES_BLAST       0x00020000      /* blast all recursive servers */
208 #define RES_USEBSTRING  0x00040000      /* IPv6 reverse lookup with byte
209                                            strings */
210 #define RES_NOIP6DOTINT 0x00080000      /* Do not use .ip6.int in IPv6
211                                            reverse lookup */
212
213 #define RES_DEFAULT     (RES_RECURSE|RES_DEFNAMES|RES_DNSRCH|RES_NOIP6DOTINT)
214
215 /*
216  * Resolver "pfcode" values.  Used by dig.
217  */
218 #define RES_PRF_STATS   0x00000001
219 #define RES_PRF_UPDATE  0x00000002
220 #define RES_PRF_CLASS   0x00000004
221 #define RES_PRF_CMD     0x00000008
222 #define RES_PRF_QUES    0x00000010
223 #define RES_PRF_ANS     0x00000020
224 #define RES_PRF_AUTH    0x00000040
225 #define RES_PRF_ADD     0x00000080
226 #define RES_PRF_HEAD1   0x00000100
227 #define RES_PRF_HEAD2   0x00000200
228 #define RES_PRF_TTLID   0x00000400
229 #define RES_PRF_HEADX   0x00000800
230 #define RES_PRF_QUERY   0x00001000
231 #define RES_PRF_REPLY   0x00002000
232 #define RES_PRF_INIT    0x00004000
233 /*                      0x00008000      */
234
235 /* Things involving an internal (static) resolver context. */
236 __BEGIN_DECLS
237 extern struct __res_state *__res_state(void) __attribute__ ((__const__));
238 __END_DECLS
239 #define _res (*__res_state())
240
241 #ifndef __BIND_NOSTATIC
242 #define fp_nquery               __fp_nquery
243 #define fp_query                __fp_query
244 #define hostalias               __hostalias
245 #define p_query                 __p_query
246 #define res_close               __res_close
247 #define res_init                __res_init
248 #define res_isourserver         __res_isourserver
249 #define res_mkquery             __res_mkquery
250 #define res_query               __res_query
251 #define res_querydomain         __res_querydomain
252 #define res_search              __res_search
253 #define res_send                __res_send
254
255 __BEGIN_DECLS
256 void            fp_nquery (const u_char *, int, FILE *) __THROW;
257 void            fp_query (const u_char *, FILE *) __THROW;
258 const char *    hostalias (const char *) __THROW;
259 void            p_query (const u_char *) __THROW;
260 void            res_close (void) __THROW;
261 int             res_init (void) __THROW;
262 int             res_isourserver (const struct sockaddr_in *) __THROW;
263 int             res_mkquery (int, const char *, int, int, const u_char *,
264                              int, const u_char *, u_char *, int) __THROW;
265 int             res_query (const char *, int, int, u_char *, int) __THROW;
266 int             res_querydomain (const char *, const char *, int, int,
267                                  u_char *, int) __THROW;
268 int             res_search (const char *, int, int, u_char *, int) __THROW;
269 int             res_send (const u_char *, int, u_char *, int) __THROW;
270 __END_DECLS
271 #endif
272
273 #define b64_ntop                __b64_ntop
274 #define b64_pton                __b64_pton
275 #define dn_comp                 __dn_comp
276 #define dn_count_labels         __dn_count_labels
277 #define dn_expand               __dn_expand
278 #define dn_skipname             __dn_skipname
279 #define fp_resstat              __fp_resstat
280 #define loc_aton                __loc_aton
281 #define loc_ntoa                __loc_ntoa
282 #define p_cdname                __p_cdname
283 #define p_cdnname               __p_cdnname
284 #define p_class                 __p_class
285 #define p_fqname                __p_fqname
286 #define p_fqnname               __p_fqnname
287 #define p_option                __p_option
288 #define p_secstodate            __p_secstodate
289 #define p_section               __p_section
290 #define p_time                  __p_time
291 #define p_type                  __p_type
292 #define p_rcode                 __p_rcode
293 #define putlong                 __putlong
294 #define putshort                __putshort
295 #define res_dnok                __res_dnok
296 #define res_hnok                __res_hnok
297 #define res_hostalias           __res_hostalias
298 #define res_mailok              __res_mailok
299 #define res_nameinquery         __res_nameinquery
300 #define res_nclose              __res_nclose
301 #define res_ninit               __res_ninit
302 #define res_nmkquery            __res_nmkquery
303 #define res_npquery             __res_npquery
304 #define res_nquery              __res_nquery
305 #define res_nquerydomain        __res_nquerydomain
306 #define res_nsearch             __res_nsearch
307 #define res_nsend               __res_nsend
308 #define res_nisourserver        __res_nisourserver
309 #define res_ownok               __res_ownok
310 #define res_queriesmatch        __res_queriesmatch
311 #define res_randomid            __res_randomid
312 #define sym_ntop                __sym_ntop
313 #define sym_ntos                __sym_ntos
314 #define sym_ston                __sym_ston
315 __BEGIN_DECLS
316 int             res_hnok (const char *) __THROW;
317 int             res_ownok (const char *) __THROW;
318 int             res_mailok (const char *) __THROW;
319 int             res_dnok (const char *) __THROW;
320 int             sym_ston (const struct res_sym *, const char *, int *) __THROW;
321 const char *    sym_ntos (const struct res_sym *, int, int *) __THROW;
322 const char *    sym_ntop (const struct res_sym *, int, int *) __THROW;
323 int             b64_ntop (u_char const *, size_t, char *, size_t) __THROW;
324 int             b64_pton (char const *, u_char *, size_t) __THROW;
325 int             loc_aton (const char *ascii, u_char *binary) __THROW;
326 const char *    loc_ntoa (const u_char *binary, char *ascii) __THROW;
327 int             dn_skipname (const u_char *, const u_char *) __THROW;
328 void            putlong (u_int32_t, u_char *) __THROW;
329 void            putshort (u_int16_t, u_char *) __THROW;
330 const char *    p_class (int) __THROW;
331 const char *    p_time (u_int32_t) __THROW;
332 const char *    p_type (int) __THROW;
333 const char *    p_rcode (int) __THROW;
334 const u_char *  p_cdnname (const u_char *, const u_char *, int, FILE *)
335      __THROW;
336 const u_char *  p_cdname (const u_char *, const u_char *, FILE *) __THROW;
337 const u_char *  p_fqnname (const u_char *cp, const u_char *msg,
338                            int, char *, int) __THROW;
339 const u_char *  p_fqname (const u_char *, const u_char *, FILE *) __THROW;
340 const char *    p_option (u_long option) __THROW;
341 char *          p_secstodate (u_long) __THROW;
342 int             dn_count_labels (const char *) __THROW;
343 int             dn_comp (const char *, u_char *, int, u_char **, u_char **)
344      __THROW;
345 int             dn_expand (const u_char *, const u_char *, const u_char *,
346                            char *, int) __THROW;
347 u_int           res_randomid (void) __THROW;
348 int             res_nameinquery (const char *, int, int,
349                                  const u_char *, const u_char *) __THROW;
350 int             res_queriesmatch (const u_char *, const u_char *,
351                                   const u_char *, const u_char *) __THROW;
352 const char *    p_section (int section, int opcode) __THROW;
353 /* Things involving a resolver context. */
354 int             res_ninit (res_state) __THROW;
355 int             res_nisourserver (const res_state,
356                                   const struct sockaddr_in *) __THROW;
357 void            fp_resstat (const res_state, FILE *) __THROW;
358 void            res_npquery (const res_state, const u_char *, int, FILE *)
359      __THROW;
360 const char *    res_hostalias (const res_state, const char *, char *, size_t)
361      __THROW;
362 int             res_nquery (res_state, const char *, int, int, u_char *, int)
363      __THROW;
364 int             res_nsearch (res_state, const char *, int, int, u_char *, int)
365      __THROW;
366 int             res_nquerydomain (res_state, const char *, const char *, int,
367                                   int, u_char *, int) __THROW;
368 int             res_nmkquery (res_state, int, const char *, int, int,
369                               const u_char *, int, const u_char *, u_char *,
370                               int) __THROW;
371 int             res_nsend (res_state, const u_char *, int, u_char *, int)
372      __THROW;
373 void            res_nclose (res_state) __THROW;
374 __END_DECLS
375 #endif
376
377 #endif /* !_RESOLV_H_ */