dns.c 41.3 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
/** How long will we wait for an answer from the resolver before we decide
 * that the resolver is wedged? */
41
42
#define RESOLVE_MAX_TIMEOUT 300

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

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

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

64
65
#define CACHED_RESOLVE_MAGIC 0x1234F00D

66
67
68
69
70
71
72
/* 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. */
73
#define CACHE_STATE_PENDING 0
74
75
76
/** 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. */
77
#define CACHE_STATE_DONE 1
78
79
/** We are caching an answer for this address. This should have no pending
 * connections, and should appear in the hash table. */
80
#define CACHE_STATE_CACHED_VALID 2
81
82
/** We are caching a failure for this address. This should have no pending
 * connections, and should appear in the hash table */
83
84
#define CACHE_STATE_CACHED_FAILED 3

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

101
static void purge_expired_resolves(uint32_t now);
102
static void dns_found_answer(const char *address, uint32_t addr, char outcome,
103
                             uint32_t ttl);
104
static void send_resolved_cell(edge_connection_t *conn, uint8_t answer_type);
105
static int launch_resolve(edge_connection_t *exitconn);
106
#ifndef USE_EVENTDNS
Nick Mathewson's avatar
Nick Mathewson committed
107
static int dnsworker_main(void *data);
108
static int spawn_dnsworker(void);
109
static int spawn_enough_dnsworkers(void);
110
#endif
111
112
static void assert_cache_ok(void);
static void assert_resolve_ok(cached_resolve_t *resolve);
113

114
115
/** Hash table of cached_resolve objects. */
static HT_HEAD(cache_map, cached_resolve_t) cache_root;
116

Roger Dingledine's avatar
Roger Dingledine committed
117
/** Function to compare hashed resolves on their addresses; used to
118
 * implement hash tables. */
119
120
static INLINE int
cached_resolves_eq(cached_resolve_t *a, cached_resolve_t *b)
121
{
122
  /* make this smarter one day? */
123
  assert_resolve_ok(a); // Not b; b may be just a search.
124
125
126
127
128
129
130
  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);
131
132
}

133
HT_PROTOTYPE(cache_map, cached_resolve_t, node, cached_resolve_hash,
134
             cached_resolves_eq);
135
HT_GENERATE(cache_map, cached_resolve_t, node, cached_resolve_hash,
136
            cached_resolves_eq, 0.6, malloc, realloc, free);
137

138
/** Initialize the DNS cache. */
139
static void
140
init_cache_map(void)
141
{
142
  HT_INIT(&cache_root);
143
144
}

145
146
147
148
#ifdef USE_EVENTDNS
static void
eventdns_log_cb(const char *msg)
{
149
150
151
152
153
  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
154
  log(LOG_INFO, LD_EXIT, "eventdns: %s", msg);
155
156
157
}
#endif

Roger Dingledine's avatar
Roger Dingledine committed
158
/** Initialize the DNS subsystem; called by the OR process. */
159
160
161
void
dns_init(void)
{
162

163
  init_cache_map();
164
  dnsworkers_rotate();
165
#ifdef USE_EVENTDNS
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
  {
    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");
    }
  }
185
#endif
186
}
187

188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
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;
}

210
/** Helper: free storage held by an entry in the DNS cache. */
211
static void
212
_free_cached_resolve(cached_resolve_t *r)
213
{
Nick Mathewson's avatar
Nick Mathewson committed
214
  while (r->pending_connections) {
215
    pending_connection_t *victim = r->pending_connections;
216
217
218
    r->pending_connections = victim->next;
    tor_free(victim);
  }
219
  r->magic = 0xFF00FF00;
220
221
222
  tor_free(r);
}

223
224
225
/** 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. */
226
static int
227
_compare_cached_resolves_by_expiry(const void *_a, const void *_b)
228
{
229
  const cached_resolve_t *a = _a, *b = _b;
230
231
232
233
234
235
236
237
  if (a->expire < b->expire)
    return -1;
  else if (a->expire == b->expire)
    return 0;
  else
    return 1;
}

238
239
/** Priority queue of cached_resolve_t objects to let us know when they
 * will expire. */
240
241
static smartlist_t *cached_resolve_pqueue = NULL;

242
243
/** Set an expiry time for a cached_resolve_t, and add it to the expiry
 * priority queue */
244
245
246
247
static void
set_expiry(cached_resolve_t *resolve, time_t expires)
{
  tor_assert(resolve && resolve->expire == 0);
248
249
  if (!cached_resolve_pqueue)
    cached_resolve_pqueue = smartlist_create();
250
251
252
253
254
255
  resolve->expire = expires;
  smartlist_pqueue_add(cached_resolve_pqueue,
                       _compare_cached_resolves_by_expiry,
                       resolve);
}

