main.c 30.7 KB
Newer Older
1
/* Copyright 2001,2002,2003 Roger Dingledine, Matej Pfajfar. */
2
3
/* See LICENSE for licensing information */
/* $Id$ */
Roger Dingledine's avatar
Roger Dingledine committed
4

Roger Dingledine's avatar
Roger Dingledine committed
5
6
7
8
/**
 * \file main.c
 * \brief Tor main loop and startup functions.
 **/
9

Roger Dingledine's avatar
Roger Dingledine committed
10
11
#include "or.h"

12
/********* PROTOTYPES **********/
Roger Dingledine's avatar
Roger Dingledine committed
13

14
static void dumpstats(int severity); /* log stats */
15
static int init_from_config(int argc, char **argv);
Roger Dingledine's avatar
Roger Dingledine committed
16

Roger Dingledine's avatar
Roger Dingledine committed
17
18
/********* START VARIABLES **********/

Nick Mathewson's avatar
Nick Mathewson committed
19
/* declared in connection.c */
20
extern char *conn_state_to_string[][_CONN_TYPE_MAX+1];
21

22
23
or_options_t options; /**< Command-line and config-file options. */
int global_read_bucket; /**< Max number of bytes I can read this second. */
Roger Dingledine's avatar
Roger Dingledine committed
24

Roger Dingledine's avatar
Roger Dingledine committed
25
/** What was the read bucket before the last call to prepare_for_pool?
26
 * (used to determine how many bytes we've read). */
27
static int stats_prev_global_read_bucket;
Roger Dingledine's avatar
Roger Dingledine committed
28
/** How many bytes have we read since we started the process? */
29
static uint64_t stats_n_bytes_read = 0;
Roger Dingledine's avatar
Roger Dingledine committed
30
/** How many seconds have we been running? */
31
32
static long stats_n_seconds_reading = 0;

Roger Dingledine's avatar
Roger Dingledine committed
33
/** Array of all open connections; each element corresponds to the element of
34
 * poll_array in the same position.  The first nfds elements are valid. */
Roger Dingledine's avatar
Roger Dingledine committed
35
static connection_t *connection_array[MAXCONNECTIONS] =
Roger Dingledine's avatar
Roger Dingledine committed
36
37
        { NULL };

Roger Dingledine's avatar
Roger Dingledine committed
38
/** Array of pollfd objects for calls to poll(). */
Nick Mathewson's avatar
Nick Mathewson committed
39
static struct pollfd poll_array[MAXCONNECTIONS];
Roger Dingledine's avatar
Roger Dingledine committed
40

41
static int nfds=0; /**< Number of connections currently active. */
Roger Dingledine's avatar
Roger Dingledine committed
42

43
#ifndef MS_WINDOWS /* do signal stuff only on unix */
44
45
46
static int please_dumpstats=0; /**< Whether we should dump stats during the loop. */
static int please_reset=0; /**< Whether we just got a sighup. */
static int please_reap_children=0; /**< Whether we should waitpid for exited children. */
47
#endif /* signal stuff */
48

Roger Dingledine's avatar
Roger Dingledine committed
49
/** We set this to 1 when we've fetched a dir, to know whether to complain
50
51
 * yet about unrecognized nicknames in entrynodes, exitnodes, etc.
 * Also, we don't try building circuits unless this is 1. */
52
int has_fetched_directory=0;
53

Roger Dingledine's avatar
Roger Dingledine committed
54
/** We set this to 1 when we've opened a circuit, so we can print a log
55
 * entry to inform the user that Tor is working. */
56
int has_completed_circuit=0;
57

Roger Dingledine's avatar
Roger Dingledine committed
58
59
/********* END VARIABLES ************/

Roger Dingledine's avatar
Roger Dingledine committed
60
61
62
63
64
65
66
67
/****************************************************************************
*
* This section contains accessors and other methods on the connection_array
* and poll_array variables (which are global within this file and unavailable
* outside it).
*
****************************************************************************/

Roger Dingledine's avatar
Roger Dingledine committed
68
/** Add <b>conn</b> to the array of connections that we can poll on.  The
69
70
71
 * connection's socket must be set; the connection starts out
 * non-reading and non-writing.
 */
Roger Dingledine's avatar
Roger Dingledine committed
72
int connection_add(connection_t *conn) {
Roger Dingledine's avatar
Roger Dingledine committed
73
  tor_assert(conn);
74
  tor_assert(conn->s >= 0);
Roger Dingledine's avatar
Roger Dingledine committed
75

76
  if(nfds >= options.MaxConn-1) {
77
    log_fn(LOG_WARN,"failing because nfds is too high.");
Roger Dingledine's avatar
Roger Dingledine committed
78
79
    return -1;
  }
Roger Dingledine's avatar
Roger Dingledine committed
80

81
  tor_assert(conn->poll_index == -1); /* can only connection_add once */
Roger Dingledine's avatar
Roger Dingledine committed
82
83
84
  conn->poll_index = nfds;
  connection_array[nfds] = conn;

85
  poll_array[nfds].fd = conn->s;
86
87

  /* zero these out here, because otherwise we'll inherit values from the previously freed one */
Roger Dingledine's avatar
Roger Dingledine committed
88
89
90
91
92
  poll_array[nfds].events = 0;
  poll_array[nfds].revents = 0;

  nfds++;

93
  log_fn(LOG_INFO,"new conn type %s, socket %d, nfds %d.",
Roger Dingledine's avatar
Roger Dingledine committed
94
      CONN_TYPE_TO_STRING(conn->type), conn->s, nfds);
Roger Dingledine's avatar
Roger Dingledine committed
95
96
97
98

  return 0;
}

Roger Dingledine's avatar
Roger Dingledine committed
99
/** Remove the connection from the global list, and remove the
Nick Mathewson's avatar
Nick Mathewson committed
100
101
102
 * corresponding poll entry.  Calling this function will shift the last
 * connection (if any) into the position occupied by conn.
 */
