dns.c 15.1 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
        pending_connection->next = resolve->pending_connections;
        resolve->pending_connections = pending_connection;
117
118
119
        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
120
        return 0;
121
122
      case CACHE_STATE_VALID:
        exitconn->addr = resolve->answer;
123
124
        log_fn(LOG_DEBUG,"Connection (fd %d) found cached answer for '%s'",
               exitconn->s, exitconn->address);
125
        return 1;
126
127
128
      case CACHE_STATE_FAILED:
        return -1;
    }
129
  } else { /* need to add it */
130
    resolve = tor_malloc(sizeof(struct cached_resolve));
Roger Dingledine's avatar
   
Roger Dingledine committed
131
132
    memset(resolve, 0, sizeof(struct cached_resolve));
    resolve->state = CACHE_STATE_PENDING;
133
    resolve->expire = now + 15*60; /* 15 minutes */
Roger Dingledine's avatar
   
Roger Dingledine committed
134
    strncpy(resolve->question, exitconn->address, MAX_ADDRESSLEN);
135
136

    /* add us to the pending list */
137
    pending_connection = tor_malloc(sizeof(struct pending_connection_t));
138
    pending_connection->conn = exitconn;
Roger Dingledine's avatar
   
Roger Dingledine committed
139
140
    pending_connection->next = resolve->pending_connections;
    resolve->pending_connections = pending_connection;
141

142
143
144
145
146
147
148
149
    /* 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
150
    SPLAY_INSERT(cache_tree, &cache_root, resolve);
Roger Dingledine's avatar
Roger Dingledine committed
151
    return assign_to_dnsworker(exitconn);
152
153
154
155
156
157
  }

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

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
192
193
/* 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;
194
195
196
197
198
199
200
  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) {
Roger Dingledine's avatar
Roger Dingledine committed
201
    log_fn(LOG_WARN,"Question '%s' is not pending. Dropping.", question);
202
203
204
205
    return;
  }

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

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

  /* 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) {
265
266
267
268
269
270
271
272
  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) {
Roger Dingledine's avatar
Roger Dingledine committed
273
    log_fn(LOG_WARN,"Answer to unasked question '%s'? Dropping.", question);
274
275
    /* XXX Why drop?  Just because we don't care now doesn't mean we shouldn't
     * XXX cache the result for later. */
276
    return;
277
278
  }

279
280
281
282
283
284
285
286
287
288
  if (resolve->state != CACHE_STATE_PENDING) {
    log_fn(LOG_WARN, "Duplicate answer to question '%s'; ignoring",
           question);
    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); */
289

290
  resolve->answer = ntohl(answer);
291
  if(resolve->answer)
292
293
294
295
296
297
    resolve->state = CACHE_STATE_VALID;
  else
    resolve->state = CACHE_STATE_FAILED;

  while(resolve->pending_connections) {
    pend = resolve->pending_connections;
298
    pend->conn->addr = resolve->answer;
299
300
301
302
    if(resolve->state == CACHE_STATE_FAILED)
      connection_edge_end(pend->conn, END_STREAM_REASON_RESOLVEFAILED, NULL);
    else
      connection_exit_connect(pend->conn);
303
304
305
306
307
    resolve->pending_connections = pend->next;
    free(pend);
  }
}

308
309
310
311
312
313
314
315
316
317
318
319
320
321
/******************************************************************/

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) {
Roger Dingledine's avatar
Roger Dingledine committed
322
    log_fn(LOG_WARN,"Read eof. Worker dying.");
323
    if(conn->state == DNSWORKER_STATE_BUSY) {
324
      dns_cancel_pending_resolve(conn->address, NULL);
Roger Dingledine's avatar
Roger Dingledine committed
325
      num_dnsworkers_busy--;
326
    }
Roger Dingledine's avatar
Roger Dingledine committed
327
    num_dnsworkers--;
328
329
330
331
    return -1;
  }

  assert(conn->state == DNSWORKER_STATE_BUSY);
332
  if(buf_datalen(conn->inbuf) < 4) /* entire answer available? */
333
    return 0; /* not yet */
334
  assert(buf_datalen(conn->inbuf) == 4);
335

336
  connection_fetch_from_buf((char*)&answer,sizeof(answer),conn);
337

338
339
340
  log_fn(LOG_DEBUG, "DNSWorker (fd %d) returned answer for '%s'",
         conn->s, conn->address);

341
342
343
  dns_found_answer(conn->address, answer);

  free(conn->address);
Roger Dingledine's avatar
Roger Dingledine committed
344
  conn->address = strdup("<idle>");
345
  conn->state = DNSWORKER_STATE_IDLE;
Roger Dingledine's avatar
Roger Dingledine committed
346
  num_dnsworkers_busy--;
347
348
349
350

  return 0;
}

