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__)
42 #include <sys/select.h>
44 #if (defined(NETWARE) && !defined(__NOVELL_LIBC__))
45 #include <sys/bsdskt.h>
49 # include <netinet/in.h>
50 # include <sys/socket.h>
52 #elif defined(_WIN32_WCE)
53 # ifndef WIN32_LEAN_AND_MEAN
54 # define WIN32_LEAN_AND_MEAN
59 # ifndef WIN32_LEAN_AND_MEAN
60 # define WIN32_LEAN_AND_MEAN
63 # include <winsock2.h>
64 # include <ws2tcpip.h>
66 # include <sys/socket.h>
67 # include <netinet/in.h>
75 ** c-ares external API function linkage decorations.
78 #ifdef CARES_STATICLIB
80 #elif defined(WIN32) || defined(_WIN32) || defined(__SYMBIAN32__)
81 # if defined(CARES_BUILDING_LIBRARY)
82 # define CARES_EXTERN __declspec(dllexport)
84 # define CARES_EXTERN __declspec(dllimport)
86 #elif defined(CARES_BUILDING_LIBRARY) && defined(CARES_SYMBOL_HIDING)
87 # define CARES_EXTERN CARES_SYMBOL_SCOPE_EXTERN
93 #define ARES_SUCCESS 0
95 /* Server error codes (ARES_ENODATA indicates no relevant answer) */
96 #define ARES_ENODATA 1
97 #define ARES_EFORMERR 2
98 #define ARES_ESERVFAIL 3
99 #define ARES_ENOTFOUND 4
100 #define ARES_ENOTIMP 5
101 #define ARES_EREFUSED 6
103 /* Locally generated error codes */
104 #define ARES_EBADQUERY 7
105 #define ARES_EBADNAME 8
106 #define ARES_EBADFAMILY 9
107 #define ARES_EBADRESP 10
108 #define ARES_ECONNREFUSED 11
109 #define ARES_ETIMEOUT 12
111 #define ARES_EFILE 14
112 #define ARES_ENOMEM 15
113 #define ARES_EDESTRUCTION 16
114 #define ARES_EBADSTR 17
116 /* ares_getnameinfo error codes */
117 #define ARES_EBADFLAGS 18
119 /* ares_getaddrinfo error codes */
120 #define ARES_ENONAME 19
121 #define ARES_EBADHINTS 20
123 /* Uninitialized library error code */
124 #define ARES_ENOTINITIALIZED 21 /* introduced in 1.7.0 */
126 /* ares_library_init error codes */
127 #define ARES_ELOADIPHLPAPI 22 /* introduced in 1.7.0 */
128 #define ARES_EADDRGETNETWORKPARAMS 23 /* introduced in 1.7.0 */
130 /* More error codes */
131 #define ARES_ECANCELLED 24 /* introduced in 1.7.0 */
134 #define ARES_FLAG_USEVC (1 << 0)
135 #define ARES_FLAG_PRIMARY (1 << 1)
136 #define ARES_FLAG_IGNTC (1 << 2)
137 #define ARES_FLAG_NORECURSE (1 << 3)
138 #define ARES_FLAG_STAYOPEN (1 << 4)
139 #define ARES_FLAG_NOSEARCH (1 << 5)
140 #define ARES_FLAG_NOALIASES (1 << 6)
141 #define ARES_FLAG_NOCHECKRESP (1 << 7)
142 #define ARES_FLAG_EDNS (1 << 8)
144 /* Option mask values */
145 #define ARES_OPT_FLAGS (1 << 0)
146 #define ARES_OPT_TIMEOUT (1 << 1)
147 #define ARES_OPT_TRIES (1 << 2)
148 #define ARES_OPT_NDOTS (1 << 3)
149 #define ARES_OPT_UDP_PORT (1 << 4)
150 #define ARES_OPT_TCP_PORT (1 << 5)
151 #define ARES_OPT_SERVERS (1 << 6)
152 #define ARES_OPT_DOMAINS (1 << 7)
153 #define ARES_OPT_LOOKUPS (1 << 8)
154 #define ARES_OPT_SOCK_STATE_CB (1 << 9)
155 #define ARES_OPT_SORTLIST (1 << 10)
156 #define ARES_OPT_SOCK_SNDBUF (1 << 11)
157 #define ARES_OPT_SOCK_RCVBUF (1 << 12)
158 #define ARES_OPT_TIMEOUTMS (1 << 13)
159 #define ARES_OPT_ROTATE (1 << 14)
160 #define ARES_OPT_EDNSPSZ (1 << 15)
161 #define ARES_OPT_NOROTATE (1 << 16)
163 /* Nameinfo flag values */
164 #define ARES_NI_NOFQDN (1 << 0)
165 #define ARES_NI_NUMERICHOST (1 << 1)
166 #define ARES_NI_NAMEREQD (1 << 2)
167 #define ARES_NI_NUMERICSERV (1 << 3)
168 #define ARES_NI_DGRAM (1 << 4)
169 #define ARES_NI_TCP 0
170 #define ARES_NI_UDP ARES_NI_DGRAM
171 #define ARES_NI_SCTP (1 << 5)
172 #define ARES_NI_DCCP (1 << 6)
173 #define ARES_NI_NUMERICSCOPE (1 << 7)
174 #define ARES_NI_LOOKUPHOST (1 << 8)
175 #define ARES_NI_LOOKUPSERVICE (1 << 9)
176 /* Reserved for future use */
177 #define ARES_NI_IDN (1 << 10)
178 #define ARES_NI_IDN_ALLOW_UNASSIGNED (1 << 11)
179 #define ARES_NI_IDN_USE_STD3_ASCII_RULES (1 << 12)
181 /* Addrinfo flag values */
182 #define ARES_AI_CANONNAME (1 << 0)
183 #define ARES_AI_NUMERICHOST (1 << 1)
184 #define ARES_AI_PASSIVE (1 << 2)
185 #define ARES_AI_NUMERICSERV (1 << 3)
186 #define ARES_AI_V4MAPPED (1 << 4)
187 #define ARES_AI_ALL (1 << 5)
188 #define ARES_AI_ADDRCONFIG (1 << 6)
189 /* Reserved for future use */
190 #define ARES_AI_IDN (1 << 10)
191 #define ARES_AI_IDN_ALLOW_UNASSIGNED (1 << 11)
192 #define ARES_AI_IDN_USE_STD3_ASCII_RULES (1 << 12)
193 #define ARES_AI_CANONIDN (1 << 13)
195 #define ARES_AI_MASK (ARES_AI_CANONNAME|ARES_AI_NUMERICHOST|ARES_AI_PASSIVE| \
196 ARES_AI_NUMERICSERV|ARES_AI_V4MAPPED|ARES_AI_ALL| \
198 #define ARES_GETSOCK_MAXNUM 16 /* ares_getsock() can return info about this
200 #define ARES_GETSOCK_READABLE(bits,num) (bits & (1<< (num)))
201 #define ARES_GETSOCK_WRITABLE(bits,num) (bits & (1 << ((num) + \
202 ARES_GETSOCK_MAXNUM)))
204 /* c-ares library initialization flag values */
205 #define ARES_LIB_INIT_NONE (0)
206 #define ARES_LIB_INIT_WIN32 (1 << 0)
207 #define ARES_LIB_INIT_ALL (ARES_LIB_INIT_WIN32)
211 * Typedef our socket type
214 #ifndef ares_socket_typedef
216 typedef SOCKET ares_socket_t;
217 #define ARES_SOCKET_BAD INVALID_SOCKET
219 typedef int ares_socket_t;
220 #define ARES_SOCKET_BAD -1
222 #define ares_socket_typedef
223 #endif /* ares_socket_typedef */
225 typedef void (*ares_sock_state_cb)(void *data,
226 ares_socket_t socket_fd,
232 /* NOTE about the ares_options struct to users and developers.
234 This struct will remain looking like this. It will not be extended nor
235 shrunk in future releases, but all new options will be set by ares_set_*()
236 options instead of with the ares_init_options() function.
238 Eventually (in a galaxy far far away), all options will be settable by
239 ares_set_*() options and the ares_init_options() function will become
242 When new options are added to c-ares, they are not added to this
243 struct. And they are not "saved" with the ares_save_options() function but
244 instead we encourage the use of the ares_dup() function. Needless to say,
245 if you add config options to c-ares you need to make sure ares_dup()
246 duplicates this new option.
249 struct ares_options {
251 int timeout; /* in seconds or milliseconds, depending on options */
254 unsigned short udp_port;
255 unsigned short tcp_port;
256 int socket_send_buffer_size;
257 int socket_receive_buffer_size;
258 struct in_addr *servers;
263 ares_sock_state_cb sock_state_cb;
264 void *sock_state_cb_data;
265 struct apattern *sortlist;
273 struct ares_channeldata;
275 typedef struct ares_channeldata *ares_channel;
277 typedef void (*ares_callback)(void *arg,
283 typedef void (*ares_host_callback)(void *arg,
286 struct hostent *hostent);
288 typedef void (*ares_nameinfo_callback)(void *arg,
294 typedef int (*ares_sock_create_callback)(ares_socket_t socket_fd,
298 typedef int (*ares_sock_config_callback)(ares_socket_t socket_fd,
302 CARES_EXTERN int ares_library_init(int flags);
304 CARES_EXTERN int ares_library_init_mem(int flags,
305 void *(*amalloc)(size_t size),
306 void (*afree)(void *ptr),
307 void *(*arealloc)(void *ptr, size_t size));
309 CARES_EXTERN int ares_library_initialized(void);
311 CARES_EXTERN void ares_library_cleanup(void);
313 CARES_EXTERN const char *ares_version(int *version);
315 CARES_EXTERN int ares_init(ares_channel *channelptr);
317 CARES_EXTERN int ares_init_options(ares_channel *channelptr,
318 struct ares_options *options,
321 CARES_EXTERN int ares_save_options(ares_channel channel,
322 struct ares_options *options,
325 CARES_EXTERN void ares_destroy_options(struct ares_options *options);
327 CARES_EXTERN int ares_dup(ares_channel *dest,
330 CARES_EXTERN void ares_destroy(ares_channel channel);
332 CARES_EXTERN void ares_cancel(ares_channel channel);
334 /* These next 3 configure local binding for the out-going socket
335 * connection. Use these to specify source IP and/or network device
336 * on multi-homed systems.
338 CARES_EXTERN void ares_set_local_ip4(ares_channel channel, unsigned int local_ip);
340 /* local_ip6 should be 16 bytes in length */
341 CARES_EXTERN void ares_set_local_ip6(ares_channel channel,
342 const unsigned char* local_ip6);
344 /* local_dev_name should be null terminated. */
345 CARES_EXTERN void ares_set_local_dev(ares_channel channel,
346 const char* local_dev_name);
348 CARES_EXTERN void ares_set_socket_callback(ares_channel channel,
349 ares_sock_create_callback callback,
352 CARES_EXTERN void ares_set_socket_configure_callback(ares_channel channel,
353 ares_sock_config_callback callback,
356 CARES_EXTERN int ares_set_sortlist(ares_channel channel,
357 const char *sortstr);
359 CARES_EXTERN void ares_send(ares_channel channel,
360 const unsigned char *qbuf,
362 ares_callback callback,
365 CARES_EXTERN void ares_query(ares_channel channel,
369 ares_callback callback,
372 CARES_EXTERN void ares_search(ares_channel channel,
376 ares_callback callback,
379 CARES_EXTERN void ares_gethostbyname(ares_channel channel,
382 ares_host_callback callback,
385 CARES_EXTERN int ares_gethostbyname_file(ares_channel channel,
388 struct hostent **host);
390 CARES_EXTERN void ares_gethostbyaddr(ares_channel channel,
394 ares_host_callback callback,
397 CARES_EXTERN void ares_getnameinfo(ares_channel channel,
398 const struct sockaddr *sa,
399 ares_socklen_t salen,
401 ares_nameinfo_callback callback,
404 CARES_EXTERN int ares_fds(ares_channel channel,
408 CARES_EXTERN int ares_getsock(ares_channel channel,
409 ares_socket_t *socks,
412 CARES_EXTERN struct timeval *ares_timeout(ares_channel channel,
413 struct timeval *maxtv,
416 CARES_EXTERN void ares_process(ares_channel channel,
420 CARES_EXTERN void ares_process_fd(ares_channel channel,
421 ares_socket_t read_fd,
422 ares_socket_t write_fd);
424 CARES_EXTERN int ares_create_query(const char *name,
433 CARES_EXTERN int ares_mkquery(const char *name,
441 CARES_EXTERN int ares_expand_name(const unsigned char *encoded,
442 const unsigned char *abuf,
447 CARES_EXTERN int ares_expand_string(const unsigned char *encoded,
448 const unsigned char *abuf,
454 * NOTE: before c-ares 1.7.0 we would most often use the system in6_addr
455 * struct below when ares itself was built, but many apps would use this
456 * private version since the header checked a HAVE_* define for it. Starting
457 * with 1.7.0 we always declare and use our own to stop relying on the
460 struct ares_in6_addr {
462 unsigned char _S6_u8[16];
466 struct ares_addrttl {
467 struct in_addr ipaddr;
471 struct ares_addr6ttl {
472 struct ares_in6_addr ip6addr;
476 struct ares_srv_reply {
477 struct ares_srv_reply *next;
479 unsigned short priority;
480 unsigned short weight;
484 struct ares_mx_reply {
485 struct ares_mx_reply *next;
487 unsigned short priority;
490 struct ares_txt_reply {
491 struct ares_txt_reply *next;
493 size_t length; /* length excludes null termination */
496 /* NOTE: This structure is a superset of ares_txt_reply
498 struct ares_txt_ext {
499 struct ares_txt_ext *next;
502 /* 1 - if start of new record
503 * 0 - if a chunk in the same record */
504 unsigned char record_start;
507 struct ares_naptr_reply {
508 struct ares_naptr_reply *next;
509 unsigned char *flags;
510 unsigned char *service;
511 unsigned char *regexp;
513 unsigned short order;
514 unsigned short preference;
517 struct ares_soa_reply {
521 unsigned int refresh;
528 ** Parse the buffer, starting at *abuf and of length alen bytes, previously
529 ** obtained from an ares_search call. Put the results in *host, if nonnull.
530 ** Also, if addrttls is nonnull, put up to *naddrttls IPv4 addresses along with
531 ** their TTLs in that array, and set *naddrttls to the number of addresses
535 CARES_EXTERN int ares_parse_a_reply(const unsigned char *abuf,
537 struct hostent **host,
538 struct ares_addrttl *addrttls,
541 CARES_EXTERN int ares_parse_aaaa_reply(const unsigned char *abuf,
543 struct hostent **host,
544 struct ares_addr6ttl *addrttls,
547 CARES_EXTERN int ares_parse_ptr_reply(const unsigned char *abuf,
552 struct hostent **host);
554 CARES_EXTERN int ares_parse_ns_reply(const unsigned char *abuf,
556 struct hostent **host);
558 CARES_EXTERN int ares_parse_srv_reply(const unsigned char* abuf,
560 struct ares_srv_reply** srv_out);
562 CARES_EXTERN int ares_parse_mx_reply(const unsigned char* abuf,
564 struct ares_mx_reply** mx_out);
566 CARES_EXTERN int ares_parse_txt_reply(const unsigned char* abuf,
568 struct ares_txt_reply** txt_out);
570 CARES_EXTERN int ares_parse_txt_reply_ext(const unsigned char* abuf,
572 struct ares_txt_ext** txt_out);
574 CARES_EXTERN int ares_parse_naptr_reply(const unsigned char* abuf,
576 struct ares_naptr_reply** naptr_out);
578 CARES_EXTERN int ares_parse_soa_reply(const unsigned char* abuf,
580 struct ares_soa_reply** soa_out);
582 CARES_EXTERN void ares_free_string(void *str);
584 CARES_EXTERN void ares_free_hostent(struct hostent *host);
586 CARES_EXTERN void ares_free_data(void *dataptr);
588 CARES_EXTERN const char *ares_strerror(int code);
590 struct ares_addr_node {
591 struct ares_addr_node *next;
594 struct in_addr addr4;
595 struct ares_in6_addr addr6;
599 struct ares_addr_port_node {
600 struct ares_addr_port_node *next;
603 struct in_addr addr4;
604 struct ares_in6_addr addr6;
610 CARES_EXTERN int ares_set_servers(ares_channel channel,
611 struct ares_addr_node *servers);
612 CARES_EXTERN int ares_set_servers_ports(ares_channel channel,
613 struct ares_addr_port_node *servers);
615 /* Incomming string format: host[:port][,host[:port]]... */
616 CARES_EXTERN int ares_set_servers_csv(ares_channel channel,
617 const char* servers);
618 CARES_EXTERN int ares_set_servers_ports_csv(ares_channel channel,
619 const char* servers);
621 CARES_EXTERN int ares_get_servers(ares_channel channel,
622 struct ares_addr_node **servers);
623 CARES_EXTERN int ares_get_servers_ports(ares_channel channel,
624 struct ares_addr_port_node **servers);
626 CARES_EXTERN const char *ares_inet_ntop(int af, const void *src, char *dst,
627 ares_socklen_t size);
629 CARES_EXTERN int ares_inet_pton(int af, const char *src, void *dst);