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.2 2003/06/17 04:25:56 dillon Exp $
  60  */
  61
  62 #ifndef _NETDB_H_
  63 #define _NETDB_H_
  64
  65 #include <machine/ansi.h>
  66 #include <sys/cdefs.h>
  67
  68 #ifdef  _BSD_SIZE_T_
  69 typedef _BSD_SIZE_T_    size_t;
  70 #undef  _BSD_SIZE_T_
  71 #endif
  72
  73 #ifndef _PATH_HEQUIV
  74 # define        _PATH_HEQUIV    "/etc/hosts.equiv"
  75 #endif
  76 #define _PATH_HOSTS     "/etc/hosts"
  77 #define _PATH_NETWORKS  "/etc/networks"
  78 #define _PATH_PROTOCOLS "/etc/protocols"
  79 #define _PATH_SERVICES  "/etc/services"
  80
  81 extern int h_errno;
  82
  83 /*
  84  * Structures returned by network data base library.  All addresses are
  85  * supplied in host order, and returned in network order (suitable for
  86  * use in system calls).
  87  */
  88 struct  hostent {
  89         char    *h_name;        /* official name of host */
  90         char    **h_aliases;    /* alias list */
  91         int     h_addrtype;     /* host address type */
  92         int     h_length;       /* length of address */
  93         char    **h_addr_list;  /* list of addresses from name server */
  94 #define h_addr  h_addr_list[0]  /* address, for backward compatibility */
  95 };
  96
  97 /*
  98  * Assumption here is that a network number
  99  * fits in an unsigned long -- probably a poor one.
 100  */
 101 struct  netent {
 102         char            *n_name;        /* official name of net */
 103         char            **n_aliases;    /* alias list */
 104         int             n_addrtype;     /* net address type */
 105         unsigned long   n_net;          /* network # */
 106 };
 107
 108 struct  servent {
 109         char    *s_name;        /* official service name */
 110         char    **s_aliases;    /* alias list */
 111         int     s_port;         /* port # */
 112         char    *s_proto;       /* protocol to use */
 113 };
 114
 115 struct  protoent {
 116         char    *p_name;        /* official protocol name */
 117         char    **p_aliases;    /* alias list */
 118         int     p_proto;        /* protocol # */
 119 };
 120
 121 struct addrinfo {
 122         int     ai_flags;       /* AI_PASSIVE, AI_CANONNAME, AI_NUMERICHOST */
 123         int     ai_family;      /* PF_xxx */
 124         int     ai_socktype;    /* SOCK_xxx */
 125         int     ai_protocol;    /* 0 or IPPROTO_xxx for IPv4 and IPv6 */
 126         size_t  ai_addrlen;     /* length of ai_addr */
 127         char    *ai_canonname;  /* canonical name for hostname */
 128         struct  sockaddr *ai_addr;      /* binary address */
 129         struct  addrinfo *ai_next;      /* next structure in linked list */
 130 };
 131
 132 /*
 133  * Error return codes from gethostbyname() and gethostbyaddr()
 134  * (left in extern int h_errno).
 135  */
 136
 137 #define NETDB_INTERNAL  -1      /* see errno */
 138 #define NETDB_SUCCESS   0       /* no problem */
 139 #define HOST_NOT_FOUND  1 /* Authoritative Answer Host not found */
 140 #define TRY_AGAIN       2 /* Non-Authoritative Host not found, or SERVERFAIL */
 141 #define NO_RECOVERY     3 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP */
 142 #define NO_DATA         4 /* Valid name, no data record of requested type */
 143 #define NO_ADDRESS      NO_DATA         /* no address, look for MX record */
 144
 145 /*
 146  * Error return codes from getaddrinfo()
 147  */
 148 #define EAI_ADDRFAMILY   1      /* address family for hostname not supported */
 149 #define EAI_AGAIN        2      /* temporary failure in name resolution */
 150 #define EAI_BADFLAGS     3      /* invalid value for ai_flags */
 151 #define EAI_FAIL         4      /* non-recoverable failure in name resolution */
 152 #define EAI_FAMILY       5      /* ai_family not supported */
 153 #define EAI_MEMORY       6      /* memory allocation failure */
 154 #define EAI_NODATA       7      /* no address associated with hostname */
 155 #define EAI_NONAME       8      /* hostname nor servname provided, or not known */
 156 #define EAI_SERVICE      9      /* servname not supported for ai_socktype */
 157 #define EAI_SOCKTYPE    10      /* ai_socktype not supported */
 158 #define EAI_SYSTEM      11      /* system error returned in errno */
 159 #define EAI_BADHINTS    12
 160 #define EAI_PROTOCOL    13
 161 #define EAI_MAX         14
 162
 163 /*
 164  * Flag values for getaddrinfo()
 165  */
 166 #define AI_PASSIVE      0x00000001 /* get address to use bind() */
 167 #define AI_CANONNAME    0x00000002 /* fill ai_canonname */
 168 #define AI_NUMERICHOST  0x00000004 /* prevent name resolution */
 169 /* valid flags for addrinfo */
 170 #define AI_MASK \
 171     (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_ADDRCONFIG)
 172
 173 #define AI_ALL          0x00000100 /* IPv6 and IPv4-mapped (with AI_V4MAPPED) */
 174 #define AI_V4MAPPED_CFG 0x00000200 /* accept IPv4-mapped if kernel supports */
 175 #define AI_ADDRCONFIG   0x00000400 /* only if any address is assigned */
 176 #define AI_V4MAPPED     0x00000800 /* accept IPv4-mapped IPv6 address */
 177 /* special recommended flags for getipnodebyname */
 178 #define AI_DEFAULT      (AI_V4MAPPED_CFG | AI_ADDRCONFIG)
 179
 180 /*
 181  * Constants for getnameinfo()
 182  */
 183 #define NI_MAXHOST      1025
 184 #define NI_MAXSERV      32
 185
 186 /*
 187  * Flag values for getnameinfo()
 188  */
 189 #define NI_NOFQDN       0x00000001
 190 #define NI_NUMERICHOST  0x00000002
 191 #define NI_NAMEREQD     0x00000004
 192 #define NI_NUMERICSERV  0x00000008
 193 #define NI_DGRAM        0x00000010
 194 #define NI_WITHSCOPEID  0x00000020
 195
 196 /*
 197  * Scope delimit character
 198  */
 199 #define SCOPE_DELIMITER '%'
 200
 201 /*
 202  * data types - basically forward decl for getnameinfo()
 203  */
 204 #ifdef  _BSD_SOCKLEN_T_
 205 typedef _BSD_SOCKLEN_T_ socklen_t;
 206 #undef  _BSD_SOCKLEN_T_
 207 #endif
 208
 209 __BEGIN_DECLS
 210 void            endhostent __P((void));
 211 void            endnetent __P((void));
 212 void            endnetgrent __P((void));
 213 void            endprotoent __P((void));
 214 void            endservent __P((void));
 215 void            freehostent __P((struct hostent *));
 216 struct hostent  *gethostbyaddr __P((const char *, int, int));
 217 struct hostent  *gethostbyname __P((const char *));
 218 struct hostent  *gethostbyname2 __P((const char *, int));
 219 struct hostent  *gethostent __P((void));
 220 struct hostent  *getipnodebyaddr __P((const void *, size_t, int, int *));
 221 struct hostent  *getipnodebyname __P((const char *, int, int, int *));
 222 struct netent   *getnetbyaddr __P((unsigned long, int));
 223 struct netent   *getnetbyname __P((const char *));
 224 struct netent   *getnetent __P((void));
 225 int             getnetgrent __P((char **, char **, char **));
 226 struct protoent *getprotobyname __P((const char *));
 227 struct protoent *getprotobynumber __P((int));
 228 struct protoent *getprotoent __P((void));
 229 struct servent  *getservbyname __P((const char *, const char *));
 230 struct servent  *getservbyport __P((int, const char *));
 231 struct servent  *getservent __P((void));
 232 void            herror __P((const char *));
 233 __const char    *hstrerror __P((int));
 234 int             innetgr __P((const char *, const char *, const char *,
 235                                 const char *));
 236 void            sethostent __P((int));
 237 /* void         sethostfile __P((const char *)); */
 238 void            setnetent __P((int));
 239 void            setprotoent __P((int));
 240 int             getaddrinfo __P((const char *, const char *,
 241                                  const struct addrinfo *, struct addrinfo **));
 242 int             getnameinfo __P((const struct sockaddr *, socklen_t, char *,
 243                                  size_t, char *, size_t, int));
 244 void            freeaddrinfo __P((struct addrinfo *));
 245 char            *gai_strerror __P((int));
 246 void            setnetgrent __P((const char *));
 247 void            setservent __P((int));
 248
 249 /*
 250  * PRIVATE functions specific to the FreeBSD implementation
 251  */
 252
 253 /* DO NOT USE THESE, THEY ARE SUBJECT TO CHANGE AND ARE NOT PORTABLE!!! */
 254 void    _sethosthtent __P((int));
 255 void    _endhosthtent __P((void));
 256 void    _sethostdnsent __P((int));
 257 void    _endhostdnsent __P((void));
 258 void    _setnethtent __P((int));
 259 void    _endnethtent __P((void));
 260 void    _setnetdnsent __P((int));
 261 void    _endnetdnsent __P((void));
 262 struct hostent * _gethostbyhtname  __P((const char *, int));
 263 struct hostent * _gethostbydnsname __P((const char *, int));
 264 struct hostent * _gethostbynisname __P((const char *, int));
 265 struct hostent * _gethostbyhtaddr  __P((const char *, int, int));
 266 struct hostent * _gethostbydnsaddr __P((const char *, int, int));
 267 struct hostent * _gethostbynisaddr __P((const char *, int, int));
 268 struct netent *  _getnetbyhtname  __P((const char *));
 269 struct netent *  _getnetbydnsname __P((const char *));
 270 struct netent *  _getnetbynisname __P((const char *));
 271 struct netent *  _getnetbyhtaddr  __P((unsigned long, int));
 272 struct netent *  _getnetbydnsaddr __P((unsigned long, int));
 273 struct netent *  _getnetbynisaddr __P((unsigned long, int));
 274 void _map_v4v6_address __P((const char *, char *));
 275 void _map_v4v6_hostent __P((struct hostent *, char **, int *));
 276 __END_DECLS
 277
 278 #endif /* !_NETDB_H_ */