netdb.h revision 18b78355b8621cae4f0cb3aa0448d1808b09d97f
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. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *	This product includes software developed by the University of
16 *	California, Berkeley and its contributors.
17 * 4. 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 * -
34 * Portions Copyright (c) 1993 by Digital Equipment Corporation.
35 *
36 * Permission to use, copy, modify, and distribute this software for any
37 * purpose with or without fee is hereby granted, provided that the above
38 * copyright notice and this permission notice appear in all copies, and that
39 * the name of Digital Equipment Corporation not be used in advertising or
40 * publicity pertaining to distribution of the document or software without
41 * specific, written prior permission.
42 *
43 * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
44 * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
45 * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
46 * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
47 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
48 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
49 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
50 * SOFTWARE.
51 * -
52 * --Copyright--
53 */
54
55/*
56 *      @(#)netdb.h	8.1 (Berkeley) 6/2/93
57 *      From: Id: netdb.h,v 8.9 1996/11/19 08:39:29 vixie Exp $
58 * $FreeBSD$
59 */
60
61#ifndef _NETDB_H_
62#define _NETDB_H_
63
64#include <sys/cdefs.h>
65#include <machine/ansi.h>
66
67#ifdef	_BSD_SIZE_T_
68typedef	_BSD_SIZE_T_	size_t;
69#undef	_BSD_SIZE_T_
70#endif
71
72#ifdef	_BSD_SOCKLEN_T_
73typedef	_BSD_SOCKLEN_T_	socklen_t;
74#undef	_BSD_SOCKLEN_T_
75#endif
76
77#ifndef _PATH_HEQUIV
78# define	_PATH_HEQUIV	"/etc/hosts.equiv"
79#endif
80#define	_PATH_HOSTS	"/etc/hosts"
81#define	_PATH_NETWORKS	"/etc/networks"
82#define	_PATH_PROTOCOLS	"/etc/protocols"
83#define	_PATH_SERVICES	"/etc/services"
84
85extern int h_errno;
86
87/*
88 * Structures returned by network data base library.  All addresses are
89 * supplied in host order, and returned in network order (suitable for
90 * use in system calls).
91 */
92struct hostent {
93	char	*h_name;	/* official name of host */
94	char	**h_aliases;	/* alias list */
95	int	h_addrtype;	/* host address type */
96	int	h_length;	/* length of address */
97	char	**h_addr_list;	/* list of addresses from name server */
98#define	h_addr	h_addr_list[0]	/* address, for backward compatibility */
99};
100
101/*
102 * Assumption here is that a network number
103 * fits in an unsigned long -- probably a poor one.
104 */
105struct netent {
106	char		*n_name;	/* official name of net */
107	char		**n_aliases;	/* alias list */
108	int		n_addrtype;	/* net address type */
109	unsigned long	n_net;		/* network # */
110};
111
112struct servent {
113	char	*s_name;	/* official service name */
114	char	**s_aliases;	/* alias list */
115	int	s_port;		/* port # */
116	char	*s_proto;	/* protocol to use */
117};
118
119struct protoent {
120	char	*p_name;	/* official protocol name */
121	char	**p_aliases;	/* alias list */
122	int	p_proto;	/* protocol # */
123};
124
125struct addrinfo {
126	int	ai_flags;	/* AI_PASSIVE, AI_CANONNAME, AI_NUMERICHOST */
127	int	ai_family;	/* PF_xxx */
128	int	ai_socktype;	/* SOCK_xxx */
129	int	ai_protocol;	/* 0 or IPPROTO_xxx for IPv4 and IPv6 */
130	size_t	ai_addrlen;	/* length of ai_addr */
131	char	*ai_canonname;	/* canonical name for hostname */
132	struct	sockaddr *ai_addr;	/* binary address */
133	struct	addrinfo *ai_next;	/* next structure in linked list */
134};
135
136/*
137 * Error return codes from gethostbyname() and gethostbyaddr()
138 * (left in extern int h_errno).
139 */
140
141#define	NETDB_INTERNAL	-1	/* see errno */
142#define	NETDB_SUCCESS	0	/* no problem */
143#define	HOST_NOT_FOUND	1 /* Authoritative Answer Host not found */
144#define	TRY_AGAIN	2 /* Non-Authoritative Host not found, or SERVERFAIL */
145#define	NO_RECOVERY	3 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP */
146#define	NO_DATA		4 /* Valid name, no data record of requested type */
147#define	NO_ADDRESS	NO_DATA		/* no address, look for MX record */
148
149/*
150 * Error return codes from getaddrinfo()
151 */
152#define	EAI_ADDRFAMILY	 1	/* address family for hostname not supported */
153#define	EAI_AGAIN	 2	/* temporary failure in name resolution */
154#define	EAI_BADFLAGS	 3	/* invalid value for ai_flags */
155#define	EAI_FAIL	 4	/* non-recoverable failure in name resolution */
156#define	EAI_FAMILY	 5	/* ai_family not supported */
157#define	EAI_MEMORY	 6	/* memory allocation failure */
158#define	EAI_NODATA	 7	/* no address associated with hostname */
159#define	EAI_NONAME	 8	/* hostname nor servname provided, or not known */
160#define	EAI_SERVICE	 9	/* servname not supported for ai_socktype */
161#define	EAI_SOCKTYPE	10	/* ai_socktype not supported */
162#define	EAI_SYSTEM	11	/* system error returned in errno */
163#define	EAI_BADHINTS	12
164#define	EAI_PROTOCOL	13
165#define	EAI_MAX		14
166
167/*
168 * Flag values for getaddrinfo()
169 */
170#define	AI_PASSIVE	0x00000001 /* get address to use bind() */
171#define	AI_CANONNAME	0x00000002 /* fill ai_canonname */
172#define	AI_NUMERICHOST	0x00000004 /* prevent name resolution */
173/* valid flags for addrinfo */
174#define AI_MASK \
175    (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_ADDRCONFIG)
176
177#define	AI_ALL		0x00000100 /* IPv6 and IPv4-mapped (with AI_V4MAPPED) */
178#define	AI_V4MAPPED_CFG	0x00000200 /* accept IPv4-mapped if kernel supports */
179#define	AI_ADDRCONFIG	0x00000400 /* only if any address is assigned */
180#define	AI_V4MAPPED	0x00000800 /* accept IPv4-mapped IPv6 address */
181/* special recommended flags for getipnodebyname */
182#define	AI_DEFAULT	(AI_V4MAPPED_CFG | AI_ADDRCONFIG)
183
184/*
185 * Constants for getnameinfo()
186 */
187#define	NI_MAXHOST	1025
188#define	NI_MAXSERV	32
189
190/*
191 * Flag values for getnameinfo()
192 */
193#define	NI_NOFQDN	0x00000001
194#define	NI_NUMERICHOST	0x00000002
195#define	NI_NAMEREQD	0x00000004
196#define	NI_NUMERICSERV	0x00000008
197#define	NI_DGRAM	0x00000010
198#define NI_WITHSCOPEID	0x00000020
199
200/*
201 * Scope delimit character
202 */
203#define	SCOPE_DELIMITER	'%'
204
205__BEGIN_DECLS
206void		endhostent __P((void));
207void		endnetent __P((void));
208void		endnetgrent __P((void));
209void		endprotoent __P((void));
210void		endservent __P((void));
211void		freehostent __P((struct hostent *));
212struct hostent	*gethostbyaddr __P((const char *, int, int));
213struct hostent	*gethostbyname __P((const char *));
214struct hostent	*gethostbyname2 __P((const char *, int));
215struct hostent	*gethostent __P((void));
216struct hostent	*getipnodebyaddr __P((const void *, size_t, int, int *));
217struct hostent	*getipnodebyname __P((const char *, int, int, int *));
218struct netent	*getnetbyaddr __P((unsigned long, int));
219struct netent	*getnetbyname __P((const char *));
220struct netent	*getnetent __P((void));
221int		getnetgrent __P((char **, char **, char **));
222struct protoent	*getprotobyname __P((const char *));
223struct protoent	*getprotobynumber __P((int));
224struct protoent	*getprotoent __P((void));
225struct servent	*getservbyname __P((const char *, const char *));
226struct servent	*getservbyport __P((int, const char *));
227struct servent	*getservent __P((void));
228void		herror __P((const char *));
229__const char	*hstrerror __P((int));
230int		innetgr __P((const char *, const char *, const char *,
231				const char *));
232void		sethostent __P((int));
233/* void		sethostfile __P((const char *)); */
234void		setnetent __P((int));
235void		setprotoent __P((int));
236int		getaddrinfo __P((const char *, const char *,
237				 const struct addrinfo *, struct addrinfo **));
238int		getnameinfo __P((const struct sockaddr *, socklen_t, char *,
239				 size_t, char *, size_t, int));
240void		freeaddrinfo __P((struct addrinfo *));
241char		*gai_strerror __P((int));
242void		setnetgrent __P((const char *));
243void		setservent __P((int));
244
245/*
246 * PRIVATE functions specific to the FreeBSD implementation
247 */
248
249/* DO NOT USE THESE, THEY ARE SUBJECT TO CHANGE AND ARE NOT PORTABLE!!! */
250void	_sethosthtent __P((int));
251void	_endhosthtent __P((void));
252void	_sethostdnsent __P((int));
253void	_endhostdnsent __P((void));
254void	_setnethtent __P((int));
255void	_endnethtent __P((void));
256void	_setnetdnsent __P((int));
257void	_endnetdnsent __P((void));
258struct hostent * _gethostbynisname __P((const char *, int));
259struct hostent * _gethostbynisaddr __P((const char *, int, int));
260void _map_v4v6_address __P((const char *, char *));
261void _map_v4v6_hostent __P((struct hostent *, char **, int *));
262__END_DECLS
263
264#endif /* !_NETDB_H_ */
265