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