dns.c 31.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

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

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

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

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

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

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

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

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

82
83
/** Hash table of cached_resolve objects. */
static HT_HEAD(cache_map, cached_resolve_t) cache_root;
84

Roger Dingledine's avatar
Roger Dingledine committed
85
/** Function to compare hashed resolves on their addresses; used to
86
 * implement hash tables. */
87
88
static INLINE int
cached_resolves_eq(cached_resolve_t *a, cached_resolve_t *b)
89
{
90
  /* make this smarter one day? */
91
92
93
94
95
96
97
  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);
98
99
}

100
HT_PROTOTYPE(cache_map, cached_resolve_t, node, cached_resolve_hash,
101
             cached_resolves_eq);
102
HT_GENERATE(cache_map, cached_resolve_t, node, cached_resolve_hash,
103
            cached_resolves_eq, 0.6, malloc, realloc, free);
104

105
/** Initialize the DNS cache. */
106
static void
107
init_cache_map(void)
108
{
109
  HT_INIT(&cache_root);
110
111
}

Roger Dingledine's avatar
Roger Dingledine committed
112
/** Initialize the DNS subsystem; called by the OR process. */
113
114
115
void
dns_init(void)
{
116
  init_cache_map();
117
  dnsworkers_rotate();
118
}
119

120
/** Helper: free storage held by an entry in the DNS cache. */
121
static void
122
_free_cached_resolve(cached_resolve_t *r)
123
{
Nick Mathewson's avatar
Nick Mathewson committed
124
  while (r->pending_connections) {
125
    pending_connection_t *victim = r->pending_connections;
126
127
128
129
130
131
    r->pending_connections = victim->next;
    tor_free(victim);
  }
  tor_free(r);
}

132
/** Free all storage held in the DNS cache */
133
134
135
void
dns_free_all(void)
{
136
  cached_resolve_t **ptr, **next, *item;
137
  for (ptr = HT_START(cache_map, &cache_root); ptr != NULL; ptr = next) {
138
    item = *ptr;
139
    next = HT_NEXT_RMV(cache_map, &cache_root, ptr);
140
    _free_cached_resolve(item);
141
  }
142
  HT_CLEAR(cache_map, &cache_root);
143
144
}

145
/** Linked list of resolved addresses, oldest to newest. */
146
147
static cached_resolve_t *oldest_cached_resolve = NULL;
static cached_resolve_t *newest_cached_resolve = NULL;
148

Nick Mathewson's avatar
Nick Mathewson committed
149
/** Remove every cached_resolve whose <b>expire</b> time is before <b>now</b>
150
 * from the cache. */
151
152
153
static void
purge_expired_resolves(uint32_t now)
{
154
155
  cached_resolve_t *resolve;
  pending_connection_t *pend;
156
  connection_t *pendconn;
157
158
159
160

  /* this is fast because the linked list
   * oldest_cached_resolve is ordered by when they came in.
   */
161
  while (oldest_cached_resolve && (oldest_cached_resolve->expire < now)) {
162
    resolve = oldest_cached_resolve;
163
164
    log_debug(LD_EXIT,
              "Forgetting old cached resolve (address %s, expires %lu)",
165
166
              escaped_safe_str(resolve->address),
              (unsigned long)resolve->expire);
167
    if (resolve->state == CACHE_STATE_PENDING) {
168
      log_debug(LD_EXIT,
169
170
                "Bug: Expiring a dns resolve %s that's still pending."
                " Forgot to cull it?", escaped_safe_str(resolve->address));
171
      tor_fragile_assert();
172
173
    }
    if (resolve->pending_connections) {
174
175
      log_debug(LD_EXIT,
                "Closing pending connections on expiring DNS resolve!");
176
      tor_fragile_assert();
177
178
179
180
181
182
      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;
183
        connection_edge_end(pendconn, END_STREAM_REASON_TIMEOUT,
184
                            pendconn->cpath_layer);
185
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
186
187
188
        connection_free(pendconn);
        tor_free(pend);
      }
189
    }
190
    oldest_cached_resolve = resolve->next;
191
    if (!oldest_cached_resolve) /* if there are no more, */
192
193
      newest_cached_resolve = NULL; /* then make sure the list's tail knows
                                     * that too */
194
    HT_REMOVE(cache_map, &cache_root, resolve);
195
    tor_free(resolve);
196
197
198
  }
}

