include/netdb.h

   1 /*-
   2  * Copyright (c) 1980, 1983, 1988, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. 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  * -
  34  * Portions Copyright (c) 1993 by Digital Equipment Corporation.
  35  *
  36  * Permission to use, copy, modify, and distribute this software for any
  37  * purpose with or without fee is hereby granted, provided that the above
  38  * copyright notice and this permission notice appear in all copies, and that
  39  * the name of Digital Equipment Corporation not be used in advertising or
  40  * publicity pertaining to distribution of the document or software without
  41  * specific, written prior permission.
  42  *
  43  * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
  44  * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
  45  * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
  46  * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  47  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  48  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
  49  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  50  * SOFTWARE.
  51  * -
  52  * --Copyright--
  53  */
  54
  55 /*
  56  *      @(#)netdb.h     8.1 (Berkeley) 6/2/93
  57  *      From: Id: netdb.h,v 8.9 1996/11/19 08:39:29 vixie Exp $
  58  * $FreeBSD: src/include/netdb.h,v 1.14.2.5 2001/08/29 08:46:51 alfred Exp $
  59  * $DragonFly: src/include/netdb.h,v 1.7 2008/10/04 22:09:16 swildner Exp $
  60  */
  61
  62 #ifndef _NETDB_H_
  63 #define _NETDB_H_
  64
  65 #ifndef _MACHINE_STDINT_H_
  66 #include <machine/stdint.h>
  67 #endif
  68 #include <sys/cdefs.h>
  69
  70 #ifndef _SIZE_T_DECLARED
  71 #define _SIZE_T_DECLARED
  72 typedef __size_t        size_t;
  73 #endif
  74
  75 #ifndef _SOCKLEN_T_DECLARED
  76 #define _SOCKLEN_T_DECLARED
  77 typedef __socklen_t     socklen_t;
  78 #endif
  79
  80 #ifndef _PATH_HEQUIV
  81 # define        _PATH_HEQUIV    "/etc/hosts.equiv"
  82 #endif
  83 #define _PATH_HOSTS     "/etc/hosts"
  84 #define _PATH_NETWORKS  "/etc/networks"
  85 #define _PATH_PROTOCOLS "/etc/protocols"
  86 #define _PATH_SERVICES  "/etc/services"
  87
  88 extern int h_errno;
  89
  90 /*
  91  * Structures returned by network data base library.  All addresses are
  92  * supplied in host order, and returned in network order (suitable for
  93  * use in system calls).
  94  */
  95 struct  hostent {
  96         char    *h_name;        /* official name of host */
  97         char    **h_aliases;    /* alias list */
  98         int     h_addrtype;     /* host address type */
  99         int     h_length;       /* length of address */
 100         char    **h_addr_list;  /* list of addresses from name server */
 101 #define h_addr  h_addr_list[0]  /* address, for backward compatibility */
 102 };
 103
 104 /*
 105  * Assumption here is that a network number
 106  * fits in an unsigned long -- probably a poor one.
 107  */
 108 struct  netent {
 109         char            *n_name;        /* official name of net */
 110         char            **n_aliases;    /* alias list */
 111         int             n_addrtype;     /* net address type */
 112         unsigned long   n_net;          /* network # */
 113 };
 114
 115 struct  servent {
 116         char    *s_name;        /* official service name */
 117         char    **s_aliases;    /* alias list */
 118         int     s_port;         /* port # */
 119         char    *s_proto;       /* protocol to use */
 120 };
 121
 122 struct  protoent {
 123         char    *p_name;        /* official protocol name */
 124         char    **p_aliases;    /* alias list */
 125         int     p_proto;        /* protocol # */
 126 };
 127
 128 struct addrinfo {
 129         int     ai_flags;       /* AI_PASSIVE, AI_CANONNAME, AI_NUMERICHOST */
 130         int     ai_family;      /* PF_xxx */
 131         int     ai_socktype;    /* SOCK_xxx */
 132         int     ai_protocol;    /* 0 or IPPROTO_xxx for IPv4 and IPv6 */
 133         size_t ai_addrlen;      /* length of ai_addr */
 134         char    *ai_canonname;  /* canonical name for hostname */
 135         struct  sockaddr *ai_addr;      /* binary address */
 136         struct  addrinfo *ai_next;      /* next structure in linked list */
 137 };
 138
 139 /*
 140  * Error return codes from gethostbyname() and gethostbyaddr()
 141  * (left in extern int h_errno).
 142  */
 143
 144 #define NETDB_INTERNAL  -1      /* see errno */
 145 #define NETDB_SUCCESS   0       /* no problem */
 146 #define HOST_NOT_FOUND  1 /* Authoritative Answer Host not found */
 147 #define TRY_AGAIN       2 /* Non-Authoritative Host not found, or SERVERFAIL */
 148 #define NO_RECOVERY     3 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP */
 149 #define NO_DATA         4 /* Valid name, no data record of requested type */
 150 #define NO_ADDRESS      NO_DATA         /* no address, look for MX record */
 151
 152 /*
 153  * Error return codes from getaddrinfo()
 154  */
 155 #define EAI_ADDRFAMILY   1      /* address family for hostname not supported */
 156 #define EAI_AGAIN        2      /* temporary failure in name resolution */
 157 #define EAI_BADFLAGS     3      /* invalid value for ai_flags */
 158 #define EAI_FAIL         4      /* non-recoverable failure in name resolution */
 159 #define EAI_FAMILY       5      /* ai_family not supported */
 160 #define EAI_MEMORY       6      /* memory allocation failure */
 161 #define EAI_NODATA       7      /* no address associated with hostname */
 162 #define EAI_NONAME       8      /* hostname nor servname provided, or not known */
 163 #define EAI_SERVICE      9      /* servname not supported for ai_socktype */
 164 #define EAI_SOCKTYPE    10      /* ai_socktype not supported */
 165 #define EAI_SYSTEM      11      /* system error returned in errno */
 166 #define EAI_BADHINTS    12      /* invalid value for hints */
 167 #define EAI_PROTOCOL    13      /* resolved protocol is unknown */
 168 #define EAI_OVERFLOW    14      /* argument buffer overflow */
 169 #define EAI_MAX         15
 170
 171 /*
 172  * Flag values for getaddrinfo()
 173  */
 174 #define AI_PASSIVE      0x00000001 /* get address to use bind() */
 175 #define AI_CANONNAME    0x00000002 /* fill ai_canonname */
 176 #define AI_NUMERICHOST  0x00000004 /* prevent host name resolution */
 177 #define AI_NUMERICSERV  0x00000008 /* prevent service name resolution */
 178 /* valid flags for addrinfo (not a standard def, apps should not use it) */
 179 #define AI_MASK \
 180     (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_NUMERICSERV | \
 181      AI_ADDRCONFIG)
 182
 183 #define AI_ALL          0x00000100 /* IPv6 and IPv4-mapped (with AI_V4MAPPED) */
 184 #define AI_V4MAPPED_CFG 0x00000200 /* accept IPv4-mapped if kernel supports */
 185 #define AI_ADDRCONFIG   0x00000400 /* only if any address is assigned */
 186 #define AI_V4MAPPED     0x00000800 /* accept IPv4-mapped IPv6 address */
 187 /* special recommended flags for getipnodebyname */
 188 #define AI_DEFAULT      (AI_V4MAPPED_CFG | AI_ADDRCONFIG)
 189
 190 /*
 191  * Constants for getnameinfo()
 192  */
 193 #define NI_MAXHOST      1025
 194 #define NI_MAXSERV      32
 195
 196 /*
 197  * Flag values for getnameinfo()
 198  */
 199 #define NI_NOFQDN       0x00000001
 200 #define NI_NUMERICHOST  0x00000002
 201 #define NI_NAMEREQD     0x00000004
 202 #define NI_NUMERICSERV  0x00000008
 203 #define NI_DGRAM        0x00000010
 204 #define NI_WITHSCOPEID  0x00000020
 205
 206 /*
 207  * Scope delimit character
 208  */
 209 #define SCOPE_DELIMITER '%'
 210
 211 /*
 212  * data types - basically forward decl for getnameinfo()
 213  */
 214
 215 __BEGIN_DECLS
 216 void            endhostent (void);
 217 void            endnetent (void);
 218 void            endnetgrent (void);
 219 void            endprotoent (void);
 220 void            endservent (void);
 221 void            freehostent (struct hostent *);
 222 struct hostent  *gethostbyaddr (const char *, int, int);
 223 struct hostent  *gethostbyname (const char *);
 224 struct hostent  *gethostbyname2 (const char *, int);
 225 struct hostent  *gethostent (void);
 226 struct hostent  *getipnodebyaddr (const void *, size_t, int, int *);
 227 struct hostent  *getipnodebyname (const char *, int, int, int *);
 228 struct netent   *getnetbyaddr (unsigned long, int);
 229 struct netent   *getnetbyname (const char *);
 230 struct netent   *getnetent (void);
 231 int             getnetgrent (char **, char **, char **);
 232 struct protoent *getprotobyname (const char *);
 233 struct protoent *getprotobynumber (int);
 234 struct protoent *getprotoent (void);
 235 struct servent  *getservbyname (const char *, const char *);
 236 struct servent  *getservbyport (int, const char *);
 237 struct servent  *getservent (void);
 238 void            herror (const char *);
 239 __const char    *hstrerror (int);
 240 int             innetgr (const char *, const char *, const char *,
 241                                 const char *);
 242 void            sethostent (int);
 243 /* void         sethostfile (const char *); */
 244 void            setnetent (int);
 245 void            setprotoent (int);
 246 int             getaddrinfo (const char *, const char *,
 247                                  const struct addrinfo *, struct addrinfo **);
 248 int             getnameinfo (const struct sockaddr *, socklen_t, char *,
 249                                  size_t, char *, size_t, int);
 250 void            freeaddrinfo (struct addrinfo *);
 251 const char      *gai_strerror (int);
 252 void            setnetgrent (const char *);
 253 void            setservent (int);
 254
 255 /*
 256  * PRIVATE functions specific to the FreeBSD implementation
 257  */
 258
 259 /* DO NOT USE THESE, THEY ARE SUBJECT TO CHANGE AND ARE NOT PORTABLE!!! */
 260 void    _sethosthtent (int);
 261 void    _endhosthtent (void);
 262 void    _sethostdnsent (int);
 263 void    _endhostdnsent (void);
 264 void    _setnethtent (int);
 265 void    _endnethtent (void);
 266 void    _setnetdnsent (int);
 267 void    _endnetdnsent (void);
 268 struct hostent * _gethostbyhtname  (const char *, int);
 269 struct hostent * _gethostbydnsname (const char *, int);
 270 struct hostent * _gethostbynisname (const char *, int);
 271 struct hostent * _gethostbyhtaddr  (const char *, int, int);
 272 struct hostent * _gethostbydnsaddr (const char *, int, int);
 273 struct hostent * _gethostbynisaddr (const char *, int, int);
 274 struct netent *  _getnetbyhtname  (const char *);
 275 struct netent *  _getnetbydnsname (const char *);
 276 struct netent *  _getnetbynisname (const char *);
 277 struct netent *  _getnetbyhtaddr  (unsigned long, int);
 278 struct netent *  _getnetbydnsaddr (unsigned long, int);
 279 struct netent *  _getnetbynisaddr (unsigned long, int);
 280 void _map_v4v6_address (const char *, char *);
 281 void _map_v4v6_hostent (struct hostent *, char **, int *);
 282 __END_DECLS
 283
 284 #endif /* !_NETDB_H_ */