256
/** Free all storage held in the DNS cache */
257
258
259
void
dns_free_all(void)
{
260
  cached_resolve_t **ptr, **next, *item;
261
  for (ptr = HT_START(cache_map, &cache_root); ptr != NULL; ptr = next) {
262
    item = *ptr;
263
    next = HT_NEXT_RMV(cache_map, &cache_root, ptr);
264
    _free_cached_resolve(item);
265
  }
266
  HT_CLEAR(cache_map, &cache_root);
267
268
  smartlist_free(cached_resolve_pqueue);
  cached_resolve_pqueue = NULL;
269
270
}

Nick Mathewson's avatar
Nick Mathewson committed
271
/** Remove every cached_resolve whose <b>expire</b> time is before <b>now</b>
272
 * from the cache. */
273
274
275
static void
purge_expired_resolves(uint32_t now)
{
Nick Mathewson's avatar
Nick Mathewson committed
276
  cached_resolve_t *resolve, *removed;
277
  pending_connection_t *pend;
278
  edge_connection_t *pendconn;
279

Nick Mathewson's avatar
Nick Mathewson committed
280
  assert_cache_ok();
281
282
283
284
285
286
287
288
289
290
  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);

291
    if (resolve->state == CACHE_STATE_PENDING) {
292
      log_debug(LD_EXIT,
293
294
295
296
297
298
299
300
301
302
303
304
305
                "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);
306
    }
307

308
    if (resolve->pending_connections) {
309
      log_debug(LD_EXIT,
310
                "Closing pending connections on timed-out DNS resolve!");
311
      tor_fragile_assert();
312
313
314
315
      while (resolve->pending_connections) {
        pend = resolve->pending_connections;
        resolve->pending_connections = pend->next;
        /* Connections should only be pending if they have no socket. */
316
        tor_assert(pend->conn->_base.s == -1);
317
        pendconn = pend->conn;
318
        connection_edge_end(pendconn, END_STREAM_REASON_TIMEOUT,
319
                            pendconn->cpath_layer);
320
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
321
        connection_free(TO_CONN(pendconn));
322
323
        tor_free(pend);
      }
324
    }
325

326
327
328
329
330
331
332
333
334
335
336
337
338
339
    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 {
340
      /* This should be in state DONE. Make sure it's not in the cache. */
341
342
      cached_resolve_t *tmp = HT_FIND(cache_map, &cache_root, resolve);
      tor_assert(tmp != resolve);
343
    }
344
  }
345

Nick Mathewson's avatar
Nick Mathewson committed
346
  assert_cache_ok();
347
348
}

Roger Dingledine's avatar
Roger Dingledine committed
349
/** Send a response to the RESOLVE request of a connection. answer_type must
350
351
 *  be one of RESOLVED_TYPE_(IPV4|ERROR|ERROR_TRANSIENT) */
static void
352
send_resolved_cell(edge_connection_t *conn, uint8_t answer_type)
353
354
{
  char buf[RELAY_PAYLOAD_SIZE];
355
  size_t buflen;
356
  uint32_t ttl;
357
358

  buf[0] = answer_type;
359
  ttl = dns_clip_ttl(conn->address_ttl);
360
361
362
363
364

  switch (answer_type)
    {
    case RESOLVED_TYPE_IPV4:
      buf[1] = 4;
365
      set_uint32(buf+2, htonl(conn->_base.addr));
366
      set_uint32(buf+6, htonl(ttl));
367
      buflen = 10;
368
369
370
      break;
    case RESOLVED_TYPE_ERROR_TRANSIENT:
    case RESOLVED_TYPE_ERROR:
371
372
373
      {
        const char *errmsg = "Error resolving hostname";
        int msglen = strlen(errmsg);
374

375
376
        buf[1] = msglen;
        strlcpy(buf+2, errmsg, sizeof(buf)-2);
377
        set_uint32(buf+2+msglen, htonl(ttl));
378
379
380
        buflen = 6+msglen;
        break;
      }
381
382
383
    default:
      tor_assert(0);
    }
384
  connection_edge_send_command(conn, circuit_get_by_edge_conn(conn),
385
386
387
388
                               RELAY_COMMAND_RESOLVED, buf, buflen,
                               conn->cpath_layer);
}

Nick Mathewson's avatar
Nick Mathewson committed
389
390
/** 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.
391
 * If resolve failed, unlink exitconn if needed, free it, and return -1.
392
393
394
395
396
397
398
 *
 * 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.
 */
