mainloop.c 83.4 KB
Newer Older
Roger Dingledine's avatar
Roger Dingledine committed
1
2
/* Copyright (c) 2001 Matej Pfajfar.
 * Copyright (c) 2001-2004, Roger Dingledine.
3
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
4
 * Copyright (c) 2007-2021, The Tor Project, Inc. */
5
/* See LICENSE for licensing information */
Roger Dingledine's avatar
Roger Dingledine committed
6

Roger Dingledine's avatar
Roger Dingledine committed
7
/**
8
 * \file mainloop.c
9
 * \brief Toplevel module. Handles signals, multiplexes between
10
 *     connections, implements main loop, and drives scheduled events.
Nick Mathewson's avatar
Nick Mathewson committed
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 *
 * For the main loop itself; see run_main_loop_once().  It invokes the rest of
 * Tor mostly through Libevent callbacks.  Libevent callbacks can happen when
 * a timer elapses, a signal is received, a socket is ready to read or write,
 * or an event is manually activated.
 *
 * Most events in Tor are driven from these callbacks:
 *  <ul>
 *   <li>conn_read_callback() and conn_write_callback() here, which are
 *     invoked when a socket is ready to read or write respectively.
 *   <li>signal_callback(), which handles incoming signals.
 *  </ul>
 * Other events are used for specific purposes, or for building more complex
 * control structures.  If you search for usage of tor_libevent_new(), you
 * will find all the events that we construct in Tor.
 *
 * Tor has numerous housekeeping operations that need to happen
 * regularly. They are handled in different ways:
 * <ul>
 *   <li>The most frequent operations are handled after every read or write
 *    event, at the end of connection_handle_read() and
 *    connection_handle_write().
 *
 *   <li>The next most frequent operations happen after each invocation of the
 *     main loop, in run_main_loop_once().
 *
 *   <li>Once per second, we run all of the operations listed in
 *     second_elapsed_callback(), and in its child, run_scheduled_events().
 *
 *   <li>Once-a-second operations are handled in second_elapsed_callback().
 *
 *   <li>More infrequent operations take place based on the periodic event
 *     driver in periodic.c .  These are stored in the periodic_events[]
 *     table.
 * </ul>
 *
Roger Dingledine's avatar
Roger Dingledine committed
47
 **/
48

49
#define MAINLOOP_PRIVATE
50
#include "core/or/or.h"
51

52
53
54
55
56
57
58
59
#include "app/config/config.h"
#include "app/config/statefile.h"
#include "app/main/ntmain.h"
#include "core/mainloop/connection.h"
#include "core/mainloop/cpuworker.h"
#include "core/mainloop/mainloop.h"
#include "core/mainloop/netstatus.h"
#include "core/mainloop/periodic.h"
60
61
#include "core/or/channel.h"
#include "core/or/channelpadding.h"
62
#include "core/or/channeltls.h"
63
64
65
66
67
#include "core/or/circuitbuild.h"
#include "core/or/circuitlist.h"
#include "core/or/circuituse.h"
#include "core/or/connection_edge.h"
#include "core/or/connection_or.h"
68
69
70
71
72
73
#include "core/or/dos.h"
#include "core/or/status.h"
#include "feature/client/addressmap.h"
#include "feature/client/bridges.h"
#include "feature/client/dnsserv.h"
#include "feature/client/entrynodes.h"
74
#include "feature/client/proxymode.h"
75
#include "feature/client/transports.h"
76
#include "feature/control/control.h"
77
#include "feature/control/control_events.h"
78
#include "feature/dirauth/authmode.h"
79
#include "feature/dircache/consdiffmgr.h"
80
#include "feature/dirclient/dirclient_modes.h"
81
#include "feature/dircommon/directory.h"
82
83
84
#include "feature/hibernate/hibernate.h"
#include "feature/hs/hs_cache.h"
#include "feature/hs/hs_client.h"
85
#include "feature/hs/hs_service.h"
86
87
88
#include "feature/nodelist/microdesc.h"
#include "feature/nodelist/networkstatus.h"
#include "feature/nodelist/nodelist.h"
89
90
91
92
93
#include "feature/nodelist/routerlist.h"
#include "feature/relay/dns.h"
#include "feature/relay/routerkeys.h"
#include "feature/relay/routermode.h"
#include "feature/relay/selftest.h"
94
#include "feature/stats/geoip_stats.h"
95
#include "feature/stats/predict_ports.h"
96
#include "feature/stats/connstats.h"
97
#include "feature/stats/rephist.h"
98
#include "lib/buf/buffers.h"
99
100
101
102
#include "lib/crypt_ops/crypto_rand.h"
#include "lib/err/backtrace.h"
#include "lib/tls/buffers_tls.h"

Nick Mathewson's avatar
Nick Mathewson committed
103
#include "lib/net/buffers_net.h"
104
#include "lib/evloop/compat_libevent.h"
105

106
107
#include <event2/event.h>

108
109
110
111
112
113
114
#include "core/or/cell_st.h"
#include "core/or/entry_connection_st.h"
#include "feature/nodelist/networkstatus_st.h"
#include "core/or/or_connection_st.h"
#include "app/config/or_state_st.h"
#include "feature/nodelist/routerinfo_st.h"
#include "core/or/socks_request_st.h"
115

