2 /* Copyright 1998, 2009 by the Massachusetts Institute of Technology.
3 * Copyright (C) 2007-2010 by Daniel Stenberg
5 * Permission to use, copy, modify, and distribute this
6 * software and its documentation for any purpose and without
7 * fee is hereby granted, provided that the above copyright
8 * notice appear in all copies and that both that copyright
9 * notice and this permission notice appear in supporting
10 * documentation, and that the name of M.I.T. not be used in
11 * advertising or publicity pertaining to distribution of the
12 * software without specific, written prior permission.
13 * M.I.T. makes no representations about the suitability of
14 * this software for any purpose. It is provided "as is"
15 * without express or implied warranty.
21 #include "ares_version.h" /* c-ares version defines */
22 #include "ares_build.h" /* c-ares build definitions */
23 #include "ares_rules.h" /* c-ares rules enforcement */
26 * Define WIN32 when build target is Win32 API
29 #if (defined(_WIN32) || defined(__WIN32__)) && \
30 !defined(WIN32) && !defined(__SYMBIAN32__)
34 #include <sys/types.h>
36 /* HP-UX systems version 9, 10 and 11 lack sys/select.h and so does oldish
37 libc5-based Linux systems. Only include it on system that are known to
39 #if defined(_AIX) || defined(__NOVELL_LIBC__) || defined(__NetBSD__) || \
40 defined(__minix) || defined(__SYMBIAN32__) || defined(__INTEGRITY)
41 #include <sys/select.h>
43 #if (defined(NETWARE) && !defined(__NOVELL_LIBC__))
44 #include <sys/bsdskt.h>
48 # include <netinet/in.h>
49 # include <sys/socket.h>
52 # ifndef WIN32_LEAN_AND_MEAN
53 # define WIN32_LEAN_AND_MEAN
56 # include <winsock2.h>
57 # include <ws2tcpip.h>
59 # include <sys/socket.h>
60 # include <netinet/in.h>
68 ** c-ares external API function linkage decorations.
71 #if !defined(CARES_STATICLIB) && \
72 (defined(WIN32) || defined(_WIN32) || defined(__SYMBIAN32__))
73 /* __declspec function decoration for Win32 and Symbian DLL's */
74 # if defined(CARES_BUILDING_LIBRARY)
75 # define CARES_EXTERN __declspec(dllexport)
77 # define CARES_EXTERN __declspec(dllimport)
80 /* visibility function decoration for other cases */
81 # if !defined(CARES_SYMBOL_HIDING) || \
82 defined(WIN32) || defined(_WIN32) || defined(__SYMBIAN32__)
85 # define CARES_EXTERN CARES_SYMBOL_SCOPE_EXTERN
90 #define ARES_SUCCESS 0
92 /* Server error codes (ARES_ENODATA indicates no relevant answer) */
93 #define ARES_ENODATA 1
94 #define ARES_EFORMERR 2
95 #define ARES_ESERVFAIL 3
96 #define ARES_ENOTFOUND 4
97 #define ARES_ENOTIMP 5
98 #define ARES_EREFUSED 6
100 /* Locally generated error codes */
101 #define ARES_EBADQUERY 7
102 #define ARES_EBADNAME 8
103 #define ARES_EBADFAMILY 9
104 #define ARES_EBADRESP 10
105 #define ARES_ECONNREFUSED 11
106 #define ARES_ETIMEOUT 12
108 #define ARES_EFILE 14
109 #define ARES_ENOMEM 15
110 #define ARES_EDESTRUCTION 16
111 #define ARES_EBADSTR 17
113 /* ares_getnameinfo error codes */
114 #define ARES_EBADFLAGS 18
116 /* ares_getaddrinfo error codes */
117 #define ARES_ENONAME 19
118 #define ARES_EBADHINTS 20
120 /* Uninitialized library error code */
121 #define ARES_ENOTINITIALIZED 21 /* introduced in 1.7.0 */
123 /* ares_library_init error codes */
124 #define ARES_ELOADIPHLPAPI 22 /* introduced in 1.7.0 */
125 #define ARES_EADDRGETNETWORKPARAMS 23 /* introduced in 1.7.0 */
127 /* More error codes */
128 #define ARES_ECANCELLED 24 /* introduced in 1.7.0 */
131 #define ARES_FLAG_USEVC (1 << 0)
132 #define ARES_FLAG_PRIMARY (1 << 1)
133 #define ARES_FLAG_IGNTC (1 << 2)
134 #define ARES_FLAG_NORECURSE (1 << 3)
135 #define ARES_FLAG_STAYOPEN (1 << 4)
136 #define ARES_FLAG_NOSEARCH (1 << 5)
137 #define ARES_FLAG_NOALIASES (1 << 6)
138 #define ARES_FLAG_NOCHECKRESP (1 << 7)
140 /* Option mask values */
141 #define ARES_OPT_FLAGS (1 << 0)
142 #define ARES_OPT_TIMEOUT (1 << 1)
143 #define ARES_OPT_TRIES (1 << 2)
144 #define ARES_OPT_NDOTS (1 << 3)
145 #define ARES_OPT_UDP_PORT (1 << 4)
146 #define ARES_OPT_TCP_PORT (1 << 5)
147 #define ARES_OPT_SERVERS (1 << 6)
148 #define ARES_OPT_DOMAINS (1 << 7)
149 #define ARES_OPT_LOOKUPS (1 << 8)
150 #define ARES_OPT_SOCK_STATE_CB (1 << 9)
151 #define ARES_OPT_SORTLIST (1 << 10)
152 #define ARES_OPT_SOCK_SNDBUF (1 << 11)
153 #define ARES_OPT_SOCK_RCVBUF (1 << 12)
154 #define ARES_OPT_TIMEOUTMS (1 << 13)
155 #define ARES_OPT_ROTATE (1 << 14)
157 /* Nameinfo flag values */
158 #define ARES_NI_NOFQDN (1 << 0)
159 #define ARES_NI_NUMERICHOST (1 << 1)
160 #define ARES_NI_NAMEREQD (1 << 2)
161 #define ARES_NI_NUMERICSERV (1 << 3)
162 #define ARES_NI_DGRAM (1 << 4)
163 #define ARES_NI_TCP 0
164 #define ARES_NI_UDP ARES_NI_DGRAM
165 #define ARES_NI_SCTP (1 << 5)
166 #define ARES_NI_DCCP (1 << 6)
167 #define ARES_NI_NUMERICSCOPE (1 << 7)
168 #define ARES_NI_LOOKUPHOST (1 << 8)
169 #define ARES_NI_LOOKUPSERVICE (1 << 9)
170 /* Reserved for future use */
171 #define ARES_NI_IDN (1 << 10)
172 #define ARES_NI_IDN_ALLOW_UNASSIGNED (1 << 11)
173 #define ARES_NI_IDN_USE_STD3_ASCII_RULES (1 << 12)
175 /* Addrinfo flag values */
176 #define ARES_AI_CANONNAME (1 << 0)
177 #define ARES_AI_NUMERICHOST (1 << 1)
178 #define ARES_AI_PASSIVE (1 << 2)
179 #define ARES_AI_NUMERICSERV (1 << 3)
180 #define ARES_AI_V4MAPPED (1 << 4)
181 #define ARES_AI_ALL (1 << 5)
182 #define ARES_AI_ADDRCONFIG (1 << 6)
183 /* Reserved for future use */
184 #define ARES_AI_IDN (1 << 10)
185 #define ARES_AI_IDN_ALLOW_UNASSIGNED (1 << 11)
186 #define ARES_AI_IDN_USE_STD3_ASCII_RULES (1 << 12)
187 #define ARES_AI_CANONIDN (1 << 13)
189 #define ARES_AI_MASK (ARES_AI_CANONNAME|ARES_AI_NUMERICHOST|ARES_AI_PASSIVE| \
190 ARES_AI_NUMERICSERV|ARES_AI_V4MAPPED|ARES_AI_ALL| \
192 #define ARES_GETSOCK_MAXNUM 16 /* ares_getsock() can return info about this
194 #define ARES_GETSOCK_READABLE(bits,num) (bits & (1<< (num)))
195 #define ARES_GETSOCK_WRITABLE(bits,num) (bits & (1 << ((num) + \
196 ARES_GETSOCK_MAXNUM)))
198 /* c-ares library initialization flag values */
199 #define ARES_LIB_INIT_NONE (0)
200 #define ARES_LIB_INIT_WIN32 (1 << 0)
201 #define ARES_LIB_INIT_ALL (ARES_LIB_INIT_WIN32)
205 * Typedef our socket type
208 #ifndef ares_socket_typedef
210 typedef SOCKET ares_socket_t;
211 #define ARES_SOCKET_BAD INVALID_SOCKET
213 typedef int ares_socket_t;
214 #define ARES_SOCKET_BAD -1
216 #define ares_socket_typedef
217 #endif /* ares_socket_typedef */
219 typedef void (*ares_sock_state_cb)(void *data,
220 ares_socket_t socket_fd,
226 /* NOTE about the ares_options struct to users and developers.
228 This struct will remain looking like this. It will not be extended nor
229 shrunk in future releases, but all new options will be set by ares_set_*()
230 options instead of with the ares_init_options() function.
232 Eventually (in a galaxy far far away), all options will be settable by
233 ares_set_*() options and the ares_init_options() function will become
236 When new options are added to c-ares, they are not added to this
237 struct. And they are not "saved" with the ares_save_options() function but
238 instead we encourage the use of the ares_dup() function. Needless to say,
239 if you add config options to c-ares you need to make sure ares_dup()
240 duplicates this new option.
243 struct ares_options {
245 int timeout; /* in seconds or milliseconds, depending on options */
248 unsigned short udp_port;
249 unsigned short tcp_port;
250 int socket_send_buffer_size;
251 int socket_receive_buffer_size;
252 struct in_addr *servers;
257 ares_sock_state_cb sock_state_cb;
258 void *sock_state_cb_data;
259 struct apattern *sortlist;
266 struct ares_channeldata;
268 typedef struct ares_channeldata *ares_channel;
270 typedef void (*ares_callback)(void *arg,
276 typedef void (*ares_host_callback)(void *arg,
279 struct hostent *hostent);
281 typedef void (*ares_nameinfo_callback)(void *arg,
287 typedef int (*ares_sock_create_callback)(ares_socket_t socket_fd,
291 CARES_EXTERN int ares_library_init(int flags);
293 CARES_EXTERN void ares_library_cleanup(void);
295 CARES_EXTERN const char *ares_version(int *version);
297 CARES_EXTERN int ares_init(ares_channel *channelptr);
299 CARES_EXTERN int ares_init_options(ares_channel *channelptr,
300 struct ares_options *options,
303 CARES_EXTERN int ares_save_options(ares_channel channel,
304 struct ares_options *options,
307 CARES_EXTERN void ares_destroy_options(struct ares_options *options);
309 CARES_EXTERN int ares_dup(ares_channel *dest,
312 CARES_EXTERN void ares_destroy(ares_channel channel);
314 CARES_EXTERN void ares_cancel(ares_channel channel);
316 /* These next 3 configure local binding for the out-going socket
317 * connection. Use these to specify source IP and/or network device
318 * on multi-homed systems.
320 CARES_EXTERN void ares_set_local_ip4(ares_channel channel, unsigned int local_ip);
322 /* local_ip6 should be 16 bytes in length */
323 CARES_EXTERN void ares_set_local_ip6(ares_channel channel,
324 const unsigned char* local_ip6);
326 /* local_dev_name should be null terminated. */
327 CARES_EXTERN void ares_set_local_dev(ares_channel channel,
328 const char* local_dev_name);
330 CARES_EXTERN void ares_set_socket_callback(ares_channel channel,
331 ares_sock_create_callback callback,
334 CARES_EXTERN void ares_send(ares_channel channel,
335 const unsigned char *qbuf,
337 ares_callback callback,
340 CARES_EXTERN void ares_query(ares_channel channel,
344 ares_callback callback,
347 CARES_EXTERN void ares_search(ares_channel channel,
351 ares_callback callback,
354 CARES_EXTERN void ares_gethostbyname(ares_channel channel,
357 ares_host_callback callback,
360 CARES_EXTERN int ares_gethostbyname_file(ares_channel channel,
363 struct hostent **host);
365 CARES_EXTERN void ares_gethostbyaddr(ares_channel channel,
369 ares_host_callback callback,
372 CARES_EXTERN void ares_getnameinfo(ares_channel channel,
373 const struct sockaddr *sa,
374 ares_socklen_t salen,
376 ares_nameinfo_callback callback,
379 CARES_EXTERN int ares_fds(ares_channel channel,
383 CARES_EXTERN int ares_getsock(ares_channel channel,
384 ares_socket_t *socks,
387 CARES_EXTERN struct timeval *ares_timeout(ares_channel channel,
388 struct timeval *maxtv,
391 CARES_EXTERN void ares_process(ares_channel channel,
395 CARES_EXTERN void ares_process_fd(ares_channel channel,
396 ares_socket_t read_fd,
397 ares_socket_t write_fd);
399 CARES_EXTERN int ares_mkquery(const char *name,
407 CARES_EXTERN int ares_expand_name(const unsigned char *encoded,
408 const unsigned char *abuf,
413 CARES_EXTERN int ares_expand_string(const unsigned char *encoded,
414 const unsigned char *abuf,
420 * NOTE: before c-ares 1.7.0 we would most often use the system in6_addr
421 * struct below when ares itself was built, but many apps would use this
422 * private version since the header checked a HAVE_* define for it. Starting
423 * with 1.7.0 we always declare and use our own to stop relying on the
426 struct ares_in6_addr {
428 unsigned char _S6_u8[16];
432 struct ares_addrttl {
433 struct in_addr ipaddr;
437 struct ares_addr6ttl {
438 struct ares_in6_addr ip6addr;
442 struct ares_srv_reply {
443 struct ares_srv_reply *next;
445 unsigned short priority;
446 unsigned short weight;
450 struct ares_mx_reply {
451 struct ares_mx_reply *next;
453 unsigned short priority;
456 struct ares_txt_reply {
457 struct ares_txt_reply *next;
459 size_t length; /* length excludes null termination */
463 ** Parse the buffer, starting at *abuf and of length alen bytes, previously
464 ** obtained from an ares_search call. Put the results in *host, if nonnull.
465 ** Also, if addrttls is nonnull, put up to *naddrttls IPv4 addresses along with
466 ** their TTLs in that array, and set *naddrttls to the number of addresses
470 CARES_EXTERN int ares_parse_a_reply(const unsigned char *abuf,
472 struct hostent **host,
473 struct ares_addrttl *addrttls,
476 CARES_EXTERN int ares_parse_aaaa_reply(const unsigned char *abuf,
478 struct hostent **host,
479 struct ares_addr6ttl *addrttls,
482 CARES_EXTERN int ares_parse_ptr_reply(const unsigned char *abuf,
487 struct hostent **host);
489 CARES_EXTERN int ares_parse_ns_reply(const unsigned char *abuf,
491 struct hostent **host);
493 CARES_EXTERN int ares_parse_srv_reply(const unsigned char* abuf,
495 struct ares_srv_reply** srv_out);
497 CARES_EXTERN int ares_parse_mx_reply(const unsigned char* abuf,
499 struct ares_mx_reply** mx_out);
501 CARES_EXTERN int ares_parse_txt_reply(const unsigned char* abuf,
503 struct ares_txt_reply** txt_out);
505 CARES_EXTERN void ares_free_string(void *str);
507 CARES_EXTERN void ares_free_hostent(struct hostent *host);
509 CARES_EXTERN void ares_free_data(void *dataptr);
511 CARES_EXTERN const char *ares_strerror(int code);
513 /* TODO: Hold port here as well. */
514 struct ares_addr_node {
515 struct ares_addr_node *next;
518 struct in_addr addr4;
519 struct ares_in6_addr addr6;
523 CARES_EXTERN int ares_set_servers(ares_channel channel,
524 struct ares_addr_node *servers);
526 /* Incomming string format: host[:port][,host[:port]]... */
527 CARES_EXTERN int ares_set_servers_csv(ares_channel channel,
528 const char* servers);
530 CARES_EXTERN int ares_get_servers(ares_channel channel,
531 struct ares_addr_node **servers);