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