dns.c 23.9 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. */
38
static int num_dnsworkers=0;
39
/** How many of the running dnsworkers have an assigned task right now. */
40
41
42
static int num_dnsworkers_busy=0;
/** When did we last rotate the dnsworkers? */
static time_t last_rotation_time=0;
43

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

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

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

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

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

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

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

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

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

Nick Mathewson's avatar
Nick Mathewson committed
105
/** Remove every cached_resolve whose <b>expire</b> time is before <b>now</b>
106
 * from the cache. */
107
108
static void purge_expired_resolves(uint32_t now) {
  struct cached_resolve *resolve;
109
110
  struct pending_connection_t *pend;
  connection_t *pendconn;
111
112
113
114
115
116

  /* 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;
117
    log(LOG_DEBUG,"Forgetting old cached resolve (expires %lu)", (unsigned long)resolve->expire);
118
119
    if(resolve->state == CACHE_STATE_PENDING) {
      log_fn(LOG_WARN,"Expiring a dns resolve that's still pending. Forgot to cull it?");
120
121
122
123
124
125
126
127
128
129
130
    }
    if (resolve->pending_connections) {
      log_fn(LOG_WARN, "Closing pending connections on expiring DNS resolve!");
      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;
        connection_edge_end(pendconn, END_STREAM_REASON_MISC,
                            pendconn->cpath_layer);
131
        circuit_detach_stream(circuit_get_by_conn(pendconn), pendconn);
132
133
134
        connection_free(pendconn);
        tor_free(pend);
      }
135
    }
136
137
138
139
    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);
140
    tor_free(resolve);
141
142
143
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
144
145
/** 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.
146
 * If resolve failed, return -1.
147
148
149
150
151
152
153
154
155
 *
 * 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
156
  struct cached_resolve search;
157
  struct pending_connection_t *pending_connection;
158
  struct in_addr in;
159
  uint32_t now = time(NULL);
160
  assert_connection_ok(exitconn, 0);
161
  tor_assert(exitconn->s == -1);
162

163
164
165
166
167
  /* 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;
168
169
170
171
  }

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

174
175
  /* now check the tree to see if 'address' is already there. */
  strncpy(search.address, exitconn->address, MAX_ADDRESSLEN);
176
  search.address[MAX_ADDRESSLEN-1] = 0;
Roger Dingledine's avatar
   
Roger Dingledine committed
177
  resolve = SPLAY_FIND(cache_tree, &cache_root, &search);
178
  if(resolve) { /* already there */
179
180
181
    switch(resolve->state) {
      case CACHE_STATE_PENDING:
        /* add us to the pending list */
182
        pending_connection = tor_malloc(sizeof(struct pending_connection_t));
183
        pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
184
185
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
186
187
        log_fn(LOG_DEBUG,"Connection (fd %d) waiting for pending DNS resolve of '%s'",
               exitconn->s, exitconn->address);
188
        exitconn->state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
   
Roger Dingledine committed
189
        return 0;
190
      case CACHE_STATE_VALID:
191
        exitconn->addr = resolve->addr;
192
193
        log_fn(LOG_DEBUG,"Connection (fd %d) found cached answer for '%s'",
               exitconn->s, exitconn->address);
194
        return 1;
195
196
197
      case CACHE_STATE_FAILED:
        return -1;
    }
Roger Dingledine's avatar
Roger Dingledine committed
198
    tor_assert(0);
Roger Dingledine's avatar
Roger Dingledine committed
199
200
201
202
  }
  /* not there, need to add it */
  resolve = tor_malloc_zero(sizeof(struct cached_resolve));
  resolve->state = CACHE_STATE_PENDING;
203
204
  resolve->expire = now + MAX_DNS_ENTRY_AGE;
  strncpy(resolve->address, exitconn->address, MAX_ADDRESSLEN);
205
  resolve->address[MAX_ADDRESSLEN-1] = 0;
Roger Dingledine's avatar
Roger Dingledine committed
206
207
208
209

  /* add us to the pending list */
  pending_connection = tor_malloc(sizeof(struct pending_connection_t));
  pending_connection->conn = exitconn;
210
  pending_connection->next = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
211
  resolve->pending_connections = pending_connection;
212
  exitconn->state = EXIT_CONN_STATE_RESOLVING;
Roger Dingledine's avatar
Roger Dingledine committed
213
214
215
216
217
218

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

Roger Dingledine's avatar
Roger Dingledine committed
222
223
  SPLAY_INSERT(cache_tree, &cache_root, resolve);
  return assign_to_dnsworker(exitconn);
224
225
}