351
int dnsworker_main(void *data) {
352
353
354
  char question[MAX_ADDRESSLEN];
  unsigned char question_len;
  struct hostent *rent;
355
  int *fdarray = data;
Roger Dingledine's avatar
Roger Dingledine committed
356
  int fd;
357
358
359

  close(fdarray[0]); /* this is the side of the socketpair the parent uses */
  fd = fdarray[1]; /* this side is ours */
360
361
362
363

  for(;;) {

    if(read(fd, &question_len, 1) != 1) {
364
      log_fn(LOG_ERR,"read length failed. Child exiting.");
365
      spawn_exit();
366
367
368
    }
    assert(question_len > 0);

369
    if(read_all(fd, question, question_len) != question_len) {
370
      log_fn(LOG_ERR,"read hostname failed. Child exiting.");
371
      spawn_exit();
372
373
374
375
376
    }
    question[question_len] = 0; /* null terminate it */

    rent = gethostbyname(question);
    if (!rent) {
377
      log_fn(LOG_INFO,"Could not resolve dest addr %s. Returning nulls.",question);
Roger Dingledine's avatar
Roger Dingledine committed
378
      if(write_all(fd, "\0\0\0\0", 4) != 4) {
379
        log_fn(LOG_ERR,"writing nulls failed. Child exiting.");
380
        spawn_exit();
381
382
383
      }
    } else {
      assert(rent->h_length == 4); /* break to remind us if we move away from ipv4 */
Roger Dingledine's avatar
Roger Dingledine committed
384
      if(write_all(fd, rent->h_addr, 4) != 4) {
385
        log_fn(LOG_INFO,"writing answer failed. Child exiting.");
386
        spawn_exit();
387
      }
388
      log_fn(LOG_INFO,"Answered question '%s'.",question);
389
390
    }
  }
391
  return 0; /* windows wants this function to return an int */
392
393
}

Roger Dingledine's avatar
Roger Dingledine committed
394
static int spawn_dnsworker(void) {
395
396
397
  int fd[2];
  connection_t *conn;

398
  if(tor_socketpair(AF_UNIX, SOCK_STREAM, 0, fd) < 0) {
399
    log(LOG_ERR, "Couldn't construct socketpair: %s", strerror(errno));
400
401
402
    exit(1);
  }

403
  spawn_func(dnsworker_main, (void*)fd);
Roger Dingledine's avatar
Roger Dingledine committed
404
  log_fn(LOG_DEBUG,"just spawned a worker.");
405
  close(fd[1]); /* we don't need the worker's side of the pipe */
406
407
408

  conn = connection_new(CONN_TYPE_DNSWORKER);

409
  set_socket_nonblocking(fd[0]);
410
411
412

  /* 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
413
  conn->address = tor_strdup("<unused>");
414
415

  if(connection_add(conn) < 0) { /* no space, forget it */
Roger Dingledine's avatar
Roger Dingledine committed
416
    log_fn(LOG_WARN,"connection_add failed. Giving up.");
417
418
419
420
421
422
423
424
425
426
    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
427
428
static void spawn_enough_dnsworkers(void) {
  int num_dnsworkers_needed; /* aim to have 1 more than needed,
429
                           * but no less than min and no more than max */
430
431
  connection_t *dnsconn;

432
433
434
435
  /* XXX This may not be the best strategy. Maybe we should queue pending
   * XXX requests until the old ones finish or time out: otherwise, if
   * XXX the connection requests come fast enough, we never get any DNS done.
   */
Roger Dingledine's avatar
Roger Dingledine committed
436
  if(num_dnsworkers_busy == MAX_DNSWORKERS) {
437
438
439
    /* We always want at least one worker idle.
     * So find the oldest busy worker and kill it.
     */
440
441
442
    dnsconn = connection_get_by_type_state_lastwritten(CONN_TYPE_DNSWORKER, DNSWORKER_STATE_BUSY);
    assert(dnsconn);

443
    log_fn(LOG_DEBUG, "Max DNS workers spawned; all are busy. Killing one.");
444
    /* tell the exit connection that it's failed */
445
    dns_cancel_pending_resolve(dnsconn->address, NULL);
446

447
    dnsconn->marked_for_close = 1;
Roger Dingledine's avatar
Roger Dingledine committed
448
    num_dnsworkers_busy--;
449
    num_dnsworkers--;
450
  }
451

Roger Dingledine's avatar
Roger Dingledine committed
452
453
  if(num_dnsworkers_busy >= MIN_DNSWORKERS)
    num_dnsworkers_needed = num_dnsworkers_busy+1;
454
  else
Roger Dingledine's avatar
Roger Dingledine committed
455
    num_dnsworkers_needed = MIN_DNSWORKERS;
456

Roger Dingledine's avatar
Roger Dingledine committed
457
458
  while(num_dnsworkers < num_dnsworkers_needed) {
    if(spawn_dnsworker() < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
459
      log(LOG_WARN,"spawn_enough_dnsworkers(): spawn failed!");
460
461
      return;
    }
Roger Dingledine's avatar
Roger Dingledine committed
462
    num_dnsworkers++;
463
464
  }

Roger Dingledine's avatar
Roger Dingledine committed
465
  while(num_dnsworkers > num_dnsworkers_needed+MAX_IDLE_DNSWORKERS) { /* too many idle? */
466
467
468
469
    /* 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
470
    num_dnsworkers--;
471
  }
472
473
}

474
475
476
477
478
479
480
/*
  Local Variables:
  mode:c
  indent-tabs-mode:nil
  c-basic-offset:2
  End:
*/