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