xref: /freebsd/include/netdb.h (revision df7f5d4de4592a8948a25ce01e5bddfbb7ce39dc)
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  *      @(#)netdb.h	8.1 (Berkeley) 6/2/93
34  *      From: Id: netdb.h,v 8.7 1996/05/09 05:59:09 vixie Exp
35  *	$Id$
36  * -
37  * Portions Copyright (c) 1993 by Digital Equipment Corporation.
38  *
39  * Permission to use, copy, modify, and distribute this software for any
40  * purpose with or without fee is hereby granted, provided that the above
41  * copyright notice and this permission notice appear in all copies, and that
42  * the name of Digital Equipment Corporation not be used in advertising or
43  * publicity pertaining to distribution of the document or software without
44  * specific, written prior permission.
45  *
46  * THE SOFTWARE IS PROVIDED "AS IS" AND DIGITAL EQUIPMENT CORP. DISCLAIMS ALL
47  * WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES
48  * OF MERCHANTABILITY AND FITNESS.   IN NO EVENT SHALL DIGITAL EQUIPMENT
49  * CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
50  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
51  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
52  * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
53  * SOFTWARE.
54  * -
55  * --Copyright--
56  */
57 
58 #ifndef _NETDB_H_
59 #define _NETDB_H_
60 
61 #include <sys/cdefs.h>
62 
63 #define	_PATH_HEQUIV	"/etc/hosts.equiv"
64 #define	_PATH_HOSTS	"/etc/hosts"
65 #define	_PATH_NETWORKS	"/etc/networks"
66 #define	_PATH_PROTOCOLS	"/etc/protocols"
67 #define	_PATH_SERVICES	"/etc/services"
68 
69 extern int h_errno;
70 
71 /*
72  * Structures returned by network data base library.  All addresses are
73  * supplied in host order, and returned in network order (suitable for
74  * use in system calls).
75  */
76 struct	hostent {
77 	char	*h_name;	/* official name of host */
78 	char	**h_aliases;	/* alias list */
79 	int	h_addrtype;	/* host address type */
80 	int	h_length;	/* length of address */
81 	char	**h_addr_list;	/* list of addresses from name server */
82 #define	h_addr	h_addr_list[0]	/* address, for backward compatibility */
83 };
84 
85 /*
86  * Assumption here is that a network number
87  * fits in an unsigned long -- probably a poor one.
88  */
89 struct	netent {
90 	char		*n_name;	/* official name of net */
91 	char		**n_aliases;	/* alias list */
92 	int		n_addrtype;	/* net address type */
93 	unsigned long	n_net;		/* network # */
94 };
95 
96 struct	servent {
97 	char	*s_name;	/* official service name */
98 	char	**s_aliases;	/* alias list */
99 	int	s_port;		/* port # */
100 	char	*s_proto;	/* protocol to use */
101 };
102 
103 struct	protoent {
104 	char	*p_name;	/* official protocol name */
105 	char	**p_aliases;	/* alias list */
106 	int	p_proto;	/* protocol # */
107 };
108 
109 /*
110  * Error return codes from gethostbyname() and gethostbyaddr()
111  * (left in extern int h_errno).
112  */
113 
114 #define	NETDB_INTERNAL	-1	/* see errno */
115 #define	NETDB_SUCCESS	0	/* no problem */
116 #define	HOST_NOT_FOUND	1 /* Authoritative Answer Host not found */
117 #define	TRY_AGAIN	2 /* Non-Authoritative Host not found, or SERVERFAIL */
118 #define	NO_RECOVERY	3 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP */
119 #define	NO_DATA		4 /* Valid name, no data record of requested type */
120 #define	NO_ADDRESS	NO_DATA		/* no address, look for MX record */
121 
122 __BEGIN_DECLS
123 void		endhostent __P((void));
124 void		endnetent __P((void));
125 void		endprotoent __P((void));
126 void		endservent __P((void));
127 struct hostent	*gethostbyaddr __P((const char *, int, int));
128 struct hostent	*gethostbyname __P((const char *));
129 struct hostent	*gethostbyname2 __P((const char *, int));
130 struct hostent	*gethostent __P((void));
131 struct netent	*getnetbyaddr __P((unsigned long, int));
132 struct netent	*getnetbyname __P((const char *));
133 struct netent	*getnetent __P((void));
134 struct protoent	*getprotobyname __P((const char *));
135 struct protoent	*getprotobynumber __P((int));
136 struct protoent	*getprotoent __P((void));
137 struct servent	*getservbyname __P((const char *, const char *));
138 struct servent	*getservbyport __P((int, const char *));
139 struct servent	*getservent __P((void));
140 void		herror __P((const char *));
141 const char	*hstrerror __P((int));
142 void		sethostent __P((int));
143 /* void		sethostfile __P((const char *)); */
144 void		setnetent __P((int));
145 void		setprotoent __P((int));
146 void		setservent __P((int));
147 
148 /*
149  * PRIVATE functions specific to the FreeBSD implementation
150  */
151 
152 /* DO NOT USE THESE, THEY ARE SUBJECT TO CHANGE AND ARE NOT PORTABLE!!! */
153 void	_sethosthtent __P((int));
154 void	_endhosthtent __P((void));
155 void	_sethostdnsent __P((int));
156 void	_endhostdnsent __P((void));
157 void	_setnethtent __P((int));
158 void	_endnethtent __P((void));
159 void	_setnetdnsent __P((int));
160 void	_endnetdnsent __P((void));
161 struct hostent * _gethostbyhtname  __P((const char *, int));
162 struct hostent * _gethostbydnsname __P((const char *, int));
163 struct hostent * _gethostbynisname __P((const char *, int));
164 struct hostent * _gethostbyhtaddr  __P((const char *, int, int));
165 struct hostent * _gethostbydnsaddr __P((const char *, int, int));
166 struct hostent * _gethostbynisaddr __P((const char *, int, int));
167 struct netent *  _getnetbyhtname  __P((const char *));
168 struct netent *  _getnetbydnsname __P((const char *));
169 struct netent *  _getnetbynisname __P((const char *));
170 struct netent *  _getnetbyhtaddr  __P((unsigned long, int));
171 struct netent *  _getnetbydnsaddr __P((unsigned long, int));
172 struct netent *  _getnetbynisaddr __P((unsigned long, int));
173 void _map_v4v6_address __P((const char *src, char *dst));
174 void _map_v4v6_hostent __P((struct hostent *hp, char **bp, int *len));
175 __END_DECLS
176 
177 #endif /* !_NETDB_H_ */
178