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