include/netdb.h

   1 /*      $NetBSD: netdb.h,v 1.61 2009/04/12 17:07:33 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_DB
 129 #define _PATH_SERVICES_DB "/var/db/services.db"
 130 #endif
 131 #endif
 132
 133 __BEGIN_DECLS
 134 extern int h_errno;
 135 extern int * __h_errno(void);
 136 #ifdef _REENTRANT
 137 #define h_errno (*__h_errno())
 138 #endif
 139 __END_DECLS
 140
 141 /*%
 142  * Structures returned by network data base library.  All addresses are
 143  * supplied in host order, and returned in network order (suitable for
 144  * use in system calls).
 145  */
 146 struct  hostent {
 147         char    *h_name;        /*%< official name of host */
 148         char    **h_aliases;    /*%< alias list */
 149         int     h_addrtype;     /*%< host address type */
 150         int     h_length;       /*%< length of address */
 151         char    **h_addr_list;  /*%< list of addresses from name server */
 152 #define h_addr  h_addr_list[0]  /*%< address, for backward compatiblity */
 153 };
 154
 155 /*%
 156  * Assumption here is that a network number
 157  * fits in an unsigned long -- probably a poor one.
 158  */
 159 struct  netent {
 160         char            *n_name;        /*%< official name of net */
 161         char            **n_aliases;    /*%< alias list */
 162         int             n_addrtype;     /*%< net address type */
 163 #if (defined(__sparc__) && defined(_LP64)) || \
 164     (defined(__sh__) && defined(_LP64) && (_BYTE_ORDER == _BIG_ENDIAN))
 165         int             __n_pad0;       /* ABI compatibility */
 166 #endif
 167         uint32_t        n_net;          /*%< network # */
 168 #if defined(__alpha__) || (defined(__i386__) && defined(_LP64)) || \
 169     (defined(__sh__) && defined(_LP64) && (_BYTE_ORDER == _LITTLE_ENDIAN))
 170         int             __n_pad0;       /* ABI compatibility */
 171 #endif
 172 };
 173
 174 struct  servent {
 175         char    *s_name;        /*%< official service name */
 176         char    **s_aliases;    /*%< alias list */
 177         int     s_port;         /*%< port # */
 178         char    *s_proto;       /*%< protocol to use */
 179 };
 180
 181 struct  protoent {
 182         char    *p_name;        /*%< official protocol name */
 183         char    **p_aliases;    /*%< alias list */
 184         int     p_proto;        /*%< protocol # */
 185 };
 186
 187 /*
 188  * Note: ai_addrlen used to be a size_t, per RFC 2553.
 189  * In XNS5.2, and subsequently in POSIX-2001 and
 190  * draft-ietf-ipngwg-rfc2553bis-02.txt it was changed to a socklen_t.
 191  * To accommodate for this while preserving binary compatibility with the
 192  * old interface, we prepend or append 32 bits of padding, depending on
 193  * the (LP64) architecture's endianness.
 194  *
 195  * This should be deleted the next time the libc major number is
 196  * incremented.
 197  */
 198 #if (_POSIX_C_SOURCE - 0) >= 200112L || (_XOPEN_SOURCE - 0) >= 520 || \
 199     defined(_NETBSD_SOURCE)
 200 struct addrinfo {
 201         int             ai_flags;       /*%< AI_PASSIVE, AI_CANONNAME */
 202         int             ai_family;      /*%< PF_xxx */
 203         int             ai_socktype;    /*%< SOCK_xxx */
 204         int             ai_protocol;    /*%< 0 or IPPROTO_xxx for IPv4 and IPv6 */
 205 #if defined(__sparc__) && defined(_LP64)
 206         int             __ai_pad0;      /* ABI compatibility */
 207 #endif
 208         socklen_t        ai_addrlen;    /*%< length of ai_addr */
 209 #if defined(__alpha__) || (defined(__i386__) && defined(_LP64))
 210         int             __ai_pad0;      /* ABI compatibility */
 211 #endif
 212         char            *ai_canonname;  /*%< canonical name for hostname */
 213         struct sockaddr *ai_addr;       /*%< binary address */
 214         struct addrinfo *ai_next;       /*%< next structure in linked list */
 215 };
 216 #endif
 217
 218 /*%
 219  * Error return codes from gethostbyname() and gethostbyaddr()
 220  * (left in extern int h_errno).
 221  */
 222
 223 #if defined(_NETBSD_SOURCE)
 224 #define NETDB_INTERNAL  -1      /*%< see errno */
 225 #define NETDB_SUCCESS   0       /*%< no problem */
 226 #endif
 227 #define NO_ADDRESS      NO_DATA         /* no address, look for MX record */
 228 #define HOST_NOT_FOUND  1 /*%< Authoritative Answer Host not found */
 229 #define TRY_AGAIN       2 /*%< Non-Authoritive Host not found, or SERVERFAIL */
 230 #define NO_RECOVERY     3 /*%< Non recoverable errors, FORMERR, REFUSED, NOTIMP */
 231 #define NO_DATA         4 /*%< Valid name, no data record of requested type */
 232 #if defined(_NETBSD_SOURCE)
 233 #define NO_ADDRESS      NO_DATA         /*%< no address, look for MX record */
 234 #endif
 235
 236 /*
 237  * Error return codes from getaddrinfo()
 238  */
 239 #if (_POSIX_C_SOURCE - 0) >= 200112L || (_XOPEN_SOURCE - 0) >= 520 || \
 240     defined(_NETBSD_SOURCE)
 241 #define EAI_ADDRFAMILY   1      /*%< address family for hostname not supported */
 242 #define EAI_AGAIN        2      /*%< temporary failure in name resolution */
 243 #define EAI_BADFLAGS     3      /*%< invalid value for ai_flags */
 244 #define EAI_FAIL         4      /*%< non-recoverable failure in name resolution */
 245 #define EAI_FAMILY       5      /*%< ai_family not supported */
 246 #define EAI_MEMORY       6      /*%< memory allocation failure */
 247 #define EAI_NODATA       7      /*%< no address associated with hostname */
 248 #define EAI_NONAME       8      /*%< hostname nor servname provided, or not known */
 249 #define EAI_SERVICE      9      /*%< servname not supported for ai_socktype */
 250 #define EAI_SOCKTYPE    10      /*%< ai_socktype not supported */
 251 #define EAI_SYSTEM      11      /*%< system error returned in errno */
 252 #define EAI_BADHINTS    12      /* invalid value for hints */
 253 #define EAI_PROTOCOL    13      /* resolved protocol is unknown */
 254 #define EAI_OVERFLOW    14      /* argument buffer overflow */
 255 #define EAI_MAX         15
 256 #endif /* _POSIX_C_SOURCE >= 200112 || _XOPEN_SOURCE >= 520 || _NETBSD_SOURCE */
 257
 258 /*%
 259  * Flag values for getaddrinfo()
 260  */
 261 #if (_POSIX_C_SOURCE - 0) >= 200112L || (_XOPEN_SOURCE - 0) >= 520 || \
 262     defined(_NETBSD_SOURCE)
 263 #define AI_PASSIVE      0x00000001 /* get address to use bind() */
 264 #define AI_CANONNAME    0x00000002 /* fill ai_canonname */
 265 #define AI_NUMERICHOST  0x00000004 /* prevent host name resolution */
 266 #define AI_NUMERICSERV  0x00000008 /* prevent service name resolution */
 267 /* valid flags for addrinfo (not a standard def, apps should not use it) */
 268 #define AI_MASK \
 269     (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_NUMERICSERV)
 270 #endif
 271
 272 #if (_POSIX_C_SOURCE - 0) >= 200112L || (_XOPEN_SOURCE - 0) >= 520 || \
 273     defined(_NETBSD_SOURCE)
 274 /*%
 275  * Constants for getnameinfo()
 276  */
 277 #if defined(_NETBSD_SOURCE)
 278 #define NI_MAXHOST      1025
 279 #define NI_MAXSERV      32
 280 #endif
 281
 282 /*%
 283  * Flag values for getnameinfo()
 284  */
 285 #define NI_NOFQDN       0x00000001
 286 #define NI_NUMERICHOST  0x00000002
 287 #define NI_NAMEREQD     0x00000004
 288 #define NI_NUMERICSERV  0x00000008
 289 #define NI_DGRAM        0x00000010
 290 #define NI_WITHSCOPEID  0x00000020
 291 #define NI_NUMERICSCOPE 0x00000040
 292
 293 /*%
 294  * Scope delimit character
 295  */
 296 #if defined(_NETBSD_SOURCE)
 297 #define SCOPE_DELIMITER '%'
 298 #endif
 299 #endif /* (_POSIX_C_SOURCE - 0) >= 200112L || ... */
 300
 301 __BEGIN_DECLS
 302 void            endhostent(void);
 303 void            endnetent(void);
 304 void            endprotoent(void);
 305 void            endservent(void);
 306 #if (_XOPEN_SOURCE - 0) >= 520 && (_XOPEN_SOURCE - 0) < 600 || \
 307     defined(_NETBSD_SOURCE)
 308 #if 0 /* we do not ship this */
 309 void            freehostent(struct hostent *);
 310 #endif
 311 #endif
 312 struct hostent  *gethostbyaddr(const char *, socklen_t, int);
 313 struct hostent  *gethostbyname(const char *);
 314 #if defined(_NETBSD_SOURCE)
 315 struct hostent  *gethostbyname2(const char *, int);
 316 #endif
 317 struct hostent  *gethostent(void);
 318 struct netent   *getnetbyaddr(uint32_t, int);
 319 struct netent   *getnetbyname(const char *);
 320 struct netent   *getnetent(void);
 321 struct protoent *getprotobyname(const char *);
 322 struct protoent *getprotobynumber(int);
 323 struct protoent *getprotoent(void);
 324 struct servent  *getservbyname(const char *, const char *);
 325 struct servent  *getservbyport(int, const char *);
 326 struct servent  *getservent(void);
 327 #if defined(_NETBSD_SOURCE)
 328 void            herror(const char *);
 329 const char      *hstrerror(int);
 330 #endif
 331 void            sethostent(int);
 332 #if defined(_NETBSD_SOURCE)
 333 /* void         sethostfile(const char *); */
 334 #endif
 335 void            setnetent(int);
 336 void            setprotoent(int);
 337 #if (_POSIX_C_SOURCE - 0) >= 200112L || (_XOPEN_SOURCE - 0) >= 520 || \
 338     defined(_NETBSD_SOURCE)
 339 void            setservent(int);
 340 int             getaddrinfo(const char * __restrict, const char * __restrict,
 341                                  const struct addrinfo * __restrict,
 342                                  struct addrinfo ** __restrict);
 343 int             getnameinfo(const struct sockaddr * __restrict, socklen_t,
 344                                  char * __restrict, socklen_t,
 345                                  char * __restrict, socklen_t, int);
 346 struct addrinfo *allocaddrinfo(socklen_t);
 347 void            freeaddrinfo(struct addrinfo *);
 348 const char      *gai_strerror(int);
 349 #endif
 350 void            setservent(int);
 351 __END_DECLS
 352
 353 #endif /* !_NETDB_H_ */