dns.c 43.8 KB
Newer Older
Roger Dingledine's avatar
Roger Dingledine committed
1
/* Copyright 2003-2004 Roger Dingledine.
Roger Dingledine's avatar
Roger Dingledine committed
2
 * Copyright 2004-2006 Roger Dingledine, Nick Mathewson. */
3
4
/* See LICENSE for licensing information */
/* $Id$ */
5
6
const char dns_c_id[] =
  "$Id$";
7

Roger Dingledine's avatar
Roger Dingledine committed
8
9
/**
 * \file dns.c
10
 * \brief Implements a local cache for DNS results for Tor servers.
11
 * We provide two asynchronous backend implementations:
12
13
14
15
16
17
 *   1) A farm of 'DNS worker' threads or processes to perform DNS lookups for
 *      onion routers and cache the results.
 *   2) A wrapper around Adam Langley's eventdns.c code, to send requests
 *      to the nameservers asynchronously.
 * (We can't just use gethostbyname() and friends because we really need to
 * be nonblocking.)
Roger Dingledine's avatar
Roger Dingledine committed
18
 **/
19

20
#include "or.h"
21
#include "../common/ht.h"
22
23
24
#ifdef USE_EVENTDNS
#include "eventdns.h"
#endif
25

Roger Dingledine's avatar
Roger Dingledine committed
26
/** Longest hostname we're willing to resolve. */
27
28
#define MAX_ADDRESSLEN 256

Roger Dingledine's avatar
Roger Dingledine committed
29
/** Maximum DNS processes to spawn. */
30
#define MAX_DNSWORKERS 100
Roger Dingledine's avatar
Roger Dingledine committed
31
/** Minimum DNS processes to spawn. */
32
#define MIN_DNSWORKERS 3
33

Roger Dingledine's avatar
Roger Dingledine committed
34
/** If more than this many processes are idle, shut down the extras. */
35
#define MAX_IDLE_DNSWORKERS 10
36

37
38
/** How long will we wait for an answer from the resolver before we decide
 * that the resolver is wedged? */
39
40
#define RESOLVE_MAX_TIMEOUT 300

Roger Dingledine's avatar
Roger Dingledine committed
41
/** Possible outcomes from hostname lookup: permanent failure,
42
 * transient (retryable) failure, and success. */
43
44
45
46
#define DNS_RESOLVE_FAILED_TRANSIENT 1
#define DNS_RESOLVE_FAILED_PERMANENT 2
#define DNS_RESOLVE_SUCCEEDED 3

47
#ifndef USE_EVENTDNS
48
/** How many dnsworkers we have running right now. */
49
static int num_dnsworkers=0;
50
/** How many of the running dnsworkers have an assigned task right now. */
51
52
53
static int num_dnsworkers_busy=0;
/** When did we last rotate the dnsworkers? */
static time_t last_rotation_time=0;
54
#endif
55

Roger Dingledine's avatar
Roger Dingledine committed
56
/** Linked list of connections waiting for a DNS answer. */
57
typedef struct pending_connection_t {
58
  edge_connection_t *conn;
59
  struct pending_connection_t *next;
60
} pending_connection_t;
61

62
63
#define CACHED_RESOLVE_MAGIC 0x1234F00D

64
65
66
67
68
69
70
/* Possible states for a cached resolve_t */
/** We are waiting for the resolver system to tell us an answer here.
 * When we get one, or when we time out, the state of this cached_resolve_t
 * will become "DONE" and we'll possibly add a CACHED_VALID or a CACHED_FAILED
 * entry. This cached_resolve_t will be in the hash table so that we will
 * know not to launch more requests for this addr, but rather to add more
 * connections to the pending list for the addr. */
71
#define CACHE_STATE_PENDING 0
72
73
74
/** This used to be a pending cached_resolve_t, and we got an answer for it.
 * Now we're waiting for this cached_resolve_t to expire.  This should
 * have no pending connections, and should not appear in the hash table. */
75
#define CACHE_STATE_DONE 1
76
77
/** We are caching an answer for this address. This should have no pending
 * connections, and should appear in the hash table. */
78
#define CACHE_STATE_CACHED_VALID 2
79
80
/** We are caching a failure for this address. This should have no pending
 * connections, and should appear in the hash table */
81
82
#define CACHE_STATE_CACHED_FAILED 3

Roger Dingledine's avatar
Roger Dingledine committed
83
/** A DNS request: possibly completed, possibly pending; cached_resolve
84
 * structs are stored at the OR side in a hash table, and as a linked
85
86
 * list from oldest to newest.
 */