116
117
118
119
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

120
#ifdef HAVE_SYSTEMD
121
122
123
124
125
#   if defined(__COVERITY__) && !defined(__INCLUDE_LEVEL__)
/* Systemd's use of gcc's __INCLUDE_LEVEL__ extension macro appears to confuse
 * Coverity. Here's a kludge to unconfuse it.
 */
#   define __INCLUDE_LEVEL__ 2
126
#endif /* defined(__COVERITY__) && !defined(__INCLUDE_LEVEL__) */
127
#include <systemd/sd-daemon.h>
128
#endif /* defined(HAVE_SYSTEMD) */
129

130
/* Token bucket for all traffic. */
131
token_bucket_rw_t global_bucket;
132
133

/* Token bucket for relayed traffic. */
134
token_bucket_rw_t global_relayed_bucket;
135

136
/* XXX we might want to keep stats about global_relayed_*_bucket too. Or not.*/
137
/** How many bytes have we read since we started the process? */
138
static uint64_t stats_n_bytes_read = 0;
139
/** How many bytes have we written since we started the process? */
140
static uint64_t stats_n_bytes_written = 0;
141
/** What time did this process start up? */
142
time_t time_of_process_start = 0;
Roger Dingledine's avatar
Roger Dingledine committed
143
/** How many seconds have we been running? */
144
static long stats_n_seconds_working = 0;
Alexander Færøy's avatar
Alexander Færøy committed
145
146
147
148
149
150
/** How many times have we returned from the main loop successfully? */
static uint64_t stats_n_main_loop_successes = 0;
/** How many times have we received an error from the main loop? */
static uint64_t stats_n_main_loop_errors = 0;
/** How many times have we returned from the main loop with no events. */
static uint64_t stats_n_main_loop_idle = 0;
151
152
153
154
155
156
157

/** How often will we honor SIGNEWNYM requests? */
#define MAX_SIGNEWNYM_RATE 10
/** When did we last process a SIGNEWNYM request? */
static time_t time_of_last_signewnym = 0;
/** Is there a signewnym request we're currently waiting to handle? */
static int signewnym_is_pending = 0;
158
159
/** Mainloop event for the deferred signewnym call. */
static mainloop_event_t *handle_deferred_signewnym_ev = NULL;
160
161
/** How many times have we called newnym? */
static unsigned newnym_epoch = 0;
162

163
/** Smartlist of all open connections. */
164
STATIC smartlist_t *connection_array = NULL;
165
166
/** List of connections that have been marked for close and need to be freed
 * and removed from connection_array. */
167
static smartlist_t *closeable_connection_lst = NULL;
168
169
/** List of linked connections that are currently reading data into their
 * inbuf from their partner's outbuf. */
170
static smartlist_t *active_linked_connection_lst = NULL;
171
172
173
/** Flag: Set to true iff we entered the current libevent main loop via
 * <b>loop_once</b>. If so, there's no need to trigger a loopexit in order
 * to handle linked connections. */
174
static int called_loop_once = 0;
175
176
177
178
179
180
181
182
/** Flag: if true, it's time to shut down, so the main loop should exit as
 * soon as possible.
 */
static int main_loop_should_exit = 0;
/** The return value that the main loop should yield when it exits, if
 * main_loop_should_exit is true.
 */
static int main_loop_exit_value = 0;
Roger Dingledine's avatar
Roger Dingledine committed
183

Roger Dingledine's avatar
Roger Dingledine committed
184
/** We set this to 1 when we've opened a circuit, so we can print a log
185
186
187
188
189
 * entry to inform the user that Tor is working.  We set it to 0 when
 * we think the fact that we once opened a circuit doesn't mean we can do so
 * any longer (a big time jump happened, when we notice our directory is
 * heinously out-of-date, etc.
 */
190
static int can_complete_circuits = 0;
191

192
193
194
195
196
197
/** How often do we check for router descriptors that we should download
 * when we have too little directory info? */
#define GREEDY_DESCRIPTOR_RETRY_INTERVAL (10)
/** How often do we check for router descriptors that we should download
 * when we have enough directory info? */
#define LAZY_DESCRIPTOR_RETRY_INTERVAL (60)
198

199
200
201
202
203
204
205
static int conn_close_if_marked(int i);
static void connection_start_reading_from_linked_conn(connection_t *conn);
static int connection_should_read_from_linked_conn(connection_t *conn);
static void conn_read_callback(evutil_socket_t fd, short event, void *_conn);
static void conn_write_callback(evutil_socket_t fd, short event, void *_conn);
static void shutdown_did_not_work_callback(evutil_socket_t fd, short event,
                                           void *arg) ATTR_NORETURN;
Roger Dingledine's avatar
Roger Dingledine committed
206

Roger Dingledine's avatar
Roger Dingledine committed
207
/****************************************************************************
208
209
210
211
212
 *
 * This section contains accessors and other methods on the connection_array
 * variables (which are global within this file and unavailable outside it).
 *
 ****************************************************************************/
Roger Dingledine's avatar
Roger Dingledine committed
213

214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
/** Return 1 if we have successfully built a circuit, and nothing has changed
 * to make us think that maybe we can't.
 */
int
have_completed_a_circuit(void)
{
  return can_complete_circuits;
}

