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