2 /* Copyright 1998 by the Massachusetts Institute of Technology.
3 * Copyright (C) 2007-2013 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 defined(ANDROID) || defined(__ANDROID__) || defined(__OpenBSD__) || \
43 #include <sys/select.h>
45 #if (defined(NETWARE) && !defined(__NOVELL_LIBC__))
46 #include <sys/bsdskt.h>
50 # include <netinet/in.h>
51 # include <sys/socket.h>
53 #elif defined(_WIN32_WCE)
54 # ifndef WIN32_LEAN_AND_MEAN
55 # define WIN32_LEAN_AND_MEAN
60 # ifndef WIN32_LEAN_AND_MEAN
61 # define WIN32_LEAN_AND_MEAN
64 # include <winsock2.h>
65 # include <ws2tcpip.h>
67 # include <sys/socket.h>
68 # include <netinet/in.h>
71 #if defined(ANDROID) || defined(__ANDROID__)
80 ** c-ares external API function linkage decorations.
83 #ifdef CARES_STATICLIB
85 #elif defined(WIN32) || defined(_WIN32) || defined(__SYMBIAN32__)
86 # if defined(CARES_BUILDING_LIBRARY)
87 # define CARES_EXTERN __declspec(dllexport)
89 # define CARES_EXTERN __declspec(dllimport)
91 #elif defined(CARES_BUILDING_LIBRARY) && defined(CARES_SYMBOL_HIDING)
92 # define CARES_EXTERN CARES_SYMBOL_SCOPE_EXTERN
98 #define ARES_SUCCESS 0
100 /* Server error codes (ARES_ENODATA indicates no relevant answer) */
101 #define ARES_ENODATA 1
102 #define ARES_EFORMERR 2
103 #define ARES_ESERVFAIL 3
104 #define ARES_ENOTFOUND 4
105 #define ARES_ENOTIMP 5
106 #define ARES_EREFUSED 6
108 /* Locally generated error codes */
109 #define ARES_EBADQUERY 7
110 #define ARES_EBADNAME 8
111 #define ARES_EBADFAMILY 9
112 #define ARES_EBADRESP 10
113 #define ARES_ECONNREFUSED 11
114 #define ARES_ETIMEOUT 12
116 #define ARES_EFILE 14
117 #define ARES_ENOMEM 15
118 #define ARES_EDESTRUCTION 16
119 #define ARES_EBADSTR 17
121 /* ares_getnameinfo error codes */
122 #define ARES_EBADFLAGS 18
124 /* ares_getaddrinfo error codes */
125 #define ARES_ENONAME 19
126 #define ARES_EBADHINTS 20
128 /* Uninitialized library error code */
129 #define ARES_ENOTINITIALIZED 21 /* introduced in 1.7.0 */
131 /* ares_library_init error codes */
132 #define ARES_ELOADIPHLPAPI 22 /* introduced in 1.7.0 */
133 #define ARES_EADDRGETNETWORKPARAMS 23 /* introduced in 1.7.0 */
135 /* More error codes */
136 #define ARES_ECANCELLED 24 /* introduced in 1.7.0 */
139 #define ARES_FLAG_USEVC (1 << 0)
140 #define ARES_FLAG_PRIMARY (1 << 1)
141 #define ARES_FLAG_IGNTC (1 << 2)
142 #define ARES_FLAG_NORECURSE (1 << 3)
143 #define ARES_FLAG_STAYOPEN (1 << 4)
144 #define ARES_FLAG_NOSEARCH (1 << 5)
145 #define ARES_FLAG_NOALIASES (1 << 6)
146 #define ARES_FLAG_NOCHECKRESP (1 << 7)
147 #define ARES_FLAG_EDNS (1 << 8)
149 /* Option mask values */
150 #define ARES_OPT_FLAGS (1 << 0)
151 #define ARES_OPT_TIMEOUT (1 << 1)
152 #define ARES_OPT_TRIES (1 << 2)
153 #define ARES_OPT_NDOTS (1 << 3)
154 #define ARES_OPT_UDP_PORT (1 << 4)
155 #define ARES_OPT_TCP_PORT (1 << 5)
156 #define ARES_OPT_SERVERS (1 << 6)
157 #define ARES_OPT_DOMAINS (1 << 7)
158 #define ARES_OPT_LOOKUPS (1 << 8)
159 #define ARES_OPT_SOCK_STATE_CB (1 << 9)
160 #define ARES_OPT_SORTLIST (1 << 10)
161 #define ARES_OPT_SOCK_SNDBUF (1 << 11)
162 #define ARES_OPT_SOCK_RCVBUF (1 << 12)
163 #define ARES_OPT_TIMEOUTMS (1 << 13)
164 #define ARES_OPT_ROTATE (1 << 14)
165 #define ARES_OPT_EDNSPSZ (1 << 15)
166 #define ARES_OPT_NOROTATE (1 << 16)
167 #define ARES_OPT_RESOLVCONF (1 << 17)
169 /* Nameinfo flag values */
170 #define ARES_NI_NOFQDN (1 << 0)
171 #define ARES_NI_NUMERICHOST (1 << 1)
172 #define ARES_NI_NAMEREQD (1 << 2)
173 #define ARES_NI_NUMERICSERV (1 << 3)
174 #define ARES_NI_DGRAM (1 << 4)
175 #define ARES_NI_TCP 0
176 #define ARES_NI_UDP ARES_NI_DGRAM
177 #define ARES_NI_SCTP (1 << 5)
178 #define ARES_NI_DCCP (1 << 6)
179 #define ARES_NI_NUMERICSCOPE (1 << 7)
180 #define ARES_NI_LOOKUPHOST (1 << 8)
181 #define ARES_NI_LOOKUPSERVICE (1 << 9)
182 /* Reserved for future use */
183 #define ARES_NI_IDN (1 << 10)
184 #define ARES_NI_IDN_ALLOW_UNASSIGNED (1 << 11)
185 #define ARES_NI_IDN_USE_STD3_ASCII_RULES (1 << 12)
187 /* Addrinfo flag values */
188 #define ARES_AI_CANONNAME (1 << 0)
189 #define ARES_AI_NUMERICHOST (1 << 1)
190 #define ARES_AI_PASSIVE (1 << 2)
191 #define ARES_AI_NUMERICSERV (1 << 3)
192 #define ARES_AI_V4MAPPED (1 << 4)
193 #define ARES_AI_ALL (1 << 5)
194 #define ARES_AI_ADDRCONFIG (1 << 6)
195 /* Reserved for future use */
196 #define ARES_AI_IDN (1 << 10)
197 #define ARES_AI_IDN_ALLOW_UNASSIGNED (1 << 11)
198 #define ARES_AI_IDN_USE_STD3_ASCII_RULES (1 << 12)
199 #define ARES_AI_CANONIDN (1 << 13)
201 #define ARES_AI_MASK (ARES_AI_CANONNAME|ARES_AI_NUMERICHOST|ARES_AI_PASSIVE| \
202 ARES_AI_NUMERICSERV|ARES_AI_V4MAPPED|ARES_AI_ALL| \
204 #define ARES_GETSOCK_MAXNUM 16 /* ares_getsock() can return info about this
206 #define ARES_GETSOCK_READABLE(bits,num) (bits & (1<< (num)))
207 #define ARES_GETSOCK_WRITABLE(bits,num) (bits & (1 << ((num) + \
208 ARES_GETSOCK_MAXNUM)))
210 /* c-ares library initialization flag values */
211 #define ARES_LIB_INIT_NONE (0)
212 #define ARES_LIB_INIT_WIN32 (1 << 0)
213 #define ARES_LIB_INIT_ALL (ARES_LIB_INIT_WIN32)
217 * Typedef our socket type
220 #ifndef ares_socket_typedef
222 typedef SOCKET ares_socket_t;
223 #define ARES_SOCKET_BAD INVALID_SOCKET
225 typedef int ares_socket_t;
226 #define ARES_SOCKET_BAD -1
228 #define ares_socket_typedef
229 #endif /* ares_socket_typedef */
231 typedef void (*ares_sock_state_cb)(void *data,
232 ares_socket_t socket_fd,
238 /* NOTE about the ares_options struct to users and developers.
240 This struct will remain looking like this. It will not be extended nor
241 shrunk in future releases, but all new options will be set by ares_set_*()
242 options instead of with the ares_init_options() function.
244 Eventually (in a galaxy far far away), all options will be settable by
245 ares_set_*() options and the ares_init_options() function will become
248 When new options are added to c-ares, they are not added to this
249 struct. And they are not "saved" with the ares_save_options() function but
250 instead we encourage the use of the ares_dup() function. Needless to say,
251 if you add config options to c-ares you need to make sure ares_dup()
252 duplicates this new option.
255 struct ares_options {
257 int timeout; /* in seconds or milliseconds, depending on options */
260 unsigned short udp_port;
261 unsigned short tcp_port;
262 int socket_send_buffer_size;
263 int socket_receive_buffer_size;
264 struct in_addr *servers;
269 ares_sock_state_cb sock_state_cb;
270 void *sock_state_cb_data;
271 struct apattern *sortlist;
274 char *resolvconf_path;
280 struct ares_channeldata;
282 typedef struct ares_channeldata *ares_channel;
284 typedef void (*ares_callback)(void *arg,
290 typedef void (*ares_host_callback)(void *arg,
293 struct hostent *hostent);
295 typedef void (*ares_nameinfo_callback)(void *arg,
301 typedef int (*ares_sock_create_callback)(ares_socket_t socket_fd,
305 typedef int (*ares_sock_config_callback)(ares_socket_t socket_fd,
309 CARES_EXTERN int ares_library_init(int flags);
311 CARES_EXTERN int ares_library_init_mem(int flags,
312 void *(*amalloc)(size_t size),
313 void (*afree)(void *ptr),
314 void *(*arealloc)(void *ptr, size_t size));
316 #if defined(ANDROID) || defined(__ANDROID__)
317 CARES_EXTERN void ares_library_init_jvm(JavaVM *jvm);
318 CARES_EXTERN int ares_library_init_android(jobject connectivity_manager);
319 CARES_EXTERN int ares_library_android_initialized(void);
322 CARES_EXTERN int ares_library_initialized(void);
324 CARES_EXTERN void ares_library_cleanup(void);
326 CARES_EXTERN const char *ares_version(int *version);
328 CARES_EXTERN int ares_init(ares_channel *channelptr);
330 CARES_EXTERN int ares_init_options(ares_channel *channelptr,
331 struct ares_options *options,
334 CARES_EXTERN int ares_save_options(ares_channel channel,
335 struct ares_options *options,
338 CARES_EXTERN void ares_destroy_options(struct ares_options *options);
340 CARES_EXTERN int ares_dup(ares_channel *dest,
343 CARES_EXTERN void ares_destroy(ares_channel channel);
345 CARES_EXTERN void ares_cancel(ares_channel channel);
347 /* These next 3 configure local binding for the out-going socket
348 * connection. Use these to specify source IP and/or network device
349 * on multi-homed systems.
351 CARES_EXTERN void ares_set_local_ip4(ares_channel channel, unsigned int local_ip);
353 /* local_ip6 should be 16 bytes in length */
354 CARES_EXTERN void ares_set_local_ip6(ares_channel channel,
355 const unsigned char* local_ip6);
357 /* local_dev_name should be null terminated. */
358 CARES_EXTERN void ares_set_local_dev(ares_channel channel,
359 const char* local_dev_name);
361 CARES_EXTERN void ares_set_socket_callback(ares_channel channel,
362 ares_sock_create_callback callback,
365 CARES_EXTERN void ares_set_socket_configure_callback(ares_channel channel,
366 ares_sock_config_callback callback,
369 CARES_EXTERN int ares_set_sortlist(ares_channel channel,
370 const char *sortstr);
373 * Virtual function set to have user-managed socket IO.
374 * Note that all functions need to be defined, and when
375 * set, the library will not do any bind nor set any
376 * socket options, assuming the client handles these
377 * through either socket creation or the
378 * ares_sock_config_callback call.
381 struct ares_socket_functions {
382 ares_socket_t(*asocket)(int, int, int, void *);
383 int(*aclose)(ares_socket_t, void *);
384 int(*aconnect)(ares_socket_t, const struct sockaddr *, ares_socklen_t, void *);
385 ares_ssize_t(*arecvfrom)(ares_socket_t, void *, size_t, int, struct sockaddr *, ares_socklen_t *, void *);
386 ares_ssize_t(*asendv)(ares_socket_t, const struct iovec *, int, void *);
389 CARES_EXTERN void ares_set_socket_functions(ares_channel channel,
390 const struct ares_socket_functions * funcs,
393 CARES_EXTERN void ares_send(ares_channel channel,
394 const unsigned char *qbuf,
396 ares_callback callback,
399 CARES_EXTERN void ares_query(ares_channel channel,
403 ares_callback callback,
406 CARES_EXTERN void ares_search(ares_channel channel,
410 ares_callback callback,
413 CARES_EXTERN void ares_gethostbyname(ares_channel channel,
416 ares_host_callback callback,
419 CARES_EXTERN int ares_gethostbyname_file(ares_channel channel,
422 struct hostent **host);
424 CARES_EXTERN void ares_gethostbyaddr(ares_channel channel,
428 ares_host_callback callback,
431 CARES_EXTERN void ares_getnameinfo(ares_channel channel,
432 const struct sockaddr *sa,
433 ares_socklen_t salen,
435 ares_nameinfo_callback callback,
438 CARES_EXTERN int ares_fds(ares_channel channel,
442 CARES_EXTERN int ares_getsock(ares_channel channel,
443 ares_socket_t *socks,
446 CARES_EXTERN struct timeval *ares_timeout(ares_channel channel,
447 struct timeval *maxtv,
450 CARES_EXTERN void ares_process(ares_channel channel,
454 CARES_EXTERN void ares_process_fd(ares_channel channel,
455 ares_socket_t read_fd,
456 ares_socket_t write_fd);
458 CARES_EXTERN int ares_create_query(const char *name,
467 CARES_EXTERN int ares_mkquery(const char *name,
475 CARES_EXTERN int ares_expand_name(const unsigned char *encoded,
476 const unsigned char *abuf,
481 CARES_EXTERN int ares_expand_string(const unsigned char *encoded,
482 const unsigned char *abuf,
488 * NOTE: before c-ares 1.7.0 we would most often use the system in6_addr
489 * struct below when ares itself was built, but many apps would use this
490 * private version since the header checked a HAVE_* define for it. Starting
491 * with 1.7.0 we always declare and use our own to stop relying on the
494 struct ares_in6_addr {
496 unsigned char _S6_u8[16];
500 struct ares_addrttl {
501 struct in_addr ipaddr;
505 struct ares_addr6ttl {
506 struct ares_in6_addr ip6addr;
510 struct ares_srv_reply {
511 struct ares_srv_reply *next;
513 unsigned short priority;
514 unsigned short weight;
518 struct ares_mx_reply {
519 struct ares_mx_reply *next;
521 unsigned short priority;
524 struct ares_txt_reply {
525 struct ares_txt_reply *next;
527 size_t length; /* length excludes null termination */
530 /* NOTE: This structure is a superset of ares_txt_reply
532 struct ares_txt_ext {
533 struct ares_txt_ext *next;
536 /* 1 - if start of new record
537 * 0 - if a chunk in the same record */
538 unsigned char record_start;
541 struct ares_naptr_reply {
542 struct ares_naptr_reply *next;
543 unsigned char *flags;
544 unsigned char *service;
545 unsigned char *regexp;
547 unsigned short order;
548 unsigned short preference;
551 struct ares_soa_reply {
555 unsigned int refresh;
562 ** Parse the buffer, starting at *abuf and of length alen bytes, previously
563 ** obtained from an ares_search call. Put the results in *host, if nonnull.
564 ** Also, if addrttls is nonnull, put up to *naddrttls IPv4 addresses along with
565 ** their TTLs in that array, and set *naddrttls to the number of addresses
569 CARES_EXTERN int ares_parse_a_reply(const unsigned char *abuf,
571 struct hostent **host,
572 struct ares_addrttl *addrttls,
575 CARES_EXTERN int ares_parse_aaaa_reply(const unsigned char *abuf,
577 struct hostent **host,
578 struct ares_addr6ttl *addrttls,
581 CARES_EXTERN int ares_parse_ptr_reply(const unsigned char *abuf,
586 struct hostent **host);
588 CARES_EXTERN int ares_parse_ns_reply(const unsigned char *abuf,
590 struct hostent **host);
592 CARES_EXTERN int ares_parse_srv_reply(const unsigned char* abuf,
594 struct ares_srv_reply** srv_out);
596 CARES_EXTERN int ares_parse_mx_reply(const unsigned char* abuf,
598 struct ares_mx_reply** mx_out);
600 CARES_EXTERN int ares_parse_txt_reply(const unsigned char* abuf,
602 struct ares_txt_reply** txt_out);
604 CARES_EXTERN int ares_parse_txt_reply_ext(const unsigned char* abuf,
606 struct ares_txt_ext** txt_out);
608 CARES_EXTERN int ares_parse_naptr_reply(const unsigned char* abuf,
610 struct ares_naptr_reply** naptr_out);
612 CARES_EXTERN int ares_parse_soa_reply(const unsigned char* abuf,
614 struct ares_soa_reply** soa_out);
616 CARES_EXTERN void ares_free_string(void *str);
618 CARES_EXTERN void ares_free_hostent(struct hostent *host);
620 CARES_EXTERN void ares_free_data(void *dataptr);
622 CARES_EXTERN const char *ares_strerror(int code);
624 struct ares_addr_node {
625 struct ares_addr_node *next;
628 struct in_addr addr4;
629 struct ares_in6_addr addr6;
633 struct ares_addr_port_node {
634 struct ares_addr_port_node *next;
637 struct in_addr addr4;
638 struct ares_in6_addr addr6;
644 CARES_EXTERN int ares_set_servers(ares_channel channel,
645 struct ares_addr_node *servers);
646 CARES_EXTERN int ares_set_servers_ports(ares_channel channel,
647 struct ares_addr_port_node *servers);
649 /* Incomming string format: host[:port][,host[:port]]... */
650 CARES_EXTERN int ares_set_servers_csv(ares_channel channel,
651 const char* servers);
652 CARES_EXTERN int ares_set_servers_ports_csv(ares_channel channel,
653 const char* servers);
655 CARES_EXTERN int ares_get_servers(ares_channel channel,
656 struct ares_addr_node **servers);
657 CARES_EXTERN int ares_get_servers_ports(ares_channel channel,
658 struct ares_addr_port_node **servers);
660 CARES_EXTERN const char *ares_inet_ntop(int af, const void *src, char *dst,
661 ares_socklen_t size);
663 CARES_EXTERN int ares_inet_pton(int af, const char *src, void *dst);