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