/** Note that we have successfully built a circuit, so that reachability
 * testing and introduction points and so on may be attempted. */
void
note_that_we_completed_a_circuit(void)
{
  can_complete_circuits = 1;
}

/** Note that something has happened (like a clock jump, or DisableNetwork) to
 * make us think that maybe we can't complete circuits. */
void
note_that_we_maybe_cant_complete_circuits(void)
{
  can_complete_circuits = 0;
}

Roger Dingledine's avatar
Roger Dingledine committed
239
/** Add <b>conn</b> to the array of connections that we can poll on.  The
240
241
242
 * connection's socket must be set; the connection starts out
 * non-reading and non-writing.
 */
243
int
244
connection_add_impl(connection_t *conn, int is_connecting)
245
{
Roger Dingledine's avatar
Roger Dingledine committed
246
  tor_assert(conn);
247
  tor_assert(SOCKET_OK(conn->s) ||
248
249
             conn->linked ||
             (conn->type == CONN_TYPE_AP &&
250
              TO_EDGE_CONN(conn)->is_dns_request));
Roger Dingledine's avatar
Roger Dingledine committed
251

252
  tor_assert(conn->conn_array_index == -1); /* can only connection_add once */
253
254
  conn->conn_array_index = smartlist_len(connection_array);
  smartlist_add(connection_array, conn);
Roger Dingledine's avatar
Roger Dingledine committed
255

256
  (void) is_connecting;
257

258
  if (SOCKET_OK(conn->s) || conn->linked) {
259
260
261
262
    conn->read_event = tor_event_new(tor_libevent_get_base(),
         conn->s, EV_READ|EV_PERSIST, conn_read_callback, conn);
    conn->write_event = tor_event_new(tor_libevent_get_base(),
         conn->s, EV_WRITE|EV_PERSIST, conn_write_callback, conn);
263
    /* XXXX CHECK FOR NULL RETURN! */
264
  }
Roger Dingledine's avatar
Roger Dingledine committed
265

Roger Dingledine's avatar
Roger Dingledine committed
266
  log_debug(LD_NET,"new conn type %s, socket %d, address %s, n_conns %d.",
267
            conn_type_to_string(conn->type), (int)conn->s, conn->address,
268
            smartlist_len(connection_array));
Roger Dingledine's avatar
Roger Dingledine committed
269
270
271
272

  return 0;
}

273
274
275
276
277
278
/** Tell libevent that we don't care about <b>conn</b> any more. */
void
connection_unregister_events(connection_t *conn)
{
  if (conn->read_event) {
    if (event_del(conn->read_event))
279
      log_warn(LD_BUG, "Error removing read event for %d", (int)conn->s);
280
281
282
283
    tor_free(conn->read_event);
  }
  if (conn->write_event) {
    if (event_del(conn->write_event))
284
      log_warn(LD_BUG, "Error removing write event for %d", (int)conn->s);
285
286
    tor_free(conn->write_event);
  }
287
  if (conn->type == CONN_TYPE_AP_DNS_LISTENER) {
288
289
290
291
    dnsserv_close_listener(conn);
  }
}

Roger Dingledine's avatar
Roger Dingledine committed
292
/** Remove the connection from the global list, and remove the
Nick Mathewson's avatar
Nick Mathewson committed
293
294
295
 * corresponding poll entry.  Calling this function will shift the last
 * connection (if any) into the position occupied by conn.
 */
296
297
298
int
connection_remove(connection_t *conn)
{
Roger Dingledine's avatar
Roger Dingledine committed
299
  int current_index;
300
  connection_t *tmp;
Roger Dingledine's avatar
Roger Dingledine committed
301

Roger Dingledine's avatar
Roger Dingledine committed
302
  tor_assert(conn);
Roger Dingledine's avatar
Roger Dingledine committed
303

304
  log_debug(LD_NET,"removing socket %d (type %s), n_conns now %d",
305
            (int)conn->s, conn_type_to_string(conn->type),
306
            smartlist_len(connection_array));
Roger Dingledine's avatar
Roger Dingledine committed
307

308
  if (conn->type == CONN_TYPE_AP && conn->socket_family == AF_UNIX) {
309
    log_info(LD_NET, "Closing SOCKS Unix socket connection");
310
311
  }

Karsten Loesing's avatar
Karsten Loesing committed
312
313
  control_event_conn_bandwidth(conn);

314
315
  tor_assert(conn->conn_array_index >= 0);
  current_index = conn->conn_array_index;
316
  connection_unregister_events(conn); /* This is redundant, but cheap. */
317
318
  if (current_index == smartlist_len(connection_array)-1) { /* at the end */
    smartlist_del(connection_array, current_index);
Roger Dingledine's avatar
Roger Dingledine committed
319
    return 0;
Roger Dingledine's avatar
Roger Dingledine committed
320
  }
Roger Dingledine's avatar
Roger Dingledine committed
321

322
  /* replace this one with the one at the end */
323
324
325
  smartlist_del(connection_array, current_index);
  tmp = smartlist_get(connection_array, current_index);
  tmp->conn_array_index = current_index;
Roger Dingledine's avatar
Roger Dingledine committed
326

Roger Dingledine's avatar
Roger Dingledine committed
327
  return 0;
Roger Dingledine's avatar
Roger Dingledine committed
328
329
}

