dns.c 40 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
11
12
13
 * \brief Implements a farm of 'DNS worker' threads or processes to
 * perform DNS lookups for onion routers and cache the results.
 * [This needs to be done in the background because of the lack of a
 * good, ubiquitous asynchronous DNS implementation.]
Roger Dingledine's avatar
Roger Dingledine committed
14
 **/
15

16
17
/* See
 * http://elvin.dstc.com/ListArchive/elvin-dev/archive/2001/09/msg00027.html
18
19
20
21
 * for some approaches to asynchronous dns. We will want to switch once one of
 * them becomes more commonly available.
 */

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

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

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

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

39
40
41
/** DOCDCOC */
#define RESOLVE_MAX_TIMEOUT 300

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

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

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

63
64
#define CACHED_RESOLVE_MAGIC 0x1234F00D

65
66
67
68
69
70
/* DOCDOC */
#define CACHE_STATE_PENDING 0
#define CACHE_STATE_DONE 1
#define CACHE_STATE_CACHED_VALID 2
#define CACHE_STATE_CACHED_FAILED 3

Roger Dingledine's avatar
Roger Dingledine committed
71
/** A DNS request: possibly completed, possibly pending; cached_resolve
72
 * structs are stored at the OR side in a hash table, and as a linked
73
74
 * list from oldest to newest.
 */
75
typedef struct cached_resolve_t {
76
  HT_ENTRY(cached_resolve_t) node;
77
  uint32_t magic;
78
  char address[MAX_ADDRESSLEN]; /**< The hostname to be resolved. */
79
  uint32_t addr; /**< IPv4 addr for <b>address</b>. */
80
81
  uint8_t state; /**< 0 is pending; 1 means answer is valid; 2 means resolve
                  * failed. */
82
  time_t expire; /**< Remove items from cache after this time. */
83
  uint32_t ttl; /**< What TTL did the nameserver tell us? */
84
85
  pending_connection_t *pending_connections;
} cached_resolve_t;
86

87
static void purge_expired_resolves(uint32_t now);
88
static void dns_found_answer(const char *address, uint32_t addr, char outcome,
89
                             uint32_t ttl);
90
91
static void send_resolved_cell(edge_connection_t *conn, uint8_t answer_type);
static int assign_to_dnsworker(edge_connection_t *exitconn);
92
#ifndef USE_EVENTDNS
Nick Mathewson's avatar
Nick Mathewson committed
93
static int dnsworker_main(void *data);
94
static int spawn_dnsworker(void);
95
static int spawn_enough_dnsworkers(void);
96
#endif
97
98
static void assert_cache_ok(void);
static void assert_resolve_ok(cached_resolve_t *resolve);
99

100
101
/** Hash table of cached_resolve objects. */
static HT_HEAD(cache_map, cached_resolve_t) cache_root;
102

Roger Dingledine's avatar
Roger Dingledine committed
103
/** Function to compare hashed resolves on their addresses; used to
104
 * implement hash tables. */
105
106
static INLINE int
cached_resolves_eq(cached_resolve_t *a, cached_resolve_t *b)
107
{
108
  /* make this smarter one day? */
109
  assert_resolve_ok(a); // Not b; b may be just a search.
110
111
112
113
114
115
116
  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);
117
118
}

119
HT_PROTOTYPE(cache_map, cached_resolve_t, node, cached_resolve_hash,
120
             cached_resolves_eq);
121
HT_GENERATE(cache_map, cached_resolve_t, node, cached_resolve_hash,
122
            cached_resolves_eq, 0.6, malloc, realloc, free);
123

124
/** Initialize the DNS cache. */
125
static void
126
init_cache_map(void)
127
{
128
  HT_INIT(&cache_root);
129
130
}

131
132
133
134
#ifdef USE_EVENTDNS
static void
eventdns_log_cb(const char *msg)
{
135
136
137
138
139
  if (!strcmpstart(msg, "Resolve requested for") &&
      get_options()->SafeLogging) {
    log(LOG_INFO, LD_EXIT, "eventdns: Resolve requested.");
    return;
  }
Nick Mathewson's avatar
Nick Mathewson committed
140
  log(LOG_INFO, LD_EXIT, "eventdns: %s", msg);
141
142
143
}
#endif