Roger Dingledine's avatar
Roger Dingledine committed
103
104
105
int connection_remove(connection_t *conn) {
  int current_index;

Roger Dingledine's avatar
Roger Dingledine committed
106
107
  tor_assert(conn);
  tor_assert(nfds>0);
Roger Dingledine's avatar
Roger Dingledine committed
108

109
  log_fn(LOG_INFO,"removing socket %d (type %s), nfds now %d",
Roger Dingledine's avatar
Roger Dingledine committed
110
         conn->s, CONN_TYPE_TO_STRING(conn->type), nfds-1);
Roger Dingledine's avatar
Roger Dingledine committed
111

112
  tor_assert(conn->poll_index >= 0);
Roger Dingledine's avatar
Roger Dingledine committed
113
114
115
116
  current_index = conn->poll_index;
  if(current_index == nfds-1) { /* this is the end */
    nfds--;
    return 0;
Roger Dingledine's avatar
Roger Dingledine committed
117
  }
Roger Dingledine's avatar
Roger Dingledine committed
118

119
  /* replace this one with the one at the end */
Roger Dingledine's avatar
Roger Dingledine committed
120
  nfds--;
Roger Dingledine's avatar
Roger Dingledine committed
121
  poll_array[current_index].fd = poll_array[nfds].fd;
Roger Dingledine's avatar
Roger Dingledine committed
122
123
124
125
126
  poll_array[current_index].events = poll_array[nfds].events;
  poll_array[current_index].revents = poll_array[nfds].revents;
  connection_array[current_index] = connection_array[nfds];
  connection_array[current_index]->poll_index = current_index;

Roger Dingledine's avatar
Roger Dingledine committed
127
  return 0;
Roger Dingledine's avatar
Roger Dingledine committed
128
129
}

Roger Dingledine's avatar
Roger Dingledine committed
130
131
132
/** Set <b>*array</b> to an array of all connections, and <b>*n</b>
 * to the length of the array. <b>*array</b> and <b>*n</b> must not
 * be modified.
133
 */
134
135
136
void get_connection_array(connection_t ***array, int *n) {
  *array = connection_array;
  *n = nfds;
137
138
}

Roger Dingledine's avatar
Roger Dingledine committed
139
140
/** Set the event mask on <b>conn</b> to <b>events</b>.  (The form of
* the event mask is as for poll().)
141
 */
Roger Dingledine's avatar
Roger Dingledine committed
142
143
void connection_watch_events(connection_t *conn, short events) {

144
  tor_assert(conn && conn->poll_index >= 0 && conn->poll_index < nfds);
Roger Dingledine's avatar
Roger Dingledine committed
145
146
147
148

  poll_array[conn->poll_index].events = events;
}

Roger Dingledine's avatar
Roger Dingledine committed
149
/** Return true iff <b>conn</b> is listening for read events. */
Roger Dingledine's avatar
Roger Dingledine committed
150
int connection_is_reading(connection_t *conn) {
151
  tor_assert(conn && conn->poll_index >= 0);
Roger Dingledine's avatar
Roger Dingledine committed
152
153
154
  return poll_array[conn->poll_index].events & POLLIN;
}

Roger Dingledine's avatar
Roger Dingledine committed
155
/** Tell the main loop to stop notifying <b>conn</b> of any read events. */
156
void connection_stop_reading(connection_t *conn) {
157
  tor_assert(conn && conn->poll_index >= 0 && conn->poll_index < nfds);
158

159
  log(LOG_DEBUG,"connection_stop_reading() called.");
160
161
162
163
  if(poll_array[conn->poll_index].events & POLLIN)
    poll_array[conn->poll_index].events -= POLLIN;
}

Roger Dingledine's avatar
Roger Dingledine committed
164
/** Tell the main loop to start notifying <b>conn</b> of any read events. */
165
void connection_start_reading(connection_t *conn) {
166
  tor_assert(conn && conn->poll_index >= 0 && conn->poll_index < nfds);
167
168
169
  poll_array[conn->poll_index].events |= POLLIN;
}

Roger Dingledine's avatar
Roger Dingledine committed
170
/** Return true iff <b>conn</b> is listening for write events. */
171
172
173
174
int connection_is_writing(connection_t *conn) {
  return poll_array[conn->poll_index].events & POLLOUT;
}

Roger Dingledine's avatar
Roger Dingledine committed
175
/** Tell the main loop to stop notifying <b>conn</b> of any write events. */
176
void connection_stop_writing(connection_t *conn) {
177
  tor_assert(conn && conn->poll_index >= 0 && conn->poll_index < nfds);
178
179
180
181
  if(poll_array[conn->poll_index].events & POLLOUT)
    poll_array[conn->poll_index].events -= POLLOUT;
}

Roger Dingledine's avatar
Roger Dingledine committed
182
/** Tell the main loop to start notifying <b>conn</b> of any write events. */
183
void connection_start_writing(connection_t *conn) {
184
  tor_assert(conn && conn->poll_index >= 0 && conn->poll_index < nfds);
185
186
187
  poll_array[conn->poll_index].events |= POLLOUT;
}

Roger Dingledine's avatar
Roger Dingledine committed
188
/** Called when the connection at connection_array[i] has a read event,
189
190
 * or it has pending tls data waiting to be read: checks for validity,
 * catches numerous errors, and dispatches to connection_handle_read.
191
 */
