dns.c 22.5 KB
Newer Older
1
2
3
4
/* Copyright 2003 Roger Dingledine. */
/* See LICENSE for licensing information */
/* $Id$ */

Roger Dingledine's avatar
Roger Dingledine committed
5
6
7
8
/**
 * \file dns.c
 * \brief Resolve hostnames in separate processes.
 **/
9

10
11
12
13
14
/* 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.
 */

15
#include "or.h"
16
#include "tree.h"
17

18
extern or_options_t options; /* command-line and config-file options */
Roger Dingledine's avatar
Roger Dingledine committed
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 50
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. */
Roger Dingledine's avatar
Roger Dingledine committed
38
int num_dnsworkers=0;
39
/** How many of the running dnsworkers have an assigned task right now. */
Roger Dingledine's avatar
Roger Dingledine committed
40
int num_dnsworkers_busy=0;
41

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

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

65
66
67
68
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
69
static int dnsworker_main(void *data);
70
71
72
static int spawn_dnsworker(void);
static void spawn_enough_dnsworkers(void);

73
/** Splay tree of cached_resolve objects. */
74
static SPLAY_HEAD(cache_tree, cached_resolve) cache_root;
75

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

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

87
/** Initialize the DNS cache. */
88
static void init_cache_tree(void) {
89
90
91
  SPLAY_INIT(&cache_root);
}

Roger Dingledine's avatar
Roger Dingledine committed
92
/** Initialize the DNS subsystem; called by the OR process. */
93
94
void dns_init(void) {
  init_cache_tree();
Roger Dingledine's avatar
Roger Dingledine committed
95
  spawn_enough_dnsworkers();
96
}
97

98
/** Linked list of resolved addresses, oldest to newest. */
Roger Dingledine's avatar
Roger Dingledine committed
99
100
static struct cached_resolve *oldest_cached_resolve = NULL;
static struct cached_resolve *newest_cached_resolve = NULL;
101

Nick Mathewson's avatar
Nick Mathewson committed
102
/** Remove every cached_resolve whose <b>expire</b> time is before <b>now</b>
103
 * from the cache. */
