1 #ifndef HEADER_CURL_HOSTIP_H
2 #define HEADER_CURL_HOSTIP_H
3 /***************************************************************************
5 * Project ___| | | | _ \| |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
10 * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.
12 * This software is licensed as described in the file COPYING, which
13 * you should have received as part of this distribution. The terms
14 * are also available at https://curl.haxx.se/docs/copyright.html.
16 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17 * copies of the Software, and permit persons to whom the Software is
18 * furnished to do so, under the terms of the COPYING file.
20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21 * KIND, either express or implied.
23 ***************************************************************************/
25 #include "curl_setup.h"
27 #include "curl_addrinfo.h"
36 #define in_addr_t unsigned long
39 /* Allocate enough memory to hold the full name information structs and
40 * everything. OSF1 is known to require at least 8872 bytes. The buffer
41 * required for storing all possible aliases and IP numbers is according to
42 * Stevens' Unix Network Programming 2nd edition, p. 304: 8192 bytes!
44 #define CURL_HOSTENT_SIZE 9000
46 #define CURL_TIMEOUT_RESOLVE 300 /* when using asynch methods, we allow this
47 many seconds for a name resolve */
49 #define CURL_ASYNC_SUCCESS CURLE_OK
57 * Curl_global_host_cache_init() initializes and sets up a global DNS cache.
58 * Global DNS cache is general badness. Do not use. This will be removed in
59 * a future version. Use the share interface instead!
61 * Returns a struct curl_hash pointer on success, NULL on failure.
63 struct curl_hash *Curl_global_host_cache_init(void);
64 void Curl_global_host_cache_dtor(void);
66 struct Curl_dns_entry {
68 /* timestamp == 0 -- CURLOPT_RESOLVE entry, doesn't timeout */
70 /* use-counter, use Curl_resolv_unlock to release reference */
75 * Curl_resolv() returns an entry with the info for the specified host
78 * The returned data *MUST* be "unlocked" with Curl_resolv_unlock() after
79 * use, or we'll leak memory!
82 #define CURLRESOLV_TIMEDOUT -2
83 #define CURLRESOLV_ERROR -1
84 #define CURLRESOLV_RESOLVED 0
85 #define CURLRESOLV_PENDING 1
86 int Curl_resolv(struct connectdata *conn, const char *hostname,
87 int port, struct Curl_dns_entry **dnsentry);
88 int Curl_resolv_timeout(struct connectdata *conn, const char *hostname,
89 int port, struct Curl_dns_entry **dnsentry,
94 * Curl_ipv6works() returns TRUE if IPv6 seems to work.
96 bool Curl_ipv6works(void);
98 #define Curl_ipv6works() FALSE
102 * Curl_ipvalid() checks what CURL_IPRESOLVE_* requirements that might've
103 * been set and returns TRUE if they are OK.
105 bool Curl_ipvalid(struct connectdata *conn);
109 * Curl_getaddrinfo() is the generic low-level name resolve API within this
110 * source file. There are several versions of this function - for different
111 * name resolve layers (selected at build-time). They all take this same set
114 Curl_addrinfo *Curl_getaddrinfo(struct connectdata *conn,
115 const char *hostname,
120 /* unlock a previously resolved dns entry */
121 void Curl_resolv_unlock(struct SessionHandle *data,
122 struct Curl_dns_entry *dns);
124 /* for debugging purposes only: */
125 void Curl_scan_cache_used(void *user, void *ptr);
127 /* init a new dns cache and return success */
128 int Curl_mk_dnscache(struct curl_hash *hash);
130 /* prune old entries from the DNS cache */
131 void Curl_hostcache_prune(struct SessionHandle *data);
133 /* Return # of adresses in a Curl_addrinfo struct */
134 int Curl_num_addresses (const Curl_addrinfo *addr);
136 #if defined(CURLDEBUG) && defined(HAVE_GETNAMEINFO)
137 int curl_dogetnameinfo(GETNAMEINFO_QUAL_ARG1 GETNAMEINFO_TYPE_ARG1 sa,
138 GETNAMEINFO_TYPE_ARG2 salen,
139 char *host, GETNAMEINFO_TYPE_ARG46 hostlen,
140 char *serv, GETNAMEINFO_TYPE_ARG46 servlen,
141 GETNAMEINFO_TYPE_ARG7 flags,
142 int line, const char *source);
145 /* IPv4 threadsafe resolve function used for synch and asynch builds */
146 Curl_addrinfo *Curl_ipv4_resolve_r(const char * hostname, int port);
148 CURLcode Curl_async_resolved(struct connectdata *conn,
149 bool *protocol_connect);
151 #ifndef CURLRES_ASYNCH
152 #define Curl_async_resolved(x,y) CURLE_OK
156 * Curl_addrinfo_callback() is used when we build with any asynch specialty.
157 * Handles end of async request processing. Inserts ai into hostcache when
158 * status is CURL_ASYNC_SUCCESS. Twiddles fields in conn to indicate async
159 * request completed whether successful or failed.
161 CURLcode Curl_addrinfo_callback(struct connectdata *conn,
166 * Curl_printable_address() returns a printable version of the 1st address
167 * given in the 'ip' argument. The result will be stored in the buf that is
170 const char *Curl_printable_address(const Curl_addrinfo *ip,
171 char *buf, size_t bufsize);
174 * Curl_fetch_addr() fetches a 'Curl_dns_entry' already in the DNS cache.
176 * Returns the Curl_dns_entry entry pointer or NULL if not in the cache.
178 * The returned data *MUST* be "unlocked" with Curl_resolv_unlock() after
179 * use, or we'll leak memory!
181 struct Curl_dns_entry *
182 Curl_fetch_addr(struct connectdata *conn,
183 const char *hostname,
186 * Curl_cache_addr() stores a 'Curl_addrinfo' struct in the DNS cache.
188 * Returns the Curl_dns_entry entry pointer or NULL if the storage failed.
190 struct Curl_dns_entry *
191 Curl_cache_addr(struct SessionHandle *data, Curl_addrinfo *addr,
192 const char *hostname, int port);
195 #define CURL_INADDR_NONE (in_addr_t) ~0
197 #define CURL_INADDR_NONE INADDR_NONE
200 #ifdef HAVE_SIGSETJMP
201 /* Forward-declaration of variable defined in hostip.c. Beware this
202 * is a global and unique instance. This is used to store the return
203 * address that we can jump back to from inside a signal handler.
204 * This is not thread-safe stuff.
206 extern sigjmp_buf curl_jmpenv;
210 * Function provided by the resolver backend to set DNS servers to use.
212 CURLcode Curl_set_dns_servers(struct SessionHandle *data, char *servers);
215 * Function provided by the resolver backend to set
216 * outgoing interface to use for DNS requests
218 CURLcode Curl_set_dns_interface(struct SessionHandle *data,
222 * Function provided by the resolver backend to set
223 * local IPv4 address to use as source address for DNS requests
225 CURLcode Curl_set_dns_local_ip4(struct SessionHandle *data,
226 const char *local_ip4);
229 * Function provided by the resolver backend to set
230 * local IPv6 address to use as source address for DNS requests
232 CURLcode Curl_set_dns_local_ip6(struct SessionHandle *data,
233 const char *local_ip6);
236 * Clean off entries from the cache
238 void Curl_hostcache_clean(struct SessionHandle *data, struct curl_hash *hash);
241 * Destroy the hostcache of this handle.
243 void Curl_hostcache_destroy(struct SessionHandle *data);
246 * Populate the cache with specified entries from CURLOPT_RESOLVE.
248 CURLcode Curl_loadhostpairs(struct SessionHandle *data);
250 #endif /* HEADER_CURL_HOSTIP_H */