include/netdb.h

   1 /*      $NetBSD: netdb.h,v 1.65 2012/03/17 21:57:48 christos Exp $      */
   2
   3 /*
   4  * ++Copyright++ 1980, 1983, 1988, 1993
   5  * -
   6  * Copyright (c) 1980, 1983, 1988, 1993
   7  *      The Regents of the University of California.  All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  * 3. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  * -
  33  * Portions Copyright (c) 1993 by Digital Equipment Corporation.
  34  *
  35  * Permission to use, copy, modify, and distribute this software for any
  36  * purpose with or without fee is hereby granted, provided that the above
  37  * copyright notice and this permission notice appear in all copies, and that
  38  * the name of Digital Equipment Corporation not be used in advertising or
  39  * publicity pertaining to distribution of the document or software without
  40  * specific, written prior permission.
  41  *
  42  * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
  43  * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
  44  * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
  45  * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  46  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  47  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
  48  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  49  * SOFTWARE.
  50  * -
  51  * Portions Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
  52  * All rights reserved.
  53  *
  54  * Redistribution and use in source and binary forms, with or without
  55  * modification, are permitted provided that the following conditions
  56  * are met:
  57  * 1. Redistributions of source code must retain the above copyright
  58  *    notice, this list of conditions and the following disclaimer.
  59  * 2. Redistributions in binary form must reproduce the above copyright
  60  *    notice, this list of conditions and the following disclaimer in the
  61  *    documentation and/or other materials provided with the distribution.
  62  * 3. All advertising materials mentioning features or use of this software
  63  *    must display the following acknowledgement:
  64  *    This product includes software developed by WIDE Project and
  65  *    its contributors.
  66  * 4. Neither the name of the project nor the names of its contributors
  67  *    may be used to endorse or promote products derived from this software
  68  *    without specific prior written permission.
  69  *
  70  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  71  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  72  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  73  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  74  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  75  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  76  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  77  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  78  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  79  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  80  * SUCH DAMAGE.
  81  * -
  82  * --Copyright--
  83  */
  84
  85 /*
  86  *      @(#)netdb.h     8.1 (Berkeley) 6/2/93
  87  *      Id: netdb.h,v 1.22 2008/02/28 05:34:17 marka Exp
  88  */
  89
  90 #ifndef _NETDB_H_
  91 #define _NETDB_H_
  92
  93 #include <machine/ansi.h>
  94 #include <machine/endian_machdep.h>
  95 #include <sys/ansi.h>
  96 #include <sys/cdefs.h>
  97 #include <sys/featuretest.h>
  98 #include <inttypes.h>
  99 /*
 100  * Data types
 101  */
 102 #ifndef socklen_t
 103 typedef __socklen_t     socklen_t;
 104 #define socklen_t       __socklen_t
 105 #endif
 106
 107 #ifdef  _BSD_SIZE_T_
 108 typedef _BSD_SIZE_T_    size_t;
 109 #undef  _BSD_SIZE_T_
 110 #endif
 111
 112 #if defined(_NETBSD_SOURCE)
 113 #ifndef _PATH_HEQUIV
 114 #define _PATH_HEQUIV    "/etc/hosts.equiv"
 115 #endif
 116 #ifndef _PATH_HOSTS
 117 #define _PATH_HOSTS     "/etc/hosts"
 118 #endif
 119 #ifndef _PATH_NETWORKS
 120 #define _PATH_NETWORKS  "/etc/networks"
 121 #endif
 122 #ifndef _PATH_PROTOCOLS
 123 #define _PATH_PROTOCOLS "/etc/protocols"
 124 #endif
 125 #ifndef _PATH_SERVICES
 126 #define _PATH_SERVICES  "/etc/services"
 127 #endif
 128 #ifndef _PATH_SERVICES_CDB
 129 #define _PATH_SERVICES_CDB "/var/db/services.cdb"
 130 #endif
 131 #ifndef _PATH_SERVICES_DB
 132 #define _PATH_SERVICES_DB "/var/db/services.db"
 133 #endif
 134 #ifdef __minix
 135 #define _PATH_SERVACCES "/etc/serv.access"
 136 #endif
 137 #endif
 138
 139 __BEGIN_DECLS
 140 extern int h_errno;
 141 extern int * __h_errno(void);
 142 #ifdef _REENTRANT
 143 #define h_errno (*__h_errno())
 144 #endif
 145 __END_DECLS
 146
 147 /*%
 148  * Structures returned by network data base library.  All addresses are
 149  * supplied in host order, and returned in network order (suitable for
 150  * use in system calls).
 151  */
 152 struct  hostent {
 153         char    *h_name;        /*%< official name of host */
 154         char    **h_aliases;    /*%< alias list */
 155         int     h_addrtype;     /*%< host address type */
 156         int     h_length;       /*%< length of address */
 157         char    **h_addr_list;  /*%< list of addresses from name server */
 158 #define h_addr  h_addr_list[0]  /*%< address, for backward compatiblity */
 159 };
 160
 161 /*%
 162  * Assumption here is that a network number
 163  * fits in an unsigned long -- probably a poor one.
 164  */
 165 struct  netent {
 166         char            *n_name;        /*%< official name of net */
 167         char            **n_aliases;    /*%< alias list */
 168         int             n_addrtype;     /*%< net address type */
 169 #if (defined(__sparc__) && defined(_LP64)) || \
 170     (defined(__sh__) && defined(_LP64) && (_BYTE_ORDER == _BIG_ENDIAN))
 171         int             __n_pad0;       /* ABI compatibility */
 172 #endif
 173         uint32_t        n_net;          /*%< network # */
 174 #if defined(__alpha__) || (defined(__i386__) && defined(_LP64)) || \
 175     (defined(__sh__) && defined(_LP64) && (_BYTE_ORDER == _LITTLE_ENDIAN))
 176         int             __n_pad0;       /* ABI compatibility */
 177 #endif
 178 };
 179
 180 struct  servent {
 181         char    *s_name;        /*%< official service name */
 182         char    **s_aliases;    /*%< alias list */
 183         int     s_port;         /*%< port # */
 184         char    *s_proto;       /*%< protocol to use */
 185 };
 186
 187 struct  protoent {
 188         char    *p_name;        /*%< official protocol name */
 189         char    **p_aliases;    /*%< alias list */
 190         int     p_proto;        /*%< protocol # */
 191 };
 192
 193 /*
 194  * Note: ai_addrlen used to be a size_t, per RFC 2553.
 195  * In XNS5.2, and subsequently in POSIX-2001 and
 196  * draft-ietf-ipngwg-rfc2553bis-02.txt it was changed to a socklen_t.
 197  * To accommodate for this while preserving binary compatibility with the
 198  * old interface, we prepend or append 32 bits of padding, depending on
 199  * the (LP64) architecture's endianness.
 200  *
 201  * This should be deleted the next time the libc major number is
 202  * incremented.
 203  */
 204 #if (_POSIX_C_SOURCE - 0) >= 200112L || (_XOPEN_SOURCE - 0) >= 520 || \
 205     defined(_NETBSD_SOURCE)
 206 struct addrinfo {
 207         int             ai_flags;       /*%< AI_PASSIVE, AI_CANONNAME */
 208         int             ai_family;      /*%< PF_xxx */
 209         int             ai_socktype;    /*%< SOCK_xxx */
 210         int             ai_protocol;    /*%< 0 or IPPROTO_xxx for IPv4 and IPv6 */
 211 #if defined(__sparc__) && defined(_LP64)
 212         int             __ai_pad0;      /* ABI compatibility */
 213 #endif
 214         socklen_t        ai_addrlen;    /*%< length of ai_addr */
 215 #if defined(__alpha__) || (defined(__i386__) && defined(_LP64))
 216         int             __ai_pad0;      /* ABI compatibility */
 217 #endif
 218         char            *ai_canonname;  /*%< canonical name for hostname */
 219         struct sockaddr *ai_addr;       /*%< binary address */
 220         struct addrinfo *ai_next;       /*%< next structure in linked list */
 221 };
 222 #endif
 223
 224 /*%
 225  * Error return codes from gethostbyname() and gethostbyaddr()
 226  * (left in extern int h_errno).
 227  */
 228
 229 #if defined(_NETBSD_SOURCE)
 230 #define NETDB_INTERNAL  -1      /*%< see errno */
 231 #define NETDB_SUCCESS   0       /*%< no problem */
 232 #endif
 233 #define NO_ADDRESS      NO_DATA         /* no address, look for MX record */
 234 #define HOST_NOT_FOUND  1 /*%< Authoritative Answer Host not found */
 235 #define TRY_AGAIN       2 /*%< Non-Authoritive Host not found, or SERVERFAIL */
 236 #define NO_RECOVERY     3 /*%< Non recoverable errors, FORMERR, REFUSED, NOTIMP */
 237 #define NO_DATA         4 /*%< Valid name, no data record of requested type */
 238 #if defined(_NETBSD_SOURCE)
 239 #define NO_ADDRESS      NO_DATA         /*%< no address, look for MX record */
 240 #endif
 241
 242 /*
 243  * Error return codes from getaddrinfo()
 244  */
 245 #if (_POSIX_C_SOURCE - 0) >= 200112L || (_XOPEN_SOURCE - 0) >= 520 || \
 246     defined(_NETBSD_SOURCE)
 247 #define EAI_ADDRFAMILY   1      /*%< address family for hostname not supported */
 248 #define EAI_AGAIN        2      /*%< temporary failure in name resolution */
 249 #define EAI_BADFLAGS     3      /*%< invalid value for ai_flags */
 250 #define EAI_FAIL         4      /*%< non-recoverable failure in name resolution */
 251 #define EAI_FAMILY       5      /*%< ai_family not supported */
 252 #define EAI_MEMORY       6      /*%< memory allocation failure */
 253 #define EAI_NODATA       7      /*%< no address associated with hostname */
 254 #define EAI_NONAME       8      /*%< hostname nor servname provided, or not known */
 255 #define EAI_SERVICE      9      /*%< servname not supported for ai_socktype */
 256 #define EAI_SOCKTYPE    10      /*%< ai_socktype not supported */
 257 #define EAI_SYSTEM      11      /*%< system error returned in errno */
 258 #define EAI_BADHINTS    12      /* invalid value for hints */
 259 #define EAI_PROTOCOL    13      /* resolved protocol is unknown */
 260 #define EAI_OVERFLOW    14      /* argument buffer overflow */
 261 #define EAI_MAX         15
 262 #endif /* _POSIX_C_SOURCE >= 200112 || _XOPEN_SOURCE >= 520 || _NETBSD_SOURCE */
 263
 264 /*%
 265  * Flag values for getaddrinfo()
 266  */
 267 #if (_POSIX_C_SOURCE - 0) >= 200112L || (_XOPEN_SOURCE - 0) >= 520 || \
 268     defined(_NETBSD_SOURCE)
 269 #define AI_PASSIVE      0x00000001 /* get address to use bind() */
 270 #define AI_CANONNAME    0x00000002 /* fill ai_canonname */
 271 #define AI_NUMERICHOST  0x00000004 /* prevent host name resolution */
 272 #define AI_NUMERICSERV  0x00000008 /* prevent service name resolution */
 273 /* valid flags for addrinfo (not a standard def, apps should not use it) */
 274 #define AI_MASK \
 275     (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_NUMERICSERV | \
 276     AI_ADDRCONFIG)
 277 #define AI_ADDRCONFIG   0x00000400 /* only if any address is assigned */
 278 #endif
 279
 280 #if (_POSIX_C_SOURCE - 0) >= 200112L || (_XOPEN_SOURCE - 0) >= 520 || \
 281     defined(_NETBSD_SOURCE)
 282 /*%
 283  * Constants for getnameinfo()
 284  */
 285 #if defined(_NETBSD_SOURCE)
 286 #define NI_MAXHOST      1025
 287 #define NI_MAXSERV      32
 288 #endif
 289
 290 /*%
 291  * Flag values for getnameinfo()
 292  */
 293 #define NI_NOFQDN       0x00000001
 294 #define NI_NUMERICHOST  0x00000002
 295 #define NI_NAMEREQD     0x00000004
 296 #define NI_NUMERICSERV  0x00000008
 297 #define NI_DGRAM        0x00000010
 298 #define NI_WITHSCOPEID  0x00000020
 299 #define NI_NUMERICSCOPE 0x00000040
 300
 301 /*%
 302  * Scope delimit character
 303  */
 304 #if defined(_NETBSD_SOURCE)
 305 #define SCOPE_DELIMITER '%'
 306 #endif
 307 #endif /* (_POSIX_C_SOURCE - 0) >= 200112L || ... */
 308
 309 __BEGIN_DECLS
 310 void            endhostent(void);
 311 void            endnetent(void);
 312 void            endprotoent(void);
 313 void            endservent(void);
 314 #if (_XOPEN_SOURCE - 0) >= 520 && (_XOPEN_SOURCE - 0) < 600 || \
 315     defined(_NETBSD_SOURCE)
 316 #if 0 /* we do not ship this */
 317 void            freehostent(struct hostent *);
 318 #endif
 319 #endif
 320 struct hostent  *gethostbyaddr(const char *, socklen_t, int);
 321 struct hostent  *gethostbyname(const char *);
 322 #if defined(_NETBSD_SOURCE)
 323 struct hostent  *gethostbyname2(const char *, int);
 324 #endif
 325 struct hostent  *gethostent(void);
 326 struct netent   *getnetbyaddr(uint32_t, int);
 327 struct netent   *getnetbyname(const char *);
 328 struct netent   *getnetent(void);
 329 struct protoent *getprotobyname(const char *);
 330 struct protoent *getprotobynumber(int);
 331 struct protoent *getprotoent(void);
 332 struct servent  *getservbyname(const char *, const char *);
 333 struct servent  *getservbyport(int, const char *);
 334 struct servent  *getservent(void);
 335 #if defined(_NETBSD_SOURCE)
 336 void            herror(const char *);
 337 const char      *hstrerror(int);
 338 #endif
 339 void            sethostent(int);
 340 #if defined(_NETBSD_SOURCE)
 341 /* void         sethostfile(const char *); */
 342 #endif
 343 void            setnetent(int);
 344 void            setprotoent(int);
 345 void            setservent(int);
 346 #if (_POSIX_C_SOURCE - 0) >= 200112L || (_XOPEN_SOURCE - 0) >= 520 || \
 347     defined(_NETBSD_SOURCE)
 348 int             getaddrinfo(const char * __restrict, const char * __restrict,
 349                                  const struct addrinfo * __restrict,
 350                                  struct addrinfo ** __restrict);
 351 int             getnameinfo(const struct sockaddr * __restrict, socklen_t,
 352                                  char * __restrict, socklen_t,
 353                                  char * __restrict, socklen_t, int);
 354 struct addrinfo *allocaddrinfo(socklen_t);
 355 void            freeaddrinfo(struct addrinfo *);
 356 const char      *gai_strerror(int);
 357 #endif
 358 __END_DECLS
 359
 360 #endif /* !_NETDB_H_ */