87
typedef struct cached_resolve_t {
88
  HT_ENTRY(cached_resolve_t) node;
89
  uint32_t magic;
90
  char address[MAX_ADDRESSLEN]; /**< The hostname to be resolved. */
91
  uint32_t addr; /**< IPv4 addr for <b>address</b>. */
92
  uint8_t state; /**< Is this cached entry pending/done/valid/failed? */
93
  time_t expire; /**< Remove items from cache after this time. */
94
  uint32_t ttl; /**< What TTL did the nameserver tell us? */
95
96
  pending_connection_t *pending_connections;
} cached_resolve_t;
97

98
static void purge_expired_resolves(time_t now);
99
static void dns_found_answer(const char *address, uint32_t addr, char outcome,
100
                             uint32_t ttl);
101
static void send_resolved_cell(edge_connection_t *conn, uint8_t answer_type);
102
static int launch_resolve(edge_connection_t *exitconn);
103
#ifndef USE_EVENTDNS
104
static void dnsworkers_rotate(void);
Nick Mathewson's avatar
Nick Mathewson committed
105
static int dnsworker_main(void *data);
106
static int spawn_dnsworker(void);
107
static int spawn_enough_dnsworkers(void);
108
#else
109
static int configure_nameservers(int force);
110
#endif
111
#ifdef DEBUG_DNS_CACHE
112
static void _assert_cache_ok(void);
113
114
#define assert_cache_ok() _assert_cache_ok()
#else
115
#define assert_cache_ok() do {} while (0)
116
#endif
117
static void assert_resolve_ok(cached_resolve_t *resolve);
118

119
120
121
122
123
124
125
#ifdef USE_EVENTDNS
/* DOCDOC */
static int nameservers_configured = 0;
static char *resolv_conf_fname = NULL;
static time_t resolv_conf_mtime = 0;
#endif

126
127
/** Hash table of cached_resolve objects. */
static HT_HEAD(cache_map, cached_resolve_t) cache_root;
128

Roger Dingledine's avatar
Roger Dingledine committed
129
/** Function to compare hashed resolves on their addresses; used to
130
 * implement hash tables. */
131
132
static INLINE int
cached_resolves_eq(cached_resolve_t *a, cached_resolve_t *b)
133
{
134
  /* make this smarter one day? */
135
  assert_resolve_ok(a); // Not b; b may be just a search.
136
137
138
139
140
141
142
  return !strncmp(a->address, b->address, MAX_ADDRESSLEN);
}

static INLINE unsigned int
cached_resolve_hash(cached_resolve_t *a)
{
  return ht_string_hash(a->address);
143
144
}

145
HT_PROTOTYPE(cache_map, cached_resolve_t, node, cached_resolve_hash,
146
             cached_resolves_eq);
147
HT_GENERATE(cache_map, cached_resolve_t, node, cached_resolve_hash,
148
            cached_resolves_eq, 0.6, malloc, realloc, free);
149

150
/** Initialize the DNS cache. */
151
static void
152
init_cache_map(void)
153
{
154
  HT_INIT(&cache_root);
155
156
}

157
158
#ifdef USE_EVENTDNS
static void
159
eventdns_log_cb(int warn, const char *msg)
160
{
161
162
163
164
165
  if (!strcmpstart(msg, "Resolve requested for") &&
      get_options()->SafeLogging) {
    log(LOG_INFO, LD_EXIT, "eventdns: Resolve requested.");
    return;
  }
166
  log(warn?LOG_WARN:LOG_INFO, LD_EXIT, "eventdns: %s", msg);
167
168
169
}
#endif

Roger Dingledine's avatar
Roger Dingledine committed
170
/** Initialize the DNS subsystem; called by the OR process. */
171
int
172
173
dns_init(void)
{
174
  init_cache_map();
175
#ifdef USE_EVENTDNS
176
  if (server_mode(get_options()))
177
178
179
    return configure_nameservers(1);
#else
  dnsworkers_rotate();
180
#endif
181
  return 0;
182
}
183

184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
/* DOCDOC */
void
dns_reset(void)
{
#ifdef USE_EVENTDNS
  or_options_t *options = get_options();
  if (! server_mode(options)) {
    eventdns_clear_nameservers_and_suspend();
    eventdns_search_clear();
    nameservers_configured = 0;
    tor_free(resolv_conf_fname);
    resolv_conf_mtime = 0;
  } else {
    if (configure_nameservers(0) < 0)
      /* XXXX */
      return;
  }
#else
  dnsworkers_rotate();
#endif
}

