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

195
196
197
198
/** 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)
199
200
{
  char buf[RELAY_PAYLOAD_SIZE];
201
  size_t buflen;
202
203
204
205
206
207
208
209

  buf[0] = answer_type;

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

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

246
  HT_INSERT(cache_map, &cache_root, r);
247
248
}

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

271
272
273
274
  /* 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);
275
276
    if (exitconn->purpose == EXIT_PURPOSE_RESOLVE)
      send_resolved_cell(exitconn, RESOLVED_TYPE_IPV4);
277
    return 1;
278
279
280
  }

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

284
285
286
  /* lower-case exitconn->address, so it's in canonical form */
  tor_strlower(exitconn->address);

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

  /* add us to the pending list */
332
  pending_connection = tor_malloc_zero(sizeof(pending_connection_t));
Roger Dingledine's avatar
Roger Dingledine committed
333
334
  pending_connection->conn = exitconn;
  resolve->pending_connections = pending_connection;
335
  exitconn->state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
Roger Dingledine committed
336

337
  insert_resolve(resolve);
Roger Dingledine's avatar
Roger Dingledine committed
338
  return assign_to_dnsworker(exitconn);
339
340
}

Roger Dingledine's avatar
Roger Dingledine committed
341
/** Find or spawn a dns worker process to handle resolving
Nick Mathewson's avatar
Nick Mathewson committed
342
 * <b>exitconn</b>-\>address; tell that dns worker to begin resolving.
343
 */
344
345
346
static int
assign_to_dnsworker(connection_t *exitconn)
{
347
348
  connection_t *dnsconn;
  unsigned char len;
349

Roger Dingledine's avatar
Roger Dingledine committed
350
  tor_assert(exitconn->state == EXIT_CONN_STATE_RESOLVING);
351
  tor_assert(exitconn->s == -1);
352

353
354
355
356
  /* respawn here, to be sure there are enough */
  if (spawn_enough_dnsworkers() < 0) {
    goto err;
  }
357

358
359
  dnsconn = connection_get_by_type_state(CONN_TYPE_DNSWORKER,
                                         DNSWORKER_STATE_IDLE);
360

361
  if (!dnsconn) {
362
    warn(LD_EXIT,"no idle dns workers. Failing.");
363
364
    if (exitconn->purpose == EXIT_PURPOSE_RESOLVE)
      send_resolved_cell(exitconn, RESOLVED_TYPE_ERROR_TRANSIENT);
365
    goto err;
366
367
  }

368
  debug(LD_EXIT,
369
370
        "Connection (fd %d) needs to resolve '%s'; assigning "
        "to DNSWorker (fd %d)",
371
        exitconn->s, safe_str(exitconn->address), dnsconn->s);
372

373
  tor_free(dnsconn->address);
374
  dnsconn->address = tor_strdup(exitconn->address);
375
  dnsconn->state = DNSWORKER_STATE_BUSY;
Roger Dingledine's avatar
Roger Dingledine committed
376
  num_dnsworkers_busy++;
377

378
  len = strlen(dnsconn->address);
379
  connection_write_to_buf((char*)&len, 1, dnsconn);
380
  connection_write_to_buf(dnsconn->address, len, dnsconn);
381
382

  return 0;
383
err:
384
  dns_cancel_pending_resolve(exitconn->address); /* also sends end and frees */
385
  return -1;
386
387
}

Nick Mathewson's avatar
Nick Mathewson committed
388
/** Remove <b>conn</b> from the list of connections waiting for conn-\>address.
389
 */