199
200
201
202
/** 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)
203
204
{
  char buf[RELAY_PAYLOAD_SIZE];
205
  size_t buflen;
206
207
208
209
210
211
212
213

  buf[0] = answer_type;

  switch (answer_type)
    {
    case RESOLVED_TYPE_IPV4:
      buf[1] = 4;
      set_uint32(buf+2, htonl(conn->addr));
214
215
      set_uint32(buf+6, htonl(MAX_DNS_ENTRY_AGE)); /*XXXX send a real TTL*/
      buflen = 10;
216
217
218
      break;
    case RESOLVED_TYPE_ERROR_TRANSIENT:
    case RESOLVED_TYPE_ERROR:
219
220
221
222
223
224
225
226
227
228
      {
        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;
      }
229
230
231
    default:
      tor_assert(0);
    }
232
  connection_edge_send_command(conn, circuit_get_by_edge_conn(conn),
233
234
235
236
                               RELAY_COMMAND_RESOLVED, buf, buflen,
                               conn->cpath_layer);
}

237
238
/** Link <b>r</b> into the hash table of address-to-result mappings, and add it
 * to the linked list of resolves-by-age. */
239
static void
240
insert_resolve(cached_resolve_t *r)
241
242
243
244
245
246
247
248
249
{
  /* 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;

250
  HT_INSERT(cache_map, &cache_root, r);
251
252
}

Nick Mathewson's avatar
Nick Mathewson committed
253
254
/** 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.
255
 * If resolve failed, unlink exitconn if needed, free it, and return -1.
256
257
258
259
260
261
262
 *
 * 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.
 */
263
264
265
int
dns_resolve(connection_t *exitconn)
{
266
267
268
  cached_resolve_t *resolve;
  cached_resolve_t search;
  pending_connection_t *pending_connection;
269
  struct in_addr in;
270
  circuit_t *circ;
271
  uint32_t now = time(NULL);
272
  assert_connection_ok(exitconn, 0);
273
  tor_assert(exitconn->s == -1);
274

275
276
277
278
  /* 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);
279
280
    if (exitconn->purpose == EXIT_PURPOSE_RESOLVE)
      send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
281
    return 1;
282
283
284
  }

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

288
289
290
  /* lower-case exitconn->address, so it's in canonical form */
  tor_strlower(exitconn->address);

291
  /* now check the hash table to see if 'address' is already there. */
Nick Mathewson's avatar
Nick Mathewson committed
292
  strlcpy(search.address, exitconn->address, sizeof(search.address));
293
  resolve = HT_FIND(cache_map, &cache_root, &search);
294
295
  if (resolve) { /* already there */
    switch (resolve->state) {
296
297
      case CACHE_STATE_PENDING:
        /* add us to the pending list */
298
        pending_connection = tor_malloc_zero(
299
                                      sizeof(pending_connection_t));
300
        pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
301
302
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
303
        log_debug(LD_EXIT,"Connection (fd %d) waiting for pending DNS "
304
305
                  "resolve of %s",
                  exitconn->s, escaped_safe_str(exitconn->address));
306
        exitconn->state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
   
Roger Dingledine committed
307
        return 0;
308
      case CACHE_STATE_VALID:
309
        exitconn->addr = resolve->addr;
310
311
        log_debug(LD_EXIT,"Connection (fd %d) found cached answer for %s",
                  exitconn->s, escaped_safe_str(exitconn->address));
312
313
        if (exitconn->purpose == EXIT_PURPOSE_RESOLVE)
          send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
314
        return 1;
315
      case CACHE_STATE_FAILED:
316
317
        log_debug(LD_EXIT,"Connection (fd %d) found cached error for %s",
                  exitconn->s, escaped_safe_str(exitconn->address));
318
319
        if (exitconn->purpose == EXIT_PURPOSE_RESOLVE)
          send_resolved_cell(exitconn, RESOLVED_TYPE_ERROR);
320
        circ = circuit_get_by_edge_conn(exitconn);
321
322
        if (circ)
          circuit_detach_stream(circ, exitconn);
323
324
        if (!exitconn->marked_for_close)
          connection_free(exitconn);
325
326
        return -1;
    }
Roger Dingledine's avatar
Roger Dingledine committed
327
    tor_assert(0);
Roger Dingledine's avatar
Roger Dingledine committed
328
329
  }
  /* not there, need to add it */
330
  resolve = tor_malloc_zero(sizeof(cached_resolve_t));
Roger Dingledine's avatar
Roger Dingledine committed
331
  resolve->state = CACHE_STATE_PENDING;
332
  resolve->expire = now + MAX_DNS_ENTRY_AGE;
Nick Mathewson's avatar
Nick Mathewson committed
333
  strlcpy(resolve->address, exitconn->address, sizeof(resolve->address));
Roger Dingledine's avatar
Roger Dingledine committed
334
335

  /* add us to the pending list */
336
  pending_connection = tor_malloc_zero(sizeof(pending_connection_t));
Roger Dingledine's avatar
Roger Dingledine committed
337
338
  pending_connection->conn = exitconn;
  resolve->pending_connections = pending_connection;
339
  exitconn->state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
Roger Dingledine committed
340

341
  insert_resolve(resolve);
342
343
  log_debug(LD_EXIT,"Assigning question %s to dnsworker.",
            escaped_safe_str(exitconn->address));
Roger Dingledine's avatar
Roger Dingledine committed
344
  return assign_to_dnsworker(exitconn);
345
346
}

Roger Dingledine's avatar
Roger Dingledine committed
347
/** Find or spawn a dns worker process to handle resolving
Nick Mathewson's avatar
Nick Mathewson committed
348
 * <b>exitconn</b>-\>address; tell that dns worker to begin resolving.
349
 */
350
351
352
static int
assign_to_dnsworker(connection_t *exitconn)
{
353
354
  connection_t *dnsconn;
  unsigned char len;
355

Roger Dingledine's avatar
Roger Dingledine committed
356
  tor_assert(exitconn->state == EXIT_CONN_STATE_RESOLVING);
357
  tor_assert(exitconn->s == -1);
358

359
360
361
362
  /* respawn here, to be sure there are enough */
  if (spawn_enough_dnsworkers() < 0) {
    goto err;
  }
363

364
365
  dnsconn = connection_get_by_type_state(CONN_TYPE_DNSWORKER,
                                         DNSWORKER_STATE_IDLE);
366

367
  if (!dnsconn) {
368
    log_warn(LD_EXIT,"no idle dns workers. Failing.");
369
370
    if (exitconn->purpose == EXIT_PURPOSE_RESOLVE)
      send_resolved_cell(exitconn, RESOLVED_TYPE_ERROR_TRANSIENT);
371
    goto err;
372
373
  }

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

379
  tor_free(dnsconn->address);
380
  dnsconn->address = tor_strdup(exitconn->address);
381
  dnsconn->state = DNSWORKER_STATE_BUSY;
Roger Dingledine's avatar
Roger Dingledine committed
382
  num_dnsworkers_busy++;
383

384
  len = strlen(dnsconn->address);
385
  connection_write_to_buf((char*)&len, 1, dnsconn);
386
  connection_write_to_buf(dnsconn->address, len, dnsconn);
387
388

  return 0;
389
err:
390
  dns_cancel_pending_resolve(exitconn->address); /* also sends end and frees */
391
  return -1;
392
393
}

Nick Mathewson's avatar
Nick Mathewson committed
394
/** Remove <b>conn</b> from the list of connections waiting for conn-\>address.
395
 */
396
397
void
connection_dns_remove(connection_t *conn)
398
{
399
400
401
  pending_connection_t *pend, *victim;
  cached_resolve_t search;
  cached_resolve_t *resolve;
402

403
404
405
  tor_assert(conn->type == CONN_TYPE_EXIT);
  tor_assert(conn->state == EXIT_CONN_STATE_RESOLVING);

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

408
  resolve = HT_FIND(cache_map, &cache_root, &search);
409
  if (!resolve) {
410
411
    log_notice(LD_BUG, "Address %s is not pending. Dropping.",
               escaped_safe_str(conn->address));
412
413
414
    return;
  }

Roger Dingledine's avatar
Roger Dingledine committed
415
  tor_assert(resolve->pending_connections);
416
417
418
419
  assert_connection_ok(conn,0);

  pend = resolve->pending_connections;

420
  if (pend->conn == conn) {
421
    resolve->pending_connections = pend->next;
422
    tor_free(pend);
423
    log_debug(LD_EXIT, "First connection (fd %d) no longer waiting "
424
425
              "for resolve of %s",
              conn->s, escaped_safe_str(conn->address));
426
427
    return;
  } else {
428
429
    for ( ; pend->next; pend = pend->next) {
      if (pend->next->conn == conn) {
430
431
        victim = pend->next;
        pend->next = victim->next;
432
        tor_free(victim);
433
        log_debug(LD_EXIT,
434
435
                  "Connection (fd %d) no longer waiting for resolve of %s",
                  conn->s, escaped_safe_str(conn->address));
436
437
438
        return; /* more are pending */
      }
    }
Roger Dingledine's avatar
Roger Dingledine committed
439
    tor_assert(0); /* not reachable unless onlyconn not in pending list */
440
441
442
  }
}

Roger Dingledine's avatar
Roger Dingledine committed
443
/** Log an error and abort if conn is waiting for a DNS resolve.
444
 */
445
446
447
void
assert_connection_edge_not_dns_pending(connection_t *conn)
{
448
  pending_connection_t *pend;
449
  cached_resolve_t **resolve;
450

451
  HT_FOREACH(resolve, cache_map, &cache_root) {
452
    for (pend = (*resolve)->pending_connections;
453
454
         pend;
         pend = pend->next) {
Roger Dingledine's avatar
Roger Dingledine committed
455
      tor_assert(pend->conn != conn);
456
457
458
459
    }
  }
}

Roger Dingledine's avatar
Roger Dingledine committed
460
/** Log an error and abort if any connection waiting for a DNS resolve is
461
 * corrupted. */
462
463
464
void
assert_all_pending_dns_resolves_ok(void)
{
465
  pending_connection_t *pend;
466
  cached_resolve_t **resolve;
467

468
  HT_FOREACH(resolve, cache_map, &cache_root) {
469
    for (pend = (*resolve)->pending_connections;
470
471
         pend;
         pend = pend->next) {
472
      assert_connection_ok(pend->conn, 0);
473
474
      tor_assert(pend->conn->s == -1);
      tor_assert(!connection_in_array(pend->conn));
475
476
477
478
    }
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
479
480
481
/** 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.
482
 */
483
484
485
void
dns_cancel_pending_resolve(char *address)
{
486
487
488
  pending_connection_t *pend;
  cached_resolve_t search;
  cached_resolve_t *resolve;
489
  connection_t *pendconn;
490
  circuit_t *circ;
491

Nick Mathewson's avatar
Nick Mathewson committed
492
  strlcpy(search.address, address, sizeof(search.address));
493

494
  resolve = HT_FIND(cache_map, &cache_root, &search);
495
  if (!resolve) {
496
497
    log_notice(LD_BUG,"Address %s is not pending. Dropping.",
               escaped_safe_str(address));
498
499
500
    return;
  }

501
502
  if (!resolve->pending_connections) {
    /* XXX this should never trigger, but sometimes it does */
503
    log_warn(LD_BUG,
504
505
             "Bug: Address %s is pending but has no pending connections!",
             escaped_safe_str(address));
506
    tor_fragile_assert();
507
508
    return;
  }
Roger Dingledine's avatar
Roger Dingledine committed
509
  tor_assert(resolve->pending_connections);
510

511
  /* mark all pending connections to fail */
512
  log_debug(LD_EXIT,
513
514
             "Failing all connections waiting on DNS resolve of %s",
             escaped_safe_str(address));
515
  while (resolve->pending_connections) {
516
    pend = resolve->pending_connections;
517
    pend->conn->state = EXIT_CONN_STATE_RESOLVEFAILED;
518
    pendconn = pend->conn;
519
    tor_assert(pendconn->s == -1);
520
    if (!pendconn->marked_for_close) {
521
522
      connection_edge_end(pendconn, END_STREAM_REASON_RESOURCELIMIT,
                          pendconn->cpath_layer);
523
    }
524
    circ = circuit_get_by_edge_conn(pendconn);
525
526
    if (circ)
      circuit_detach_stream(circ, pendconn);
527
    connection_free(pendconn);
528
529
    resolve->pending_connections = pend->next;
    tor_free(pend);
530
531
  }

532
533
534
  dns_purge_resolve(resolve);
}

Nick Mathewson's avatar
Nick Mathewson committed
535
/** Remove <b>resolve</b> from the cache.
536
 */
537
static void
538
dns_purge_resolve(cached_resolve_t *resolve)
539
{
540
  cached_resolve_t *tmp;
541

542
  /* remove resolve from the linked list */
543
  if (resolve == oldest_cached_resolve) {
544
    oldest_cached_resolve = resolve->next;
545
    if (oldest_cached_resolve == NULL)
546
      newest_cached_resolve = NULL;
547
  } else {
548
    /* FFFF make it a doubly linked list if this becomes too slow */
549
550
551
552
    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 */
553
554
    tmp->next = resolve->next; /* unlink it */

555
    if (newest_cached_resolve == resolve)
556
      newest_cached_resolve = tmp;
557
  }
558

559
  /* remove resolve from the map */
560
  HT_REMOVE(cache_map, &cache_root, resolve);
561

562
  tor_free(resolve);
563
564
}

Roger Dingledine's avatar
Roger Dingledine committed
565
/** Called on the OR side when a DNS worker tells us the outcome of a DNS
566
 * resolve: tell all pending connections about the result of the lookup, and
Nick Mathewson's avatar
Nick Mathewson committed
567
568
569
570
 * 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}.
571
 */
572
573
574
static void
dns_found_answer(char *address, uint32_t addr, char outcome)
{
575
576
577
  pending_connection_t *pend;
  cached_resolve_t search;
  cached_resolve_t *resolve;
578
  connection_t *pendconn;
579
  circuit_t *circ;
580

Nick Mathewson's avatar
Nick Mathewson committed
581
  strlcpy(search.address, address, sizeof(search.address));
582

583
  resolve = HT_FIND(cache_map, &cache_root, &search);
584
  if (!resolve) {
585
586
    log_info(LD_EXIT,"Resolved unasked address %s; caching anyway.",
             escaped_safe_str(address));
587
    resolve = tor_malloc_zero(sizeof(cached_resolve_t));
588
589
590
591
592
    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);
593
    return;
594
595
  }

596
  if (resolve->state != CACHE_STATE_PENDING) {
597
598
    /* XXXX Maybe update addr? or check addr for consistency? Or let
     * VALID replace FAILED? */
599
600
    log_notice(LD_EXIT, "Resolved %s which was already resolved; ignoring",
               escaped_safe_str(address));
Roger Dingledine's avatar
Roger Dingledine committed
601
    tor_assert(resolve->pending_connections == NULL);
602
603
604
605
606
607
    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
608
  /* tor_assert(resolve->state == CACHE_STATE_PENDING); */
609

610
  resolve->addr = addr;
611
  if (outcome == DNS_RESOLVE_SUCCEEDED)
612
613
614
615
    resolve->state = CACHE_STATE_VALID;
  else
    resolve->state = CACHE_STATE_FAILED;

616
  while (resolve->pending_connections) {
617
    pend = resolve->pending_connections;
618
    assert_connection_ok(pend->conn,time(NULL));
619
    pend->conn->addr = resolve->addr;
620
621
    pendconn = pend->conn; /* don't pass complex things to the
                              connection_mark_for_close macro */
622

623
    if (resolve->state == CACHE_STATE_FAILED) {
624
      /* prevent double-remove. */
625
      pendconn->state = EXIT_CONN_STATE_RESOLVEFAILED;
626
      if (pendconn->purpose == EXIT_PURPOSE_CONNECT) {
627
628
        connection_edge_end(pendconn, END_STREAM_REASON_RESOLVEFAILED,
                            pendconn->cpath_layer);
629
        /* This detach must happen after we send the end cell. */
630
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
631
      } else {
632
        send_resolved_cell(pendconn, RESOLVED_TYPE_ERROR);
633
        /* This detach must happen after we send the resolved cell. */
634
        circuit_detach_stream(circuit_get_by_edge_conn(pendconn), pendconn);
635
      }
636
      connection_free(pendconn);
Roger Dingledine's avatar
Roger Dingledine committed
637
    } else {
638
639
640
641
      if (pendconn->purpose == EXIT_PURPOSE_CONNECT) {
        /* prevent double-remove. */
        pend->conn->state = EXIT_CONN_STATE_CONNECTING;

642
        circ = circuit_get_by_edge_conn(pend->conn);
643
644
645
646
647
        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;
648
        pend->conn->on_circuit = circ;
649
650
651
652
653
654
655
656
        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);
657
        circ = circuit_get_by_edge_conn(pendconn);
658
659
660
661
        tor_assert(circ);
        circuit_detach_stream(circ, pendconn);
        connection_free(pendconn);
      }
Roger Dingledine's avatar
Roger Dingledine committed
662
    }
663
664
    resolve->pending_connections = pend->next;
    tor_free(pend);
665
  }
666

667
  if (outcome == DNS_RESOLVE_FAILED_TRANSIENT) { /* remove from cache */
668
669
    dns_purge_resolve(resolve);
  }
670
671
}

672
673
/******************************************************************/

Nick Mathewson's avatar
Nick Mathewson committed
674
/*
675
 * Connection between OR and dnsworker
Nick Mathewson's avatar
Nick Mathewson committed
676
 */
677

Roger Dingledine's avatar
Roger Dingledine committed
678
/** Write handler: called when we've pushed a request to a dnsworker. */
679
680
681
int
connection_dns_finished_flushing(connection_t *conn)
{
682
683
  tor_assert(conn);
  tor_assert(conn->type == CONN_TYPE_DNSWORKER);
684
685
686
687
  connection_stop_writing(conn);
  return 0;
}

688
689
690
int
connection_dns_reached_eof(connection_t *conn)
{
691
  log_warn(LD_EXIT,"Read eof. Worker died unexpectedly.");
692
  if (conn->state == DNSWORKER_STATE_BUSY) {
693
694
695
696
    /* don't cancel the resolve here -- it would be cancelled in
     * connection_about_to_close_connection(), since conn is still
     * in state BUSY
     */
697
698
699
700
701
702
703
704
    num_dnsworkers_busy--;
  }
  num_dnsworkers--;
  connection_mark_for_close(conn);
  return 0;
}

/** Read handler: called when we get data from a dnsworker. See
705
706
 * if we have a complete answer.  If so, call dns_found_answer on the
 * result.  If not, wait.  Returns 0. */
707
708
709
int
connection_dns_process_inbuf(connection_t *conn)
{
710
  char success;
711
  uint32_t addr;
712

713
714
  tor_assert(conn);
  tor_assert(conn->type == CONN_TYPE_DNSWORKER);
715

716
  if (conn->state != DNSWORKER_STATE_BUSY && buf_datalen(conn->inbuf)) {
717
718
    log_warn(LD_BUG,
             "Bug: read data (%d bytes) from an idle dns worker (fd %d, "
719
720
             "address %s). Please report.", (int)buf_datalen(conn->inbuf),
             conn->s, escaped_safe_str(conn->address));
721
    tor_fragile_assert();
722
723
724
725
726
727
728

    /* 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);
729
      log_warn(LD_EXIT,"Discarding idle dns answer (success %d, addr %d.)",
730
               success, addr);
731
    }
732
733
    return 0;
  }
734
  if (buf_datalen(conn->inbuf) < 5) /* entire answer available? */
735
    return 0; /* not yet */
736
  tor_assert(conn->state == DNSWORKER_STATE_BUSY);
Roger Dingledine's avatar
Roger Dingledine committed
737
  tor_assert(buf_datalen(conn->inbuf) == 5);
738

739
740
  connection_fetch_from_buf(&success,1,conn);
  connection_fetch_from_buf((char *)&addr,sizeof(uint32_t),conn);
741

742
743
  log_debug(LD_EXIT, "DNSWorker (fd %d) returned answer for %s",
            conn->s, escaped_safe_str(conn->address));
744

Roger Dingledine's avatar
Roger Dingledine committed
745
746
  tor_assert(success >= DNS_RESOLVE_FAILED_TRANSIENT);
  tor_assert(success <= DNS_RESOLVE_SUCCEEDED);
747
  dns_found_answer(conn->address, ntohl(addr), success);
748

749
  tor_free(conn->address);
750
  conn->address = tor_strdup("<idle>");
751
  conn->state = DNSWORKER_STATE_IDLE;
Roger Dingledine's avatar
Roger Dingledine committed
752
  num_dnsworkers_busy--;
753
754
755
756
757
  if (conn->timestamp_created < last_rotation_time) {
    connection_mark_for_close(conn);
    num_dnsworkers--;
    spawn_enough_dnsworkers();
  }
758
759
760
  return 0;
}

761
762
763
/** Close and re-open all idle dnsworkers; schedule busy ones to be closed
 * and re-opened once they're no longer busy.
 **/
764
765
void
dnsworkers_rotate(void)
766
767
768
769
770
771
772
773
{
  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);
774
775
  if (server_mode(get_options()))
    spawn_enough_dnsworkers();
776
777
}

Roger Dingledine's avatar
Roger Dingledine committed
778
/** Implementation for DNS workers; this code runs in a separate
779
780
781
 * 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
782
783
784
785
786
787
 *    - The OR says:
 *         - ADDRESSLEN [1 byte]
 *         - ADDRESS    [ADDRESSLEN bytes]
 *    - The DNS worker does the lookup, and replies:
 *         - OUTCOME    [1 byte]
 *         - IP         [4 bytes]
788
789
790
791
792
793
794
 *
 * 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.
 */
795
796
797
static int
dnsworker_main(void *data)
{
798
799
  char address[MAX_ADDRESSLEN];
  unsigned char address_len;
800
  char *log_address;
801
  char answer[5];
Roger Dingledine's avatar
Roger Dingledine committed
802
  uint32_t ip;
803
  int *fdarray = data;
Roger Dingledine's avatar
Roger Dingledine committed
804
  int fd;
805
  int result;
806

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

810
  fd = fdarray[1]; /* this side is ours */
811
#ifndef TOR_IS_MULTITHREADED
812
813
  tor_close_socket(fdarray[0]); /* this is the side of the socketpair the
                                 * parent uses */
814
  tor_free_all(1); /* so the child doesn't hold the parent's fd's open */
815
  handle_signals(0); /* ignore interrupts from the keyboard, etc */
816
817
#endif
  tor_free(data);
818

819
  for (;;) {