netdb.h revision 4c1233433d4d46f6e4a755a79944ded2cc7e5420
17c478bdstevel@tonic-gate/*-
27c478bdstevel@tonic-gate * Copyright (c) 1980, 1983, 1988, 1993
37c478bdstevel@tonic-gate *	The Regents of the University of California.  All rights reserved.
47c478bdstevel@tonic-gate *
54a634bbga * Redistribution and use in source and binary forms, with or without
64a634bbga * modification, are permitted provided that the following conditions
77c478bdstevel@tonic-gate * are met:
87c478bdstevel@tonic-gate * 1. Redistributions of source code must retain the above copyright
97c478bdstevel@tonic-gate *    notice, this list of conditions and the following disclaimer.
107c478bdstevel@tonic-gate * 2. Redistributions in binary form must reproduce the above copyright
117c478bdstevel@tonic-gate *    notice, this list of conditions and the following disclaimer in the
127c478bdstevel@tonic-gate *    documentation and/or other materials provided with the distribution.
137c478bdstevel@tonic-gate * 3. All advertising materials mentioning features or use of this software
147c478bdstevel@tonic-gate *    must display the following acknowledgement:
157c478bdstevel@tonic-gate *	This product includes software developed by the University of
167c478bdstevel@tonic-gate *	California, Berkeley and its contributors.
177c478bdstevel@tonic-gate * 4. Neither the name of the University nor the names of its contributors
187c478bdstevel@tonic-gate *    may be used to endorse or promote products derived from this software
197c478bdstevel@tonic-gate *    without specific prior written permission.
207c478bdstevel@tonic-gate *
217c478bdstevel@tonic-gate * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
224a634bbga * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
237c478bdstevel@tonic-gate * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
247c478bdstevel@tonic-gate * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
257c478bdstevel@tonic-gate * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
267c478bdstevel@tonic-gate * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
277c478bdstevel@tonic-gate * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
287c478bdstevel@tonic-gate * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
297c478bdstevel@tonic-gate * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
307c478bdstevel@tonic-gate * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
317c478bdstevel@tonic-gate * SUCH DAMAGE.
327c478bdstevel@tonic-gate *
337c478bdstevel@tonic-gate * -
347c478bdstevel@tonic-gate * Portions Copyright (c) 1993 by Digital Equipment Corporation.
357c478bdstevel@tonic-gate *
367c478bdstevel@tonic-gate * Permission to use, copy, modify, and distribute this software for any
377c478bdstevel@tonic-gate * purpose with or without fee is hereby granted, provided that the above
387c478bdstevel@tonic-gate * copyright notice and this permission notice appear in all copies, and that
397c478bdstevel@tonic-gate * the name of Digital Equipment Corporation not be used in advertising or
407c478bdstevel@tonic-gate * publicity pertaining to distribution of the document or software without
417c478bdstevel@tonic-gate * specific, written prior permission.
427c478bdstevel@tonic-gate *
437c478bdstevel@tonic-gate * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
447c478bdstevel@tonic-gate * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
457c478bdstevel@tonic-gate * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
467c478bdstevel@tonic-gate * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
477c478bdstevel@tonic-gate * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
487c478bdstevel@tonic-gate * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
497c478bdstevel@tonic-gate * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
507c478bdstevel@tonic-gate * SOFTWARE.
517c478bdstevel@tonic-gate * -
527c478bdstevel@tonic-gate * --Copyright--
537c478bdstevel@tonic-gate */
547c478bdstevel@tonic-gate
557c478bdstevel@tonic-gate/*
567c478bdstevel@tonic-gate *      @(#)netdb.h	8.1 (Berkeley) 6/2/93
577c478bdstevel@tonic-gate *      From: Id: netdb.h,v 8.9 1996/11/19 08:39:29 vixie Exp $
587c478bdstevel@tonic-gate * $FreeBSD$
597c478bdstevel@tonic-gate */
607c478bdstevel@tonic-gate
617c478bdstevel@tonic-gate#ifndef _NETDB_H_
627c478bdstevel@tonic-gate#define _NETDB_H_
637c478bdstevel@tonic-gate
647c478bdstevel@tonic-gate#include <machine/ansi.h>
657c478bdstevel@tonic-gate#include <sys/cdefs.h>
667c478bdstevel@tonic-gate
677c478bdstevel@tonic-gate#ifdef	_BSD_SIZE_T_
687c478bdstevel@tonic-gatetypedef	_BSD_SIZE_T_	size_t;
697c478bdstevel@tonic-gate#undef	_BSD_SIZE_T_
707c478bdstevel@tonic-gate#endif
717c478bdstevel@tonic-gate
727c478bdstevel@tonic-gate#ifndef _PATH_HEQUIV
737c478bdstevel@tonic-gate# define	_PATH_HEQUIV	"/etc/hosts.equiv"
747c478bdstevel@tonic-gate#endif
757c478bdstevel@tonic-gate#define	_PATH_HOSTS	"/etc/hosts"
767c478bdstevel@tonic-gate#define	_PATH_NETWORKS	"/etc/networks"
777c478bdstevel@tonic-gate#define	_PATH_PROTOCOLS	"/etc/protocols"
787c478bdstevel@tonic-gate#define	_PATH_SERVICES	"/etc/services"
797c478bdstevel@tonic-gate
807c478bdstevel@tonic-gateextern int h_errno;
817c478bdstevel@tonic-gate
827c478bdstevel@tonic-gate/*
837c478bdstevel@tonic-gate * Structures returned by network data base library.  All addresses are
847c478bdstevel@tonic-gate * supplied in host order, and returned in network order (suitable for
857c478bdstevel@tonic-gate * use in system calls).
867c478bdstevel@tonic-gate */
877c478bdstevel@tonic-gatestruct	hostent {
887c478bdstevel@tonic-gate	char	*h_name;	/* official name of host */
897c478bdstevel@tonic-gate	char	**h_aliases;	/* alias list */
907c478bdstevel@tonic-gate	int	h_addrtype;	/* host address type */
917c478bdstevel@tonic-gate	int	h_length;	/* length of address */
927c478bdstevel@tonic-gate	char	**h_addr_list;	/* list of addresses from name server */
937c478bdstevel@tonic-gate#define	h_addr	h_addr_list[0]	/* address, for backward compatibility */
947c478bdstevel@tonic-gate};
957c478bdstevel@tonic-gate
967c478bdstevel@tonic-gate/*
977c478bdstevel@tonic-gate * Assumption here is that a network number
987c478bdstevel@tonic-gate * fits in an unsigned long -- probably a poor one.
997c478bdstevel@tonic-gate */
1007c478bdstevel@tonic-gatestruct	netent {
1017c478bdstevel@tonic-gate	char		*n_name;	/* official name of net */
1027c478bdstevel@tonic-gate	char		**n_aliases;	/* alias list */
1037c478bdstevel@tonic-gate	int		n_addrtype;	/* net address type */
1047c478bdstevel@tonic-gate	unsigned long	n_net;		/* network # */
1057c478bdstevel@tonic-gate};
1067c478bdstevel@tonic-gate
1077c478bdstevel@tonic-gatestruct	servent {
1087c478bdstevel@tonic-gate	char	*s_name;	/* official service name */
1097c478bdstevel@tonic-gate	char	**s_aliases;	/* alias list */
1107c478bdstevel@tonic-gate	int	s_port;		/* port # */
1117c478bdstevel@tonic-gate	char	*s_proto;	/* protocol to use */
1127c478bdstevel@tonic-gate};
1137c478bdstevel@tonic-gate
114struct	protoent {
115	char	*p_name;	/* official protocol name */
116	char	**p_aliases;	/* alias list */
117	int	p_proto;	/* protocol # */
118};
119
120struct addrinfo {
121	int	ai_flags;	/* AI_PASSIVE, AI_CANONNAME, AI_NUMERICHOST */
122	int	ai_family;	/* PF_xxx */
123	int	ai_socktype;	/* SOCK_xxx */
124	int	ai_protocol;	/* 0 or IPPROTO_xxx for IPv4 and IPv6 */
125	size_t	ai_addrlen;	/* length of ai_addr */
126	char	*ai_canonname;	/* canonical name for hostname */
127	struct	sockaddr *ai_addr;	/* binary address */
128	struct	addrinfo *ai_next;	/* next structure in linked list */
129};
130
131/*
132 * Error return codes from gethostbyname() and gethostbyaddr()
133 * (left in extern int h_errno).
134 */
135
136#define	NETDB_INTERNAL	-1	/* see errno */
137#define	NETDB_SUCCESS	0	/* no problem */
138#define	HOST_NOT_FOUND	1 /* Authoritative Answer Host not found */
139#define	TRY_AGAIN	2 /* Non-Authoritative Host not found, or SERVERFAIL */
140#define	NO_RECOVERY	3 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP */
141#define	NO_DATA		4 /* Valid name, no data record of requested type */
142#define	NO_ADDRESS	NO_DATA		/* no address, look for MX record */
143
144/*
145 * Error return codes from getaddrinfo()
146 */
147#define	EAI_ADDRFAMILY	 1	/* address family for hostname not supported */
148#define	EAI_AGAIN	 2	/* temporary failure in name resolution */
149#define	EAI_BADFLAGS	 3	/* invalid value for ai_flags */
150#define	EAI_FAIL	 4	/* non-recoverable failure in name resolution */
151#define	EAI_FAMILY	 5	/* ai_family not supported */
152#define	EAI_MEMORY	 6	/* memory allocation failure */
153#define	EAI_NODATA	 7	/* no address associated with hostname */
154#define	EAI_NONAME	 8	/* hostname nor servname provided, or not known */
155#define	EAI_SERVICE	 9	/* servname not supported for ai_socktype */
156#define	EAI_SOCKTYPE	10	/* ai_socktype not supported */
157#define	EAI_SYSTEM	11	/* system error returned in errno */
158#define	EAI_BADHINTS	12
159#define	EAI_PROTOCOL	13
160#define	EAI_RESNULL	14
161#define	EAI_MAX		15
162
163/*
164 * Flag values for getaddrinfo()
165 */
166#define	AI_PASSIVE	0x00000001 /* get address to use bind() */
167#define	AI_CANONNAME	0x00000002 /* fill ai_canonname */
168#define	AI_NUMERICHOST	0x00000004 /* prevent name resolution */
169/* valid flags for addrinfo */
170#define AI_MASK \
171    (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_ADDRCONFIG)
172
173#define	AI_ALL		0x00000100 /* IPv6 and IPv4-mapped (with AI_V4MAPPED) */
174#define	AI_V4MAPPED_CFG	0x00000200 /* accept IPv4-mapped if kernel supports */
175#define	AI_ADDRCONFIG	0x00000400 /* only if any address is assigned */
176#define	AI_V4MAPPED	0x00000800 /* accept IPv4-mapped IPv6 address */
177/* special recommended flags for getipnodebyname */
178#define	AI_DEFAULT	(AI_V4MAPPED_CFG | AI_ADDRCONFIG)
179
180/*
181 * Constants for getnameinfo()
182 */
183#define	NI_MAXHOST	1025
184#define	NI_MAXSERV	32
185
186/*
187 * Flag values for getnameinfo()
188 */
189#define	NI_NOFQDN	0x00000001
190#define	NI_NUMERICHOST	0x00000002
191#define	NI_NAMEREQD	0x00000004
192#define	NI_NUMERICSERV	0x00000008
193#define	NI_DGRAM	0x00000010
194#define NI_WITHSCOPEID	0x00000020
195
196/*
197 * Scope delimit character
198 */
199#define	SCOPE_DELIMITER	'%'
200
201/*
202 * data types - basically forward decl for getnameinfo()
203 */
204#ifdef	_BSD_SOCKLEN_T_
205typedef	_BSD_SOCKLEN_T_	socklen_t;
206#undef	_BSD_SOCKLEN_T_
207#endif
208
209__BEGIN_DECLS
210void		endhostent __P((void));
211void		endnetent __P((void));
212void		endprotoent __P((void));
213void		endservent __P((void));
214void		freehostent __P((struct hostent *));
215struct hostent	*gethostbyaddr __P((const char *, int, int));
216struct hostent	*gethostbyname __P((const char *));
217struct hostent	*gethostbyname2 __P((const char *, int));
218struct hostent	*gethostent __P((void));
219struct hostent	*getipnodebyaddr __P((const void *, size_t, int, int *));
220struct hostent	*getipnodebyname __P((const char *, int, int, int *));
221struct netent	*getnetbyaddr __P((unsigned long, int));
222struct netent	*getnetbyname __P((const char *));
223struct netent	*getnetent __P((void));
224struct protoent	*getprotobyname __P((const char *));
225struct protoent	*getprotobynumber __P((int));
226struct protoent	*getprotoent __P((void));
227struct servent	*getservbyname __P((const char *, const char *));
228struct servent	*getservbyport __P((int, const char *));
229struct servent	*getservent __P((void));
230void		herror __P((const char *));
231__const char	*hstrerror __P((int));
232void		sethostent __P((int));
233/* void		sethostfile __P((const char *)); */
234void		setnetent __P((int));
235void		setprotoent __P((int));
236int		getaddrinfo __P((const char *, const char *,
237				 const struct addrinfo *, struct addrinfo **));
238int		getnameinfo __P((const struct sockaddr *, socklen_t, char *,
239				 size_t, char *, size_t, int));
240void		freeaddrinfo __P((struct addrinfo *));
241char		*gai_strerror __P((int));
242void		setservent __P((int));
243
244/*
245 * PRIVATE functions specific to the FreeBSD implementation
246 */
247
248/* DO NOT USE THESE, THEY ARE SUBJECT TO CHANGE AND ARE NOT PORTABLE!!! */
249void	_sethosthtent __P((int));
250void	_endhosthtent __P((void));
251void	_sethostdnsent __P((int));
252void	_endhostdnsent __P((void));
253void	_setnethtent __P((int));
254void	_endnethtent __P((void));
255void	_setnetdnsent __P((int));
256void	_endnetdnsent __P((void));
257struct hostent * _gethostbynisname __P((const char *, int));
258struct hostent * _gethostbynisaddr __P((const char *, int, int));
259void _map_v4v6_address __P((const char *src, char *dst));
260void _map_v4v6_hostent __P((struct hostent *hp, char **bp, int *len));
261__END_DECLS
262
263#endif /* !_NETDB_H_ */
264