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

Roger Dingledine's avatar
Roger Dingledine committed
7
8
/**
 * \file dns.c
9
10
11
12
 * \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
13
 **/
14

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

20
#include "or.h"
21
#include "tree.h"
22

Roger Dingledine's avatar
Roger Dingledine committed
23
/** Longest hostname we're willing to resolve. */
24
25
#define MAX_ADDRESSLEN 256

Roger Dingledine's avatar
Roger Dingledine committed
26
/** Maximum DNS processes to spawn. */
27
#define MAX_DNSWORKERS 100
Roger Dingledine's avatar
Roger Dingledine committed
28
/** Minimum DNS processes to spawn. */
29
#define MIN_DNSWORKERS 3
30

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

Roger Dingledine's avatar
Roger Dingledine committed
34
/** Possible outcomes from hostname lookup: permanent failure,
35
 * transient (retryable) failure, and success. */
36
37
38
39
#define DNS_RESOLVE_FAILED_TRANSIENT 1
#define DNS_RESOLVE_FAILED_PERMANENT 2
#define DNS_RESOLVE_SUCCEEDED 3

40
/** How many dnsworkers we have running right now. */
41
static int num_dnsworkers=0;
42
/** How many of the running dnsworkers have an assigned task right now. */
43
44
45
static int num_dnsworkers_busy=0;
/** When did we last rotate the dnsworkers? */
static time_t last_rotation_time=0;
46

Roger Dingledine's avatar
Roger Dingledine committed
47
/** Linked list of connections waiting for a DNS answer. */
48
49
typedef struct pending_connection_t {
  connection_t *conn;
50
  struct pending_connection_t *next;
51
} pending_connection_t;
52

Roger Dingledine's avatar
Roger Dingledine committed
53
/** A DNS request: possibly completed, possibly pending; cached_resolve
54
55
56
 * structs are stored at the OR side in a splay tree, and as a linked
 * list from oldest to newest.
 */
57
58
typedef struct cached_resolve_t {
  SPLAY_ENTRY(cached_resolve_t) node;
59
  char address[MAX_ADDRESSLEN]; /**< The hostname to be resolved. */
60
  uint32_t addr; /**< IPv4 addr for <b>address</b>. */
61
  char state; /**< 0 is pending; 1 means answer is valid; 2 means resolve failed. */
62
63
64
#define CACHE_STATE_PENDING 0
#define CACHE_STATE_VALID 1
#define CACHE_STATE_FAILED 2
65
  uint32_t expire; /**< Remove items from cache after this time. */
66
67
68
  pending_connection_t *pending_connections;
  struct cached_resolve_t *next;
} cached_resolve_t;
69

70
71
static void purge_expired_resolves(uint32_t now);
static int assign_to_dnsworker(connection_t *exitconn);
72
static void dns_purge_resolve(cached_resolve_t *resolve);
73
static void dns_found_answer(char *address, uint32_t addr, char outcome);
Nick Mathewson's avatar
Nick Mathewson committed
74
static int dnsworker_main(void *data);
75
static int spawn_dnsworker(void);
76
static int spawn_enough_dnsworkers(void);
77
static void send_resolved_cell(connection_t *conn, uint8_t answer_type);
78

79
/** Splay tree of cached_resolve objects. */
80
static SPLAY_HEAD(cache_tree, cached_resolve_t) cache_root;
81

Roger Dingledine's avatar
Roger Dingledine committed
82
/** Function to compare hashed resolves on their addresses; used to
83
 * implement splay trees. */
84
85
static int compare_cached_resolves(cached_resolve_t *a,
                                   cached_resolve_t *b) {
86
  /* make this smarter one day? */
87
  return strncmp(a->address, b->address, MAX_ADDRESSLEN);
88
89
}

90
91
SPLAY_PROTOTYPE(cache_tree, cached_resolve_t, node, compare_cached_resolves);
SPLAY_GENERATE(cache_tree, cached_resolve_t, node, compare_cached_resolves);
92

93
/** Initialize the DNS cache. */
94
95
96
static void
init_cache_tree(void)
{
97
98
99
  SPLAY_INIT(&cache_root);
}

Roger Dingledine's avatar
Roger Dingledine committed
100
/** Initialize the DNS subsystem; called by the OR process. */
101
102
103
void
dns_init(void)
{
104
  init_cache_tree();
105
  dnsworkers_rotate();
106
}
107

