netdb.h revision 126243
11539Srgrimes/*- 21539Srgrimes * Copyright (c) 1980, 1983, 1988, 1993 31539Srgrimes * The Regents of the University of California. All rights reserved. 41539Srgrimes * 51539Srgrimes * Redistribution and use in source and binary forms, with or without 61539Srgrimes * modification, are permitted provided that the following conditions 71539Srgrimes * are met: 81539Srgrimes * 1. Redistributions of source code must retain the above copyright 91539Srgrimes * notice, this list of conditions and the following disclaimer. 101539Srgrimes * 2. Redistributions in binary form must reproduce the above copyright 111539Srgrimes * notice, this list of conditions and the following disclaimer in the 121539Srgrimes * documentation and/or other materials provided with the distribution. 131539Srgrimes * 3. All advertising materials mentioning features or use of this software 141539Srgrimes * must display the following acknowledgement: 151539Srgrimes * This product includes software developed by the University of 161539Srgrimes * California, Berkeley and its contributors. 171539Srgrimes * 4. Neither the name of the University nor the names of its contributors 181539Srgrimes * may be used to endorse or promote products derived from this software 191539Srgrimes * without specific prior written permission. 201539Srgrimes * 211539Srgrimes * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 221539Srgrimes * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 231539Srgrimes * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 241539Srgrimes * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 251539Srgrimes * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 261539Srgrimes * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 271539Srgrimes * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 281539Srgrimes * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 291539Srgrimes * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 301539Srgrimes * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 311539Srgrimes * SUCH DAMAGE. 321539Srgrimes * 331539Srgrimes * - 341539Srgrimes * Portions Copyright (c) 1993 by Digital Equipment Corporation. 358858Srgrimes * 361539Srgrimes * Permission to use, copy, modify, and distribute this software for any 371539Srgrimes * purpose with or without fee is hereby granted, provided that the above 381539Srgrimes * copyright notice and this permission notice appear in all copies, and that 391539Srgrimes * the name of Digital Equipment Corporation not be used in advertising or 401539Srgrimes * publicity pertaining to distribution of the document or software without 411539Srgrimes * specific, written prior permission. 428858Srgrimes * 431539Srgrimes * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL 441539Srgrimes * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES 451539Srgrimes * OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL DIGITAL EQUIPMENT 461539Srgrimes * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 471539Srgrimes * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR 481539Srgrimes * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS 491539Srgrimes * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS 501539Srgrimes * SOFTWARE. 511539Srgrimes * - 521539Srgrimes * --Copyright-- 531539Srgrimes */ 541539Srgrimes 5536888Speter/* 5636888Speter * @(#)netdb.h 8.1 (Berkeley) 6/2/93 5736888Speter * From: Id: netdb.h,v 8.9 1996/11/19 08:39:29 vixie Exp $ 5850473Speter * $FreeBSD: head/include/netdb.h 126243 2004-02-25 21:03:46Z green $ 5936888Speter */ 6036888Speter 611539Srgrimes#ifndef _NETDB_H_ 621539Srgrimes#define _NETDB_H_ 631539Srgrimes 6484463Sbde#include <sys/cdefs.h> 65102227Smike#include <sys/_types.h> 6621055Speter 67102227Smike#ifndef _SIZE_T_DECLARED 68102227Smiketypedef __size_t size_t; 69102227Smike#define _SIZE_T_DECLARED 7072510Sume#endif 7172510Sume 72102227Smike#ifndef _SOCKLEN_T_DECLARED 73102227Smiketypedef __socklen_t socklen_t; 74102227Smike#define _SOCKLEN_T_DECLARED 7584463Sbde#endif 7684463Sbde 7736888Speter#ifndef _PATH_HEQUIV 7836888Speter# define _PATH_HEQUIV "/etc/hosts.equiv" 7936888Speter#endif 801539Srgrimes#define _PATH_HOSTS "/etc/hosts" 811539Srgrimes#define _PATH_NETWORKS "/etc/networks" 821539Srgrimes#define _PATH_PROTOCOLS "/etc/protocols" 831539Srgrimes#define _PATH_SERVICES "/etc/services" 841539Srgrimes 85126243Sgreen#define h_errno (*__h_error()) 8610132Speter 871539Srgrimes/* 881539Srgrimes * Structures returned by network data base library. All addresses are 891539Srgrimes * supplied in host order, and returned in network order (suitable for 901539Srgrimes * use in system calls). 911539Srgrimes */ 9283047Sobrienstruct hostent { 931539Srgrimes char *h_name; /* official name of host */ 941539Srgrimes char **h_aliases; /* alias list */ 951539Srgrimes int h_addrtype; /* host address type */ 961539Srgrimes int h_length; /* length of address */ 971539Srgrimes char **h_addr_list; /* list of addresses from name server */ 9813771Smpp#define h_addr h_addr_list[0] /* address, for backward compatibility */ 991539Srgrimes}; 1001539Srgrimes 1011539Srgrimes/* 1021539Srgrimes * Assumption here is that a network number 1031539Srgrimes * fits in an unsigned long -- probably a poor one. 1041539Srgrimes */ 10583047Sobrienstruct netent { 1061539Srgrimes char *n_name; /* official name of net */ 1071539Srgrimes char **n_aliases; /* alias list */ 1081539Srgrimes int n_addrtype; /* net address type */ 1091539Srgrimes unsigned long n_net; /* network # */ 1101539Srgrimes}; 1111539Srgrimes 11283047Sobrienstruct servent { 1131539Srgrimes char *s_name; /* official service name */ 1141539Srgrimes char **s_aliases; /* alias list */ 1151539Srgrimes int s_port; /* port # */ 1161539Srgrimes char *s_proto; /* protocol to use */ 1171539Srgrimes}; 1181539Srgrimes 11983047Sobrienstruct protoent { 1201539Srgrimes char *p_name; /* official protocol name */ 1211539Srgrimes char **p_aliases; /* alias list */ 1221539Srgrimes int p_proto; /* protocol # */ 1231539Srgrimes}; 1241539Srgrimes 12555163Sshinstruct addrinfo { 12655163Sshin int ai_flags; /* AI_PASSIVE, AI_CANONNAME, AI_NUMERICHOST */ 12755163Sshin int ai_family; /* PF_xxx */ 12855163Sshin int ai_socktype; /* SOCK_xxx */ 12955163Sshin int ai_protocol; /* 0 or IPPROTO_xxx for IPv4 and IPv6 */ 13055163Sshin size_t ai_addrlen; /* length of ai_addr */ 13155163Sshin char *ai_canonname; /* canonical name for hostname */ 13255163Sshin struct sockaddr *ai_addr; /* binary address */ 13355163Sshin struct addrinfo *ai_next; /* next structure in linked list */ 13455163Sshin}; 13555163Sshin 1361539Srgrimes/* 1371539Srgrimes * Error return codes from gethostbyname() and gethostbyaddr() 138126243Sgreen * (left in h_errno). 1391539Srgrimes */ 1401539Srgrimes 14110132Speter#define NETDB_INTERNAL -1 /* see errno */ 14210132Speter#define NETDB_SUCCESS 0 /* no problem */ 1431539Srgrimes#define HOST_NOT_FOUND 1 /* Authoritative Answer Host not found */ 14413771Smpp#define TRY_AGAIN 2 /* Non-Authoritative Host not found, or SERVERFAIL */ 1451539Srgrimes#define NO_RECOVERY 3 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP */ 1461539Srgrimes#define NO_DATA 4 /* Valid name, no data record of requested type */ 1471539Srgrimes#define NO_ADDRESS NO_DATA /* no address, look for MX record */ 1481539Srgrimes 14955163Sshin/* 15055163Sshin * Error return codes from getaddrinfo() 15155163Sshin */ 152121430Sume#if 0 153121430Sume/* obsoleted */ 15455163Sshin#define EAI_ADDRFAMILY 1 /* address family for hostname not supported */ 155121430Sume#endif 15655163Sshin#define EAI_AGAIN 2 /* temporary failure in name resolution */ 15755163Sshin#define EAI_BADFLAGS 3 /* invalid value for ai_flags */ 15855163Sshin#define EAI_FAIL 4 /* non-recoverable failure in name resolution */ 15955163Sshin#define EAI_FAMILY 5 /* ai_family not supported */ 16055163Sshin#define EAI_MEMORY 6 /* memory allocation failure */ 161121430Sume#if 0 162121430Sume/* obsoleted */ 16355163Sshin#define EAI_NODATA 7 /* no address associated with hostname */ 164121430Sume#endif 16555163Sshin#define EAI_NONAME 8 /* hostname nor servname provided, or not known */ 16655163Sshin#define EAI_SERVICE 9 /* servname not supported for ai_socktype */ 16755163Sshin#define EAI_SOCKTYPE 10 /* ai_socktype not supported */ 16855163Sshin#define EAI_SYSTEM 11 /* system error returned in errno */ 16955163Sshin#define EAI_BADHINTS 12 17055163Sshin#define EAI_PROTOCOL 13 17174393Sume#define EAI_MAX 14 17255163Sshin 17355163Sshin/* 17455163Sshin * Flag values for getaddrinfo() 17555163Sshin */ 17655163Sshin#define AI_PASSIVE 0x00000001 /* get address to use bind() */ 17755163Sshin#define AI_CANONNAME 0x00000002 /* fill ai_canonname */ 17855163Sshin#define AI_NUMERICHOST 0x00000004 /* prevent name resolution */ 17955163Sshin/* valid flags for addrinfo */ 18072693Sume#define AI_MASK \ 18172693Sume (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_ADDRCONFIG) 18255163Sshin 18355163Sshin#define AI_ALL 0x00000100 /* IPv6 and IPv4-mapped (with AI_V4MAPPED) */ 18455163Sshin#define AI_V4MAPPED_CFG 0x00000200 /* accept IPv4-mapped if kernel supports */ 18555163Sshin#define AI_ADDRCONFIG 0x00000400 /* only if any address is assigned */ 18655163Sshin#define AI_V4MAPPED 0x00000800 /* accept IPv4-mapped IPv6 address */ 18755163Sshin/* special recommended flags for getipnodebyname */ 18855163Sshin#define AI_DEFAULT (AI_V4MAPPED_CFG | AI_ADDRCONFIG) 18955163Sshin 19055163Sshin/* 19155163Sshin * Constants for getnameinfo() 19255163Sshin */ 19355163Sshin#define NI_MAXHOST 1025 19455163Sshin#define NI_MAXSERV 32 19555163Sshin 19655163Sshin/* 19755163Sshin * Flag values for getnameinfo() 19855163Sshin */ 19955163Sshin#define NI_NOFQDN 0x00000001 20055163Sshin#define NI_NUMERICHOST 0x00000002 20155163Sshin#define NI_NAMEREQD 0x00000004 20255163Sshin#define NI_NUMERICSERV 0x00000008 20355163Sshin#define NI_DGRAM 0x00000010 204121316Sume#if 1 /* obsolete */ 20555163Sshin#define NI_WITHSCOPEID 0x00000020 206121316Sume#endif 20755163Sshin 20855163Sshin/* 20955163Sshin * Scope delimit character 21055163Sshin */ 21157033Sshin#define SCOPE_DELIMITER '%' 21255163Sshin 2131539Srgrimes__BEGIN_DECLS 21493032Simpvoid endhostent(void); 21593032Simpvoid endnetent(void); 21693032Simpvoid endnetgrent(void); 21793032Simpvoid endprotoent(void); 21893032Simpvoid endservent(void); 21993032Simpvoid freehostent(struct hostent *); 22093032Simpstruct hostent *gethostbyaddr(const char *, int, int); 22193032Simpstruct hostent *gethostbyname(const char *); 22293032Simpstruct hostent *gethostbyname2(const char *, int); 22393032Simpstruct hostent *gethostent(void); 22493032Simpstruct hostent *getipnodebyaddr(const void *, size_t, int, int *); 22593032Simpstruct hostent *getipnodebyname(const char *, int, int, int *); 22693032Simpstruct netent *getnetbyaddr(unsigned long, int); 22793032Simpstruct netent *getnetbyname(const char *); 22893032Simpstruct netent *getnetent(void); 22993032Simpint getnetgrent(char **, char **, char **); 23093032Simpstruct protoent *getprotobyname(const char *); 23193032Simpstruct protoent *getprotobynumber(int); 23293032Simpstruct protoent *getprotoent(void); 23393032Simpstruct servent *getservbyname(const char *, const char *); 23493032Simpstruct servent *getservbyport(int, const char *); 23593032Simpstruct servent *getservent(void); 23693032Simpvoid herror(const char *); 23793032Simp__const char *hstrerror(int); 23893032Simpint innetgr(const char *, const char *, const char *, const char *); 23993032Simpvoid sethostent(int); 24093032Simp/* void sethostfile(const char *); */ 24193032Simpvoid setnetent(int); 24293032Simpvoid setprotoent(int); 24393032Simpint getaddrinfo(const char *, const char *, 24493032Simp const struct addrinfo *, struct addrinfo **); 24593032Simpint getnameinfo(const struct sockaddr *, socklen_t, char *, 24693032Simp size_t, char *, size_t, int); 24793032Simpvoid freeaddrinfo(struct addrinfo *); 24893032Simpchar *gai_strerror(int); 24993032Simpvoid setnetgrent(const char *); 25093032Simpvoid setservent(int); 25117902Speter 25217902Speter/* 25317902Speter * PRIVATE functions specific to the FreeBSD implementation 25417902Speter */ 25517902Speter 25617902Speter/* DO NOT USE THESE, THEY ARE SUBJECT TO CHANGE AND ARE NOT PORTABLE!!! */ 257126243Sgreenint * __h_error(void); 25893032Simpvoid _sethosthtent(int); 25993032Simpvoid _endhosthtent(void); 26093032Simpvoid _sethostdnsent(int); 26193032Simpvoid _endhostdnsent(void); 26293032Simpvoid _setnethtent(int); 26393032Simpvoid _endnethtent(void); 26493032Simpvoid _setnetdnsent(int); 26593032Simpvoid _endnetdnsent(void); 26693032Simpstruct hostent * _gethostbynisname(const char *, int); 26793032Simpstruct hostent * _gethostbynisaddr(const char *, int, int); 26893032Simpvoid _map_v4v6_address(const char *, char *); 26998866Simpvoid _map_v4v6_hostent(struct hostent *, char **, char **); 2701539Srgrimes__END_DECLS 2711539Srgrimes 2721539Srgrimes#endif /* !_NETDB_H_ */ 273