330
/** If <b>conn</b> is an edge conn, remove it from the list
331
332
333
 * of conn's on this circuit. If it's not on an edge,
 * flush and send destroys for all circuits on this conn.
 *
334
335
 * Remove it from connection_array (if applicable) and
 * from closeable_connection_list.
336
337
338
 *
 * Then free it.
 */
339
static void
340
connection_unlink(connection_t *conn)
341
{
342
  connection_about_to_close_connection(conn);
343
  if (conn->conn_array_index >= 0) {
344
345
    connection_remove(conn);
  }
346
347
348
349
350
351
352
  if (conn->linked_conn) {
    conn->linked_conn->linked_conn = NULL;
    if (! conn->linked_conn->marked_for_close &&
        conn->linked_conn->reading_from_linked_conn)
      connection_start_reading(conn->linked_conn);
    conn->linked_conn = NULL;
  }
353
  smartlist_remove(closeable_connection_lst, conn);
354
  smartlist_remove(active_linked_connection_lst, conn);
355
  if (conn->type == CONN_TYPE_EXIT) {
356
    assert_connection_edge_not_dns_pending(TO_EDGE_CONN(conn));
357
  }
358
359
  if (conn->type == CONN_TYPE_OR) {
    if (!tor_digest_is_zero(TO_OR_CONN(conn)->identity_digest))
360
      connection_or_clear_identity(TO_OR_CONN(conn));
361
362
363
364
365
366
367
368
369
370
371
372
    /* connection_unlink() can only get called if the connection
     * was already on the closeable list, and it got there by
     * connection_mark_for_close(), which was called from
     * connection_or_close_normally() or
     * connection_or_close_for_error(), so the channel should
     * already be in CHANNEL_STATE_CLOSING, and then the
     * connection_about_to_close_connection() goes to
     * connection_or_about_to_close(), which calls channel_closed()
     * to notify the channel_t layer, and closed the channel, so
     * nothing more to do here to deal with the channel associated
     * with an orconn.
     */
373
  }
374
375
376
  connection_free(conn);
}

377
378
379
/** Event that invokes schedule_active_linked_connections_cb. */
static mainloop_event_t *schedule_active_linked_connections_event = NULL;

380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
/**
 * Callback: used to activate read events for all linked connections, so
 * libevent knows to call their read callbacks.  This callback run as a
 * postloop event, so that the events _it_ activates don't happen until
 * Libevent has a chance to check for other events.
 */
static void
schedule_active_linked_connections_cb(mainloop_event_t *event, void *arg)
{
  (void)event;
  (void)arg;

  /* All active linked conns should get their read events activated,
   * so that libevent knows to run their callbacks. */
  SMARTLIST_FOREACH(active_linked_connection_lst, connection_t *, conn,
                    event_active(conn->read_event, EV_READ, 1));

397
398
399
400
401
402
403
404
405
406
407
  /* Reactivate the event if we still have connections in the active list.
   *
   * A linked connection doesn't get woken up by I/O but rather artificially
   * by this event callback. It has directory data spooled in it and it is
   * sent incrementally by small chunks unless spool_eagerly is true. For that
   * to happen, we need to induce the activation of the read event so it can
   * be flushed. */
  if (smartlist_len(active_linked_connection_lst)) {
    mainloop_event_activate(schedule_active_linked_connections_event);
  }
}
408

409
410
/** Initialize the global connection list, closeable connection list,
 * and active connection list. */
411
412
void
tor_init_connection_lists(void)
413
414
415
416
417
418
419
420
421
{
  if (!connection_array)
    connection_array = smartlist_new();
  if (!closeable_connection_lst)
    closeable_connection_lst = smartlist_new();
  if (!active_linked_connection_lst)
    active_linked_connection_lst = smartlist_new();
}

422
/** Schedule <b>conn</b> to be closed. **/
423
424
425
void
add_connection_to_closeable_list(connection_t *conn)
{
Nick Mathewson's avatar
Nick Mathewson committed
426
  tor_assert(!smartlist_contains(closeable_connection_lst, conn));
427
  tor_assert(conn->marked_for_close);
428
  assert_connection_ok(conn, time(NULL));
429
  smartlist_add(closeable_connection_lst, conn);
430
  mainloop_schedule_postloop_cleanup();
431
432
}

433
/** Return 1 if conn is on the closeable list, else return 0. */
434
435
436
int
connection_is_on_closeable_list(connection_t *conn)
{
Nick Mathewson's avatar
Nick Mathewson committed
437
  return smartlist_contains(closeable_connection_lst, conn);
438
439
}

440
/** Return true iff conn is in the current poll array. */
441
442
443
int
connection_in_array(connection_t *conn)
{
Nick Mathewson's avatar
Nick Mathewson committed
444
  return smartlist_contains(connection_array, conn);
445
446
}

447
/** Set <b>*array</b> to an array of all connections. <b>*array</b> must not
Roger Dingledine's avatar
Roger Dingledine committed
448
 * be modified.
449
 */
450
451
MOCK_IMPL(smartlist_t *,
get_connection_array, (void))
452
{
453
  if (!connection_array)
454
    connection_array = smartlist_new();
455
  return connection_array;
456
457
}