399
int
400
dns_resolve(edge_connection_t *exitconn)
401
{
402
403
404
  cached_resolve_t *resolve;
  cached_resolve_t search;
  pending_connection_t *pending_connection;
405
  struct in_addr in;
406
  circuit_t *circ;
407
  uint32_t now = time(NULL);
408
409
  assert_connection_ok(TO_CONN(exitconn), 0);
  tor_assert(exitconn->_base.s == -1);
410

411
412
  assert_cache_ok();

413
  /* first check if exitconn->_base.address is an IP. If so, we already
414
   * know the answer. */
415
416
  if (tor_inet_aton(exitconn->_base.address, &in) != 0) {
    exitconn->_base.addr = ntohl(in.s_addr);
417
    exitconn->address_ttl = DEFAULT_DNS_TTL;
418
    if (exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE)
419
      send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
420
    return 1;
421
422
423
  }

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

427
428
  /* lower-case exitconn->_base.address, so it's in canonical form */
  tor_strlower(exitconn->_base.address);
429

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

480
  /* add this connection to the pending list */
481
  pending_connection = tor_malloc_zero(sizeof(pending_connection_t));
Roger Dingledine's avatar
Roger Dingledine committed
482
483
  pending_connection->conn = exitconn;
  resolve->pending_connections = pending_connection;
484
  exitconn->_base.state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
Roger Dingledine committed
485

486
  /* Add this resolve to the cache and priority queue. */
487
  HT_INSERT(cache_map, &cache_root, resolve);
488
  set_expiry(resolve, now + RESOLVE_MAX_TIMEOUT);
489

490
  log_debug(LD_EXIT,"Launching %s.",
491
            escaped_safe_str(exitconn->_base.address));
492
  assert_cache_ok();
493
  return launch_resolve(exitconn);
494
495
}

496
/** Log an error and abort if conn is waiting for a DNS resolve.
497
 */
498
void
499
assert_connection_edge_not_dns_pending(edge_connection_t *conn)
500
{
501
502
  pending_connection_t *pend;
  cached_resolve_t **resolve;
503

504
505
506
507
508
509
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
      tor_assert(pend->conn != conn);
    }
510
  }
511
}
512

513
514
515
516
517
518
519
/** 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;
520

521
522
523
524
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
525
526
527
      assert_connection_ok(TO_CONN(pend->conn), 0);
      tor_assert(pend->conn->_base.s == -1);
      tor_assert(!connection_in_array(TO_CONN(pend->conn)));
528
    }
529
530
531
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
532
/** Remove <b>conn</b> from the list of connections waiting for conn-\>address.
533
 */
