dns.c 38 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

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

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

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

60
61
#define CACHED_RESOLVE_MAGIC 0x1234F00D

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

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

94
95
/** Hash table of cached_resolve objects. */
static HT_HEAD(cache_map, cached_resolve_t) cache_root;
96

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

113
HT_PROTOTYPE(cache_map, cached_resolve_t, node, cached_resolve_hash,
114
             cached_resolves_eq);
115
HT_GENERATE(cache_map, cached_resolve_t, node, cached_resolve_hash,
116
            cached_resolves_eq, 0.6, malloc, realloc, free);
117

118
/** Initialize the DNS cache. */
119
static void
120
init_cache_map(void)
121
{
122
  HT_INIT(&cache_root);
123
124
}

125
126
127
128
#ifdef USE_EVENTDNS
static void
eventdns_log_cb(const char *msg)
{
129
130
131
132
133
  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
134
  log(LOG_INFO, LD_EXIT, "eventdns: %s", msg);
135
136
137
}
#endif

Roger Dingledine's avatar
Roger Dingledine committed
138
/** Initialize the DNS subsystem; called by the OR process. */
139
140
141
void
dns_init(void)
{
142

143
  init_cache_map();
144
  dnsworkers_rotate();
145
#ifdef USE_EVENTDNS
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
  {
    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");
    }
  }
165
#endif
166
}
167

168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
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;
}

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

203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
/** DODDOC */
static int
_compare_cached_resolves_by_expiry(void *_a, void *_b)
{
  cached_resolve_t *a = _a, *b = _b;
  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);
  resolve->expire = expires;
  smartlist_pqueue_add(cached_resolve_pqueue,
                       _compare_cached_resolves_by_expiry,
                       resolve);
}

229
/** Free all storage held in the DNS cache */
230
231
232
void
dns_free_all(void)
{
233
  cached_resolve_t **ptr, **next, *item;
234
  for (ptr = HT_START(cache_map, &cache_root); ptr != NULL; ptr = next) {
235
    item = *ptr;
236
    next = HT_NEXT_RMV(cache_map, &cache_root, ptr);
237
    _free_cached_resolve(item);
238
  }
239
  HT_CLEAR(cache_map, &cache_root);
240
241
  smartlist_free(cached_resolve_pqueue);
  cached_resolve_pqueue = NULL;
242
243
}

244

245

Nick Mathewson's avatar
Nick Mathewson committed
246
/** Remove every cached_resolve whose <b>expire</b> time is before <b>now</b>
247
 * from the cache. */
248
249
250
static void
purge_expired_resolves(uint32_t now)
{
Nick Mathewson's avatar
Nick Mathewson committed
251
  cached_resolve_t *resolve, *removed;
252
  pending_connection_t *pend;
253
  edge_connection_t *pendconn;
254

Nick Mathewson's avatar
Nick Mathewson committed
255
  assert_cache_ok();
256
257
258
259
260
261
262
263
264
265
  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);

266
267
    log_debug(LD_EXIT,
              "Forgetting old cached resolve (address %s, expires %lu)",
268
269
              escaped_safe_str(resolve->address),
              (unsigned long)resolve->expire);
270
    if (resolve->state == CACHE_STATE_PENDING) {
271
      log_debug(LD_EXIT,
272
273
                "Bug: Expiring a dns resolve %s that's still pending."
                " Forgot to cull it?", escaped_safe_str(resolve->address));
274
      tor_fragile_assert();
275
    }
276

277
    if (resolve->pending_connections) {
278
279
      log_debug(LD_EXIT,
                "Closing pending connections on expiring DNS resolve!");
280
      tor_fragile_assert();
281
282
283
284
      while (resolve->pending_connections) {
        pend = resolve->pending_connections;
        resolve->pending_connections = pend->next;
        /* Connections should only be pending if they have no socket. */
285
        tor_assert(pend->conn->_base.s == -1);
286
        pendconn = pend->conn;
287
        connection_edge_end(pendconn, END_STREAM_REASON_TIMEOUT,
288
                            pendconn->cpath_layer);
289
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
290
        connection_free(TO_CONN(pendconn));
291
292
        tor_free(pend);
      }
293
    }
294

Nick Mathewson's avatar
Nick Mathewson committed
295
    removed = HT_REMOVE(cache_map, &cache_root, resolve);
