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

5
6
7
8
9
/* 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.
 */

10
#include "or.h"
11
#include "tree.h"
12

13
14
#define MAX_ADDRESSLEN 256

15
16
#define MAX_DNSWORKERS 50
#define MIN_DNSWORKERS 3
17
#define MAX_IDLE_DNSWORKERS 10
18

Roger Dingledine's avatar
Roger Dingledine committed
19
20
int num_dnsworkers=0;
int num_dnsworkers_busy=0;
21

22
static void purge_expired_resolves(uint32_t now);
Roger Dingledine's avatar
Roger Dingledine committed
23
static int assign_to_dnsworker(connection_t *exitconn);
24
static void dns_found_answer(char *address, uint32_t addr);
25
int dnsworker_main(void *data);
Roger Dingledine's avatar
Roger Dingledine committed
26
27
static int spawn_dnsworker(void);
static void spawn_enough_dnsworkers(void);
28
29
30
31
32
33
34
35

struct pending_connection_t {
  struct connection_t *conn;
  struct pending_connection_t *next;
};

struct cached_resolve {
  SPLAY_ENTRY(cached_resolve) node;
36
37
  char address[MAX_ADDRESSLEN]; /* the hostname to be resolved */
  uint32_t addr; /* in host order. I know I'm horrible for assuming ipv4 */
38
39
40
41
42
43
44
45
46
  char state; /* 0 is pending; 1 means answer is valid; 2 means resolve failed */
#define CACHE_STATE_PENDING 0
#define CACHE_STATE_VALID 1
#define CACHE_STATE_FAILED 2
  uint32_t expire; /* remove untouched items from cache after some time? */
  struct pending_connection_t *pending_connections;
  struct cached_resolve *next;
};

47
static SPLAY_HEAD(cache_tree, cached_resolve) cache_root;
48

49
50
static int compare_cached_resolves(struct cached_resolve *a,
                                   struct cached_resolve *b) {
51
  /* make this smarter one day? */
52
  return strncasecmp(a->address, b->address, MAX_ADDRESSLEN);
53
54
55
56
57
}

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

58
static void init_cache_tree(void) {
59
60
61
  SPLAY_INIT(&cache_root);
}

62
63
void dns_init(void) {
  init_cache_tree();
Roger Dingledine's avatar
Roger Dingledine committed
64
  spawn_enough_dnsworkers();
65
}
66

67
68
69
static struct cached_resolve *oldest_cached_resolve = NULL; /* linked list, */
static struct cached_resolve *newest_cached_resolve = NULL; /* oldest to newest */

70
71
72
73
74
75
76
77
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;
78
    log(LOG_DEBUG,"Forgetting old cached resolve (expires %lu)", (unsigned long)resolve->expire);
79
80
81
82
83
84
85
86
    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);
    free(resolve);
  }
}

87
/* See if we have a cache entry for 'exitconn->address'. if so,
88
89
 * if resolve valid, put it into exitconn->addr and return 1.
 * If resolve failed, return -1.
90
91
92
93
94
95
96
97
98
 *
 * 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
99
  struct cached_resolve search;
100
  struct pending_connection_t *pending_connection;
101
  uint32_t now = time(NULL);
102
  assert_connection_ok(exitconn, 0);
103

104
  /* first take this opportunity to see if there are any expired
105
106
     resolves in the tree.*/
  purge_expired_resolves(now);
107

108
109
  /* now check the tree to see if 'address' is already there. */
  strncpy(search.address, exitconn->address, MAX_ADDRESSLEN);
110
  search.address[MAX_ADDRESSLEN-1] = 0;
Roger Dingledine's avatar
   
Roger Dingledine committed
111
  resolve = SPLAY_FIND(cache_tree, &cache_root, &search);
