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