458
459
460
461
/**
 * Return the amount of network traffic read, in bytes, over the life of this
 * process.
 */
462
463
MOCK_IMPL(uint64_t,
get_bytes_read,(void))
464
465
466
467
{
  return stats_n_bytes_read;
}

468
469
470
471
/**
 * Return the amount of network traffic read, in bytes, over the life of this
 * process.
 */
472
473
MOCK_IMPL(uint64_t,
get_bytes_written,(void))
474
475
476
477
{
  return stats_n_bytes_written;
}

478
479
480
481
482
483
484
485
486
487
488
/**
 * Increment the amount of network traffic read and written, over the life of
 * this process.
 */
void
stats_increment_bytes_read_and_written(uint64_t r, uint64_t w)
{
  stats_n_bytes_read += r;
  stats_n_bytes_written += w;
}

489
/** Set the event mask on <b>conn</b> to <b>events</b>.  (The event
490
 * mask is a bitmask whose bits are READ_EVENT and WRITE_EVENT)
491
 */
492
void
493
connection_watch_events(connection_t *conn, watchable_events_t events)
494
{
495
  if (events & READ_EVENT)
496
497
498
499
    connection_start_reading(conn);
  else
    connection_stop_reading(conn);

500
  if (events & WRITE_EVENT)
501
502
503
    connection_start_writing(conn);
  else
    connection_stop_writing(conn);
Roger Dingledine's avatar
Roger Dingledine committed
504
505
}

Roger Dingledine's avatar
Roger Dingledine committed
506
/** Return true iff <b>conn</b> is listening for read events. */
507
508
509
int
connection_is_reading(connection_t *conn)
{
510
  tor_assert(conn);
511

512
513
  return conn->reading_from_linked_conn ||
    (conn->read_event && event_pending(conn->read_event, EV_READ, NULL));
Roger Dingledine's avatar
Roger Dingledine committed
514
515
}

Alexander Færøy's avatar
Alexander Færøy committed
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
/** Reset our main loop counters. */
void
reset_main_loop_counters(void)
{
  stats_n_main_loop_successes = 0;
  stats_n_main_loop_errors = 0;
  stats_n_main_loop_idle = 0;
}

/** Increment the main loop success counter. */
static void
increment_main_loop_success_count(void)
{
  ++stats_n_main_loop_successes;
}

/** Get the main loop success counter. */
uint64_t
get_main_loop_success_count(void)
{
  return stats_n_main_loop_successes;
}

/** Increment the main loop error counter. */
static void
increment_main_loop_error_count(void)
{
  ++stats_n_main_loop_errors;
}

/** Get the main loop error counter. */
uint64_t
get_main_loop_error_count(void)
{
  return stats_n_main_loop_errors;
}

/** Increment the main loop idle counter. */
static void
increment_main_loop_idle_count(void)
{
  ++stats_n_main_loop_idle;
}

/** Get the main loop idle counter. */
uint64_t
get_main_loop_idle_count(void)
{
  return stats_n_main_loop_idle;
}

567
/** Check whether <b>conn</b> is correct in having (or not having) a
568
 * read/write event (passed in <b>ev</b>). On success, return 0. On failure,
569
 * log a warning and return -1. */
570
571
572
573
574
575
static int
connection_check_event(connection_t *conn, struct event *ev)
{
  int bad;

  if (conn->type == CONN_TYPE_AP && TO_EDGE_CONN(conn)->is_dns_request) {
576
577
578
579
    /* DNS requests which we launch through the dnsserv.c module do not have
     * any underlying socket or any underlying linked connection, so they
     * shouldn't have any attached events either.
     */
580
581
    bad = ev != NULL;
  } else {
Chelsea H. Komlo's avatar
Chelsea H. Komlo committed
582
    /* Everything else should have an underlying socket, or a linked
583
584
     * connection (which is also tracked with a read_event/write_event pair).
     */
585
586
587
588
589
590
591
592
593
594
595
    bad = ev == NULL;
  }

  if (bad) {
    log_warn(LD_BUG, "Event missing on connection %p [%s;%s]. "
             "socket=%d. linked=%d. "
             "is_dns_request=%d. Marked_for_close=%s:%d",
             conn,
             conn_type_to_string(conn->type),
             conn_state_to_string(conn->type, conn->state),
             (int)conn->s, (int)conn->linked,
Nick Mathewson's avatar
Nick Mathewson committed
596
597
             (conn->type == CONN_TYPE_AP &&
                               TO_EDGE_CONN(conn)->is_dns_request),
598
599
600
601
602
603
604
605
606
             conn->marked_for_close_file ? conn->marked_for_close_file : "-",
             conn->marked_for_close
             );
    log_backtrace(LOG_WARN, LD_BUG, "Backtrace attached.");
    return -1;
  }
  return 0;
}

Roger Dingledine's avatar
Roger Dingledine committed
607
/** Tell the main loop to stop notifying <b>conn</b> of any read events. */
608
609
MOCK_IMPL(void,
connection_stop_reading,(connection_t *conn))
610
{
611
  tor_assert(conn);
612

613
  if (connection_check_event(conn, conn->read_event) < 0) {
614
615
    return;
  }
616

617
618
619
620
621
622
623
  if (conn->linked) {
    conn->reading_from_linked_conn = 0;
    connection_stop_reading_from_linked_conn(conn);
  } else {
    if (event_del(conn->read_event))
      log_warn(LD_NET, "Error from libevent setting read event state for %d "
               "to unwatched: %s",
624
               (int)conn->s,
625
626
               tor_socket_strerror(tor_socket_errno(conn->s)));
  }
627
628
}