108
/** Helper: free storage held by an entry in the DNS cache. */
109
static void
110
_free_cached_resolve(cached_resolve_t *r)
111
{
Nick Mathewson's avatar
Nick Mathewson committed
112
  while (r->pending_connections) {
113
    pending_connection_t *victim = r->pending_connections;
114
115
116
117
118
119
    r->pending_connections = victim->next;
    tor_free(victim);
  }
  tor_free(r);
}

120
/** Free all storage held in the DNS cache */
121
122
123
void
dns_free_all(void)
{
124
  cached_resolve_t *ptr, *next;
125
126
127
128
129
130
131
  for (ptr = SPLAY_MIN(cache_tree, &cache_root); ptr != NULL; ptr = next) {
    next = SPLAY_NEXT(cache_tree, &cache_root, ptr);
    SPLAY_REMOVE(cache_tree, &cache_root, ptr);
    _free_cached_resolve(ptr);
  }
}

132
/** Linked list of resolved addresses, oldest to newest. */
133
134
static cached_resolve_t *oldest_cached_resolve = NULL;
static cached_resolve_t *newest_cached_resolve = NULL;
135

Nick Mathewson's avatar
Nick Mathewson committed
136
/** Remove every cached_resolve whose <b>expire</b> time is before <b>now</b>
137
 * from the cache. */
138
139
140
static void
purge_expired_resolves(uint32_t now)
{
141
142
  cached_resolve_t *resolve;
  pending_connection_t *pend;
143
  connection_t *pendconn;
144
145
146
147

  /* this is fast because the linked list
   * oldest_cached_resolve is ordered by when they came in.
   */
148
  while (oldest_cached_resolve && (oldest_cached_resolve->expire < now)) {
149
    resolve = oldest_cached_resolve;
Roger Dingledine's avatar
Roger Dingledine committed
150
    log(LOG_DEBUG,"Forgetting old cached resolve (address %s, expires %lu)",
151
        safe_str(resolve->address), (unsigned long)resolve->expire);
152
    if (resolve->state == CACHE_STATE_PENDING) {
153
      log_fn(LOG_WARN,"Bug: Expiring a dns resolve ('%s') that's still pending. Forgot to cull it?", safe_str(resolve->address));
154
      tor_fragile_assert();
155
156
157
    }
    if (resolve->pending_connections) {
      log_fn(LOG_WARN, "Closing pending connections on expiring DNS resolve!");
158
      tor_fragile_assert();
159
160
161
162
163
164
      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;
165
        connection_edge_end(pendconn, END_STREAM_REASON_TIMEOUT,
166
                            pendconn->cpath_layer);
167
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
168
169
170
        connection_free(pendconn);
        tor_free(pend);
      }
171
    }
172
    oldest_cached_resolve = resolve->next;
173
    if (!oldest_cached_resolve) /* if there are no more, */
174
175
      newest_cached_resolve = NULL; /* then make sure the list's tail knows that too */
    SPLAY_REMOVE(cache_tree, &cache_root, resolve);
176
    tor_free(resolve);
177
178
179
  }
}

180
181
182
183
/** Send a response to the RESOVLE request of a connection. answer_type must
 *  be one of RESOLVED_TYPE_(IPV4|ERROR|ERROR_TRANSIENT) */
static void
send_resolved_cell(connection_t *conn, uint8_t answer_type)
184
185
{
  char buf[RELAY_PAYLOAD_SIZE];
186
  size_t buflen;
187
188
189
190
191
192
193
194

  buf[0] = answer_type;

  switch (answer_type)
    {
    case RESOLVED_TYPE_IPV4:
      buf[1] = 4;
      set_uint32(buf+2, htonl(conn->addr));
195
196
      set_uint32(buf+6, htonl(MAX_DNS_ENTRY_AGE)); /*XXXX send a real TTL*/
      buflen = 10;
197
198
199
      break;
    case RESOLVED_TYPE_ERROR_TRANSIENT:
    case RESOLVED_TYPE_ERROR:
200
201
202
203
204
205
206
207
208
209
      {
        const char *errmsg = "Error resolving hostname";
        int msglen = strlen(errmsg);
        int ttl = (answer_type == RESOLVED_TYPE_ERROR ? MAX_DNS_ENTRY_AGE : 0);
        buf[1] = msglen;
        strlcpy(buf+2, errmsg, sizeof(buf)-2);
        set_uint32(buf+2+msglen, htonl((uint32_t)ttl));
        buflen = 6+msglen;
        break;
      }
210
211
212
    default:
      tor_assert(0);
    }
213
  connection_edge_send_command(conn, circuit_get_by_edge_conn(conn),
214
215
216
217
                               RELAY_COMMAND_RESOLVED, buf, buflen,
                               conn->cpath_layer);
}

