netdb.h revision 141908
1193326Sed/*- 2193326Sed * Copyright (c) 1980, 1983, 1988, 1993 3193326Sed * The Regents of the University of California. All rights reserved. 4193326Sed * 5193326Sed * Redistribution and use in source and binary forms, with or without 6193326Sed * modification, are permitted provided that the following conditions 7193326Sed * are met: 8193326Sed * 1. Redistributions of source code must retain the above copyright 9193326Sed * notice, this list of conditions and the following disclaimer. 10193326Sed * 2. Redistributions in binary form must reproduce the above copyright 11193326Sed * notice, this list of conditions and the following disclaimer in the 12193326Sed * documentation and/or other materials provided with the distribution. 13193326Sed * 3. All advertising materials mentioning features or use of this software 14212904Sdim * must display the following acknowledgement: 15193326Sed * This product includes software developed by the University of 16198092Srdivacky * California, Berkeley and its contributors. 17198092Srdivacky * 4. Neither the name of the University nor the names of its contributors 18205219Srdivacky * may be used to endorse or promote products derived from this software 19235633Sdim * without specific prior written permission. 20206084Srdivacky * 21203955Srdivacky * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22252723Sdim * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23252723Sdim * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24252723Sdim * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25203955Srdivacky * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26193326Sed * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27212904Sdim * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28193326Sed * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29207619Srdivacky * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30207619Srdivacky * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31207619Srdivacky * SUCH DAMAGE. 32207619Srdivacky * 33207619Srdivacky * - 34207619Srdivacky * Portions Copyright (c) 1993 by Digital Equipment Corporation. 35207619Srdivacky * 36193326Sed * Permission to use, copy, modify, and distribute this software for any 37193326Sed * purpose with or without fee is hereby granted, provided that the above 38193326Sed * copyright notice and this permission notice appear in all copies, and that 39198092Srdivacky * the name of Digital Equipment Corporation not be used in advertising or 40193326Sed * publicity pertaining to distribution of the document or software without 41193326Sed * specific, written prior permission. 42193326Sed * 43193326Sed * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL 44193326Sed * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES 45193326Sed * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL DIGITAL EQUIPMENT 46193326Sed * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 47198092Srdivacky * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR 48193326Sed * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS 49193326Sed * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS 50193326Sed * SOFTWARE. 51198092Srdivacky * - 52198092Srdivacky * --Copyright-- 53193326Sed */ 54193326Sed 55193326Sed/* 56201361Srdivacky * @(#)netdb.h 8.1 (Berkeley) 6/2/93 57201361Srdivacky * From: Id: netdb.h,v 8.9 1996/11/19 08:39:29 vixie Exp $ 58193326Sed * $FreeBSD: head/include/netdb.h 141908 2005-02-14 11:33:12Z phantom $ 59193326Sed */ 60198092Srdivacky 61193326Sed#ifndef _NETDB_H_ 62193326Sed#define _NETDB_H_ 63193326Sed 64193326Sed#include <sys/cdefs.h> 65207619Srdivacky#include <sys/_types.h> 66207619Srdivacky 67207619Srdivacky#ifndef _SIZE_T_DECLARED 68207619Srdivackytypedef __size_t size_t; 69207619Srdivacky#define _SIZE_T_DECLARED 70207619Srdivacky#endif 71207619Srdivacky 72207619Srdivacky#ifndef _SOCKLEN_T_DECLARED 73207619Srdivackytypedef __socklen_t socklen_t; 74207619Srdivacky#define _SOCKLEN_T_DECLARED 75207619Srdivacky#endif 76207619Srdivacky 77207619Srdivacky#ifndef _PATH_HEQUIV 78207619Srdivacky# define _PATH_HEQUIV "/etc/hosts.equiv" 79203955Srdivacky#endif 80203955Srdivacky#define _PATH_HOSTS "/etc/hosts" 81206084Srdivacky#define _PATH_NETWORKS "/etc/networks" 82193326Sed#define _PATH_PROTOCOLS "/etc/protocols" 83206084Srdivacky#define _PATH_SERVICES "/etc/services" 84206084Srdivacky 85206084Srdivacky#define h_errno (*__h_error()) 86205408Srdivacky 87252723Sdim/* 88205408Srdivacky * Structures returned by network data base library. All addresses are 89205408Srdivacky * supplied in host order, and returned in network order (suitable for 90252723Sdim * use in system calls). 91205408Srdivacky */ 92206084Srdivackystruct hostent { 93206084Srdivacky char *h_name; /* official name of host */ 94206084Srdivacky char **h_aliases; /* alias list */ 95206084Srdivacky int h_addrtype; /* host address type */ 96206084Srdivacky int h_length; /* length of address */ 97206084Srdivacky char **h_addr_list; /* list of addresses from name server */ 98206084Srdivacky#define h_addr h_addr_list[0] /* address, for backward compatibility */ 99206084Srdivacky}; 100245431Sdim 101245431Sdim/* 102245431Sdim * Assumption here is that a network number 103245431Sdim * fits in an unsigned long -- probably a poor one. 104245431Sdim */ 105245431Sdimstruct netent { 106206084Srdivacky char *n_name; /* official name of net */ 107245431Sdim char **n_aliases; /* alias list */ 108245431Sdim int n_addrtype; /* net address type */ 109206084Srdivacky unsigned long n_net; /* network # */ 110206084Srdivacky}; 111245431Sdim 112245431Sdimstruct servent { 113226890Sdim char *s_name; /* official service name */ 114226890Sdim char **s_aliases; /* alias list */ 115226890Sdim int s_port; /* port # */ 116226890Sdim char *s_proto; /* protocol to use */ 117206084Srdivacky}; 118206084Srdivacky 119206084Srdivackystruct protoent { 120206084Srdivacky char *p_name; /* official protocol name */ 121206084Srdivacky char **p_aliases; /* alias list */ 122205408Srdivacky int p_proto; /* protocol # */ 123203955Srdivacky}; 124198092Srdivacky 125206084Srdivackystruct addrinfo { 126206084Srdivacky int ai_flags; /* AI_PASSIVE, AI_CANONNAME, AI_NUMERICHOST */ 127205408Srdivacky int ai_family; /* PF_xxx */ 128205408Srdivacky int ai_socktype; /* SOCK_xxx */ 129205408Srdivacky int ai_protocol; /* 0 or IPPROTO_xxx for IPv4 and IPv6 */ 130205408Srdivacky size_t ai_addrlen; /* length of ai_addr */ 131203955Srdivacky char *ai_canonname; /* canonical name for hostname */ 132198092Srdivacky struct sockaddr *ai_addr; /* binary address */ 133206084Srdivacky struct addrinfo *ai_next; /* next structure in linked list */ 134206084Srdivacky}; 135206084Srdivacky 136206084Srdivacky/* 137206084Srdivacky * Error return codes from gethostbyname() and gethostbyaddr() 138206084Srdivacky * (left in h_errno). 139226890Sdim */ 140206084Srdivacky 141206084Srdivacky#define NETDB_INTERNAL -1 /* see errno */ 142226890Sdim#define NETDB_SUCCESS 0 /* no problem */ 143226890Sdim#define HOST_NOT_FOUND 1 /* Authoritative Answer Host not found */ 144206084Srdivacky#define TRY_AGAIN 2 /* Non-Authoritative Host not found, or SERVERFAIL */ 145203955Srdivacky#define NO_RECOVERY 3 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP */ 146207619Srdivacky#define NO_DATA 4 /* Valid name, no data record of requested type */ 147218893Sdim#define NO_ADDRESS NO_DATA /* no address, look for MX record */ 148207619Srdivacky 149212904Sdim/* 150212904Sdim * Error return codes from getaddrinfo() 151207619Srdivacky */ 152207619Srdivacky#if 0 153207619Srdivacky/* obsoleted */ 154207619Srdivacky#define EAI_ADDRFAMILY 1 /* address family for hostname not supported */ 155207619Srdivacky#endif 156207619Srdivacky#define EAI_AGAIN 2 /* temporary failure in name resolution */ 157207619Srdivacky#define EAI_BADFLAGS 3 /* invalid value for ai_flags */ 158207619Srdivacky#define EAI_FAIL 4 /* non-recoverable failure in name resolution */ 159226890Sdim#define EAI_FAMILY 5 /* ai_family not supported */ 160245431Sdim#define EAI_MEMORY 6 /* memory allocation failure */ 161245431Sdim#if 0 162207619Srdivacky/* obsoleted */ 163207619Srdivacky#define EAI_NODATA 7 /* no address associated with hostname */ 164207619Srdivacky#endif 165207619Srdivacky#define EAI_NONAME 8 /* hostname nor servname provided, or not known */ 166207619Srdivacky#define EAI_SERVICE 9 /* servname not supported for ai_socktype */ 167207619Srdivacky#define EAI_SOCKTYPE 10 /* ai_socktype not supported */ 168207619Srdivacky#define EAI_SYSTEM 11 /* system error returned in errno */ 169207619Srdivacky#define EAI_BADHINTS 12 170245431Sdim#define EAI_PROTOCOL 13 171245431Sdim#define EAI_MAX 14 172207619Srdivacky 173207619Srdivacky/* 174207619Srdivacky * Flag values for getaddrinfo() 175235633Sdim */ 176235633Sdim#define AI_PASSIVE 0x00000001 /* get address to use bind() */ 177235633Sdim#define AI_CANONNAME 0x00000002 /* fill ai_canonname */ 178235633Sdim#define AI_NUMERICHOST 0x00000004 /* prevent host name resolution */ 179207619Srdivacky#define AI_NUMERICSERV 0x00000008 /* prevent service name resolution */ 180207619Srdivacky/* valid flags for addrinfo (not a standard def, apps should not use it) */ 181207619Srdivacky#define AI_MASK \ 182207619Srdivacky (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_NUMERICSERV | \ 183207619Srdivacky AI_ADDRCONFIG) 184207619Srdivacky 185207619Srdivacky#define AI_ALL 0x00000100 /* IPv6 and IPv4-mapped (with AI_V4MAPPED) */ 186207619Srdivacky#define AI_V4MAPPED_CFG 0x00000200 /* accept IPv4-mapped if kernel supports */ 187207619Srdivacky#define AI_ADDRCONFIG 0x00000400 /* only if any address is assigned */ 188207619Srdivacky#define AI_V4MAPPED 0x00000800 /* accept IPv4-mapped IPv6 address */ 189207619Srdivacky/* special recommended flags for getipnodebyname */ 190207619Srdivacky#define AI_DEFAULT (AI_V4MAPPED_CFG | AI_ADDRCONFIG) 191207619Srdivacky 192207619Srdivacky/* 193207619Srdivacky * Constants for getnameinfo() 194207619Srdivacky */ 195207619Srdivacky#define NI_MAXHOST 1025 196207619Srdivacky#define NI_MAXSERV 32 197207619Srdivacky 198207619Srdivacky/* 199207619Srdivacky * Flag values for getnameinfo() 200207619Srdivacky */ 201207619Srdivacky#define NI_NOFQDN 0x00000001 202207619Srdivacky#define NI_NUMERICHOST 0x00000002 203207619Srdivacky#define NI_NAMEREQD 0x00000004 204207619Srdivacky#define NI_NUMERICSERV 0x00000008 205207619Srdivacky#define NI_DGRAM 0x00000010 206207619Srdivacky#if 1 /* obsolete */ 207207619Srdivacky#define NI_WITHSCOPEID 0x00000020 208207619Srdivacky#endif 209207619Srdivacky 210207619Srdivacky/* 211207619Srdivacky * Scope delimit character 212207619Srdivacky */ 213207619Srdivacky#define SCOPE_DELIMITER '%' 214207619Srdivacky 215207619Srdivacky__BEGIN_DECLS 216207619Srdivackyvoid endhostent(void); 217207619Srdivackyvoid endnetent(void); 218207619Srdivackyvoid endnetgrent(void); 219207619Srdivackyvoid endprotoent(void); 220252723Sdimvoid endservent(void); 221252723Sdimvoid freehostent(struct hostent *); 222252723Sdimstruct hostent *gethostbyaddr(const char *, int, int); 223252723Sdimstruct hostent *gethostbyname(const char *); 224252723Sdimstruct hostent *gethostbyname2(const char *, int); 225252723Sdimstruct hostent *gethostent(void); 226252723Sdimstruct hostent *getipnodebyaddr(const void *, size_t, int, int *); 227252723Sdimstruct hostent *getipnodebyname(const char *, int, int, int *); 228252723Sdimstruct netent *getnetbyaddr(unsigned long, int); 229207619Srdivackystruct netent *getnetbyname(const char *); 230207619Srdivackystruct netent *getnetent(void); 231207619Srdivackyint getnetgrent(char **, char **, char **); 232207619Srdivackystruct protoent *getprotobyname(const char *); 233207619Srdivackystruct protoent *getprotobynumber(int); 234207619Srdivackystruct protoent *getprotoent(void); 235207619Srdivackystruct servent *getservbyname(const char *, const char *); 236207619Srdivackystruct servent *getservbyport(int, const char *); 237207619Srdivackystruct servent *getservent(void); 238207619Srdivackyvoid herror(const char *); 239207619Srdivacky__const char *hstrerror(int); 240207619Srdivackyint innetgr(const char *, const char *, const char *, const char *); 241207619Srdivackyvoid sethostent(int); 242207619Srdivacky/* void sethostfile(const char *); */ 243207619Srdivackyvoid setnetent(int); 244207619Srdivackyvoid setprotoent(int); 245207619Srdivackyint getaddrinfo(const char *, const char *, 246207619Srdivacky const struct addrinfo *, struct addrinfo **); 247207619Srdivackyint getnameinfo(const struct sockaddr *, socklen_t, char *, 248207619Srdivacky size_t, char *, size_t, int); 249207619Srdivackyvoid freeaddrinfo(struct addrinfo *); 250203955Srdivackyconst char *gai_strerror(int); 251193326Sedvoid setnetgrent(const char *); 252207619Srdivackyvoid setservent(int); 253207619Srdivacky 254207619Srdivacky/* 255207619Srdivacky * PRIVATE functions specific to the FreeBSD implementation 256207619Srdivacky */ 257207619Srdivacky 258206084Srdivacky/* DO NOT USE THESE, THEY ARE SUBJECT TO CHANGE AND ARE NOT PORTABLE!!! */ 259207619Srdivackyint * __h_error(void); 260207619Srdivackyvoid _sethosthtent(int); 261207619Srdivackyvoid _endhosthtent(void); 262207619Srdivackyvoid _sethostdnsent(int); 263206084Srdivackyvoid _endhostdnsent(void); 264207619Srdivackyvoid _setnethtent(int); 265207619Srdivackyvoid _endnethtent(void); 266203955Srdivackyvoid _setnetdnsent(int); 267198092Srdivackyvoid _endnetdnsent(void); 268207619Srdivackystruct hostent * _gethostbynisname(const char *, int); 269207619Srdivackystruct hostent * _gethostbynisaddr(const char *, int, int); 270207619Srdivackyvoid _map_v4v6_address(const char *, char *); 271207619Srdivackyvoid _map_v4v6_hostent(struct hostent *, char **, char **); 272207619Srdivacky__END_DECLS 273207619Srdivacky 274207619Srdivacky#endif /* !_NETDB_H_ */ 275207619Srdivacky