Roger Dingledine's avatar
Roger Dingledine committed
629
/** Tell the main loop to start notifying <b>conn</b> of any read events. */
630
631
MOCK_IMPL(void,
connection_start_reading,(connection_t *conn))
632
{
633
  tor_assert(conn);
634

635
  if (connection_check_event(conn, conn->read_event) < 0) {
636
637
    return;
  }
638

639
640
641
642
643
644
645
646
  if (conn->linked) {
    conn->reading_from_linked_conn = 1;
    if (connection_should_read_from_linked_conn(conn))
      connection_start_reading_from_linked_conn(conn);
  } else {
    if (event_add(conn->read_event, NULL))
      log_warn(LD_NET, "Error from libevent setting read event state for %d "
               "to watched: %s",
647
               (int)conn->s,
648
649
               tor_socket_strerror(tor_socket_errno(conn->s)));
  }
650
651
}

Roger Dingledine's avatar
Roger Dingledine committed
652
/** Return true iff <b>conn</b> is listening for write events. */
653
654
655
int
connection_is_writing(connection_t *conn)
{
656
657
  tor_assert(conn);

658
659
  return conn->writing_to_linked_conn ||
    (conn->write_event && event_pending(conn->write_event, EV_WRITE, NULL));
660
661
}

Roger Dingledine's avatar
Roger Dingledine committed
662
/** Tell the main loop to stop notifying <b>conn</b> of any write events. */
663
664
MOCK_IMPL(void,
connection_stop_writing,(connection_t *conn))
665
{
666
  tor_assert(conn);
667

668
669
670
  if (connection_check_event(conn, conn->write_event) < 0) {
    return;
  }
671

672
673
674
675
676
677
678
679
  if (conn->linked) {
    conn->writing_to_linked_conn = 0;
    if (conn->linked_conn)
      connection_stop_reading_from_linked_conn(conn->linked_conn);
  } else {
    if (event_del(conn->write_event))
      log_warn(LD_NET, "Error from libevent setting write event state for %d "
               "to unwatched: %s",
680
               (int)conn->s,
681
682
               tor_socket_strerror(tor_socket_errno(conn->s)));
  }
683
684
}

Roger Dingledine's avatar
Roger Dingledine committed
685
/** Tell the main loop to start notifying <b>conn</b> of any write events. */
686
687
MOCK_IMPL(void,
connection_start_writing,(connection_t *conn))
688
{
689
  tor_assert(conn);
690

691
692
693
  if (connection_check_event(conn, conn->write_event) < 0) {
    return;
  }
694

695
696
697
698
699
700
701
702
703
  if (conn->linked) {
    conn->writing_to_linked_conn = 1;
    if (conn->linked_conn &&
        connection_should_read_from_linked_conn(conn->linked_conn))
      connection_start_reading_from_linked_conn(conn->linked_conn);
  } else {
    if (event_add(conn->write_event, NULL))
      log_warn(LD_NET, "Error from libevent setting write event state for %d "
               "to watched: %s",
704
               (int)conn->s,
705
706
707
708
               tor_socket_strerror(tor_socket_errno(conn->s)));
  }
}

709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
/** Return true iff <b>conn</b> is linked conn, and reading from the conn
 * linked to it would be good and feasible.  (Reading is "feasible" if the
 * other conn exists and has data in its outbuf, and is "good" if we have our
 * reading_from_linked_conn flag set and the other conn has its
 * writing_to_linked_conn flag set.)*/
static int
connection_should_read_from_linked_conn(connection_t *conn)
{
  if (conn->linked && conn->reading_from_linked_conn) {
    if (! conn->linked_conn ||
        (conn->linked_conn->writing_to_linked_conn &&
         buf_datalen(conn->linked_conn->outbuf)))
      return 1;
  }
  return 0;
}

Nick Mathewson's avatar
Nick Mathewson committed
726
727
728
/** Event to run 'shutdown did not work callback'. */
static struct event *shutdown_did_not_work_event = NULL;

729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
/** Failsafe measure that should never actually be necessary: If
 * tor_shutdown_event_loop_and_exit() somehow doesn't successfully exit the
 * event loop, then this callback will kill Tor with an assertion failure
 * seconds later
 */
static void
shutdown_did_not_work_callback(evutil_socket_t fd, short event, void *arg)
{
  // LCOV_EXCL_START
  (void) fd;
  (void) event;
  (void) arg;
  tor_assert_unreached();
  // LCOV_EXCL_STOP
}

745
746
747
748
749
750
751
752
753
754
755
756
#ifdef ENABLE_RESTART_DEBUGGING
static struct event *tor_shutdown_event_loop_for_restart_event = NULL;
static void
tor_shutdown_event_loop_for_restart_cb(
                      evutil_socket_t fd, short event, void *arg)
{
  (void)fd;
  (void)event;
  (void)arg;
  tor_event_free(tor_shutdown_event_loop_for_restart_event);
  tor_shutdown_event_loop_and_exit(0);
}
Nick Mathewson's avatar
Nick Mathewson committed
757
#endif /* defined(ENABLE_RESTART_DEBUGGING) */
758

