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