Roger Dingledine's avatar
Roger Dingledine committed
192
static void conn_read(int i) {
193
  connection_t *conn = connection_array[i];
Roger Dingledine's avatar
Roger Dingledine committed
194

Roger Dingledine's avatar
Roger Dingledine committed
195
196
197
  if (conn->marked_for_close)
    return;

198
199
  /* see http://www.greenend.org.uk/rjk/2001/06/poll.html for
   * discussion of POLLIN vs POLLHUP */
200
  if(!(poll_array[i].revents & (POLLIN|POLLHUP|POLLERR)))
Nick Mathewson's avatar
Nick Mathewson committed
201
202
    if(!connection_is_reading(conn) ||
       !connection_has_pending_tls_data(conn))
203
      return; /* this conn should not read */
204

205
  log_fn(LOG_DEBUG,"socket %d wants to read.",conn->s);
Roger Dingledine's avatar
Roger Dingledine committed
206

207
  assert_connection_ok(conn, time(NULL));
208
  assert_all_pending_dns_resolves_ok();
209

210
  if(
211
    /* XXX does POLLHUP also mean it's definitely broken? */
212
#ifdef MS_WINDOWS
213
    (poll_array[i].revents & POLLERR) ||
214
#endif
215
    connection_handle_read(conn) < 0) {
216
217
218
      if (!conn->marked_for_close) {
        /* this connection is broken. remove it */
        /* XXX This shouldn't ever happen anymore. */
219
        /* XXX but it'll clearly happen on MS_WINDOWS from POLLERR, right? */
220
        log_fn(LOG_ERR,"Unhandled error on read for %s connection (fd %d); removing",
221
               CONN_TYPE_TO_STRING(conn->type), conn->s);
222
223
        connection_mark_for_close(conn,0);
      }
224
225
226
  }
  assert_connection_ok(conn, time(NULL));
  assert_all_pending_dns_resolves_ok();
Roger Dingledine's avatar
Roger Dingledine committed
227
228
}

Roger Dingledine's avatar
Roger Dingledine committed
229
/** Called when the connection at connection_array[i] has a write event:
230
231
232
 * checks for validity, catches numerous errors, and dispatches to
 * connection_handle_write.
 */
Roger Dingledine's avatar
Roger Dingledine committed
233
static void conn_write(int i) {
Roger Dingledine's avatar
Roger Dingledine committed
234
235
  connection_t *conn;

236
237
238
  if(!(poll_array[i].revents & POLLOUT))
    return; /* this conn doesn't want to write */

Roger Dingledine's avatar
Roger Dingledine committed
239
  conn = connection_array[i];
240
  log_fn(LOG_DEBUG,"socket %d wants to write.",conn->s);
241
242
  if (conn->marked_for_close)
    return;
Roger Dingledine's avatar
Roger Dingledine committed
243

244
  assert_connection_ok(conn, time(NULL));
245
  assert_all_pending_dns_resolves_ok();
246

247
248
249
  if (connection_handle_write(conn) < 0) {
    if (!conn->marked_for_close) {
      /* this connection is broken. remove it. */
Roger Dingledine's avatar
Roger Dingledine committed
250
      log_fn(LOG_WARN,"Unhandled error on read for %s connection (fd %d); removing",
251
             CONN_TYPE_TO_STRING(conn->type), conn->s);
252
      conn->has_sent_end = 1; /* otherwise we cry wolf about duplicate close */
253
254
      connection_mark_for_close(conn,0);
    }
255
256
  }
  assert_connection_ok(conn, time(NULL));
257
  assert_all_pending_dns_resolves_ok();
Roger Dingledine's avatar
Roger Dingledine committed
258
259
}

Roger Dingledine's avatar
Roger Dingledine committed
260
/** If the connection at connection_array[i] is marked for close, then:
261
262
263
264
265
266
267
268
 *    - If it has data that it wants to flush, try to flush it.
 *    - If it _still_ has data to flush, and conn->hold_open_until_flushed is
 *      true, then leave the connection open and return.
 *    - Otherwise, remove the connection from connection_array and from
 *      all other lists, close it, and free it.
 * If we remove the connection, then call conn_closed_if_marked at the new
 * connection at position i.
 */
Nick Mathewson's avatar
Nick Mathewson committed
269
static void conn_close_if_marked(int i) {
Roger Dingledine's avatar
Roger Dingledine committed
270
  connection_t *conn;
271
  int retval;
Roger Dingledine's avatar
Roger Dingledine committed
272
273

  conn = connection_array[i];
274
  assert_connection_ok(conn, time(NULL));
275
  assert_all_pending_dns_resolves_ok();
276
277
278
279
280
281
282
283
  if(!conn->marked_for_close)
    return; /* nothing to see here, move along */

  log_fn(LOG_INFO,"Cleaning up connection (fd %d).",conn->s);
  if(conn->s >= 0 && connection_wants_to_flush(conn)) {
    /* -1 means it's an incomplete edge connection, or that the socket
     * has already been closed as unflushable. */
    if(!conn->hold_open_until_flushed)
284
      log_fn(LOG_WARN,
285
        "Conn (fd %d, type %s, state %d) marked, but wants to flush %d bytes. "
286
        "(Marked at %s:%d)",
287
        conn->s, CONN_TYPE_TO_STRING(conn->type), conn->state,
288
289
290
291
292
293
        conn->outbuf_flushlen, conn->marked_for_close_file, conn->marked_for_close);
    if(connection_speaks_cells(conn)) {
      if(conn->state == OR_CONN_STATE_OPEN) {
        retval = flush_buf_tls(conn->tls, conn->outbuf, &conn->outbuf_flushlen);
        /* XXX actually, some non-zero results are maybe ok. which ones? */
      } else
294
        retval = -1; /* never flush non-open broken tls connections */
295
296
297
    } else {
      retval = flush_buf(conn->s, conn->outbuf, &conn->outbuf_flushlen);
    }
Roger Dingledine's avatar
Roger Dingledine committed
298
    if(retval >= 0 &&
299
300
301
302
       conn->hold_open_until_flushed && connection_wants_to_flush(conn)) {
      log_fn(LOG_INFO,"Holding conn (fd %d) open for more flushing.",conn->s);
      /* XXX should we reset timestamp_lastwritten here? */
      return;
303
    }
304
    if(connection_wants_to_flush(conn)) {
305
306
307
308
      log_fn(LOG_WARN,"Conn (fd %d, type %s, state %d) still wants to flush. Losing %d bytes! (Marked at %s:%d)",
             conn->s, CONN_TYPE_TO_STRING(conn->type), conn->state,
             (int)buf_datalen(conn->outbuf), conn->marked_for_close_file,
             conn->marked_for_close);
Roger Dingledine's avatar
Roger Dingledine committed
309
310
    }
  }
311
312
313
314
315
  /* if it's an edge conn, remove it from the list
   * of conn's on this circuit. If it's not on an edge,
   * flush and send destroys for all circuits on this conn
   */
  circuit_about_to_close_connection(conn);
316
  connection_remove(conn);
317
318
319
  if(conn->type == CONN_TYPE_EXIT) {
    assert_connection_edge_not_dns_pending(conn);
  }
320
321
322
323
324
  connection_free(conn);
  if(i<nfds) { /* we just replaced the one at i with a new one.
                  process it too. */
    conn_close_if_marked(i);
  }
Roger Dingledine's avatar
Roger Dingledine committed
325
326
}

