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: src/include/netdb.h,v 1.23 2002/03/23 17:24:53 imp Exp $
59  */
60 
61 #ifndef _NETDB_H_
62 #define _NETDB_H_
63 
64 #include <sys/cdefs.h>
65 #include <sys/types.h>
66 #include <machine/ansi.h>
67 #include <stdio.h>
68 
69 #ifndef __socklen_t_defined
70 typedef unsigned int socklen_t;
71 #define __socklen_t_defined 1
72 #endif
73 
74 #ifdef	_BSD_SOCKLEN_T_
75 typedef	_BSD_SOCKLEN_T_	socklen_t;
76 #undef	_BSD_SOCKLEN_T_
77 #endif
78 
79 #ifndef _PATH_HEQUIV
80 # define	_PATH_HEQUIV	"/etc/hosts.equiv"
81 #endif
82 #define	_PATH_HOSTS	"/etc/hosts"
83 #define	_PATH_NETWORKS	"/etc/networks"
84 #define	_PATH_PROTOCOLS	"/etc/protocols"
85 #define	_PATH_SERVICES	"/etc/services"
86 
87 extern int h_errno;
88 
89 #define	MAXALIASES	35
90   /* For now, only support one return address. */
91 #define MAXADDRS         2
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   char *h_addr;         /* address, for backward compatibility */
104   /* private data, for re-entrancy */
105   char *__host_addrs[MAXADDRS];
106   char *__host_aliases[MAXALIASES];
107   unsigned int __host_addr[4];
108 };
109 
110 /*
111  * Assumption here is that a network number
112  * fits in an unsigned long -- probably a poor one.
113  */
114 struct netent {
115 	char		*n_name;	/* official name of net */
116 	char		**n_aliases;	/* alias list */
117 	int		n_addrtype;	/* net address type */
118 	unsigned long	n_net;		/* network # */
119 };
120 
121 struct servent {
122 	char	*s_name;	/* official service name */
123 	char	**s_aliases;	/* alias list */
124 	int	s_port;		/* port # */
125 	char	*s_proto;	/* protocol to use */
126 };
127 
128 struct protoent {
129 	char	*p_name;	/* official protocol name */
130 	char	**p_aliases;	/* alias list */
131 	int	p_proto;	/* protocol # */
132 };
133 
134 struct addrinfo {
135 	int	ai_flags;	/* AI_PASSIVE, AI_CANONNAME, AI_NUMERICHOST */
136 	int	ai_family;	/* PF_xxx */
137 	int	ai_socktype;	/* SOCK_xxx */
138 	int	ai_protocol;	/* 0 or IPPROTO_xxx for IPv4 and IPv6 */
139 	size_t	ai_addrlen;	/* length of ai_addr */
140 	char	*ai_canonname;	/* canonical name for hostname */
141 	struct	sockaddr *ai_addr;	/* binary address */
142 	struct	addrinfo *ai_next;	/* next structure in linked list */
143 };
144 
145 /*
146  * Error return codes from gethostbyname() and gethostbyaddr()
147  * (left in extern int h_errno).
148  */
149 
150 #define	NETDB_INTERNAL	-1	/* see errno */
151 #define	NETDB_SUCCESS	0	/* no problem */
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 #define	NO_ADDRESS	NO_DATA		/* no address, look for MX record */
157 
158 /*
159  * Error return codes from getaddrinfo()
160  */
161 #define	EAI_ADDRFAMILY	 1	/* address family for hostname not supported */
162 #define	EAI_AGAIN	 2	/* temporary failure in name resolution */
163 #define	EAI_BADFLAGS	 3	/* invalid value for ai_flags */
164 #define	EAI_FAIL	 4	/* non-recoverable failure in name resolution */
165 #define	EAI_FAMILY	 5	/* ai_family not supported */
166 #define	EAI_MEMORY	 6	/* memory allocation failure */
167 #define	EAI_NODATA	 7	/* no address associated with hostname */
168 #define	EAI_NONAME	 8	/* hostname nor servname provided, or not known */
169 #define	EAI_SERVICE	 9	/* servname not supported for ai_socktype */
170 #define	EAI_SOCKTYPE	10	/* ai_socktype not supported */
171 #define	EAI_SYSTEM	11	/* system error returned in errno */
172 #define	EAI_BADHINTS	12
173 #define	EAI_PROTOCOL	13
174 #define	EAI_MAX		14
175 
176 /*
177  * Flag values for getaddrinfo()
178  */
179 #define	AI_PASSIVE	0x00000001 /* get address to use bind() */
180 #define	AI_CANONNAME	0x00000002 /* fill ai_canonname */
181 #define	AI_NUMERICHOST	0x00000004 /* prevent name resolution */
182 /* valid flags for addrinfo */
183 #define AI_MASK \
184     (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_ADDRCONFIG)
185 
186 #define	AI_ALL		0x00000100 /* IPv6 and IPv4-mapped (with AI_V4MAPPED) */
187 #define	AI_V4MAPPED_CFG	0x00000200 /* accept IPv4-mapped if kernel supports */
188 #define	AI_ADDRCONFIG	0x00000400 /* only if any address is assigned */
189 #define	AI_V4MAPPED	0x00000800 /* accept IPv4-mapped IPv6 address */
190 /* special recommended flags for getipnodebyname */
191 #define	AI_DEFAULT	(AI_V4MAPPED_CFG | AI_ADDRCONFIG)
192 
193 /*
194  * Constants for getnameinfo()
195  */
196 #define	NI_MAXHOST	1025
197 #define	NI_MAXSERV	32
198 
199 /*
200  * Flag values for getnameinfo()
201  */
202 #define	NI_NOFQDN	0x00000001
203 #define	NI_NUMERICHOST	0x00000002
204 #define	NI_NAMEREQD	0x00000004
205 #define	NI_NUMERICSERV	0x00000008
206 #define	NI_DGRAM	0x00000010
207 #define NI_WITHSCOPEID	0x00000020
208 
209 /*
210  * Scope delimit character
211  */
212 #define	SCOPE_DELIMITER	'%'
213 
214 __BEGIN_DECLS
215 void		endhostent(void);
216 void		endhostent_r(FILE **, int *);
217 void		endnetent(void);
218 void		endnetgrent(void);
219 void		endprotoent(void);
220 void		endservent(void);
221 void		freehostent(struct hostent *);
222 struct hostent	*gethostbyaddr(const char *, int, int);
223 struct hostent	*gethostbyname(const char *);
224 struct hostent	*gethostbyname2(const char *, int);
225 struct hostent	*gethostent(void);
226 int             gethostent_r(struct hostent *, char *, int, int *, FILE **);
227 struct hostent	*getipnodebyaddr(const void *, size_t, int, int *);
228 struct hostent	*getipnodebyname(const char *, int, int, int *);
229 struct netent	*getnetbyaddr(unsigned long, int);
230 struct netent	*getnetbyname(const char *);
231 struct netent	*getnetent(void);
232 int		getnetgrent(char **, char **, char **);
233 struct protoent	*getprotobyname(const char *);
234 struct protoent	*getprotobynumber(int);
235 struct protoent	*getprotoent(void);
236 struct servent	*getservbyname(const char *, const char *);
237 struct servent	*getservbyport(int, const char *);
238 struct servent	*getservent(void);
239 void		herror(const char *);
240 __const char	*hstrerror(int);
241 int		innetgr(const char *, const char *, const char *, const char *);
242 void		sethostent(int);
243 void		sethostent_r(int, FILE **, 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 char		*gai_strerror(int);
253 void		setnetgrent(const char *);
254 void		setservent(int);
255 
256 /*
257  * PRIVATE functions specific to the FreeBSD implementation
258  */
259 
260 /* DO NOT USE THESE, THEY ARE SUBJECT TO CHANGE AND ARE NOT PORTABLE!!! */
261 void	_sethosthtent(int);
262 void	_sethosthtent_r(int, FILE **, int *);
263 void	_endhosthtent(void);
264 void	_endhosthtent_r(FILE **, int *);
265 void	_sethostdnsent(int);
266 void	_endhostdnsent(void);
267 void	_setnethtent(int);
268 void	_endnethtent(void);
269 void	_setnetdnsent(int);
270 void	_endnetdnsent(void);
271 struct hostent * _gethostbynisname(const char *, int);
272 struct hostent * _gethostbynisaddr(const char *, int, int);
273 void _map_v4v6_address(const char *, char *);
274 void _map_v4v6_hostent(struct hostent *, char **, int *);
275 __END_DECLS
276 
277 #endif /* !_NETDB_H_ */
278