759
760
761
762
763
764
765
766
767
768
769
770
771
/**
 * After finishing the current callback (if any), shut down the main loop,
 * clean up the process, and exit with <b>exitcode</b>.
 */
void
tor_shutdown_event_loop_and_exit(int exitcode)
{
  if (main_loop_should_exit)
    return; /* Ignore multiple calls to this function. */

  main_loop_should_exit = 1;
  main_loop_exit_value = exitcode;

772
773
774
775
  if (! tor_libevent_is_initialized()) {
    return; /* No event loop to shut down. */
  }

776
777
  /* Die with an assertion failure in ten seconds, if for some reason we don't
   * exit normally. */
778
  /* XXXX We should consider this code if it's never used. */
779
  struct timeval ten_seconds = { 10, 0 };
Nick Mathewson's avatar
Nick Mathewson committed
780
781
782
783
  shutdown_did_not_work_event = tor_evtimer_new(
                  tor_libevent_get_base(),
                  shutdown_did_not_work_callback, NULL);
  event_add(shutdown_did_not_work_event, &ten_seconds);
784

785
786
787
  /* Unlike exit_loop_after_delay(), exit_loop_after_callback
   * prevents other callbacks from running. */
  tor_libevent_exit_loop_after_callback(tor_libevent_get_base());
788
789
790
791
792
793
794
795
796
}

/** Return true iff tor_shutdown_event_loop_and_exit() has been called. */
int
tor_event_loop_shutdown_is_pending(void)
{
  return main_loop_should_exit;
}

797
798
799
800
/** Helper: Tell the main loop to begin reading bytes into <b>conn</b> from
 * its linked connection, if it is not doing so already.  Called by
 * connection_start_reading and connection_start_writing as appropriate. */
static void
801
802
803
804
805
806
807
808
connection_start_reading_from_linked_conn(connection_t *conn)
{
  tor_assert(conn);
  tor_assert(conn->linked == 1);

  if (!conn->active_on_link) {
    conn->active_on_link = 1;
    smartlist_add(active_linked_connection_lst, conn);
809
    mainloop_event_activate(schedule_active_linked_connections_event);
810
  } else {
Nick Mathewson's avatar
Nick Mathewson committed
811
    tor_assert(smartlist_contains(active_linked_connection_lst, conn));
812
813
814
  }
}

815
816
817
/** Tell the main loop to stop reading bytes into <b>conn</b> from its linked
 * connection, if is currently doing so.  Called by connection_stop_reading,
 * connection_stop_writing, and connection_read. */
818
819
820
821
822
823
824
825
void
connection_stop_reading_from_linked_conn(connection_t *conn)
{
  tor_assert(conn);
  tor_assert(conn->linked == 1);

  if (conn->active_on_link) {
    conn->active_on_link = 0;
826
827
828
    /* FFFF We could keep an index here so we can smartlist_del
     * cleanly.  On the other hand, this doesn't show up on profiles,
     * so let's leave it alone for now. */
829
830
    smartlist_remove(active_linked_connection_lst, conn);
  } else {
Nick Mathewson's avatar
Nick Mathewson committed
831
    tor_assert(!smartlist_contains(active_linked_connection_lst, conn));
832
  }
833
834
}

835
/** Close all connections that have been scheduled to get closed. */
836
STATIC void
837
838
839
840
841
close_closeable_connections(void)
{
  int i;
  for (i = 0; i < smartlist_len(closeable_connection_lst); ) {
    connection_t *conn = smartlist_get(closeable_connection_lst, i);
842
    if (conn->conn_array_index < 0) {
843
      connection_unlink(conn); /* blow it away right now */
844
    } else {
845
      if (!conn_close_if_marked(conn->conn_array_index))
846
847
        ++i;
    }
848
849
850
  }
}

851
/** Count moribund connections for the OOS handler */
852
853
MOCK_IMPL(int,
connection_count_moribund, (void))
854
{
855
  int moribund = 0;
856
857
858
859
860

  /*
   * Count things we'll try to kill when close_closeable_connections()
   * runs next.
   */
861
  SMARTLIST_FOREACH_BEGIN(closeable_connection_lst, connection_t *, conn) {
862
    if (SOCKET_OK(conn->s) && connection_is_moribund(conn)) ++moribund;
863
  } SMARTLIST_FOREACH_END(conn);
864
865
866
867

  return moribund;
}

868
869
/** Libevent callback: this gets invoked when (connection_t*)<b>conn</b> has
 * some data to read. */