112
  if(resolve) { /* already there */
113
114
115
    switch(resolve->state) {
      case CACHE_STATE_PENDING:
        /* add us to the pending list */
116
        pending_connection = tor_malloc(sizeof(struct pending_connection_t));
117
        pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
118
119
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
120
121
        log_fn(LOG_DEBUG,"Connection (fd %d) waiting for pending DNS resolve of '%s'",
               exitconn->s, exitconn->address);
Roger Dingledine's avatar
   
Roger Dingledine committed
122
        return 0;
123
      case CACHE_STATE_VALID:
124
        exitconn->addr = resolve->addr;
125
126
        log_fn(LOG_DEBUG,"Connection (fd %d) found cached answer for '%s'",
               exitconn->s, exitconn->address);
127
        return 1;
128
129
130
      case CACHE_STATE_FAILED:
        return -1;
    }
Roger Dingledine's avatar
Roger Dingledine committed
131
132
133
134
135
    assert(0);
  }
  /* not there, need to add it */
  resolve = tor_malloc_zero(sizeof(struct cached_resolve));
  resolve->state = CACHE_STATE_PENDING;
136
137
  resolve->expire = now + MAX_DNS_ENTRY_AGE;
  strncpy(resolve->address, exitconn->address, MAX_ADDRESSLEN);
138
  resolve->address[MAX_ADDRESSLEN-1] = 0;
Roger Dingledine's avatar
Roger Dingledine committed
139
140
141
142
143
144
145
146
147
148
149
150

  /* add us to the pending list */
  pending_connection = tor_malloc(sizeof(struct pending_connection_t));
  pending_connection->conn = exitconn;
  pending_connection->next = resolve->pending_connections;
  resolve->pending_connections = pending_connection;

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

Roger Dingledine's avatar
Roger Dingledine committed
154
155
  SPLAY_INSERT(cache_tree, &cache_root, resolve);
  return assign_to_dnsworker(exitconn);
156
157
}

Roger Dingledine's avatar
Roger Dingledine committed
158
static int assign_to_dnsworker(connection_t *exitconn) {
159
160
  connection_t *dnsconn;
  unsigned char len;
161

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

164
  dnsconn = connection_get_by_type_state(CONN_TYPE_DNSWORKER, DNSWORKER_STATE_IDLE);
165
166

  if(!dnsconn) {
Roger Dingledine's avatar
Roger Dingledine committed
167
    log_fn(LOG_WARN,"no idle dns workers. Failing.");
168
    dns_cancel_pending_resolve(exitconn->address, NULL);
169
    return -1;
170
171
  }

172
173
174
  log_fn(LOG_DEBUG, "Connection (fd %d) needs to resolve '%s'; assigning to DNSWorker (fd %d)",
         exitconn->s, exitconn->address, dnsconn->s);

Roger Dingledine's avatar
Roger Dingledine committed
175
  free(dnsconn->address);
176
  dnsconn->address = tor_strdup(exitconn->address);
177
  dnsconn->state = DNSWORKER_STATE_BUSY;
Roger Dingledine's avatar
Roger Dingledine committed
178
  num_dnsworkers_busy++;
179

180
  len = strlen(dnsconn->address);
181
182
  connection_write_to_buf(&len, 1, dnsconn);
  connection_write_to_buf(dnsconn->address, len, dnsconn);
183

Roger Dingledine's avatar
Roger Dingledine committed
184
//  log_fn(LOG_DEBUG,"submitted '%s'", exitconn->address);
185
186
187
  return 0;
}

188
189
190
191
/* if onlyconn is NULL, cancel the whole thing. if onlyconn is defined,
 * then remove onlyconn from the pending list, and if the pending list
 * is now empty, cancel the whole thing.
 */