296
    if (removed != resolve) {
297
      log_err(LD_BUG, "The expired resolve we purged didn't match any in"
Nick Mathewson's avatar
   
Nick Mathewson committed
298
299
300
              " the cache. Tried to purge %s (%p); instead got %s (%p.",
              resolve->address, resolve,
              removed ? removed->address : "NULL", remove);
301
    }
302
    tor_assert(removed == resolve);
303
    resolve->magic = 0xF0BBF0BB;
304
    tor_free(resolve);
305
  }
306

Nick Mathewson's avatar
Nick Mathewson committed
307
  assert_cache_ok();
308
309
}

Roger Dingledine's avatar
Roger Dingledine committed
310
/** Send a response to the RESOLVE request of a connection. answer_type must
311
312
 *  be one of RESOLVED_TYPE_(IPV4|ERROR|ERROR_TRANSIENT) */
static void
313
send_resolved_cell(edge_connection_t *conn, uint8_t answer_type)
314
315
{
  char buf[RELAY_PAYLOAD_SIZE];
316
  size_t buflen;
317
  uint32_t ttl;
318
319

  buf[0] = answer_type;
320
  ttl = dns_clip_ttl(conn->address_ttl);
321
322
323
324
325

  switch (answer_type)
    {
    case RESOLVED_TYPE_IPV4:
      buf[1] = 4;
326
      set_uint32(buf+2, htonl(conn->_base.addr));
327
      set_uint32(buf+6, htonl(ttl));
328
      buflen = 10;
329
330
331
      break;
    case RESOLVED_TYPE_ERROR_TRANSIENT:
    case RESOLVED_TYPE_ERROR:
332
333
334
      {
        const char *errmsg = "Error resolving hostname";
        int msglen = strlen(errmsg);
335

336
337
        buf[1] = msglen;
        strlcpy(buf+2, errmsg, sizeof(buf)-2);
338
        set_uint32(buf+2+msglen, htonl(ttl));
339
340
341
        buflen = 6+msglen;
        break;
      }
342
343
344
    default:
      tor_assert(0);
    }
345
  connection_edge_send_command(conn, circuit_get_by_edge_conn(conn),
346
347
348
349
                               RELAY_COMMAND_RESOLVED, buf, buflen,
                               conn->cpath_layer);
}

Nick Mathewson's avatar
Nick Mathewson committed
350
351
/** 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.
352
 * If resolve failed, unlink exitconn if needed, free it, and return -1.
353
354
355
356
357
358
359
 *
 * 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.
 */