206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
uint32_t
dns_clip_ttl(uint32_t ttl)
{
  if (ttl < MIN_DNS_TTL)
    return MIN_DNS_TTL;
  else if (ttl > MAX_DNS_TTL)
    return MAX_DNS_TTL;
  else
    return ttl;
}

static uint32_t
dns_get_expiry_ttl(uint32_t ttl)
{
  if (ttl < MIN_DNS_TTL)
    return MIN_DNS_TTL;
  else if (ttl > MAX_DNS_ENTRY_AGE)
    return MAX_DNS_ENTRY_AGE;
  else
    return ttl;
}

228
/** Helper: free storage held by an entry in the DNS cache. */
229
static void
230
_free_cached_resolve(cached_resolve_t *r)
231
{
Nick Mathewson's avatar
Nick Mathewson committed
232
  while (r->pending_connections) {
233
    pending_connection_t *victim = r->pending_connections;
234
235
236
    r->pending_connections = victim->next;
    tor_free(victim);
  }
237
  r->magic = 0xFF00FF00;
238
239
240
  tor_free(r);
}

241
242
243
/** Compare two cached_resolve_t pointers by expiry time, and return
 * less-than-zero, zero, or greater-than-zero as appropriate. Used for
 * the priority queue implementation. */
244
static int
245
_compare_cached_resolves_by_expiry(const void *_a, const void *_b)
246
{
247
  const cached_resolve_t *a = _a, *b = _b;
248
  return a->expire - b->expire;
249
250
}

251
252
/** Priority queue of cached_resolve_t objects to let us know when they
 * will expire. */
253
254
static smartlist_t *cached_resolve_pqueue = NULL;

255
256
/** Set an expiry time for a cached_resolve_t, and add it to the expiry
 * priority queue */
257
258
259
260
static void
set_expiry(cached_resolve_t *resolve, time_t expires)
{
  tor_assert(resolve && resolve->expire == 0);
261
262
  if (!cached_resolve_pqueue)
    cached_resolve_pqueue = smartlist_create();
263
264
265
266
267
268
  resolve->expire = expires;
  smartlist_pqueue_add(cached_resolve_pqueue,
                       _compare_cached_resolves_by_expiry,
                       resolve);
}

269
/** Free all storage held in the DNS cache */
270
271
272
void
dns_free_all(void)
{
273
  cached_resolve_t **ptr, **next, *item;
274
  for (ptr = HT_START(cache_map, &cache_root); ptr != NULL; ptr = next) {
275
    item = *ptr;
276
    next = HT_NEXT_RMV(cache_map, &cache_root, ptr);
277
    _free_cached_resolve(item);
278
  }
279
  HT_CLEAR(cache_map, &cache_root);
280
281
  if (cached_resolve_pqueue)
    smartlist_free(cached_resolve_pqueue);
282
  cached_resolve_pqueue = NULL;
283
284
}

Nick Mathewson's avatar
Nick Mathewson committed
285
/** Remove every cached_resolve whose <b>expire</b> time is before <b>now</b>
286
 * from the cache. */
