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. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * -
  30  * Portions Copyright (c) 1993 by Digital Equipment Corporation.
  31  *
  32  * Permission to use, copy, modify, and distribute this software for any
  33  * purpose with or without fee is hereby granted, provided that the above
  34  * copyright notice and this permission notice appear in all copies, and that
  35  * the name of Digital Equipment Corporation not be used in advertising or
  36  * publicity pertaining to distribution of the document or software without
  37  * specific, written prior permission.
  38  *
  39  * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
  40  * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
  41  * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
  42  * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
  43  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  44  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
  45  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  46  * SOFTWARE.
  47  * -
  48  * --Copyright--
  49  */
  50
  51 /*
  52  *      @(#)netdb.h     8.1 (Berkeley) 6/2/93
  53  *      From: Id: netdb.h,v 8.9 1996/11/19 08:39:29 vixie Exp $
  54  * $FreeBSD: src/include/netdb.h,v 1.45 2009/03/14 20:04:28 das Exp $
  55  */
  56
  57 #ifndef _NETDB_H_
  58 #define _NETDB_H_
  59
  60 #include <sys/cdefs.h>
  61 #include <machine/stdint.h>     /* for __size_t, __socklen_t */
  62 #include <stdint.h>
  63
  64 #ifndef _IN_ADDR_T_DECLARED
  65 typedef __uint32_t      in_addr_t;      /* base type for internet address */
  66 #define _IN_ADDR_T_DECLARED
  67 #endif
  68
  69 #ifndef _IN_PORT_T_DECLARED
  70 typedef __uint16_t      in_port_t;
  71 #define _IN_PORT_T_DECLARED
  72 #endif
  73
  74 #ifndef _SIZE_T_DECLARED
  75 typedef __size_t        size_t;
  76 #define _SIZE_T_DECLARED
  77 #endif
  78
  79 #ifndef _SOCKLEN_T_DECLARED
  80 typedef __socklen_t     socklen_t;
  81 #define _SOCKLEN_T_DECLARED
  82 #endif
  83
  84 #ifndef _PATH_HEQUIV
  85 # define        _PATH_HEQUIV    "/etc/hosts.equiv"
  86 #endif
  87 #define _PATH_HOSTS     "/etc/hosts"
  88 #define _PATH_NETWORKS  "/etc/networks"
  89 #define _PATH_PROTOCOLS "/etc/protocols"
  90 #define _PATH_SERVICES  "/etc/services"
  91
  92 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE < 200809)
  93 #define h_errno (*__h_errno())
  94 #endif
  95
  96 /*
  97  * Structures returned by network data base library.  All addresses are
  98  * supplied in host order, and returned in network order (suitable for
  99  * use in system calls).
 100  */
 101 struct hostent {
 102         char    *h_name;        /* official name of host */
 103         char    **h_aliases;    /* alias list */
 104         int     h_addrtype;     /* host address type */
 105         int     h_length;       /* length of address */
 106         char    **h_addr_list;  /* list of addresses from name server */
 107 #if __BSD_VISIBLE
 108 #define h_addr  h_addr_list[0]  /* address, for backward compatibility */
 109 #endif
 110 };
 111
 112 struct netent {
 113         char            *n_name;        /* official name of net */
 114         char            **n_aliases;    /* alias list */
 115         int             n_addrtype;     /* net address type */
 116         uint32_t        n_net;          /* network # */
 117 };
 118
 119 struct servent {
 120         char    *s_name;        /* official service name */
 121         char    **s_aliases;    /* alias list */
 122         int     s_port;         /* port # */
 123         char    *s_proto;       /* protocol to use */
 124 };
 125
 126 struct protoent {
 127         char    *p_name;        /* official protocol name */
 128         char    **p_aliases;    /* alias list */
 129         int     p_proto;        /* protocol # */
 130 };
 131
 132 struct addrinfo {
 133         int     ai_flags;       /* AI_PASSIVE, AI_CANONNAME, AI_NUMERICHOST */
 134         int     ai_family;      /* PF_xxx */
 135         int     ai_socktype;    /* SOCK_xxx */
 136         int     ai_protocol;    /* 0 or IPPROTO_xxx for IPv4 and IPv6 */
 137         socklen_t ai_addrlen;   /* length of ai_addr */
 138         char    *ai_canonname;  /* canonical name for hostname */
 139         struct  sockaddr *ai_addr;      /* binary address */
 140         struct  addrinfo *ai_next;      /* next structure in linked list */
 141 };
 142
 143 /*
 144  * Error return codes from gethostbyname() and gethostbyaddr()
 145  * (left in h_errno).
 146  */
 147
 148 #if __BSD_VISIBLE
 149 #define NETDB_INTERNAL  -1      /* see errno */
 150 #define NETDB_SUCCESS   0       /* no problem */
 151 #endif
 152 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE < 200809)
 153 #define HOST_NOT_FOUND  1 /* Authoritative Answer Host not found */
 154 #define TRY_AGAIN       2 /* Non-Authoritative Host not found, or SERVERFAIL */
 155 #define NO_RECOVERY     3 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP */
 156 #define NO_DATA         4 /* Valid name, no data record of requested type */
 157 #endif
 158 #if __BSD_VISIBLE
 159 #define NO_ADDRESS      NO_DATA         /* no address, look for MX record */
 160 #endif
 161
 162 /*
 163  * Error return codes from getaddrinfo()
 164  */
 165 #if __BSD_VISIBLE
 166 /* XXX deprecated */
 167 #define EAI_ADDRFAMILY   1      /* address family for hostname not supported */
 168 #endif
 169 #define EAI_AGAIN        2      /* temporary failure in name resolution */
 170 #define EAI_BADFLAGS     3      /* invalid value for ai_flags */
 171 #define EAI_FAIL         4      /* non-recoverable failure in name resolution */
 172 #define EAI_FAMILY       5      /* ai_family not supported */
 173 #define EAI_MEMORY       6      /* memory allocation failure */
 174 #if __BSD_VISIBLE
 175 /* XXX deprecated */
 176 #define EAI_NODATA       7      /* no address associated with hostname */
 177 #endif
 178 #define EAI_NONAME       8      /* hostname nor servname provided, or not known */
 179 #define EAI_SERVICE      9      /* servname not supported for ai_socktype */
 180 #define EAI_SOCKTYPE    10      /* ai_socktype not supported */
 181 #define EAI_SYSTEM      11      /* system error returned in errno */
 182 #if __BSD_VISIBLE
 183 #define EAI_BADHINTS    12      /* invalid value for hints */
 184 #define EAI_PROTOCOL    13      /* resolved protocol is unknown */
 185 #endif
 186 #define EAI_OVERFLOW    14      /* argument buffer overflow */
 187 #if __BSD_VISIBLE
 188 #define EAI_MAX         15
 189 #endif
 190
 191 /*
 192  * Flag values for getaddrinfo()
 193  */
 194 #define AI_PASSIVE      0x00000001 /* get address to use bind() */
 195 #define AI_CANONNAME    0x00000002 /* fill ai_canonname */
 196 #define AI_NUMERICHOST  0x00000004 /* prevent host name resolution */
 197 #define AI_NUMERICSERV  0x00000008 /* prevent service name resolution */
 198 #if __BSD_VISIBLE
 199 /* valid flags for addrinfo (not a standard def, apps should not use it) */
 200 #define AI_MASK \
 201     (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_NUMERICSERV | \
 202     AI_ADDRCONFIG)
 203 #endif
 204
 205 #define AI_ALL          0x00000100 /* IPv6 and IPv4-mapped (with AI_V4MAPPED) */
 206 #if __BSD_VISIBLE
 207 #define AI_V4MAPPED_CFG 0x00000200 /* accept IPv4-mapped if kernel supports */
 208 #endif
 209 #define AI_ADDRCONFIG   0x00000400 /* only if any address is assigned */
 210 #define AI_V4MAPPED     0x00000800 /* accept IPv4-mapped IPv6 address */
 211 #if __BSD_VISIBLE
 212 /* special recommended flags for getipnodebyname */
 213 #define AI_DEFAULT      (AI_V4MAPPED_CFG | AI_ADDRCONFIG)
 214
 215 /*
 216  * Constants for getnameinfo()
 217  */
 218 #define NI_MAXHOST      1025
 219 #define NI_MAXSERV      32
 220 #endif
 221
 222 /*
 223  * Flag values for getnameinfo()
 224  */
 225 #define NI_NOFQDN       0x00000001
 226 #define NI_NUMERICHOST  0x00000002
 227 #define NI_NAMEREQD     0x00000004
 228 #define NI_NUMERICSERV  0x00000008
 229 #define NI_DGRAM        0x00000010
 230 #if __BSD_VISIBLE
 231 #define NI_WITHSCOPEID  0x00000020      /* XXX deprecated */
 232 #endif
 233 #define NI_NUMERICSCOPE 0x00000040
 234
 235 #if __BSD_VISIBLE
 236 /*
 237  * Scope delimit character
 238  */
 239 #define SCOPE_DELIMITER '%'
 240 #endif
 241
 242 __BEGIN_DECLS
 243 void            endhostent(void);
 244 void            endnetent(void);
 245 void            endprotoent(void);
 246 void            endservent(void);
 247 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE < 200809)
 248 struct hostent  *gethostbyaddr(const void *, socklen_t, int);
 249 struct hostent  *gethostbyname(const char *);
 250 #endif
 251 struct hostent  *gethostent(void);
 252 struct netent   *getnetbyaddr(uint32_t, int);
 253 struct netent   *getnetbyname(const char *);
 254 struct netent   *getnetent(void);
 255 struct protoent *getprotobyname(const char *);
 256 struct protoent *getprotobynumber(int);
 257 struct protoent *getprotoent(void);
 258 struct servent  *getservbyname(const char *, const char *);
 259 struct servent  *getservbyport(int, const char *);
 260 struct servent  *getservent(void);
 261 void            sethostent(int);
 262 /* void         sethostfile(const char *); */
 263 void            setnetent(int);
 264 void            setprotoent(int);
 265 int             getaddrinfo(const char * __restrict, const char * __restrict,
 266                     const struct addrinfo * __restrict,
 267                     struct addrinfo ** __restrict);
 268 /* XXX nodeLen and serviceLen should be socklen_t */
 269 int             getnameinfo(const struct sockaddr * __restrict, socklen_t,
 270                     char * __restrict, size_t, char * __restrict, size_t, int);
 271 void            freeaddrinfo(struct addrinfo *);
 272 const char      *gai_strerror(int);
 273 void            setservent(int);
 274
 275 #if __BSD_VISIBLE
 276 void            endnetgrent(void);
 277 void            freehostent(struct hostent *);
 278 int             gethostbyaddr_r(const void *, socklen_t, int, struct hostent *,
 279                                 char *, size_t, struct hostent **, int *);
 280 int             gethostbyname_r(const char *, struct hostent *, char *, size_t,
 281                                 struct hostent **, int *);
 282 struct hostent  *gethostbyname2(const char *, int);
 283 int             gethostbyname2_r(const char *, int, struct hostent *, char *,
 284                                  size_t, struct hostent **, int *);
 285 int             gethostent_r(struct hostent *, char *, size_t,
 286                              struct hostent **, int *);
 287 struct hostent  *getipnodebyaddr(const void *, size_t, int, int *);
 288 struct hostent  *getipnodebyname(const char *, int, int, int *);
 289 int             getnetbyaddr_r(uint32_t, int, struct netent *, char *, size_t,
 290                                struct netent **, int *);
 291 int             getnetbyname_r(const char *, struct netent *, char *, size_t,
 292                                struct netent **, int *);
 293 int             getnetent_r(struct netent *, char *, size_t, struct netent **,
 294                             int *);
 295 int             getnetgrent(char **, char **, char **);
 296 int             getprotobyname_r(const char *, struct protoent *, char *,
 297                                  size_t, struct protoent **);
 298 int             getprotobynumber_r(int, struct protoent *, char *, size_t,
 299                                    struct protoent **);
 300 int             getprotoent_r(struct protoent *, char *, size_t,
 301                               struct protoent **);
 302 int             getservbyname_r(const char *, const char *, struct servent *,
 303                                 char *, size_t, struct servent **);
 304 int             getservbyport_r(int, const char *, struct servent *, char *,
 305                                 size_t, struct servent **);
 306 int             getservent_r(struct servent *, char *, size_t,
 307                              struct servent **);
 308 void            herror(const char *);
 309 const char      *hstrerror(int);
 310 int             innetgr(const char *, const char *, const char *, const char *);
 311 void            setnetgrent(const char *);
 312 #endif
 313
 314
 315 /*
 316  * PRIVATE functions specific to the FreeBSD implementation
 317  */
 318
 319 /* DO NOT USE THESE, THEY ARE SUBJECT TO CHANGE AND ARE NOT PORTABLE!!! */
 320 int     * __h_errno(void);
 321 __END_DECLS
 322
 323 #endif /* !_NETDB_H_ */