Roger Dingledine's avatar
Roger Dingledine committed
226
/** Find or spawn a dns worker process to handle resolving
Nick Mathewson's avatar
Nick Mathewson committed
227
 * <b>exitconn</b>-\>address; tell that dns worker to begin resolving.
228
 */
Roger Dingledine's avatar
Roger Dingledine committed
229
static int assign_to_dnsworker(connection_t *exitconn) {
230
231
  connection_t *dnsconn;
  unsigned char len;
232

Roger Dingledine's avatar
Roger Dingledine committed
233
  tor_assert(exitconn->state == EXIT_CONN_STATE_RESOLVING);
234
  tor_assert(exitconn->s == -1);
235

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

238
  dnsconn = connection_get_by_type_state(CONN_TYPE_DNSWORKER, DNSWORKER_STATE_IDLE);
239
240

  if(!dnsconn) {
Roger Dingledine's avatar
Roger Dingledine committed
241
    log_fn(LOG_WARN,"no idle dns workers. Failing.");
242
    dns_cancel_pending_resolve(exitconn->address);
243
    return -1;
244
245
  }

246
247
248
  log_fn(LOG_DEBUG, "Connection (fd %d) needs to resolve '%s'; assigning to DNSWorker (fd %d)",
         exitconn->s, exitconn->address, dnsconn->s);

249
  tor_free(dnsconn->address);
250
  dnsconn->address = tor_strdup(exitconn->address);
251
  dnsconn->state = DNSWORKER_STATE_BUSY;
Roger Dingledine's avatar
Roger Dingledine committed
252
  num_dnsworkers_busy++;
253

254
  len = strlen(dnsconn->address);
255
256
  connection_write_to_buf(&len, 1, dnsconn);
  connection_write_to_buf(dnsconn->address, len, dnsconn);
257

Roger Dingledine's avatar
Roger Dingledine committed
258
//  log_fn(LOG_DEBUG,"submitted '%s'", exitconn->address);
259
260
261
  return 0;
}

Nick Mathewson's avatar
Nick Mathewson committed
262
/** Remove <b>conn</b> from the list of connections waiting for conn-\>address.
263
 */
264
265
266
267
268
269
void connection_dns_remove(connection_t *conn)
{
  struct pending_connection_t *pend, *victim;
  struct cached_resolve search;
  struct cached_resolve *resolve;

270
271
272
  tor_assert(conn->type == CONN_TYPE_EXIT);
  tor_assert(conn->state == EXIT_CONN_STATE_RESOLVING);

273
274
275
276
277
278
279
280
281
  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
282
  tor_assert(resolve->pending_connections);
283
284
285
286
287
288
  assert_connection_ok(conn,0);

  pend = resolve->pending_connections;

  if(pend->conn == conn) {
    resolve->pending_connections = pend->next;
289
    tor_free(pend);
290
    log_fn(LOG_DEBUG, "First connection (fd %d) no longer waiting for resolve of '%s'",
291
292
293
294
295
296
297
           conn->s, conn->address);
    return;
  } else {
    for( ; pend->next; pend = pend->next) {
      if(pend->next->conn == conn) {
        victim = pend->next;
        pend->next = victim->next;
298
        tor_free(victim);
299
300
301
302
303
        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
304
    tor_assert(0); /* not reachable unless onlyconn not in pending list */
305
306
307
  }
}

Roger Dingledine's avatar
Roger Dingledine committed
308
/** Log an error and abort if conn is waiting for a DNS resolve.
309
 */
310
311
312
313
314
315
316
317
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
318
      tor_assert(pend->conn != conn);
319
320
321
322
    }
  }
}