Roger Dingledine's avatar
Roger Dingledine committed
327
/** This function is called whenever we successfully pull down a directory */
328
329
void directory_has_arrived(void) {

330
  log_fn(LOG_INFO, "A directory has arrived.");
331

332
  /* just for testing */
Roger Dingledine's avatar
tabs    
Roger Dingledine committed
333
334
//  directory_initiate_command(router_pick_directory_server(),
//                             DIR_PURPOSE_FETCH_RENDDESC, "foo", 3);
335

336
337
338
339
340
  has_fetched_directory=1;

  if(options.ORPort) { /* connect to them all */
    router_retry_connections();
  }
341
342
}

Roger Dingledine's avatar
Roger Dingledine committed
343
/** Perform regular maintenance tasks for a single connection.  This
Nick Mathewson's avatar
Nick Mathewson committed
344
345
346
347
348
 * function gets run once per second per connection by run_housekeeping.
 */
static void run_connection_housekeeping(int i, time_t now) {
  cell_t cell;
  connection_t *conn = connection_array[i];
Roger Dingledine's avatar
Roger Dingledine committed
349

350
  /* Expire any directory connections that haven't sent anything for 5 min */
351
  if(conn->type == CONN_TYPE_DIR &&
352
     !conn->marked_for_close &&
353
354
     conn->timestamp_lastwritten + 5*60 < now) {
    log_fn(LOG_WARN,"Expiring wedged directory conn (purpose %d)", conn->purpose);
355
    connection_mark_for_close(conn,0);
356
    /* XXXX Does this next part make sense, really? */
357
    conn->hold_open_until_flushed = 1; /* give it a last chance */
358
359
360
    return;
  }

Nick Mathewson's avatar
Nick Mathewson committed
361
362
363
364
  /* check connections to see whether we should send a keepalive, expire, or wait */
  if(!connection_speaks_cells(conn))
    return;

365
366
  /* If we haven't written to an OR connection for a while, then either nuke
     the connection or send a keepalive, depending. */
Nick Mathewson's avatar
Nick Mathewson committed
367
  if(now >= conn->timestamp_lastwritten + options.KeepalivePeriod) {
368
    if((!options.ORPort && !circuit_get_by_conn(conn)) ||
Nick Mathewson's avatar
Nick Mathewson committed
369
370
371
372
       (!connection_state_is_open(conn))) {
      /* we're an onion proxy, with no circuits; or our handshake has expired. kill it. */
      log_fn(LOG_INFO,"Expiring connection to %d (%s:%d).",
             i,conn->address, conn->port);
373
      /* flush anything waiting, e.g. a destroy for a just-expired circ */
374
      connection_mark_for_close(conn,CLOSE_REASON_UNUSED_OR_CONN);
375
      conn->hold_open_until_flushed = 1;
Nick Mathewson's avatar
Nick Mathewson committed
376
377
378
379
380
381
382
383
384
385
386
    } else {
      /* either a full router, or we've got a circuit. send a padding cell. */
      log_fn(LOG_DEBUG,"Sending keepalive to (%s:%d)",
             conn->address, conn->port);
      memset(&cell,0,sizeof(cell_t));
      cell.command = CELL_PADDING;
      connection_or_write_cell_to_buf(&cell, conn);
    }
  }
}

Roger Dingledine's avatar
Roger Dingledine committed
387
/** Perform regular maintenance tasks.  This function gets run once per
Nick Mathewson's avatar
Nick Mathewson committed
388
389
390
 * second by prepare_for_poll.
 */
