dns.c 13.9 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 *question, uint32_t answer);
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

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

struct cached_resolve {
  SPLAY_ENTRY(cached_resolve) node;
  char question[MAX_ADDRESSLEN]; /* the hostname to be resolved */
  uint32_t answer; /* in host order. I know I'm horrible for assuming ipv4 */
  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;
};

SPLAY_HEAD(cache_tree, cached_resolve) cache_root;

static int compare_cached_resolves(struct cached_resolve *a, struct cached_resolve *b) {
  /* make this smarter one day? */
  return strncasecmp(a->question, b->question, MAX_ADDRESSLEN);
}

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

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

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

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

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

86
/* See if the question 'exitconn->address' has been answered. if so,
87
88
 * if resolve valid, put it into exitconn->addr and return 1.
 * If resolve failed, return -1.
89
90
91
92
93
94
95
96
97
 *
 * 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
98
  struct cached_resolve search;
99
  struct pending_connection_t *pending_connection;
100
  uint32_t now = time(NULL);
101

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

106
107
  /* now check the tree to see if 'question' is already there. */
  strncpy(search.question, exitconn->address, MAX_ADDRESSLEN);
Roger Dingledine's avatar
   
Roger Dingledine committed
108
  resolve = SPLAY_FIND(cache_tree, &cache_root, &search);
109
  if(resolve) { /* already there */
110
111
112
    switch(resolve->state) {
      case CACHE_STATE_PENDING:
        /* add us to the pending list */
113
        pending_connection = tor_malloc(sizeof(struct pending_connection_t));
114
        pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
115
116
117
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
        return 0;
118
119
      case CACHE_STATE_VALID:
        exitconn->addr = resolve->answer;
120
        return 1;
121
122
123
      case CACHE_STATE_FAILED:
        return -1;
    }
124
  } else { /* need to add it */
125
    resolve = tor_malloc(sizeof(struct cached_resolve));
Roger Dingledine's avatar
   
Roger Dingledine committed
126
127
    memset(resolve, 0, sizeof(struct cached_resolve));
    resolve->state = CACHE_STATE_PENDING;
128
129
    resolve->expire = now + 100; /* XXX for testing. when we're confident, switch it back */
//    resolve->expire = now + 86400; /* now + 1 day */
Roger Dingledine's avatar
   
Roger Dingledine committed
130
    strncpy(resolve->question, exitconn->address, MAX_ADDRESSLEN);
131
132

    /* add us to the pending list */
133
    pending_connection = tor_malloc(sizeof(struct pending_connection_t));
134
    pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
135
136
    pending_connection->next = resolve->pending_connections;
    resolve->pending_connections = pending_connection;
137

138
139
140
141
142
143
144
145
    /* add us to the linked list of resolves */
    if (!oldest_cached_resolve) {
      oldest_cached_resolve = resolve;
    } else {
      newest_cached_resolve->next = resolve;
    }
    newest_cached_resolve = resolve;

Roger Dingledine's avatar
   
Roger Dingledine committed
146
    SPLAY_INSERT(cache_tree, &cache_root, resolve);
Roger Dingledine's avatar
Roger Dingledine committed
147
    return assign_to_dnsworker(exitconn);
148
149
150
151
152
153
  }

  assert(0);
  return 0; /* not reached; keep gcc happy */
}