390
391
void
connection_dns_remove(connection_t *conn)
392
{
393
394
395
  pending_connection_t *pend, *victim;
  cached_resolve_t search;
  cached_resolve_t *resolve;
396

397
398
399
  tor_assert(conn->type == CONN_TYPE_EXIT);
  tor_assert(conn->state == EXIT_CONN_STATE_RESOLVING);

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

402
  resolve = HT_FIND(cache_map, &cache_root, &search);
403
  if (!resolve) {
404
    /* XXXX RD This *is* a bug, right? -NM */
405
406
    notice(LD_BUG, "Address '%s' is not pending. Dropping.",
           safe_str(conn->address));
407
408
409
    return;
  }

Roger Dingledine's avatar
Roger Dingledine committed
410
  tor_assert(resolve->pending_connections);
411
412
413
414
  assert_connection_ok(conn,0);

  pend = resolve->pending_connections;

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

Roger Dingledine's avatar
Roger Dingledine committed
438
/** Log an error and abort if conn is waiting for a DNS resolve.
439
 */
440
441
442
void
assert_connection_edge_not_dns_pending(connection_t *conn)
{
443
  pending_connection_t *pend;
444
  cached_resolve_t **resolve;
445

446
  HT_FOREACH(resolve, cache_map, &cache_root) {
447
    for (pend = (*resolve)->pending_connections;
448
449
         pend;
         pend = pend->next) {
Roger Dingledine's avatar
Roger Dingledine committed
450
      tor_assert(pend->conn != conn);
451
452
453
454
    }
  }
}

Roger Dingledine's avatar
Roger Dingledine committed
455
/** Log an error and abort if any connection waiting for a DNS resolve is
456
 * corrupted. */
457
458
459
void
assert_all_pending_dns_resolves_ok(void)
{
460
  pending_connection_t *pend;
461
  cached_resolve_t **resolve;
462

463
  HT_FOREACH(resolve, cache_map, &cache_root) {
464
    for (pend = (*resolve)->pending_connections;
465
466
         pend;
         pend = pend->next) {
467
      assert_connection_ok(pend->conn, 0);
468
469
      tor_assert(pend->conn->s == -1);
      tor_assert(!connection_in_array(pend->conn));
470
471
472
473
    }
  }
}

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

Nick Mathewson's avatar
Nick Mathewson committed
487
  strlcpy(search.address, address, sizeof(search.address));
488

489
  resolve = HT_FIND(cache_map, &cache_root, &search);
490
  if (!resolve) {
491
492
    /* XXXX RD This *is* a bug, right? -NM */
    notice(LD_BUG,"Address '%s' is not pending. Dropping.", safe_str(address));
493
494
495
    return;
  }

496
497
  if (!resolve->pending_connections) {
    /* XXX this should never trigger, but sometimes it does */
498
    warn(LD_BUG,"Bug: Address '%s' is pending but has no pending connections!",
499
         safe_str(address));
500
    tor_fragile_assert();
501
502
    return;
  }
Roger Dingledine's avatar
Roger Dingledine committed
503
  tor_assert(resolve->pending_connections);
504

505
  /* mark all pending connections to fail */
506
507
  debug(LD_EXIT, "Failing all connections waiting on DNS resolve of '%s'",
        safe_str(address));
508
  while (resolve->pending_connections) {
509
    pend = resolve->pending_connections;
510
    pend->conn->state = EXIT_CONN_STATE_RESOLVEFAILED;
511
    pendconn = pend->conn;
512
    tor_assert(pendconn->s == -1);
513
    if (!pendconn->marked_for_close) {
514
515
      connection_edge_end(pendconn, END_STREAM_REASON_RESOURCELIMIT,
                          pendconn->cpath_layer);
516
    }
517
    circ = circuit_get_by_edge_conn(pendconn);
518
519
    if (circ)
      circuit_detach_stream(circ, pendconn);
520
    connection_free(pendconn);
521
522
    resolve->pending_connections = pend->next;
    tor_free(pend);
523
524
  }

525
526
527
  dns_purge_resolve(resolve);
}

Nick Mathewson's avatar
Nick Mathewson committed
528
/** Remove <b>resolve</b> from the cache.
529
 */
530
static void
531
dns_purge_resolve(cached_resolve_t *resolve)
532
{
533
  cached_resolve_t *tmp;
534

535
  /* remove resolve from the linked list */
536
  if (resolve == oldest_cached_resolve) {
537
    oldest_cached_resolve = resolve->next;
538
    if (oldest_cached_resolve == NULL)
539
      newest_cached_resolve = NULL;
540
  } else {
541
    /* FFFF make it a doubly linked list if this becomes too slow */
542
543
544
545
    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 */
546
547
    tmp->next = resolve->next; /* unlink it */

548
    if (newest_cached_resolve == resolve)
549
      newest_cached_resolve = tmp;
550
  }
551

552
  /* remove resolve from the map */
553
  HT_REMOVE(cache_map, &cache_root, resolve);
554

555
  tor_free(resolve);
556
557
}

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

Nick Mathewson's avatar
Nick Mathewson committed
574
  strlcpy(search.address, address, sizeof(search.address));
575

576
  resolve = HT_FIND(cache_map, &cache_root, &search);
577
  if (!resolve) {
578
579
    info(LD_EXIT,"Resolved unasked address '%s'; caching anyway.",
         safe_str(address));
580
    resolve = tor_malloc_zero(sizeof(cached_resolve_t));
581
582
583
584
585
    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);
586
    return;
587
588
  }

589
  if (resolve->state != CACHE_STATE_PENDING) {
590
591
    /* XXXX Maybe update addr? or check addr for consistency? Or let
     * VALID replace FAILED? */
592
    notice(LD_EXIT, "Resolved '%s' which was already resolved; ignoring",
593
           safe_str(address));
Roger Dingledine's avatar
Roger Dingledine committed
594
    tor_assert(resolve->pending_connections == NULL);
595
596
597
598
599
600
    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
601
  /* tor_assert(resolve->state == CACHE_STATE_PENDING); */
602

603
  resolve->addr = addr;
604
  if (outcome == DNS_RESOLVE_SUCCEEDED)
605
606
607
608
    resolve->state = CACHE_STATE_VALID;
  else
    resolve->state = CACHE_STATE_FAILED;

609
  while (resolve->pending_connections) {
610
    pend = resolve->pending_connections;
611
    assert_connection_ok(pend->conn,time(NULL));
612
    pend->conn->addr = resolve->addr;
613
614
    pendconn = pend->conn; /* don't pass complex things to the
                              connection_mark_for_close macro */
615

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

635
        circ = circuit_get_by_edge_conn(pend->conn);
636
637
638
639
640
        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;
641
        pend->conn->on_circuit = circ;
642
643
644
645
646
647
648
649
        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);
650
        circ = circuit_get_by_edge_conn(pendconn);
651
652
653
654
        tor_assert(circ);
        circuit_detach_stream(circ, pendconn);
        connection_free(pendconn);
      }
