xref: /freebsd/include/netdb.h (revision 7f3dea244c40159a41ab22da77a434d7c5b5e85a)
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 
66 #ifndef _PATH_HEQUIV
67 # define	_PATH_HEQUIV	"/etc/hosts.equiv"
68 #endif
69 #define	_PATH_HOSTS	"/etc/hosts"
70 #define	_PATH_NETWORKS	"/etc/networks"
71 #define	_PATH_PROTOCOLS	"/etc/protocols"
72 #define	_PATH_SERVICES	"/etc/services"
73 
74 extern int h_errno;
75 
76 /*
77  * Structures returned by network data base library.  All addresses are
78  * supplied in host order, and returned in network order (suitable for
79  * use in system calls).
80  */
81 struct	hostent {
82 	char	*h_name;	/* official name of host */
83 	char	**h_aliases;	/* alias list */
84 	int	h_addrtype;	/* host address type */
85 	int	h_length;	/* length of address */
86 	char	**h_addr_list;	/* list of addresses from name server */
87 #define	h_addr	h_addr_list[0]	/* address, for backward compatibility */
88 };
89 
90 /*
91  * Assumption here is that a network number
92  * fits in an unsigned long -- probably a poor one.
93  */
94 struct	netent {
95 	char		*n_name;	/* official name of net */
96 	char		**n_aliases;	/* alias list */
97 	int		n_addrtype;	/* net address type */
98 	unsigned long	n_net;		/* network # */
99 };
100 
101 struct	servent {
102 	char	*s_name;	/* official service name */
103 	char	**s_aliases;	/* alias list */
104 	int	s_port;		/* port # */
105 	char	*s_proto;	/* protocol to use */
106 };
107 
108 struct	protoent {
109 	char	*p_name;	/* official protocol name */
110 	char	**p_aliases;	/* alias list */
111 	int	p_proto;	/* protocol # */
112 };
113 
114 /*
115  * Error return codes from gethostbyname() and gethostbyaddr()
116  * (left in extern int h_errno).
117  */
118 
119 #define	NETDB_INTERNAL	-1	/* see errno */
120 #define	NETDB_SUCCESS	0	/* no problem */
121 #define	HOST_NOT_FOUND	1 /* Authoritative Answer Host not found */
122 #define	TRY_AGAIN	2 /* Non-Authoritative Host not found, or SERVERFAIL */
123 #define	NO_RECOVERY	3 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP */
124 #define	NO_DATA		4 /* Valid name, no data record of requested type */
125 #define	NO_ADDRESS	NO_DATA		/* no address, look for MX record */
126 
127 __BEGIN_DECLS
128 void		endhostent __P((void));
129 void		endnetent __P((void));
130 void		endprotoent __P((void));
131 void		endservent __P((void));
132 struct hostent	*gethostbyaddr __P((const char *, int, int));
133 struct hostent	*gethostbyname __P((const char *));
134 struct hostent	*gethostbyname2 __P((const char *, int));
135 struct hostent	*gethostent __P((void));
136 struct netent	*getnetbyaddr __P((unsigned long, int));
137 struct netent	*getnetbyname __P((const char *));
138 struct netent	*getnetent __P((void));
139 struct protoent	*getprotobyname __P((const char *));
140 struct protoent	*getprotobynumber __P((int));
141 struct protoent	*getprotoent __P((void));
142 struct servent	*getservbyname __P((const char *, const char *));
143 struct servent	*getservbyport __P((int, const char *));
144 struct servent	*getservent __P((void));
145 void		herror __P((const char *));
146 __const char	*hstrerror __P((int));
147 void		sethostent __P((int));
148 /* void		sethostfile __P((const char *)); */
149 void		setnetent __P((int));
150 void		setprotoent __P((int));
151 void		setservent __P((int));
152 
153 /*
154  * PRIVATE functions specific to the FreeBSD implementation
155  */
156 
157 /* DO NOT USE THESE, THEY ARE SUBJECT TO CHANGE AND ARE NOT PORTABLE!!! */
158 void	_sethosthtent __P((int));
159 void	_endhosthtent __P((void));
160 void	_sethostdnsent __P((int));
161 void	_endhostdnsent __P((void));
162 void	_setnethtent __P((int));
163 void	_endnethtent __P((void));
164 void	_setnetdnsent __P((int));
165 void	_endnetdnsent __P((void));
166 struct hostent * _gethostbyhtname  __P((const char *, int));
167 struct hostent * _gethostbydnsname __P((const char *, int));
168 struct hostent * _gethostbynisname __P((const char *, int));
169 struct hostent * _gethostbyhtaddr  __P((const char *, int, int));
170 struct hostent * _gethostbydnsaddr __P((const char *, int, int));
171 struct hostent * _gethostbynisaddr __P((const char *, int, int));
172 struct netent *  _getnetbyhtname  __P((const char *));
173 struct netent *  _getnetbydnsname __P((const char *));
174 struct netent *  _getnetbynisname __P((const char *));
175 struct netent *  _getnetbyhtaddr  __P((unsigned long, int));
176 struct netent *  _getnetbydnsaddr __P((unsigned long, int));
177 struct netent *  _getnetbynisaddr __P((unsigned long, int));
178 void _map_v4v6_address __P((const char *src, char *dst));
179 void _map_v4v6_hostent __P((struct hostent *hp, char **bp, int *len));
180 __END_DECLS
181 
182 #endif /* !_NETDB_H_ */
183