Merge branch 'master' of ssh://crater.dragonflybsd.org/repository/git/dragonfly
[dragonfly.git] / include / netdb.h
blob1f7e5fafe050aa6be2008e78092d3604c120ca32
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. 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.
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.
33 * -
34 * Portions Copyright (c) 1993 by Digital Equipment Corporation.
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.
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--
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: src/include/netdb.h,v 1.45 2009/03/14 20:04:28 das Exp $
59 * $DragonFly: src/include/netdb.h,v 1.7 2008/10/04 22:09:16 swildner Exp $
62 #ifndef _NETDB_H_
63 #define _NETDB_H_
65 #include <sys/cdefs.h>
66 #include <sys/types.h>
68 #ifndef _SIZE_T_DECLARED
69 typedef __size_t size_t;
70 #define _SIZE_T_DECLARED
71 #endif
73 #ifndef _SOCKLEN_T_DECLARED
74 typedef __socklen_t socklen_t;
75 #define _SOCKLEN_T_DECLARED
76 #endif
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"
86 #define h_errno (*__h_errno())
89 * Structures returned by network data base library. All addresses are
90 * supplied in host order, and returned in network order (suitable for
91 * use in system calls).
93 struct hostent {
94 char *h_name; /* official name of host */
95 char **h_aliases; /* alias list */
96 int h_addrtype; /* host address type */
97 int h_length; /* length of address */
98 char **h_addr_list; /* list of addresses from name server */
99 #define h_addr h_addr_list[0] /* address, for backward compatibility */
102 struct netent {
103 char *n_name; /* official name of net */
104 char **n_aliases; /* alias list */
105 int n_addrtype; /* net address type */
106 uint32_t n_net; /* network # */
109 struct servent {
110 char *s_name; /* official service name */
111 char **s_aliases; /* alias list */
112 int s_port; /* port # */
113 char *s_proto; /* protocol to use */
116 struct protoent {
117 char *p_name; /* official protocol name */
118 char **p_aliases; /* alias list */
119 int p_proto; /* protocol # */
122 struct addrinfo {
123 int ai_flags; /* AI_PASSIVE, AI_CANONNAME, AI_NUMERICHOST */
124 int ai_family; /* PF_xxx */
125 int ai_socktype; /* SOCK_xxx */
126 int ai_protocol; /* 0 or IPPROTO_xxx for IPv4 and IPv6 */
127 socklen_t ai_addrlen; /* length of ai_addr */
128 char *ai_canonname; /* canonical name for hostname */
129 struct sockaddr *ai_addr; /* binary address */
130 struct addrinfo *ai_next; /* next structure in linked list */
134 * Error return codes from gethostbyname() and gethostbyaddr()
135 * (left in h_errno).
138 #define NETDB_INTERNAL -1 /* see errno */
139 #define NETDB_SUCCESS 0 /* no problem */
140 #define HOST_NOT_FOUND 1 /* Authoritative Answer Host not found */
141 #define TRY_AGAIN 2 /* Non-Authoritative Host not found, or SERVERFAIL */
142 #define NO_RECOVERY 3 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP */
143 #define NO_DATA 4 /* Valid name, no data record of requested type */
144 #define NO_ADDRESS NO_DATA /* no address, look for MX record */
147 * Error return codes from getaddrinfo()
149 /* XXX deprecated */
150 #define EAI_ADDRFAMILY 1 /* address family for hostname not supported */
151 #define EAI_AGAIN 2 /* temporary failure in name resolution */
152 #define EAI_BADFLAGS 3 /* invalid value for ai_flags */
153 #define EAI_FAIL 4 /* non-recoverable failure in name resolution */
154 #define EAI_FAMILY 5 /* ai_family not supported */
155 #define EAI_MEMORY 6 /* memory allocation failure */
156 /* XXX deprecated */
157 #define EAI_NODATA 7 /* no address associated with hostname */
158 #define EAI_NONAME 8 /* hostname nor servname provided, or not known */
159 #define EAI_SERVICE 9 /* servname not supported for ai_socktype */
160 #define EAI_SOCKTYPE 10 /* ai_socktype not supported */
161 #define EAI_SYSTEM 11 /* system error returned in errno */
162 #define EAI_BADHINTS 12 /* invalid value for hints */
163 #define EAI_PROTOCOL 13 /* resolved protocol is unknown */
164 #define EAI_OVERFLOW 14 /* argument buffer overflow */
165 #define EAI_MAX 15
168 * Flag values for getaddrinfo()
170 #define AI_PASSIVE 0x00000001 /* get address to use bind() */
171 #define AI_CANONNAME 0x00000002 /* fill ai_canonname */
172 #define AI_NUMERICHOST 0x00000004 /* prevent host name resolution */
173 #define AI_NUMERICSERV 0x00000008 /* prevent service name resolution */
174 /* valid flags for addrinfo (not a standard def, apps should not use it) */
175 #define AI_MASK \
176 (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_NUMERICSERV | \
177 AI_ADDRCONFIG)
179 #define AI_ALL 0x00000100 /* IPv6 and IPv4-mapped (with AI_V4MAPPED) */
180 #define AI_V4MAPPED_CFG 0x00000200 /* accept IPv4-mapped if kernel supports */
181 #define AI_ADDRCONFIG 0x00000400 /* only if any address is assigned */
182 #define AI_V4MAPPED 0x00000800 /* accept IPv4-mapped IPv6 address */
183 /* special recommended flags for getipnodebyname */
184 #define AI_DEFAULT (AI_V4MAPPED_CFG | AI_ADDRCONFIG)
187 * Constants for getnameinfo()
189 #define NI_MAXHOST 1025
190 #define NI_MAXSERV 32
193 * Flag values for getnameinfo()
195 #define NI_NOFQDN 0x00000001
196 #define NI_NUMERICHOST 0x00000002
197 #define NI_NAMEREQD 0x00000004
198 #define NI_NUMERICSERV 0x00000008
199 #define NI_DGRAM 0x00000010
200 /* XXX deprecated */
201 #define NI_WITHSCOPEID 0x00000020
205 * Scope delimit character
207 #define SCOPE_DELIMITER '%'
209 __BEGIN_DECLS
210 void endhostent(void);
211 void endnetent(void);
212 void endprotoent(void);
213 void endservent(void);
214 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE <= 200112)
215 struct hostent *gethostbyaddr(const void *, socklen_t, int);
216 struct hostent *gethostbyname(const char *);
217 #endif
218 struct hostent *gethostent(void);
219 struct netent *getnetbyaddr(uint32_t, int);
220 struct netent *getnetbyname(const char *);
221 struct netent *getnetent(void);
222 struct protoent *getprotobyname(const char *);
223 struct protoent *getprotobynumber(int);
224 struct protoent *getprotoent(void);
225 struct servent *getservbyname(const char *, const char *);
226 struct servent *getservbyport(int, const char *);
227 struct servent *getservent(void);
228 void sethostent(int);
229 /* void sethostfile(const char *); */
230 void setnetent(int);
231 void setprotoent(int);
232 int getaddrinfo(const char *, const char *,
233 const struct addrinfo *, struct addrinfo **);
234 int getnameinfo(const struct sockaddr *, socklen_t, char *,
235 size_t, char *, size_t, int);
236 void freeaddrinfo(struct addrinfo *);
237 const char *gai_strerror(int);
238 void setservent(int);
240 #if __BSD_VISIBLE
241 void endnetgrent(void);
242 void freehostent(struct hostent *);
243 int gethostbyaddr_r(const void *, socklen_t, int, struct hostent *,
244 char *, size_t, struct hostent **, int *);
245 int gethostbyname_r(const char *, struct hostent *, char *, size_t,
246 struct hostent **, int *);
247 struct hostent *gethostbyname2(const char *, int);
248 int gethostbyname2_r(const char *, int, struct hostent *, char *,
249 size_t, struct hostent **, int *);
250 int gethostent_r(struct hostent *, char *, size_t,
251 struct hostent **, int *);
252 struct hostent *getipnodebyaddr(const void *, size_t, int, int *);
253 struct hostent *getipnodebyname(const char *, int, int, int *);
254 int getnetbyaddr_r(uint32_t, int, struct netent *, char *, size_t,
255 struct netent**, int *);
256 int getnetbyname_r(const char *, struct netent *, char *, size_t,
257 struct netent **, int *);
258 int getnetent_r(struct netent *, char *, size_t, struct netent **,
259 int *);
260 int getnetgrent(char **, char **, char **);
261 int getprotobyname_r(const char *, struct protoent *, char *,
262 size_t, struct protoent **);
263 int getprotobynumber_r(int, struct protoent *, char *, size_t,
264 struct protoent **);
265 int getprotoent_r(struct protoent *, char *, size_t,
266 struct protoent **);
267 int getservbyname_r(const char *, const char *, struct servent *,
268 char *, size_t, struct servent **);
269 int getservbyport_r(int, const char *, struct servent *, char *,
270 size_t, struct servent **);
271 int getservent_r(struct servent *, char *, size_t,
272 struct servent **);
273 void herror(const char *);
274 __const char *hstrerror(int);
275 int innetgr(const char *, const char *, const char *, const char *);
276 void setnetgrent(const char *);
277 #endif
281 * PRIVATE functions specific to the FreeBSD implementation
284 /* DO NOT USE THESE, THEY ARE SUBJECT TO CHANGE AND ARE NOT PORTABLE!!! */
285 int * __h_errno(void);
286 __END_DECLS
288 #endif /* !_NETDB_H_ */