StdLib/Include/netdb.h

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