static void run_scheduled_events(time_t now) {
391
  static long time_to_fetch_directory = 0;
392
  static time_t last_uploaded_services = 0;
393
  static time_t last_rotated_certificate = 0;
Nick Mathewson's avatar
Nick Mathewson committed
394
  int i;
395

396

Roger Dingledine's avatar
Roger Dingledine committed
397
  /** 1a. Every MIN_ONION_KEY_LIFETIME seconds, rotate the onion keys,
398
399
400
401
   *  shut down and restart all cpuworkers, and update the directory if
   *  necessary.
   */
  if (options.ORPort && get_onion_key_set_at()+MIN_ONION_KEY_LIFETIME < now) {
402
    log_fn(LOG_INFO,"Rotating onion key.");
403
404
405
406
407
408
409
410
    rotate_onion_key();
    cpuworkers_rotate();
    if (router_rebuild_descriptor()<0) {
      log_fn(LOG_WARN, "Couldn't rebuild router descriptor");
    }
    router_upload_dir_desc_to_dirservers();
  }

Roger Dingledine's avatar
Roger Dingledine committed
411
  /** 1b. Every MAX_SSL_KEY_LIFETIME seconds, we change our TLS context. */
412
413
414
  if (!last_rotated_certificate)
    last_rotated_certificate = now;
  if (options.ORPort && last_rotated_certificate+MAX_SSL_KEY_LIFETIME < now) {
415
    log_fn(LOG_INFO,"Rotating tls context.");
416
417
418
419
420
421
422
423
424
    if (tor_tls_context_new(get_identity_key(), 1, options.Nickname,
                            MAX_SSL_KEY_LIFETIME) < 0) {
      log_fn(LOG_WARN, "Error reinitializing TLS context");
    }
    last_rotated_certificate = now;
    /* XXXX We should rotate TLS connections as well; this code doesn't change
     * XXXX them at all. */
  }

Roger Dingledine's avatar
Roger Dingledine committed
425
  /** 1c. Every DirFetchPostPeriod seconds, we get a new directory and upload
Nick Mathewson's avatar
Nick Mathewson committed
426
427
428
   *    our descriptor (if any). */
  if(time_to_fetch_directory < now) {
    /* it's time to fetch a new directory and/or post our descriptor */
429
    if(options.ORPort) {
Nick Mathewson's avatar
Nick Mathewson committed
430
      router_rebuild_descriptor();
431
      router_upload_dir_desc_to_dirservers();
Nick Mathewson's avatar
Nick Mathewson committed
432
433
434
435
436
    }
    if(!options.DirPort) {
      /* NOTE directory servers do not currently fetch directories.
       * Hope this doesn't bite us later. */
      directory_initiate_command(router_pick_directory_server(),
437
                                 DIR_PURPOSE_FETCH_DIR, NULL, 0);
438
439
440
    } else {
      /* We're a directory; dump any old descriptors. */
      dirserv_remove_old_servers();
Nick Mathewson's avatar
Nick Mathewson committed
441
    }
442
443
    /* Force an upload of our descriptors every DirFetchPostPeriod seconds. */
    rend_services_upload(1);
444
    last_uploaded_services = now;
Nick Mathewson's avatar
Nick Mathewson committed
445
    rend_cache_clean(); /* should this go elsewhere? */
Nick Mathewson's avatar
Nick Mathewson committed
446
447
    time_to_fetch_directory = now + options.DirFetchPostPeriod;
  }
448

449

Roger Dingledine's avatar
Roger Dingledine committed
450
  /** 2. Every second, we examine pending circuits and prune the
451
   *    ones which have been pending for more than a few seconds.
452
453
454
   *    We do this before step 3, so it can try building more if
   *    it's not comfortable with the number of available circuits.
   */
455
  circuit_expire_building(now);
456

Roger Dingledine's avatar
Roger Dingledine committed
457
  /** 2b. Also look at pending streams and prune the ones that 'began'
458
459
460
461
462
463
   *     a long time ago but haven't gotten a 'connected' yet.
   *     Do this before step 3, so we can put them back into pending
   *     state to be picked up by the new circuit.
   */
  connection_ap_expire_beginning();

464

Roger Dingledine's avatar
Roger Dingledine committed
465
  /** 2c. And expire connections that we've held open for too long.
466
467
468
   */
  connection_expire_held_open();

Roger Dingledine's avatar
Roger Dingledine committed
469
  /** 3. Every second, we try a new circuit if there are no valid
470
471
472
   *    circuits. Every NewCircuitPeriod seconds, we expire circuits
   *    that became dirty more than NewCircuitPeriod seconds ago,
   *    and we make a new circ if there are no clean circuits.
Nick Mathewson's avatar
Nick Mathewson committed
473
   */
474
  if(has_fetched_directory)
475
    circuit_build_needed_circs(now);
476

Roger Dingledine's avatar
Roger Dingledine committed
477
  /** 4. We do housekeeping for each connection... */
Nick Mathewson's avatar
Nick Mathewson committed
478
479
480
  for(i=0;i<nfds;i++) {
    run_connection_housekeeping(i, now);
  }
481

Roger Dingledine's avatar
Roger Dingledine committed
482
  /** 5. And remove any marked circuits... */
483
484
  circuit_close_all_marked();

Roger Dingledine's avatar
Roger Dingledine committed
485
  /** 6. And upload service descriptors for any services whose intro points
486
   *    have changed in the last second. */
487
488
489
490
  if (last_uploaded_services < now-5) {
    rend_services_upload(0);
    last_uploaded_services = now;
  }
491

Roger Dingledine's avatar
Roger Dingledine committed
492
  /** 7. and blow away any connections that need to die. have to do this now,
493
494
   * because if we marked a conn for close and left its socket -1, then
   * we'll pass it to poll/select and bad things will happen.
Nick Mathewson's avatar
Nick Mathewson committed
495
496
497
498
   */
  for(i=0;i<nfds;i++)
    conn_close_if_marked(i);
}
499

Roger Dingledine's avatar
Roger Dingledine committed
500
/** Called every time we're about to call tor_poll.  Increments statistics,
501
502
503
 * and adjusts token buckets.  Returns the number of milliseconds to use for
 * the poll() timeout.
 */