104
105
106
107
108
109
110
111
static void purge_expired_resolves(uint32_t now) {
  struct cached_resolve *resolve;

  /* this is fast because the linked list
   * oldest_cached_resolve is ordered by when they came in.
   */
  while(oldest_cached_resolve && (oldest_cached_resolve->expire < now)) {
    resolve = oldest_cached_resolve;
112
    log(LOG_DEBUG,"Forgetting old cached resolve (expires %lu)", (unsigned long)resolve->expire);
113
114
115
116
117
118
    if(resolve->state == CACHE_STATE_PENDING) {
      log_fn(LOG_WARN,"Expiring a dns resolve that's still pending. Forgot to cull it?");
      /* XXX if resolve->pending_connections is used, then we're probably
       * introducing bugs by closing resolve without notifying those streams.
       */
    }
119
120
121
122
    oldest_cached_resolve = resolve->next;
    if(!oldest_cached_resolve) /* if there are no more, */
      newest_cached_resolve = NULL; /* then make sure the list's tail knows that too */
    SPLAY_REMOVE(cache_tree, &cache_root, resolve);
123
    tor_free(resolve);
124
125
126
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
127
128
/** 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.
129
 * If resolve failed, return -1.
130
131
132
133
134
135
136
137
138
 *
 * 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
139
  struct cached_resolve search;
140
  struct pending_connection_t *pending_connection;
141
  struct in_addr in;
142
  uint32_t now = time(NULL);
143
  assert_connection_ok(exitconn, 0);
144

145
146
147
148
149
  /* 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);
    return 1;
150
151
152
153
  }

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

156
157
  /* now check the tree to see if 'address' is already there. */
  strncpy(search.address, exitconn->address, MAX_ADDRESSLEN);
158
  search.address[MAX_ADDRESSLEN-1] = 0;
Roger Dingledine's avatar
   
Roger Dingledine committed
159
  resolve = SPLAY_FIND(cache_tree, &cache_root, &search);
160
  if(resolve) { /* already there */
161
162
163
    switch(resolve->state) {
      case CACHE_STATE_PENDING:
        /* add us to the pending list */
164
        pending_connection = tor_malloc(sizeof(struct pending_connection_t));
165
        pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
166
167
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
168
169
        log_fn(LOG_DEBUG,"Connection (fd %d) waiting for pending DNS resolve of '%s'",
               exitconn->s, exitconn->address);
170
        exitconn->state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
   
Roger Dingledine committed
171
        return 0;
172
      case CACHE_STATE_VALID:
173
        exitconn->addr = resolve->addr;
174
175
        log_fn(LOG_DEBUG,"Connection (fd %d) found cached answer for '%s'",
               exitconn->s, exitconn->address);
176
        return 1;
177
178
179
      case CACHE_STATE_FAILED:
        return -1;
    }
Roger Dingledine's avatar
Roger Dingledine committed
180
    tor_assert(0);
Roger Dingledine's avatar
Roger Dingledine committed
181
182
183
184
  }
  /* not there, need to add it */
  resolve = tor_malloc_zero(sizeof(struct cached_resolve));
  resolve->state = CACHE_STATE_PENDING;
185
186
  resolve->expire = now + MAX_DNS_ENTRY_AGE;
  strncpy(resolve->address, exitconn->address, MAX_ADDRESSLEN);
187
  resolve->address[MAX_ADDRESSLEN-1] = 0;
Roger Dingledine's avatar
Roger Dingledine committed
188
189
190
191

  /* add us to the pending list */
  pending_connection = tor_malloc(sizeof(struct pending_connection_t));
  pending_connection->conn = exitconn;
192
  pending_connection->next = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
193
  resolve->pending_connections = pending_connection;
194
  exitconn->state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
Roger Dingledine committed
195
196
197
198
199
200

  /* add us to the linked list of resolves */
  if (!oldest_cached_resolve) {
    oldest_cached_resolve = resolve;
  } else {
    newest_cached_resolve->next = resolve;
201
  }
Roger Dingledine's avatar
Roger Dingledine committed
202
  newest_cached_resolve = resolve;
203

Roger Dingledine's avatar
Roger Dingledine committed
204
205
  SPLAY_INSERT(cache_tree, &cache_root, resolve);
  return assign_to_dnsworker(exitconn);
206
207
}

Roger Dingledine's avatar
Roger Dingledine committed
208
/** Find or spawn a dns worker process to handle resolving
Nick Mathewson's avatar
Nick Mathewson committed
209
 * <b>exitconn</b>-\>address; tell that dns worker to begin resolving.
210
 */
Roger Dingledine's avatar
Roger Dingledine committed
211
static int assign_to_dnsworker(connection_t *exitconn) {
212
213
  connection_t *dnsconn;
  unsigned char len;
214

Roger Dingledine's avatar
Roger Dingledine committed
215
  tor_assert(exitconn->state == EXIT_CONN_STATE_RESOLVING);
216

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

219
  dnsconn = connection_get_by_type_state(CONN_TYPE_DNSWORKER, DNSWORKER_STATE_IDLE);
220
221

  if(!dnsconn) {
Roger Dingledine's avatar
Roger Dingledine committed
222
    log_fn(LOG_WARN,"no idle dns workers. Failing.");
223
    dns_cancel_pending_resolve(exitconn->address);
224
    return -1;
225
226
  }

227
228
229
  log_fn(LOG_DEBUG, "Connection (fd %d) needs to resolve '%s'; assigning to DNSWorker (fd %d)",
         exitconn->s, exitconn->address, dnsconn->s);

230
  tor_free(dnsconn->address);
231
  dnsconn->address = tor_strdup(exitconn->address);
232
  dnsconn->state = DNSWORKER_STATE_BUSY;
Roger Dingledine's avatar
Roger Dingledine committed
233
  num_dnsworkers_busy++;
234

235
  len = strlen(dnsconn->address);
236
237
  connection_write_to_buf(&len, 1, dnsconn);
  connection_write_to_buf(dnsconn->address, len, dnsconn);
238

Roger Dingledine's avatar
Roger Dingledine committed
239
//  log_fn(LOG_DEBUG,"submitted '%s'", exitconn->address);
240
241
242
  return 0;
}

Nick Mathewson's avatar
Nick Mathewson committed
243
/** Remove <b>conn</b> from the list of connections waiting for conn-\>address.
244
 */
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
void connection_dns_remove(connection_t *conn)
{
  struct pending_connection_t *pend, *victim;
  struct cached_resolve search;
  struct cached_resolve *resolve;

  strncpy(search.address, conn->address, MAX_ADDRESSLEN);
  search.address[MAX_ADDRESSLEN-1] = 0;

  resolve = SPLAY_FIND(cache_tree, &cache_root, &search);
  if(!resolve) {
    log_fn(LOG_WARN,"Address '%s' is not pending. Dropping.", conn->address);
    return;
  }

Roger Dingledine's avatar
Roger Dingledine committed
260
  tor_assert(resolve->pending_connections);
261
262
263
264
265
266
  assert_connection_ok(conn,0);

  pend = resolve->pending_connections;

  if(pend->conn == conn) {
    resolve->pending_connections = pend->next;
267
    tor_free(pend);
268
    log_fn(LOG_DEBUG, "First connection (fd %d) no longer waiting for resolve of '%s'",
269
270
271
272
273
274
275
           conn->s, conn->address);
    return;
  } else {
    for( ; pend->next; pend = pend->next) {
      if(pend->next->conn == conn) {
        victim = pend->next;
        pend->next = victim->next;
276
        tor_free(victim);
277
278
279
280
281
        log_fn(LOG_DEBUG, "Connection (fd %d) no longer waiting for resolve of '%s'",
               conn->s, conn->address);
        return; /* more are pending */
      }
    }
Roger Dingledine's avatar
Roger Dingledine committed
282
    tor_assert(0); /* not reachable unless onlyconn not in pending list */
283
284
285
  }
}

Roger Dingledine's avatar
Roger Dingledine committed
286
/** Log an error and abort if conn is waiting for a DNS resolve.
287
 */
288
289
290
291
292
293
294
295
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) {
    for(pend = resolve->pending_connections;
        pend;
        pend = pend->next) {
Roger Dingledine's avatar
Roger Dingledine committed
296
      tor_assert(pend->conn != conn);
297
298
299
300
    }
  }
}