870
static void
871
conn_read_callback(evutil_socket_t fd, short event, void *_conn)
872
873
{
  connection_t *conn = _conn;
874
875
  (void)fd;
  (void)event;
876

877
  log_debug(LD_NET,"socket %d wants to read.",(int)conn->s);
878

879
  /* assert_connection_ok(conn, time(NULL)); */
880

881
882
883
884
885
886
887
888
889
890
  /* Handle marked for close connections early */
  if (conn->marked_for_close && connection_is_reading(conn)) {
    /* Libevent says we can read, but we are marked for close so we will never
     * try to read again. We will try to close the connection below inside of
     * close_closeable_connections(), but let's make sure not to cause Libevent
     * to spin on conn_read_callback() while we wait for the socket to let us
     * flush to it.*/
    connection_stop_reading(conn);
  }

891
892
  if (connection_handle_read(conn) < 0) {
    if (!conn->marked_for_close) {
893
#ifndef _WIN32
894
      log_warn(LD_BUG,"Unhandled error on read for %s connection "
895
               "(fd %d); removing",
896
               conn_type_to_string(conn->type), (int)conn->s);
897
      tor_fragile_assert();
898
#endif /* !defined(_WIN32) */
899
      if (CONN_IS_EDGE(conn))
900
        connection_edge_end_errno(TO_EDGE_CONN(conn));
901
902
903
904
905
906
907
908
909
      connection_mark_for_close(conn);
    }
  }
  assert_connection_ok(conn, time(NULL));

  if (smartlist_len(closeable_connection_lst))
    close_closeable_connections();
}

910
911
/** Libevent callback: this gets invoked when (connection_t*)<b>conn</b> has
 * some data to write. */
912
static void
913
conn_write_callback(evutil_socket_t fd, short events, void *_conn)
914
915
{
  connection_t *conn = _conn;
916
917
  (void)fd;
  (void)events;
918

919
920
  LOG_FN_CONN(conn, (LOG_DEBUG, LD_NET, "socket %d wants to write.",
                     (int)conn->s));
921

922
  /* assert_connection_ok(conn, time(NULL)); */
923

924
  if (connection_handle_write(conn, 0) < 0) {
925
926
    if (!conn->marked_for_close) {
      /* this connection is broken. remove it. */
927
      log_fn(LOG_WARN,LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
928
             "unhandled error on write for %s connection (fd %d); removing",
929
             conn_type_to_string(conn->type), (int)conn->s);
930
      tor_fragile_assert();
931
932
      if (CONN_IS_EDGE(conn)) {
        /* otherwise we cry wolf about duplicate close */
933
934
935
        edge_connection_t *edge_conn = TO_EDGE_CONN(conn);
        if (!edge_conn->end_reason)
          edge_conn->end_reason = END_STREAM_REASON_INTERNAL;
936
        edge_conn->edge_has_sent_end = 1;
937
      }
938
      connection_close_immediate(conn); /* So we don't try to flush. */
939
940
941
942
943
944
945
946
947
      connection_mark_for_close(conn);
    }
  }
  assert_connection_ok(conn, time(NULL));

  if (smartlist_len(closeable_connection_lst))
    close_closeable_connections();
}

Roger Dingledine's avatar
Roger Dingledine committed
948
/** If the connection at connection_array[i] is marked for close, then:
949
950
951
952
953
 *    - 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.
954
 * Returns 1 if the connection was closed, 0 otherwise.
955
 */
956
957
958
static int
conn_close_if_marked(int i)
{
Roger Dingledine's avatar
Roger Dingledine committed
959
  connection_t *conn;
960
  int retval;
961
  time_t now;
Roger Dingledine's avatar
Roger Dingledine committed
962

963
  conn = smartlist_get(connection_array, i);
964
  if (!conn->marked_for_close)
965
    return 0; /* nothing to see here, move along */
966
967
  now = time(NULL);
  assert_connection_ok(conn, now);
968

Nick Mathewson's avatar
Nick Mathewson committed
969
970
  log_debug(LD_NET,"Cleaning up connection (fd "TOR_SOCKET_T_FORMAT").",
            conn->s);
971
972
973

  /* If the connection we are about to close was trying to connect to
  a proxy server and failed, the client won't be able to use that
974
  proxy. We should warn the user about this. */
975
976
  if (conn->proxy_state == PROXY_INFANT)
    log_failed_proxy_connection(conn);
977

978
979
  if ((SOCKET_OK(conn->s) || conn->linked_conn) &&
      connection_wants_to_flush(conn)) {
980
    /* s == -1 means it's an incomplete edge connection, or that the socket
981
     * has already been closed as unflushable. */
982
    ssize_t sz = connection_bucket_write_limit(conn, now);
983
    if (!conn->hold_open_until_flushed)
984
985
      log_info(LD_NET,
               "Conn (addr %s, fd %d, type %s, state %d) marked, but wants "
986
               "to flush %"TOR_PRIuSZ" bytes. (Marked at %s:%d)",
987
               escaped_safe_str_client(conn->address),
988
               (int)conn->s, conn_type_to_string(conn->type), conn->state,
989
990
               connection_get_outbuf_len(conn),
               conn->marked_for_close_file, conn->marked_for_close);
991
    if (conn->linked_conn) {
992
      retval = (int) buf_move_all(conn->linked_conn->inbuf, conn->outbuf);
993
994
995
996
997
      if (retval >= 0) {
        /* The linked conn will notice that it has data when it notices that
         * we're gone. */
        connection_start_reading_from_linked_conn(conn->linked_conn);
      }
998
      log_debug(LD_GENERAL, "Flushed last %d bytes from a linked conn; "
999
               "%d left; wants-to-flush==%d", retval,
1000
                (int)connection_get_outbuf_len(conn),
For faster browsing, not all history is shown. View entire blame