xref: /netbsd-src/include/netdb.h (revision 9fbd88883c38d0c0fbfcbe66d76fe6b0fab3f9de)
1 /*	$NetBSD: netdb.h,v 1.21 2001/04/26 12:55:31 kleink Exp $	*/
2 
3 /*
4  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the project nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 /*-
33  * Copyright (c) 1980, 1983, 1988, 1993
34  *	The Regents of the University of California.  All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  * 1. Redistributions of source code must retain the above copyright
40  *    notice, this list of conditions and the following disclaimer.
41  * 2. Redistributions in binary form must reproduce the above copyright
42  *    notice, this list of conditions and the following disclaimer in the
43  *    documentation and/or other materials provided with the distribution.
44  * 3. All advertising materials mentioning features or use of this software
45  *    must display the following acknowledgement:
46  *	This product includes software developed by the University of
47  *	California, Berkeley and its contributors.
48  * 4. Neither the name of the University nor the names of its contributors
49  *    may be used to endorse or promote products derived from this software
50  *    without specific prior written permission.
51  *
52  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
53  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
54  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
55  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
56  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
57  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
58  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
59  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
60  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
61  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
62  * SUCH DAMAGE.
63  *
64  *      @(#)netdb.h	8.1 (Berkeley) 6/2/93
65  *	Id: netdb.h,v 4.9.1.2 1993/05/17 09:59:01 vixie Exp
66  * -
67  * Portions Copyright (c) 1993 by Digital Equipment Corporation.
68  *
69  * Permission to use, copy, modify, and distribute this software for any
70  * purpose with or without fee is hereby granted, provided that the above
71  * copyright notice and this permission notice appear in all copies, and that
72  * the name of Digital Equipment Corporation not be used in advertising or
73  * publicity pertaining to distribution of the document or software without
74  * specific, written prior permission.
75  *
76  * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
77  * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
78  * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
79  * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
80  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
81  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
82  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
83  * SOFTWARE.
84  * -
85  * --Copyright--
86  */
87 
88 #ifndef _NETDB_H_
89 #define _NETDB_H_
90 
91 #include <machine/ansi.h>
92 #include <sys/cdefs.h>
93 #include <inttypes.h>
94 
95 #ifdef  _BSD_SIZE_T_
96 typedef _BSD_SIZE_T_	size_t;
97 #undef  _BSD_SIZE_T_
98 #endif
99 
100 #if !defined(_XOPEN_SOURCE)
101 #define	_PATH_HEQUIV	"/etc/hosts.equiv"
102 #define	_PATH_HOSTS	"/etc/hosts"
103 #define	_PATH_NETWORKS	"/etc/networks"
104 #define	_PATH_PROTOCOLS	"/etc/protocols"
105 #define	_PATH_SERVICES	"/etc/services"
106 #endif
107 
108 extern int h_errno;
109 
110 /*
111  * Structures returned by network data base library.  All addresses are
112  * supplied in host order, and returned in network order (suitable for
113  * use in system calls).
114  */
115 struct	hostent {
116 	char	*h_name;	/* official name of host */
117 	char	**h_aliases;	/* alias list */
118 	int	h_addrtype;	/* host address type */
119 	int	h_length;	/* length of address */
120 	char	**h_addr_list;	/* list of addresses from name server */
121 #define	h_addr	h_addr_list[0]	/* address, for backward compatiblity */
122 };
123 
124 /*
125  * Assumption here is that a network number
126  * fits in an unsigned long -- probably a poor one.
127  */
128 struct	netent {
129 	char		*n_name;	/* official name of net */
130 	char		**n_aliases;	/* alias list */
131 	int		n_addrtype;	/* net address type */
132 	unsigned long	n_net;		/* network # XXX */
133 };
134 
135 struct	servent {
136 	char	*s_name;	/* official service name */
137 	char	**s_aliases;	/* alias list */
138 	int	s_port;		/* port # */
139 	char	*s_proto;	/* protocol to use */
140 };
141 
142 struct	protoent {
143 	char	*p_name;	/* official protocol name */
144 	char	**p_aliases;	/* alias list */
145 	int	p_proto;	/* protocol # */
146 };
147 
148 #if !defined(_XOPEN_SOURCE)
149 struct addrinfo {
150 	int	ai_flags;	/* AI_PASSIVE, AI_CANONNAME, AI_NUMERICHOST */
151 	int	ai_family;	/* PF_xxx */
152 	int	ai_socktype;	/* SOCK_xxx */
153 	int	ai_protocol;	/* 0 or IPPROTO_xxx for IPv4 and IPv6 */
154 	size_t	ai_addrlen;	/* length of ai_addr */
155 	char	*ai_canonname;	/* canonical name for hostname */
156 	struct sockaddr *ai_addr;	/* binary address */
157 	struct addrinfo *ai_next;	/* next structure in linked list */
158 };
159 #endif
160 
161 /*
162  * Error return codes from gethostbyname() and gethostbyaddr()
163  * (left in extern int h_errno).
164  */
165 
166 #if !defined(_XOPEN_SOURCE)
167 #define	NETDB_INTERNAL	-1	/* see errno */
168 #define	NETDB_SUCCESS	0	/* no problem */
169 #endif
170 #define	HOST_NOT_FOUND	1 /* Authoritative Answer Host not found */
171 #define	TRY_AGAIN	2 /* Non-Authoritative Host not found, or SERVERFAIL */
172 #define	NO_RECOVERY	3 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP */
173 #define	NO_DATA		4 /* Valid name, no data record of requested type */
174 #if !defined(_XOPEN_SOURCE)
175 #define	NO_ADDRESS	NO_DATA		/* no address, look for MX record */
176 #endif
177 
178 /*
179  * Error return codes from getaddrinfo()
180  */
181 #if !defined(_XOPEN_SOURCE)
182 #define	EAI_ADDRFAMILY	 1	/* address family for hostname not supported */
183 #define	EAI_AGAIN	 2	/* temporary failure in name resolution */
184 #define	EAI_BADFLAGS	 3	/* invalid value for ai_flags */
185 #define	EAI_FAIL	 4	/* non-recoverable failure in name resolution */
186 #define	EAI_FAMILY	 5	/* ai_family not supported */
187 #define	EAI_MEMORY	 6	/* memory allocation failure */
188 #define	EAI_NODATA	 7	/* no address associated with hostname */
189 #define	EAI_NONAME	 8	/* hostname nor servname provided, or not known */
190 #define	EAI_SERVICE	 9	/* servname not supported for ai_socktype */
191 #define	EAI_SOCKTYPE	10	/* ai_socktype not supported */
192 #define	EAI_SYSTEM	11	/* system error returned in errno */
193 #define	EAI_BADHINTS	12
194 #define	EAI_PROTOCOL	13
195 #define	EAI_MAX		14
196 #endif /* !_XOPEN_SOURCE */
197 
198 /*
199  * Flag values for getaddrinfo()
200  */
201 #if !defined(_XOPEN_SOURCE)
202 #define	AI_PASSIVE	0x00000001 /* get address to use bind() */
203 #define	AI_CANONNAME	0x00000002 /* fill ai_canonname */
204 #define	AI_NUMERICHOST	0x00000004 /* prevent name resolution */
205 /* valid flags for addrinfo */
206 #define	AI_MASK		(AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST)
207 #endif
208 
209 #if !defined(_XOPEN_SOURCE) || (_XOPEN_SOURCE - 0) >= 500
210 #define	AI_ALL		0x00000100 /* IPv6 and IPv4-mapped (with AI_V4MAPPED) */
211 #endif
212 #if !defined(_XOPEN_SOURCE)
213 #define	AI_V4MAPPED_CFG	0x00000200 /* accept IPv4-mapped if kernel supports */
214 #endif
215 #if !defined(_XOPEN_SOURCE) || (_XOPEN_SOURCE - 0) >= 500
216 #define	AI_ADDRCONFIG	0x00000400 /* only if any address is assigned */
217 #define	AI_V4MAPPED	0x00000800 /* accept IPv4-mapped IPv6 address */
218 /* special recommended flags for getipnodebyname */
219 #define	AI_DEFAULT	(AI_V4MAPPED_CFG | AI_ADDRCONFIG)
220 #endif
221 
222 #if !defined(_XOPEN_SOURCE)
223 /*
224  * Constants for getnameinfo()
225  */
226 #define	NI_MAXHOST	1025
227 #define	NI_MAXSERV	32
228 
229 /*
230  * Flag values for getnameinfo()
231  */
232 #define	NI_NOFQDN	0x00000001
233 #define	NI_NUMERICHOST	0x00000002
234 #define	NI_NAMEREQD	0x00000004
235 #define	NI_NUMERICSERV	0x00000008
236 #define	NI_DGRAM	0x00000010
237 #define	NI_WITHSCOPEID	0x00000020	/*KAME extension*/
238 
239 /*
240  * Scope delimit character
241  */
242 #define	SCOPE_DELIMITER '%'		/*KAME extension*/
243 #endif /* !_XOPEN_SOURCE */
244 
245 /*
246  * Data types
247  */
248 #include <sys/ansi.h>
249 #ifndef socklen_t
250 typedef __socklen_t	socklen_t;
251 #define socklen_t	__socklen_t
252 #endif
253 
254 __BEGIN_DECLS
255 void		endhostent __P((void));
256 void		endnetent __P((void));
257 void		endprotoent __P((void));
258 void		endservent __P((void));
259 #if !defined(_XOPEN_SOURCE) || (_XOPEN_SOURCE - 0) >= 500
260 void		freehostent __P((struct hostent *));
261 #endif
262 struct hostent	*gethostbyaddr __P((const char *, socklen_t, int));
263 struct hostent	*gethostbyname __P((const char *));
264 #if !defined(_XOPEN_SOURCE)
265 struct hostent	*gethostbyname2 __P((const char *, int));
266 #endif
267 struct hostent	*gethostent __P((void));
268 #if !defined(_XOPEN_SOURCE) || (_XOPEN_SOURCE - 0) >= 500
269 #if 0 /* we do not ship these */
270 struct hostent	*getipnodebyaddr __P((const void *, size_t, int, int *));
271 struct hostent	*getipnodebyname __P((const char *, int, int, int *));
272 #endif
273 #endif
274 struct netent	*getnetbyaddr __P((unsigned long, int));
275 struct netent	*getnetbyname __P((const char *));
276 struct netent	*getnetent __P((void));
277 struct protoent	*getprotobyname __P((const char *));
278 struct protoent	*getprotobynumber __P((int));
279 struct protoent	*getprotoent __P((void));
280 struct servent	*getservbyname __P((const char *, const char *));
281 struct servent	*getservbyport __P((int, const char *));
282 struct servent	*getservent __P((void));
283 #if !defined(_XOPEN_SOURCE)
284 void		herror __P((const char *));
285 const char	*hstrerror __P((int));
286 #endif
287 void		sethostent __P((int));
288 #if !defined(_XOPEN_SOURCE)
289 /* void		sethostfile __P((const char *)); */
290 #endif
291 void		setnetent __P((int));
292 void		setprotoent __P((int));
293 #if !defined(_XOPEN_SOURCE)
294 int		getaddrinfo __P((const char *, const char *,
295 				 const struct addrinfo *, struct addrinfo **));
296 int		getnameinfo __P((const struct sockaddr *, socklen_t, char *,
297 				 size_t, char *, size_t, int));
298 void		freeaddrinfo __P((struct addrinfo *));
299 char		*gai_strerror __P((int));
300 #endif
301 void		setservent __P((int));
302 __END_DECLS
303 
304 #endif /* !_NETDB_H_ */
305