netdb.h revision 156960
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 156960 2006-03-21 16:11:11Z ume $ 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 77146244Sume#ifndef _UINT32_T_DECLARED 78146244Sumetypedef __uint32_t uint32_t; 79146244Sume#define _UINT32_T_DECLARED 80146244Sume#endif 81146244Sume 8236888Speter#ifndef _PATH_HEQUIV 8336888Speter# define _PATH_HEQUIV "/etc/hosts.equiv" 8436888Speter#endif 851539Srgrimes#define _PATH_HOSTS "/etc/hosts" 861539Srgrimes#define _PATH_NETWORKS "/etc/networks" 871539Srgrimes#define _PATH_PROTOCOLS "/etc/protocols" 881539Srgrimes#define _PATH_SERVICES "/etc/services" 891539Srgrimes 90156960Sume#define h_errno (*__h_errno()) 9110132Speter 921539Srgrimes/* 931539Srgrimes * Structures returned by network data base library. All addresses are 941539Srgrimes * supplied in host order, and returned in network order (suitable for 951539Srgrimes * use in system calls). 961539Srgrimes */ 9783047Sobrienstruct hostent { 981539Srgrimes char *h_name; /* official name of host */ 991539Srgrimes char **h_aliases; /* alias list */ 1001539Srgrimes int h_addrtype; /* host address type */ 1011539Srgrimes int h_length; /* length of address */ 1021539Srgrimes char **h_addr_list; /* list of addresses from name server */ 10313771Smpp#define h_addr h_addr_list[0] /* address, for backward compatibility */ 1041539Srgrimes}; 1051539Srgrimes 10683047Sobrienstruct netent { 1071539Srgrimes char *n_name; /* official name of net */ 1081539Srgrimes char **n_aliases; /* alias list */ 1091539Srgrimes int n_addrtype; /* net address type */ 110146244Sume uint32_t n_net; /* network # */ 1111539Srgrimes}; 1121539Srgrimes 11383047Sobrienstruct servent { 1141539Srgrimes char *s_name; /* official service name */ 1151539Srgrimes char **s_aliases; /* alias list */ 1161539Srgrimes int s_port; /* port # */ 1171539Srgrimes char *s_proto; /* protocol to use */ 1181539Srgrimes}; 1191539Srgrimes 12083047Sobrienstruct protoent { 1211539Srgrimes char *p_name; /* official protocol name */ 1221539Srgrimes char **p_aliases; /* alias list */ 1231539Srgrimes int p_proto; /* protocol # */ 1241539Srgrimes}; 1251539Srgrimes 12655163Sshinstruct addrinfo { 12755163Sshin int ai_flags; /* AI_PASSIVE, AI_CANONNAME, AI_NUMERICHOST */ 12855163Sshin int ai_family; /* PF_xxx */ 12955163Sshin int ai_socktype; /* SOCK_xxx */ 13055163Sshin int ai_protocol; /* 0 or IPPROTO_xxx for IPv4 and IPv6 */ 131146244Sume socklen_t ai_addrlen; /* length of ai_addr */ 13255163Sshin char *ai_canonname; /* canonical name for hostname */ 13355163Sshin struct sockaddr *ai_addr; /* binary address */ 13455163Sshin struct addrinfo *ai_next; /* next structure in linked list */ 13555163Sshin}; 13655163Sshin 1371539Srgrimes/* 1381539Srgrimes * Error return codes from gethostbyname() and gethostbyaddr() 139126243Sgreen * (left in h_errno). 1401539Srgrimes */ 1411539Srgrimes 14210132Speter#define NETDB_INTERNAL -1 /* see errno */ 14310132Speter#define NETDB_SUCCESS 0 /* no problem */ 1441539Srgrimes#define HOST_NOT_FOUND 1 /* Authoritative Answer Host not found */ 14513771Smpp#define TRY_AGAIN 2 /* Non-Authoritative Host not found, or SERVERFAIL */ 1461539Srgrimes#define NO_RECOVERY 3 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP */ 1471539Srgrimes#define NO_DATA 4 /* Valid name, no data record of requested type */ 1481539Srgrimes#define NO_ADDRESS NO_DATA /* no address, look for MX record */ 1491539Srgrimes 15055163Sshin/* 15155163Sshin * Error return codes from getaddrinfo() 15255163Sshin */ 153121430Sume#if 0 154121430Sume/* obsoleted */ 15555163Sshin#define EAI_ADDRFAMILY 1 /* address family for hostname not supported */ 156121430Sume#endif 15755163Sshin#define EAI_AGAIN 2 /* temporary failure in name resolution */ 15855163Sshin#define EAI_BADFLAGS 3 /* invalid value for ai_flags */ 15955163Sshin#define EAI_FAIL 4 /* non-recoverable failure in name resolution */ 16055163Sshin#define EAI_FAMILY 5 /* ai_family not supported */ 16155163Sshin#define EAI_MEMORY 6 /* memory allocation failure */ 162121430Sume#if 0 163121430Sume/* obsoleted */ 16455163Sshin#define EAI_NODATA 7 /* no address associated with hostname */ 165121430Sume#endif 16655163Sshin#define EAI_NONAME 8 /* hostname nor servname provided, or not known */ 16755163Sshin#define EAI_SERVICE 9 /* servname not supported for ai_socktype */ 16855163Sshin#define EAI_SOCKTYPE 10 /* ai_socktype not supported */ 16955163Sshin#define EAI_SYSTEM 11 /* system error returned in errno */ 17055163Sshin#define EAI_BADHINTS 12 17155163Sshin#define EAI_PROTOCOL 13 17274393Sume#define EAI_MAX 14 17355163Sshin 17455163Sshin/* 17555163Sshin * Flag values for getaddrinfo() 17655163Sshin */ 17755163Sshin#define AI_PASSIVE 0x00000001 /* get address to use bind() */ 17855163Sshin#define AI_CANONNAME 0x00000002 /* fill ai_canonname */ 179140908Sume#define AI_NUMERICHOST 0x00000004 /* prevent host name resolution */ 180140908Sume#define AI_NUMERICSERV 0x00000008 /* prevent service name resolution */ 181140908Sume/* valid flags for addrinfo (not a standard def, apps should not use it) */ 18272693Sume#define AI_MASK \ 183140908Sume (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_NUMERICSERV | \ 184140908Sume AI_ADDRCONFIG) 18555163Sshin 18655163Sshin#define AI_ALL 0x00000100 /* IPv6 and IPv4-mapped (with AI_V4MAPPED) */ 18755163Sshin#define AI_V4MAPPED_CFG 0x00000200 /* accept IPv4-mapped if kernel supports */ 18855163Sshin#define AI_ADDRCONFIG 0x00000400 /* only if any address is assigned */ 18955163Sshin#define AI_V4MAPPED 0x00000800 /* accept IPv4-mapped IPv6 address */ 19055163Sshin/* special recommended flags for getipnodebyname */ 19155163Sshin#define AI_DEFAULT (AI_V4MAPPED_CFG | AI_ADDRCONFIG) 19255163Sshin 19355163Sshin/* 19455163Sshin * Constants for getnameinfo() 19555163Sshin */ 19655163Sshin#define NI_MAXHOST 1025 19755163Sshin#define NI_MAXSERV 32 19855163Sshin 19955163Sshin/* 20055163Sshin * Flag values for getnameinfo() 20155163Sshin */ 20255163Sshin#define NI_NOFQDN 0x00000001 20355163Sshin#define NI_NUMERICHOST 0x00000002 20455163Sshin#define NI_NAMEREQD 0x00000004 20555163Sshin#define NI_NUMERICSERV 0x00000008 20655163Sshin#define NI_DGRAM 0x00000010 207146690Sume#if 0 /* obsolete */ 20855163Sshin#define NI_WITHSCOPEID 0x00000020 209121316Sume#endif 21055163Sshin 21155163Sshin/* 21255163Sshin * Scope delimit character 21355163Sshin */ 21457033Sshin#define SCOPE_DELIMITER '%' 21555163Sshin 2161539Srgrimes__BEGIN_DECLS 21793032Simpvoid endhostent(void); 21893032Simpvoid endnetent(void); 21993032Simpvoid endnetgrent(void); 22093032Simpvoid endprotoent(void); 22193032Simpvoid endservent(void); 22293032Simpvoid freehostent(struct hostent *); 22393032Simpstruct hostent *gethostbyaddr(const char *, int, int); 22493032Simpstruct hostent *gethostbyname(const char *); 22593032Simpstruct hostent *gethostbyname2(const char *, int); 22693032Simpstruct hostent *gethostent(void); 22793032Simpstruct hostent *getipnodebyaddr(const void *, size_t, int, int *); 22893032Simpstruct hostent *getipnodebyname(const char *, int, int, int *); 229146244Sumestruct netent *getnetbyaddr(uint32_t, int); 23093032Simpstruct netent *getnetbyname(const char *); 23193032Simpstruct netent *getnetent(void); 23293032Simpint getnetgrent(char **, char **, char **); 23393032Simpstruct protoent *getprotobyname(const char *); 23493032Simpstruct protoent *getprotobynumber(int); 23593032Simpstruct protoent *getprotoent(void); 23693032Simpstruct servent *getservbyname(const char *, const char *); 23793032Simpstruct servent *getservbyport(int, const char *); 23893032Simpstruct servent *getservent(void); 23993032Simpvoid herror(const char *); 24093032Simp__const char *hstrerror(int); 24193032Simpint innetgr(const char *, const char *, const char *, const char *); 24293032Simpvoid sethostent(int); 24393032Simp/* void sethostfile(const char *); */ 24493032Simpvoid setnetent(int); 24593032Simpvoid setprotoent(int); 24693032Simpint getaddrinfo(const char *, const char *, 24793032Simp const struct addrinfo *, struct addrinfo **); 24893032Simpint getnameinfo(const struct sockaddr *, socklen_t, char *, 24993032Simp size_t, char *, size_t, int); 25093032Simpvoid freeaddrinfo(struct addrinfo *); 251141908Sphantomconst char *gai_strerror(int); 25293032Simpvoid setnetgrent(const char *); 25393032Simpvoid setservent(int); 25417902Speter 25517902Speter/* 25617902Speter * PRIVATE functions specific to the FreeBSD implementation 25717902Speter */ 25817902Speter 25917902Speter/* DO NOT USE THESE, THEY ARE SUBJECT TO CHANGE AND ARE NOT PORTABLE!!! */ 260156960Sumeint * __h_errno(void); 2611539Srgrimes__END_DECLS 2621539Srgrimes 2631539Srgrimes#endif /* !_NETDB_H_ */ 264