Nick Mathewson's avatar
Nick Mathewson committed
504
505
506
507
508
static int prepare_for_poll(void) {
  static long current_second = 0; /* from previous calls to gettimeofday */
  connection_t *conn;
  struct timeval now;
  int i;
509

Nick Mathewson's avatar
Nick Mathewson committed
510
  tor_gettimeofday(&now);
511

512
513
  /* Check how much bandwidth we've consumed, and increment the token
   * buckets. */
514
515
516
517
  stats_n_bytes_read += stats_prev_global_read_bucket-global_read_bucket;
  connection_bucket_refill(&now);
  stats_prev_global_read_bucket = global_read_bucket;

Nick Mathewson's avatar
Nick Mathewson committed
518
  if(now.tv_sec > current_second) { /* the second has rolled over. check more stuff. */
519

Nick Mathewson's avatar
Nick Mathewson committed
520
    ++stats_n_seconds_reading;
521
    assert_all_pending_dns_resolves_ok();
Nick Mathewson's avatar
Nick Mathewson committed
522
    run_scheduled_events(now.tv_sec);
523
    assert_all_pending_dns_resolves_ok();
524

525
    current_second = now.tv_sec; /* remember which second it is, for next time */
526
527
  }

528
529
  for(i=0;i<nfds;i++) {
    conn = connection_array[i];
530
531
    if(connection_has_pending_tls_data(conn) &&
       connection_is_reading(conn)) {
532
533
534
535
536
537
      log_fn(LOG_DEBUG,"sock %d has pending bytes.",conn->s);
      return 0; /* has pending bytes to read; don't let poll wait. */
    }
  }

  return (1000 - (now.tv_usec / 1000)); /* how many milliseconds til the next second? */
538
539
}

Roger Dingledine's avatar
Roger Dingledine committed
540
/** Configure the Tor process from the command line arguments and from the
541
542
 * configuration file.
 */
543
static int init_from_config(int argc, char **argv) {
544
  /* read the configuration file. */
545
546
547
548
549
  if(getconfig(argc,argv,&options)) {
    log_fn(LOG_ERR,"Reading config failed. For usage, try -h.");
    return -1;
  }
  close_logs(); /* we'll close, then open with correct loglevel if necessary */
550

551
  /* Setuid/setgid as appropriate */
552
553
554
555
556
557
  if(options.User || options.Group) {
    if(switch_id(options.User, options.Group) != 0) {
      return -1;
    }
  }

558
  /* Start backgrounding the process, if requested. */
559
560
561
562
  if (options.RunAsDaemon) {
    start_daemon(options.DataDirectory);
  }

563
  /* Configure the log(s) */
564
565
  if(!options.LogFile && !options.RunAsDaemon)
    add_stream_log(options.loglevel, "<stdout>", stdout);
566
  if(options.LogFile) {
567
568
569
570
571
    if (add_file_log(options.loglevel, options.LogFile) != 0) {
      /* opening the log file failed!  Use stderr and log a warning */
      add_stream_log(options.loglevel, "<stderr>", stderr);
      log_fn(LOG_WARN, "Cannot write to LogFile '%s': %s.", options.LogFile, strerror(errno));
    }
572
    log_fn(LOG_NOTICE, "Successfully opened LogFile '%s', redirecting output.",
573
574
575
           options.LogFile);
  }
  if(options.DebugLogFile) {
576
    if (add_file_log(LOG_DEBUG, options.DebugLogFile) != 0)
577
578
579
      log_fn(LOG_WARN, "Cannot write to DebugLogFile '%s': %s.", options.DebugLogFile, strerror(errno));
    log_fn(LOG_DEBUG, "Successfully opened DebugLogFile '%s'.", options.DebugLogFile);
  }
580

581
  /* Set up our buckets */
582
  connection_bucket_init();
583
584
  stats_prev_global_read_bucket = global_read_bucket;

585
  /* Finish backgrounding the process */
586
587
588
  if(options.RunAsDaemon) {
    /* XXXX Can we delay this any more? */
    finish_daemon();
589
590
  }

591
592
  /* Write our pid to the pid file. if we do not have write permissions we
   * will log a warning */
593
594
  if(options.PidFile)
    write_pidfile(options.PidFile);
595

596
597
598
  return 0;
}

Roger Dingledine's avatar
Roger Dingledine committed
599
/** Called when we get a SIGHUP: reload configuration files and keys,
600
 * retry all connections, re-upload all descriptors, and so on. */
601
602
603
static int do_hup(void) {
  char keydir[512];

604
  log_fn(LOG_NOTICE,"Received sighup. Reloading config.");
605
  has_completed_circuit=0;
606
607
608
609
610
  /* first, reload config variables, in case they've changed */
  /* no need to provide argc/v, they've been cached inside init_from_config */
  if (init_from_config(0, NULL) < 0) {
    exit(1);
  }
611
  /* reload keys as needed for rendezvous services. */
612
  if (rend_service_load_keys()<0) {
613
614
615
    log_fn(LOG_ERR,"Error reloading rendezvous service keys");
    exit(1);
  }
616
617
618
619
620
621
622
623
624
625
626
  if(retry_all_connections() < 0) {
    log_fn(LOG_ERR,"Failed to bind one of the listener ports.");
    return -1;
  }
  if(options.DirPort) {
    /* reload the approved-routers file */
    sprintf(keydir,"%s/approved-routers", options.DataDirectory);
    log_fn(LOG_INFO,"Reloading approved fingerprints from %s...",keydir);
    if(dirserv_parse_fingerprint_file(keydir) < 0) {
      log_fn(LOG_WARN, "Error reloading fingerprints. Continuing with old list.");
    }
627
628
    /* Since we aren't fetching a directory, we won't retry rendezvous points
     * when it gets in.  Try again now. */
629
    rend_services_introduce();
630
631
  } else {
    /* fetch a new directory */
Roger Dingledine's avatar
Roger Dingledine committed
632
    directory_initiate_command(router_pick_directory_server(),
633
                               DIR_PURPOSE_FETCH_DIR, NULL, 0);
634
635
636
637
638
639
640
641
642
643
644
645
  }
  if(options.ORPort) {
    router_rebuild_descriptor();
    sprintf(keydir,"%s/router.desc", options.DataDirectory);
    log_fn(LOG_INFO,"Dumping descriptor to %s...",keydir);
    if (write_str_to_file(keydir, router_get_my_descriptor())) {
      return -1;
    }
  }
  return 0;
}