Roger Dingledine's avatar
Roger Dingledine committed
301
/** Log an error and abort if any connection waiting for a DNS resolve is
302
 * corrupted. */
303
304
305
306
307
308
309
310
311
312
313
314
315
void assert_all_pending_dns_resolves_ok(void) {
  struct pending_connection_t *pend;
  struct cached_resolve *resolve;

  SPLAY_FOREACH(resolve, cache_tree, &cache_root) {
    for(pend = resolve->pending_connections;
        pend;
        pend = pend->next) {
      assert_connection_ok(pend->conn, 0);
    }
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
316
317
318
/** 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.
319
 */
320
321
void dns_cancel_pending_resolve(char *address) {
  struct pending_connection_t *pend;
322
  struct cached_resolve search;
323
  struct cached_resolve *resolve;
324
  connection_t *pendconn;
325

326
  strncpy(search.address, address, MAX_ADDRESSLEN);
327
  search.address[MAX_ADDRESSLEN-1] = 0;
328
329
330

  resolve = SPLAY_FIND(cache_tree, &cache_root, &search);
  if(!resolve) {
331
    log_fn(LOG_WARN,"Address '%s' is not pending. Dropping.", address);
332
333
334
    return;
  }

Roger Dingledine's avatar
Roger Dingledine committed
335
  tor_assert(resolve->pending_connections);
336

337
338
339
340
  /* mark all pending connections to fail */
  log_fn(LOG_DEBUG, "Failing all connections waiting on DNS resolve of '%s'",
         address);
  while(resolve->pending_connections) {
341
    pend = resolve->pending_connections;
342
343
    /* So that mark_for_close doesn't double-remove the connection. */
    pend->conn->state = EXIT_CONN_STATE_RESOLVEFAILED;
344
345
    pendconn = pend->conn; /* don't pass complex things to the
                              connection_mark_for_close macro */
346
347
348
349
    if(!pendconn->marked_for_close) {
      connection_edge_end(pendconn, END_STREAM_REASON_MISC, pendconn->cpath_layer);
      connection_mark_for_close(pendconn);
    }
350
351
    resolve->pending_connections = pend->next;
    tor_free(pend);
352
353
  }

354
355
356
  dns_purge_resolve(resolve);
}

Nick Mathewson's avatar
Nick Mathewson committed
357
/** Remove <b>resolve</b> from the cache.
358
 */
359
360
361
static void dns_purge_resolve(struct cached_resolve *resolve) {
  struct cached_resolve *tmp;

362
363
364
365
366
  /* remove resolve from the linked list */
  if(resolve == oldest_cached_resolve) {
    oldest_cached_resolve = resolve->next;
    if(oldest_cached_resolve == NULL)
      newest_cached_resolve = NULL;
367
  } else {
368
369
    /* FFFF make it a doubly linked list if this becomes too slow */
    for(tmp=oldest_cached_resolve; tmp && tmp->next != resolve; tmp=tmp->next) ;
Roger Dingledine's avatar
Roger Dingledine committed
370
    tor_assert(tmp); /* it's got to be in the list, or we screwed up somewhere else */
371
372
373
374
    tmp->next = resolve->next; /* unlink it */

    if(newest_cached_resolve == resolve)
      newest_cached_resolve = tmp;
375
  }
376
377
378
379

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

380
  tor_free(resolve);
381
382
}

Roger Dingledine's avatar
Roger Dingledine committed
383
/** Called on the OR side when a DNS worker tells us the outcome of a DNS
384
 * resolve: tell all pending connections about the result of the lookup, and
Nick Mathewson's avatar
Nick Mathewson committed
385
386
387
388
 * 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}.
389
 */
390
static void dns_found_answer(char *address, uint32_t addr, char outcome) {
391
392
393
  struct pending_connection_t *pend;
  struct cached_resolve search;
  struct cached_resolve *resolve;
394
  connection_t *pendconn;
395
  circuit_t *circ;
396

397
  strncpy(search.address, address, MAX_ADDRESSLEN);
398
  search.address[MAX_ADDRESSLEN-1] = 0;
399
400
401

  resolve = SPLAY_FIND(cache_tree, &cache_root, &search);
  if(!resolve) {
402
    log_fn(LOG_INFO,"Resolved unasked address '%s'? Dropping.", address);
403
404
    /* XXX Why drop?  Just because we don't care now doesn't mean we shouldn't
     * XXX cache the result for later. */
405
    return;
406
407
  }

408
  if (resolve->state != CACHE_STATE_PENDING) {
409
410
    /* XXXX Maybe update addr? or check addr for consistency? Or let
     * VALID replace FAILED? */
411
412
    log_fn(LOG_WARN, "Resolved '%s' which was already resolved; ignoring",
           address);
Roger Dingledine's avatar
Roger Dingledine committed
413
    tor_assert(resolve->pending_connections == NULL);
414
415
416
417
418
419
    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
420
  /* tor_assert(resolve->state == CACHE_STATE_PENDING); */
421

422
  resolve->addr = ntohl(addr);
423
  if(outcome == DNS_RESOLVE_SUCCEEDED)
424
425
426
427
428
429
    resolve->state = CACHE_STATE_VALID;
  else
    resolve->state = CACHE_STATE_FAILED;

  while(resolve->pending_connections) {
    pend = resolve->pending_connections;
430
    assert_connection_ok(pend->conn,time(NULL));
431
    pend->conn->addr = resolve->addr;
432
433


434
    if(resolve->state == CACHE_STATE_FAILED) {
435
436
      pendconn = pend->conn; /* don't pass complex things to the
                                connection_mark_for_close macro */
437
      /* prevent double-remove. */
438
      pendconn->state = EXIT_CONN_STATE_RESOLVEFAILED;
439
      circuit_detach_stream(circuit_get_by_conn(pendconn), pendconn);
440
441
      connection_edge_end(pendconn, END_STREAM_REASON_MISC, pendconn->cpath_layer);
      connection_mark_for_close(pendconn);
442
      connection_free(pendconn);
Roger Dingledine's avatar
Roger Dingledine committed
443
    } else {
444
445
      /* prevent double-remove. */
      pend->conn->state = EXIT_CONN_STATE_CONNECTING;
446
447
448
449
450
451
452
453
454

      circ = circuit_get_by_conn(pend->conn);
      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;
      circ->n_streams = pend->conn;

455
      connection_exit_connect(pend->conn);
Roger Dingledine's avatar
Roger Dingledine committed
456
    }
457
458
    resolve->pending_connections = pend->next;
    tor_free(pend);
459
  }
460
461
462
463

  if(outcome == DNS_RESOLVE_FAILED_TRANSIENT) { /* remove from cache */
    dns_purge_resolve(resolve);
  }
464
465
}

466
467
/******************************************************************/

Nick Mathewson's avatar
Nick Mathewson committed
468
/*
469
 * Connection between OR and dnsworker
Nick Mathewson's avatar
Nick Mathewson committed
470
 */
471

Roger Dingledine's avatar
Roger Dingledine committed
472
/** Write handler: called when we've pushed a request to a dnsworker. */
473
int connection_dns_finished_flushing(connection_t *conn) {
Roger Dingledine's avatar
Roger Dingledine committed
474
  tor_assert(conn && conn->type == CONN_TYPE_DNSWORKER);
475
476
477
478
  connection_stop_writing(conn);
  return 0;
}

Roger Dingledine's avatar
Roger Dingledine committed
479
/** Read handler: called when we get data from a dnsworker.  If the
480
481
482
 * connection is closed, mark the dnsworker as dead.  Otherwise, see
 * if we have a complete answer.  If so, call dns_found_answer on the
 * result.  If not, wait.  Returns 0. */
483
int connection_dns_process_inbuf(connection_t *conn) {
484
  char success;
485
  uint32_t addr;
486

Roger Dingledine's avatar
Roger Dingledine committed
487
  tor_assert(conn && conn->type == CONN_TYPE_DNSWORKER);
488
489

  if(conn->inbuf_reached_eof) {
490
    log_fn(LOG_WARN,"Read eof. Worker died unexpectedly.");
491
    if(conn->state == DNSWORKER_STATE_BUSY) {
492
      dns_cancel_pending_resolve(conn->address);
Roger Dingledine's avatar
Roger Dingledine committed
493
      num_dnsworkers_busy--;
494
    }
Roger Dingledine's avatar
Roger Dingledine committed
495
    num_dnsworkers--;
496
    connection_mark_for_close(conn);
497
    return 0;
498
499
  }

Roger Dingledine's avatar
Roger Dingledine committed
500
  tor_assert(conn->state == DNSWORKER_STATE_BUSY);
501
  if(buf_datalen(conn->inbuf) < 5) /* entire answer available? */
502
    return 0; /* not yet */
Roger Dingledine's avatar
Roger Dingledine committed
503
  tor_assert(buf_datalen(conn->inbuf) == 5);
504

505
506
  connection_fetch_from_buf(&success,1,conn);
  connection_fetch_from_buf((char *)&addr,sizeof(uint32_t),conn);
507

508
509
510
  log_fn(LOG_DEBUG, "DNSWorker (fd %d) returned answer for '%s'",
         conn->s, conn->address);

Roger Dingledine's avatar
Roger Dingledine committed
511
512
  tor_assert(success >= DNS_RESOLVE_FAILED_TRANSIENT);
  tor_assert(success <= DNS_RESOLVE_SUCCEEDED);
513
  dns_found_answer(conn->address, addr, success);
514

515
  tor_free(conn->address);
516
  conn->address = tor_strdup("<idle>");
517
  conn->state = DNSWORKER_STATE_IDLE;
Roger Dingledine's avatar
Roger Dingledine committed
518
  num_dnsworkers_busy--;
519
520
521
522

  return 0;
}

Roger Dingledine's avatar
Roger Dingledine committed
523
/** Implementation for DNS workers; this code runs in a separate
524
525
526
 * 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
527
528
529
530
531
532
 *    - The OR says:
 *         - ADDRESSLEN [1 byte]
 *         - ADDRESS    [ADDRESSLEN bytes]
 *    - The DNS worker does the lookup, and replies:
 *         - OUTCOME    [1 byte]
 *         - IP         [4 bytes]
533
534
535
536
537
538
539
 *
 * 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
540
static int dnsworker_main(void *data) {
541
542
  char address[MAX_ADDRESSLEN];
  unsigned char address_len;
543
  char answer[5];
Roger Dingledine's avatar
Roger Dingledine committed
544
  uint32_t ip;
545
  int *fdarray = data;
Roger Dingledine's avatar
Roger Dingledine committed
546
  int fd;
547

548
  tor_close_socket(fdarray[0]); /* this is the side of the socketpair the parent uses */
549
  fd = fdarray[1]; /* this side is ours */
550
#ifndef MS_WINDOWS
551
  connection_free_all(); /* so the child doesn't hold the parent's fd's open */
552
#endif
553
554
555

  for(;;) {

556
    if(recv(fd, &address_len, 1, 0) != 1) {
557
      log_fn(LOG_INFO,"dnsworker exiting because tor process died.");
558
      spawn_exit();
559
    }
Roger Dingledine's avatar
Roger Dingledine committed
560
    tor_assert(address_len > 0);
561

562
    if(read_all(fd, address, address_len, 1) != address_len) {
563
      log_fn(LOG_ERR,"read hostname failed. Child exiting.");
564
      spawn_exit();
565
    }
566
    address[address_len] = 0; /* null terminate it */
567

Roger Dingledine's avatar
Roger Dingledine committed
568
    switch (tor_lookup_hostname(address, &ip)) {
569
      case 1:
570
571
        log_fn(LOG_INFO,"Could not resolve dest addr %s (transient).",address);
        answer[0] = DNS_RESOLVE_FAILED_TRANSIENT;
572
573
        break;
      case -1:
574
575
        log_fn(LOG_INFO,"Could not resolve dest addr %s (permanent).",address);
        answer[0] = DNS_RESOLVE_FAILED_PERMANENT;
576
        break;
577
578
579
      case 0:
        log_fn(LOG_INFO,"Resolved address '%s'.",address);
        answer[0] = DNS_RESOLVE_SUCCEEDED;
580
        break;
581
    }
Roger Dingledine's avatar
Roger Dingledine committed
582
    set_uint32(answer+1, ip);
583
584
585
586
    if(write_all(fd, answer, 5, 1) != 5) {
      log_fn(LOG_ERR,"writing answer failed. Child exiting.");
      spawn_exit();
    }
587
  }
588
  return 0; /* windows wants this function to return an int */
589
590
}

Roger Dingledine's avatar
Roger Dingledine committed
591
/** Launch a new DNS worker; return 0 on success, -1 on failure.
592
 */
Roger Dingledine's avatar
Roger Dingledine committed
593
static int spawn_dnsworker(void) {
594
595
596
  int fd[2];
  connection_t *conn;

597
  if(tor_socketpair(AF_UNIX, SOCK_STREAM, 0, fd) < 0) {
598
599
    log(LOG_ERR, "Couldn't construct socketpair: %s",
        tor_socket_strerror(tor_socket_errno(-1)));
600
601
602
    exit(1);
  }

603
  spawn_func(dnsworker_main, (void*)fd);
Roger Dingledine's avatar
Roger Dingledine committed
604
  log_fn(LOG_DEBUG,"just spawned a worker.");
605
  tor_close_socket(fd[1]); /* we don't need the worker's side of the pipe */
606
607
608

  conn = connection_new(CONN_TYPE_DNSWORKER);

609
  set_socket_nonblocking(fd[0]);
610
611
612

  /* set up conn so it's got all the data we need to remember */
  conn->s = fd[0];
Roger Dingledine's avatar
Roger Dingledine committed
613
  conn->address = tor_strdup("<unused>");
614
615

  if(connection_add(conn) < 0) { /* no space, forget it */
Roger Dingledine's avatar
Roger Dingledine committed
616
    log_fn(LOG_WARN,"connection_add failed. Giving up.");
617
618
619
620
621
622
623
624
625
626
    connection_free(conn); /* this closes fd[0] */
    return -1;
  }

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

  return 0; /* success */
}

Roger Dingledine's avatar
Roger Dingledine committed
627
/** If we have too many or too few DNS workers, spawn or kill some.
628
 */
Roger Dingledine's avatar
Roger Dingledine committed
629
630
static void spawn_enough_dnsworkers(void) {
  int num_dnsworkers_needed; /* aim to have 1 more than needed,
631
                           * but no less than min and no more than max */
632
633
  connection_t *dnsconn;

634
  /* XXX This may not be the best strategy. Maybe we should queue pending
635
636
637
638
639
640
   *     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
641
   */
Roger Dingledine's avatar
Roger Dingledine committed
642
  if(num_dnsworkers_busy == MAX_DNSWORKERS) {
643
644
645
    /* We always want at least one worker idle.
     * So find the oldest busy worker and kill it.
     */
646
647
    dnsconn = connection_get_by_type_state_lastwritten(CONN_TYPE_DNSWORKER,
                                                       DNSWORKER_STATE_BUSY);
Roger Dingledine's avatar
Roger Dingledine committed
648
    tor_assert(dnsconn);
649

650
651
    log_fn(LOG_WARN, "%d DNS workers are spawned; all are busy. Killing one.",
           MAX_DNSWORKERS);
652

653
    connection_mark_for_close(dnsconn);
Roger Dingledine's avatar
Roger Dingledine committed
654
    num_dnsworkers_busy--;
655
    num_dnsworkers--;
656
  }
657

Roger Dingledine's avatar
Roger Dingledine committed
658
659
  if(num_dnsworkers_busy >= MIN_DNSWORKERS)
    num_dnsworkers_needed = num_dnsworkers_busy+1;
660
  else
Roger Dingledine's avatar
Roger Dingledine committed
661
    num_dnsworkers_needed = MIN_DNSWORKERS;
662

Roger Dingledine's avatar
Roger Dingledine committed
663
664
  while(num_dnsworkers < num_dnsworkers_needed) {
    if(spawn_dnsworker() < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
665
      log(LOG_WARN,"spawn_enough_dnsworkers(): spawn failed!");
666
667
      return;
    }
Roger Dingledine's avatar
Roger Dingledine committed
668
    num_dnsworkers++;
669
670
  }

671
  while(num_dnsworkers > num_dnsworkers_busy+MAX_IDLE_DNSWORKERS) { /* too many idle? */
672
    /* cull excess workers */
673
674
    log_fn(LOG_WARN,"%d of %d dnsworkers are idle. Killing one.",
           num_dnsworkers-num_dnsworkers_needed, num_dnsworkers);
675
    dnsconn = connection_get_by_type_state(CONN_TYPE_DNSWORKER, DNSWORKER_STATE_IDLE);
Roger Dingledine's avatar
Roger Dingledine committed
676
    tor_assert(dnsconn);
677
    connection_mark_for_close(dnsconn);
Roger Dingledine's avatar
Roger Dingledine committed
678
    num_dnsworkers--;
679
  }
680
681
}

682
683
684
685
686
687
688
/*
  Local Variables:
  mode:c
  indent-tabs-mode:nil
  c-basic-offset:2
  End:
*/