Roger Dingledine's avatar
Roger Dingledine committed
144
/** Initialize the DNS subsystem; called by the OR process. */
145
146
147
void
dns_init(void)
{
148

149
  init_cache_map();
150
  dnsworkers_rotate();
151
#ifdef USE_EVENTDNS
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
  {
    or_options_t *options = get_options();
    eventdns_set_log_fn(eventdns_log_cb);
    if (options->Nameservers && smartlist_len(options->Nameservers)) {
      SMARTLIST_FOREACH(options->Nameservers, const char *, ip,
        {
          struct in_addr in;
          log_info(LD_EXIT, "Parsing /etc/resolv.conf");
          if (tor_inet_aton(ip, &in)) {
            log_info(LD_EXIT, "Adding nameserver '%s'", ip);
            eventdns_nameserver_add(in.s_addr);
          }
        });
    } else {
      log_info(LD_EXIT, "Parsing /etc/resolv.conf");
      eventdns_resolv_conf_parse(DNS_OPTION_NAMESERVERS|DNS_OPTION_MISC,
                                 "/etc/resolv.conf");
    }
  }
171
#endif
172
}
173

174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
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;
}

196
/** Helper: free storage held by an entry in the DNS cache. */
197
static void
198
_free_cached_resolve(cached_resolve_t *r)
199
{
Nick Mathewson's avatar
Nick Mathewson committed
200
  while (r->pending_connections) {
201
    pending_connection_t *victim = r->pending_connections;
202
203
204
    r->pending_connections = victim->next;
    tor_free(victim);
  }
205
  r->magic = 0xFF00FF00;
206
207
208
  tor_free(r);
}

209
210
/** DODDOC */
static int
211
_compare_cached_resolves_by_expiry(const void *_a, const void *_b)
212
{
213
  const cached_resolve_t *a = _a, *b = _b;
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
  if (a->expire < b->expire)
    return -1;
  else if (a->expire == b->expire)
    return 0;
  else
    return 1;
}

/** Linked list of resolved addresses, oldest to newest. DOCDOC*/
static smartlist_t *cached_resolve_pqueue = NULL;

static void
set_expiry(cached_resolve_t *resolve, time_t expires)
{
  tor_assert(resolve && resolve->expire == 0);
229
230
  if (!cached_resolve_pqueue)
    cached_resolve_pqueue = smartlist_create();
231
232
233
234
235
236
  resolve->expire = expires;
  smartlist_pqueue_add(cached_resolve_pqueue,
                       _compare_cached_resolves_by_expiry,
                       resolve);
}

237
/** Free all storage held in the DNS cache */
238
239
240
void
dns_free_all(void)
{
241
  cached_resolve_t **ptr, **next, *item;
242
  for (ptr = HT_START(cache_map, &cache_root); ptr != NULL; ptr = next) {
243
    item = *ptr;
244
    next = HT_NEXT_RMV(cache_map, &cache_root, ptr);
245
    _free_cached_resolve(item);
246
  }
247
  HT_CLEAR(cache_map, &cache_root);
248
249
  smartlist_free(cached_resolve_pqueue);
  cached_resolve_pqueue = NULL;
250
251
}

Nick Mathewson's avatar
Nick Mathewson committed
252
/** Remove every cached_resolve whose <b>expire</b> time is before <b>now</b>
253
 * from the cache. */
254
255
256
static void
purge_expired_resolves(uint32_t now)
{
Nick Mathewson's avatar
Nick Mathewson committed
257
  cached_resolve_t *resolve, *removed;
258
  pending_connection_t *pend;
259
  edge_connection_t *pendconn;
260

Nick Mathewson's avatar
Nick Mathewson committed
261
  assert_cache_ok();
262
263
264
265
266
267
268
269
270
271
  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);

272
    if (resolve->state == CACHE_STATE_PENDING) {
273
      log_debug(LD_EXIT,
274
275
276
277
278
279
280
281
282
283
284
285
286
                "Expiring a dns resolve %s that's still pending. Forgot to cull"
                " it? DNS resolve didn't tell us about the timeout?",
                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);
287
    }
288