Roger Dingledine's avatar
Roger Dingledine committed
646
/** Tor main loop. */
647
648
649
650
static int do_main_loop(void) {
  int i;
  int timeout;
  int poll_result;
Roger Dingledine's avatar
Roger Dingledine committed
651

652
653
  /* Initialize the history structures. */
  rep_hist_init();
654
  /* Intialize the service cache. */
Nick Mathewson's avatar
Nick Mathewson committed
655
  rend_cache_init();
656

657
658
  /* load the private keys, if we're supposed to have them, and set up the
   * TLS context. */
659
  if (init_keys() < 0 || rend_service_load_keys() < 0) {
660
661
662
663
    log_fn(LOG_ERR,"Error initializing keys; exiting");
    return -1;
  }

664
665
666
667
668
669
670
  /* load the routers file */
  if(options.RouterFile &&
     router_set_routerlist_from_file(options.RouterFile) < 0) {
    log_fn(LOG_ERR,"Error loading router list.");
    return -1;
  }

671
672
673
674
675
  if(options.DirPort) { /* the directory is already here, run startup things */
    has_fetched_directory = 1;
    directory_has_arrived();
  }

676
  if(options.ORPort) {
677
    cpu_init(); /* launch cpuworkers. Need to do this *after* we've read the onion key. */
Roger Dingledine's avatar
Roger Dingledine committed
678
  }
Roger Dingledine's avatar
Roger Dingledine committed
679

680
681
  /* start up the necessary connections based on which ports are
   * non-zero. This is where we try to connect to all the other ORs,
682
   * and start the listeners.
683
   */
684
685
686
687
  if(retry_all_connections() < 0) {
    log_fn(LOG_ERR,"Failed to bind one of the listener ports.");
    return -1;
  }
Roger Dingledine's avatar
Roger Dingledine committed
688
689

  for(;;) {
690
#ifndef MS_WINDOWS /* do signal stuff only on unix */
691
    if(please_dumpstats) {
692
693
      /* prefer to log it at INFO, but make sure we always see it */
      dumpstats(options.loglevel>LOG_INFO ? options.loglevel : LOG_INFO);
694
695
      please_dumpstats = 0;
    }
696
    if(please_reset) {
697
      do_hup();
698
      please_reset = 0;
699
    }
Roger Dingledine's avatar
Roger Dingledine committed
700
701
702
703
    if(please_reap_children) {
      while(waitpid(-1,NULL,WNOHANG)) ; /* keep reaping until no more zombies */
      please_reap_children = 0;
    }
704
#endif /* signal stuff */
705

706
707
708
    timeout = prepare_for_poll();

    /* poll until we have an event, or the second ends */
709
    poll_result = tor_poll(poll_array, nfds, timeout);
710

711
    /* let catch() handle things like ^c, and otherwise don't worry about it */
712
    if(poll_result < 0) {
713
714
715
      /* let the program survive things like ^z */
      if(tor_socket_errno(-1) != EINTR) {
        log_fn(LOG_ERR,"poll failed: %s [%d]",
716
717
               tor_socket_strerror(tor_socket_errno(-1)),
               tor_socket_errno(-1));
718
        return -1;
719
      } else {
Nick Mathewson's avatar
Nick Mathewson committed
720
        log_fn(LOG_DEBUG,"poll interrupted.");
721
      }
722
    }
Roger Dingledine's avatar
Roger Dingledine committed
723

724
725
    /* do all the reads and errors first, so we can detect closed sockets */
    for(i=0;i<nfds;i++)
726
      conn_read(i); /* this also marks broken connections */
Roger Dingledine's avatar
Roger Dingledine committed
727

728
729
730
731
732
733
    /* then do the writes */
    for(i=0;i<nfds;i++)
      conn_write(i);

    /* any of the conns need to be closed now? */
    for(i=0;i<nfds;i++)
Roger Dingledine's avatar
Roger Dingledine committed
734
      conn_close_if_marked(i);
Roger Dingledine's avatar
Roger Dingledine committed
735

736
737
738
    /* refilling buckets and sending cells happens at the beginning of the
     * next iteration of the loop, inside prepare_for_poll()
     */
Roger Dingledine's avatar
Roger Dingledine committed
739
740
741
  }
}

Roger Dingledine's avatar
Roger Dingledine committed
742
/** Unix signal handler. */
743
static void catch(int the_signal) {
Roger Dingledine's avatar
Roger Dingledine committed
744

745
#ifndef MS_WINDOWS /* do signal stuff only on unix */
746
  switch(the_signal) {
747
//    case SIGABRT:
748
749
    case SIGTERM:
    case SIGINT:
750
      log(LOG_ERR,"Catching signal %d, exiting cleanly.", the_signal);
751
752
      /* we don't care if there was an error when we unlink, nothing
         we could do about it anyways */
753
754
      if(options.PidFile)
        unlink(options.PidFile);
755
      exit(0);
756
757
758
    case SIGPIPE:
      log(LOG_WARN,"Bug: caught sigpipe. Ignoring.");
      break;
759
    case SIGHUP:
760
      please_reset = 1;
761
762
763
764
      break;
    case SIGUSR1:
      please_dumpstats = 1;
      break;
Roger Dingledine's avatar
Roger Dingledine committed
765
766
    case SIGCHLD:
      please_reap_children = 1;
Roger Dingledine's avatar
Roger Dingledine committed
767
      break;
768
    default:
Roger Dingledine's avatar
Roger Dingledine committed
769
      log(LOG_WARN,"Caught signal %d that we can't handle??", the_signal);
770
  }
771
#endif /* signal stuff */
772
773
}

Roger Dingledine's avatar
Roger Dingledine committed
774
/** Write all statistics to the log, with log level 'severity'.  Called
Nick Mathewson's avatar
Nick Mathewson committed
775
 * in response to a SIGUSR1. */
