dns.c 29.8 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
9
10
/**
 * \file dns.c
 * \brief Resolve hostnames in separate processes.
 **/
11

12
13
14
15
16
/* 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.
 */

17
#include "or.h"
18
#include "tree.h"
19

Roger Dingledine's avatar
Roger Dingledine committed
20
/** Longest hostname we're willing to resolve. */
21
22
#define MAX_ADDRESSLEN 256

Roger Dingledine's avatar
Roger Dingledine committed
23
/** Maximum DNS processes to spawn. */
24
#define MAX_DNSWORKERS 100
Roger Dingledine's avatar
Roger Dingledine committed
25
/** Minimum DNS processes to spawn. */
26
#define MIN_DNSWORKERS 3
27

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

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

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

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

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

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

76
/** Splay tree of cached_resolve objects. */
77
static SPLAY_HEAD(cache_tree, cached_resolve) cache_root;
78

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

SPLAY_PROTOTYPE(cache_tree, cached_resolve, node, compare_cached_resolves);
SPLAY_GENERATE(cache_tree, cached_resolve, node, compare_cached_resolves);

90
/** Initialize the DNS cache. */
91
static void init_cache_tree(void) {
92
93
94
  SPLAY_INIT(&cache_root);
}

Roger Dingledine's avatar
Roger Dingledine committed
95
/** Initialize the DNS subsystem; called by the OR process. */
96
97
void dns_init(void) {
  init_cache_tree();
98
  last_rotation_time=time(NULL);
Roger Dingledine's avatar
Roger Dingledine committed
99
  spawn_enough_dnsworkers();
100
}
101

102
103
static void
_free_cached_resolve(struct cached_resolve *r) {
Nick Mathewson's avatar
Nick Mathewson committed
104
  while (r->pending_connections) {
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
    struct pending_connection_t *victim = r->pending_connections;
    r->pending_connections = victim->next;
    tor_free(victim);
  }
  tor_free(r);
}

void
dns_free_all(void)
{
  struct cached_resolve *ptr, *next;
  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);
  }
}

123
/** Linked list of resolved addresses, oldest to newest. */
Roger Dingledine's avatar
Roger Dingledine committed
124
125
static struct cached_resolve *oldest_cached_resolve = NULL;
static struct cached_resolve *newest_cached_resolve = NULL;
126

Nick Mathewson's avatar
Nick Mathewson committed
127
/** Remove every cached_resolve whose <b>expire</b> time is before <b>now</b>
128
 * from the cache. */
