xref: /dragonfly/include/netdb.h (revision 763ffc12ee6c6fc2b3b1fcb4faacd9d9ec991e64)
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. 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.
16  *
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.
28  *
29  * -
30  * Portions Copyright (c) 1993 by Digital Equipment Corporation.
31  *
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.
38  *
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--
49  */
50 
51 /*
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 $
55  */
56 
57 #ifndef _NETDB_H_
58 #define _NETDB_H_
59 
60 #include <sys/cdefs.h>
61 #include <machine/stdint.h>   /* for __size_t, __socklen_t, __uint*_t */
62 
63 #ifndef _IN_ADDR_T_DECLARED
64 typedef   __uint32_t          in_addr_t;          /* base type for internet address */
65 #define   _IN_ADDR_T_DECLARED
66 #endif
67 
68 #ifndef _IN_PORT_T_DECLARED
69 typedef   __uint16_t          in_port_t;
70 #define   _IN_PORT_T_DECLARED
71 #endif
72 
73 #ifndef _SIZE_T_DECLARED
74 typedef   __size_t  size_t;
75 #define   _SIZE_T_DECLARED
76 #endif
77 
78 #ifndef _SOCKLEN_T_DECLARED
79 typedef   __socklen_t         socklen_t;
80 #define   _SOCKLEN_T_DECLARED
81 #endif
82 
83 #ifndef _UINT32_T_DECLARED
84 typedef   __uint32_t          uint32_t;
85 #define   _UINT32_T_DECLARED
86 #endif
87 
88 #ifndef _PATH_HEQUIV
89 # define  _PATH_HEQUIV        "/etc/hosts.equiv"
90 #endif
91 #define   _PATH_HOSTS         "/etc/hosts"
92 #define   _PATH_NETWORKS      "/etc/networks"
93 #define   _PATH_PROTOCOLS     "/etc/protocols"
94 #define   _PATH_SERVICES      "/etc/services"
95 
96 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE < 200809)
97 #define   h_errno (*__h_errno())
98 #endif
99 
100 /*
101  * Structures returned by network data base library.  All addresses are
102  * supplied in host order, and returned in network order (suitable for
103  * use in system calls).
104  */
105 struct hostent {
106           char      *h_name;  /* official name of host */
107           char      **h_aliases;        /* alias list */
108           int       h_addrtype;         /* host address type */
109           int       h_length; /* length of address */
110           char      **h_addr_list;      /* list of addresses from name server */
111 #if __BSD_VISIBLE
112 #define   h_addr    h_addr_list[0]      /* address, for backward compatibility */
113 #endif
114 };
115 
116 struct netent {
117           char                *n_name;  /* official name of net */
118           char                **n_aliases;        /* alias list */
119           int                 n_addrtype;         /* net address type */
120           uint32_t  n_net;              /* network # */
121 };
122 
123 struct servent {
124           char      *s_name;  /* official service name */
125           char      **s_aliases;        /* alias list */
126           int       s_port;             /* port # */
127           char      *s_proto; /* protocol to use */
128 };
129 
130 struct protoent {
131           char      *p_name;  /* official protocol name */
132           char      **p_aliases;        /* alias list */
133           int       p_proto;  /* protocol # */
134 };
135 
136 struct addrinfo {
137           int       ai_flags; /* AI_PASSIVE, AI_CANONNAME, AI_NUMERICHOST */
138           int       ai_family;          /* PF_xxx */
139           int       ai_socktype;        /* SOCK_xxx */
140           int       ai_protocol;        /* 0 or IPPROTO_xxx for IPv4 and IPv6 */
141           socklen_t ai_addrlen;         /* length of ai_addr */
142           char      *ai_canonname;      /* canonical name for hostname */
143           struct    sockaddr *ai_addr;  /* binary address */
144           struct    addrinfo *ai_next;  /* next structure in linked list */
145 };
146 
147 /*
148  * Error return codes from gethostbyname() and gethostbyaddr()
149  * (left in h_errno).
150  */
151 
152 #if __BSD_VISIBLE
153 #define   NETDB_INTERNAL      -1        /* see errno */
154 #define   NETDB_SUCCESS       0         /* no problem */
155 #endif
156 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE < 200809)
157 #define   HOST_NOT_FOUND      1 /* Authoritative Answer Host not found */
158 #define   TRY_AGAIN 2 /* Non-Authoritative Host not found, or SERVERFAIL */
159 #define   NO_RECOVERY         3 /* Non recoverable errors, FORMERR, REFUSED, NOTIMP */
160 #define   NO_DATA             4 /* Valid name, no data record of requested type */
161 #endif
162 #if __BSD_VISIBLE
163 #define   NO_ADDRESS          NO_DATA             /* no address, look for MX record */
164 #endif
165 
166 /*
167  * Error return codes from getaddrinfo()
168  */
169 #if __BSD_VISIBLE
170 /* XXX deprecated */
171 #define   EAI_ADDRFAMILY       1        /* address family for hostname not supported */
172 #endif
173 #define   EAI_AGAIN  2        /* temporary failure in name resolution */
174 #define   EAI_BADFLAGS         3        /* invalid value for ai_flags */
175 #define   EAI_FAIL   4        /* non-recoverable failure in name resolution */
176 #define   EAI_FAMILY           5        /* ai_family not supported */
177 #define   EAI_MEMORY           6        /* memory allocation failure */
178 #if __BSD_VISIBLE
179 /* XXX deprecated */
180 #define   EAI_NODATA           7        /* no address associated with hostname */
181 #endif
182 #define   EAI_NONAME           8        /* hostname nor servname provided, or not known */
183 #define   EAI_SERVICE          9        /* servname not supported for ai_socktype */
184 #define   EAI_SOCKTYPE        10        /* ai_socktype not supported */
185 #define   EAI_SYSTEM          11        /* system error returned in errno */
186 #if __BSD_VISIBLE
187 #define   EAI_BADHINTS        12        /* invalid value for hints */
188 #define   EAI_PROTOCOL        13        /* resolved protocol is unknown */
189 #endif
190 #define   EAI_OVERFLOW        14        /* argument buffer overflow */
191 #if __BSD_VISIBLE
192 #define   EAI_MAX             15
193 #endif
194 
195 /*
196  * Flag values for getaddrinfo()
197  */
198 #define   AI_PASSIVE          0x00000001 /* get address to use bind() */
199 #define   AI_CANONNAME        0x00000002 /* fill ai_canonname */
200 #define   AI_NUMERICHOST      0x00000004 /* prevent host name resolution */
201 #define   AI_NUMERICSERV      0x00000008 /* prevent service name resolution */
202 #if __BSD_VISIBLE
203 /* valid flags for addrinfo (not a standard def, apps should not use it) */
204 #define AI_MASK \
205     (AI_PASSIVE | AI_CANONNAME | AI_NUMERICHOST | AI_NUMERICSERV | \
206     AI_ADDRCONFIG)
207 #endif
208 
209 #define   AI_ALL              0x00000100 /* IPv6 and IPv4-mapped (with AI_V4MAPPED) */
210 #if __BSD_VISIBLE
211 #define   AI_V4MAPPED_CFG     0x00000200 /* accept IPv4-mapped if kernel supports */
212 #endif
213 #define   AI_ADDRCONFIG       0x00000400 /* only if any address is assigned */
214 #define   AI_V4MAPPED         0x00000800 /* accept IPv4-mapped IPv6 address */
215 #if __BSD_VISIBLE
216 /* special recommended flags for getipnodebyname */
217 #define   AI_DEFAULT          (AI_V4MAPPED_CFG | AI_ADDRCONFIG)
218 
219 /*
220  * Constants for getnameinfo()
221  */
222 #define   NI_MAXHOST          1025
223 #define   NI_MAXSERV          32
224 #endif
225 
226 /*
227  * Flag values for getnameinfo()
228  */
229 #define   NI_NOFQDN 0x00000001
230 #define   NI_NUMERICHOST      0x00000002
231 #define   NI_NAMEREQD         0x00000004
232 #define   NI_NUMERICSERV      0x00000008
233 #define   NI_DGRAM  0x00000010
234 #if __BSD_VISIBLE
235 #define   NI_WITHSCOPEID      0x00000020          /* XXX deprecated */
236 #endif
237 #define   NI_NUMERICSCOPE     0x00000040
238 
239 #if __BSD_VISIBLE
240 /*
241  * Scope delimit character
242  */
243 #define   SCOPE_DELIMITER     '%'
244 #endif
245 
246 __BEGIN_DECLS
247 void                endhostent(void);
248 void                endnetent(void);
249 void                endprotoent(void);
250 void                endservent(void);
251 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE < 200809)
252 struct hostent      *gethostbyaddr(const void *, socklen_t, int);
253 struct hostent      *gethostbyname(const char *);
254 #endif
255 struct hostent      *gethostent(void);
256 struct netent       *getnetbyaddr(uint32_t, int);
257 struct netent       *getnetbyname(const char *);
258 struct netent       *getnetent(void);
259 struct protoent     *getprotobyname(const char *);
260 struct protoent     *getprotobynumber(int);
261 struct protoent     *getprotoent(void);
262 struct servent      *getservbyname(const char *, const char *);
263 struct servent      *getservbyport(int, const char *);
264 struct servent      *getservent(void);
265 void                sethostent(int);
266 /* void             sethostfile(const char *); */
267 void                setnetent(int);
268 void                setprotoent(int);
269 int                 getaddrinfo(const char * __restrict, const char * __restrict,
270                         const struct addrinfo * __restrict,
271                         struct addrinfo ** __restrict);
272 /* XXX nodeLen and serviceLen should be socklen_t */
273 int                 getnameinfo(const struct sockaddr * __restrict, socklen_t,
274                         char * __restrict, size_t, char * __restrict, size_t, int);
275 void                freeaddrinfo(struct addrinfo *);
276 const char          *gai_strerror(int);
277 void                setservent(int);
278 
279 #if __BSD_VISIBLE
280 void                endnetgrent(void);
281 void                freehostent(struct hostent *);
282 int                 gethostbyaddr_r(const void *, socklen_t, int, struct hostent *,
283                                         char *, size_t, struct hostent **, int *);
284 int                 gethostbyname_r(const char *, struct hostent *, char *, size_t,
285                                         struct hostent **, int *);
286 struct hostent      *gethostbyname2(const char *, int);
287 int                 gethostbyname2_r(const char *, int, struct hostent *, char *,
288                                          size_t, struct hostent **, int *);
289 int                 gethostent_r(struct hostent *, char *, size_t,
290                                    struct hostent **, int *);
291 struct hostent      *getipnodebyaddr(const void *, size_t, int, int *);
292 struct hostent      *getipnodebyname(const char *, int, int, int *);
293 int                 getnetbyaddr_r(uint32_t, int, struct netent *, char *, size_t,
294                                      struct netent **, int *);
295 int                 getnetbyname_r(const char *, struct netent *, char *, size_t,
296                                      struct netent **, int *);
297 int                 getnetent_r(struct netent *, char *, size_t, struct netent **,
298                                   int *);
299 int                 getnetgrent(char **, char **, char **);
300 int                 getprotobyname_r(const char *, struct protoent *, char *,
301                                          size_t, struct protoent **);
302 int                 getprotobynumber_r(int, struct protoent *, char *, size_t,
303                                            struct protoent **);
304 int                 getprotoent_r(struct protoent *, char *, size_t,
305                                     struct protoent **);
306 int                 getservbyname_r(const char *, const char *, struct servent *,
307                                         char *, size_t, struct servent **);
308 int                 getservbyport_r(int, const char *, struct servent *, char *,
309                                         size_t, struct servent **);
310 int                 getservent_r(struct servent *, char *, size_t,
311                                    struct servent **);
312 void                herror(const char *);
313 const char          *hstrerror(int);
314 int                 innetgr(const char *, const char *, const char *, const char *);
315 void                setnetgrent(const char *);
316 #endif
317 
318 
319 /*
320  * PRIVATE functions specific to the FreeBSD implementation
321  */
322 
323 /* DO NOT USE THESE, THEY ARE SUBJECT TO CHANGE AND ARE NOT PORTABLE!!! */
324 int       * __h_errno(void);
325 __END_DECLS
326 
327 #endif /* !_NETDB_H_ */
328