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