534
void
535
connection_dns_remove(edge_connection_t *conn)
536
{
537
538
539
  pending_connection_t *pend, *victim;
  cached_resolve_t search;
  cached_resolve_t *resolve;
540

541
542
  tor_assert(conn->_base.type == CONN_TYPE_EXIT);
  tor_assert(conn->_base.state == EXIT_CONN_STATE_RESOLVING);
543

544
  strlcpy(search.address, conn->_base.address, sizeof(search.address));
545

546
  resolve = HT_FIND(cache_map, &cache_root, &search);
547
  if (!resolve) {
548
    log_notice(LD_BUG, "Address %s is not pending. Dropping.",
549
               escaped_safe_str(conn->_base.address));
550
551
552
    return;
  }

Roger Dingledine's avatar
Roger Dingledine committed
553
  tor_assert(resolve->pending_connections);
554
  assert_connection_ok(TO_CONN(conn),0);
555
556
557

  pend = resolve->pending_connections;

558
  if (pend->conn == conn) {
559
    resolve->pending_connections = pend->next;
560
    tor_free(pend);
561
    log_debug(LD_EXIT, "First connection (fd %d) no longer waiting "
562
              "for resolve of %s",
563
              conn->_base.s, escaped_safe_str(conn->_base.address));
564
565
    return;
  } else {
566
567
    for ( ; pend->next; pend = pend->next) {
      if (pend->next->conn == conn) {
568
569
        victim = pend->next;
        pend->next = victim->next;
570
        tor_free(victim);
571
        log_debug(LD_EXIT,
572
                  "Connection (fd %d) no longer waiting for resolve of %s",
573
                  conn->_base.s, escaped_safe_str(conn->_base.address));
574
575
576
        return; /* more are pending */
      }
    }
Roger Dingledine's avatar
Roger Dingledine committed
577
    tor_assert(0); /* not reachable unless onlyconn not in pending list */
578
579
580
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
581
582
583
/** 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.
584
 */
585
void
586
dns_cancel_pending_resolve(char *address) //XXXX NM CHECKME.
587
{
588
589
  pending_connection_t *pend;
  cached_resolve_t search;
590
  cached_resolve_t *resolve, *tmp;
591
  edge_connection_t *pendconn;
592
  circuit_t *circ;
593

Nick Mathewson's avatar
Nick Mathewson committed
594
  strlcpy(search.address, address, sizeof(search.address));
595

596
  resolve = HT_FIND(cache_map, &cache_root, &search);
597
  if (!resolve || resolve->state != CACHE_STATE_PENDING) {
598
599
    log_notice(LD_BUG,"Address %s is not pending. Dropping.",
               escaped_safe_str(address));
600
601
602
    return;
  }

603
604
  if (!resolve->pending_connections) {
    /* XXX this should never trigger, but sometimes it does */
605
    log_warn(LD_BUG,
606
607
             "Bug: Address %s is pending but has no pending connections!",
             escaped_safe_str(address));
608
    tor_fragile_assert();
609
610
    return;
  }
Roger Dingledine's avatar
Roger Dingledine committed
611
  tor_assert(resolve->pending_connections);
612
  tor_assert(! resolve->expire);
613

614
  /* mark all pending connections to fail */
615
  log_debug(LD_EXIT,
616
617
             "Failing all connections waiting on DNS resolve of %s",
             escaped_safe_str(address));
618
  while (resolve->pending_connections) {
619
    pend = resolve->pending_connections;
620
    pend->conn->_base.state = EXIT_CONN_STATE_RESOLVEFAILED;
621
    pendconn = pend->conn;
622
623
624
    assert_connection_ok(TO_CONN(pendconn), 0);
    tor_assert(pendconn->_base.s == -1);
    if (!pendconn->_base.marked_for_close) {
625
626
      connection_edge_end(pendconn, END_STREAM_REASON_RESOURCELIMIT,
                          pendconn->cpath_layer);
627
    }
628
    circ = circuit_get_by_edge_conn(pendconn);
629
630
    if (circ)
      circuit_detach_stream(circ, pendconn);
631
    connection_free(TO_CONN(pendconn));
632
633
    resolve->pending_connections = pend->next;
    tor_free(pend);
634
635
  }

Nick Mathewson's avatar
Nick Mathewson committed
636
  tmp = HT_REMOVE(cache_map, &cache_root, resolve);
637
638
639
640
641
642
  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
643
  tor_assert(tmp == resolve);
644
  resolve->magic = 0xABABABAB;
645
  tor_free(resolve);
646
647
}

648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
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
668
/** Called on the OR side when a DNS worker tells us the outcome of a DNS
669
 * resolve: tell all pending connections about the result of the lookup, and
Nick Mathewson's avatar
Nick Mathewson committed
670
671
672
673
 * 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}.
674
 */
675
static void
676
677
dns_found_answer(const char *address, uint32_t addr, char outcome,
                 uint32_t ttl)
678
{
679
680
  pending_connection_t *pend;
  cached_resolve_t search;
681
  cached_resolve_t *resolve, *removed;
682
  edge_connection_t *pendconn;
683
  circuit_t *circ;
684

685
686
  assert_cache_ok();

Nick Mathewson's avatar
Nick Mathewson committed
687
  strlcpy(search.address, address, sizeof(search.address));
688

689
  resolve = HT_FIND(cache_map, &cache_root, &search);
690
  if (!resolve) {
691
692
    log_info(LD_EXIT,"Resolved unasked address %s; caching anyway.",
             escaped_safe_str(address));
693
    add_answer_to_cache(address, addr, outcome, ttl);
694
    return;
695
  }
696
  assert_resolve_ok(resolve);
697

698
  if (resolve->state != CACHE_STATE_PENDING) {
699
700
    /* XXXX Maybe update addr? or check addr for consistency? Or let
     * VALID replace FAILED? */
701
702
    log_notice(LD_EXIT, "Resolved %s which was already resolved; ignoring",
               escaped_safe_str(address));
Roger Dingledine's avatar
Roger Dingledine committed
703
    tor_assert(resolve->pending_connections == NULL);
704
705
706
707
708
709
    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
710
  /* tor_assert(resolve->state == CACHE_STATE_PENDING); */
711

712
  while (resolve->pending_connections) {
713
    pend = resolve->pending_connections;
714
715
    pendconn = pend->conn; /* don't pass complex things to the
                              connection_mark_for_close macro */
716
    assert_connection_ok(TO_CONN(pendconn),time(NULL));
717
718
    pendconn->_base.addr = addr;
    pendconn->address_ttl = ttl;
719

720
    if (outcome != DNS_RESOLVE_SUCCEEDED) {
721
      /* prevent double-remove. */
722
723
      pendconn->_base.state = EXIT_CONN_STATE_RESOLVEFAILED;
      if (pendconn->_base.purpose == EXIT_PURPOSE_CONNECT) {
724
725
        connection_edge_end(pendconn, END_STREAM_REASON_RESOLVEFAILED,
                            pendconn->cpath_layer);
726
        /* This detach must happen after we send the end cell. */
727
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
728
      } else {
729
        send_resolved_cell(pendconn, RESOLVED_TYPE_ERROR);
730
        /* This detach must happen after we send the resolved cell. */
731
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
732
      }
733
      connection_free(TO_CONN(pendconn));
Roger Dingledine's avatar
Roger Dingledine committed
734
    } else {
735
      if (pendconn->_base.purpose == EXIT_PURPOSE_CONNECT) {
736
        /* prevent double-remove. */
737
        pend->conn->_base.state = EXIT_CONN_STATE_CONNECTING;
738

739
        circ = circuit_get_by_edge_conn(pend->conn);
740
        tor_assert(circ);
741
        tor_assert(!CIRCUIT_IS_ORIGIN(circ));
742
743
744
        /* unlink pend->conn from resolving_streams, */
        circuit_detach_stream(circ, pend->conn);
        /* and link it to n_streams */
745
        pend->conn->next_stream = TO_OR_CIRCUIT(circ)->n_streams;
746
        pend->conn->on_circuit = circ;
747
        TO_OR_CIRCUIT(circ)->n_streams = pend->conn;
748
749
750
751
752

        connection_exit_connect(pend->conn);
      } else {
        /* prevent double-remove.  This isn't really an accurate state,
         * but it does the right thing. */
753
        pendconn->_base.state = EXIT_CONN_STATE_RESOLVEFAILED;
754
        send_resolved_cell(pendconn, RESOLVED_TYPE_IPV4);
755
        circ = circuit_get_by_edge_conn(pendconn);
756
757
        tor_assert(circ);
        circuit_detach_stream(circ, pendconn);
758
        connection_free(TO_CONN(pendconn));
759
      }
Roger Dingledine's avatar
Roger Dingledine committed
760
    }
761
762
    resolve->pending_connections = pend->next;
    tor_free(pend);
763
  }
764

765
766
767
768
769
770
771
  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);
772
  }
773
774
  assert_resolve_ok(resolve);
  assert_cache_ok();
775

776
  add_answer_to_cache(address, addr, outcome, ttl);
777
  assert_cache_ok();
778
779
}

780
781
782
783
784
#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
785
launch_resolve(edge_connection_t *exitconn)
786
787
788
789
{
  connection_t *dnsconn;
  unsigned char len;

790
791
792
  tor_assert(exitconn->_base.state == EXIT_CONN_STATE_RESOLVING);
  assert_connection_ok(TO_CONN(exitconn), 0);
  tor_assert(exitconn->_base.s == -1);
793
794
795
796
797
798
799
800
801
802
803

  /* 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.");
804
    if (exitconn->_base.purpose == EXIT_PURPOSE_RESOLVE)
805
      send_resolved_cell(exitconn, RESOLVED_TYPE_ERROR_TRANSIENT);
806
807
808
809
810
    goto err;
  }

  log_debug(LD_EXIT,
            "Connection (fd %d) needs to resolve %s; assigning "
811
812
            "to DNSWorker (fd %d)", exitconn->_base.s,
            escaped_safe_str(exitconn->_base.address), dnsconn->s);
813
814

  tor_free(dnsconn->address);
815
  dnsconn->address = tor_strdup(exitconn->_base.address);
816
  dnsconn->state = DNSWORKER_STATE_BUSY;
817
818
819
820
  /* 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);
821
822
823
824
825
826
827
828
  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:
829
830
  /* also sends end and frees */
  dns_cancel_pending_resolve(exitconn->_base.address);
831
832
833
  return -1;
}

834
835
/******************************************************************/

Nick Mathewson's avatar
Nick Mathewson committed
836
/*
837
 * Connection between OR and dnsworker
Nick Mathewson's avatar
Nick Mathewson committed
838
 */
839

Roger Dingledine's avatar
Roger Dingledine committed
840
/** Write handler: called when we've pushed a request to a dnsworker. */
841
842
843
int
connection_dns_finished_flushing(connection_t *conn)
{
844
845
  tor_assert(conn);
  tor_assert