129
130
static void purge_expired_resolves(uint32_t now) {
  struct cached_resolve *resolve;
131
132
  struct pending_connection_t *pend;
  connection_t *pendconn;
133
134
135
136

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

169
170
171
static void send_resolved_cell(connection_t *conn, uint8_t answer_type)
{
  char buf[RELAY_PAYLOAD_SIZE];
172
  size_t buflen;
173
174
175
176
177
178
179
180
181
182
183
184
185

  buf[0] = answer_type;

  switch (answer_type)
    {
    case RESOLVED_TYPE_IPV4:
      buf[1] = 4;
      set_uint32(buf+2, htonl(conn->addr));
      buflen = 6;
      break;
    case RESOLVED_TYPE_ERROR_TRANSIENT:
    case RESOLVED_TYPE_ERROR:
      buf[1] = 24; /* length of "error resolving hostname" */
Nick Mathewson's avatar
Nick Mathewson committed
186
      strlcpy(buf+2, "error resolving hostname", sizeof(buf)-2);
187
188
189
190
191
      buflen = 26;
      break;
    default:
      tor_assert(0);
    }
192
  connection_edge_send_command(conn, circuit_get_by_edge_conn(conn),
193
194
195
196
                               RELAY_COMMAND_RESOLVED, buf, buflen,
                               conn->cpath_layer);
}

197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
/** 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
insert_resolve(struct cached_resolve *r)
{
  /* 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
213
214
/** 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.
215
 * If resolve failed, unlink exitconn if needed, free it, and return -1.
216
217
218
219
220
221
222
223
224
 *
 * 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.
 */
int dns_resolve(connection_t *exitconn) {
  struct cached_resolve *resolve;
Roger Dingledine's avatar
   
Roger Dingledine committed
225
  struct cached_resolve search;
226
  struct pending_connection_t *pending_connection;
227
  struct in_addr in;
228
  circuit_t *circ;
229
  uint32_t now = time(NULL);
230
  assert_connection_ok(exitconn, 0);
231
  tor_assert(exitconn->s == -1);
232

233
234
235
236
  /* 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);
237
238
    if (exitconn->purpose == EXIT_PURPOSE_RESOLVE)
      send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
239
    return 1;
240
241
242
243
  }

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

246
247
248
  /* lower-case exitconn->address, so it's in canonical form */
  tor_strlower(exitconn->address);

249
  /* now check the tree to see if 'address' is already there. */
Nick Mathewson's avatar
Nick Mathewson committed
250
  strlcpy(search.address, exitconn->address, sizeof(search.address));
Roger Dingledine's avatar
   
Roger Dingledine committed
251
  resolve = SPLAY_FIND(cache_tree, &cache_root, &search);
252
253
  if (resolve) { /* already there */
    switch (resolve->state) {
254
255
      case CACHE_STATE_PENDING:
        /* add us to the pending list */
256
257
        pending_connection = tor_malloc_zero(
                                      sizeof(struct pending_connection_t));
258
        pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
259
260
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
261
        log_fn(LOG_DEBUG,"Connection (fd %d) waiting for pending DNS resolve of '%s'",
262
               exitconn->s, safe_str(exitconn->address));
263
        exitconn->state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
   
Roger Dingledine committed
264
        return 0;
265
      case CACHE_STATE_VALID:
266
        exitconn->addr = resolve->addr;
267
        log_fn(LOG_DEBUG,"Connection (fd %d) found cached answer for '%s'",
268
               exitconn->s, safe_str(exitconn->address));
269
270
        if (exitconn->purpose == EXIT_PURPOSE_RESOLVE)
          send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
271
        return 1;
272
      case CACHE_STATE_FAILED:
273
        log_fn(LOG_DEBUG,"Connection (fd %d) found cached error for '%s'",
274
               exitconn->s, safe_str(exitconn->address));
275
276
        if (exitconn->purpose == EXIT_PURPOSE_RESOLVE)
          send_resolved_cell(exitconn, RESOLVED_TYPE_ERROR);
277
        circ = circuit_get_by_edge_conn(exitconn);
278
279
        if (circ)
          circuit_detach_stream(circ, exitconn);
280
281
        if (!exitconn->marked_for_close)
          connection_free(exitconn);
282
283
        return -1;
    }
Roger Dingledine's avatar
Roger Dingledine committed
284
    tor_assert(0);
Roger Dingledine's avatar
Roger Dingledine committed
285
286
287
288
  }
  /* not there, need to add it */
  resolve = tor_malloc_zero(sizeof(struct cached_resolve));
  resolve->state = CACHE_STATE_PENDING;
289
  resolve->expire = now + MAX_DNS_ENTRY_AGE;
Nick Mathewson's avatar
Nick Mathewson committed
290
  strlcpy(resolve->address, exitconn->address, sizeof(resolve->address));
Roger Dingledine's avatar
Roger Dingledine committed
291
292

  /* add us to the pending list */
293
  pending_connection = tor_malloc_zero(sizeof(struct pending_connection_t));
Roger Dingledine's avatar
Roger Dingledine committed
294
295
  pending_connection->conn = exitconn;
  resolve->pending_connections = pending_connection;
296
  exitconn->state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
Roger Dingledine committed
297

298
  insert_resolve(resolve);
Roger Dingledine's avatar
Roger Dingledine committed
299
  return assign_to_dnsworker(exitconn);
300
301
}

Roger Dingledine's avatar
Roger Dingledine committed
302
/** Find or spawn a dns worker process to handle resolving
Nick Mathewson's avatar
Nick Mathewson committed
303
 * <b>exitconn</b>-\>address; tell that dns worker to begin resolving.
304
 */
Roger Dingledine's avatar
Roger Dingledine committed
305
static int assign_to_dnsworker(connection_t *exitconn) {
306
307
  connection_t *dnsconn;
  unsigned char len;
308

Roger Dingledine's avatar
Roger Dingledine committed
309
  tor_assert(exitconn->state == EXIT_CONN_STATE_RESOLVING);
310
  tor_assert(exitconn->s == -1);
311

Roger Dingledine's avatar
Roger Dingledine committed
312
  spawn_enough_dnsworkers(); /* respawn here, to be sure there are enough */
313

314
  dnsconn = connection_get_by_type_state(CONN_TYPE_DNSWORKER, DNSWORKER_STATE_IDLE);
315

316
  if (!dnsconn) {
Roger Dingledine's avatar
Roger Dingledine committed
317
    log_fn(LOG_WARN,"no idle dns workers. Failing.");
318
319
    if (exitconn->purpose == EXIT_PURPOSE_RESOLVE)
      send_resolved_cell(exitconn, RESOLVED_TYPE_ERROR_TRANSIENT);
320
    dns_cancel_pending_resolve(exitconn->address); /* also sends end and frees! */
321
    return -1;
322
323
  }

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

327
  tor_free(dnsconn->address);
328
  dnsconn->address = tor_strdup(exitconn->address);
329
  dnsconn->state = DNSWORKER_STATE_BUSY;
Roger Dingledine's avatar
Roger Dingledine committed
330
  num_dnsworkers_busy++;
331

332
  len = strlen(dnsconn->address);
333
334
  connection_write_to_buf(&len, 1, dnsconn);
  connection_write_to_buf(dnsconn->address, len, dnsconn);
335
336
337
338

  return 0;
}

Nick Mathewson's avatar
Nick Mathewson committed
339
/** Remove <b>conn</b> from the list of connections waiting for conn-\>address.
340
 */
341
342
343
344
345
346
void connection_dns_remove(connection_t *conn)
{
  struct pending_connection_t *pend, *victim;
  struct cached_resolve search;
  struct cached_resolve *resolve;

347
348
349
  tor_assert(conn->type == CONN_TYPE_EXIT);
  tor_assert(conn->state == EXIT_CONN_STATE_RESOLVING);

Nick Mathewson's avatar
Nick Mathewson committed
350
  strlcpy(search.address, conn->address, sizeof(search.address));
351
352

  resolve = SPLAY_FIND(cache_tree, &cache_root, &search);
353
  if (!resolve) {
354
    log_fn(LOG_NOTICE,"Address '%s' is not pending. Dropping.", safe_str(conn->address));
355
356
357
    return;
  }

Roger Dingledine's avatar
Roger Dingledine committed
358
  tor_assert(resolve->pending_connections);
359
360
361
362
  assert_connection_ok(conn,0);

  pend = resolve->pending_connections;

363
  if (pend->conn == conn) {
364
    resolve->pending_connections = pend->next;
365
    tor_free(pend);
366
    log_fn(LOG_DEBUG, "First connection (fd %d) no longer waiting for resolve of '%s'",
367
           conn->s, safe_str(conn->address));
368
369
    return;
  } else {
370
371
    for ( ; pend->next; pend = pend->next) {
      if (pend->next->conn == conn) {
372
373
        victim = pend->next;
        pend->next = victim->next;
374
        tor_free(victim);
375
        log_fn(LOG_DEBUG, "Connection (fd %d) no longer waiting for resolve of '%s'",
376
               conn->s, safe_str(conn->address));
377
378
379
        return; /* more are pending */
      }
    }
Roger Dingledine's avatar
Roger Dingledine committed
380
    tor_assert(0); /* not reachable unless onlyconn not in pending list */
381
382
383
  }
}

Roger Dingledine's avatar
Roger Dingledine committed
384
/** Log an error and abort if conn is waiting for a DNS resolve.
385
 */
386
387
388
389
390
void assert_connection_edge_not_dns_pending(connection_t *conn) {
  struct pending_connection_t *pend;
  struct cached_resolve *resolve;

  SPLAY_FOREACH(resolve, cache_tree, &cache_root) {
391
    for (pend = resolve->pending_connections;
392
393
         pend;
         pend = pend->next) {
Roger Dingledine's avatar
Roger Dingledine committed
394
      tor_assert(pend->conn != conn);
395
396
397
398
    }
  }
}

Roger Dingledine's avatar
Roger Dingledine committed
399
/** Log an error and abort if any connection waiting for a DNS resolve is
400
 * corrupted. */
401
402
403
404
405
void assert_all_pending_dns_resolves_ok(void) {
  struct pending_connection_t *pend;
  struct cached_resolve *resolve;

  SPLAY_FOREACH(resolve, cache_tree, &cache_root) {
406
    for (pend = resolve->pending_connections;
407
408
         pend;
         pend = pend->next) {
409
      assert_connection_ok(pend->conn, 0);
410
411
      tor_assert(pend->conn->s == -1);
      tor_assert(!connection_in_array(pend->conn));
412
413
414
415
    }
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
416
417
418
/** 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.
419
 */
420
421
void dns_cancel_pending_resolve(char *address) {
  struct pending_connection_t *pend;
422
  struct cached_resolve search;
423
  struct cached_resolve *resolve;
424
  connection_t *pendconn;
425
  circuit_t *circ;
426

Nick Mathewson's avatar
Nick Mathewson committed
427
  strlcpy(search.address, address, sizeof(search.address));
428
429

  resolve = SPLAY_FIND(cache_tree, &cache_root, &search);
430
  if (!resolve) {
431
    log_fn(LOG_NOTICE,"Address '%s' is not pending. Dropping.", safe_str(address));
432
433
434
    return;
  }

435
436
  if (!resolve->pending_connections) {
    /* XXX this should never trigger, but sometimes it does */
437
438
    log_fn(LOG_WARN,"Bug: Address '%s' is pending but has no pending connections!",
           safe_str(address));
439
    tor_fragile_assert();
440
441
    return;
  }
Roger Dingledine's avatar
Roger Dingledine committed
442
  tor_assert(resolve->pending_connections);
443

444
445
  /* mark all pending connections to fail */
  log_fn(LOG_DEBUG, "Failing all connections waiting on DNS resolve of '%s'",
446
         safe_str(address));
447
  while (resolve->pending_connections) {
448
    pend = resolve->pending_connections;
449
    pend->conn->state = EXIT_CONN_STATE_RESOLVEFAILED;
450
    pendconn = pend->conn;
451
    tor_assert(pendconn->s == -1);
452
    if (!pendconn->marked_for_close) {
453
454
      connection_edge_end(pendconn, END_STREAM_REASON_RESOURCELIMIT,
                          pendconn->cpath_layer);
455
    }
456
    circ = circuit_get_by_edge_conn(pendconn);
457
458
    if (circ)
      circuit_detach_stream(circ, pendconn);
459
    connection_free(pendconn);
460
461
    resolve->pending_connections = pend->next;
    tor_free(pend);
462
463
  }

464
465
466
  dns_purge_resolve(resolve);
}

Nick Mathewson's avatar
Nick Mathewson committed
467
/** Remove <b>resolve</b> from the cache.
468
 */
469
470
471
static void dns_purge_resolve(struct cached_resolve *resolve) {
  struct cached_resolve *tmp;

472
  /* remove resolve from the linked list */
473
  if (resolve == oldest_cached_resolve) {
474
    oldest_cached_resolve = resolve->next;
475
    if (oldest_cached_resolve == NULL)
476
      newest_cached_resolve = NULL;
477
  } else {
478
    /* FFFF make it a doubly linked list if this becomes too slow */
479
    for (tmp=oldest_cached_resolve; tmp && tmp->next != resolve; tmp=tmp->next) ;
Roger Dingledine's avatar
Roger Dingledine committed
480
    tor_assert(tmp); /* it's got to be in the list, or we screwed up somewhere else */
481
482
    tmp->next = resolve->next; /* unlink it */

483
    if (newest_cached_resolve == resolve)
484
      newest_cached_resolve = tmp;
485
  }
486
487
488
489

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

490
  tor_free(resolve);
491
492
}

Roger Dingledine's avatar
Roger Dingledine committed
493
/** Called on the OR side when a DNS worker tells us the outcome of a DNS
494
 * resolve: tell all pending connections about the result of the lookup, and
Nick Mathewson's avatar
Nick Mathewson committed
495
496
497
498
 * 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}.
499
 */
500
static void dns_found_answer(char *address, uint32_t addr, char outcome) {
501
502
503
  struct pending_connection_t *pend;
  struct cached_resolve search;
  struct cached_resolve *resolve;
504
  connection_t *pendconn;
505
  circuit_t *circ;
506

Nick Mathewson's avatar
Nick Mathewson committed
507
  strlcpy(search.address, address, sizeof(search.address));
508
509

  resolve = SPLAY_FIND(cache_tree, &cache_root, &search);
510
  if (!resolve) {
511
512
    log_fn(LOG_INFO,"Resolved unasked address '%s'; caching anyway.",
           safe_str(address));
513
514
515
516
517
518
    resolve = tor_malloc_zero(sizeof(struct cached_resolve));
    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);
519
    return;
520
521
  }

522
  if (resolve->state != CACHE_STATE_PENDING) {
523
524
    /* XXXX Maybe update addr? or check addr for consistency? Or let
     * VALID replace FAILED? */
Roger Dingledine's avatar
Roger Dingledine committed
525
    log_fn(LOG_NOTICE, "Resolved '%s' which was already resolved; ignoring",
526
           safe_str(address));
Roger Dingledine's avatar
Roger Dingledine committed
527
    tor_assert(resolve->pending_connections == NULL);
528
529
530
531
532
533
    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
534
  /* tor_assert(resolve->state == CACHE_STATE_PENDING); */
535

536
  resolve->addr = addr;
537
  if (outcome == DNS_RESOLVE_SUCCEEDED)
538
539
540
541
    resolve->state = CACHE_STATE_VALID;
  else
    resolve->state = CACHE_STATE_FAILED;

542
  while (resolve->pending_connections) {
543
    pend = resolve->pending_connections;
544
    assert_connection_ok(pend->conn,time(NULL));
545
    pend->conn->addr = resolve->addr;
546
547
    pendconn = pend->conn; /* don't pass complex things to the
                              connection_mark_for_close macro */
548

549
    if (resolve->state == CACHE_STATE_FAILED) {
550
      /* prevent double-remove. */
551
      pendconn->state = EXIT_CONN_STATE_RESOLVEFAILED;
552
      if (pendconn->purpose == EXIT_PURPOSE_CONNECT) {
553
554
        connection_edge_end(pendconn, END_STREAM_REASON_RESOLVEFAILED, pendconn->cpath_layer);
        /* This detach must happen after we send the end cell. */
555
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
556
      } else {
557
        send_resolved_cell(pendconn, RESOLVED_TYPE_ERROR);
558
        /* This detach must happen after we send the resolved cell. */
559
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
560
      }
561
      connection_free(pendconn);
Roger Dingledine's avatar
Roger Dingledine committed
562
    } else {
563
564
565
566
      if (pendconn->purpose == EXIT_PURPOSE_CONNECT) {
        /* prevent double-remove. */
        pend->conn->state = EXIT_CONN_STATE_CONNECTING;

567
        circ = circuit_get_by_edge_conn(pend->conn);
568
569
570
571
572
        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;
573
        pend->conn->on_circuit = circ;
574
575
576
577
578
579
580
581
        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);
582
        circ = circuit_get_by_edge_conn(pendconn);
583
584
585
586
        tor_assert(circ);
        circuit_detach_stream(circ, pendconn);
        connection_free(pendconn);
      }
Roger Dingledine's avatar
Roger Dingledine committed
587
    }
588
589
    resolve->pending_connections = pend->next;
    tor_free(pend);
590
  }
591

592
  if (outcome == DNS_RESOLVE_FAILED_TRANSIENT) { /* remove from cache */
593
594
    dns_purge_resolve(resolve);
  }
595
596
}

597
598
/******************************************************************/

Nick Mathewson's avatar
Nick Mathewson committed
599
/*
600
 * Connection between OR and dnsworker
Nick Mathewson's avatar
Nick Mathewson committed
601
 */
602

Roger Dingledine's avatar
Roger Dingledine committed
603
/** Write handler: called when we've pushed a request to a dnsworker. */
604
int connection_dns_finished_flushing(connection_t *conn) {
605
606
  tor_assert(conn);
  tor_assert(conn->type == CONN_TYPE_DNSWORKER);
607
608
609
610
  connection_stop_writing(conn);
  return 0;
}

611
612
int connection_dns_reached_eof(connection_t *conn) {
  log_fn(LOG_WARN,"Read eof. Worker died unexpectedly.");
613
  if (conn->state == DNSWORKER_STATE_BUSY) {
614
615
616
617
    /* don't cancel the resolve here -- it would be cancelled in
     * connection_about_to_close_connection(), since conn is still
     * in state BUSY
     */
618
619
620
621
622
623
624
625
    num_dnsworkers_busy--;
  }
  num_dnsworkers--;
  connection_mark_for_close(conn);
  return 0;
}

/** Read handler: called when we get data from a dnsworker. See
626
627
 * if we have a complete answer.  If so, call dns_found_answer on the
 * result.  If not, wait.  Returns 0. */
628
int connection_dns_process_inbuf(connection_t *conn) {
629
  char success;
630
  uint32_t addr;
631

632
633
  tor_assert(conn);
  tor_assert(conn->type == CONN_TYPE_DNSWORKER);
634

635
  if (conn->state != DNSWORKER_STATE_BUSY && buf_datalen(conn->inbuf)) {
636
    log_fn(LOG_WARN,"Bug: read data (%d bytes) from an idle dns worker (fd %d, address '%s'). Please report.",
637
           (int)buf_datalen(conn->inbuf), conn->s, safe_str(conn->address));
638
    tor_fragile_assert();
639
640
641
642
643
644
645
646

    /* 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.)",
647
             success, addr); // XXX safe_str
648
    }
649
650
    return 0;
  }
651
  if (buf_datalen(conn->inbuf) < 5) /* entire answer available? */
652
    return 0; /* not yet */
653
  tor_assert(conn->state == DNSWORKER_STATE_BUSY);
Roger Dingledine's avatar
Roger Dingledine committed
654
  tor_assert(buf_datalen(conn->inbuf) == 5);
655

656
657
  connection_fetch_from_buf(&success,1,conn);
  connection_fetch_from_buf((char *)&addr,sizeof(uint32_t),conn);
658

659
  log_fn(LOG_DEBUG, "DNSWorker (fd %d) returned answer for '%s'",
660
         conn->s, safe_str(conn->address));
661

Roger Dingledine's avatar
Roger Dingledine committed
662
663
  tor_assert(success >= DNS_RESOLVE_FAILED_TRANSIENT);
  tor_assert(success <= DNS_RESOLVE_SUCCEEDED);
664
  dns_found_answer(conn->address, ntohl(addr), success);
665

666
  tor_free(conn->address);
667
  conn->address = tor_strdup("<idle>");
668
  conn->state = DNSWORKER_STATE_IDLE;
Roger Dingledine's avatar
Roger Dingledine committed
669
  num_dnsworkers_busy--;
670
671
672
673
674
  if (conn->timestamp_created < last_rotation_time) {
    connection_mark_for_close(conn);
    num_dnsworkers--;
    spawn_enough_dnsworkers();
  }
675
676
677
  return 0;
}

678
679
680
681
682
683
/** Close and re-open all idle dnsworkers; schedule busy ones to be closed
 * and re-opened once they're no longer busy.
 **/
void dnsworkers_rotate(void)
{
  connection_t *dnsconn;
684
  log_fn(LOG_INFO, "Rotating DNS workers.");
685
686
687
688
689
690
691
692
693
  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);
  spawn_enough_dnsworkers();
}

Roger Dingledine's avatar
Roger Dingledine committed
694
/** Implementation for DNS workers; this code runs in a separate
695
696
697
 * 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
698
699
700
701
702
703
 *    - The OR says:
 *         - ADDRESSLEN [1 byte]
 *         - ADDRESS    [ADDRESSLEN bytes]
 *    - The DNS worker does the lookup, and replies:
 *         - OUTCOME    [1 byte]
 *         - IP         [4 bytes]
704
705
706
707
708
709
710
 *
 * 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.
 */
Nick Mathewson's avatar
Nick Mathewson committed
711
static int dnsworker_main(void *data) {
712
713
  char address[MAX_ADDRESSLEN];
  unsigned char address_len;
714
  char answer[5];
Roger Dingledine's avatar
Roger Dingledine committed
715
  uint32_t ip;
716
  int *fdarray = data;
Roger Dingledine's avatar
Roger Dingledine committed
717
  int fd;
718
  int result;
719

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

722
  fd = fdarray[1]; /* this side is ours */
723
#ifndef TOR_IS_MULTITHREADED
724
  tor_close_socket(fdarray[0]); /* this is the side of the socketpair the parent uses */
725
  tor_free_all(1); /* so the child doesn't hold the parent's fd's open */
726
  handle_signals(0); /* ignore interrupts from the keyboard, etc */
727
728
#endif
  tor_free(data);
729

730
  for (;;) {
731
    int r;
732

733
734
735
736
737
738
739
    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)));
      }
