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

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

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

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

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

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

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

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

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

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

62
63
#define CACHED_RESOLVE_MAGIC 0x1234F00D

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

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

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

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

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

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

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

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

Roger Dingledine's avatar
Roger Dingledine committed
157
/** Initialize the DNS subsystem; called by the OR process. */
158
159
160
void
dns_init(void)
{
161
  init_cache_map();
162
  dnsworkers_rotate();
163
#ifdef USE_EVENTDNS
164
165
  if (server_mode(get_options()))
    configure_nameservers();
166
#endif
167
}
168

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

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

204
205
206
/** 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. */
207
static int
208
_compare_cached_resolves_by_expiry(const void *_a, const void *_b)
209
{
210
  const cached_resolve_t *a = _a, *b = _b;
211
  return a->expire - b->expire;
212
213
}

214
215
/** Priority queue of cached_resolve_t objects to let us know when they
 * will expire. */
216
217
static smartlist_t *cached_resolve_pqueue = NULL;

218
219
/** Set an expiry time for a cached_resolve_t, and add it to the expiry
 * priority queue */
220
221
222
223
static void
set_expiry(cached_resolve_t *resolve, time_t expires)
{
  tor_assert(resolve && resolve->expire == 0);
224
225
  if (!cached_resolve_pqueue)
    cached_resolve_pqueue = smartlist_create();
226
227
228
229
230
231
  resolve->expire = expires;
  smartlist_pqueue_add(cached_resolve_pqueue,
                       _compare_cached_resolves_by_expiry,
                       resolve);
}

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

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

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

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

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

303
304
305
306
307
308
309
    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).",
310
311
                resolve->address, (void*)resolve,
                removed ? removed->address : "NULL", (void*)remove);
312
313
314
315
316
      }
      tor_assert(removed == resolve);
      resolve->magic = 0xF0BBF0BB;
      tor_free(resolve);
    } else {
317
      /* This should be in state DONE. Make sure it's not in the cache. */
318
319
      cached_resolve_t *tmp = HT_FIND(cache_map, &cache_root, resolve);
      tor_assert(tmp != resolve);
320
    }
321
  }
322

Nick Mathewson's avatar
Nick Mathewson committed
323
  assert_cache_ok();
324
325
}

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

  buf[0] = answer_type;
336
  ttl = dns_clip_ttl(conn->address_ttl);
337
338
339
340
341

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

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

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

389
390
  assert_cache_ok();

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

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

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

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

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

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

468
  log_debug(LD_EXIT,"Launching %s.",
469
            escaped_safe_str(exitconn->_base.address));
470
  assert_cache_ok();
471
  return launch_resolve(exitconn);
472
473
}

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

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

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

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

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

519
520
  tor_assert(conn->_base.type == CONN_TYPE_EXIT);
  tor_assert(conn->_base.state == EXIT_CONN_STATE_RESOLVING);
521

522
  strlcpy(search.address, conn->_base.address, sizeof(search.address));
523

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

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

  pend = resolve->pending_connections;

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

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

Nick Mathewson's avatar
Nick Mathewson committed
572
  strlcpy(search.address, address, sizeof(search.address));
573

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

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

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

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

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

663
664
  assert_cache_ok();

Nick Mathewson's avatar
Nick Mathewson committed
665
  strlcpy(search.address, address, sizeof(search.address));
666

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

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

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

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

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

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

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

754
  add_answer_to_cache(address, addr, outcome, ttl);
755
  assert_cache_ok();
756
757
}

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

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

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

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

  tor_free(dnsconn->address);
793
  dnsconn->address = tor_strdup(exitconn->_base.address);
794
  dnsconn->state = DNSWORKER_STATE_BUSY;
795
796
797
798
  /* 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);
799
800
801
802
803
804
805
806
  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:
807
808
  /* also sends end and frees */
  dns_cancel_pending_resolve(exitconn->_base.address);
809
810
811
  return -1;
}

812
813
/******************************************************************/

Nick Mathewson's avatar
Nick Mathewson committed
814
/*
Nick Mathewson's avatar