287
static void
288
purge_expired_resolves(time_t now)
289
{
Nick Mathewson's avatar
Nick Mathewson committed
290
  cached_resolve_t *resolve, *removed;
291
  pending_connection_t *pend;
292
  edge_connection_t *pendconn;
293

Nick Mathewson's avatar
Nick Mathewson committed
294
  assert_cache_ok();
295
296
297
298
299
300
301
302
303
304
  if (!cached_resolve_pqueue)
    return;

  while (smartlist_len(cached_resolve_pqueue)) {
    resolve = smartlist_get(cached_resolve_pqueue, 0);
    if (resolve->expire > now)
      break;
    smartlist_pqueue_pop(cached_resolve_pqueue,
                         _compare_cached_resolves_by_expiry);

305
    if (resolve->state == CACHE_STATE_PENDING) {
306
      log_debug(LD_EXIT,
307
308
                "Expiring a dns resolve %s that's still pending. Forgot to "
                "cull it? DNS resolve didn't tell us about the timeout?",
309
310
311
312
313
314
315
316
317
318
319
                escaped_safe_str(resolve->address));
    } else if (resolve->state == CACHE_STATE_CACHED_VALID ||
               resolve->state == CACHE_STATE_CACHED_FAILED) {
      log_debug(LD_EXIT,
                "Forgetting old cached resolve (address %s, expires %lu)",
                escaped_safe_str(resolve->address),
                (unsigned long)resolve->expire);
      tor_assert(!resolve->pending_connections);
    } else {
      tor_assert(resolve->state == CACHE_STATE_DONE);
      tor_assert(!resolve->pending_connections);
320
    }
321

322
    if (resolve->pending_connections) {
323
      log_debug(LD_EXIT,
324
                "Closing pending connections on timed-out DNS resolve!");
325
      tor_fragile_assert();
326
327
328
329
      while (resolve->pending_connections) {
        pend = resolve->pending_connections;
        resolve->pending_connections = pend->next;
        /* Connections should only be pending if they have no socket. */
330
        tor_assert(pend->conn->_base.s == -1);
331
        pendconn = pend->conn;
332
        connection_edge_end(pendconn, END_STREAM_REASON_TIMEOUT,
333
                            pendconn->cpath_layer);
334
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
335
        connection_free(TO_CONN(pendconn));
336
337
        tor_free(pend);
      }
338
    }
339

340
341
342
343
344
345
346
    if (resolve->state == CACHE_STATE_CACHED_VALID ||
        resolve->state == CACHE_STATE_CACHED_FAILED ||
        resolve->state == CACHE_STATE_PENDING) {
      removed = HT_REMOVE(cache_map, &cache_root, resolve);
      if (removed != resolve) {
        log_err(LD_BUG, "The expired resolve we purged didn't match any in"
                " the cache. Tried to purge %s (%p); instead got %s (%p).",
347
348
                resolve->address, (void*)resolve,
                removed ? removed->address : "NULL", (void*)remove);
349
350
351
352
353
      }
      tor_assert(removed == resolve);
      resolve->magic = 0xF0BBF0BB;
      tor_free(resolve);
    } else {
354
      /* This should be in state DONE. Make sure it's not in the cache. */
355
356
      cached_resolve_t *tmp = HT_FIND(cache_map, &cache_root, resolve);
      tor_assert(tmp != resolve);
357
    }
358
  }
359

Nick Mathewson's avatar
Nick Mathewson committed
360
  assert_cache_ok();
361
362
}

Roger Dingledine's avatar
Roger Dingledine committed
363
/** Send a response to the RESOLVE request of a connection. answer_type must
364
365
 *  be one of RESOLVED_TYPE_(IPV4|ERROR|ERROR_TRANSIENT) */
static void
366
send_resolved_cell(edge_connection_t *conn, uint8_t answer_type)
367
368
{
  char buf[RELAY_PAYLOAD_SIZE];
369
  size_t buflen;
370
  uint32_t ttl;
371
372

  buf[0] = answer_type;
373
  ttl = dns_clip_ttl(conn->address_ttl);
374
375
376
377
378

  switch (answer_type)
    {
    case RESOLVED_TYPE_IPV4:
      buf[1] = 4;
379
      set_uint32(buf+2, htonl(conn->_base.addr));
380
      set_uint32(buf+6, htonl(ttl));
381
      buflen = 10;
382
383
384
      break;
    case RESOLVED_TYPE_ERROR_TRANSIENT:
    case RESOLVED_TYPE_ERROR:
385
386
387
      {
        const char *errmsg = "Error resolving hostname";
        int msglen = strlen(errmsg);
388

389
390
        buf[1] = msglen;
        strlcpy(buf+2, errmsg, sizeof(buf)-2);
391
        set_uint32(buf+2+msglen, htonl(ttl));
392
393
394
        buflen = 6+msglen;
        break;
      }
395
396
    default:
      tor_assert(0);
397
      return;
398
    }
399
  connection_edge_send_command(conn, circuit_get_by_edge_conn(conn),
400
401
402
403
                               RELAY_COMMAND_RESOLVED, buf, buflen,
                               conn->cpath_layer);
}

Nick Mathewson's avatar
Nick Mathewson committed
404
405
/** See if we have a cache entry for <b>exitconn</b>-\>address. if so,
 * if resolve valid, put it into <b>exitconn</b>-\>addr and return 1.
406
 * If resolve failed, unlink exitconn if needed, free it, and return -1.
407
408
409
410
411
412
413
 *
 * Else, if seen before and pending, add conn to the pending list,
 * and return 0.
 *
 * Else, if not seen before, add conn to pending list, hand to
 * dns farm, and return 0.
 */
