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