fe90ab5a75f2f9b02d90e73dec32f6c47520d630
[kopensolaris-gnu/glibc.git] / resolv / resolv.h
1 /*
2  * ++Copyright++ 1983, 1987, 1989, 1993
3  * -
4  * Copyright (c) 1983, 1987, 1989, 1993
5  *    The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *      This product includes software developed by the University of
18  *      California, Berkeley and its contributors.
19  * 4. Neither the name of the University nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  * -
35  * Portions Copyright (c) 1993 by Digital Equipment Corporation.
36  *
37  * Permission to use, copy, modify, and distribute this software for any
38  * purpose with or without fee is hereby granted, provided that the above
39  * copyright notice and this permission notice appear in all copies, and that
40  * the name of Digital Equipment Corporation not be used in advertising or
41  * publicity pertaining to distribution of the document or software without
42  * specific, written prior permission.
43  *
44  * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
45  * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
46  * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
47  * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
48  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
49  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
50  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
51  * SOFTWARE.
52  * -
53  * --Copyright--
54  */
55
56 /*
57  *      @(#)resolv.h    8.1 (Berkeley) 6/2/93
58  *      $Id$
59  */
60
61 #ifndef _RESOLV_H_
62 #define _RESOLV_H_
63
64 #include <sys/param.h>
65 #if (!defined(BSD)) || (BSD < 199306)
66 # include <sys/bitypes.h>
67 #else
68 # include <sys/types.h>
69 #endif
70 #include <sys/cdefs.h>
71 #include <stdio.h>
72
73 /*
74  * Revision information.  This is the release date in YYYYMMDD format.
75  * It can change every day so the right thing to do with it is use it
76  * in preprocessor commands such as "#if (__RES > 19931104)".  Do not
77  * compare for equality; rather, use it to determine whether your resolver
78  * is new enough to contain a certain feature.
79  */
80
81 #define __RES   19960801
82
83 /*
84  * Resolver configuration file.
85  * Normally not present, but may contain the address of the
86  * inital name server(s) to query and the domain search list.
87  */
88
89 #ifndef _PATH_RESCONF
90 #define _PATH_RESCONF        "/etc/resolv.conf"
91 #endif
92
93 /*
94  * Global defines and variables for resolver stub.
95  */
96 #define MAXNS                   3       /* max # name servers we'll track */
97 #define MAXDFLSRCH              3       /* # default domain levels to try */
98 #define MAXDNSRCH               6       /* max # domains in search path */
99 #define LOCALDOMAINPARTS        2       /* min levels in name that is "local" */
100
101 #define RES_TIMEOUT             5       /* min. seconds between retries */
102 #define MAXRESOLVSORT           10      /* number of net to sort on */
103 #define RES_MAXNDOTS            15      /* should reflect bit field size */
104
105 struct __res_state {
106         int     retrans;                /* retransmition time interval */
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 */
112 #define nsaddr  nsaddr_list[0]          /* for backward compatibility */
113         u_short id;                     /* current message id */
114         char    *dnsrch[MAXDNSRCH+1];   /* components of domain to search */
115         char    defdname[256];          /* default domain (deprecated) */
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];
124         char    pad[72];                /* on an i386 this means 512b total */
125 };
126
127 /*
128  * Resolver options (keep these in synch with res_debug.c, please)
129  */
130 #define RES_INIT        0x00000001      /* address initialized */
131 #define RES_DEBUG       0x00000002      /* print debug messages */
132 #define RES_AAONLY      0x00000004      /* authoritative answers only (!IMPL)*/
133 #define RES_USEVC       0x00000008      /* use virtual circuit */
134 #define RES_PRIMARY     0x00000010      /* query primary server only (!IMPL) */
135 #define RES_IGNTC       0x00000020      /* ignore trucation errors */
136 #define RES_RECURSE     0x00000040      /* recursion desired */
137 #define RES_DEFNAMES    0x00000080      /* use default domain name */
138 #define RES_STAYOPEN    0x00000100      /* Keep TCP socket open */
139 #define RES_DNSRCH      0x00000200      /* search up local domain tree */
140 #define RES_INSECURE1   0x00000400      /* type 1 security disabled */
141 #define RES_INSECURE2   0x00000800      /* type 2 security disabled */
142 #define RES_NOALIASES   0x00001000      /* shuts off HOSTALIASES feature */
143 #define RES_USE_INET6   0x00002000      /* use/map IPv6 in gethostbyname() */
144
145 #define RES_DEFAULT     (RES_RECURSE | RES_DEFNAMES | RES_DNSRCH)
146
147 /*
148  * Resolver "pfcode" values.  Used by dig.
149  */
150 #define RES_PRF_STATS   0x00000001
151 /*                      0x00000002      */
152 #define RES_PRF_CLASS   0x00000004
153 #define RES_PRF_CMD     0x00000008
154 #define RES_PRF_QUES    0x00000010
155 #define RES_PRF_ANS     0x00000020
156 #define RES_PRF_AUTH    0x00000040
157 #define RES_PRF_ADD     0x00000080
158 #define RES_PRF_HEAD1   0x00000100
159 #define RES_PRF_HEAD2   0x00000200
160 #define RES_PRF_TTLID   0x00000400
161 #define RES_PRF_HEADX   0x00000800
162 #define RES_PRF_QUERY   0x00001000
163 #define RES_PRF_REPLY   0x00002000
164 #define RES_PRF_INIT    0x00004000
165 /*                      0x00008000      */
166
167 /* hooks are still experimental as of 4.9.2 */
168 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
169         res_sendhookact;
170
171 typedef res_sendhookact (*res_send_qhook)__P((struct sockaddr_in * const *ns,
172                                               const u_char **query,
173                                               int *querylen,
174                                               u_char *ans,
175                                               int anssiz,
176                                               int *resplen));
177
178 typedef res_sendhookact (*res_send_rhook)__P((const struct sockaddr_in *ns,
179                                               const u_char *query,
180                                               int querylen,
181                                               u_char *ans,
182                                               int anssiz,
183                                               int *resplen));
184
185 struct res_sym {
186         int     number;         /* Identifying number, like T_MX */
187         char *  name;           /* Its symbolic name, like "MX" */
188         char *  humanname;      /* Its fun name, like "mail exchanger" */
189 };
190
191 extern struct __res_state _res;
192 extern const struct res_sym __p_class_syms[];
193 extern const struct res_sym __p_type_syms[];
194
195 /* Private routines shared between libc/net, named, nslookup and others. */
196 #define res_hnok        __res_hnok
197 #define res_ownok       __res_ownok
198 #define res_mailok      __res_mailok
199 #define res_dnok        __res_dnok
200 #define sym_ston        __sym_ston
201 #define sym_ntos        __sym_ntos
202 #define sym_ntop        __sym_ntop
203 #define b64_ntop        __b64_ntop
204 #define b64_pton        __b64_pton
205 #define loc_ntoa        __loc_ntoa
206 #define loc_aton        __loc_aton
207 #define dn_skipname     __dn_skipname
208 #define fp_resstat      __fp_resstat
209 #define fp_query        __fp_query
210 #define fp_nquery       __fp_nquery
211 #define hostalias       __hostalias
212 #define putlong         __putlong
213 #define putshort        __putshort
214 #define p_class         __p_class
215 #define p_time          __p_time
216 #define p_type          __p_type
217 #define p_query         __p_query
218 #define p_cdnname       __p_cdnname
219 #define p_cdname        __p_cdname
220 #define p_fqnname       __p_fqnname
221 #define p_fqname        __p_fqname
222 #define p_rr            __p_rr
223 #define p_option        __p_option
224 #define p_secstodate    __p_secstodate
225 #define dn_count_labels __dn_count_labels
226 #define dn_comp         __dn_comp
227 #define dn_expand       __dn_expand
228 #define res_init        __res_init
229 #define res_randomid    __res_randomid
230 #define res_query       __res_query
231 #define res_search      __res_search
232 #define res_querydomain __res_querydomain
233 #define res_mkquery     __res_mkquery
234 #define res_send        __res_send
235 #define res_isourserver __res_isourserver
236 #define res_nameinquery __res_nameinquery
237 #define res_queriesmatch __res_queriesmatch
238 #define res_close       __res_close
239 __BEGIN_DECLS
240 int             res_hnok __P((const char *));
241 int             res_ownok __P((const char *));
242 int             res_mailok __P((const char *));
243 int             res_dnok __P((const char *));
244 int             sym_ston __P((const struct res_sym *, char *, int *));
245 const char *    sym_ntos __P((const struct res_sym *, int, int *));
246 const char *    sym_ntop __P((const struct res_sym *, int, int *));
247 int             b64_ntop __P((u_char const *, size_t, char *, size_t));
248 int             b64_pton __P((char const *, u_char *, size_t));
249 int             loc_aton __P((const char *, u_char *));
250 const char *    loc_ntoa __P((const u_char *, char *));
251 int             dn_skipname __P((const u_char *, const u_char *));
252 void            fp_resstat __P((struct __res_state *, FILE *));
253 void            fp_query __P((const u_char *, FILE *));
254 void            fp_nquery __P((const u_char *, int, FILE *));
255 const char *    hostalias __P((const char *));
256 void            putlong __P((u_int32_t, u_char *));
257 void            putshort __P((u_int16_t, u_char *));
258 const char *    p_class __P((int));
259 const char *    p_time __P((u_int32_t));
260 const char *    p_type __P((int));
261 void            p_query __P((const u_char *));
262 const u_char *  p_cdnname __P((const u_char *, const u_char *, int, FILE *));
263 const u_char *  p_cdname __P((const u_char *, const u_char *, FILE *));
264 const u_char *  p_fqnname __P((const u_char *cp, const u_char *msg,
265                                int, char *, int));
266 const u_char *  p_fqname __P((const u_char *, const u_char *, FILE *));
267 const u_char *  p_rr __P((const u_char *, const u_char *, FILE *));
268 const char *    p_option __P((u_long option));
269 char *          p_secstodate __P((u_long));
270 int             dn_count_labels __P((char *));
271 int             dn_comp __P((const char *, u_char *, int,
272                              u_char **, u_char **));
273 int             dn_expand __P((const u_char *, const u_char *, const u_char *,
274                                char *, int));
275 int             res_init __P((void));
276 u_int           res_randomid __P((void));
277 int             res_query __P((const char *, int, int, u_char *, int));
278 int             res_search __P((const char *, int, int, u_char *, int));
279 int             res_querydomain __P((const char *, const char *, int, int,
280                                      u_char *, int));
281 int             res_mkquery __P((int, const char *, int, int, const u_char *, int,
282                                  const u_char *, u_char *, int));
283 int             res_send __P((const u_char *, int, u_char *, int));
284 int             res_isourserver __P((const struct sockaddr_in *));
285 int             res_nameinquery __P((const char *, int, int,
286                                      const u_char *, const u_char *));
287 int             res_queriesmatch __P((const u_char *, const u_char *,
288                                       const u_char *, const u_char *));
289 void            res_close __P((void));
290 __END_DECLS
291
292 #endif /* !_RESOLV_H_ */