414
int
415
dns_resolve(edge_connection_t *exitconn)
416
{
417
418
419
  cached_resolve_t *resolve;
  cached_resolve_t search;
  pending_connection_t *pending_connection;
420
  struct in_addr in;
421
  circuit_t *circ;
422
  time_t now = time(NULL);
423
424
  assert_connection_ok(TO_CONN(exitconn), 0);
  tor_assert(exitconn->_base.s == -1);
425

426
427
  assert_cache_ok();

428
  /* first check if exitconn->_base.address is an IP. If so, we already
429
   * know the answer. */
430
431
  if (tor_inet_aton(exitconn->_base.address, &in) != 0) {
    exitconn->_base.addr = ntohl(in.s_addr);
432
    exitconn->address_ttl = DEFAULT_DNS_TTL;
433
    if (exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE)
434
      send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
435
    return 1;
436
437
438
  }

  /* then take this opportunity to see if there are any expired
439
   * resolves in the hash table. */
440
  purge_expired_resolves(now);
441

442
443
  /* lower-case exitconn->_base.address, so it's in canonical form */
  tor_strlower(exitconn->_base.address);
444

445
  /* now check the hash table to see if 'address' is already there. */
446
  strlcpy(search.address, exitconn->_base.address, sizeof(search.address));
447
  resolve = HT_FIND(cache_map, &cache_root, &search);
448
  if (resolve && resolve->expire > now) { /* already there */
449
    switch (resolve->state) {
450
451
      case CACHE_STATE_PENDING:
        /* add us to the pending list */
452
        pending_connection = tor_malloc_zero(
453
                                      sizeof(pending_connection_t));
454
        pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
455
456
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
457
        log_debug(LD_EXIT,"Connection (fd %d) waiting for pending DNS "
458
459
                  "resolve of %s", exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
460
        exitconn->_base.state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
   
Roger Dingledine committed
461
        return 0;
462
      case CACHE_STATE_CACHED_VALID:
463
        exitconn->_base.addr = resolve->addr;
464
        exitconn->address_ttl = resolve->ttl;
465
        log_debug(LD_EXIT,"Connection (fd %d) found cached answer for %s",
466
467
                  exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
468
        if (exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE)
469
          send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
470
        return 1;
471
      case CACHE_STATE_CACHED_FAILED:
472
        log_debug(LD_EXIT,"Connection (fd %d) found cached error for %s",
473
474
                  exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
475
        if (exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE)
476
          send_resolved_cell(exitconn, RESOLVED_TYPE_ERROR);
477
        circ = circuit_get_by_edge_conn(exitconn);
478
479
        if (circ)
          circuit_detach_stream(circ, exitconn);
480
481
        if (!exitconn->_base.marked_for_close)
          connection_free(TO_CONN(exitconn));
482
        return -1;
483
484
485
      case CACHE_STATE_DONE:
        log_err(LD_BUG, "Found a 'DONE' dns resolve still in the cache.");
        tor_fragile_assert();
486
    }
Roger Dingledine's avatar
Roger Dingledine committed
487
    tor_assert(0);
Roger Dingledine's avatar
Roger Dingledine committed
488
489
  }
  /* not there, need to add it */
490
  resolve = tor_malloc_zero(sizeof(cached_resolve_t));
491
  resolve->magic = CACHED_RESOLVE_MAGIC;
Roger Dingledine's avatar
Roger Dingledine committed
492
  resolve->state = CACHE_STATE_PENDING;
493
  strlcpy(resolve->address, exitconn->_base.address, sizeof(resolve->address));
Roger Dingledine's avatar
Roger Dingledine committed
494

495
  /* add this connection to the pending list */
496
  pending_connection = tor_malloc_zero(sizeof(pending_connection_t));
Roger Dingledine's avatar
Roger Dingledine committed
497
498
  pending_connection->conn = exitconn;
  resolve->pending_connections = pending_connection;
499
  exitconn->_base.state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
Roger Dingledine committed
500

501
  /* Add this resolve to the cache and priority queue. */
502
  HT_INSERT(cache_map, &cache_root, resolve);
503
  set_expiry(resolve, now + RESOLVE_MAX_TIMEOUT);
504

505
  log_debug(LD_EXIT,"Launching %s.",
506
            escaped_safe_str(exitconn->_base.address));
507
  assert_cache_ok();
508
  return launch_resolve(exitconn);
509
510
}

511
/** Log an error and abort if conn is waiting for a DNS resolve.
512
 */
513
void
514
assert_connection_edge_not_dns_pending(edge_connection_t *conn)
515
{
516
517
  pending_connection_t *pend;
  cached_resolve_t **resolve;
518

519
520
521
522
523
524
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
      tor_assert(pend->conn != conn);
    }
525
  }
526
}
527

528
529
530
531
532
533
534
/** Log an error and abort if any connection waiting for a DNS resolve is
 * corrupted. */
void
assert_all_pending_dns_resolves_ok(void)
{
  pending_connection_t *pend;
  cached_resolve_t **resolve;
535

536
537
538
539
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
540
541
542
      assert_connection_ok(TO_CONN(pend->conn), 0);
      tor_assert(pend->conn->_base.s == -1);
      tor_assert(!connection_in_array(TO_CONN(pend->conn)));
543
    }
544
545
546
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
547
/** Remove <b>conn</b> from the list of connections waiting for conn-\>address.
548
 */
549
void
550
connection_dns_remove(edge_connection_t *conn)
551
{
552
553
554
  pending_connection_t *pend, *victim;
  cached_resolve_t search;
  cached_resolve_t *resolve;
555

556
557
  tor_assert(conn->_base.type == CONN_TYPE_EXIT);
  tor_assert(conn->_base.state == EXIT_CONN_STATE_RESOLVING);
558

559
  strlcpy(search.address, conn->_base.address, sizeof(search.address));
560

561
  resolve = HT_FIND(cache_map, &cache_root, &search);
562
  if (!resolve) {
563
    log_notice(LD_BUG, "Address %s is not pending. Dropping.",
564
               escaped_safe_str(conn->_base.address));
565
566
567
    return;
  }

Roger Dingledine's avatar
Roger Dingledine committed
568
  tor_assert(resolve->pending_connections);
569
  assert_connection_ok(TO_CONN(conn),0);
570
571
572

  pend = resolve->pending_connections;

573
  if (pend->conn == conn) {
574
    resolve->pending_connections = pend->next;
575
    tor_free(pend);
576
    log_debug(LD_EXIT, "First connection (fd %d) no longer waiting "
577
              "for resolve of %s",
578
              conn->_base.s, escaped_safe_str(conn->_base.address));
579
580
    return;
  } else {
581
582
    for ( ; pend->next; pend = pend->next) {
      if (pend->next->conn == conn) {
583
584
        victim = pend->next;
        pend->next = victim->next;
585
        tor_free(victim);
586
        log_debug(LD_EXIT,
587
                  "Connection (fd %d) no longer waiting for resolve of %s",
588
                  conn->_base.s, escaped_safe_str(conn->_base.address));
589
590
591
        return; /* more are pending */
      }
    }
Roger Dingledine's avatar
Roger Dingledine committed
592
    tor_assert(0); /* not reachable unless onlyconn not in pending list */
593
594
595
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
596
597
598
/** Mark all connections waiting for <b>address</b> for close.  Then cancel
 * the resolve for <b>address</b> itself, and remove any cached results for
 * <b>address</b> from the cache.
599
 */
600
void
601
dns_cancel_pending_resolve(char *address)
602
{
603
604
  pending_connection_t *pend;
  cached_resolve_t search;
605
  cached_resolve_t *resolve, *tmp;
606
  edge_connection_t *pendconn;
607
  circuit_t *circ;
608

Nick Mathewson's avatar
Nick Mathewson committed
609
  strlcpy(search.address, address, sizeof(search.address));
610

611
  resolve = HT_FIND(cache_map, &cache_root, &search);
612
  if (!resolve || resolve->state != CACHE_STATE_PENDING) {
613
614
    log_notice(LD_BUG,"Address %s is not pending. Dropping.",
               escaped_safe_str(address));
615
616
617
    return;
  }

618
619
  if (!resolve->pending_connections) {
    /* XXX this should never trigger, but sometimes it does */
620
    log_warn(LD_BUG,
621
622
             "Bug: Address %s is pending but has no pending connections!",
             escaped_safe_str(address));
623
    tor_fragile_assert();
624
625
    return;
  }
Roger Dingledine's avatar
Roger Dingledine committed
626
  tor_assert(resolve->pending_connections);
627
  tor_assert(! resolve->expire);
628

629
  /* mark all pending connections to fail */
630
  log_debug(LD_EXIT,
631
632
             "Failing all connections waiting on DNS resolve of %s",
             escaped_safe_str(address));
633
  while (resolve->pending_connections) {
634
    pend = resolve->pending_connections;
635
    pend->conn->_base.state = EXIT_CONN_STATE_RESOLVEFAILED;
636
    pendconn = pend->conn;
637
638
639
    assert_connection_ok(TO_CONN(pendconn), 0);
    tor_assert(pendconn->_base.s == -1);
    if (!pendconn->_base.marked_for_close) {
640
641
      connection_edge_end(pendconn, END_STREAM_REASON_RESOURCELIMIT,
                          pendconn->cpath_layer);
642
    }
643
    circ = circuit_get_by_edge_conn(pendconn);
644
645
    if (circ)
      circuit_detach_stream(circ, pendconn);
646
    connection_free(TO_CONN(pendconn));
647
648
    resolve->pending_connections = pend->next;
    tor_free(pend);
649
650
  }

Nick Mathewson's avatar
Nick Mathewson committed
651
  tmp = HT_REMOVE(cache_map, &cache_root, resolve);
652
653
654
  if (tmp != resolve) {
    log_err(LD_BUG, "The cancelled resolve we purged didn't match any in"
            " the cache. Tried to purge %s (%p); instead got %s (%p).",
655
656
            resolve->address, (void*)resolve,
            tmp ? tmp->address : "NULL", (void*)tmp);
657
  }
Nick Mathewson's avatar
Nick Mathewson committed
658
  tor_assert(tmp == resolve);
659
  resolve->magic = 0xABABABAB;
660
  tor_free(resolve);
661
662
}

663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
static void
add_answer_to_cache(const char *address, uint32_t addr, char outcome,
                    uint32_t ttl)
{
  cached_resolve_t *resolve;
  if (outcome == DNS_RESOLVE_FAILED_TRANSIENT)
    return;

  resolve = tor_malloc_zero(sizeof(cached_resolve_t));
  resolve->magic = CACHED_RESOLVE_MAGIC;
  resolve->state = (outcome == DNS_RESOLVE_SUCCEEDED) ?
    CACHE_STATE_CACHED_VALID : CACHE_STATE_CACHED_FAILED;
  strlcpy(resolve->address, address, sizeof(resolve->address));
  resolve->addr = addr;
  resolve->ttl = ttl;
  assert_resolve_ok(resolve);
  HT_INSERT(cache_map, &cache_root, resolve);
  set_expiry(resolve, time(NULL) + dns_get_expiry_ttl(ttl));
}

Roger Dingledine's avatar
Roger Dingledine committed
683
/** Called on the OR side when a DNS worker tells us the outcome of a DNS
684
 * resolve: tell all pending connections about the result of the lookup, and
Nick Mathewson's avatar
Nick Mathewson committed
685
686
687
688
 * cache the value.  (<b>address</b> is a NUL-terminated string containing the
 * address to look up; <b>addr</b> is an IPv4 address in host order;
 * <b>outcome</b> is one of
 * DNS_RESOLVE_{FAILED_TRANSIENT|FAILED_PERMANENT|SUCCEEDED}.
689
 */
690
static void
691
692
dns_found_answer(const char *address, uint32_t addr, char outcome,
                 uint32_t ttl)
693
{
694
695
  pending_connection_t *pend;
  cached_resolve_t search;
696
  cached_resolve_t *resolve, *removed;
697
  edge_connection_t *pendconn;
698
  circuit_t *circ;
699

700
701
  assert_cache_ok();

Nick Mathewson's avatar
Nick Mathewson committed
702
  strlcpy(search.address, address, sizeof(search.address));
703

704
  resolve = HT_FIND(cache_map, &cache_root, &search);
705
  if (!resolve) {
706
707
    log_info(LD_EXIT,"Resolved unasked address %s; caching anyway.",
             escaped_safe_str(address));
708
    add_answer_to_cache(address, addr, outcome, ttl);
709
    return;
710
  }
711
  assert_resolve_ok(resolve);
712

713
  if (resolve->state != CACHE_STATE_PENDING) {
714
715
    /* XXXX Maybe update addr? or check addr for consistency? Or let
     * VALID replace FAILED? */
716
717
    log_notice(LD_EXIT, "Resolved %s which was already resolved; ignoring",
               escaped_safe_str(address));
Roger Dingledine's avatar
Roger Dingledine committed
718
    tor_assert(resolve->pending_connections == NULL);
719
720
721
722
723
724
    return;
  }
  /* Removed this assertion: in fact, we'll sometimes get a double answer
   * to the same question.  This can happen when we ask one worker to resolve
   * X.Y.Z., then we cancel the request, and then we ask another worker to
   * resolve X.Y.Z. */
Roger Dingledine's avatar
Roger Dingledine committed
725
  /* tor_assert(resolve->state == CACHE_STATE_PENDING); */
726

727
  while (resolve->pending_connections) {
728
    pend = resolve->pending_connections;
729
730
    pendconn = pend->conn; /* don't pass complex things to the
                              connection_mark_for_close macro */
731
    assert_connection_ok(TO_CONN(pendconn),time(NULL));
732
733
    pendconn->_base.addr = addr;
    pendconn->address_ttl = ttl;
734

735
    if (outcome != DNS_RESOLVE_SUCCEEDED) {
736
      /* prevent double-remove. */
737
738
      pendconn->_base.state = EXIT_CONN_STATE_RESOLVEFAILED;
      if (pendconn->_base.purpose == EXIT_PURPOSE_CONNECT) {
739
740
        connection_edge_end(pendconn, END_STREAM_REASON_RESOLVEFAILED,
                            pendconn->cpath_layer);
741
        /* This detach must happen after we send the end cell. */
742
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
743
      } else {
744
        send_resolved_cell(pendconn, RESOLVED_TYPE_ERROR);
745
        /* This detach must happen after we send the resolved cell. */
746
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
747
      }
748
      connection_free(TO_CONN(pendconn));
Roger Dingledine's avatar
Roger Dingledine committed
749
    } else {
750
      if (pendconn->_base.purpose == EXIT_PURPOSE_CONNECT) {
751
        /* prevent double-remove. */
752
        pend->conn->_base.state = EXIT_CONN_STATE_CONNECTING;
753

754
        circ = circuit_get_by_edge_conn(pend->conn);
755
        tor_assert(circ);
756
        tor_assert(!CIRCUIT_IS_ORIGIN(circ));
757
758
759
        /* unlink pend->conn from resolving_streams, */
        circuit_detach_stream(circ, pend->conn);
        /* and link it to n_streams */
760
        pend->conn->next_stream = TO_OR_CIRCUIT(circ)->n_streams;
761
        pend->conn->on_circuit = circ;
762
        TO_OR_CIRCUIT(circ)->n_streams = pend->conn;
763
764
765
766
767

        connection_exit_connect(pend->conn);
      } else {
        /* prevent double-remove.  This isn't really an accurate state,
         * but it does the right thing. */
768
        pendconn->_base.state = EXIT_CONN_STATE_RESOLVEFAILED;
769
        send_resolved_cell(pendconn, RESOLVED_TYPE_IPV4);
770
        circ = circuit_get_by_edge_conn(pendconn);
771
772
        tor_assert(circ);
        circuit_detach_stream(circ, pendconn);
773
        connection_free(TO_CONN(pendconn));
774
      }
Roger Dingledine's avatar
Roger Dingledine committed
775
    }
776
777
    resolve->pending_connections = pend->next;
    tor_free(pend);
778
  }
779

780
781
782
783
784
  resolve->state = CACHE_STATE_DONE;
  removed = HT_REMOVE(cache_map, &cache_root, &search);
  if (removed != resolve) {
    log_err(LD_BUG, "The pending resolve we found wasn't removable from"
            " the cache. Tried to purge %s (%p); instead got %s (%p).",
785
786
            resolve->address, (void*)resolve,
            removed ? removed->address : "NULL", (void*)removed);
787
  }
788
789
  assert_resolve_ok(resolve);
  assert_cache_ok();
790

791
  add_answer_to_cache(address, addr, outcome, ttl);
792
  assert_cache_ok();
793
794
}

795
796
797
798
799
#ifndef USE_EVENTDNS
/** Find or spawn a dns worker process to handle resolving
 * <b>exitconn</b>-\>address; tell that dns worker to begin resolving.
 */
static int
800
launch_resolve(edge_connection_t *exitconn)
801
802
803
804
{
  connection_t *dnsconn;
  unsigned char len;

805
806
807
  tor_assert(exitconn->_base.state == EXIT_CONN_STATE_RESOLVING);
  assert_connection_ok(TO_CONN(exitconn), 0);
  tor_assert(exitconn->_base.s == -1);
808
809
810
811
812
813
814
815
816
817
818

  /* respawn here, to be sure there are enough */
  if (spawn_enough_dnsworkers() < 0) {
    goto err;
  }

  dnsconn = connection_get_by_type_state(CONN_TYPE_DNSWORKER,
                                         DNSWORKER_STATE_IDLE);

  if (!dnsconn) {
    log_warn(LD_EXIT,"no idle dns workers. Failing.");