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