dns.c 37.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
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
56
typedef struct pending_connection_t {
  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
  uint32_t expire; /**< Remove items from cache after this time. */
77
  uint32_t ttl; /**< What TTL did the nameserver tell us? */
78
79
80
  pending_connection_t *pending_connections;
  struct cached_resolve_t *next;
} cached_resolve_t;
81

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

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

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

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

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

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

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

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

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

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

205
/** Free all storage held in the DNS cache */
206
207
208
void
dns_free_all(void)
{
209
  cached_resolve_t **ptr, **next, *item;
210
  for (ptr = HT_START(cache_map, &cache_root); ptr != NULL; ptr = next) {
211
    item = *ptr;
212
    next = HT_NEXT_RMV(cache_map, &cache_root, ptr);
213
    _free_cached_resolve(item);
214
  }
215
  HT_CLEAR(cache_map, &cache_root);
216
217
}

218
/** Linked list of resolved addresses, oldest to newest. */
219
220
static cached_resolve_t *oldest_cached_resolve = NULL;
static cached_resolve_t *newest_cached_resolve = NULL;
221

Nick Mathewson's avatar
Nick Mathewson committed
222
/** Remove every cached_resolve whose <b>expire</b> time is before <b>now</b>
223
 * from the cache. */
224
225
226
static void
purge_expired_resolves(uint32_t now)
{
227
228
  cached_resolve_t *resolve;
  pending_connection_t *pend;
229
  connection_t *pendconn;
230
231
232
233

  /* this is fast because the linked list
   * oldest_cached_resolve is ordered by when they came in.
   */
234
  while (oldest_cached_resolve && (oldest_cached_resolve->expire < now)) {
235
    resolve = oldest_cached_resolve;
236
237
    log_debug(LD_EXIT,
              "Forgetting old cached resolve (address %s, expires %lu)",
238
239
              escaped_safe_str(resolve->address),
              (unsigned long)resolve->expire);
240
    if (resolve->state == CACHE_STATE_PENDING) {
241
      log_debug(LD_EXIT,
242
243
                "Bug: Expiring a dns resolve %s that's still pending."
                " Forgot to cull it?", escaped_safe_str(resolve->address));
244
      tor_fragile_assert();
245
246
    }
    if (resolve->pending_connections) {
247
248
      log_debug(LD_EXIT,
                "Closing pending connections on expiring DNS resolve!");
249
      tor_fragile_assert();
250
251
252
253
254
255
      while (resolve->pending_connections) {
        pend = resolve->pending_connections;
        resolve->pending_connections = pend->next;
        /* Connections should only be pending if they have no socket. */
        tor_assert(pend->conn->s == -1);
        pendconn = pend->conn;
256
        connection_edge_end(pendconn, END_STREAM_REASON_TIMEOUT,
257
                            pendconn->cpath_layer);
258
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
259
260
261
        connection_free(pendconn);
        tor_free(pend);
      }
262
    }
263
    oldest_cached_resolve = resolve->next;
264
    if (!oldest_cached_resolve) /* if there are no more, */
265
266
      newest_cached_resolve = NULL; /* then make sure the list's tail knows
                                     * that too */
267
    HT_REMOVE(cache_map, &cache_root, resolve);
268
    resolve->magic = 0xF0BBF0BB;
269
    tor_free(resolve);
270
271
272
  }
}

273
274
275
/** Send a response to the RESOVLE request of a connection. answer_type must
 *  be one of RESOLVED_TYPE_(IPV4|ERROR|ERROR_TRANSIENT) */
static void
276
send_resolved_cell(connection_t *conn, uint8_t answer_type)
277
278
{
  char buf[RELAY_PAYLOAD_SIZE];
279
  size_t buflen;
280
  uint32_t ttl;
281
282

  buf[0] = answer_type;
283
  ttl = dns_clip_ttl(conn->address_ttl);
284
285
286
287
288
289

  switch (answer_type)
    {
    case RESOLVED_TYPE_IPV4:
      buf[1] = 4;
      set_uint32(buf+2, htonl(conn->addr));
290
      set_uint32(buf+6, htonl(ttl));
291
      buflen = 10;
292
293
294
      break;
    case RESOLVED_TYPE_ERROR_TRANSIENT:
    case RESOLVED_TYPE_ERROR:
295
296
297
      {
        const char *errmsg = "Error resolving hostname";
        int msglen = strlen(errmsg);
298

299
300
        buf[1] = msglen;
        strlcpy(buf+2, errmsg, sizeof(buf)-2);
301
        set_uint32(buf+2+msglen, htonl(ttl));
302
303
304
        buflen = 6+msglen;
        break;
      }
305
306
307
    default:
      tor_assert(0);
    }
308
  connection_edge_send_command(conn, circuit_get_by_edge_conn(conn),
309
310
311
312
                               RELAY_COMMAND_RESOLVED, buf, buflen,
                               conn->cpath_layer);
}