Roger Dingledine's avatar
Roger Dingledine committed
154
static int assign_to_dnsworker(connection_t *exitconn) {
155
156
  connection_t *dnsconn;
  unsigned char len;
157

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

160
  dnsconn = connection_get_by_type_state(CONN_TYPE_DNSWORKER, DNSWORKER_STATE_IDLE);
161
162

  if(!dnsconn) {
Roger Dingledine's avatar
Roger Dingledine committed
163
    log_fn(LOG_INFO,"no idle dns workers. Failing.");
164
    dns_cancel_pending_resolve(exitconn->address, NULL);
165
    return -1;
166
167
  }

168
169
  dnsconn->address = strdup(exitconn->address);
  dnsconn->state = DNSWORKER_STATE_BUSY;
Roger Dingledine's avatar
Roger Dingledine committed
170
  num_dnsworkers_busy++;
171

172
173
174
175
  len = strlen(dnsconn->address);
  /* FFFF we should have it retry if the first worker bombs out */
  if(connection_write_to_buf(&len, 1, dnsconn) < 0 ||
     connection_write_to_buf(dnsconn->address, len, dnsconn) < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
176
    log_fn(LOG_NOTICE,"Write failed. Closing worker and failing resolve.");
177
    dnsconn->marked_for_close = 1;
178
    dns_cancel_pending_resolve(exitconn->address, NULL);
179
180
181
    return -1;
  }

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

186
187
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.
 */
void dns_cancel_pending_resolve(char *question, connection_t *onlyconn) {
  struct pending_connection_t *pend, *victim;
192
193
194
195
196
197
198
  struct cached_resolve search;
  struct cached_resolve *resolve, *tmp;

  strncpy(search.question, question, MAX_ADDRESSLEN);

  resolve = SPLAY_FIND(cache_tree, &cache_root, &search);
  if(!resolve) {
199
    log_fn(LOG_INFO,"Answer to unasked question '%s'? Dropping.", question);
200
201
202
203
    return;
  }

  assert(resolve->state == CACHE_STATE_PENDING);
204
  assert(resolve->pending_connections);
205

206
  if(onlyconn) {
207
    pend = resolve->pending_connections;
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
    if(pend->conn == onlyconn) {
      resolve->pending_connections = pend->next;
      free(pend);
      if(resolve->pending_connections) /* more pending, don't cancel it */
        return;
    } else {
      for( ; pend->next; pend = pend->next) {
        if(pend->next->conn == onlyconn) {
          victim = pend->next;
          pend->next = victim->next;
          free(victim);
          return; /* more are pending */
        }
      }
      assert(0); /* not reachable unless onlyconn not in pending list */
    }
  } else {
    /* mark all pending connections to fail */
    while(resolve->pending_connections) {
      pend = resolve->pending_connections;
      pend->conn->marked_for_close = 1;
      resolve->pending_connections = pend->next;
      free(pend);
    }
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
  }

  /* 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);
}

static void dns_found_answer(char *question, uint32_t answer) {
256
257
258
259
260
261
262
263
  struct pending_connection_t *pend;
  struct cached_resolve search;
  struct cached_resolve *resolve;

  strncpy(search.question, question, MAX_ADDRESSLEN);

  resolve = SPLAY_FIND(cache_tree, &cache_root, &search);
  if(!resolve) {
264
    log_fn(LOG_INFO,"Answer to unasked question '%s'? Dropping.", question);
265
    return;
266
267
  }

268
  assert(resolve->state == CACHE_STATE_PENDING);
269
  /* XXX sometimes this still gets triggered. :( */
270

271
  resolve->answer = ntohl(answer);
272
  if(resolve->answer)
273
274
275
276
277
278
    resolve->state = CACHE_STATE_VALID;
  else
    resolve->state = CACHE_STATE_FAILED;

  while(resolve->pending_connections) {
    pend = resolve->pending_connections;
279
    pend->conn->addr = resolve->answer;
280
281
282
283
284
285
286
287
    if(resolve->state == CACHE_STATE_FAILED || connection_exit_connect(pend->conn) < 0) {
      pend->conn->marked_for_close = 1;
    }
    resolve->pending_connections = pend->next;
    free(pend);
  }
}

288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
/******************************************************************/

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) {
  uint32_t answer;

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

  if(conn->inbuf_reached_eof) {
    log(LOG_ERR,"connection_dnsworker_process_inbuf(): Read eof. Worker dying.");
303
    if(conn->state == DNSWORKER_STATE_BUSY) {
304
      dns_cancel_pending_resolve(conn->address, NULL);
Roger Dingledine's avatar
Roger Dingledine committed
305
      num_dnsworkers_busy--;
306
    }
Roger Dingledine's avatar
Roger Dingledine committed
307
    num_dnsworkers--;
308
309
310
311
312
313
314
315
    return -1;
  }

  assert(conn->state == DNSWORKER_STATE_BUSY);
  if(conn->inbuf_datalen < 4) /* entire answer available? */
    return 0; /* not yet */
  assert(conn->inbuf_datalen == 4);

316
  connection_fetch_from_buf((char*)&answer,sizeof(answer),conn);
317
318
319
320
321
322

  dns_found_answer(conn->address, answer);

  free(conn->address);
  conn->address = NULL;
  conn->state = DNSWORKER_STATE_IDLE;
Roger Dingledine's avatar
Roger Dingledine committed
323
  num_dnsworkers_busy--;
324
325
326
327

  return 0;
}