776
static void dumpstats(int severity) {
777
778
  int i;
  connection_t *conn;
779
  time_t now = time(NULL);
780

781
  log(severity, "Dumping stats:");
782
783
784

  for(i=0;i<nfds;i++) {
    conn = connection_array[i];
Roger Dingledine's avatar
Roger Dingledine committed
785
    log(severity, "Conn %d (socket %d) type %d (%s), state %d (%s), created %d secs ago",
786
      i, conn->s, conn->type, CONN_TYPE_TO_STRING(conn->type),
Roger Dingledine's avatar
Roger Dingledine committed
787
      conn->state, conn_state_to_string[conn->type][conn->state], (int)(now - conn->timestamp_created));
788
    if(!connection_is_listener(conn)) {
789
      log(severity,"Conn %d is to '%s:%d'.",i,conn->address, conn->port);
Roger Dingledine's avatar
Roger Dingledine committed
790
      log(severity,"Conn %d: %d bytes waiting on inbuf (last read %d secs ago)",i,
791
             (int)buf_datalen(conn->inbuf),
Roger Dingledine's avatar
Roger Dingledine committed
792
793
794
             (int)(now - conn->timestamp_lastread));
      log(severity,"Conn %d: %d bytes waiting on outbuf (last written %d secs ago)",i,
             (int)buf_datalen(conn->outbuf), (int)(now - conn->timestamp_lastwritten));
795
    }
796
    circuit_dump_by_conn(conn, severity); /* dump info about all the circuits using this conn */
797
  }
798
799
  log(severity,
         "Cells processed: %10lu padding\n"
800
801
802
803
804
         "                 %10lu create\n"
         "                 %10lu created\n"
         "                 %10lu relay\n"
         "                        (%10lu relayed)\n"
         "                        (%10lu delivered)\n"
805
         "                 %10lu destroy",
806
807
808
809
810
811
812
813
         stats_n_padding_cells_processed,
         stats_n_create_cells_processed,
         stats_n_created_cells_processed,
         stats_n_relay_cells_processed,
         stats_n_relay_cells_relayed,
         stats_n_relay_cells_delivered,
         stats_n_destroy_cells_processed);
  if (stats_n_data_cells_packaged)
814
    log(severity,"Average packaged cell fullness: %2.3f%%",
Roger Dingledine's avatar
Roger Dingledine committed
815
           100*(((double)stats_n_data_bytes_packaged) /
816
                (stats_n_data_cells_packaged*RELAY_PAYLOAD_SIZE)) );
817
  if (stats_n_data_cells_received)
818
    log(severity,"Average delivered cell fullness: %2.3f%%",
Roger Dingledine's avatar
Roger Dingledine committed
819
           100*(((double)stats_n_data_bytes_received) /
820
                (stats_n_data_cells_received*RELAY_PAYLOAD_SIZE)) );
Roger Dingledine's avatar
Roger Dingledine committed
821

822
  if (stats_n_seconds_reading)
823
    log(severity,"Average bandwidth used: %d bytes/sec",
824
           (int) (stats_n_bytes_read/stats_n_seconds_reading));
825
826

  rep_hist_dump_stats(now,severity);
827
  rend_service_dump_stats(severity);
828
829
}

Roger Dingledine's avatar
Roger Dingledine committed
830
/** Called before we make any calls to network-related functions.
Nick Mathewson's avatar
Nick Mathewson committed
831
832
 * (Some operating systems require their network libraries to be
 * initialized.) */
833
834
835
836
837
838
839
840
841
int network_init(void)
{
#ifdef MS_WINDOWS
  /* This silly exercise is necessary before windows will allow gethostbyname to work.
   */
  WSADATA WSAData;
  int r;
  r = WSAStartup(0x101,&WSAData);
  if (r) {
Roger Dingledine's avatar
Roger Dingledine committed
842
843
    log_fn(LOG_WARN,"Error initializing windows network layer: code was %d",r);
    return -1;
844
845
846
847
848
849
  }
  /* XXXX We should call WSACleanup on exit, I think. */
#endif
  return 0;
}

Roger Dingledine's avatar
Roger Dingledine committed
850
/** Called by exit() as we shut down the process.
Nick Mathewson's avatar
Nick Mathewson committed
851
 */
852
853
854
855
856
857
858
void exit_function(void)
{
#ifdef MS_WINDOWS
  WSACleanup();
#endif
}

Roger Dingledine's avatar
Roger Dingledine committed
859
/** Main entry point for the Tor command-line client.
Nick Mathewson's avatar
Nick Mathewson committed
860
 */
861
int tor_main(int argc, char *argv[]) {
Roger Dingledine's avatar
Roger Dingledine committed
862

863
864
  /* give it somewhere to log to initially */
  add_stream_log(LOG_INFO, "<stdout>", stdout);
865
  log_fn(LOG_NOTICE,"Tor v%s. This is experimental software. Do not use it if you need anonymity.",VERSION);
866

867
  if (network_init()<0) {
Roger Dingledine's avatar
Roger Dingledine committed
868
869
    log_fn(LOG_ERR,"Error initializing network; exiting.");
    return 1;
870
871
872
  }
  atexit(exit_function);

873
874
875
  if (init_from_config(argc,argv) < 0)
    return -1;

876
877
878
879
#ifndef MS_WINDOWS
  if(geteuid()==0)
    log_fn(LOG_WARN,"You are running Tor as root. You don't need to, and you probably shouldn't.");
#endif
880

881
  if(options.ORPort) { /* only spawn dns handlers if we're a router */
882
    dns_init(); /* initialize the dns resolve tree, and spawn workers */
883
  }
Roger Dingledine's avatar
Roger Dingledine committed
884
885
886
  if(options.SocksPort) {
    client_dns_init(); /* init the client dns cache */
  }
887

888
#ifndef MS_WINDOWS /* do signal stuff only on unix */
889
890
891
892
893
894
895
896
897
898
899
900
901
{
  struct sigaction action;
  action