360
int
361
dns_resolve(edge_connection_t *exitconn)
362
{
363
364
365
  cached_resolve_t *resolve;
  cached_resolve_t search;
  pending_connection_t *pending_connection;
366
  struct in_addr in;
367
  circuit_t *circ;
368
  uint32_t now = time(NULL);
369
370
  assert_connection_ok(TO_CONN(exitconn), 0);
  tor_assert(exitconn->_base.s == -1);
371

372
373
  assert_cache_ok();

374
  /* first check if exitconn->_base.address is an IP. If so, we already
375
   * know the answer. */
376
377
  if (tor_inet_aton(exitconn->_base.address, &in) != 0) {
    exitconn->_base.addr = ntohl(in.s_addr);
378
    exitconn->address_ttl = DEFAULT_DNS_TTL;
379
    if (exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE)
380
      send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
381
    return 1;
382
383
384
  }

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

388
389
  /* lower-case exitconn->_base.address, so it's in canonical form */
  tor_strlower(exitconn->_base.address);
390

391
  /* now check the hash table to see if 'address' is already there. */
392
  strlcpy(search.address, exitconn->_base.address, sizeof(search.address));
393
  resolve = HT_FIND(cache_map, &cache_root, &search);
394
  if (resolve && resolve->expire > now) { /* already there */
395
    switch (resolve->state) {
396
397
      case CACHE_STATE_PENDING:
        /* add us to the pending list */
398
        pending_connection = tor_malloc_zero(
399
                                      sizeof(pending_connection_t));
400
        pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
401
402
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
403
        log_debug(LD_EXIT,"Connection (fd %d) waiting for pending DNS "
404
405
                  "resolve of %s", exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
406
        exitconn->_base.state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
   
Roger Dingledine committed
407
        return 0;
408
      case CACHE_STATE_VALID:
409
        exitconn->_base.addr = resolve->addr;
410
        exitconn->address_ttl = resolve->ttl;
411
        log_debug(LD_EXIT,"Connection (fd %d) found cached answer for %s",
412
413
                  exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
414
        if (exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE)
415
          send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
416
        return 1;
417
      case CACHE_STATE_FAILED:
418
        log_debug(LD_EXIT,"Connection (fd %d) found cached error for %s",
419
420
                  exitconn->_base.s,
                  escaped_safe_str(exitconn->_base.address));
421
        if (exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE)
422
          send_resolved_cell(exitconn, RESOLVED_TYPE_ERROR);
423
        circ = circuit_get_by_edge_conn(exitconn);
424
425
        if (circ)
          circuit_detach_stream(circ, exitconn);
426
427
        if (!exitconn->_base.marked_for_close)
          connection_free(TO_CONN(exitconn));
428
429
        return -1;
    }
Roger Dingledine's avatar
Roger Dingledine committed
430
    tor_assert(0);
Roger Dingledine's avatar
Roger Dingledine committed
431
432
  }
  /* not there, need to add it */
433
  resolve = tor_malloc_zero(sizeof(cached_resolve_t));
434
  resolve->magic = CACHED_RESOLVE_MAGIC;
Roger Dingledine's avatar
Roger Dingledine committed
435
  resolve->state = CACHE_STATE_PENDING;
436
  strlcpy(resolve->address, exitconn->_base.address, sizeof(resolve->address));
Roger Dingledine's avatar
Roger Dingledine committed
437
438

  /* add us to the pending list */
439
  pending_connection = tor_malloc_zero(sizeof(pending_connection_t));
Roger Dingledine's avatar
Roger Dingledine committed
440
441
  pending_connection->conn = exitconn;
  resolve->pending_connections = pending_connection;
442
  exitconn->_base.state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
Roger Dingledine committed
443

444
445
446
447
  /* Add this resolve to the cache. It has no expiry yet, so it doesn't
   * go into the priority queue. */
  HT_INSERT(cache_map, &cache_root, resolve);

448
  log_debug(LD_EXIT,"Assigning question %s to dnsworker.",
449
            escaped_safe_str(exitconn->_base.address));
450
  assert_cache_ok();
Roger Dingledine's avatar
Roger Dingledine committed
451
  return assign_to_dnsworker(exitconn);
452
453
}

454
/** Log an error and abort if conn is waiting for a DNS resolve.
455
 */
456
void
457
assert_connection_edge_not_dns_pending(edge_connection_t *conn)
458
{
459
460
  pending_connection_t *pend;
  cached_resolve_t **resolve;
461

462
463
464
465
466
467
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
      tor_assert(pend->conn != conn);
    }
468
  }
469
}
470

471
472
473
474
475
476
477
/** 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;
478

479
480
481
482
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
483
484
485
      assert_connection_ok(TO_CONN(pend->conn), 0);
      tor_assert(pend->conn->_base.s == -1);
      tor_assert(!connection_in_array(TO_CONN(pend->conn)));
486
    }
487
488
489
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
490
/** Remove <b>conn</b> from the list of connections waiting for conn-\>address.
491
 */