313
314
/** Link <b>r</b> into the hash table of address-to-result mappings, and add it
 * to the linked list of resolves-by-age. */
315
static void
316
insert_resolve(cached_resolve_t *r)
317
318
319
320
321
322
323
324
325
{
  /* add us to the linked list of resolves */
  if (!oldest_cached_resolve) {
    oldest_cached_resolve = r;
  } else {
    newest_cached_resolve->next = r;
  }
  newest_cached_resolve = r;

326
  HT_INSERT(cache_map, &cache_root, r);
327
328
}

Nick Mathewson's avatar
Nick Mathewson committed
329
330
/** 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.
331
 * If resolve failed, unlink exitconn if needed, free it, and return -1.
332
333
334
335
336
337
338
 *
 * 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.
 */
339
340
341
int
dns_resolve(connection_t *exitconn)
{
342
343
344
  cached_resolve_t *resolve;
  cached_resolve_t search;
  pending_connection_t *pending_connection;
345
  struct in_addr in;
346
  circuit_t *circ;
347
  uint32_t now = time(NULL);
348
  assert_connection_ok(exitconn, 0);
349
  tor_assert(exitconn->s == -1);
350

351
352
  assert_cache_ok();

353
354
355
356
  /* first check if exitconn->address is an IP. If so, we already
   * know the answer. */
  if (tor_inet_aton(exitconn->address, &in) != 0) {
    exitconn->addr = ntohl(in.s_addr);
357
    exitconn->address_ttl = DEFAULT_DNS_TTL;
358
    if (exitconn->purpose == EXIT_PURPOSE_RESOLVE)
359
      send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
360
    return 1;
361
362
363
  }

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

367
368
369
  /* lower-case exitconn->address, so it's in canonical form */
  tor_strlower(exitconn->address);

370
  /* now check the hash table to see if 'address' is already there. */
Nick Mathewson's avatar
Nick Mathewson committed
371
  strlcpy(search.address, exitconn->address, sizeof(search.address));
372
  resolve = HT_FIND(cache_map, &cache_root, &search);
373
  if (resolve && resolve->expire > now) { /* already there */
374
    switch (resolve->state) {
375
376
      case CACHE_STATE_PENDING:
        /* add us to the pending list */
377
        pending_connection = tor_malloc_zero(
378
                                      sizeof(pending_connection_t));
379
        pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
380
381
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
382
        log_debug(LD_EXIT,"Connection (fd %d) waiting for pending DNS "
383
384
                  "resolve of %s",
                  exitconn->s, escaped_safe_str(exitconn->address));
385
        exitconn->state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
   
Roger Dingledine committed
386
        return 0;
387
      case CACHE_STATE_VALID:
388
        exitconn->addr = resolve->addr;
389
        exitconn->address_ttl = resolve->ttl;
390
391
        log_debug(LD_EXIT,"Connection (fd %d) found cached answer for %s",
                  exitconn->s, escaped_safe_str(exitconn->address));
392
        if (exitconn->purpose == EXIT_PURPOSE_RESOLVE)
393
          send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
394
        return 1;
395
      case CACHE_STATE_FAILED:
396
397
        log_debug(LD_EXIT,"Connection (fd %d) found cached error for %s",
                  exitconn->s, escaped_safe_str(exitconn->address));
398
        if (exitconn->purpose == EXIT_PURPOSE_RESOLVE)
399
          send_resolved_cell(exitconn, RESOLVED_TYPE_ERROR);
400
        circ = circuit_get_by_edge_conn(exitconn);
401
402
        if (circ)
          circuit_detach_stream(circ, exitconn);
403
404
        if (!exitconn->marked_for_close)
          connection_free(exitconn);
405
406
        return -1;
    }
Roger Dingledine's avatar
Roger Dingledine committed
407
    tor_assert(0);
Roger Dingledine's avatar
Roger Dingledine committed
408
409
  }
  /* not there, need to add it */
410
  resolve = tor_malloc_zero(sizeof(cached_resolve_t));
411
  resolve->magic = CACHED_RESOLVE_MAGIC;
Roger Dingledine's avatar
Roger Dingledine committed
412
  resolve->state = CACHE_STATE_PENDING;
413
  resolve->expire = now + DEFAULT_DNS_TTL; /* this will get replaced. */
Nick Mathewson's avatar
Nick Mathewson committed
414
  strlcpy(resolve->address, exitconn->address, sizeof(resolve->address));
Roger Dingledine's avatar
Roger Dingledine committed
415
416

  /* add us to the pending list */
417
  pending_connection = tor_malloc_zero(sizeof(pending_connection_t));
Roger Dingledine's avatar
Roger Dingledine committed
418
419
  pending_connection->conn = exitconn;
  resolve->pending_connections = pending_connection;
420
  exitconn->state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
Roger Dingledine committed
421

422
  insert_resolve(resolve);
423
424
  log_debug(LD_EXIT,"Assigning question %s to dnsworker.",
            escaped_safe_str(exitconn->address));
425
  assert_cache_ok();
Roger Dingledine's avatar
Roger Dingledine committed
426
  return assign_to_dnsworker(exitconn);
427
428
}