289
    if (resolve->pending_connections) {
290
      log_debug(LD_EXIT,
291
                "Closing pending connections on timed-out DNS resolve!");
292
      tor_fragile_assert();
293
294
295
296
      while (resolve->pending_connections) {
        pend = resolve->pending_connections;
        resolve->pending_connections = pend->next;
        /* Connections should only be pending if they have no socket. */
297
        tor_assert(pend->conn->_base.s == -1);
298
        pendconn = pend->conn;
299
        connection_edge_end(pendconn, END_STREAM_REASON_TIMEOUT,
300
                            pendconn->cpath_layer);
301
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
302
        connection_free(TO_CONN(pendconn));
303
304
        tor_free(pend);
      }
305
    }
306

307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
    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).",
                resolve->address, resolve,
                removed ? removed->address : "NULL", remove);
      }
      tor_assert(removed == resolve);
      resolve->magic = 0xF0BBF0BB;
      tor_free(resolve);
    } else {
      cached_resolve_t *tmp = HT_FIND(cache_map, &cache_root, resolve);
      tor_assert(tmp != resolve);
323
    }
324
  }
325

Nick Mathewson's avatar
Nick Mathewson committed
326
  assert_cache_ok();
327
328
}

Roger Dingledine's avatar
Roger Dingledine committed
329
/** Send a response to the RESOLVE request of a connection. answer_type must
330
331
 *  be one of RESOLVED_TYPE_(IPV4|ERROR|ERROR_TRANSIENT) */
static void
332
send_resolved_cell(edge_connection_t *conn, uint8_t answer_type)
333
334
{
  char buf[RELAY_PAYLOAD_SIZE];
335
  size_t buflen;
336
  uint32_t ttl;
337
338

  buf[0] = answer_type;
339
  ttl = dns_clip_ttl(conn->address_ttl);
340
341
342
343
344

  switch (answer_type)
    {
    case RESOLVED_TYPE_IPV4:
      buf[1] = 4;
345
      set_uint32(buf+2, htonl(conn->_base.addr));
346
      set_uint32(buf+6, htonl(ttl));
347
      buflen = 10;
348
349
350
      break;
    case RESOLVED_TYPE_ERROR_TRANSIENT:
    case RESOLVED_TYPE_ERROR:
351
352
353
      {
        const char *errmsg = "Error resolving hostname";
        int msglen = strlen(errmsg);
354

355
356
        buf[1] = msglen;
        strlcpy(buf+2, errmsg, sizeof(buf)-2);
357
        set_uint32(buf+2+msglen, htonl(ttl));
358
359
360
        buflen = 6+msglen;
        break;
      }
361
362
363
    default:
      tor_assert(0);
    }
364
  connection_edge_send_command(conn, circuit_get_by_edge_conn(conn),
365
366
367
368
                               RELAY_COMMAND_RESOLVED, buf, buflen,
                               conn->cpath_layer);
}

Nick Mathewson's avatar
Nick Mathewson committed
369
370
/** 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.
371
 * If resolve failed, unlink exitconn if needed, free it, and return -1.
372
373
374
375
376
377
378
 *
 * 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.
 */