740
      tor_close_socket(fd);
741
      spawn_exit();
742
743
    }

744
    if (address_len && read_all(fd, address, address_len, 1) != address_len) {
745
      log_fn(LOG_ERR,"read hostname failed. Child exiting.");
746
      tor_close_socket(fd);
747
      spawn_exit();
748
    }
749
    address[address_len] = 0; /* null terminate it */
750

751
752
753
754
755
    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) {
756
      case 1:
757
        /* XXX result can never be 1, because we set it to -1 above on error */
758
        log_fn(LOG_INFO,"Could not resolve dest addr %s (transient).",safe_str(address));
759
        answer[0] = DNS_RESOLVE_FAILED_TRANSIENT;
760
761
        break;
      case -1:
762
        log_fn(LOG_INFO,"Could not resolve dest addr %s (permanent).",safe_str(address));
763
        answer[0] = DNS_RESOLVE_FAILED_PERMANENT;
764
        break;
765
      case 0:
766
        log_fn(LOG_INFO,"Resolved address '%s'.",safe_str(address));
767
        answer[0] = DNS_RESOLVE_SUCCEEDED;
768
        break;
769
    }
Roger Dingledine's avatar
Roger Dingledine committed
770
    set_uint32(answer+1, ip);
771
    if (write_all(fd, answer, 5, 1) != 5) {
772
      log_fn(LOG_ERR,"writing answer failed. Child exiting.");
773
      tor_close_socket(fd);
774
775
      spawn_exit();
    }