328
int dnsworker_main(void *data) {
329
330
331
  char question[MAX_ADDRESSLEN];
  unsigned char question_len;
  struct hostent *rent;
332
  int *fdarray = data;
Roger Dingledine's avatar
Roger Dingledine committed
333
  int fd;
334
335
336

  close(fdarray[0]); /* this is the side of the socketpair the parent uses */
  fd = fdarray[1]; /* this side is ours */
337
338
339
340
341

  for(;;) {

    if(read(fd, &question_len, 1) != 1) {
      log(LOG_INFO,"dnsworker_main(): read length failed. Exiting.");
342
      spawn_exit();
343
344
345
    }
    assert(question_len > 0);

346
    if(read_all(fd, question, question_len) != question_len) {
347
      log(LOG_INFO,"dnsworker_main(): read hostname failed. Exiting.");
348
      spawn_exit();
349
350
351
352
353
354
    }
    question[question_len] = 0; /* null terminate it */

    rent = gethostbyname(question);
    if (!rent) {
      log(LOG_INFO,"dnsworker_main(): Could not resolve dest addr %s. Returning nulls.",question);
Roger Dingledine's avatar
Roger Dingledine committed
355
      if(write_all(fd, "\0\0\0\0", 4) != 4) {
356
        log(LOG_INFO,"dnsworker_main(): writing nulls failed. Exiting.");
357
        spawn_exit();
358
359
360
      }
    } else {
      assert(rent->h_length == 4); /* break to remind us if we move away from ipv4 */
Roger Dingledine's avatar
Roger Dingledine committed
361
      if(write_all(fd, rent->h_addr, 4) != 4) {
362
        log(LOG_INFO,"dnsworker_main(): writing answer failed. Exiting.");
363
        spawn_exit();
364
365
366
367
      }
      log(LOG_INFO,"dnsworker_main(): Answered question '%s'.",question);
    }
  }
368
  return 0; /* windows wants this function to return an int */
369
370
}

Roger Dingledine's avatar
Roger Dingledine committed
371
static int spawn_dnsworker(void) {
372
373
374
  int fd[2];
  connection_t *conn;

375
  if(tor_socketpair(AF_UNIX, SOCK_STREAM, 0, fd) < 0) {
376
377
378
379
    perror("socketpair");
    exit(1);
  }

380
  spawn_func(dnsworker_main, (void*)fd);
Roger Dingledine's avatar
Roger Dingledine committed
381
  log_fn(LOG_DEBUG,"just spawned a worker.");
382
  close(fd[1]); /* we don't need the worker's side of the pipe */
383
384
385
386
387
388
389

  conn = connection_new(CONN_TYPE_DNSWORKER);
  if(!conn) {
    close(fd[0]);
    return -1;
  }

390
  set_socket_nonblocking(fd[0]);
391
392
393
394
395

  /* set up conn so it's got all the data we need to remember */
  conn->receiver_bucket = -1; /* non-cell connections don't do receiver buckets */
  conn->bandwidth = -1;
  conn->s = fd[0];
396
  conn->address = strdup("localhost");
397
398

  if(connection_add(conn) < 0) { /* no space, forget it */
Roger Dingledine's avatar
Roger Dingledine committed
399
    log_fn(LOG_INFO,"connection_add failed. Giving up.");
400
401
402
403
404
405
406
407
408
409
    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
410
411
static void spawn_enough_dnsworkers(void) {
  int num_dnsworkers_needed; /* aim to have 1 more than needed,
412
                           * but no less than min and no more than max */
413
414
  connection_t *dnsconn;

Roger Dingledine's avatar
Roger Dingledine committed
415
  if(num_dnsworkers_busy == MAX_DNSWORKERS) {
416
417
418
    /* We always want at least one worker idle.
     * So find the oldest busy worker and kill it.
     */
419
420
421
422
    dnsconn = connection_get_by_type_state_lastwritten(CONN_TYPE_DNSWORKER, DNSWORKER_STATE_BUSY);
    assert(dnsconn);

    /* tell the exit connection that it's failed */
423
    dns_cancel_pending_resolve(dnsconn->address, NULL);
424

425
    dnsconn->marked_for_close = 1;
Roger Dingledine's avatar
Roger Dingledine committed
426
    num_dnsworkers_busy--;
427
  }
428

Roger Dingledine's avatar
Roger Dingledine committed
429
430
  if(num_dnsworkers_busy >= MIN_DNSWORKERS)
    num_dnsworkers_needed = num_dnsworkers_busy+1;
431
  else
Roger Dingledine's avatar
Roger Dingledine committed
432
    num_dnsworkers_needed = MIN_DNSWORKERS;
433

Roger Dingledine's avatar
Roger Dingledine committed
434
435
436
  while(num_dnsworkers < num_dnsworkers_needed) {
    if(spawn_dnsworker() < 0) {
      log(LOG_ERR,"spawn_enough_dnsworkers(): spawn failed!");
437
438
      return;
    }
Roger Dingledine's avatar
Roger Dingledine committed
439
    num_dnsworkers++;
440
441
  }

Roger Dingledine's avatar
Roger Dingledine committed
442
  while(num_dnsworkers > num_dnsworkers_needed+MAX_IDLE_DNSWORKERS) { /* too many idle? */
443
444
445
446
    /* cull excess workers */
    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
447
    num_dnsworkers--;
448
  }
449
450
}

451
452
453
454
455
456
457
/*
  Local Variables:
  mode:c
  indent-tabs-mode:nil
  c-basic-offset:2
  End:
*/