379
int
380
dns_resolve(edge_connection_t *exitconn)
381
{
382
383
384
  cached_resolve_t *resolve;
  cached_resolve_t search;
  pending_connection_t *pending_connection;
385
  struct in_addr in;
386
  circuit_t *circ;
387
  uint32_t now = time(NULL);
388
389
  assert_connection_ok(TO_CONN(exitconn), 0);
  tor_assert(exitconn->_base.s == -1);
390

391
392
  assert_cache_ok();

393
  /* first check if exitconn->_base.address is an IP. If so, we already
394
   * know the answer. */
395
396
  if (tor_inet_aton(exitconn->_base.address, &in) != 0) {
    exitconn->_base.addr = ntohl(in.s_addr);
397
    exitconn->address_ttl = DEFAULT_DNS_TTL;
398
    if (exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE)
399
      send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
400
    return 1;
401
402
403
  }

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

407
408
  /* lower-case exitconn->_base.address, so it's in canonical form */
  tor_strlower(exitconn->_base.address);
409

410
  /* now check the hash table to see if 'address' is already there. */
411
  strlcpy(search.address, exitconn->_base.address, sizeof(search.address));
412
  resolve = HT_FIND(cache_map, &cache_root, &search);
413
  if (resolve && resolve->expire > now) { /* already there */
414
    switch (resolve->state) {
415
416
      case CACHE_STATE_PENDING:
        /* add us to the pending list */
417
        pending_connection = tor_malloc_zero(
418
                                      sizeof(pending_connection_t));
419
        pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
420
421
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
422
        log_debug(LD_EXIT,"Connection (fd %d) waiting for pending DNS "
423
424
                  "resolve of %s", exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
425
        exitconn->_base.state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
   
Roger Dingledine committed
426
        return 0;
427
      case CACHE_STATE_CACHED_VALID:
428
        exitconn->_base.addr = resolve->addr;
429
        exitconn->address_ttl = resolve->ttl;
430
        log_debug(LD_EXIT,"Connection (fd %d) found cached answer for %s",
431
432
                  exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
433
        if (exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE)
434
          send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
435
        return 1;
436
      case CACHE_STATE_CACHED_FAILED:
437
        log_debug(LD_EXIT,"Connection (fd %d) found cached error for %s",
438
439
                  exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
440
        if (exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE)
441
          send_resolved_cell(exitconn, RESOLVED_TYPE_ERROR);
442
        circ = circuit_get_by_edge_conn(exitconn);
443
444
        if (circ)
          circuit_detach_stream(circ, exitconn);
445
446
        if (!exitconn->_base.marked_for_close)
          connection_free(TO_CONN(exitconn));
447
        return -1;
448
449
450
      case CACHE_STATE_DONE:
        log_err(LD_BUG, "Found a 'DONE' dns resolve still in the cache.");
        tor_fragile_assert();
451
    }
Roger Dingledine's avatar
Roger Dingledine committed
452
    tor_assert(0);
Roger Dingledine's avatar
Roger Dingledine committed
453
454
  }
  /* not there, need to add it */
455
  resolve = tor_malloc_zero(sizeof(cached_resolve_t));
456
  resolve->magic = CACHED_RESOLVE_MAGIC;
Roger Dingledine's avatar
Roger Dingledine committed
457
  resolve->state = CACHE_STATE_PENDING;
458
  strlcpy(resolve->address, exitconn->_base.address, sizeof(resolve->address));
Roger Dingledine's avatar
Roger Dingledine committed
459

460
  /* add this connection to the pending list */
461
  pending_connection = tor_malloc_zero(sizeof(pending_connection_t));
Roger Dingledine's avatar
Roger Dingledine committed
462
463
  pending_connection->conn = exitconn;
  resolve->pending_connections = pending_connection;
464
  exitconn->_base.state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
Roger Dingledine committed
465

466
  /* Add this resolve to the cache and priority queue. */
467
  HT_INSERT(cache_map, &cache_root, resolve);
468
  set_expiry(resolve, now + RESOLVE_MAX_TIMEOUT);
469

470
  log_debug(LD_EXIT,"Assigning question %s to dnsworker.",
471
            escaped_safe_str(exitconn->_base.address));
472
  assert_cache_ok();
Roger Dingledine's avatar
Roger Dingledine committed
473
  return assign_to_dnsworker(exitconn);
474
475
}

476
/** Log an error and abort if conn is waiting for a DNS resolve.
477
 */
478
void
479
assert_connection_edge_not_dns_pending(edge_connection_t *conn)
480
{
481
482
  pending_connection_t *pend;
  cached_resolve_t **resolve;
483

484
485
486
487
488
489
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
      tor_assert(pend->conn != conn);
    }
490
  }
491
}
492

493
494
495
496
497
498
499
/** 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;
500

501
502
503
504
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
505
506
507
      assert_connection_ok(TO_CONN(pend->conn), 0);
      tor_assert(pend->conn->_base.s == -1);
      tor_assert(!connection_in_array(TO_CONN(pend->conn)));
508
    }
509
510
511
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
512
/** Remove <b>conn</b> from the list of connections waiting for conn-\>address.
513
 */
514
void
515
connection_dns_remove(edge_connection_t *conn)
516
{
517
518
519
  pending_connection_t *pend, *victim;
  cached_resolve_t search;
  cached_resolve_t *resolve;
520

521
522
  tor_assert(conn->_base.type == CONN_TYPE_EXIT);
  tor_assert(conn->_base.state == EXIT_CONN_STATE_RESOLVING);
523

524
  strlcpy(search.address, conn->_base.address, sizeof(search.address));
525

526
  resolve = HT_FIND(cache_map, &cache_root, &search);
527
  if (!resolve) {
528
    log_notice(LD_BUG, "Address %s is not pending. Dropping.",
529
               escaped_safe_str(conn->_base.address));
530
531
532
    return;
  }

Roger Dingledine's avatar
Roger Dingledine committed
533
  tor_assert(resolve->pending_connections);
534
  assert_connection_ok(TO_CONN(conn),0);
535
536
537

  pend = resolve->pending_connections;

538
  if (pend->conn == conn) {
539
    resolve->pending_connections = pend->next;
540
    tor_free(pend);
541
    log_debug(LD_EXIT, "First connection (fd %d) no longer waiting "
542
              "for resolve of %s",
543
              conn->_base.s, escaped_safe_str(conn->_base.address));
544
545
    return;
  } else {
546
547
    for ( ; pend->next; pend = pend->next) {
      if (pend->next->conn == conn) {
548
549
        victim = pend->next;
        pend->next = victim->next;
550
        tor_free(victim);
551
        log_debug(LD_EXIT,
552
                  "Connection (fd %d) no longer waiting for resolve of %s",
553
                  conn->_base.s, escaped_safe_str(conn->_base.address));
554
555
556
        return; /* more are pending */
      }
    }
Roger Dingledine's avatar
Roger Dingledine committed
557
    tor_assert(0); /* not reachable unless onlyconn not in pending list */
558
559
560
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
561
562
563
/** 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.
564
 */
565
void
566
dns_cancel_pending_resolve(char *address) //XXXX NM CHECKME.
567
{
568
569
  pending_connection_t *pend;
  cached_resolve_t search;
570
  cached_resolve_t *resolve, *tmp;
571
  edge_connection_t *pendconn;
572
  circuit_t *circ;
573

Nick Mathewson's avatar
Nick Mathewson committed
574
  strlcpy(search.address, address, sizeof(search.address));
575

576
  resolve = HT_FIND(cache_map, &cache_root, &search);
577
  if (!resolve || resolve->state != CACHE_STATE_PENDING) {
578
579
    log_notice(LD_BUG,"Address %s is not pending. Dropping.",
               escaped_safe_str(address));
580
581
582
    return;
  }

583
584
  if (!resolve->pending_connections) {
    /* XXX this should never trigger, but sometimes it does */
585
    log_warn(LD_BUG,
586
587
             "Bug: Address %s is pending but has no pending connections!",
             escaped_safe_str(address));
588
    tor_fragile_assert();
589
590
    return;
  }
Roger Dingledine's avatar
Roger Dingledine committed
591
  tor_assert(resolve->pending_connections);
592
  tor_assert(! resolve->expire);
593

594
  /* mark all pending connections to fail */
595
  log_debug(LD_EXIT,
596
597
             "Failing all connections waiting on DNS resolve of %s",
             escaped_safe_str(address));
598
  while (resolve->pending_connections) {
599
    pend = resolve->pending_connections;
600
    pend->conn->_base.state = EXIT_CONN_STATE_RESOLVEFAILED;
601
    pendconn = pend->conn;
602
603
604
    assert_connection_ok(TO_CONN(pendconn), 0);
    tor_assert(pendconn->_base.s == -1);
    if (!pendconn->_base.marked_for_close) {
605
606
      connection_edge_end(pendconn, END_STREAM_REASON_RESOURCELIMIT,
                          pendconn->cpath_layer);
607
    }
608
    circ = circuit_get_by_edge_conn(pendconn);
609
610
    if (circ)
      circuit_detach_stream(circ, pendconn);
611
    connection_free(TO_CONN(pendconn));
612
613
    resolve->pending_connections = pend->next;
    tor_free(pend);
614
615
  }

Nick Mathewson's avatar
Nick Mathewson committed
616
  tmp = HT_REMOVE(cache_map, &cache_root, resolve);
617
618
619
620
621
622
  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).",
            resolve->address, resolve,
            tmp ? tmp->address : "NULL", tmp);
  }
Nick Mathewson's avatar
Nick Mathewson committed
623
  tor_assert(tmp == resolve);
624
  resolve->magic = 0xABABABAB;
625
  tor_free(resolve);
626
627
}