Roger Dingledine's avatar
Roger Dingledine committed
655
    }
656
657
    resolve->pending_connections = pend->next;
    tor_free(pend);
658
  }
659

660
  if (outcome == DNS_RESOLVE_FAILED_TRANSIENT) { /* remove from cache */
661
662
    dns_purge_resolve(resolve);
  }
663
664
}

665
666
/******************************************************************/

Nick Mathewson's avatar
Nick Mathewson committed
667
/*
668
 * Connection between OR and dnsworker
Nick Mathewson's avatar
Nick Mathewson committed
669
 */
670

Roger Dingledine's avatar
Roger Dingledine committed
671
/** Write handler: called when we've pushed a request to a dnsworker. */
672
673
674
int
connection_dns_finished_flushing(connection_t *conn)
{
675
676
  tor_assert(conn);
  tor_assert(conn->type == CONN_TYPE_DNSWORKER);
677
678
679
680
  connection_stop_writing(conn);
  return 0;
}

681
682
683
int
connection_dns_reached_eof(connection_t *conn)
{
684
  warn(LD_EXIT,"Read eof. Worker died unexpectedly.");
685
  if (conn->state == DNSWORKER_STATE_BUSY) {
686
687
688
689
    /* don't cancel the resolve here -- it would be cancelled in
     * connection_about_to_close_connection(), since conn is still
     * in state BUSY
     */
690
691
692
693
694
695
696
697
    num_dnsworkers_busy--;
  }
  num_dnsworkers--;
  connection_mark_for_close(conn);
  return 0;
}

/** Read handler: called when we get data from a dnsworker. See
698
699
 * if we have a complete answer.  If so, call dns_found_answer on the
 * result.  If not, wait.  Returns 0. */
700
701
702
int
connection_dns_process_inbuf(connection_t *conn)
{
703
  char success;
704
  uint32_t addr;
705

706
707
  tor_assert(conn);
  tor_assert(conn->type == CONN_TYPE_DNSWORKER);
708

709
  if (conn->state != DNSWORKER_STATE_BUSY && buf_datalen(conn->inbuf)) {
710
711
    warn(LD_BUG,"Bug: read data (%d bytes) from an idle dns worker (fd %d, "
         "address '%s'). Please report.",
712
         (int)buf_datalen(conn->inbuf), conn->s, safe_str(conn->address));
713
    tor_fragile_assert();
714
715
716
717
718
719
720

    /* 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);
721
      warn(LD_EXIT,"Discarding idle dns answer (success %d, addr %d.)",
722
           success, addr); // XXX safe_str
723
    }
724
725
    return 0;
  }
726
  if (buf_datalen(conn->inbuf) < 5) /* entire answer available? */
727
    return 0; /* not yet */
728
  tor_assert(conn->state == DNSWORKER_STATE_BUSY);
Roger Dingledine's avatar
Roger Dingledine committed
729
  tor_assert(buf_datalen(conn->inbuf) == 5);
730

731
732
  connection_fetch_from_buf(&success,1,conn);
  connection_fetch_from_buf((char *)&addr,sizeof(uint32_t),conn);
733

734
735
  debug(LD_EXIT, "DNSWorker (fd %d) returned answer for '%s'",
        conn->s, safe_str(conn->address));
736

Roger Dingledine's avatar
Roger Dingledine committed
737
738
  tor_assert(success >= DNS_RESOLVE_FAILED_TRANSIENT);
  tor_assert(success <= DNS_RESOLVE_SUCCEEDED);
739
  dns_found_answer(conn->address, ntohl(addr), success);
740

741
  tor_free(conn->address);
742
  conn->address = tor_strdup("<idle>");
743
  conn->state = DNSWORKER_STATE_IDLE;
Roger Dingledine's avatar
Roger Dingledine committed
744
  num_dnsworkers_busy--;
745
746
747
748
749
  if (conn->timestamp_created < last_rotation_time) {
    connection_mark_for_close(conn);
    num_dnsworkers--;
    spawn_enough_dnsworkers();
  }
750
751
752
  return 0;
}

753
754
755
/** Close and re-open all idle dnsworkers; schedule busy ones to be closed
 * and re-opened once they're no longer busy.
 **/
756
757
void
dnsworkers_rotate(void)
758
759
760
761
762
763
764
765
{
  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);
766
767
  if (server_mode(get_options()))
    spawn_enough_dnsworkers();
768
769
}

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

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

801
  fd = fdarray[1]; /* this side is ours */
802
#ifndef TOR_IS_MULTITHREADED
803
804
  tor_close_socket(fdarray[0]); /* this is the side of the socketpair the
                                 * parent uses */
805
  tor_free_all(1); /* so the child doesn't hold the parent's fd's open */
806
  handle_signals(0); /* ignore interrupts from the keyboard, etc */
807
808
#endif
  tor_free(data);
809