xref: /dragonfly/include/netdb.h (revision 92c825d6)
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: src/include/netdb.h,v 1.45 2009/03/14 20:04:28 das Exp $
55  */
56 
57 #ifndef _NETDB_H_
58 #define _NETDB_H_
59 
60 #include <sys/cdefs.h>
61 #include <stdint.h>
62 
63 #ifndef _IN_ADDR_T_DECLARED
64 typedef	__uint32_t	in_addr_t;	/* base type for internet address */
65 #define	_IN_ADDR_T_DECLARED
66 #endif
67 
68 #ifndef _IN_PORT_T_DECLARED
69 typedef	__uint16_t	in_port_t;
70 #define	_IN_PORT_T_DECLARED
71 #endif
72 
73 #ifndef _SIZE_T_DECLARED
74 typedef	__size_t	size_t;
75 #define	_SIZE_T_DECLARED
76 #endif
77 
78 #ifndef _SOCKLEN_T_DECLARED
79 typedef	__socklen_t	socklen_t;
80 #define	_SOCKLEN_T_DECLARED
81 #endif
82 
83 #ifndef _PATH_HEQUIV
84 # define	_PATH_HEQUIV	"/etc/hosts.equiv"
85 #endif
86 #define	_PATH_HOSTS	"/etc/hosts"
87 #define	_PATH_NETWORKS	"/etc/networks"
88 #define	_PATH_PROTOCOLS	"/etc/protocols"
89 #define	_PATH_SERVICES	"/etc/services"
90 
91 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE <= 200112)
92 #define	h_errno (*__h_errno())
93 #endif
94 
95 /*
96  * Structures returned by network data base library.  All addresses are
97  * supplied in host order, and returned in network order (suitable for
98  * use in system calls).
99  */
100 struct hostent {
101 	char	*h_name;	/* official name of host */
102 	char	**h_aliases;	/* alias list */
103 	int	h_addrtype;	/* host address type */
104 	int	h_length;	/* length of address */
105 	char	**h_addr_list;	/* list of addresses from name server */
106 #if __BSD_VISIBLE
107 #define	h_addr	h_addr_list[0]	/* address, for backward compatibility */
108 #endif
109 };
110 
111 struct netent {
112 	char		*n_name;	/* official name of net */
113 	char		**n_aliases;	/* alias list */
114 	int		n_addrtype;	/* net address type */
115 	uint32_t	n_net;		/* network # */
116 };
117 
118 struct servent {
119 	char	*s_name;	/* official service name */
120 	char	**s_aliases;	/* alias list */
121 	int	s_port;		/* port # */
122 	char	*s_proto;	/* protocol to use */
123 };
124 
125 struct protoent {
126 	char	*p_name;	/* official protocol name */
127 	char	**p_aliases;	/* alias list */
128 	int	p_proto;	/* protocol # */
129 };
130 
131 struct addrinfo {
132 	int	ai_flags;	/* AI_PASSIVE, AI_CANONNAME, AI_NUMERICHOST */
133 	int	ai_family;	/* PF_xxx */
134 	int	ai_socktype;	/* SOCK_xxx */
135 	int	ai_protocol;	/* 0 or IPPROTO_xxx for IPv4 and IPv6 */
136 	socklen_t ai_addrlen;	/* length of ai_addr */
137 	char	*ai_canonname;	/* canonical name for hostname */
138 	struct	sockaddr *ai_addr;	/* binary address */
139 	struct	addrinfo *ai_next;	/* next structure in linked list */
140 };
141 
142 /*
143  * Error return codes from gethostbyname() and gethostbyaddr()
144  * (left in h_errno).
145  */
146 
147 #if __BSD_VISIBLE
148 #define	NETDB_INTERNAL	-1	/* see errno */
149 #define	NETDB_SUCCESS	0	/* no problem */
150 #endif
151 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE <= 200112)
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 #endif
157 #if __BSD_VISIBLE
158 #define	NO_ADDRESS	NO_DATA		/* no address, look for MX record */
159 #endif
160 
161 /*
162  * Error return codes from getaddrinfo()
163  */
164 #if __BSD_VISIBLE
165 /* XXX deprecated */
166 #define	EAI_ADDRFAMILY	 1	/* address family for hostname not supported */
167 #endif
168 #define	EAI_AGAIN	 2	/* temporary failure in name resolution */
169 #define	EAI_BADFLAGS	 3	/* invalid value for ai_flags */
170 #define	EAI_FAIL	 4	/* non-recoverable failure in name resolution */
171 #define	EAI_FAMILY	 5	/* ai_family not supported */
172 #define	EAI_MEMORY	 6	/* memory allocation failure */
173 #if __BSD_VISIBLE
174 /* XXX deprecated */
175 #define	EAI_NODATA	 7	/* no address associated with hostname */
176 #endif
177 #define	EAI_NONAME	 8	/* hostname nor servname provided, or not known */
178 #define	EAI_SERVICE	 9	/* servname not supported for ai_socktype */
179 #define	EAI_SOCKTYPE	10	/* ai_socktype not supported */
180 #define	EAI_SYSTEM	11	/* system error returned in errno */
181 #if __BSD_VISIBLE
182 #define	EAI_BADHINTS	12	/* invalid value for hints */
183 #define	EAI_PROTOCOL	13	/* resolved protocol is unknown */
184 #endif
185 #define	EAI_OVERFLOW	14	/* argument buffer overflow */
186 #if __BSD_VISIBLE
187 #define	EAI_MAX		15
188 #endif
189 
190 /*
191  * Flag values for getaddrinfo()
192  */
193 #define	AI_PASSIVE	0x00000001 /* get address to use bind() */
194 #define	AI_CANONNAME	0x00000002 /* fill ai_canonname */
195 #define	AI_NUMERICHOST	0x00000004 /* prevent host name resolution */
196 #define	AI_NUMERICSERV	0x00000008 /* prevent service name resolution */
197 #if __BSD_VISIBLE
198 /* valid flags for addrinfo (not a standard def, apps should not use it) */
199 #define AI_MASK \
200     (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_NUMERICSERV | \
201     AI_ADDRCONFIG)
202 #endif
203 
204 #define	AI_ALL		0x00000100 /* IPv6 and IPv4-mapped (with AI_V4MAPPED) */
205 #if __BSD_VISIBLE
206 #define	AI_V4MAPPED_CFG	0x00000200 /* accept IPv4-mapped if kernel supports */
207 #endif
208 #define	AI_ADDRCONFIG	0x00000400 /* only if any address is assigned */
209 #define	AI_V4MAPPED	0x00000800 /* accept IPv4-mapped IPv6 address */
210 #if __BSD_VISIBLE
211 /* special recommended flags for getipnodebyname */
212 #define	AI_DEFAULT	(AI_V4MAPPED_CFG | AI_ADDRCONFIG)
213 
214 /*
215  * Constants for getnameinfo()
216  */
217 #define	NI_MAXHOST	1025
218 #define	NI_MAXSERV	32
219 #endif
220 
221 /*
222  * Flag values for getnameinfo()
223  */
224 #define	NI_NOFQDN	0x00000001
225 #define	NI_NUMERICHOST	0x00000002
226 #define	NI_NAMEREQD	0x00000004
227 #define	NI_NUMERICSERV	0x00000008
228 #define	NI_DGRAM	0x00000010
229 #if __BSD_VISIBLE
230 #define	NI_WITHSCOPEID	0x00000020	/* XXX deprecated */
231 #endif
232 #define	NI_NUMERICSCOPE	0x00000040
233 
234 #if __BSD_VISIBLE
235 /*
236  * Scope delimit character
237  */
238 #define	SCOPE_DELIMITER	'%'
239 #endif
240 
241 __BEGIN_DECLS
242 void		endhostent(void);
243 void		endnetent(void);
244 void		endprotoent(void);
245 void		endservent(void);
246 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE <= 200112)
247 struct hostent	*gethostbyaddr(const void *, socklen_t, int);
248 struct hostent	*gethostbyname(const char *);
249 #endif
250 struct hostent	*gethostent(void);
251 struct netent	*getnetbyaddr(uint32_t, int);
252 struct netent	*getnetbyname(const char *);
253 struct netent	*getnetent(void);
254 struct protoent	*getprotobyname(const char *);
255 struct protoent	*getprotobynumber(int);
256 struct protoent	*getprotoent(void);
257 struct servent	*getservbyname(const char *, const char *);
258 struct servent	*getservbyport(int, const char *);
259 struct servent	*getservent(void);
260 void		sethostent(int);
261 /* void		sethostfile(const char *); */
262 void		setnetent(int);
263 void		setprotoent(int);
264 int		getaddrinfo(const char *, const char *,
265 			    const struct addrinfo *, struct addrinfo **);
266 /* XXX nodeLen and serviceLen should be socklen_t */
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		setservent(int);
272 
273 #if __BSD_VISIBLE
274 void		endnetgrent(void);
275 void		freehostent(struct hostent *);
276 int		gethostbyaddr_r(const void *, socklen_t, int, struct hostent *,
277 				char *, size_t, struct hostent **, int *);
278 int		gethostbyname_r(const char *, struct hostent *, char *, size_t,
279 				struct hostent **, int *);
280 struct hostent	*gethostbyname2(const char *, int);
281 int		gethostbyname2_r(const char *, int, struct hostent *, char *,
282 				 size_t, struct hostent **, int *);
283 int		gethostent_r(struct hostent *, char *, size_t,
284 			     struct hostent **, int *);
285 struct hostent	*getipnodebyaddr(const void *, size_t, int, int *);
286 struct hostent	*getipnodebyname(const char *, int, int, int *);
287 int		getnetbyaddr_r(uint32_t, int, struct netent *, char *, size_t,
288 			       struct netent**, int *);
289 int		getnetbyname_r(const char *, struct netent *, char *, size_t,
290 			       struct netent **, int *);
291 int		getnetent_r(struct netent *, char *, size_t, struct netent **,
292 			    int *);
293 int		getnetgrent(char **, char **, char **);
294 int		getprotobyname_r(const char *, struct protoent *, char *,
295 				 size_t, struct protoent **);
296 int		getprotobynumber_r(int, struct protoent *, char *, size_t,
297 				   struct protoent **);
298 int		getprotoent_r(struct protoent *, char *, size_t,
299 			      struct protoent **);
300 int		getservbyname_r(const char *, const char *, struct servent *,
301 				char *, size_t, struct servent **);
302 int		getservbyport_r(int, const char *, struct servent *, char *,
303 				size_t, struct servent **);
304 int		getservent_r(struct servent *, char *, size_t,
305 			     struct servent **);
306 void		herror(const char *);
307 const char	*hstrerror(int);
308 int		innetgr(const char *, const char *, const char *, const char *);
309 void		setnetgrent(const char *);
310 #endif
311 
312 
313 /*
314  * PRIVATE functions specific to the FreeBSD implementation
315  */
316 
317 /* DO NOT USE THESE, THEY ARE SUBJECT TO CHANGE AND ARE NOT PORTABLE!!! */
318 int	* __h_errno(void);
319 __END_DECLS
320 
321 #endif /* !_NETDB_H_ */
322