628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
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
648
/** Called on the OR side when a DNS worker tells us the outcome of a DNS
649
 * resolve: tell all pending connections about the result of the lookup, and
Nick Mathewson's avatar
Nick Mathewson committed
650
651
652
653
 * 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}.
654
 */
655
static void
656
657
dns_found_answer(const char *address, uint32_t addr, char outcome,
                 uint32_t ttl)
658
{
659
660
  pending_connection_t *pend;
  cached_resolve_t search;
661
  cached_resolve_t *resolve, *removed;
662
  edge_connection_t *pendconn;
663
  circuit_t *circ;
664

665
666
  assert_cache_ok();

Nick Mathewson's avatar
Nick Mathewson committed
667
  strlcpy(search.address, address, sizeof(search.address));
668

669
  resolve = HT_FIND(cache_map, &cache_root, &search);
670
  if (!resolve) {
671
672
    log_info(LD_EXIT,"Resolved unasked address %s; caching anyway.",
             escaped_safe_str(address));
673
    add_answer_to_cache(address, addr, outcome, ttl);
674
    return;
675
  }
676
  assert_resolve_ok(resolve);
677

678
  if (resolve->state != CACHE_STATE_PENDING) {
679
680
    /* XXXX Maybe update addr? or check addr for consistency? Or let
     * VALID replace FAILED? */
681
682
    log_notice(LD_EXIT, "Resolved %s which was already resolved; ignoring",
               escaped_safe_str(address));
Roger Dingledine's avatar
Roger Dingledine committed
683
    tor_assert(resolve->pending_connections == NULL);
684
685
686
687
688
689
    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
690
  /* tor_assert(resolve->state == CACHE_STATE_PENDING); */
691

692
  while (resolve->pending_connections) {
693
    pend = resolve->pending_connections;
694
695
    pendconn = pend->conn; /* don't pass complex things to the
                              connection_mark_for_close macro */
696
    assert_connection_ok(TO_CONN(pendconn),time(NULL));
697
698
    pendconn->_base.addr = addr;
    pendconn->address_ttl = ttl;
699

700
    if (outcome != DNS_RESOLVE_SUCCEEDED) {
701
      /* prevent double-remove. */
702
703
      pendconn->_base.state = EXIT_CONN_STATE_RESOLVEFAILED;
      if (pendconn->_base.purpose == EXIT_PURPOSE_CONNECT) {
704
705
        connection_edge_end(pendconn, END_STREAM_REASON_RESOLVEFAILED,
                            pendconn->cpath_layer);
706
        /* This detach must happen after we send the end cell. */
707
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
708
      } else {
709
        send_resolved_cell(pendconn, RESOLVED_TYPE_ERROR);
710
        /* This detach must happen after we send the resolved cell. */
711
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
712
      }
713
      connection_free(TO_CONN(pendconn));
Roger Dingledine's avatar
Roger Dingledine committed
714
    } else {
715
      if (pendconn->_base.purpose == EXIT_PURPOSE_CONNECT) {
716
        /* prevent double-remove. */
717
        pend->conn->_base.state = EXIT_CONN_STATE_CONNECTING;
718

719
        circ = circuit_get_by_edge_conn(pend->conn);
720
        tor_assert(circ);
721
        tor_assert(!CIRCUIT_IS_ORIGIN(circ));
722
723
724
        /* unlink pend->conn from resolving_streams, */
        circuit_detach_stream(circ, pend->conn);
        /* and link it to n_streams */
725
        pend->conn->next_stream = TO_OR_CIRCUIT(circ)->n_streams;
726
        pend->conn->on_circuit = circ;
727
        TO_OR_CIRCUIT(circ)->n_streams = pend->conn;
728
729
730
731
732

        connection_exit_connect(pend->conn);
      } else {
        /* prevent double-remove.  This isn't really an accurate state,
         * but it does the right thing. */
733
        pendconn->_base.state = EXIT_CONN_STATE_RESOLVEFAILED;
734
        send_resolved_cell(pendconn, RESOLVED_TYPE_IPV4);
735
        circ = circuit_get_by_edge_conn(pendconn);
736
737
        tor_assert(circ);
        circuit_detach_stream(circ, pendconn);
738
        connection_free(TO_CONN(pendconn));
739
      }
Roger Dingledine's avatar
Roger Dingledine committed
740
    }
741
742
    resolve->pending_connections = pend->next;
    tor_free(pend);
743
  }
744

745
746
747
748
749
750
751
  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).",
            resolve->address, resolve,
            removed ? removed->address : "NULL", removed);
