Back to index

glibc  2.9
resolv.h
Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 1983, 1987, 1989
00003  *    The Regents of the University of California.  All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions
00007  * are met:
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 4. Neither the name of the University nor the names of its contributors
00014  *    may be used to endorse or promote products derived from this software
00015  *    without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
00018  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00019  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00020  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
00021  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00022  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00023  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00024  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00025  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00026  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00027  * SUCH DAMAGE.
00028  */
00029 
00030 /*
00031  * Portions Copyright (c) 1996-1999 by Internet Software Consortium.
00032  *
00033  * Permission to use, copy, modify, and distribute this software for any
00034  * purpose with or without fee is hereby granted, provided that the above
00035  * copyright notice and this permission notice appear in all copies.
00036  *
00037  * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
00038  * ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
00039  * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
00040  * CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
00041  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
00042  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
00043  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
00044  * SOFTWARE.
00045  */
00046 
00047 /*
00048  *     @(#)resolv.h  8.1 (Berkeley) 6/2/93
00049  *     $BINDId: resolv.h,v 8.31 2000/03/30 20:16:50 vixie Exp $
00050  */
00051 
00052 #ifndef _RESOLV_H_
00053 
00054 /* These headers are needed for types used in the `struct res_state'
00055    declaration.  */
00056 #include <sys/types.h>
00057 #include <netinet/in.h>
00058 
00059 #ifndef __need_res_state
00060 # define _RESOLV_H_
00061 
00062 # include <sys/param.h>
00063 # include <sys/cdefs.h>
00064 # include <stdio.h>
00065 # include <arpa/nameser.h>
00066 #endif
00067 
00068 #ifndef __res_state_defined
00069 # define __res_state_defined
00070 
00071 typedef enum { res_goahead, res_nextns, res_modified, res_done, res_error }
00072        res_sendhookact;
00073 
00074 typedef res_sendhookact (*res_send_qhook) (struct sockaddr_in * const *ns,
00075                                       const u_char **query,
00076                                       int *querylen,
00077                                       u_char *ans,
00078                                       int anssiz,
00079                                       int *resplen);
00080 
00081 typedef res_sendhookact (*res_send_rhook) (const struct sockaddr_in *ns,
00082                                       const u_char *query,
00083                                       int querylen,
00084                                       u_char *ans,
00085                                       int anssiz,
00086                                       int *resplen);
00087 
00088 /*
00089  * Global defines and variables for resolver stub.
00090  */
00091 # define MAXNS                     3      /* max # name servers we'll track */
00092 # define MAXDFLSRCH         3      /* # default domain levels to try */
00093 # define MAXDNSRCH          6      /* max # domains in search path */
00094 # define LOCALDOMAINPARTS   2      /* min levels in name that is "local" */
00095 
00096 # define RES_TIMEOUT        5      /* min. seconds between retries */
00097 # define MAXRESOLVSORT             10     /* number of net to sort on */
00098 # define RES_MAXNDOTS              15     /* should reflect bit field size */
00099 # define RES_MAXRETRANS            30     /* only for resolv.conf/RES_OPTIONS */
00100 # define RES_MAXRETRY              5      /* only for resolv.conf/RES_OPTIONS */
00101 # define RES_DFLRETRY              2      /* Default #/tries. */
00102 # define RES_MAXTIME        65535  /* Infinity, in milliseconds. */
00103 
00104 struct __res_state {
00105        int    retrans;             /* retransmition time interval */
00106        int    retry;               /* number of times to retransmit */
00107        u_long options;             /* option flags - see below. */
00108        int    nscount;             /* number of name servers */
00109        struct sockaddr_in
00110               nsaddr_list[MAXNS];  /* address of name server */
00111 # define nsaddr      nsaddr_list[0]              /* for backward compatibility */
00112        u_short       id;                  /* current message id */
00113        /* 2 byte hole here.  */
00114        char   *dnsrch[MAXDNSRCH+1];       /* components of domain to search */
00115        char   defdname[256];              /* default domain (deprecated) */
00116        u_long pfcode;                     /* RES_PRF_ flags - see below. */
00117        unsigned ndots:4;           /* threshold for initial abs. query */
00118        unsigned nsort:4;           /* number of elements in sort_list[] */
00119        unsigned ipv6_unavail:1;    /* connecting to IPv6 server failed */
00120        unsigned unused:23;
00121        struct {
00122               struct in_addr       addr;
00123               u_int32_t     mask;
00124        } sort_list[MAXRESOLVSORT];
00125        /* 4 byte hole here on 64-bit architectures.  */
00126        res_send_qhook qhook;              /* query hook */
00127        res_send_rhook rhook;              /* response hook */
00128        int    res_h_errno;         /* last one set for this context */
00129        int    _vcsock;             /* PRIVATE: for res_send VC i/o */
00130        u_int  _flags;                     /* PRIVATE: see below */
00131        /* 4 byte hole here on 64-bit architectures.  */
00132        union {
00133               char   pad[52];      /* On an i386 this means 512b total. */
00134               struct {
00135                      u_int16_t            nscount;
00136                      u_int16_t            nsmap[MAXNS];
00137                      int                  nssocks[MAXNS];
00138                      u_int16_t            nscount6;
00139                      u_int16_t            nsinit;
00140                      struct sockaddr_in6  *nsaddrs[MAXNS];
00141 #ifdef _LIBC
00142                      unsigned long long int      initstamp
00143                        __attribute__((packed));
00144 #else
00145                      unsigned int         _initstamp[2];
00146 #endif
00147               } _ext;
00148        } _u;
00149 };
00150 
00151 typedef struct __res_state *res_state;
00152 # undef __need_res_state
00153 #endif
00154 
00155 #ifdef _RESOLV_H_
00156 /*
00157  * Revision information.  This is the release date in YYYYMMDD format.
00158  * It can change every day so the right thing to do with it is use it
00159  * in preprocessor commands such as "#if (__RES > 19931104)".  Do not
00160  * compare for equality; rather, use it to determine whether your resolver
00161  * is new enough to contain a certain feature.
00162  */
00163 
00164 #define       __RES  19991006
00165 
00166 /*
00167  * Resolver configuration file.
00168  * Normally not present, but may contain the address of the
00169  * inital name server(s) to query and the domain search list.
00170  */
00171 
00172 #ifndef _PATH_RESCONF
00173 #define _PATH_RESCONF        "/etc/resolv.conf"
00174 #endif
00175 
00176 struct res_sym {
00177        int    number;              /* Identifying number, like T_MX */
00178        char * name;         /* Its symbolic name, like "MX" */
00179        char * humanname;    /* Its fun name, like "mail exchanger" */
00180 };
00181 
00182 /*
00183  * Resolver flags (used to be discrete per-module statics ints).
00184  */
00185 #define       RES_F_VC      0x00000001    /* socket is TCP */
00186 #define       RES_F_CONN    0x00000002    /* socket is connected */
00187 #define RES_F_EDNS0ERR      0x00000004    /* EDNS0 caused errors */
00188 
00189 /* res_findzonecut() options */
00190 #define       RES_EXHAUSTIVE       0x00000001    /* always do all queries */
00191 
00192 /*
00193  * Resolver options (keep these in synch with res_debug.c, please)
00194  */
00195 #define RES_INIT     0x00000001    /* address initialized */
00196 #define RES_DEBUG    0x00000002    /* print debug messages */
00197 #define RES_AAONLY   0x00000004    /* authoritative answers only (!IMPL)*/
00198 #define RES_USEVC    0x00000008    /* use virtual circuit */
00199 #define RES_PRIMARY  0x00000010    /* query primary server only (!IMPL) */
00200 #define RES_IGNTC    0x00000020    /* ignore trucation errors */
00201 #define RES_RECURSE  0x00000040    /* recursion desired */
00202 #define RES_DEFNAMES 0x00000080    /* use default domain name */
00203 #define RES_STAYOPEN 0x00000100    /* Keep TCP socket open */
00204 #define RES_DNSRCH   0x00000200    /* search up local domain tree */
00205 #define       RES_INSECURE1 0x00000400    /* type 1 security disabled */
00206 #define       RES_INSECURE2 0x00000800    /* type 2 security disabled */
00207 #define       RES_NOALIASES 0x00001000    /* shuts off HOSTALIASES feature */
00208 #define       RES_USE_INET6 0x00002000    /* use/map IPv6 in gethostbyname() */
00209 #define RES_ROTATE   0x00004000    /* rotate ns list after each query */
00210 #define       RES_NOCHECKNAME      0x00008000    /* do not check names for sanity. */
00211 #define       RES_KEEPTSIG  0x00010000    /* do not strip TSIG records */
00212 #define       RES_BLAST     0x00020000    /* blast all recursive servers */
00213 #define RES_USEBSTRING      0x00040000    /* IPv6 reverse lookup with byte
00214                                       strings */
00215 #define RES_NOIP6DOTINT     0x00080000    /* Do not use .ip6.int in IPv6
00216                                       reverse lookup */
00217 #define RES_USE_EDNS0       0x00100000    /* Use EDNS0.  */
00218 
00219 #define RES_DEFAULT  (RES_RECURSE|RES_DEFNAMES|RES_DNSRCH|RES_NOIP6DOTINT)
00220 
00221 /*
00222  * Resolver "pfcode" values.  Used by dig.
00223  */
00224 #define RES_PRF_STATS       0x00000001
00225 #define RES_PRF_UPDATE      0x00000002
00226 #define RES_PRF_CLASS   0x00000004
00227 #define RES_PRF_CMD  0x00000008
00228 #define RES_PRF_QUES 0x00000010
00229 #define RES_PRF_ANS  0x00000020
00230 #define RES_PRF_AUTH 0x00000040
00231 #define RES_PRF_ADD  0x00000080
00232 #define RES_PRF_HEAD1       0x00000100
00233 #define RES_PRF_HEAD2       0x00000200
00234 #define RES_PRF_TTLID       0x00000400
00235 #define RES_PRF_HEADX       0x00000800
00236 #define RES_PRF_QUERY       0x00001000
00237 #define RES_PRF_REPLY       0x00002000
00238 #define RES_PRF_INIT 0x00004000
00239 /*                   0x00008000    */
00240 
00241 /* Things involving an internal (static) resolver context. */
00242 __BEGIN_DECLS
00243 extern struct __res_state *__res_state(void) __attribute__ ((__const__));
00244 __END_DECLS
00245 #define _res (*__res_state())
00246 
00247 #ifndef __BIND_NOSTATIC
00248 #define fp_nquery           __fp_nquery
00249 #define fp_query            __fp_query
00250 #define hostalias           __hostalias
00251 #define p_query                    __p_query
00252 #define res_close           __res_close
00253 #define res_init            __res_init
00254 #define res_isourserver            __res_isourserver
00255 #define res_mkquery         __res_mkquery
00256 #define res_query           __res_query
00257 #define res_querydomain            __res_querydomain
00258 #define res_search          __res_search
00259 #define res_send            __res_send
00260 
00261 __BEGIN_DECLS
00262 void          fp_nquery (const u_char *, int, FILE *) __THROW;
00263 void          fp_query (const u_char *, FILE *) __THROW;
00264 const char *  hostalias (const char *) __THROW;
00265 void          p_query (const u_char *) __THROW;
00266 void          res_close (void) __THROW;
00267 int           res_init (void) __THROW;
00268 int           res_isourserver (const struct sockaddr_in *) __THROW;
00269 int           res_mkquery (int, const char *, int, int, const u_char *,
00270                           int, const u_char *, u_char *, int) __THROW;
00271 int           res_query (const char *, int, int, u_char *, int) __THROW;
00272 int           res_querydomain (const char *, const char *, int, int,
00273                              u_char *, int) __THROW;
00274 int           res_search (const char *, int, int, u_char *, int) __THROW;
00275 int           res_send (const u_char *, int, u_char *, int) __THROW;
00276 __END_DECLS
00277 #endif
00278 
00279 #define b64_ntop            __b64_ntop
00280 #define b64_pton            __b64_pton
00281 #define dn_comp                    __dn_comp
00282 #define dn_count_labels            __dn_count_labels
00283 #define dn_expand           __dn_expand
00284 #define dn_skipname         __dn_skipname
00285 #define fp_resstat          __fp_resstat
00286 #define loc_aton            __loc_aton
00287 #define loc_ntoa            __loc_ntoa
00288 #define p_cdname            __p_cdname
00289 #define p_cdnname           __p_cdnname
00290 #define p_class                    __p_class
00291 #define p_fqname            __p_fqname
00292 #define p_fqnname           __p_fqnname
00293 #define p_option            __p_option
00294 #define p_secstodate        __p_secstodate
00295 #define p_section           __p_section
00296 #define p_time                     __p_time
00297 #define p_type                     __p_type
00298 #define p_rcode                    __p_rcode
00299 #define putlong                    __putlong
00300 #define putshort            __putshort
00301 #define res_dnok            __res_dnok
00302 #define res_hnok            __res_hnok
00303 #define res_hostalias              __res_hostalias
00304 #define res_mailok          __res_mailok
00305 #define res_nameinquery            __res_nameinquery
00306 #define res_nclose          __res_nclose
00307 #define res_ninit           __res_ninit
00308 #define res_nmkquery        __res_nmkquery
00309 #define res_npquery         __res_npquery
00310 #define res_nquery          __res_nquery
00311 #define res_nquerydomain    __res_nquerydomain
00312 #define res_nsearch         __res_nsearch
00313 #define res_nsend           __res_nsend
00314 #define res_nisourserver    __res_nisourserver
00315 #define res_ownok           __res_ownok
00316 #define res_queriesmatch    __res_queriesmatch
00317 #define res_randomid        __res_randomid
00318 #define sym_ntop            __sym_ntop
00319 #define sym_ntos            __sym_ntos
00320 #define sym_ston            __sym_ston
00321 __BEGIN_DECLS
00322 int           res_hnok (const char *) __THROW;
00323 int           res_ownok (const char *) __THROW;
00324 int           res_mailok (const char *) __THROW;
00325 int           res_dnok (const char *) __THROW;
00326 int           sym_ston (const struct res_sym *, const char *, int *) __THROW;
00327 const char *  sym_ntos (const struct res_sym *, int, int *) __THROW;
00328 const char *  sym_ntop (const struct res_sym *, int, int *) __THROW;
00329 int           b64_ntop (u_char const *, size_t, char *, size_t) __THROW;
00330 int           b64_pton (char const *, u_char *, size_t) __THROW;
00331 int           loc_aton (const char *ascii, u_char *binary) __THROW;
00332 const char *  loc_ntoa (const u_char *binary, char *ascii) __THROW;
00333 int           dn_skipname (const u_char *, const u_char *) __THROW;
00334 void          putlong (u_int32_t, u_char *) __THROW;
00335 void          putshort (u_int16_t, u_char *) __THROW;
00336 const char *  p_class (int) __THROW;
00337 const char *  p_time (u_int32_t) __THROW;
00338 const char *  p_type (int) __THROW;
00339 const char *  p_rcode (int) __THROW;
00340 const u_char *       p_cdnname (const u_char *, const u_char *, int, FILE *)
00341      __THROW;
00342 const u_char *       p_cdname (const u_char *, const u_char *, FILE *) __THROW;
00343 const u_char *       p_fqnname (const u_char *cp, const u_char *msg,
00344                         int, char *, int) __THROW;
00345 const u_char *       p_fqname (const u_char *, const u_char *, FILE *) __THROW;
00346 const char *  p_option (u_long option) __THROW;
00347 char *        p_secstodate (u_long) __THROW;
00348 int           dn_count_labels (const char *) __THROW;
00349 int           dn_comp (const char *, u_char *, int, u_char **, u_char **)
00350      __THROW;
00351 int           dn_expand (const u_char *, const u_char *, const u_char *,
00352                         char *, int) __THROW;
00353 u_int         res_randomid (void) __THROW;
00354 int           res_nameinquery (const char *, int, int,
00355                              const u_char *, const u_char *) __THROW;
00356 int           res_queriesmatch (const u_char *, const u_char *,
00357                               const u_char *, const u_char *) __THROW;
00358 const char *  p_section (int section, int opcode) __THROW;
00359 /* Things involving a resolver context. */
00360 int           res_ninit (res_state) __THROW;
00361 int           res_nisourserver (const res_state,
00362                               const struct sockaddr_in *) __THROW;
00363 void          fp_resstat (const res_state, FILE *) __THROW;
00364 void          res_npquery (const res_state, const u_char *, int, FILE *)
00365      __THROW;
00366 const char *  res_hostalias (const res_state, const char *, char *, size_t)
00367      __THROW;
00368 int           res_nquery (res_state, const char *, int, int, u_char *, int)
00369      __THROW;
00370 int           res_nsearch (res_state, const char *, int, int, u_char *, int)
00371      __THROW;
00372 int           res_nquerydomain (res_state, const char *, const char *, int,
00373                               int, u_char *, int) __THROW;
00374 int           res_nmkquery (res_state, int, const char *, int, int,
00375                            const u_char *, int, const u_char *, u_char *,
00376                            int) __THROW;
00377 int           res_nsend (res_state, const u_char *, int, u_char *, int)
00378      __THROW;
00379 void          res_nclose (res_state) __THROW;
00380 __END_DECLS
00381 #endif
00382 
00383 #endif /* !_RESOLV_H_ */