776
  }
777
  return 0; /* windows wants this function to return an int */
778
779
}

Roger Dingledine's avatar
Roger Dingledine committed
780
/** Launch a new DNS worker; return 0 on success, -1 on failure.
781
 */
Roger Dingledine's avatar
Roger Dingledine committed
782
static int spawn_dnsworker(void) {
783
784
  int *fdarray;
  int fd;
785
786
  connection_t *conn;

787
788
  fdarray = tor_malloc(sizeof(int)*2);
  if (tor_socketpair(AF_UNIX, SOCK_STREAM, 0, fdarray) < 0) {
789
790
    log(LOG_ERR, "Couldn't construct socketpair: %s",
        tor_socket_strerror(tor_socket_errno(-1)));
791
    tor_cleanup();
792
    tor_free(fdarray);
793
794
795
    exit(1);
  }

796
797
798
799
  /* log_fn(LOG_NOTICE,"Before spawn: fdarray @%d has %d:%d", (int)fdarray, fdarray[0],fdarray[1]); */

  fd = fdarray[0]; /* We copy this out here, since dnsworker_main may free fdarray */
  spawn_func(dnsworker_main, (void*)fdarray);
Roger Dingledine's avatar
Roger Dingledine committed
800
  log_fn(LOG_DEBUG,"just spawned a worker.");
801
#ifndef TOR_IS_MULTITHREADED
802
803
  tor_close_socket(fdarray[1]); /* we don't need the worker's side of the pipe */
  tor_free(fdarray);
804
#endif
805
806
807

  conn = connection_new(CONN_TYPE_DNSWORKER);

808
  set_socket_nonblocking(fd);
809
810

  /* set up conn so it's got all the data we need to remember */
811
  conn->s = fd;
Roger Dingledine's avatar
Roger Dingledine committed
812
  conn->address = tor_strdup("<unused>");
813

814
  if (connection_add(conn) < 0) { /* no space, forget it */
Roger Dingledine's avatar
Roger Dingledine committed
815
    log_fn(LOG_WARN,"connection_add failed. Giving up.");
816
    connection_free(conn); /* this closes fd */
817
818
819
820
821
822
823
824
825
    return -1;
  }

  conn->state = DNSWORKER_STATE_IDLE;
  connection_start_reading(conn);

  return 0; /* success */
}

Roger Dingledine's avatar
Roger Dingledine committed
826
/** If we have too many or too few DNS workers, spawn or kill some.
827
 */
Roger Dingledine's avatar
Roger Dingledine committed
828
829
static void spawn_enough_dnsworkers(void) {
  int num_dnsworkers_needed; /* aim to have 1 more than needed,
830
                           * but no less than min and no more than max */
831
832
  connection_t *dnsconn;

833
  /* XXX This may not be the best strategy. Maybe we should queue pending
834
835
836
837
838
839
   *     requests until the old ones finish or time out: otherwise, if
   *     the connection requests come fast enough, we never get any DNS done. -NM
   * XXX But if we queue them, then the adversary can pile even more
   *     queries onto us, blocking legitimate requests for even longer.
   *     Maybe we should compromise and only kill if it's been at it for
   *     more than, e.g., 2 seconds. -RD
840
   */
841
  if (num_dnsworkers_busy == MAX_DNSWORKERS) {