429
/** Log an error and abort if conn is waiting for a DNS resolve.
430
 */
431
432
void
assert_connection_edge_not_dns_pending(connection_t *conn)
433
{
434
435
  pending_connection_t *pend;
  cached_resolve_t **resolve;
436

437
438
439
440
441
442
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
      tor_assert(pend->conn != conn);
    }
443
  }
444
}
445

446
447
448
449
450
451
452
/** 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;
453

454
455
456
457
458
459
460
461
  HT_FOREACH(resolve, cache_map, &cache_root) {
    for (pend = (*resolve)->pending_connections;
         pend;
         pend = pend->next) {
      assert_connection_ok(pend->conn, 0);
      tor_assert(pend->conn->s == -1);
      tor_assert(!connection_in_array(pend->conn));
    }
462
463
464
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
465
/** Remove <b>conn</b> from the list of connections waiting for conn-\>address.
466
 */
467
468
void
connection_dns_remove(connection_t *conn)
469
{
470
471
472
  pending_connection_t *pend, *victim;
  cached_resolve_t search;
  cached_resolve_t *resolve;
473

474
475
476
  tor_assert(conn->type == CONN_TYPE_EXIT);
  tor_assert(conn->state == EXIT_CONN_STATE_RESOLVING);

Nick Mathewson's avatar
Nick Mathewson committed
477
  strlcpy(search.address, conn->address, sizeof(search.address));
478

479
  resolve = HT_FIND(cache_map, &cache_root, &search);
480
  if (!resolve) {
481
482
    log_notice(LD_BUG, "Address %s is not pending. Dropping.",
               escaped_safe_str(conn->address));
483
484
485
    return;
  }

Roger Dingledine's avatar
Roger Dingledine committed
486
  tor_assert(resolve->pending_connections);
487
488
489
490
  assert_connection_ok(conn,0);

  pend = resolve->pending_connections;

491
  if (pend->conn == conn) {
492
    resolve->pending_connections = pend->next;
493
    tor_free(pend);
494
    log_debug(LD_EXIT, "First connection (fd %d) no longer waiting "
495
496
              "for resolve of %s",
              conn->s, escaped_safe_str(conn->address));
497
498
    return;
  } else {
499
500
    for ( ; pend->next; pend = pend->next) {
      if (pend->next->conn == conn) {
501
502
        victim = pend->next;
        pend->next = victim->next;
503
        tor_free(victim);
504
        log_debug(LD_EXIT,
505
506
                  "Connection (fd %d) no longer waiting for resolve of %s",
                  conn->s, escaped_safe_str(conn->address));
507
508
509
        return; /* more are pending */
      }
    }
Roger Dingledine's avatar
Roger Dingledine committed
510
    tor_assert(0); /* not reachable unless onlyconn not in pending list */
511
512
513
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
514
515
516
/** 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.
517
 */
518
519
520
void
dns_cancel_pending_resolve(char *address)
{
521
522
523
  pending_connection_t *pend;
  cached_resolve_t search;
  cached_resolve_t *resolve;
524
  connection_t *pendconn;
525
  circuit_t *circ;
526

Nick Mathewson's avatar
Nick Mathewson committed
527
  strlcpy(search.address, address, sizeof(search.address));
528

529
  resolve = HT_FIND(cache_map, &cache_root, &search);
530
  if (!resolve) {
531
532
    log_notice(LD_BUG,"Address %s is not pending. Dropping.",
               escaped_safe_str(address));
533
534
535
    return;
  }

536
537
  if (!resolve->pending_connections) {
    /* XXX this should never trigger, but sometimes it does */
538
    log_warn(LD_BUG,
539
540
             "Bug: Address %s is pending but has no pending connections!",
             escaped_safe_str(address));
541
    tor_fragile_assert();
542
543
    return;
  }
Roger Dingledine's avatar
Roger Dingledine committed
544
  tor_assert(resolve->pending_connections);
545

546
  /* mark all pending connections to fail */
547
  log_debug(LD_EXIT,
548
549
             "Failing all connections waiting on DNS resolve of %s",
             escaped_safe_str(address));
550
  while (resolve->pending_connections) {
551
    pend = resolve->pending_connections;
552
    pend->conn->state = EXIT_CONN_STATE_RESOLVEFAILED;
553
    pendconn = pend->conn;
554
    assert_connection_ok(pendconn, 0);
555
    tor_assert(pendconn->s == -1);
556
    if (!pendconn->marked_for_close) {
557
558
      connection_edge_end(pendconn, END_STREAM_REASON_RESOURCELIMIT,
                          pendconn->cpath_layer);
559
    }
560
    circ = circuit_get_by_edge_conn(pendconn);
561
562
    if (circ)
      circuit_detach_stream(circ, pendconn);
563
    connection_free(pendconn);
564
565
    resolve->pending_connections = pend->next;
    tor_free(pend);
566
567
  }

568
569
570
  dns_purge_resolve(resolve);
}

Nick Mathewson's avatar
Nick Mathewson committed
571
/** Remove <b>resolve</b> from the cache.
572
 */
573
static void
574
dns_purge_resolve(cached_resolve_t *resolve)
575
{
576
  cached_resolve_t *tmp;
577

578
  /* remove resolve from the linked list */
579
  if (resolve == oldest_cached_resolve) {
580
    oldest_cached_resolve = resolve->next;
581
    if (oldest_cached_resolve == NULL)
582
      newest_cached_resolve = NULL;
583
  } else {
584
    /* FFFF make it a doubly linked list if this becomes too slow */
585
586
587
588
    for (tmp=oldest_cached_resolve; tmp && tmp->next != resolve; tmp=tmp->next)
      ;
    tor_assert(tmp); /* it's got to be in the list, or we screwed up somewhere
                      * else */
589
590
    tmp->next = resolve->next; /* unlink it */

591
    if (newest_cached_resolve == resolve)
592
      newest_cached_resolve = tmp;
593
  }
594

595
  /* remove resolve from the map */
596
  HT_REMOVE(cache_map, &cache_root, resolve);
597
  resolve->magic = 0xAAAAAAAA;
598
  tor_free(resolve);
599
600
}

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

618
619
  assert_cache_ok();

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

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

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

652
  resolve->addr = addr;
653
654
  resolve->expire = time(NULL) + dns_get_expiry_ttl(ttl);
  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
    assert_connection_ok(pend->conn,time(NULL));
663
    pend->conn->addr = resolve->addr;
664
    pend->conn->address_ttl = resolve->ttl;
665
666
    pendconn = pend->conn; /* don't pass complex things to the
                              connection_mark_for_close macro */
667

668
    if (resolve->state == CACHE_STATE_FAILED) {
669
      /* prevent double-remove. */
670
      pendconn->state = EXIT_CONN_STATE_RESOLVEFAILED;
671
      if (pendconn->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(pendconn);
Roger Dingledine's avatar
Roger Dingledine committed
682
    } else {
683
684
685
686
      if (pendconn->purpose == EXIT_PURPOSE_CONNECT) {
        /* prevent double-remove. */
        pend->conn->state = EXIT_CONN_STATE_CONNECTING;

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
701

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

713
  if (outcome == DNS_RESOLVE_FAILED_TRANSIENT) { /* remove from cache */
714
715
    dns_purge_resolve(resolve);
  }
716
717

  assert_cache_ok();
718
719
}

720
721
722
723
724
725
726
727
728
729
730
#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
assign_to_dnsworker(connection_t *exitconn)
{
  connection_t *dnsconn;
  unsigned char len;

  tor_assert(exitconn->state == EXIT_CONN_STATE_RESOLVING);
731
  assert_connection_ok(exitconn, 0);
732
733
734
735
736
737
738
739
740
741
742
743
744
  tor_assert(exitconn->s == -1);

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

  log_debug(LD_EXIT,
            "Connection (fd %d) needs to resolve %s; assigning "
            "to DNSWorker (fd %d)", exitconn->s,
            escaped_safe_str(exitconn->address), dnsconn->s);

  tor_free(dnsconn->address);
  dnsconn->address = tor_strdup(exitconn->address);
  dnsconn->state = DNSWORKER_STATE_BUSY;
757
758
759
760
  /* 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);
761
762
763
764
765
766
767
768
769
770
771
772
  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:
  dns_cancel_pending_resolve(exitconn->address); /* also sends end and frees */
  return -1;
}

773
774
/******************************************************************/

Nick Mathewson's avatar
Nick Mathewson committed
775
/*
776
 * Connection between OR and dnsworker
Nick Mathewson's avatar
Nick Mathewson committed
777
 */
778

Roger Dingledine's avatar
Roger Dingledine committed
779
/** Write handler: called when we've pushed a request to a dnsworker. */
780
781
782
int
connection_dns_finished_flushing(connection_t *conn)
{
783
784
  tor_assert(conn);
  tor_assert(conn->type == CONN_TYPE_DNSWORKER);
785
786
787
788
  connection_stop_writing(conn);
  return 0;
}

789
790
791
int
connection_dns_reached_eof(connection_t *conn)
{
792
  log_warn(LD_EXIT,"Read eof. Worker died unexpectedly.");
793
  if (conn->state == DNSWORKER_STATE_BUSY) {
794
795
796
797
    /* don't cancel the resolve here -- it would be cancelled in
     * connection_about_to_close_connection(), since conn is still
     * in state BUSY
     */
798
799
800
801
802
803
804
805
    num_dnsworkers_busy--;
  }
  num_dnsworkers--;
  connection_mark_for_close(conn);
  return 0;
}

/** Read handler: called when we get data from a dnsworker. See
806
807
 * if we have a complete answer.  If so, call dns_found_answer on the
 * result.  If not, wait.  Returns 0. */
808
809
810
int
connection_dns_process_inbuf(connection_t *conn)
{
811
  char success;
812
  uint32_t addr;
813
  int ttl;
814

815
816
  tor_assert(conn);
  tor_assert(conn->type == CONN_TYPE_DNSWORKER);
817

818
  if (conn->state != DNSWORKER_STATE_BUSY && buf_datalen(conn->inbuf)) {
819
820
    log_warn(LD_BUG,
             "Bug: read data (%d bytes) from an idle dns worker (fd %d, "
821
822
             "address %s). Please report.", (int)buf_datalen(conn->inbuf),
             conn->s, escaped_safe_str(conn->address));
823
    tor_fragile_assert();
824
825
826
827
828
829
830

    /* 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);
831
      log_warn(LD_EXIT,"Discarding idle dns answer (success %d, addr %d.)",
832
               success, addr);
833
    }
834
835
    return 0;
  }
836
  if (buf_datalen(conn->inbuf) < 5) /* entire answer available? */
837
    return 0; /* not yet */
838
  tor_assert(conn->state == DNSWORKER_STATE_BUSY);
Roger Dingledine's avatar
Roger Dingledine committed
839
  tor_assert(buf_datalen(conn->inbuf) == 5);
840

841
842
  connection_fetch_from_buf(&success,1,conn);
  connection_fetch_from_buf((char *)&addr,sizeof(uint32_t),conn);
843

844
845
  log_debug(LD_EXIT, "DNSWorker (fd %d) returned answer for %s",
            conn->s, escaped_safe_str(conn->address));
846

Roger Dingledine's avatar
Roger Dingledine committed
847
848
  tor_assert(success >= DNS_RESOLVE_FAILED_TRANSIENT);
  tor_assert(success <= DNS_RESOLVE_SUCCEEDED);
849
850
851

  ttl = (success == DNS_RESOLVE_FAILED_TRANSIENT) ? 0 : MAX_DNS_ENTRY_AGE;
  dns_found_answer(