192
void dns_cancel_pending_resolve(char *address, connection_t *onlyconn) {
193
  struct pending_connection_t *pend, *victim;
194
195
196
  struct cached_resolve search;
  struct cached_resolve *resolve, *tmp;

197
  strncpy(search.address, address, MAX_ADDRESSLEN);
198
  search.address[MAX_ADDRESSLEN-1] = 0;
199
200
201

  resolve = SPLAY_FIND(cache_tree, &cache_root, &search);
  if(!resolve) {
202
    log_fn(LOG_WARN,"Address '%s' is not pending. Dropping.", address);
203
204
205
206
    return;
  }

  assert(resolve->state == CACHE_STATE_PENDING);
207
  assert(resolve->pending_connections);
208

209
  if(onlyconn) {
210
    assert_connection_ok(onlyconn,0);
211
    pend = resolve->pending_connections;
212
213
214
    if(pend->conn == onlyconn) {
      resolve->pending_connections = pend->next;
      free(pend);
215
216
      if(resolve->pending_connections) {/* more pending, don't cancel it */
        log_fn(LOG_DEBUG, "Connection (fd %d) no longer waiting for resolve of '%s'",
217
               onlyconn->s, address);
218
        return;
219
      }
220
221
222
223
224
225
    } else {
      for( ; pend->next; pend = pend->next) {
        if(pend->next->conn == onlyconn) {
          victim = pend->next;
          pend->next = victim->next;
          free(victim);
226
          log_fn(LOG_DEBUG, "Connection (fd %d) no longer waiting for resolve of '%s'",
227
                 onlyconn->s, address);
228
229
230
231
232
233
234
          return; /* more are pending */
        }
      }
      assert(0); /* not reachable unless onlyconn not in pending list */
    }
  } else {
    /* mark all pending connections to fail */
235
    log_fn(LOG_DEBUG, "Failing all connections waiting on DNS resolve of '%s'",
236
           address);
237
238
    while(resolve->pending_connections) {
      pend = resolve->pending_connections;
239
240
      if(connection_edge_end(pend->conn, END_STREAM_REASON_MISC, NULL) < 0)
        log_fn(LOG_WARN,"1: I called connection_edge_end redundantly.");
241
242
243
      resolve->pending_connections = pend->next;
      free(pend);
    }
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
  }

  /* 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;
  } else {
    /* FFFF make it a doubly linked list if this becomes too slow */
    for(tmp=oldest_cached_resolve; tmp && tmp->next != resolve; tmp=tmp->next) ;
    assert(tmp); /* it's got to be in the list, or we screwed up somewhere else */
    tmp->next = resolve->next; /* unlink it */

    if(newest_cached_resolve == resolve)
      newest_cached_resolve = tmp;
  }

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

  free(resolve);
}

