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