Roger Dingledine's avatar
Roger Dingledine committed
323
/** Log an error and abort if any connection waiting for a DNS resolve is
324
 * corrupted. */
325
326
327
328
329
330
331
332
333
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);
334
335
      tor_assert(pend->conn->s == -1);
      tor_assert(!connection_in_array(pend->conn));
336
337
338
339
    }
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
340
341
342
/** 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.
343
 */
344
345
void dns_cancel_pending_resolve(char *address) {
  struct pending_connection_t *pend;
346
  struct cached_resolve search;
347
  struct cached_resolve *resolve;
348
  connection_t *pendconn;
349

350
  strncpy(search.address, address, MAX_ADDRESSLEN);
351
  search.address[MAX_ADDRESSLEN-1] = 0;
352
353
354

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

Roger Dingledine's avatar
Roger Dingledine committed
359
  tor_assert(resolve->pending_connections);
360

361
362
363
364
  /* mark all pending connections to fail */
  log_fn(LOG_DEBUG, "Failing all connections waiting on DNS resolve of '%s'",
         address);
  while(resolve->pending_connections) {
365
    pend = resolve->pending_connections;
366
    pend->conn->state = EXIT_CONN_STATE_RESOLVEFAILED;
367
    pendconn = pend->conn;
368
    tor_assert(pendconn->s == -1);
369
370
371
    if(!pendconn->marked_for_close) {
      connection_edge_end(pendconn, END_STREAM_REASON_MISC, pendconn->cpath_layer);
    }
372
    circuit_detach_stream(circuit_get_by_conn(pendconn), pendconn);
373
    connection_free(pendconn);
374
375
    resolve->pending_connections = pend->next;
    tor_free(pend);
376
377
  }

378
379
380
  dns_purge_resolve(resolve);
}

Nick Mathewson's avatar
Nick Mathewson committed
381
/** Remove <b>resolve</b> from the cache.
382
 */
383
384
385
static void dns_purge_resolve(struct cached_resolve *resolve) {
  struct cached_resolve *tmp;

386
387
388
389
390
  /* 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;
391
  } else {
392
393
    /* 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
394
    tor_assert(tmp); /* it's got to be in the list, or we screwed up somewhere else */
395
396
397
398
    tmp->next = resolve->next; /* unlink it */

    if(newest_cached_resolve == resolve)
      newest_cached_resolve = tmp;
399
  }
400
401
402
403

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

404
  tor_free(resolve);
405
406
}

Roger Dingledine's avatar
Roger Dingledine committed
407
/** Called on the OR side when a DNS worker tells us the outcome of a DNS
408
 * resolve: tell all pending connections about the result of the lookup, and
Nick Mathewson's avatar
Nick Mathewson committed
409
410
411
412
 * 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}.
413
 */