267
static void dns_found_answer(char *address, uint32_t addr) {
268
269
270
271
  struct pending_connection_t *pend;
  struct cached_resolve search;
  struct cached_resolve *resolve;

272
  strncpy(search.address, address, MAX_ADDRESSLEN);
273
  search.address[MAX_ADDRESSLEN-1] = 0;
274
275
276

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

283
  if (resolve->state != CACHE_STATE_PENDING) {
284
285
    log_fn(LOG_WARN, "Resolved '%s' which was already resolved; ignoring",
           address);
286
287
288
289
290
291
292
    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. */
  /* assert(resolve->state == CACHE_STATE_PENDING); */
293

294
295
  resolve->addr = ntohl(addr);
  if(resolve->addr)
296
297
298
299
300
301
    resolve->state = CACHE_STATE_VALID;
  else
    resolve->state = CACHE_STATE_FAILED;

  while(resolve->pending_connections) {
    pend = resolve->pending_connections;
302
    assert_connection_ok(pend->conn,0);
303
    pend->conn->addr = resolve->addr;
304
305
306
    if(resolve->state == CACHE_STATE_FAILED) {
      if(connection_edge_end(pend->conn, END_STREAM_REASON_RESOLVEFAILED, NULL) < 0)
        log_fn(LOG_WARN,"1: I called connection_edge_end redundantly.");
Roger Dingledine's avatar
Roger Dingledine committed
307
    } else {
308
      assert_connection_ok(pend->conn, time(NULL));
309
      connection_exit_connect(pend->conn);
Roger Dingledine's avatar
Roger Dingledine committed
310
    }
311
312
313
314
315
    resolve->pending_connections = pend->next;
    free(pend);
  }
}

316
317
318
319
320
321
322
323
324
/******************************************************************/

int connection_dns_finished_flushing(connection_t *conn) {
  assert(conn && conn->type == CONN_TYPE_DNSWORKER);
  connection_stop_writing(conn);
  return 0;
}

int connection_dns_process_inbuf(connection_t *conn) {
325
  uint32_t addr;
326
327
328
329

  assert(conn && conn->type == CONN_TYPE_DNSWORKER);

  if(conn->inbuf_reached_eof) {
Roger Dingledine's avatar
Roger Dingledine committed
330
    log_fn(LOG_WARN,"Read eof. Worker dying.");
331
    if(conn->state == DNSWORKER_STATE_BUSY) {
332
      dns_cancel_pending_resolve(conn->address, NULL);
Roger Dingledine's avatar
Roger Dingledine committed
333
      num_dnsworkers_busy--;
334
    }
Roger Dingledine's avatar
Roger Dingledine committed
335
    num_dnsworkers--;
336
337
338
339
    return -1;
  }

  assert(conn->state == DNSWORKER_STATE_BUSY);
340
  if(buf_datalen(conn->inbuf) < 4) /* entire answer available? */
341
    return 0; /* not yet */
342
  assert(buf_datalen(conn->inbuf) == 4);
343

344
  connection_fetch_from_buf((char*)&addr,sizeof(addr),conn);
345

346
347
348
  log_fn(LOG_DEBUG, "DNSWorker (fd %d) returned answer for '%s'",
         conn->s, conn->address);

349
  dns_found_answer(conn->address, addr);
350
351

  free(conn->address);
352
  conn->address = tor_strdup("<idle>");
353
  conn->state = DNSWORKER_STATE_IDLE;
Roger Dingledine's avatar
Roger Dingledine committed
354
  num_dnsworkers_busy--;
355
356
357
358

  return 0;
}

359
int dnsworker_main(void *data) {
360
361
  char address[MAX_ADDRESSLEN];
  unsigned char address_len;
362
  struct hostent *rent;
363
  int *fdarray = data;
Roger Dingledine's avatar
Roger Dingledine committed
364
  int fd;
365
366
367

  close(fdarray[0]); /* this is the side of the socketpair the parent uses */
  fd = fdarray[1]; /* this side is ours */
368
  connection_free_all(); /* so the child doesn't hold the parent's fd's open */
369
/* XXX probably don't close all the fd's on MS_WINDOWS? */
370
371
372

  for(;;) {

373
    if(read(fd, &address_len, 1) != 1) {
374
      log_fn(LOG_INFO,"read length failed. Child exiting.");
375
      spawn_exit();
376
    }
377
    assert(address_len > 0);
378

379
    if(read_all(fd, address, address_len) != address_len) {
380
      log_fn(LOG_ERR,"read hostname failed. Child exiting.");
381
      spawn_exit();
382
    }
383
    address[address_len] = 0; /* null terminate it */
384

385
    rent = gethostbyname(address);
386
    if (!rent) {
387
      log_fn(LOG_INFO,"Could not resolve dest addr %s. Returning nulls.",address);
Roger Dingledine's avatar
Roger Dingledine committed
388
      if(write_all(fd, "\0\0\0\0", 4) != 4) {
389
        log_fn(LOG_ERR,"writing nulls failed. Child exiting.");
390
        spawn_exit();
391
392
393
      }
    } else {
      assert(rent->h_length == 4); /* break to remind us if we move away from ipv4 */
Roger Dingledine's avatar
Roger Dingledine committed
394
      if(write_all(fd, rent->h_addr, 4) != 4) {
395
        log_fn(LOG_INFO,"writing answer failed. Child exiting.");
396
        spawn_exit();
397
      }
398
      log_fn(LOG_INFO,"Resolved address '%s'.",address);
399
400
    }
  }
401
  return 0; /* windows wants this function to return an int */
402
403
}

Roger Dingledine's avatar
Roger Dingledine committed
404
static int spawn_dnsworker(void) {
405
406
407
  int fd[2];
  connection_t *conn;

408
  if(tor_socketpair(AF_UNIX, SOCK_STREAM, 0, fd) < 0) {
409
    log(LOG_ERR, "Couldn't construct socketpair: %s", strerror(errno));
410
411
412
    exit(1);
  }

413
  spawn_func(dnsworker_main, (void*)fd);
Roger Dingledine's avatar
Roger Dingledine committed
414
  log_fn(LOG_DEBUG,"just spawned a worker.");
415
  close(fd[1]); /* we don't need the worker's side of the pipe */
416
417
418

  conn = connection_new(CONN_TYPE_DNSWORKER);

419
  set_socket_nonblocking(fd[0]);
420
421
422

  /* 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
423
  conn->address = tor_strdup("<unused>");
424
425

  if(connection_add(conn) < 0) { /* no space, forget it */
Roger Dingledine's avatar
Roger Dingledine committed
426
    log_fn(LOG_WARN,"connection_add failed. Giving up.");
427
428
429
430
431
432
433
434
435
436
    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
437
438
static void spawn_enough_dnsworkers(void) {
  int num_dnsworkers_needed; /* aim to have 1 more than needed,
439
                           * but no less than min and no more than max */
440
441
  connection_t *dnsconn;

442
  /* XXX This may not be the best strategy. Maybe we should queue pending
443
444
445
446
447
448
   *     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
449
   */
Roger Dingledine's avatar
Roger Dingledine committed
450
  if(num_dnsworkers_busy == MAX_DNSWORKERS) {
451
452
453
    /* We always want at least one worker idle.
     * So find the oldest busy worker and kill it.
     */
454
455
    dnsconn = connection_get_by_type_state_lastwritten(CONN_TYPE_DNSWORKER,
                                                       DNSWORKER_STATE_BUSY);
456
457
    assert(dnsconn);

458
459
    log_fn(LOG_WARN, "%d DNS workers are spawned; all are busy. Killing one.",
           MAX_DNSWORKERS);
460
    /* tell the exit connection that it's failed */
461
    dns_cancel_pending_resolve(dnsconn->address, NULL);
462

463
    dnsconn->marked_for_close = 1;
Roger Dingledine's avatar
Roger Dingledine committed
464
    num_dnsworkers_busy--;
465
    num_dnsworkers--;
466
  }
467

Roger Dingledine's avatar
Roger Dingledine committed
468
469
  if(num_dnsworkers_busy >= MIN_DNSWORKERS)
    num_dnsworkers_needed = num_dnsworkers_busy+1;
470
  else
Roger Dingledine's avatar
Roger Dingledine committed
471
    num_dnsworkers_needed = MIN_DNSWORKERS;
472

Roger Dingledine's avatar
Roger Dingledine committed
473
474
  while(num_dnsworkers < num_dnsworkers_needed) {
    if(spawn_dnsworker() < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
475
      log(LOG_WARN,"spawn_enough_dnsworkers(): spawn failed!");
476
477
      return;
    }
Roger Dingledine's avatar
Roger Dingledine committed
478
    num_dnsworkers++;
479
480
  }

481
  while(num_dnsworkers > num_dnsworkers_busy+MAX_IDLE_DNSWORKERS) { /* too many idle? */
482
    /* cull excess workers */
483
484
    log_fn(LOG_WARN,"%d of %d dnsworkers are idle. Killing one.",
           num_dnsworkers-num_dnsworkers_needed, num_dnsworkers);
485
486
487
    dnsconn = connection_get_by_type_state(CONN_TYPE_DNSWORKER, DNSWORKER_STATE_IDLE);
    assert(dnsconn);
    dnsconn->marked_for_close = 1;
Roger Dingledine's avatar
Roger Dingledine committed
488
    num_dnsworkers--;
489
  }
490
491
}

492
493
494
495
496
497
498
/*
  Local Variables:
  mode:c
  indent-tabs-mode:nil
  c-basic-offset:2
  End:
*/