xref: /freebsd/include/netdb.h (revision d429ea332342fcb98d27a350d0c4944bf9aec3f9)
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 <sys/_types.h>
66 #include <machine/_limits.h>
67 #include <machine/endian.h>
68 
69 #ifndef _SIZE_T_DECLARED
70 typedef	__size_t	size_t;
71 #define	_SIZE_T_DECLARED
72 #endif
73 
74 #ifndef _SOCKLEN_T_DECLARED
75 typedef	__socklen_t	socklen_t;
76 #define	_SOCKLEN_T_DECLARED
77 #endif
78 
79 #ifndef _UINT32_T_DECLARED
80 typedef	__uint32_t	uint32_t;
81 #define	_UINT32_T_DECLARED
82 #endif
83 
84 #ifndef _PATH_HEQUIV
85 # define	_PATH_HEQUIV	"/etc/hosts.equiv"
86 #endif
87 #define	_PATH_HOSTS	"/etc/hosts"
88 #define	_PATH_NETWORKS	"/etc/networks"
89 #define	_PATH_PROTOCOLS	"/etc/protocols"
90 #define	_PATH_SERVICES	"/etc/services"
91 
92 #define	h_errno (*__h_error())
93 
94 /*
95  * Structures returned by network data base library.  All addresses are
96  * supplied in host order, and returned in network order (suitable for
97  * use in system calls).
98  */
99 struct hostent {
100 	char	*h_name;	/* official name of host */
101 	char	**h_aliases;	/* alias list */
102 	int	h_addrtype;	/* host address type */
103 	int	h_length;	/* length of address */
104 	char	**h_addr_list;	/* list of addresses from name server */
105 #define	h_addr	h_addr_list[0]	/* address, for backward compatibility */
106 };
107 
108 struct netent {
109 	char		*n_name;	/* official name of net */
110 	char		**n_aliases;	/* alias list */
111 	int		n_addrtype;	/* net address type */
112 	uint32_t	n_net;		/* network # */
113 };
114 
115 struct servent {
116 	char	*s_name;	/* official service name */
117 	char	**s_aliases;	/* alias list */
118 	int	s_port;		/* port # */
119 	char	*s_proto;	/* protocol to use */
120 };
121 
122 struct protoent {
123 	char	*p_name;	/* official protocol name */
124 	char	**p_aliases;	/* alias list */
125 	int	p_proto;	/* protocol # */
126 };
127 
128 /*
129  * Note: ai_addrlen used to be a size_t, per RFC 2553.
130  * In XNS5.2, and subsequently in POSIX-2001 and RFC 3493 it was
131  * changed to a socklen_t.
132  * To accomodate for this while preserving binary compatibility with the
133  * old interface, we prepend or append 32 bits of padding, depending on
134  * the (LP64) architecture's endianness.
135  *
136  * This should be deleted the next time the libc major number is
137  * incremented.
138  */
139 struct addrinfo {
140 	int	ai_flags;	/* AI_PASSIVE, AI_CANONNAME, AI_NUMERICHOST */
141 	int	ai_family;	/* PF_xxx */
142 	int	ai_socktype;	/* SOCK_xxx */
143 	int	ai_protocol;	/* 0 or IPPROTO_xxx for IPv4 and IPv6 */
144 #if __LONG_BIT == 64 && _BYTE_ORDER == _BIG_ENDIAN
145 	uint32_t __ai_pad0;	/* ABI compatibility */
146 #endif
147 	socklen_t ai_addrlen;	/* length of ai_addr */
148 #if __LONG_BIT == 64 && _BYTE_ORDER == _LITTLE_ENDIAN
149 	uint32_t __ai_pad0;	/* ABI compatibility */
150 #endif
151 	char	*ai_canonname;	/* canonical name for hostname */
152 	struct	sockaddr *ai_addr;	/* binary address */
153 	struct	addrinfo *ai_next;	/* next structure in linked list */
154 };
155 
156 /*
157  * Error return codes from gethostbyname() and gethostbyaddr()
158  * (left in h_errno).
159  */
160 
161 #define	NETDB_INTERNAL	-1	/* see errno */
162 #define	NETDB_SUCCESS	0	/* no problem */
163 #define	HOST_NOT_FOUND	1 /* Authoritative Answer Host not found */
164 #define	TRY_AGAIN	2 /* Non-Authoritative Host not found, or SERVERFAIL */
165 #define	NO_RECOVERY	3 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP */
166 #define	NO_DATA		4 /* Valid name, no data record of requested type */
167 #define	NO_ADDRESS	NO_DATA		/* no address, look for MX record */
168 
169 /*
170  * Error return codes from getaddrinfo()
171  */
172 #if 0
173 /* obsoleted */
174 #define	EAI_ADDRFAMILY	 1	/* address family for hostname not supported */
175 #endif
176 #define	EAI_AGAIN	 2	/* temporary failure in name resolution */
177 #define	EAI_BADFLAGS	 3	/* invalid value for ai_flags */
178 #define	EAI_FAIL	 4	/* non-recoverable failure in name resolution */
179 #define	EAI_FAMILY	 5	/* ai_family not supported */
180 #define	EAI_MEMORY	 6	/* memory allocation failure */
181 #if 0
182 /* obsoleted */
183 #define	EAI_NODATA	 7	/* no address associated with hostname */
184 #endif
185 #define	EAI_NONAME	 8	/* hostname nor servname provided, or not known */
186 #define	EAI_SERVICE	 9	/* servname not supported for ai_socktype */
187 #define	EAI_SOCKTYPE	10	/* ai_socktype not supported */
188 #define	EAI_SYSTEM	11	/* system error returned in errno */
189 #define	EAI_BADHINTS	12
190 #define	EAI_PROTOCOL	13
191 #define	EAI_MAX		14
192 
193 /*
194  * Flag values for getaddrinfo()
195  */
196 #define	AI_PASSIVE	0x00000001 /* get address to use bind() */
197 #define	AI_CANONNAME	0x00000002 /* fill ai_canonname */
198 #define	AI_NUMERICHOST	0x00000004 /* prevent host name resolution */
199 #define	AI_NUMERICSERV	0x00000008 /* prevent service name resolution */
200 /* valid flags for addrinfo (not a standard def, apps should not use it) */
201 #define AI_MASK \
202     (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_NUMERICSERV | \
203     AI_ADDRCONFIG)
204 
205 #define	AI_ALL		0x00000100 /* IPv6 and IPv4-mapped (with AI_V4MAPPED) */
206 #define	AI_V4MAPPED_CFG	0x00000200 /* accept IPv4-mapped if kernel supports */
207 #define	AI_ADDRCONFIG	0x00000400 /* only if any address is assigned */
208 #define	AI_V4MAPPED	0x00000800 /* accept IPv4-mapped IPv6 address */
209 /* special recommended flags for getipnodebyname */
210 #define	AI_DEFAULT	(AI_V4MAPPED_CFG | AI_ADDRCONFIG)
211 
212 /*
213  * Constants for getnameinfo()
214  */
215 #define	NI_MAXHOST	1025
216 #define	NI_MAXSERV	32
217 
218 /*
219  * Flag values for getnameinfo()
220  */
221 #define	NI_NOFQDN	0x00000001
222 #define	NI_NUMERICHOST	0x00000002
223 #define	NI_NAMEREQD	0x00000004
224 #define	NI_NUMERICSERV	0x00000008
225 #define	NI_DGRAM	0x00000010
226 #if 0 /* obsolete */
227 #define NI_WITHSCOPEID	0x00000020
228 #endif
229 
230 /*
231  * Scope delimit character
232  */
233 #define	SCOPE_DELIMITER	'%'
234 
235 __BEGIN_DECLS
236 void		endhostent(void);
237 void		endnetent(void);
238 void		endnetgrent(void);
239 void		endprotoent(void);
240 void		endservent(void);
241 void		freehostent(struct hostent *);
242 struct hostent	*gethostbyaddr(const char *, int, int);
243 struct hostent	*gethostbyname(const char *);
244 struct hostent	*gethostbyname2(const char *, int);
245 struct hostent	*gethostent(void);
246 struct hostent	*getipnodebyaddr(const void *, size_t, int, int *);
247 struct hostent	*getipnodebyname(const char *, int, int, int *);
248 struct netent	*getnetbyaddr(uint32_t, int);
249 struct netent	*getnetbyname(const char *);
250 struct netent	*getnetent(void);
251 int		getnetgrent(char **, char **, char **);
252 struct protoent	*getprotobyname(const char *);
253 struct protoent	*getprotobynumber(int);
254 struct protoent	*getprotoent(void);
255 struct servent	*getservbyname(const char *, const char *);
256 struct servent	*getservbyport(int, const char *);
257 struct servent	*getservent(void);
258 void		herror(const char *);
259 __const char	*hstrerror(int);
260 int		innetgr(const char *, const char *, const char *, const char *);
261 void		sethostent(int);
262 /* void		sethostfile(const char *); */
263 void		setnetent(int);
264 void		setprotoent(int);
265 int		getaddrinfo(const char *, const char *,
266 			    const struct addrinfo *, struct addrinfo **);
267 int		getnameinfo(const struct sockaddr *, socklen_t, char *,
268 			    size_t, char *, size_t, int);
269 void		freeaddrinfo(struct addrinfo *);
270 const char	*gai_strerror(int);
271 void		setnetgrent(const char *);
272 void		setservent(int);
273 
274 /*
275  * PRIVATE functions specific to the FreeBSD implementation
276  */
277 
278 /* DO NOT USE THESE, THEY ARE SUBJECT TO CHANGE AND ARE NOT PORTABLE!!! */
279 int	* __h_error(void);
280 __END_DECLS
281 
282 #endif /* !_NETDB_H_ */
283