414
static void dns_found_answer(char *address, uint32_t addr, char outcome) {
415
416
417
  struct pending_connection_t *pend;
  struct cached_resolve search;
  struct cached_resolve *resolve;
418
  connection_t *pendconn;
419
  circuit_t *circ;
420

421
  strncpy(search.address, address, MAX_ADDRESSLEN);
422
  search.address[MAX_ADDRESSLEN-1] = 0;
423
424
425

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

432
  if (resolve->state != CACHE_STATE_PENDING) {
433
434
    /* XXXX Maybe update addr? or check addr for consistency? Or let
     * VALID replace FAILED? */
435
436
    log_fn(LOG_WARN, "Resolved '%s' which was already resolved; ignoring",
           address);
Roger Dingledine's avatar
Roger Dingledine committed
437
    tor_assert(resolve->pending_connections == NULL);
438
439
440
441
442
443
    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
444
  /* tor_assert(resolve->state == CACHE_STATE_PENDING); */
445

446
  resolve->addr = ntohl(addr);
447
  if(outcome == DNS_RESOLVE_SUCCEEDED)
448
449
450
451
452
453
    resolve->state = CACHE_STATE_VALID;
  else
    resolve->state = CACHE_STATE_FAILED;

  while(resolve->pending_connections) {
    pend = resolve->pending_connections;
454
    assert_connection_ok(pend->conn,time(NULL));
455
    pend->conn->addr = resolve->addr;
456

457
    if(resolve->state == CACHE_STATE_FAILED) {
458
459
      pendconn = pend->conn; /* don't pass complex things to the
                                connection_mark_for_close macro */
460
      /* prevent double-remove. */
461
      pendconn->state = EXIT_CONN_STATE_RESOLVEFAILED;
462
      circuit_detach_stream(circuit_get_by_conn(pendconn), pendconn);
463
      connection_edge_end(pendconn, END_STREAM_REASON_MISC, pendconn->cpath_layer);
464
      connection_free(pendconn);
Roger Dingledine's avatar
Roger Dingledine committed
465
    } else {
466
467
      /* prevent double-remove. */
      pend->conn->state = EXIT_CONN_STATE_CONNECTING;
468
469
470
471
472
473
474
475
476

      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;

477
      connection_exit_connect(pend->conn);
Roger Dingledine's avatar
Roger Dingledine committed
478
    }
479
480
    resolve->pending_connections = pend->next;
    tor_free(pend);
481
  }
482
483
484
485

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

488
489
/******************************************************************/

Nick Mathewson's avatar
Nick Mathewson committed
490
/*
491
 * Connection between OR and dnsworker
Nick Mathewson's avatar
Nick Mathewson committed
492
 */
493

Roger Dingledine's avatar
Roger Dingledine committed
494
/** Write handler: called when we've pushed a request to a dnsworker. */
495
int connection_dns_finished_flushing(connection_t *conn) {
Roger Dingledine's avatar
Roger Dingledine committed
496
  tor_assert(conn && conn->type == CONN_TYPE_DNSWORKER);
497
498
499
500
  connection_stop_writing(conn);
  return 0;
}

Roger Dingledine's avatar
Roger Dingledine committed
501
/** Read handler: called when we get data from a dnsworker.  If the
502
503
504
 * 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. */
505
int connection_dns_process_inbuf(connection_t *conn) {
506
  char success;
507
  uint32_t addr;
508

Roger Dingledine's avatar
Roger Dingledine committed
509
  tor_assert(conn && conn->type == CONN_TYPE_DNSWORKER);
510
511

  if(conn->inbuf_reached_eof) {
512
    log_fn(LOG_WARN,"Read eof. Worker died unexpectedly.");
513
    if(conn->state == DNSWORKER_STATE_BUSY) {
514
      dns_cancel_pending_resolve(conn->address);
Roger Dingledine's avatar
Roger Dingledine committed
515
      num_dnsworkers_busy--;
516
    }
Roger Dingledine's avatar
Roger Dingledine committed
517
    num_dnsworkers--;
518
    connection_mark_for_close(conn);
519
    return 0;
520
521
  }

Roger Dingledine's avatar
Roger Dingledine committed
522
  tor_assert(conn->state == DNSWORKER_STATE_BUSY);
523
  if(buf_datalen(conn->inbuf) < 5) /* entire answer available? */
524
    return 0; /* not yet */
Roger Dingledine's avatar
Roger Dingledine committed
525
  tor_assert(buf_datalen(conn->inbuf) == 5);
526

527
528
  connection_fetch_from_buf(&success,1,conn);
  connection_fetch_from_buf((char *)&addr,sizeof(uint32_t),conn);
529

530
531
532
  log_fn(LOG_DEBUG, "DNSWorker (fd %d) returned answer for '%s'",
         conn->s, conn->address);

Roger Dingledine's avatar
Roger Dingledine committed
533
534
  tor_assert(success >= DNS_RESOLVE_FAILED_TRANSIENT);
  tor_assert(success <= DNS_RESOLVE_SUCCEEDED);
535
  dns_found_answer(conn->address, addr, success);
536

537
  tor_free(conn->address);
538
  conn->address = tor_strdup("<idle>");
539
  conn->state = DNSWORKER_STATE_IDLE;
Roger Dingledine's avatar
Roger Dingledine committed
540
  num_dnsworkers_busy--;
541
542
543
544
545
  if (conn->timestamp_created < last_rotation_time) {
    connection_mark_for_close(conn);
    num_dnsworkers--;
    spawn_enough_dnsworkers();
  }
546
547
548
  return 0;
}

549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
/** Close and re-open all idle dnsworkers; schedule busy ones to be closed
 * and re-opened once they're no longer busy.
 **/
void dnsworkers_rotate(void)
{
  connection_t *dnsconn;
  while ((dnsconn = connection_get_by_type_state(CONN_TYPE_DNSWORKER,
                                                 DNSWORKER_STATE_IDLE))) {
    connection_mark_for_close(dnsconn);
    num_dnsworkers--;
  }
  last_rotation_time = time(NULL);
  spawn_enough_dnsworkers();
}

Roger Dingledine's avatar
Roger Dingledine committed
564
/** Implementation for DNS workers; this code runs in a separate
565
566
567
 * 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
568
569
570
571
572
573
 *    - The OR says:
 *         - ADDRESSLEN [1 byte]
 *         - ADDRESS    [ADDRESSLEN bytes]
 *    - The DNS worker does the lookup, and replies:
 *         - OUTCOME    [1 byte]
 *         - IP         [4 bytes]
574
575
576
577
578
579
580
 *
 * 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
581
static int dnsworker_main(void *data) {
582
583
  char address[MAX_ADDRESSLEN];
  unsigned char address_len;
584
  char answer[5];
Roger Dingledine's avatar
Roger Dingledine committed
585
  uint32_t ip;
586
  int *fdarray = data;
Roger Dingledine's avatar
Roger Dingledine committed
587
  int fd;
588

589
  tor_close_socket(fdarray[0]); /* this is the side of the socketpair the parent uses */
590
  fd = fdarray[1]; /* this side is ours */
591
#ifndef MS_WINDOWS
592
  connection_free_all(); /* so the child doesn't hold the parent's fd's open */
593
#endif
594
595
596

  for(;;) {

597
    if(recv(fd, &address_len, 1, 0) != 1) {
598
      log_fn(LOG_INFO,"dnsworker exiting because tor process died.");
599
      spawn_exit();
600
    }
Roger Dingledine's avatar
Roger Dingledine committed
601
    tor_assert(address_len > 0);
602

603
    if(read_all(fd, address, address_len, 1) != address_len) {
604
      log_fn(LOG_ERR,"read hostname failed. Child exiting.");
605
      spawn_exit();
606
    }
607
    address[address_len] = 0; /* null terminate it */
608

Roger Dingledine's avatar
Roger Dingledine committed
609
    switch (tor_lookup_hostname(address, &ip)) {
610
      case 1:
611
612
        log_fn(LOG_INFO,"Could not resolve dest addr %s (transient).",address);
        answer[0] = DNS_RESOLVE_FAILED_TRANSIENT;
613
614
        break;
      case -1:
615
616
        log_fn(LOG_INFO,"Could not resolve dest addr %s (permanent).",address);
        answer[0] = DNS_RESOLVE_FAILED_PERMANENT;
617
        break;
618
619
620
      case 0:
        log_fn(LOG_INFO,"Resolved address '%s'.",address);
        answer[0] = DNS_RESOLVE_SUCCEEDED;
621
        break;
622
    }
Roger Dingledine's avatar
Roger Dingledine committed
623
    set_uint32(answer+1, ip);
624
625
626
627
    if(write_all(fd, answer, 5, 1) != 5) {
      log_fn(LOG_ERR,"writing answer failed. Child exiting.");
      spawn_exit();
    }
628
  }
629
  return 0; /* windows wants this function to return an int */
630
631
}

Roger Dingledine's avatar
Roger Dingledine committed
632
/** Launch a new DNS worker; return 0 on success, -1 on failure.
633
 */
Roger Dingledine's avatar
Roger Dingledine committed
634
static int spawn_dnsworker(void) {
635
636
637
  int fd[2];
  connection_t *conn;

638
  if(tor_socketpair(AF_UNIX, SOCK_STREAM, 0, fd) < 0) {
639
640
    log(LOG_ERR, "Couldn't construct socketpair: %s",
        tor_socket_strerror(tor_socket_errno(-1)));
641
642
643
    exit(1);
  }

644
  spawn_func(dnsworker_main, (void*)fd);
Roger Dingledine's avatar
Roger Dingledine committed
645
  log_fn(LOG_DEBUG,"just spawned a worker.");
646
  tor_close_socket(fd[1]); /* we don't need the worker's side of the pipe */
647
648
649

  conn = connection_new(CONN_TYPE_DNSWORKER);

650
  set_socket_nonblocking(fd[0]);
651
652
653

  /* 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
654
  conn->address = tor_strdup("<unused>");
655
656

  if(connection_add(conn) < 0) { /* no space, forget it */
Roger Dingledine's avatar
Roger Dingledine committed
657
    log_fn(LOG_WARN,"connection_add failed. Giving up.");
658
659
660
661
662
663
664
665
666
667
    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
668
/** If we have too many or too few DNS workers, spawn or kill some.
669
 */
Roger Dingledine's avatar
Roger Dingledine committed
670
671
static void spawn_enough_dnsworkers(void) {
  int num_dnsworkers_needed; /* aim to have 1 more than needed,
672
                           * but no less than min and no more than max */
673
674
  connection_t *dnsconn;

675
  /* XXX This may not be the best strategy. Maybe we should queue pending
676
677
678
679
680
681
   *     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
682
   */
Roger Dingledine's avatar
Roger Dingledine committed
683
  if(num_dnsworkers_busy == MAX_DNSWORKERS) {
684
685
686
    /* We always want at least one worker idle.
     * So find the oldest busy worker and kill it.
     */
687
688
    dnsconn = connection_get_by_type_state_lastwritten(CONN_TYPE_DNSWORKER,
                                                       DNSWORKER_STATE_BUSY);
Roger Dingledine's avatar
Roger Dingledine committed
689
    tor_assert(dnsconn);
690

691
692
    log_fn(LOG_WARN, "%d DNS workers are spawned; all are busy. Killing one.",
           MAX_DNSWORKERS);
693

694
    connection_mark_for_close(dnsconn);
Roger Dingledine's avatar
Roger Dingledine committed
695
    num_dnsworkers_busy--;
696
    num_dnsworkers--;
697
  }
698

Roger Dingledine's avatar
Roger Dingledine committed
699
700
  if(num_dnsworkers_busy >= MIN_DNSWORKERS)
    num_dnsworkers_needed = num_dnsworkers_busy+1;
701
  else
Roger Dingledine's avatar
Roger Dingledine committed
702
    num_dnsworkers_needed = MIN_DNSWORKERS;
703

Roger Dingledine's avatar
Roger Dingledine committed
704
705
  while(num_dnsworkers < num_dnsworkers_needed) {
    if(spawn_dnsworker() < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
706
      log(LOG_WARN,"spawn_enough_dnsworkers(): spawn failed!");
707
708
      return;
    }
Roger Dingledine's avatar
Roger Dingledine committed
709
    num_dnsworkers++;
710
711
  }

712
  while(num_dnsworkers > num_dnsworkers_busy+MAX_IDLE_DNSWORKERS) { /* too many idle? */
713
    /* cull excess workers */
714
715
    log_fn(LOG_WARN,"%d of %d dnsworkers are idle. Killing one.",
           num_dnsworkers-num_dnsworkers_needed, num_dnsworkers);
716
    dnsconn = connection_get_by_type_state(CONN_TYPE_DNSWORKER, DNSWORKER_STATE_IDLE);
Roger Dingledine's avatar
Roger Dingledine committed
717
    tor_assert(dnsconn);
718
    connection_mark_for_close(dnsconn);
Roger Dingledine's avatar
Roger Dingledine committed
719
    num_dnsworkers--;
720
  }
721
722
}

723
724
725
726
727
728
729
/*
  Local Variables:
  mode:c
  indent-tabs-mode:nil
  c-basic-offset:2
  End:
*/