752
  }
753
754
  assert_resolve_ok(resolve);
  assert_cache_ok();
755

756
  add_answer_to_cache(address, addr, outcome, ttl);
757
  assert_cache_ok();
758
759
}

760
761
762
763
764
#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
765
assign_to_dnsworker(edge_connection_t *exitconn)
766
767
768
769
{
  connection_t *dnsconn;
  unsigned char len;

770
771
772
  tor_assert(exitconn->_base.state == EXIT_CONN_STATE_RESOLVING);
  assert_connection_ok(TO_CONN(exitconn), 0);
  tor_assert(exitconn->_base.s == -1);
773
774
775
776
777
778
779
780
781
782
783

  /* 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.");
784
    if (exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE)
785
      send_resolved_cell(exitconn, RESOLVED_TYPE_ERROR_TRANSIENT);
786
787
788
789
790
    goto err;
  }

  log_debug(LD_EXIT,
            "Connection (fd %d) needs to resolve %s; assigning "
791
792
            "to DNSWorker (fd %d)", exitconn->_base.s,
            escaped_safe_str(exitconn->_base.address), dnsconn->s);
793
794

  tor_free(dnsconn->address);
795
  dnsconn->address = tor_strdup(exitconn->_base.address);
796
  dnsconn->state = DNSWORKER_STATE_BUSY;
797
798
799
800
  /* touch the lastwritten timestamp, since that's how we check to
   * see how long it's been since we asked the question, and sometimes
   * we check before the first call to connection_handle_write(). */
  dnsconn->timestamp_lastwritten = time(NULL);
801
802
803
804
805
806
807
808
  num_dnsworkers_busy++;

  len = strlen(dnsconn->address);
  connection_write_to_buf((char*)&len, 1, dnsconn);
  connection_write_to_buf(dnsconn->address, len, dnsconn);

  return 0;
err:
809
810
  /* also sends end and frees */
  dns_cancel_pending_resolve(exitconn->_base.address);
811
812
813
  return -1;
}