492
void
493
connection_dns_remove(edge_connection_t *conn)
494
{
495
496
497
  pending_connection_t *pend, *victim;
  cached_resolve_t search;
  cached_resolve_t *resolve;
498

499
500
  tor_assert(conn->_base.type == CONN_TYPE_EXIT);
  tor_assert(conn->_base.state == EXIT_CONN_STATE_RESOLVING);
501

502
  strlcpy(search.address, conn->_base.address, sizeof(search.address));
503

504
  resolve = HT_FIND(cache_map, &cache_root, &search);
505
  if (!resolve) {
506
    log_notice(LD_BUG, "Address %s is not pending. Dropping.",
507
               escaped_safe_str(conn->_base.address));
508
509
510
    return;
  }

Roger Dingledine's avatar
Roger Dingledine committed
511
  tor_assert(resolve->pending_connections);
512
  assert_connection_ok(TO_CONN(conn),0);
513
514
515

  pend = resolve->pending_connections;

516
  if (pend->conn == conn) {
517
    resolve->pending_connections = pend->next;
518
    tor_free(pend);
519
    log_debug(LD_EXIT, "First connection (fd %d) no longer waiting "
520
              "for resolve of %s",
521
              conn->_base.s, escaped_safe_str(conn->_base.address));
522
523
    return;
  } else {
524
525
    for ( ; pend->next; pend = pend->next) {
      if (pend->next->conn == conn) {
526
527
        victim = pend->next;
        pend->next = victim->next;
528
        tor_free(victim);
529
        log_debug(LD_EXIT,
530
                  "Connection (fd %d) no longer waiting for resolve of %s",
531
                  conn->_base.s, escaped_safe_str(conn->_base.address));
532
533
534
        return; /* more are pending */
      }
    }
Roger Dingledine's avatar
Roger Dingledine committed
535
    tor_assert(0); /* not reachable unless onlyconn not in pending list */
536
537
538
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
539
540
541
/** 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.
542
 */
543
544
545
void
dns_cancel_pending_resolve(char *address)
{
546
547
  pending_connection_t *pend;
  cached_resolve_t search;
548
  cached_resolve_t *resolve, *tmp;
549
  edge_connection_t *pendconn;
550
  circuit_t *circ;
551

Nick Mathewson's avatar
Nick Mathewson committed
552
  strlcpy(search.address, address, sizeof(search.address));
553

554
  resolve = HT_FIND(cache_map, &cache_root, &search);
555
  if (!resolve) {
556
557
    log_notice(LD_BUG,"Address %s is not pending. Dropping.",
               escaped_safe_str(address));
558
559
560
    return;
  }

561
562
  if (!resolve->pending_connections) {
    /* XXX this should never trigger, but sometimes it does */
563
    log_warn(LD_BUG,
564
565
             "Bug: Address %s is pending but has no pending connections!",
             escaped_safe_str(address));
566
    tor_fragile_assert();
567
568
    return;
  }
Roger Dingledine's avatar
Roger Dingledine committed
569
  tor_assert(resolve->pending_connections);
570
  tor_assert(! resolve->expire);
571

572
  /* mark all pending connections to fail */
573
  log_debug(LD_EXIT,
574
575
             "Failing all connections waiting on DNS resolve of %s",
             escaped_safe_str(address));
576
  while (resolve->pending_connections) {
577
    pend = resolve->pending_connections;
578
    pend->conn->_base.state = EXIT_CONN_STATE_RESOLVEFAILED;
579
    pendconn = pend->conn;
580
581
582
    assert_connection_ok(TO_CONN(pendconn), 0);
    tor_assert(pendconn->_base.s == -1);
    if (!pendconn->_base.marked_for_close) {
583
584
      connection_edge_end(pendconn, END_STREAM_REASON_RESOURCELIMIT,
                          pendconn->cpath_layer);
585
    }
586
    circ = circuit_get_by_edge_conn(pendconn);
587
588
    if (circ)
      circuit_detach_stream(circ, pendconn);
589
    connection_free(TO_CONN(pendconn));
590
591
    resolve->pending_connections = pend->next;
    tor_free(pend);
592
593
  }

Nick Mathewson's avatar
Nick Mathewson committed
594
595
  tmp = HT_REMOVE(cache_map, &cache_root, resolve);
  tor_assert(tmp == resolve);
596
  resolve->magic = 0xABABABAB;
597
  tor_free(resolve);
598
599
}

Roger Dingledine's avatar
Roger Dingledine committed
600
/** Called on the OR side when a DNS worker tells us the outcome of a DNS
601
 * resolve: tell all pending connections about the result of the lookup, and
Nick Mathewson's avatar
Nick Mathewson committed
602
603
604
605
 * 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}.
606
 */
607
static void
608
609
dns_found_answer(const char *address, uint32_t addr, char outcome,
                 uint32_t ttl)
610
{
611
612
613
  pending_connection_t *pend;
  cached_resolve_t search;
  cached_resolve_t *resolve;
614
  edge_connection_t *pendconn;
615
  circuit_t *circ;
616

617
618
  assert_cache_ok();

Nick Mathewson's avatar
Nick Mathewson committed
619
  strlcpy(search.address, address, sizeof(search.address));
620

621
  resolve = HT_FIND(cache_map, &cache_root, &search);
622
  if (!resolve) {
623
624
    log_info(LD_EXIT,"Resolved unasked address %s; caching anyway.",
             escaped_safe_str(address));
625
    resolve = tor_malloc_zero(sizeof(cached_resolve_t));
626
    resolve->magic = CACHED_RESOLVE_MAGIC;
627
628
    resolve->state = (outcome == DNS_RESOLVE_SUCCEEDED) ?
      CACHE_STATE_VALID : CACHE_STATE_FAILED;
629
    strlcpy(resolve->address, address, sizeof(resolve->address));
630
    resolve->addr = addr;
631
    resolve->ttl = ttl;
632
    assert_resolve_ok(resolve);
633
634
    HT_INSERT(cache_map, &cache_root, resolve);
    set_expiry(resolve, time(NULL) + dns_get_expiry_ttl(ttl));
635
    return;
636
  }
637
  assert_resolve_ok(resolve);
638

639
  if (resolve->state != CACHE_STATE_PENDING) {
640
641
    /* XXXX Maybe update addr? or check addr for consistency? Or let
     * VALID replace FAILED? */
642
643
    log_notice(LD_EXIT, "Resolved %s which was already resolved; ignoring",
               escaped_safe_str(address));
Roger Dingledine's avatar
Roger Dingledine committed
644
    tor_assert(resolve->pending_connections == NULL);
645
646
647
648
649
650
    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
651
  /* tor_assert(resolve->state == CACHE_STATE_PENDING); */
652

653
  resolve->addr = addr;
654
  resolve->ttl = ttl;
655
  if (outcome == DNS_RESOLVE_SUCCEEDED)
656
657
658
659
    resolve->state = CACHE_STATE_VALID;
  else
    resolve->state = CACHE_STATE_FAILED;

660
  while (resolve->pending_connections) {
661
    pend = resolve->pending_connections;
662
663
    pendconn = pend->conn; /* don't pass complex things to the
                              connection_mark_for_close macro */
664
665
666
    assert_connection_ok(TO_CONN(pendconn),time(NULL));
    pendconn->_base.addr = resolve->addr;
    pendconn->address_ttl = resolve->ttl;
667

668
    if (resolve->state == CACHE_STATE_FAILED) {
669
      /* prevent double-remove. */
670
671
      pendconn->_base.state = EXIT_CONN_STATE_RESOLVEFAILED;
      if (pendconn->_base.purpose == EXIT_PURPOSE_CONNECT) {
672
673
        connection_edge_end(pendconn, END_STREAM_REASON_RESOLVEFAILED,
                            pendconn->cpath_layer);
674
        /* This detach must happen after we send the end cell. */
675
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
676
      } else {
677
        send_resolved_cell(pendconn, RESOLVED_TYPE_ERROR);
678
        /* This detach must happen after we send the resolved cell. */
679
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
680
      }
681
      connection_free(TO_CONN(pendconn));
Roger Dingledine's avatar
Roger Dingledine committed
682
    } else {
683
      if (pendconn->_base.purpose == EXIT_PURPOSE_CONNECT) {
684
        /* prevent double-remove. */
685
        pend->conn->_base.state = EXIT_CONN_STATE_CONNECTING;
686

687
        circ = circuit_get_by_edge_conn(pend->conn);
688
        tor_assert(circ);
689
        tor_assert(!CIRCUIT_IS_ORIGIN(circ));
690
691
692
        /* unlink pend->conn from resolving_streams, */
        circuit_detach_stream(circ, pend->conn);
        /* and link it to n_streams */
693
        pend->conn->next_stream = TO_OR_CIRCUIT(circ)->n_streams;
694
        pend->conn->on_circuit = circ;
695
        TO_OR_CIRCUIT(circ)->n_streams = pend->conn;
696
697
698
699
700

        connection_exit_connect(pend->conn);
      } else {
        /* prevent double-remove.  This isn't really an accurate state,
         * but it does the right thing. */
701
        pendconn->_base.state = EXIT_CONN_STATE_RESOLVEFAILED;
702
        send_resolved_cell(pendconn, RESOLVED_TYPE_IPV4);
703
        circ = circuit_get_by_edge_conn(pendconn);
704
705
        tor_assert(circ);
        circuit_detach_stream(circ, pendconn);
706
        connection_free(TO_CONN(pendconn));
707
      }
Roger Dingledine's avatar
Roger Dingledine committed
708
    }
709
710
    resolve->pending_connections = pend->next;
    tor_free(pend);
711
  }
712
713
  assert_resolve_ok(resolve);
  assert_cache_ok();
714

715
  if (outcome == DNS_RESOLVE_FAILED_TRANSIENT) { /* remove from cache */
716
717
718
719
720
721
    cached_resolve_t *tmp = HT_REMOVE(cache_map, &cache_root, resolve);
    tor_assert(tmp == resolve);
    resolve->magic = 0xAAAAAAAA;
    tor_free(resolve);
  } else {
    set_expiry(resolve, time(NULL) + dns_get_expiry_ttl(ttl));
722
  }
723
724

  assert_cache_ok();
725
726
}

727
728
729
730
731
#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
732
assign_to_dnsworker(edge_connection_t *exitconn)
733
734
735
736
{
  connection_t *dnsconn;
  unsigned char len;

737
738
739
  tor_assert(exitconn->_base.state == EXIT_CONN_STATE_RESOLVING);
  assert_connection_ok(TO_CONN(exitconn), 0);
  tor_assert(exitconn->_base.s == -1);
740
741
742
743
744
745
746
747
748
749
750

  /* 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.");
751
    if (exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE)
752
      send_resolved_cell(exitconn, RESOLVED_TYPE_ERROR_TRANSIENT);
753
754
755
756
757
    goto err;
  }

  log_debug(LD_EXIT,
            "Connection (fd %d) needs to resolve %s; assigning "
758
759
            "to DNSWorker (fd %d)", exitconn->_base.s,
            escaped_safe_str(exitconn->_base.address), dnsconn->s);
760
761

  tor_free(dnsconn->address);
762
  dnsconn->address = tor_strdup(exitconn->_base.address);
763
  dnsconn->state = DNSWORKER_STATE_BUSY;
764
765
766
767
  /* 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);
768
769
770
771
772
773
774
775
  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:
776
777
  /* also sends end and frees */
  dns_cancel_pending_resolve(exitconn->_base.address);
778
779
780
  return -1;
}

781
782
/******************************************************************/

Nick Mathewson's avatar
Nick Mathewson committed
783
/*
784
 * Connection between OR and dnsworker
Nick Mathewson's avatar
Nick Mathewson committed
785
 */
786

Roger Dingledine's avatar
Roger Dingledine committed
787
/** Write handler: called when we've pushed a request to a dnsworker. */
788
789
790
int
connection_dns_finished_flushing(connection_t *conn)
{
791
792
  tor_assert(conn);
  tor_assert(conn->type == CONN_TYPE_DNSWORKER);
793
794
795
796
  connection_stop_writing(conn);
  return 0;
}

797
798
799
int
connection_dns_reached_eof(connection_t *conn)
{
800
  log_warn(LD_EXIT,"Read eof. Worker died unexpectedly.");
801
  if (conn->state == DNSWORKER_STATE_BUSY) {
802
803
804
805
    /* don't cancel the resolve here -- it would be cancelled in
     * connection_about_to_close_connection(), since conn is still
     * in state BUSY
     */
806
807
808
809
810
811
812
813
    num_dnsworkers_busy--;
  }
  num_dnsworkers--;
  connection_mark_for_close(conn);
  return 0;
}

/** Read handler: called when we get data from a dnsworker. See
814
815
 * if we have a complete answer.  If so, call dns_found_answer on the
 * result.  If not, wait.  Returns 0. */
816
817
818
int
connection_dns_process_inbuf(connection_t *conn)
{
819
  char success;
820
  uint32_t addr;
821
  int ttl;
822

823
824
  tor_assert(conn);
  tor_assert(conn->type == CONN_TYPE_DNSWORKER);
825

826
  if (conn->state != DNSWORKER_STATE_BUSY && buf_datalen(conn->inbuf)) {
827
828
    log_warn(LD_BUG,
             "Bug: read data (%d bytes) from an idle dns worker (fd %d, "
829
830
             "address %s). Please report.", (int)buf_datalen(conn->inbuf),
             conn->s, escaped_safe_str(conn->address));
831
    tor_fragile_assert();
832
833
834
835
836
837
838

    /* Pull it off the buffer anyway, or it will just stay there.
     * Keep pulling things off because sometimes we get several
     * answers at once (!). */
    while (buf_datalen(conn->inbuf)) {
      connection_fetch_from_buf(&success,1,conn);
      connection_fetch_from_buf((char *)&addr,sizeof(uint32_t),conn);
839
      log_warn(LD_EXIT,"Discarding idle dns answer (success %d, addr %d.)",