218
219
220
/** Link <b>r</b> into the tree of address-to-result mappings, and add it to
 * the linked list of resolves-by-age. */
static void
221
insert_resolve(cached_resolve_t *r)
222
223
224
225
226
227
228
229
230
231
232
233
{
  /* 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;

  SPLAY_INSERT(cache_tree, &cache_root, r);
}

Nick Mathewson's avatar
Nick Mathewson committed
234
235
/** 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.
236
 * If resolve failed, unlink exitconn if needed, free it, and return -1.
237
238
239
240
241
242
243
 *
 * 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.
 */
244
245
246
int
dns_resolve(connection_t *exitconn)
{
247
248
249
  cached_resolve_t *resolve;
  cached_resolve_t search;
  pending_connection_t *pending_connection;
250
  struct in_addr in;
251
  circuit_t *circ;
252
  uint32_t now = time(NULL);
253
  assert_connection_ok(exitconn, 0);
254
  tor_assert(exitconn->s == -1);
255

256
257
258
259
  /* 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);
260
261
    if (exitconn->purpose == EXIT_PURPOSE_RESOLVE)
      send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
262
    return 1;
263
264
265
266
  }

  /* then take this opportunity to see if there are any expired
   * resolves in the tree. */
267
  purge_expired_resolves(now);
268

269
270
271
  /* lower-case exitconn->address, so it's in canonical form */
  tor_strlower(exitconn->address);

272
  /* now check the tree to see if 'address' is already there. */
Nick Mathewson's avatar
Nick Mathewson committed
273
  strlcpy(search.address, exitconn->address, sizeof(search.address));
Roger Dingledine's avatar
   
Roger Dingledine committed
274
  resolve = SPLAY_FIND(cache_tree, &cache_root, &search);
275
276
  if (resolve) { /* already there */
    switch (resolve->state) {
277
278
      case CACHE_STATE_PENDING:
        /* add us to the pending list */
279
        pending_connection = tor_malloc_zero(
280
                                      sizeof(pending_connection_t));
281
        pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
282
283
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
284
        log_fn(LOG_DEBUG,"Connection (fd %d) waiting for pending DNS resolve of '%s'",
285
               exitconn->s, safe_str(exitconn->address));
286
        exitconn->state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
   
Roger Dingledine committed
287
        return 0;
288
      case CACHE_STATE_VALID:
289
        exitconn->addr = resolve->addr;
290
        log_fn(LOG_DEBUG,"Connection (fd %d) found cached answer for '%s'",
291
               exitconn->s, safe_str(exitconn->address));
292
293
        if (exitconn->purpose == EXIT_PURPOSE_RESOLVE)
          send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
294
        return 1;
295
      case CACHE_STATE_FAILED:
296
        log_fn(LOG_DEBUG,"Connection (fd %d) found cached error for '%s'",
297
               exitconn->s, safe_str(exitconn->address));
298
299
        if (exitconn->purpose == EXIT_PURPOSE_RESOLVE)
          send_resolved_cell(exitconn, RESOLVED_TYPE_ERROR);
300
        circ = circuit_get_by_edge_conn(exitconn);
301
302
        if (circ)
          circuit_detach_stream(circ, exitconn);
303
304
        if (!exitconn->marked_for_close)
          connection_free(exitconn);
305
306
        return -1;
    }
Roger Dingledine's avatar
Roger Dingledine committed
307
    tor_assert(0);
Roger Dingledine's avatar
Roger Dingledine committed
308
309
  }
  /* not there, need to add it */
310
  resolve = tor_malloc_zero(sizeof(cached_resolve_t));
Roger Dingledine's avatar
Roger Dingledine committed
311
  resolve->state = CACHE_STATE_PENDING;
312
  resolve->expire = now + MAX_DNS_ENTRY_AGE;
Nick Mathewson's avatar
Nick Mathewson committed
313
  strlcpy(resolve->address, exitconn->address, sizeof(resolve->address));
Roger Dingledine's avatar
Roger Dingledine committed
314
315

  /* add us to the pending list */
316
  pending_connection = tor_malloc_zero(sizeof(pending_connection_t));
Roger Dingledine's avatar
Roger Dingledine committed
317
318
  pending_connection->conn = exitconn;
  resolve->pending_connections = pending_connection;
319
  exitconn->state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
Roger Dingledine committed
320

321
  insert_resolve(resolve);
Roger Dingledine's avatar
Roger Dingledine committed
322
  return assign_to_dnsworker(exitconn);
323
324
}

Roger Dingledine's avatar
Roger Dingledine committed
325
/** Find or spawn a dns worker process to handle resolving
Nick Mathewson's avatar
Nick Mathewson committed
326
 * <b>exitconn</b>-\>address; tell that dns worker to begin resolving.
327
 */
328
329
330
static int
assign_to_dnsworker(connection_t *exitconn)
{
331
332
  connection_t *dnsconn;
  unsigned char len;
333

Roger Dingledine's avatar
Roger Dingledine committed
334
  tor_assert(exitconn->state == EXIT_CONN_STATE_RESOLVING);
335
  tor_assert(exitconn->s == -1);
336

337
338
339
340
  /* respawn here, to be sure there are enough */
  if (spawn_enough_dnsworkers() < 0) {
    goto err;
  }
341

342
  dnsconn = connection_get_by_type_state(CONN_TYPE_DNSWORKER, DNSWORKER_STATE_IDLE);
343

344
  if (!dnsconn) {
Roger Dingledine's avatar
Roger Dingledine committed
345
    log_fn(LOG_WARN,"no idle dns workers. Failing.");
346
347
    if (exitconn->purpose == EXIT_PURPOSE_RESOLVE)
      send_resolved_cell(exitconn, RESOLVED_TYPE_ERROR_TRANSIENT);
348
    goto err;
349
350
  }

351
  log_fn(LOG_DEBUG, "Connection (fd %d) needs to resolve '%s'; assigning to DNSWorker (fd %d)",
352
         exitconn->s, safe_str(exitconn->address), dnsconn->s);
353

354
  tor_free(dnsconn->address);
355
  dnsconn->address = tor_strdup(exitconn->address);
356
  dnsconn->state = DNSWORKER_STATE_BUSY;
Roger Dingledine's avatar
Roger Dingledine committed
357
  num_dnsworkers_busy++;
358

359
  len = strlen(dnsconn->address);
360
  connection_write_to_buf((char*)&len, 1, dnsconn);
361
  connection_write_to_buf(dnsconn->address, len, dnsconn);
362
363

  return 0;
364
365
366
err:
  dns_cancel_pending_resolve(exitconn->address); /* also sends end and frees! */
  return -1;
367
368
}

Nick Mathewson's avatar
Nick Mathewson committed
369
/** Remove <b>conn</b> from the list of connections waiting for conn-\>address.
370
 */
371
372
void
connection_dns_remove(connection_t *conn)
373
{
374
375
376
  pending_connection_t *pend, *victim;
  cached_resolve_t search;
  cached_resolve_t *resolve;
377

378
379
380
  tor_assert(conn->type == CONN_TYPE_EXIT);
  tor_assert(conn->state == EXIT_CONN_STATE_RESOLVING);

Nick Mathewson's avatar
Nick Mathewson committed
381
  strlcpy(search.address, conn->address, sizeof(search.address));
382
383

  resolve = SPLAY_FIND(cache_tree, &cache_root, &search);
384
  if (!resolve) {
385
    log_fn(LOG_NOTICE,"Address '%s' is not pending. Dropping.", safe_str(conn->address));
386
387
388
    return;
  }

Roger Dingledine's avatar
Roger Dingledine committed
389
  tor_assert(resolve->pending_connections);
390
391
392
393
  assert_connection_ok(conn,0);

  pend = resolve->pending_connections;

394
  if (pend->conn == conn) {
395
    resolve->pending_connections = pend->next;
396
    tor_free(pend);
397
    log_fn(LOG_DEBUG, "First connection (fd %d) no longer waiting for resolve of '%s'",
398
           conn->s, safe_str(conn->address));
399
400
    return;
  } else {
401
402
    for ( ; pend->next; pend = pend->next) {
      if (pend->next->conn == conn) {
403
404
        victim = pend->next;
        pend->next = victim->next;
405
        tor_free(victim);
406
        log_fn(LOG_DEBUG, "Connection (fd %d) no longer waiting for resolve of '%s'",
407
               conn->s, safe_str(conn->address));
408
409
410
        return; /* more are pending */
      }
    }
Roger Dingledine's avatar
Roger Dingledine committed
411
    tor_assert(0); /* not reachable unless onlyconn not in pending list */
412
413
414
  }
}

Roger Dingledine's avatar
Roger Dingledine committed
415
/** Log an error and abort if conn is waiting for a DNS resolve.
416
 */
417
418
419
void
assert_connection_edge_not_dns_pending(connection_t *conn)
{
420
421
  pending_connection_t *pend;
  cached_resolve_t *resolve;
422
423

  SPLAY_FOREACH(resolve, cache_tree, &cache_root) {
424
    for (pend = resolve->pending_connections;
425
426
         pend;
         pend = pend->next) {
Roger Dingledine's avatar
Roger Dingledine committed
427
      tor_assert(pend->conn != conn);
428
429
430
431
    }
  }
}

Roger Dingledine's avatar
Roger Dingledine committed
432
/** Log an error and abort if any connection waiting for a DNS resolve is
433
 * corrupted. */
434
435
436
void
assert_all_pending_dns_resolves_ok(void)
{
437
438
  pending_connection_t *pend;
  cached_resolve_t *resolve;
439
440

  SPLAY_FOREACH(resolve, cache_tree, &cache_root) {
441
    for (pend = resolve->pending_connections;
442
443
         pend;
         pend = pend->next) {
444
      assert_connection_ok(pend->conn, 0);
445
446
      tor_assert(pend->conn->s == -1);
      tor_assert(!connection_in_array(pend->conn));
447
448
449
450
    }
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
451
452
453
/** 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.
454
 */
455
456
457
void
dns_cancel_pending_resolve(char *address)
{
458
459
460
  pending_connection_t *pend;
  cached_resolve_t search;
  cached_resolve_t *resolve;
461
  connection_t *pendconn;
462
  circuit_t *circ;
463

Nick Mathewson's avatar
Nick Mathewson committed
464
  strlcpy(search.address, address, sizeof(search.address));
465
466

  resolve = SPLAY_FIND(cache_tree, &cache_root, &search);
467
  if (!resolve) {
468
    log_fn(LOG_NOTICE,"Address '%s' is not pending. Dropping.", safe_str(address));
469
470
471
    return;
  }

472
473
  if (!resolve->pending_connections) {
    /* XXX this should never trigger, but sometimes it does */
474
475
    log_fn(LOG_WARN,"Bug: Address '%s' is pending but has no pending connections!",
           safe_str(address));
476
    tor_fragile_assert();
477
478
    return;
  }
Roger Dingledine's avatar
Roger Dingledine committed
479
  tor_assert(resolve->pending_connections);
480

481
482
  /* mark all pending connections to fail */
  log_fn(LOG_DEBUG, "Failing all connections waiting on DNS resolve of '%s'",
483
         safe_str(address));
484
  while (resolve->pending_connections) {
485
    pend = resolve->pending_connections;
486
    pend->conn->state = EXIT_CONN_STATE_RESOLVEFAILED;
487
    pendconn = pend->conn;
488
    tor_assert(pendconn->s == -1);
489
    if (!pendconn->marked_for_close) {
490
491
      connection_edge_end(pendconn, END_STREAM_REASON_RESOURCELIMIT,
                          pendconn->cpath_layer);
492
    }
493
    circ = circuit_get_by_edge_conn(pendconn);
494
495
    if (circ)
      circuit_detach_stream(circ, pendconn);
496
    connection_free(pendconn);
497
498
    resolve->pending_connections = pend->next;
    tor_free(pend);
499
500
  }

501
502
503
  dns_purge_resolve(resolve);
}

Nick Mathewson's avatar
Nick Mathewson committed
504
/** Remove <b>resolve</b> from the cache.
505
 */
506
static void
507
dns_purge_resolve(cached_resolve_t *resolve)
508
{
509
  cached_resolve_t *tmp;
510

511
  /* remove resolve from the linked list */
512
  if (resolve == oldest_cached_resolve) {
513
    oldest_cached_resolve = resolve->next;
514
    if (oldest_cached_resolve == NULL)
515
      newest_cached_resolve = NULL;
516
  } else {
517
    /* FFFF make it a doubly linked list if this becomes too slow */
518
    for (tmp=oldest_cached_resolve; tmp && tmp->next != resolve; tmp=tmp->next) ;
Roger Dingledine's avatar
Roger Dingledine committed
519
    tor_assert(tmp); /* it's got to be in the list, or we screwed up somewhere else */
520
521
    tmp->next = resolve->next; /* unlink it */

522
    if (newest_cached_resolve == resolve)
523
      newest_cached_resolve = tmp;
524
  }
525
526
527
528

  /* remove resolve from the tree */
  SPLAY_REMOVE(cache_tree, &cache_root, resolve);

529
  tor_free(resolve);
530
531
}

Roger Dingledine's avatar
Roger Dingledine committed
532
/** Called on the OR side when a DNS worker tells us the outcome of a DNS
533
 * resolve: tell all pending connections about the result of the lookup, and
Nick Mathewson's avatar
Nick Mathewson committed
534
535
536
537
 * 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}.
538
 */
539
540
541
static void
dns_found_answer(char *address, uint32_t addr, char outcome)
{
542
543
544
  pending_connection_t *pend;
  cached_resolve_t search;
  cached_resolve_t *resolve;
545
  connection_t *pendconn;
546
  circuit_t *circ;
547

Nick Mathewson's avatar
Nick Mathewson committed
548
  strlcpy(search.address, address, sizeof(search.address));
549
550

  resolve = SPLAY_FIND(cache_tree, &cache_root, &search);
551
  if (!resolve) {
552
553
    log_fn(LOG_INFO,"Resolved unasked address '%s'; caching anyway.",
           safe_str(address));
554
    resolve = tor_malloc_zero(sizeof(cached_resolve_t));
555
556
557
558
559
    resolve->state = (outcome == DNS_RESOLVE_SUCCEEDED) ?
      CACHE_STATE_VALID : CACHE_STATE_FAILED;
    resolve->addr = addr;
    resolve->expire = time(NULL) + MAX_DNS_ENTRY_AGE;
    insert_resolve(resolve);
560
    return;
561
562
  }

563
  if (resolve->state != CACHE_STATE_PENDING) {
564
565
    /* XXXX Maybe update addr? or check addr for consistency? Or let
     * VALID replace FAILED? */
Roger Dingledine's avatar
Roger Dingledine committed
566
    log_fn(LOG_NOTICE, "Resolved '%s' which was already resolved; ignoring",
567
           safe_str(address));
Roger Dingledine's avatar
Roger Dingledine committed
568
    tor_assert(resolve->pending_connections == NULL);
569
570
571
572
573
574
    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
575
  /* tor_assert(resolve->state == CACHE_STATE_PENDING); */
576

577
  resolve->addr = addr;
578
  if (outcome == DNS_RESOLVE_SUCCEEDED)
579
580
581
582
    resolve->state = CACHE_STATE_VALID;
  else
    resolve->state = CACHE_STATE_FAILED;

583
  while (resolve->pending_connections) {
584
    pend = resolve->pending_connections;
585
    assert_connection_ok(pend->conn,time(NULL));
586
    pend->conn->addr = resolve->addr;
587
588
    pendconn = pend->conn; /* don't pass complex things to the
                              connection_mark_for_close macro */
589

590
    if (resolve->state == CACHE_STATE_FAILED) {
591
      /* prevent double-remove. */
592
      pendconn->state = EXIT_CONN_STATE_RESOLVEFAILED;
593
      if (pendconn->purpose == EXIT_PURPOSE_CONNECT) {
594
595
        connection_edge_end(pendconn, END_STREAM_REASON_RESOLVEFAILED, pendconn->cpath_layer);
        /* This detach must happen after we send the end cell. */
596
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
597
      } else {
598
        send_resolved_cell(pendconn, RESOLVED_TYPE_ERROR);
599
        /* This detach must happen after we send the resolved cell. */
600
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
601
      }
602
      connection_free(pendconn);
Roger Dingledine's avatar
Roger Dingledine committed
603
    } else {
604
605
606
607
      if (pendconn->purpose == EXIT_PURPOSE_CONNECT) {
        /* prevent double-remove. */
        pend->conn->state = EXIT_CONN_STATE_CONNECTING;

608
        circ = circuit_get_by_edge_conn(pend->conn);
609
610
611
612
613
        tor_assert(circ);
        /* unlink pend->conn from resolving_streams, */
        circuit_detach_stream(circ, pend->conn);
        /* and link it to n_streams */
        pend->conn->next_stream = circ->n_streams;
614
        pend->conn->on_circuit = circ;
615
616
617
618
619
620
621
622
        circ->n_streams = pend->conn;

        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;
        send_resolved_cell(pendconn, RESOLVED_TYPE_IPV4);
623
        circ = circuit_get_by_edge_conn(pendconn);
624
625
626
627
        tor_assert(circ);
        circuit_detach_stream(circ, pendconn);
        connection_free(pendconn);
      }
Roger Dingledine's avatar
Roger Dingledine committed
628
    }
629
630
    resolve->pending_connections = pend->next;
    tor_free(pend);
631
  }
632

633
  if (outcome == DNS_RESOLVE_FAILED_TRANSIENT) { /* remove from cache */
634
635
    dns_purge_resolve(resolve);
  }
636
637
}

638
639
/******************************************************************/

Nick Mathewson's avatar
Nick Mathewson committed
640
/*
641
 * Connection between OR and dnsworker
Nick Mathewson's avatar
Nick Mathewson committed
642
 */
643

Roger Dingledine's avatar
Roger Dingledine committed
644
/** Write handler: called when we've pushed a request to a dnsworker. */
645
646
647
int
connection_dns_finished_flushing(connection_t *conn)
{
648
649
  tor_assert(conn);
  tor_assert(conn->type == CONN_TYPE_DNSWORKER);
650
651
652
653
  connection_stop_writing(conn);
  return 0;
}

654
655
656
int
connection_dns_reached_eof(connection_t *conn)
{
657
  log_fn(LOG_WARN,"Read eof. Worker died unexpectedly.");
658
  if (conn->state == DNSWORKER_STATE_BUSY) {
659
660
661
662
    /* don't cancel the resolve here -- it would be cancelled in
     * connection_about_to_close_connection(), since conn is still
     * in state BUSY
     */
663
664
665
666
667
668
669
670
    num_dnsworkers_busy--;
  }
  num_dnsworkers--;
  connection_mark_for_close(conn);
  return 0;
}

/** Read handler: called when we get data from a dnsworker. See
671
672
 * if we have a complete answer.  If so, call dns_found_answer on the
 * result.  If not, wait.  Returns 0. */
673
674
675
int
connection_dns_process_inbuf(connection_t *conn)
{
676
  char success;
677
  uint32_t addr;
678

679
680
  tor_assert(conn);
  tor_assert(conn->type == CONN_TYPE_DNSWORKER);
681

682
  if (conn->state != DNSWORKER_STATE_BUSY && buf_datalen(conn->inbuf)) {
683
    log_fn(LOG_WARN,"Bug: read data (%d bytes) from an idle dns worker (fd %d, address '%s'). Please report.",
684
           (int)buf_datalen(conn->inbuf), conn->s, safe_str(conn->address));
685
    tor_fragile_assert();
686
687
688
689
690
691
692
693

    /* 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);
      log_fn(LOG_WARN,"Discarding idle dns answer (success %d, addr %d.)",
694
             success, addr); // XXX safe_str
695
    }
696
697
    return 0;
  }
698
  if (buf_datalen(conn->inbuf) < 5) /* entire answer available? */
699
    return 0; /* not yet */
700
  tor_assert(conn->state == DNSWORKER_STATE_BUSY);
Roger Dingledine's avatar
Roger Dingledine committed
701
  tor_assert(buf_datalen(conn->inbuf) == 5);
702

703
704
  connection_fetch_from_buf(&success,1,conn);
  connection_fetch_from_buf((char *)&addr,sizeof(uint32_t),conn);
705

706
  log_fn(LOG_DEBUG, "DNSWorker (fd %d) returned answer for '%s'",
707
         conn->s, safe_str(conn->address));
708

Roger Dingledine's avatar
Roger Dingledine committed
709
710
  tor_assert(success >= DNS_RESOLVE_FAILED_TRANSIENT);
  tor_assert(success <= DNS_RESOLVE_SUCCEEDED);
711
  dns_found_answer(conn->address, ntohl(addr), success);
712

713
  tor_free(conn->address);
714
  conn->address = tor_strdup("<idle>");
715
  conn->state = DNSWORKER_STATE_IDLE;
Roger Dingledine's avatar
Roger Dingledine committed
716
  num_dnsworkers_busy--;
717
718
719
720
721
  if (conn->timestamp_created < last_rotation_time) {
    connection_mark_for_close(conn);
    num_dnsworkers--;
    spawn_enough_dnsworkers();
  }
722
723
724
  return 0;
}

725
726
727
/** Close and re-open all idle dnsworkers; schedule busy ones to be closed
 * and re-opened once they're no longer busy.
 **/
728
729
void
dnsworkers_rotate(void)
730
731
732
733
734
735
736
737
{
  connection_t *dnsconn;
  while ((dnsconn = connection_get_by_type_state(CONN_TYPE_DNSWORKER,
                                                 DNSWORKER_STATE_IDLE))) {
    connection_mark_for_close(dnsconn);
    num_dnsworkers--;
  }
  last_rotation_time = time(NULL);
738
739
  if (server_mode(get_options()))
    spawn_enough_dnsworkers();
740
741
}

Roger Dingledine's avatar
Roger Dingledine committed
742
/** Implementation for DNS workers; this code runs in a separate
743
744
745
 * execution context.  It takes as its argument an fdarray as returned
 * by socketpair(), and communicates via fdarray[1].  The protocol is
 * as follows:
Nick Mathewson's avatar
Nick Mathewson committed
746
747
748
749
750
751
 *    - The OR says:
 *         - ADDRESSLEN [1 byte]
 *         - ADDRESS    [ADDRESSLEN bytes]
 *    - The DNS worker does the lookup, and replies:
 *         - OUTCOME    [1 byte]
 *         - IP         [4 bytes]
752
753
754
755
756
757
758
 *
 * OUTCOME is one of DNS_RESOLVE_{FAILED_TRANSIENT|FAILED_PERMANENT|SUCCEEDED}.
 * IP is in host order.
 *
 * The dnsworker runs indefinitely, until its connection is closed or an error
 * occurs.
 */
759
760
761
static int
dnsworker_main(void *data)
{
762
763
  char address[MAX_ADDRESSLEN];
  unsigned char address_len;
764
  char answer[5];
Roger Dingledine's avatar
Roger Dingledine committed
765
  uint32_t ip;
766
  int *fdarray = data;
Roger Dingledine's avatar
Roger Dingledine committed
767
  int fd;
768
  int result;
769

770
771
  /* log_fn(LOG_NOTICE,"After spawn: fdarray @%d has %d:%d", (int)fdarray, fdarray[0],fdarray[1]); */

772
  fd = fdarray[1]; /* this side is ours */
773
#ifndef TOR_IS_MULTITHREADED
774
  tor_close_socket(fdarray[0]); /* this is the side of the socketpair the parent uses */
775
  tor_free_all(1); /* so the child doesn't hold the parent's fd's open */
776
  handle_signals(0); /* ignore interrupts from the keyboard, etc */
777
778
#endif
  tor_free(data);
779

780
  for (;;) {
781
    int r;
782

783
784
785
786
787
788
789
    if ((r = recv(fd, &address_len, 1, 0)) != 1) {
      if (r == 0) {
        log_fn(LOG_INFO,"DNS worker exiting because Tor process closed connection (either pruned idle dnsworker or died).");
      } else {
        log_fn(LOG_INFO,"DNS worker exiting because of error on connection to Tor process.");
        log_fn(LOG_INFO,"(Error on %d was %s)", fd, tor_socket_strerror(tor_socket_errno(fd)));
      }
790
      tor_close_socket(fd);
791
      spawn_exit();
792
793
    }

794
    if (address_len && read_all(fd, address, address_len, 1) != address_len) {
795
      log_fn(LOG_ERR,"read hostname failed. Child exiting.");
796
      tor_close_socket(fd);
797
      spawn_exit();
798
    }
799
    address[address_len] = 0; /* null terminate it */
800

801
802
803
804
805
    result = tor_lookup_hostname(address, &ip);
    /* Make 0.0.0.0 an error, so that we can use "0" to mean "no addr") */
    if (!ip)
      result = -1;
    switch (result) {
806
      case 1:
807
        /* XXX result can never be 1, because we set it to -1 above on error */
808
        log_fn(LOG_INFO,"Could not resolve dest addr %s (transient).",safe_str(address));
809
        answer[0] = DNS_RESOLVE_FAILED_TRANSIENT;
810
811
        break;
      case -1:
812
        log_fn(LOG_INFO,"Could not resolve dest addr %s (permanent).",safe_str(address));
813
        answer[0] = DNS_RESOLVE_FAILED_PERMANENT;
814
        break;
815
      case 0:
816
        log_fn(LOG_INFO,"Resolved address '%s'.",safe_str(address));
817
        answer[0] = DNS_RESOLVE_SUCCEEDED;
818
        break;
819
    }
Roger Dingledine's avatar
Roger Dingledine committed
820
    set_uint32(answer+1, ip);
821
    if (write_all(fd, answer, 5, 1) != 5) {
822
      log_fn(LOG_ERR,"writing answer failed. Child exiting.");
823
      tor_close_socket(fd);
Roger Dingledine's avatar