814
815
/******************************************************************/

Nick Mathewson's avatar
Nick Mathewson committed
816
/*
817
 * Connection between OR and dnsworker
Nick Mathewson's avatar
Nick Mathewson committed
818
 */
819

Roger Dingledine's avatar
Roger Dingledine committed
820
/** Write handler: called when we've pushed a request to a dnsworker. */
821
822
823
int
connection_dns_finished_flushing(connection_t *conn)
{
824
825
  tor_assert(conn);
  tor_assert(conn->type == CONN_TYPE_DNSWORKER);
826
827
828
829
  connection_stop_writing(conn);
  return 0;
}

830
831
832
int
connection_dns_reached_eof(connection_t *conn)
{
833
  log_warn(LD_EXIT,"Read eof. Worker died unexpectedly.");
834
  if (conn->state == DNSWORKER_STATE_BUSY) {
835
836
837
838
    /* don't cancel the resolve here -- it would be cancelled in
     * connection_about_to_close_connection(), since conn is still
     * in state BUSY
     */
839
840
841
842
843
844
845
846
    num_dnsworkers_busy--;
  }
  num_dnsworkers--;
  connection_mark_for_close(conn);
  return 0;
}

/** Read handler: called when we get data from a dnsworker. See
847
848
 * if we have a complete answer.  If so, call dns_found_answer on the
 * result.  If not, wait.  Returns 0. */
849
850
851
int
connection_dns_process_inbuf(connection_t *conn)
{
852
  char success;
853
  uint32_t addr;
854
  int ttl;
855

856
857
  tor_assert(conn);
  tor_assert(conn->type == CONN_TYPE_DNSWORKER);
858

859
  if (conn->state != DNSWORKER_STATE_BUSY && buf_datalen(conn->inbuf)) {
Roger Dingledine's avatar