xref: /f-stack/tools/compat/include/netdb.h (revision 8cf1d457)
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$
55  */
56 
57 #ifndef _NETDB_H_
58 #define _NETDB_H_
59 
60 #include <sys/cdefs.h>
61 
62 #ifndef _IN_ADDR_T_DECLARED
63 typedef	__uint32_t	in_addr_t;
64 #define	_IN_ADDR_T_DECLARED
65 #endif
66 
67 #ifndef _IN_PORT_T_DECLARED
68 typedef	__uint16_t	in_port_t;
69 #define	_IN_PORT_T_DECLARED
70 #endif
71 
72 #ifndef _SIZE_T_DECLARED
73 typedef	__size_t	size_t;
74 #define	_SIZE_T_DECLARED
75 #endif
76 
77 #ifndef _SOCKLEN_T_DECLARED
78 typedef	__socklen_t	socklen_t;
79 #define	_SOCKLEN_T_DECLARED
80 #endif
81 
82 #ifndef _UINT32_T_DECLARED
83 typedef	__uint32_t	uint32_t;
84 #define	_UINT32_T_DECLARED
85 #endif
86 
87 #ifndef _PATH_HEQUIV
88 # define	_PATH_HEQUIV	"/etc/hosts.equiv"
89 #endif
90 #define	_PATH_HOSTS	"/etc/hosts"
91 #define	_PATH_NETWORKS	"/etc/networks"
92 #define	_PATH_PROTOCOLS	"/etc/protocols"
93 #define	_PATH_SERVICES	"/etc/services"
94 #define	_PATH_SERVICES_DB "/var/db/services.db"
95 
96 #define	h_errno (*__h_errno())
97 
98 /*
99  * Structures returned by network data base library.  All addresses are
100  * supplied in host order, and returned in network order (suitable for
101  * use in system calls).
102  */
103 struct hostent {
104 	char	*h_name;	/* official name of host */
105 	char	**h_aliases;	/* alias list */
106 	int	h_addrtype;	/* host address type */
107 	int	h_length;	/* length of address */
108 	char	**h_addr_list;	/* list of addresses from name server */
109 #define	h_addr	h_addr_list[0]	/* address, for backward compatibility */
110 };
111 
112 struct netent {
113 	char		*n_name;	/* official name of net */
114 	char		**n_aliases;	/* alias list */
115 	int		n_addrtype;	/* net address type */
116 	uint32_t	n_net;		/* network # */
117 };
118 
119 struct servent {
120 	char	*s_name;	/* official service name */
121 	char	**s_aliases;	/* alias list */
122 	int	s_port;		/* port # */
123 	char	*s_proto;	/* protocol to use */
124 };
125 
126 struct protoent {
127 	char	*p_name;	/* official protocol name */
128 	char	**p_aliases;	/* alias list */
129 	int	p_proto;	/* protocol # */
130 };
131 
132 struct addrinfo {
133 	int	ai_flags;	/* AI_PASSIVE, AI_CANONNAME, AI_NUMERICHOST */
134 	int	ai_family;	/* AF_xxx */
135 	int	ai_socktype;	/* SOCK_xxx */
136 	int	ai_protocol;	/* 0 or IPPROTO_xxx for IPv4 and IPv6 */
137 	socklen_t ai_addrlen;	/* length of ai_addr */
138 	char	*ai_canonname;	/* canonical name for hostname */
139 	struct	sockaddr *ai_addr;	/* binary address */
140 	struct	addrinfo *ai_next;	/* next structure in linked list */
141 };
142 
143 #define	IPPORT_RESERVED	1024
144 
145 /*
146  * Error return codes from gethostbyname() and gethostbyaddr()
147  * (left in h_errno).
148  */
149 
150 #define	NETDB_INTERNAL	-1	/* see errno */
151 #define	NETDB_SUCCESS	0	/* no problem */
152 #define	HOST_NOT_FOUND	1 /* Authoritative Answer Host not found */
153 #define	TRY_AGAIN	2 /* Non-Authoritative Host not found, or SERVERFAIL */
154 #define	NO_RECOVERY	3 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP */
155 #define	NO_DATA		4 /* Valid name, no data record of requested type */
156 #define	NO_ADDRESS	NO_DATA		/* no address, look for MX record */
157 
158 /*
159  * Error return codes from getaddrinfo()
160  */
161 #if 0
162 /* obsoleted */
163 #define	EAI_ADDRFAMILY	 1	/* address family for hostname not supported */
164 #endif
165 #define	EAI_AGAIN	 2	/* temporary failure in name resolution */
166 #define	EAI_BADFLAGS	 3	/* invalid value for ai_flags */
167 #define	EAI_FAIL	 4	/* non-recoverable failure in name resolution */
168 #define	EAI_FAMILY	 5	/* ai_family not supported */
169 #define	EAI_MEMORY	 6	/* memory allocation failure */
170 #if 0
171 /* obsoleted */
172 #define	EAI_NODATA	 7	/* no address associated with hostname */
173 #endif
174 #define	EAI_NONAME	 8	/* hostname nor servname provided, or not known */
175 #define	EAI_SERVICE	 9	/* servname not supported for ai_socktype */
176 #define	EAI_SOCKTYPE	10	/* ai_socktype not supported */
177 #define	EAI_SYSTEM	11	/* system error returned in errno */
178 #define	EAI_BADHINTS	12	/* invalid value for hints */
179 #define	EAI_PROTOCOL	13	/* resolved protocol is unknown */
180 #define	EAI_OVERFLOW	14	/* argument buffer overflow */
181 #define	EAI_MAX		15
182 
183 /*
184  * Flag values for getaddrinfo()
185  */
186 #define	AI_PASSIVE	0x00000001 /* get address to use bind() */
187 #define	AI_CANONNAME	0x00000002 /* fill ai_canonname */
188 #define	AI_NUMERICHOST	0x00000004 /* prevent host name resolution */
189 #define	AI_NUMERICSERV	0x00000008 /* prevent service name resolution */
190 /* valid flags for addrinfo (not a standard def, apps should not use it) */
191 #define AI_MASK \
192     (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_NUMERICSERV | \
193     AI_ADDRCONFIG | AI_ALL | AI_V4MAPPED)
194 
195 #define	AI_ALL		0x00000100 /* IPv6 and IPv4-mapped (with AI_V4MAPPED) */
196 #define	AI_V4MAPPED_CFG	0x00000200 /* accept IPv4-mapped if kernel supports */
197 #define	AI_ADDRCONFIG	0x00000400 /* only if any address is assigned */
198 #define	AI_V4MAPPED	0x00000800 /* accept IPv4-mapped IPv6 address */
199 /* special recommended flags for getipnodebyname */
200 #define	AI_DEFAULT	(AI_V4MAPPED_CFG | AI_ADDRCONFIG)
201 
202 /*
203  * Constants for getnameinfo()
204  */
205 #define	NI_MAXHOST	1025
206 #define	NI_MAXSERV	32
207 
208 /*
209  * Flag values for getnameinfo()
210  */
211 #define	NI_NOFQDN	0x00000001
212 #define	NI_NUMERICHOST	0x00000002
213 #define	NI_NAMEREQD	0x00000004
214 #define	NI_NUMERICSERV	0x00000008
215 #define	NI_DGRAM	0x00000010
216 #if 0 /* obsolete */
217 #define NI_WITHSCOPEID	0x00000020
218 #endif
219 
220 /*
221  * Scope delimit character
222  */
223 #define	SCOPE_DELIMITER	'%'
224 
225 int getaddrinfo(const char *, const char *,
226     const struct addrinfo *, struct addrinfo **);
227 void freeaddrinfo(struct addrinfo *);
228 const char *gai_strerror(int ecode);
229 
230 struct servent *getservbyport(int port, const char *proto);
231 
232 struct protoent *getprotoent(void);
233 struct protoent *getprotobyname(const char *name);
234 struct protoent *getprotobynumber(int proto);
235 void setprotoent(int stayopen);
236 void endprotoent(void);
237 
238 int getnameinfo(const struct sockaddr *sa, socklen_t salen,
239     char *host, size_t hostlen, char *serv, size_t servlen, int flags);
240 
241 struct netent *getnetbyaddr(uint32_t net, int type);
242 
243 #endif /* !_NETDB_H_ */
244