Tor  0.4.7.0-alpha-dev
mainloop.c
Go to the documentation of this file.
1 /* Copyright (c) 2001 Matej Pfajfar.
2  * 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 */
6 
7 /**
8  * \file mainloop.c
9  * \brief Toplevel module. Handles signals, multiplexes between
10  * connections, implements main loop, and drives scheduled events.
11  *
12  * For the main loop itself; see run_main_loop_once(). It invokes the rest of
13  * Tor mostly through Libevent callbacks. Libevent callbacks can happen when
14  * a timer elapses, a signal is received, a socket is ready to read or write,
15  * or an event is manually activated.
16  *
17  * Most events in Tor are driven from these callbacks:
18  * <ul>
19  * <li>conn_read_callback() and conn_write_callback() here, which are
20  * invoked when a socket is ready to read or write respectively.
21  * <li>signal_callback(), which handles incoming signals.
22  * </ul>
23  * Other events are used for specific purposes, or for building more complex
24  * control structures. If you search for usage of tor_libevent_new(), you
25  * will find all the events that we construct in Tor.
26  *
27  * Tor has numerous housekeeping operations that need to happen
28  * regularly. They are handled in different ways:
29  * <ul>
30  * <li>The most frequent operations are handled after every read or write
31  * event, at the end of connection_handle_read() and
32  * connection_handle_write().
33  *
34  * <li>The next most frequent operations happen after each invocation of the
35  * main loop, in run_main_loop_once().
36  *
37  * <li>Once per second, we run all of the operations listed in
38  * second_elapsed_callback(), and in its child, run_scheduled_events().
39  *
40  * <li>Once-a-second operations are handled in second_elapsed_callback().
41  *
42  * <li>More infrequent operations take place based on the periodic event
43  * driver in periodic.c . These are stored in the periodic_events[]
44  * table.
45  * </ul>
46  *
47  **/
48 
49 #define MAINLOOP_PRIVATE
50 #include "core/or/or.h"
51 
52 #include "app/config/config.h"
53 #include "app/config/statefile.h"
54 #include "app/main/ntmain.h"
57 #include "core/mainloop/mainloop.h"
59 #include "core/mainloop/periodic.h"
60 #include "core/or/channel.h"
61 #include "core/or/channelpadding.h"
62 #include "core/or/channeltls.h"
63 #include "core/or/circuitbuild.h"
64 #include "core/or/circuitlist.h"
65 #include "core/or/circuituse.h"
67 #include "core/or/connection_or.h"
68 #include "core/or/dos.h"
69 #include "core/or/status.h"
71 #include "feature/client/bridges.h"
72 #include "feature/client/dnsserv.h"
83 #include "feature/hs/hs_cache.h"
84 #include "feature/hs/hs_client.h"
85 #include "feature/hs/hs_service.h"
90 #include "feature/relay/dns.h"
93 #include "feature/relay/selftest.h"
97 #include "feature/stats/rephist.h"
98 #include "lib/buf/buffers.h"
100 #include "lib/err/backtrace.h"
101 #include "lib/tls/buffers_tls.h"
102 
103 #include "lib/net/buffers_net.h"
105 
106 #include <event2/event.h>
107 
108 #include "core/or/cell_st.h"
112 #include "app/config/or_state_st.h"
115 
116 #ifdef HAVE_UNISTD_H
117 #include <unistd.h>
118 #endif
119 
120 #ifdef HAVE_SYSTEMD
121 # if defined(__COVERITY__) && !defined(__INCLUDE_LEVEL__)
122 /* Systemd's use of gcc's __INCLUDE_LEVEL__ extension macro appears to confuse
123  * Coverity. Here's a kludge to unconfuse it.
124  */
125 # 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? */
143 /** How many seconds have we been running? */
144 static long stats_n_seconds_working = 0;
145 /** How many times have we returned from the main loop successfully? */
146 static uint64_t stats_n_main_loop_successes = 0;
147 /** How many times have we received an error from the main loop? */
148 static uint64_t stats_n_main_loop_errors = 0;
149 /** How many times have we returned from the main loop with no events. */
150 static uint64_t stats_n_main_loop_idle = 0;
151 
152 /** How often will we honor SIGNEWNYM requests? */
153 #define MAX_SIGNEWNYM_RATE 10
154 /** When did we last process a SIGNEWNYM request? */
155 static time_t time_of_last_signewnym = 0;
156 /** Is there a signewnym request we're currently waiting to handle? */
157 static int signewnym_is_pending = 0;
158 /** Mainloop event for the deferred signewnym call. */
160 /** How many times have we called newnym? */
161 static unsigned newnym_epoch = 0;
162 
163 /** Smartlist of all open connections. */
165 /** List of connections that have been marked for close and need to be freed
166  * and removed from connection_array. */
168 /** List of linked connections that are currently reading data into their
169  * inbuf from their partner's outbuf. */
171 /** Flag: Set to true iff we entered the current libevent main loop via
172  * <b>loop_once</b>. If so, there's no need to trigger a loopexit in order
173  * to handle linked connections. */
174 static int called_loop_once = 0;
175 /** Flag: if true, it's time to shut down, so the main loop should exit as
176  * soon as possible.
177  */
178 static int main_loop_should_exit = 0;
179 /** The return value that the main loop should yield when it exits, if
180  * main_loop_should_exit is true.
181  */
182 static int main_loop_exit_value = 0;
183 
184 /** We set this to 1 when we've opened a circuit, so we can print a log
185  * entry to inform the user that Tor is working. We set it to 0 when
186  * we think the fact that we once opened a circuit doesn't mean we can do so
187  * any longer (a big time jump happened, when we notice our directory is
188  * heinously out-of-date, etc.
189  */
190 static int can_complete_circuits = 0;
191 
192 /** How often do we check for router descriptors that we should download
193  * when we have too little directory info? */
194 #define GREEDY_DESCRIPTOR_RETRY_INTERVAL (10)
195 /** How often do we check for router descriptors that we should download
196  * when we have enough directory info? */
197 #define LAZY_DESCRIPTOR_RETRY_INTERVAL (60)
198 
199 static int conn_close_if_marked(int i);
202 static void conn_read_callback(evutil_socket_t fd, short event, void *_conn);
203 static void conn_write_callback(evutil_socket_t fd, short event, void *_conn);
204 static void shutdown_did_not_work_callback(evutil_socket_t fd, short event,
205  void *arg) ATTR_NORETURN;
206 
207 /****************************************************************************
208  *
209  * This section contains accessors and other methods on the connection_array
210  * variables (which are global within this file and unavailable outside it).
211  *
212  ****************************************************************************/
213 
214 /** Return 1 if we have successfully built a circuit, and nothing has changed
215  * to make us think that maybe we can't.
216  */
217 int
219 {
220  return can_complete_circuits;
221 }
222 
223 /** Note that we have successfully built a circuit, so that reachability
224  * testing and introduction points and so on may be attempted. */
225 void
227 {
229 }
230 
231 /** Note that something has happened (like a clock jump, or DisableNetwork) to
232  * make us think that maybe we can't complete circuits. */
233 void
235 {
237 }
238 
239 /** Add <b>conn</b> to the array of connections that we can poll on. The
240  * connection's socket must be set; the connection starts out
241  * non-reading and non-writing.
242  */
243 int
244 connection_add_impl(connection_t *conn, int is_connecting)
245 {
246  tor_assert(conn);
247  tor_assert(SOCKET_OK(conn->s) ||
248  conn->linked ||
249  (conn->type == CONN_TYPE_AP &&
250  TO_EDGE_CONN(conn)->is_dns_request));
251 
252  tor_assert(conn->conn_array_index == -1); /* can only connection_add once */
253  conn->conn_array_index = smartlist_len(connection_array);
255 
256  (void) is_connecting;
257 
258  if (SOCKET_OK(conn->s) || conn->linked) {
259  conn->read_event = tor_event_new(tor_libevent_get_base(),
260  conn->s, EV_READ|EV_PERSIST, conn_read_callback, conn);
261  conn->write_event = tor_event_new(tor_libevent_get_base(),
262  conn->s, EV_WRITE|EV_PERSIST, conn_write_callback, conn);
263  /* XXXX CHECK FOR NULL RETURN! */
264  }
265 
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));
269 
270  return 0;
271 }
272 
273 /** Tell libevent that we don't care about <b>conn</b> any more. */
274 void
276 {
277  if (conn->read_event) {
278  if (event_del(conn->read_event))
279  log_warn(LD_BUG, "Error removing read event for %d", (int)conn->s);
280  tor_free(conn->read_event);
281  }
282  if (conn->write_event) {
283  if (event_del(conn->write_event))
284  log_warn(LD_BUG, "Error removing write event for %d", (int)conn->s);
285  tor_free(conn->write_event);
286  }
287  if (conn->type == CONN_TYPE_AP_DNS_LISTENER) {
289  }
290 }
291 
292 /** Remove the connection from the global list, and remove the
293  * corresponding poll entry. Calling this function will shift the last
294  * connection (if any) into the position occupied by conn.
295  */
296 int
298 {
299  int current_index;
300  connection_t *tmp;
301 
302  tor_assert(conn);
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));
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 
313 
314  tor_assert(conn->conn_array_index >= 0);
315  current_index = conn->conn_array_index;
316  connection_unregister_events(conn); /* This is redundant, but cheap. */
317  if (current_index == smartlist_len(connection_array)-1) { /* at the end */
318  smartlist_del(connection_array, current_index);
319  return 0;
320  }
321 
322  /* replace this one with the one at the end */
323  smartlist_del(connection_array, current_index);
324  tmp = smartlist_get(connection_array, current_index);
325  tmp->conn_array_index = current_index;
326 
327  return 0;
328 }
329 
330 /** If <b>conn</b> is an edge conn, remove it from the list
331  * of conn's on this circuit. If it's not on an edge,
332  * flush and send destroys for all circuits on this conn.
333  *
334  * Remove it from connection_array (if applicable) and
335  * from closeable_connection_list.
336  *
337  * Then free it.
338  */
339 static void
341 {
343  if (conn->conn_array_index >= 0) {
344  connection_remove(conn);
345  }
346  if (conn->linked_conn) {
347  conn->linked_conn->linked_conn = NULL;
348  if (! conn->linked_conn->marked_for_close &&
351  conn->linked_conn = NULL;
352  }
355  if (conn->type == CONN_TYPE_EXIT) {
357  }
358  if (conn->type == CONN_TYPE_OR) {
359  if (!tor_digest_is_zero(TO_OR_CONN(conn)->identity_digest))
361  /* connection_unlink() can only get called if the connection
362  * was already on the closeable list, and it got there by
363  * connection_mark_for_close(), which was called from
364  * connection_or_close_normally() or
365  * connection_or_close_for_error(), so the channel should
366  * already be in CHANNEL_STATE_CLOSING, and then the
367  * connection_about_to_close_connection() goes to
368  * connection_or_about_to_close(), which calls channel_closed()
369  * to notify the channel_t layer, and closed the channel, so
370  * nothing more to do here to deal with the channel associated
371  * with an orconn.
372  */
373  }
374  connection_free(conn);
375 }
376 
377 /** Event that invokes schedule_active_linked_connections_cb. */
379 
380 /**
381  * Callback: used to activate read events for all linked connections, so
382  * libevent knows to call their read callbacks. This callback run as a
383  * postloop event, so that the events _it_ activates don't happen until
384  * Libevent has a chance to check for other events.
385  */
386 static void
388 {
389  (void)event;
390  (void)arg;
391 
392  /* All active linked conns should get their read events activated,
393  * so that libevent knows to run their callbacks. */
395  event_active(conn->read_event, EV_READ, 1));
396 
397  /* Reactivate the event if we still have connections in the active list.
398  *
399  * A linked connection doesn't get woken up by I/O but rather artificially
400  * by this event callback. It has directory data spooled in it and it is
401  * sent incrementally by small chunks unless spool_eagerly is true. For that
402  * to happen, we need to induce the activation of the read event so it can
403  * be flushed. */
404  if (smartlist_len(active_linked_connection_lst)) {
406  }
407 }
408 
409 /** Initialize the global connection list, closeable connection list,
410  * and active connection list. */
411 void
413 {
414  if (!connection_array)
420 }
421 
422 /** Schedule <b>conn</b> to be closed. **/
423 void
425 {
428  assert_connection_ok(conn, time(NULL));
431 }
432 
433 /** Return 1 if conn is on the closeable list, else return 0. */
434 int
436 {
438 }
439 
440 /** Return true iff conn is in the current poll array. */
441 int
443 {
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
448  * be modified.
449  */
452 {
453  if (!connection_array)
455  return connection_array;
456 }
457 
458 /**
459  * Return the amount of network traffic read, in bytes, over the life of this
460  * process.
461  */
462 MOCK_IMPL(uint64_t,
464 {
465  return stats_n_bytes_read;
466 }
467 
468 /**
469  * Return the amount of network traffic read, in bytes, over the life of this
470  * process.
471  */
472 MOCK_IMPL(uint64_t,
474 {
475  return stats_n_bytes_written;
476 }
477 
478 /**
479  * Increment the amount of network traffic read and written, over the life of
480  * this process.
481  */
482 void
484 {
485  stats_n_bytes_read += r;
487 }
488 
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
494 {
495  if (events & READ_EVENT)
497  else
499 
500  if (events & WRITE_EVENT)
502  else
504 }
505 
506 /** Return true iff <b>conn</b> is listening for read events. */
507 int
509 {
510  tor_assert(conn);
511 
512  return conn->reading_from_linked_conn ||
513  (conn->read_event && event_pending(conn->read_event, EV_READ, NULL));
514 }
515 
516 /** Reset our main loop counters. */
517 void
519 {
523 }
524 
525 /** Increment the main loop success counter. */
526 static void
528 {
530 }
531 
532 /** Get the main loop success counter. */
533 uint64_t
535 {
537 }
538 
539 /** Increment the main loop error counter. */
540 static void
542 {
544 }
545 
546 /** Get the main loop error counter. */
547 uint64_t
549 {
551 }
552 
553 /** Increment the main loop idle counter. */
554 static void
556 {
558 }
559 
560 /** Get the main loop idle counter. */
561 uint64_t
563 {
564  return stats_n_main_loop_idle;
565 }
566 
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 static int
571 connection_check_event(connection_t *conn, struct event *ev)
572 {
573  int bad;
574 
575  if (conn->type == CONN_TYPE_AP && TO_EDGE_CONN(conn)->is_dns_request) {
576  /* DNS requests which we launch through the dnsserv.c module do not have
577  * any underlying socket or any underlying linked connection, so they
578  * shouldn't have any attached events either.
579  */
580  bad = ev != NULL;
581  } else {
582  /* Everything else should have an underlying socket, or a linked
583  * connection (which is also tracked with a read_event/write_event pair).
584  */
585  bad = ev == NULL;
586  }
587 
588  if (bad) {
589  log_warn(LD_BUG, "Event missing on connection %p [%s;%s]. "
590  "socket=%d. linked=%d. "
591  "is_dns_request=%d. Marked_for_close=%s:%d",
592  conn,
593  conn_type_to_string(conn->type),
594  conn_state_to_string(conn->type, conn->state),
595  (int)conn->s, (int)conn->linked,
596  (conn->type == CONN_TYPE_AP &&
597  TO_EDGE_CONN(conn)->is_dns_request),
598  conn->marked_for_close_file ? conn->marked_for_close_file : "-",
599  conn->marked_for_close
600  );
601  log_backtrace(LOG_WARN, LD_BUG, "Backtrace attached.");
602  return -1;
603  }
604  return 0;
605 }
606 
607 /** Tell the main loop to stop notifying <b>conn</b> of any read events. */
608 MOCK_IMPL(void,
610 {
611  tor_assert(conn);
612 
613  if (connection_check_event(conn, conn->read_event) < 0) {
614  return;
615  }
616 
617  if (conn->linked) {
618  conn->reading_from_linked_conn = 0;
620  } else {
621  if (event_del(conn->read_event))
622  log_warn(LD_NET, "Error from libevent setting read event state for %d "
623  "to unwatched: %s",
624  (int)conn->s,
625  tor_socket_strerror(tor_socket_errno(conn->s)));
626  }
627 }
628 
629 /** Tell the main loop to start notifying <b>conn</b> of any read events. */
630 MOCK_IMPL(void,
632 {
633  tor_assert(conn);
634 
635  if (connection_check_event(conn, conn->read_event) < 0) {
636  return;
637  }
638 
639  if (conn->linked) {
640  conn->reading_from_linked_conn = 1;
643  } else {
644  if (event_add(conn->read_event, NULL))
645  log_warn(LD_NET, "Error from libevent setting read event state for %d "
646  "to watched: %s",
647  (int)conn->s,
648  tor_socket_strerror(tor_socket_errno(conn->s)));
649  }
650 }
651 
652 /** Return true iff <b>conn</b> is listening for write events. */
653 int
655 {
656  tor_assert(conn);
657 
658  return conn->writing_to_linked_conn ||
659  (conn->write_event && event_pending(conn->write_event, EV_WRITE, NULL));
660 }
661 
662 /** Tell the main loop to stop notifying <b>conn</b> of any write events. */
663 MOCK_IMPL(void,
665 {
666  tor_assert(conn);
667 
668  if (connection_check_event(conn, conn->write_event) < 0) {
669  return;
670  }
671 
672  if (conn->linked) {
673  conn->writing_to_linked_conn = 0;
674  if (conn->linked_conn)
676  } else {
677  if (event_del(conn->write_event))
678  log_warn(LD_NET, "Error from libevent setting write event state for %d "
679  "to unwatched: %s",
680  (int)conn->s,
681  tor_socket_strerror(tor_socket_errno(conn->s)));
682  }
683 }
684 
685 /** Tell the main loop to start notifying <b>conn</b> of any write events. */
686 MOCK_IMPL(void,
688 {
689  tor_assert(conn);
690 
691  if (connection_check_event(conn, conn->write_event) < 0) {
692  return;
693  }
694 
695  if (conn->linked) {
696  conn->writing_to_linked_conn = 1;
697  if (conn->linked_conn &&
700  } else {
701  if (event_add(conn->write_event, NULL))
702  log_warn(LD_NET, "Error from libevent setting write event state for %d "
703  "to watched: %s",
704  (int)conn->s,
705  tor_socket_strerror(tor_socket_errno(conn->s)));
706  }
707 }
708 
709 /** Return true iff <b>conn</b> is linked conn, and reading from the conn
710  * linked to it would be good and feasible. (Reading is "feasible" if the
711  * other conn exists and has data in its outbuf, and is "good" if we have our
712  * reading_from_linked_conn flag set and the other conn has its
713  * writing_to_linked_conn flag set.)*/
714 static int
716 {
717  if (conn->linked && conn->reading_from_linked_conn) {
718  if (! conn->linked_conn ||
720  buf_datalen(conn->linked_conn->outbuf)))
721  return 1;
722  }
723  return 0;
724 }
725 
726 /** Event to run 'shutdown did not work callback'. */
727 static struct event *shutdown_did_not_work_event = NULL;
728 
729 /** Failsafe measure that should never actually be necessary: If
730  * tor_shutdown_event_loop_and_exit() somehow doesn't successfully exit the
731  * event loop, then this callback will kill Tor with an assertion failure
732  * seconds later
733  */
734 static void
735 shutdown_did_not_work_callback(evutil_socket_t fd, short event, void *arg)
736 {
737  // LCOV_EXCL_START
738  (void) fd;
739  (void) event;
740  (void) arg;
741  tor_assert_unreached();
742  // LCOV_EXCL_STOP
743 }
744 
745 #ifdef ENABLE_RESTART_DEBUGGING
746 static struct event *tor_shutdown_event_loop_for_restart_event = NULL;
747 static void
748 tor_shutdown_event_loop_for_restart_cb(
749  evutil_socket_t fd, short event, void *arg)
750 {
751  (void)fd;
752  (void)event;
753  (void)arg;
754  tor_event_free(tor_shutdown_event_loop_for_restart_event);
756 }
757 #endif /* defined(ENABLE_RESTART_DEBUGGING) */
758 
759 /**
760  * After finishing the current callback (if any), shut down the main loop,
761  * clean up the process, and exit with <b>exitcode</b>.
762  */
763 void
765 {
767  return; /* Ignore multiple calls to this function. */
768 
770  main_loop_exit_value = exitcode;
771 
772  if (! tor_libevent_is_initialized()) {
773  return; /* No event loop to shut down. */
774  }
775 
776  /* Die with an assertion failure in ten seconds, if for some reason we don't
777  * exit normally. */
778  /* XXXX We should consider this code if it's never used. */
779  struct timeval ten_seconds = { 10, 0 };
780  shutdown_did_not_work_event = tor_evtimer_new(
783  event_add(shutdown_did_not_work_event, &ten_seconds);
784 
785  /* Unlike exit_loop_after_delay(), exit_loop_after_callback
786  * prevents other callbacks from running. */
788 }
789 
790 /** Return true iff tor_shutdown_event_loop_and_exit() has been called. */
791 int
793 {
794  return main_loop_should_exit;
795 }
796 
797 /** Helper: Tell the main loop to begin reading bytes into <b>conn</b> from
798  * its linked connection, if it is not doing so already. Called by
799  * connection_start_reading and connection_start_writing as appropriate. */
800 static void
802 {
803  tor_assert(conn);
804  tor_assert(conn->linked == 1);
805 
806  if (!conn->active_on_link) {
807  conn->active_on_link = 1;
810  } else {
812  }
813 }
814 
815 /** Tell the main loop to stop reading bytes into <b>conn</b> from its linked
816  * connection, if is currently doing so. Called by connection_stop_reading,
817  * connection_stop_writing, and connection_read. */
818 void
820 {
821  tor_assert(conn);
822  tor_assert(conn->linked == 1);
823 
824  if (conn->active_on_link) {
825  conn->active_on_link = 0;
826  /* FFFF We could keep an index here so we can smartlist_del
827  * cleanly. On the other hand, this doesn't show up on profiles,
828  * so let's leave it alone for now. */
830  } else {
832  }
833 }
834 
835 /** Close all connections that have been scheduled to get closed. */
836 STATIC void
838 {
839  int i;
840  for (i = 0; i < smartlist_len(closeable_connection_lst); ) {
841  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 {
846  ++i;
847  }
848  }
849 }
850 
851 /** Count moribund connections for the OOS handler */
852 MOCK_IMPL(int,
854 {
855  int moribund = 0;
856 
857  /*
858  * Count things we'll try to kill when close_closeable_connections()
859  * runs next.
860  */
862  if (SOCKET_OK(conn->s) && connection_is_moribund(conn)) ++moribund;
863  } SMARTLIST_FOREACH_END(conn);
864 
865  return moribund;
866 }
867 
868 /** Libevent callback: this gets invoked when (connection_t*)<b>conn</b> has
869  * 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  (void)fd;
875  (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  /* Handle marked for close connections early */
882  if (conn->marked_for_close && connection_is_reading(conn)) {
883  /* Libevent says we can read, but we are marked for close so we will never
884  * try to read again. We will try to close the connection below inside of
885  * close_closeable_connections(), but let's make sure not to cause Libevent
886  * to spin on conn_read_callback() while we wait for the socket to let us
887  * flush to it.*/
889  }
890 
891  if (connection_handle_read(conn) < 0) {
892  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);
898 #endif /* !defined(_WIN32) */
899  if (CONN_IS_EDGE(conn))
901  connection_mark_for_close(conn);
902  }
903  }
904  assert_connection_ok(conn, time(NULL));
905 
906  if (smartlist_len(closeable_connection_lst))
908 }
909 
910 /** Libevent callback: this gets invoked when (connection_t*)<b>conn</b> has
911  * 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  (void)fd;
917  (void)events;
918 
919  LOG_FN_CONN(conn, (LOG_DEBUG, LD_NET, "socket %d wants to write.",
920  (int)conn->s));
921 
922  /* assert_connection_ok(conn, time(NULL)); */
923 
924  if (connection_handle_write(conn, 0) < 0) {
925  if (!conn->marked_for_close) {
926  /* this connection is broken. remove it. */
928  "unhandled error on write for %s connection (fd %d); removing",
929  conn_type_to_string(conn->type), (int)conn->s);
931  if (CONN_IS_EDGE(conn)) {
932  /* otherwise we cry wolf about duplicate close */
933  edge_connection_t *edge_conn = TO_EDGE_CONN(conn);
934  if (!edge_conn->end_reason)
935  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  connection_mark_for_close(conn);
940  }
941  }
942  assert_connection_ok(conn, time(NULL));
943 
944  if (smartlist_len(closeable_connection_lst))
946 }
947 
948 /** If the connection at connection_array[i] is marked for close, then:
949  * - If it has data that it wants to flush, try to flush it.
950  * - If it _still_ has data to flush, and conn->hold_open_until_flushed is
951  * true, then leave the connection open and return.
952  * - Otherwise, remove the connection from connection_array and from
953  * all other lists, close it, and free it.
954  * Returns 1 if the connection was closed, 0 otherwise.
955  */
956 static int
958 {
959  connection_t *conn;
960  int retval;
961  time_t now;
962 
963  conn = smartlist_get(connection_array, i);
964  if (!conn->marked_for_close)
965  return 0; /* nothing to see here, move along */
966  now = time(NULL);
967  assert_connection_ok(conn, now);
968 
969  log_debug(LD_NET,"Cleaning up connection (fd "TOR_SOCKET_T_FORMAT").",
970  conn->s);
971 
972  /* If the connection we are about to close was trying to connect to
973  a proxy server and failed, the client won't be able to use that
974  proxy. We should warn the user about this. */
975  if (conn->proxy_state == PROXY_INFANT)
977 
978  if ((SOCKET_OK(conn->s) || conn->linked_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  log_info(LD_NET,
985  "Conn (addr %s, fd %d, type %s, state %d) marked, but wants "
986  "to flush %"TOR_PRIuSZ" bytes. (Marked at %s:%d)",
988  (int)conn->s, conn_type_to_string(conn->type), conn->state,
989  connection_get_outbuf_len(conn),
991  if (conn->linked_conn) {
992  retval = (int) buf_move_all(conn->linked_conn->inbuf, conn->outbuf);
993  if (retval >= 0) {
994  /* The linked conn will notice that it has data when it notices that
995  * we're gone. */
997  }
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),
1002  } else if (connection_speaks_cells(conn)) {
1003  if (conn->state == OR_CONN_STATE_OPEN) {
1004  retval = buf_flush_to_tls(conn->outbuf, TO_OR_CONN(conn)->tls, sz);
1005  } else
1006  retval = -1; /* never flush non-open broken tls connections */
1007  } else {
1008  retval = buf_flush_to_socket(conn->outbuf, conn->s, sz);
1009  }
1010  if (retval >= 0 && /* Technically, we could survive things like
1011  TLS_WANT_WRITE here. But don't bother for now. */
1013  if (retval > 0) {
1014  LOG_FN_CONN(conn, (LOG_INFO,LD_NET,
1015  "Holding conn (fd %d) open for more flushing.",
1016  (int)conn->s));
1017  conn->timestamp_last_write_allowed = now; /* reset so we can flush
1018  * more */
1019  } else if (sz == 0) {
1020  /* Also, retval==0. If we get here, we didn't want to write anything
1021  * (because of rate-limiting) and we didn't. */
1022 
1023  /* Connection must flush before closing, but it's being rate-limited.
1024  * Let's remove from Libevent, and mark it as blocked on bandwidth
1025  * so it will be re-added on next token bucket refill. Prevents
1026  * busy Libevent loops where we keep ending up here and returning
1027  * 0 until we are no longer blocked on bandwidth.
1028  */
1030  /* Make sure that consider_empty_buckets really disabled the
1031  * connection: */
1032  if (BUG(connection_is_writing(conn))) {
1033  connection_write_bw_exhausted(conn, true);
1034  }
1035 
1036  /* The connection is being held due to write rate limit and thus will
1037  * flush its data later. We need to stop reading because this
1038  * connection is about to be closed once flushed. It should not
1039  * process anything more coming in at this stage. */
1041  }
1042  return 0;
1043  }
1044  if (connection_wants_to_flush(conn)) {
1045  log_fn(LOG_INFO, LD_NET, "We stalled too much while trying to write %d "
1046  "bytes to address %s. If this happens a lot, either "
1047  "something is wrong with your network connection, or "
1048  "something is wrong with theirs. "
1049  "(fd %d, type %s, state %d, marked at %s:%d).",
1050  (int)connection_get_outbuf_len(conn),
1052  (int)conn->s, conn_type_to_string(conn->type), conn->state,
1053  conn->marked_for_close_file,
1054  conn->marked_for_close);
1055  }
1056  }
1057 
1058  connection_unlink(conn); /* unlink, remove, free */
1059  return 1;
1060 }
1061 
1062 /** Implementation for directory_all_unreachable. This is done in a callback,
1063  * since otherwise it would complicate Tor's control-flow graph beyond all
1064  * reason.
1065  */
1066 static void
1068 {
1069  (void)event;
1070  (void)arg;
1071 
1072  connection_t *conn;
1073 
1076  entry_connection_t *entry_conn = TO_ENTRY_CONN(conn);
1077  log_notice(LD_NET,
1078  "Is your network connection down? "
1079  "Failing connection to '%s:%d'.",
1080  safe_str_client(entry_conn->socks_request->address),
1081  entry_conn->socks_request->port);
1082  connection_mark_unattached_ap(entry_conn,
1084  }
1085  control_event_general_error("DIR_ALL_UNREACHABLE");
1086 }
1087 
1088 static mainloop_event_t *directory_all_unreachable_cb_event = NULL;
1089 
1090 /** We've just tried every dirserver we know about, and none of
1091  * them were reachable. Assume the network is down. Change state
1092  * so next time an application connection arrives we'll delay it
1093  * and try another directory fetch. Kill off all the circuit_wait
1094  * streams that are waiting now, since they will all timeout anyway.
1095  */
1096 void
1098 {
1099  (void)now;
1100 
1101  reset_uptime(); /* reset it */
1102 
1103  if (!directory_all_unreachable_cb_event) {
1104  directory_all_unreachable_cb_event =
1106  tor_assert(directory_all_unreachable_cb_event);
1107  }
1108 
1109  mainloop_event_activate(directory_all_unreachable_cb_event);
1110 }
1111 
1112 /** This function is called whenever we successfully pull down some new
1113  * network statuses or server descriptors. */
1114 void
1115 directory_info_has_arrived(time_t now, int from_cache, int suppress_logs)
1116 {
1117  const or_options_t *options = get_options();
1118 
1119  /* if we have enough dir info, then update our guard status with
1120  * whatever we just learned. */
1121  int invalidate_circs = guards_update_all();
1122 
1123  if (invalidate_circs) {
1126  }
1127 
1129  int quiet = suppress_logs || from_cache ||
1132  "I learned some more directory information, but not enough to "
1133  "build a circuit: %s", get_dir_info_status_string());
1135  return;
1136  } else {
1137  if (dirclient_fetches_from_authorities(options)) {
1139  }
1140 
1141  /* Don't even bother trying to get extrainfo until the rest of our
1142  * directory info is up-to-date */
1143  if (options->DownloadExtraInfo)
1145  }
1146 
1147  if (server_mode(options) && !net_is_disabled() && !from_cache &&
1150 }
1151 
1152 /** Perform regular maintenance tasks for a single connection. This
1153  * function gets run once per second per connection by run_scheduled_events.
1154  */
1155 static void
1157 {
1158  cell_t cell;
1159  connection_t *conn = smartlist_get(connection_array, i);
1160  const or_options_t *options = get_options();
1161  or_connection_t *or_conn;
1162  channel_t *chan = NULL;
1163  int have_any_circuits;
1164  int past_keepalive =
1165  now >= conn->timestamp_last_write_allowed + options->KeepalivePeriod;
1166 
1167  if (conn->outbuf && !connection_get_outbuf_len(conn) &&
1168  conn->type == CONN_TYPE_OR)
1169  TO_OR_CONN(conn)->timestamp_lastempty = now;
1170 
1171  if (conn->marked_for_close) {
1172  /* nothing to do here */
1173  return;
1174  }
1175 
1176  /* Expire any directory connections that haven't been active (sent
1177  * if a server or received if a client) for 5 min */
1178  if (conn->type == CONN_TYPE_DIR &&
1179  ((DIR_CONN_IS_SERVER(conn) &&
1181  + options->TestingDirConnectionMaxStall < now) ||
1182  (!DIR_CONN_IS_SERVER(conn) &&
1184  + options->TestingDirConnectionMaxStall < now))) {
1185  log_info(LD_DIR,"Expiring wedged directory conn (fd %d, purpose %d)",
1186  (int)conn->s, conn->purpose);
1187  /* This check is temporary; it's to let us know whether we should consider
1188  * parsing partial serverdesc responses. */
1189  if (conn->purpose == DIR_PURPOSE_FETCH_SERVERDESC &&
1190  connection_get_inbuf_len(conn) >= 1024) {
1191  log_info(LD_DIR,"Trying to extract information from wedged server desc "
1192  "download.");
1194  } else {
1195  connection_mark_for_close(conn);
1196  }
1197  return;
1198  }
1199 
1200  if (!connection_speaks_cells(conn))
1201  return; /* we're all done here, the rest is just for OR conns */
1202 
1203  /* If we haven't flushed to an OR connection for a while, then either nuke
1204  the connection or send a keepalive, depending. */
1205 
1206  or_conn = TO_OR_CONN(conn);
1207  tor_assert(conn->outbuf);
1208 
1209  chan = TLS_CHAN_TO_BASE(or_conn->chan);
1210  tor_assert(chan);
1211 
1212  if (channel_num_circuits(chan) != 0) {
1213  have_any_circuits = 1;
1214  chan->timestamp_last_had_circuits = now;
1215  } else {
1216  have_any_circuits = 0;
1217  }
1218 
1219  if (channel_is_bad_for_new_circs(TLS_CHAN_TO_BASE(or_conn->chan)) &&
1220  ! have_any_circuits) {
1221  /* It's bad for new circuits, and has no unmarked circuits on it:
1222  * mark it now. */
1223  log_info(LD_OR,
1224  "Expiring non-used OR connection to fd %d (%s:%d) [Too old].",
1225  (int)conn->s, fmt_and_decorate_addr(&conn->addr), conn->port);
1226  if (conn->state == OR_CONN_STATE_CONNECTING)
1228  END_OR_CONN_REASON_TIMEOUT,
1229  "Tor gave up on the connection");
1231  } else if (!connection_state_is_open(conn)) {
1232  if (past_keepalive) {
1233  /* We never managed to actually get this connection open and happy. */
1234  log_info(LD_OR,"Expiring non-open OR connection to fd %d (%s:%d).",
1235  (int)conn->s, fmt_and_decorate_addr(&conn->addr), conn->port);
1237  }
1238  } else if (we_are_hibernating() &&
1239  ! have_any_circuits &&
1240  !connection_get_outbuf_len(conn)) {
1241  /* We're hibernating or shutting down, there's no circuits, and nothing to
1242  * flush.*/
1243  log_info(LD_OR,"Expiring non-used OR connection to fd %d (%s:%d) "
1244  "[Hibernating or exiting].",
1245  (int)conn->s, fmt_and_decorate_addr(&conn->addr), conn->port);
1247  } else if (!have_any_circuits &&
1248  now - or_conn->idle_timeout >=
1250  log_info(LD_OR,"Expiring non-used OR connection %"PRIu64" to fd %d "
1251  "(%s:%d) [no circuits for %d; timeout %d; %scanonical].",
1252  (chan->global_identifier),
1253  (int)conn->s, fmt_and_decorate_addr(&conn->addr), conn->port,
1254  (int)(now - chan->timestamp_last_had_circuits),
1255  or_conn->idle_timeout,
1256  or_conn->is_canonical ? "" : "non");
1258  } else if (
1259  now >= or_conn->timestamp_lastempty + options->KeepalivePeriod*10 &&
1260  now >=
1261  conn->timestamp_last_write_allowed + options->KeepalivePeriod*10) {
1262  log_fn(LOG_PROTOCOL_WARN,LD_PROTOCOL,
1263  "Expiring stuck OR connection to fd %d (%s:%d). (%d bytes to "
1264  "flush; %d seconds since last write)",
1265  (int)conn->s, fmt_and_decorate_addr(&conn->addr), conn->port,
1266  (int)connection_get_outbuf_len(conn),
1267  (int)(now-conn->timestamp_last_write_allowed));
1269  } else if (past_keepalive && !connection_get_outbuf_len(conn)) {
1270  /* send a padding cell */
1271  log_fn(LOG_DEBUG,LD_OR,"Sending keepalive to (%s:%d)",
1272  fmt_and_decorate_addr(&conn->addr), conn->port);
1273  memset(&cell,0,sizeof(cell_t));
1274  cell.command = CELL_PADDING;
1275  connection_or_write_cell_to_buf(&cell, or_conn);
1276  } else {
1278  }
1279 }
1280 
1281 /** Honor a NEWNYM request: make future requests unlinkable to past
1282  * requests. */
1283 static void
1284 signewnym_impl(time_t now)
1285 {
1286  const or_options_t *options = get_options();
1287  if (!proxy_mode(options)) {
1288  log_info(LD_CONTROL, "Ignoring SIGNAL NEWNYM because client functionality "
1289  "is disabled.");
1290  return;
1291  }
1292 
1296  time_of_last_signewnym = now;
1298 
1299  ++newnym_epoch;
1300 
1301  control_event_signal(SIGNEWNYM);
1302 }
1303 
1304 /** Callback: run a deferred signewnym. */
1305 static void
1307 {
1308  (void)event;
1309  (void)arg;
1310  log_info(LD_CONTROL, "Honoring delayed NEWNYM request");
1311  do_signewnym(time(NULL));
1312 }
1313 
1314 /** Either perform a signewnym or schedule one, depending on rate limiting. */
1315 void
1316 do_signewnym(time_t now)
1317 {
1319  const time_t delay_sec =
1321  if (! signewnym_is_pending) {
1326  }
1327  const struct timeval delay_tv = { delay_sec, 0 };
1329  }
1330  log_notice(LD_CONTROL,
1331  "Rate limiting NEWNYM request: delaying by %d second(s)",
1332  (int)(delay_sec));
1333  } else {
1334  signewnym_impl(now);
1335  }
1336 }
1337 
1338 /** Return the number of times that signewnym has been called. */
1339 unsigned
1341 {
1342  return newnym_epoch;
1343 }
1344 
1345 /** True iff we have initialized all the members of <b>periodic_events</b>.
1346  * Used to prevent double-initialization. */
1348 
1349 /* Declare all the timer callback functions... */
1350 #ifndef COCCI
1351 #undef CALLBACK
1352 #define CALLBACK(name) \
1353  static int name ## _callback(time_t, const or_options_t *)
1354 
1355 CALLBACK(add_entropy);
1356 CALLBACK(check_expired_networkstatus);
1357 CALLBACK(clean_caches);
1358 CALLBACK(clean_consdiffmgr);
1359 CALLBACK(fetch_networkstatus);
1360 CALLBACK(heartbeat);
1361 CALLBACK(hs_service);
1362 CALLBACK(launch_descriptor_fetches);
1363 CALLBACK(prune_old_routers);
1364 CALLBACK(record_bridge_stats);
1365 CALLBACK(rend_cache_failure_clean);
1366 CALLBACK(reset_padding_counts);
1367 CALLBACK(retry_listeners);
1368 CALLBACK(rotate_x509_certificate);
1369 CALLBACK(save_state);
1370 CALLBACK(write_stats_file);
1371 CALLBACK(control_per_second_events);
1372 CALLBACK(second_elapsed);
1373 
1374 #undef CALLBACK
1375 
1376 /* Now we declare an array of periodic_event_item_t for each periodic event */
1377 #define CALLBACK(name, r, f) \
1378  PERIODIC_EVENT(name, PERIODIC_EVENT_ROLE_ ## r, f)
1379 #define FL(name) (PERIODIC_EVENT_FLAG_ ## name)
1380 #endif /* !defined(COCCI) */
1381 
1382 STATIC periodic_event_item_t mainloop_periodic_events[] = {
1383 
1384  /* Everyone needs to run these. They need to have very long timeouts for
1385  * that to be safe. */
1386  CALLBACK(add_entropy, ALL, 0),
1387  CALLBACK(heartbeat, ALL, 0),
1388  CALLBACK(reset_padding_counts, ALL, 0),
1389 
1390  /* This is a legacy catch-all callback that runs once per second if
1391  * we are online and active. */
1392  CALLBACK(second_elapsed, NET_PARTICIPANT,
1393  FL(RUN_ON_DISABLE)),
1394 
1395  /* XXXX Do we have a reason to do this on a callback? Does it do any good at
1396  * all? For now, if we're dormant, we can let our listeners decay. */
1397  CALLBACK(retry_listeners, NET_PARTICIPANT, FL(NEED_NET)),
1398 
1399  /* We need to do these if we're participating in the Tor network. */
1400  CALLBACK(check_expired_networkstatus, NET_PARTICIPANT, 0),
1401  CALLBACK(fetch_networkstatus, NET_PARTICIPANT, 0),
1402  CALLBACK(launch_descriptor_fetches, NET_PARTICIPANT, FL(NEED_NET)),
1403  CALLBACK(rotate_x509_certificate, NET_PARTICIPANT, 0),
1404  CALLBACK(check_network_participation, NET_PARTICIPANT, 0),
1405 
1406  /* We need to do these if we're participating in the Tor network, and
1407  * immediately before we stop. */
1408  CALLBACK(clean_caches, NET_PARTICIPANT, FL(RUN_ON_DISABLE)),
1409  CALLBACK(save_state, NET_PARTICIPANT, FL(RUN_ON_DISABLE)),
1410  CALLBACK(write_stats_file, NET_PARTICIPANT, FL(RUN_ON_DISABLE)),
1411  CALLBACK(prune_old_routers, NET_PARTICIPANT, FL(RUN_ON_DISABLE)),
1412 
1413  /* Hidden Service service only. */
1414  CALLBACK(hs_service, HS_SERVICE, FL(NEED_NET)), // XXXX break this down more
1415 
1416  /* Bridge only. */
1417  CALLBACK(record_bridge_stats, BRIDGE, 0),
1418 
1419  /* Client only. */
1420  /* XXXX this could be restricted to CLIENT+NET_PARTICIPANT */
1421  CALLBACK(rend_cache_failure_clean, NET_PARTICIPANT, FL(RUN_ON_DISABLE)),
1422 
1423  /* Directory server only. */
1424  CALLBACK(clean_consdiffmgr, DIRSERVER, 0),
1425 
1426  /* Controller with per-second events only. */
1427  CALLBACK(control_per_second_events, CONTROLEV, 0),
1428 
1429  END_OF_PERIODIC_EVENTS
1430 };
1431 #ifndef COCCI
1432 #undef CALLBACK
1433 #undef FL
1434 #endif
1435 
1436 /* These are pointers to members of periodic_events[] that are used to
1437  * implement particular callbacks. We keep them separate here so that we
1438  * can access them by name. We also keep them inside periodic_events[]
1439  * so that we can implement "reset all timers" in a reasonable way. */
1440 static periodic_event_item_t *fetch_networkstatus_event=NULL;
1441 static periodic_event_item_t *launch_descriptor_fetches_event=NULL;
1442 static periodic_event_item_t *check_dns_honesty_event=NULL;
1443 static periodic_event_item_t *save_state_event=NULL;
1444 static periodic_event_item_t *prune_old_routers_event=NULL;
1445 
1446 /** Reset all the periodic events so we'll do all our actions again as if we
1447  * just started up.
1448  * Useful if our clock just moved back a long time from the future,
1449  * so we don't wait until that future arrives again before acting.
1450  */
1451 void
1453 {
1455 }
1456 
1457 /** Return a bitmask of the roles this tor instance is configured for using
1458  * the given options. */
1459 STATIC int
1461 {
1462  tor_assert(options);
1463 
1464  int roles = PERIODIC_EVENT_ROLE_ALL;
1465  int is_bridge = options->BridgeRelay;
1466  int is_relay = server_mode(options);
1467  int is_dirauth = authdir_mode_v3(options);
1468  int is_bridgeauth = authdir_mode_bridge(options);
1469  int is_hidden_service = !!hs_service_get_num_services();
1470  int is_dirserver = dir_server_mode(options);
1471  int sending_control_events = control_any_per_second_event_enabled();
1472 
1473  /* We also consider tor to have the role of a client if the ControlPort is
1474  * set because a lot of things can be done over the control port which
1475  * requires tor to have basic functionalities. */
1476  int is_client = options_any_client_port_set(options) ||
1477  options->ControlPort_set ||
1478  options->OwningControllerFD != UINT64_MAX;
1479 
1480  int is_net_participant = is_participating_on_network() ||
1481  is_relay || is_hidden_service;
1482 
1483  if (is_bridge) roles |= PERIODIC_EVENT_ROLE_BRIDGE;
1484  if (is_client) roles |= PERIODIC_EVENT_ROLE_CLIENT;
1485  if (is_relay) roles |= PERIODIC_EVENT_ROLE_RELAY;
1486  if (is_dirauth) roles |= PERIODIC_EVENT_ROLE_DIRAUTH;
1487  if (is_bridgeauth) roles |= PERIODIC_EVENT_ROLE_BRIDGEAUTH;
1488  if (is_hidden_service) roles |= PERIODIC_EVENT_ROLE_HS_SERVICE;
1489  if (is_dirserver) roles |= PERIODIC_EVENT_ROLE_DIRSERVER;
1490  if (is_net_participant) roles |= PERIODIC_EVENT_ROLE_NET_PARTICIPANT;
1491  if (sending_control_events) roles |= PERIODIC_EVENT_ROLE_CONTROLEV;
1492 
1493  return roles;
1494 }
1495 
1496 /** Event to run initialize_periodic_events_cb */
1497 static struct event *initialize_periodic_events_event = NULL;
1498 
1499 /** Helper, run one second after setup:
1500  * Initializes all members of periodic_events and starts them running.
1501  *
1502  * (We do this one second after setup for backward-compatibility reasons;
1503  * it might not actually be necessary.) */
1504 static void
1505 initialize_periodic_events_cb(evutil_socket_t fd, short events, void *data)
1506 {
1507  (void) fd;
1508  (void) events;
1509  (void) data;
1510 
1511  tor_event_free(initialize_periodic_events_event);
1512 
1514 }
1515 
1516 /** Set up all the members of mainloop_periodic_events[], and configure them
1517  * all to be launched from a callback. */
1518 void
1520 {
1522  return;
1523 
1525 
1526  for (int i = 0; mainloop_periodic_events[i].name; ++i) {
1527  periodic_events_register(&mainloop_periodic_events[i]);
1528  }
1529 
1530  /* Set up all periodic events. We'll launch them by roles. */
1531 
1532 #ifndef COCCI
1533 #define NAMED_CALLBACK(name) \
1534  STMT_BEGIN name ## _event = periodic_events_find( #name ); STMT_END
1535 #endif
1536 
1537  NAMED_CALLBACK(prune_old_routers);
1538  NAMED_CALLBACK(fetch_networkstatus);
1539  NAMED_CALLBACK(launch_descriptor_fetches);
1540  NAMED_CALLBACK(check_dns_honesty);
1541  NAMED_CALLBACK(save_state);
1542 }
1543 
1544 STATIC void
1545 teardown_periodic_events(void)
1546 {
1548  fetch_networkstatus_event = NULL;
1549  launch_descriptor_fetches_event = NULL;
1550  check_dns_honesty_event = NULL;
1551  save_state_event = NULL;
1552  prune_old_routers_event = NULL;
1554 }
1555 
1556 static mainloop_event_t *rescan_periodic_events_ev = NULL;
1557 
1558 /** Callback: rescan the periodic event list. */
1559 static void
1561 {
1562  (void)event;
1563  (void)arg;
1565 }
1566 
1567 /**
1568  * Schedule an event that will rescan which periodic events should run.
1569  **/
1570 MOCK_IMPL(void,
1572 {
1573  if (!rescan_periodic_events_ev) {
1574  rescan_periodic_events_ev =
1576  }
1577  mainloop_event_activate(rescan_periodic_events_ev);
1578 }
1579 
1580 /** Do a pass at all our periodic events, disable those we don't need anymore
1581  * and enable those we need now using the given options. */
1582 void
1584 {
1585  tor_assert(options);
1586 
1588 }
1589 
1590 /* We just got new options globally set, see if we need to enabled or disable
1591  * periodic events. */
1592 void
1593 periodic_events_on_new_options(const or_options_t *options)
1594 {
1595  rescan_periodic_events(options);
1596 }
1597 
1598 /**
1599  * Update our schedule so that we'll check whether we need to fetch directory
1600  * info immediately.
1601  */
1602 void
1604 {
1605  tor_assert(fetch_networkstatus_event);
1606  tor_assert(launch_descriptor_fetches_event);
1607 
1608  periodic_event_reschedule(fetch_networkstatus_event);
1609  periodic_event_reschedule(launch_descriptor_fetches_event);
1610 }
1611 
1612 /** Mainloop callback: clean up circuits, channels, and connections
1613  * that are pending close. */
1614 static void
1616 {
1617  (void)ev;
1618  (void)arg;
1623 }
1624 
1625 /** Event to run postloop_cleanup_cb */
1627 
1628 /** Schedule a post-loop event to clean up marked channels, connections, and
1629  * circuits. */
1630 void
1632 {
1633  if (PREDICT_UNLIKELY(postloop_cleanup_ev == NULL)) {
1634  // (It's possible that we can get here if we decide to close a connection
1635  // in the earliest stages of our configuration, before we create events.)
1636  return;
1637  }
1639 }
1640 
1641 /** Event to run 'scheduled_shutdown_cb' */
1643 
1644 /** Callback: run a scheduled shutdown */
1645 static void
1647 {
1648  (void)ev;
1649  (void)arg;
1650  log_notice(LD_GENERAL, "Clean shutdown finished. Exiting.");
1652 }
1653 
1654 /** Schedule the mainloop to exit after <b>delay_sec</b> seconds. */
1655 void
1657 {
1658  const struct timeval delay_tv = { delay_sec, 0 };
1659  if (! scheduled_shutdown_ev) {
1661  }
1663 }
1664 
1665 /** Perform regular maintenance tasks. This function gets run once per
1666  * second.
1667  */
1668 static int
1669 second_elapsed_callback(time_t now, const or_options_t *options)
1670 {
1671  /* 0. See if our bandwidth limits are exhausted and we should hibernate
1672  *
1673  * Note: we have redundant mechanisms to handle the case where it's
1674  * time to wake up from hibernation; or where we have a scheduled
1675  * shutdown and it's time to run it, but this will also handle those.
1676  */
1677  consider_hibernation(now);
1678 
1679  /* Maybe enough time elapsed for us to reconsider a circuit. */
1681 
1682  if (options->UseBridges && !net_is_disabled()) {
1683  /* Note: this check uses net_is_disabled(), not should_delay_dir_fetches()
1684  * -- the latter is only for fetching consensus-derived directory info. */
1685  // TODO: client
1686  // Also, schedule this rather than probing 1x / sec
1687  fetch_bridge_descriptors(options, now);
1688  }
1689 
1690  if (accounting_is_enabled(options)) {
1691  // TODO: refactor or rewrite?
1693  }
1694 
1695  /* 3a. Every second, we examine pending circuits and prune the
1696  * ones which have been pending for more than a few seconds.
1697  * We do this before step 4, so it can try building more if
1698  * it's not comfortable with the number of available circuits.
1699  */
1700  /* (If our circuit build timeout can ever become lower than a second (which
1701  * it can't, currently), we should do this more often.) */
1702  // TODO: All expire stuff can become NET_PARTICIPANT, RUN_ON_DISABLE
1705 
1706  /* 3b. Also look at pending streams and prune the ones that 'began'
1707  * a long time ago but haven't gotten a 'connected' yet.
1708  * Do this before step 4, so we can put them back into pending
1709  * state to be picked up by the new circuit.
1710  */
1712 
1713  /* 3c. And expire connections that we've held open for too long.
1714  */
1716 
1717  /* 4. Every second, we try a new circuit if there are no valid
1718  * circuits. Every NewCircuitPeriod seconds, we expire circuits
1719  * that became dirty more than MaxCircuitDirtiness seconds ago,
1720  * and we make a new circ if there are no clean circuits.
1721  */
1722  const int have_dir_info = router_have_minimum_dir_info();
1723  if (have_dir_info && !net_is_disabled()) {
1725  } else {
1727  }
1728 
1729  /* 5. We do housekeeping for each connection... */
1731  int i;
1732  for (i=0;i<smartlist_len(connection_array);i++) {
1734  }
1735 
1736  /* Run again in a second. */
1737  return 1;
1738 }
1739 
1740 /**
1741  * Periodic callback: Every {LAZY,GREEDY}_DESCRIPTOR_RETRY_INTERVAL,
1742  * see about fetching descriptors, microdescriptors, and extrainfo
1743  * documents.
1744  */
1745 static int
1747 {
1748  if (should_delay_dir_fetches(options, NULL))
1749  return PERIODIC_EVENT_NO_UPDATE;
1750 
1755  else
1757 }
1758 
1759 /**
1760  * Periodic event: Rotate our X.509 certificates and TLS keys once every
1761  * MAX_SSL_KEY_LIFETIME_INTERNAL.
1762  */
1763 static int
1765 {
1766  static int first = 1;
1767  (void)now;
1768  (void)options;
1769  if (first) {
1770  first = 0;
1772  }
1773 
1774  /* 1b. Every MAX_SSL_KEY_LIFETIME_INTERNAL seconds, we change our
1775  * TLS context. */
1776  log_info(LD_GENERAL,"Rotating tls context.");
1777  if (router_initialize_tls_context() < 0) {
1778  log_err(LD_BUG, "Error reinitializing TLS context");
1779  tor_assert_unreached();
1780  }
1781  if (generate_ed_link_cert(options, now, 1)) {
1782  log_err(LD_OR, "Unable to update Ed25519->TLS link certificate for "
1783  "new TLS context.");
1784  tor_assert_unreached();
1785  }
1786 
1787  /* We also make sure to rotate the TLS connections themselves if they've
1788  * been up for too long -- but that's done via is_bad_for_new_circs in
1789  * run_connection_housekeeping() above. */
1791 }
1792 
1793 /**
1794  * Periodic callback: once an hour, grab some more entropy from the
1795  * kernel and feed it to our CSPRNG.
1796  **/
1797 static int
1798 add_entropy_callback(time_t now, const or_options_t *options)
1799 {
1800  (void)now;
1801  (void)options;
1802  /* We already seeded once, so don't die on failure. */
1803  if (crypto_seed_rng() < 0) {
1804  log_warn(LD_GENERAL, "Tried to re-seed RNG, but failed. We already "
1805  "seeded once, though, so we won't exit here.");
1806  }
1807 
1808  /** How often do we add more entropy to OpenSSL's RNG pool? */
1809 #define ENTROPY_INTERVAL (60*60)
1810  return ENTROPY_INTERVAL;
1811 }
1812 
1813 /** Periodic callback: if there has been no network usage in a while,
1814  * enter a dormant state. */
1815 STATIC int
1817 {
1818  /* If we're a server, we can't become dormant. */
1819  if (server_mode(options)) {
1820  goto found_activity;
1821  }
1822 
1823  /* If we aren't allowed to become dormant, then participation doesn't
1824  matter */
1825  if (! options->DormantTimeoutEnabled) {
1826  goto found_activity;
1827  }
1828 
1829  /* If we're running an onion service, we can't become dormant. */
1830  /* XXXX this would be nice to change, so that we can be dormant with a
1831  * service. */
1833  goto found_activity;
1834  }
1835 
1836  /* If we have any currently open entry streams other than "linked"
1837  * connections used for directory requests, those count as user activity.
1838  */
1839  if (options->DormantTimeoutDisabledByIdleStreams) {
1841  goto found_activity;
1842  }
1843  }
1844 
1845  /* XXXX Make this configurable? */
1846 /** How often do we check whether we have had network activity? */
1847 #define CHECK_PARTICIPATION_INTERVAL (5*60)
1848 
1849  /* Become dormant if there has been no user activity in a long time.
1850  * (The funny checks below are in order to prevent overflow.) */
1851  time_t time_since_last_activity = 0;
1852  if (get_last_user_activity_time() < now)
1853  time_since_last_activity = now - get_last_user_activity_time();
1854  if (time_since_last_activity >= options->DormantClientTimeout) {
1855  log_notice(LD_GENERAL, "No user activity in a long time: becoming"
1856  " dormant.");
1858  rescan_periodic_events(options);
1859  }
1860 
1861  return CHECK_PARTICIPATION_INTERVAL;
1862 
1863  found_activity:
1864  note_user_activity(now);
1865  return CHECK_PARTICIPATION_INTERVAL;
1866 }
1867 
1868 /**
1869  * Periodic callback: If our consensus is too old, recalculate whether
1870  * we can actually use it.
1871  */
1872 static int
1874 {
1875  (void)options;
1876  /* Check whether our networkstatus has expired. */
1878  /* Use reasonably live consensuses until they are no longer reasonably live.
1879  */
1880  if (ns && !networkstatus_consensus_reasonably_live(ns, now) &&
1883  }
1884 #define CHECK_EXPIRED_NS_INTERVAL (2*60)
1885  return CHECK_EXPIRED_NS_INTERVAL;
1886 }
1887 
1888 /**
1889  * Scheduled callback: Save the state file to disk if appropriate.
1890  */
1891 static int
1892 save_state_callback(time_t now, const or_options_t *options)
1893 {
1894  (void) options;
1895  (void) or_state_save(now); // only saves if appropriate
1896  const time_t next_write = get_or_state()->next_write;
1897  if (next_write == TIME_MAX) {
1898  return 86400;
1899  }
1900  return safe_timer_diff(now, next_write);
1901 }
1902 
1903 /** Reschedule the event for saving the state file.
1904  *
1905  * Run this when the state becomes dirty. */
1906 void
1908 {
1909  if (save_state_event == NULL) {
1910  /* This can happen early on during startup. */
1911  return;
1912  }
1913  periodic_event_reschedule(save_state_event);
1914 }
1915 
1916 /**
1917  * Periodic callback: Write statistics to disk if appropriate.
1918  */
1919 static int
1920 write_stats_file_callback(time_t now, const or_options_t *options)
1921 {
1922  /* 1g. Check whether we should write statistics to disk.
1923  */
1924 #define CHECK_WRITE_STATS_INTERVAL (60*60)
1925  time_t next_time_to_write_stats_files = now + CHECK_WRITE_STATS_INTERVAL;
1926  if (options->CellStatistics) {
1927  time_t next_write =
1929  if (next_write && next_write < next_time_to_write_stats_files)
1930  next_time_to_write_stats_files = next_write;
1931  }
1932  if (options->DirReqStatistics) {
1933  time_t next_write = geoip_dirreq_stats_write(now);
1934  if (next_write && next_write < next_time_to_write_stats_files)
1935  next_time_to_write_stats_files = next_write;
1936  }
1937  if (options->EntryStatistics) {
1938  time_t next_write = geoip_entry_stats_write(now);
1939  if (next_write && next_write < next_time_to_write_stats_files)
1940  next_time_to_write_stats_files = next_write;
1941  }
1942  if (options->HiddenServiceStatistics) {
1943  time_t next_write = rep_hist_hs_stats_write(now, false);
1944  if (next_write && next_write < next_time_to_write_stats_files)
1945  next_time_to_write_stats_files = next_write;
1946 
1947  next_write = rep_hist_hs_stats_write(now, true);
1948  if (next_write && next_write < next_time_to_write_stats_files)
1949  next_time_to_write_stats_files = next_write;
1950  }
1951  if (options->ExitPortStatistics) {
1952  time_t next_write = rep_hist_exit_stats_write(now);
1953  if (next_write && next_write < next_time_to_write_stats_files)
1954  next_time_to_write_stats_files = next_write;
1955  }
1956  if (options->ConnDirectionStatistics) {
1957  time_t next_write = conn_stats_save(now);
1958  if (next_write && next_write < next_time_to_write_stats_files)
1959  next_time_to_write_stats_files = next_write;
1960  }
1961  if (options->BridgeAuthoritativeDir) {
1962  time_t next_write = rep_hist_desc_stats_write(now);
1963  if (next_write && next_write < next_time_to_write_stats_files)
1964  next_time_to_write_stats_files = next_write;
1965  }
1966 
1967  return safe_timer_diff(now, next_time_to_write_stats_files);
1968 }
1969 
1970 static int
1971 reset_padding_counts_callback(time_t now, const or_options_t *options)
1972 {
1973  if (options->PaddingStatistics) {
1974  rep_hist_prep_published_padding_counts(now);
1975  }
1976 
1979 }
1980 
1981 static int should_init_bridge_stats = 1;
1982 
1983 /**
1984  * Periodic callback: Write bridge statistics to disk if appropriate.
1985  */
1986 static int
1987 record_bridge_stats_callback(time_t now, const or_options_t *options)
1988 {
1989  /* 1h. Check whether we should write bridge statistics to disk.
1990  */
1991  if (should_record_bridge_info(options)) {
1992  if (should_init_bridge_stats) {
1993  /* (Re-)initialize bridge statistics. */
1995  should_init_bridge_stats = 0;
1996  return WRITE_STATS_INTERVAL;
1997  } else {
1998  /* Possibly write bridge statistics to disk and ask when to write
1999  * them next time. */
2000  time_t next = geoip_bridge_stats_write(now);
2001  return safe_timer_diff(now, next);
2002  }
2003  } else if (!should_init_bridge_stats) {
2004  /* Bridge mode was turned off. Ensure that stats are re-initialized
2005  * next time bridge mode is turned on. */
2006  should_init_bridge_stats = 1;
2007  }
2008  return PERIODIC_EVENT_NO_UPDATE;
2009 }
2010 
2011 /**
2012  * Periodic callback: Clean in-memory caches every once in a while
2013  */
2014 static int
2015 clean_caches_callback(time_t now, const or_options_t *options)
2016 {
2017  /* Remove old information from rephist and the rend cache. */
2018  rep_history_clean(now - options->RephistTrackTime);
2020  hs_cache_clean_as_dir(now);
2021  microdesc_cache_rebuild(NULL, 0);
2022 #define CLEAN_CACHES_INTERVAL (30*60)
2023  return CLEAN_CACHES_INTERVAL;
2024 }
2025 
2026 /**
2027  * Periodic callback: Clean the cache of failed hidden service lookups
2028  * frequently.
2029  */
2030 static int
2032 {
2033  (void)options;
2034  /* We don't keep entries that are more than five minutes old so we try to
2035  * clean it as soon as we can since we want to make sure the client waits
2036  * as little as possible for reachability reasons. */
2038  return 30;
2039 }
2040 
2041 /**
2042  * Periodic callback: prune routerlist of old information about Tor network.
2043  */
2044 static int
2045 prune_old_routers_callback(time_t now, const or_options_t *options)
2046 {
2047 #define ROUTERLIST_PRUNING_INTERVAL (60*60) // 1 hour.
2048  (void)now;
2049  (void)options;
2050 
2051  if (!net_is_disabled()) {
2052  /* If any networkstatus documents are no longer recent, we need to
2053  * update all the descriptors' running status. */
2054  /* Remove dead routers. */
2055  log_debug(LD_GENERAL, "Pruning routerlist...");
2057  }
2058 
2059  return ROUTERLIST_PRUNING_INTERVAL;
2060 }
2061 
2062 /**
2063  * Periodic event: once a minute, (or every second if TestingTorNetwork, or
2064  * during client bootstrap), check whether we want to download any
2065  * networkstatus documents. */
2066 static int
2067 fetch_networkstatus_callback(time_t now, const or_options_t *options)
2068 {
2069  /* How often do we check whether we should download network status
2070  * documents? */
2071  const int we_are_bootstrapping = networkstatus_consensus_is_bootstrapping(
2072  now);
2073  const int prefer_mirrors = !dirclient_fetches_from_authorities(
2074  get_options());
2075  int networkstatus_dl_check_interval = 60;
2076  /* check more often when testing, or when bootstrapping from mirrors
2077  * (connection limits prevent too many connections being made) */
2078  if (options->TestingTorNetwork
2079  || (we_are_bootstrapping && prefer_mirrors)) {
2080  networkstatus_dl_check_interval = 1;
2081  }
2082 
2083  if (should_delay_dir_fetches(options, NULL))
2084  return PERIODIC_EVENT_NO_UPDATE;
2085 
2087  return networkstatus_dl_check_interval;
2088 }
2089 
2090 /**
2091  * Periodic callback: Every 60 seconds, we relaunch listeners if any died. */
2092 static int
2093 retry_listeners_callback(time_t now, const or_options_t *options)
2094 {
2095  (void)now;
2096  (void)options;
2097  if (!net_is_disabled()) {
2098  retry_all_listeners(NULL, 0);
2099  return 60;
2100  }
2101  return PERIODIC_EVENT_NO_UPDATE;
2102 }
2103 
2104 static int heartbeat_callback_first_time = 1;
2105 
2106 /**
2107  * Periodic callback: write the heartbeat message in the logs.
2108  *
2109  * If writing the heartbeat message to the logs fails for some reason, retry
2110  * again after <b>MIN_HEARTBEAT_PERIOD</b> seconds.
2111  */
2112 static int
2113 heartbeat_callback(time_t now, const or_options_t *options)
2114 {
2115  /* Check if heartbeat is disabled */
2116  if (!options->HeartbeatPeriod) {
2117  return PERIODIC_EVENT_NO_UPDATE;
2118  }
2119 
2120  /* Skip the first one. */
2121  if (heartbeat_callback_first_time) {
2122  heartbeat_callback_first_time = 0;
2123  return options->HeartbeatPeriod;
2124  }
2125 
2126  /* Write the heartbeat message */
2127  if (log_heartbeat(now) == 0) {
2128  return options->HeartbeatPeriod;
2129  } else {
2130  /* If we couldn't write the heartbeat log message, try again in the minimum
2131  * interval of time. */
2132  return MIN_HEARTBEAT_PERIOD;
2133  }
2134 }
2135 
2136 #define CDM_CLEAN_CALLBACK_INTERVAL 600
2137 static int
2138 clean_consdiffmgr_callback(time_t now, const or_options_t *options)
2139 {
2140  (void)now;
2141  if (dir_server_mode(options)) {
2143  }
2144  return CDM_CLEAN_CALLBACK_INTERVAL;
2145 }
2146 
2147 /*
2148  * Periodic callback: Run scheduled events for HS service. This is called
2149  * every second.
2150  */
2151 static int
2152 hs_service_callback(time_t now, const or_options_t *options)
2153 {
2154  (void) options;
2155 
2156  /* We need to at least be able to build circuits and that we actually have
2157  * a working network. */
2161  goto end;
2162  }
2163 
2165 
2166  end:
2167  /* Every 1 second. */
2168  return 1;
2169 }
2170 
2171 /*
2172  * Periodic callback: Send once-per-second events to the controller(s).
2173  * This is called every second.
2174  */
2175 static int
2176 control_per_second_events_callback(time_t now, const or_options_t *options)
2177 {
2178  (void) options;
2179  (void) now;
2180 
2182 
2183  return 1;
2184 }
2185 
2186 /** Last time that update_current_time was called. */
2187 static time_t current_second = 0;
2188 /** Last time that update_current_time updated current_second. */
2189 static monotime_coarse_t current_second_last_changed;
2190 
2191 /**
2192  * Set the current time to "now", which should be the value returned by
2193  * time(). Check for clock jumps and track the total number of seconds we
2194  * have been running.
2195  */
2196 void
2198 {
2199  if (PREDICT_LIKELY(now == current_second)) {
2200  /* We call this function a lot. Most frequently, the current second
2201  * will not have changed, so we just return. */
2202  return;
2203  }
2204 
2205  const time_t seconds_elapsed = current_second ? (now - current_second) : 0;
2206 
2207  /* Check the wall clock against the monotonic clock, so we can
2208  * better tell idleness from clock jumps and/or other shenanigans. */
2209  monotime_coarse_t last_updated;
2210  memcpy(&last_updated, &current_second_last_changed, sizeof(last_updated));
2211  monotime_coarse_get(&current_second_last_changed);
2212 
2213  /** How much clock jumping means that we should adjust our idea of when
2214  * to go dormant? */
2215 #define NUM_JUMPED_SECONDS_BEFORE_NETSTATUS_UPDATE 20
2216 
2217  /* Don't go dormant early or late just because we jumped in time. */
2218  if (ABS(seconds_elapsed) >= NUM_JUMPED_SECONDS_BEFORE_NETSTATUS_UPDATE) {
2220  netstatus_note_clock_jumped(seconds_elapsed);
2221  }
2222  }
2223 
2224  /** How much clock jumping do we tolerate? */
2225 #define NUM_JUMPED_SECONDS_BEFORE_WARN 100
2226 
2227  /** How much idleness do we tolerate? */
2228 #define NUM_IDLE_SECONDS_BEFORE_WARN 3600
2229 
2230  if (seconds_elapsed < -NUM_JUMPED_SECONDS_BEFORE_WARN) {
2231  // moving back in time is always a bad sign.
2232  circuit_note_clock_jumped(seconds_elapsed, false);
2233 
2234  } else if (seconds_elapsed >= NUM_JUMPED_SECONDS_BEFORE_WARN) {
2235  /* Compare the monotonic clock to the result of time(). */
2236  const int32_t monotime_msec_passed =
2237  monotime_coarse_diff_msec32(&last_updated,
2239  const int monotime_sec_passed = monotime_msec_passed / 1000;
2240  const int discrepancy = monotime_sec_passed - (int)seconds_elapsed;
2241  /* If the monotonic clock deviates from time(NULL), we have a couple of
2242  * possibilities. On some systems, this means we have been suspended or
2243  * sleeping. Everywhere, it can mean that the wall-clock time has
2244  * been changed -- for example, with settimeofday().
2245  *
2246  * On the other hand, if the monotonic time matches with the wall-clock
2247  * time, we've probably just been idle for a while, with no events firing.
2248  * we tolerate much more of that.
2249  */
2250  const bool clock_jumped = abs(discrepancy) > 2;
2251 
2252  if (clock_jumped || seconds_elapsed >= NUM_IDLE_SECONDS_BEFORE_WARN) {
2253  circuit_note_clock_jumped(seconds_elapsed, ! clock_jumped);
2254  }
2255  } else if (seconds_elapsed > 0) {
2256  stats_n_seconds_working += seconds_elapsed;
2257  }
2258 
2259  update_approx_time(now);
2260  current_second = now;
2261 }
2262 
2263 #ifdef HAVE_SYSTEMD_209
2264 static periodic_timer_t *systemd_watchdog_timer = NULL;
2265 
2266 /** Libevent callback: invoked to reset systemd watchdog. */
2267 static void
2268 systemd_watchdog_callback(periodic_timer_t *timer, void *arg)
2269 {
2270  (void)timer;
2271  (void)arg;
2272  sd_notify(0, "WATCHDOG=1");
2273 }
2274 #endif /* defined(HAVE_SYSTEMD_209) */
2275 
2276 #define UPTIME_CUTOFF_FOR_NEW_BANDWIDTH_TEST (6*60*60)
2277 
2278 /** Called when our IP address seems to have changed. <b>on_client_conn</b>
2279  * should be true if:
2280  * - we detected a change in our interface address, using an outbound
2281  * connection, and therefore
2282  * - our client TLS keys need to be rotated.
2283  * Otherwise, it should be false, and:
2284  * - we detected a change in our published address
2285  * (using some other method), and therefore
2286  * - the published addresses in our descriptor need to change.
2287  */
2288 void
2289 ip_address_changed(int on_client_conn)
2290 {
2291  const or_options_t *options = get_options();
2292  int server = server_mode(options);
2293 
2294  if (on_client_conn) {
2295  if (! server) {
2296  /* Okay, change our keys. */
2297  if (init_keys_client() < 0)
2298  log_warn(LD_GENERAL, "Unable to rotate keys after IP change!");
2299  }
2300  } else {
2301  if (server) {
2302  if (get_uptime() > UPTIME_CUTOFF_FOR_NEW_BANDWIDTH_TEST)
2304  reset_uptime();
2306  /* All relays include their IP addresses as their ORPort addresses in
2307  * their descriptor.
2308  * Exit relays also incorporate interface addresses in their exit
2309  * policies, when ExitPolicyRejectLocalInterfaces is set. */
2310  mark_my_descriptor_dirty("IP address changed");
2311  }
2312  }
2313 
2315 }
2316 
2317 /** Forget what we've learned about the correctness of our DNS servers, and
2318  * start learning again. */
2319 void
2321 {
2322  if (server_mode(get_options())) {
2324  if (check_dns_honesty_event) {
2325  periodic_event_reschedule(check_dns_honesty_event);
2326  }
2327  }
2328 }
2329 
2330 /** Initialize some mainloop_event_t objects that we require. */
2331 void
2333 {
2337  }
2338  if (!postloop_cleanup_ev) {
2341  }
2342 }
2343 
2344 /** Tor main loop. */
2345 int
2347 {
2348  /* initialize the periodic events first, so that code that depends on the
2349  * events being present does not assert.
2350  */
2353 
2355 
2356  struct timeval one_second = { 1, 0 };
2357  initialize_periodic_events_event = tor_evtimer_new(
2360  event_add(initialize_periodic_events_event, &one_second);
2361 
2362 #ifdef HAVE_SYSTEMD_209
2363  uint64_t watchdog_delay;
2364  /* set up systemd watchdog notification. */
2365  if (sd_watchdog_enabled(1, &watchdog_delay) > 0) {
2366  if (! systemd_watchdog_timer) {
2367  struct timeval watchdog;
2368  /* The manager will "act on" us if we don't send them a notification
2369  * every 'watchdog_delay' microseconds. So, send notifications twice
2370  * that often. */
2371  watchdog_delay /= 2;
2372  watchdog.tv_sec = watchdog_delay / 1000000;
2373  watchdog.tv_usec = watchdog_delay % 1000000;
2374 
2375  systemd_watchdog_timer = periodic_timer_new(tor_libevent_get_base(),
2376  &watchdog,
2377  systemd_watchdog_callback,
2378  NULL);
2379  tor_assert(systemd_watchdog_timer);
2380  }
2381  }
2382 #endif /* defined(HAVE_SYSTEMD_209) */
2383 #ifdef ENABLE_RESTART_DEBUGGING
2384  {
2385  static int first_time = 1;
2386 
2387  if (first_time && getenv("TOR_DEBUG_RESTART")) {
2388  first_time = 0;
2389  const char *sec_str = getenv("TOR_DEBUG_RESTART_AFTER_SECONDS");
2390  long sec;
2391  int sec_ok=0;
2392  if (sec_str &&
2393  (sec = tor_parse_long(sec_str, 10, 0, INT_MAX, &sec_ok, NULL)) &&
2394  sec_ok) {
2395  /* Okay, we parsed the seconds. */
2396  } else {
2397  sec = 5;
2398  }
2399  struct timeval restart_after = { (time_t) sec, 0 };
2400  tor_shutdown_event_loop_for_restart_event =
2401  tor_evtimer_new(tor_libevent_get_base(),
2402  tor_shutdown_event_loop_for_restart_cb, NULL);
2403  event_add(tor_shutdown_event_loop_for_restart_event, &restart_after);
2404  }
2405  }
2406 #endif /* defined(ENABLE_RESTART_DEBUGGING) */
2407 
2408  return run_main_loop_until_done();
2409 }
2410 
2411 #ifndef _WIN32
2412 /** Rate-limiter for EINVAL-type libevent warnings. */
2413 static ratelim_t libevent_error_ratelim = RATELIM_INIT(10);
2414 #endif
2415 
2416 /**
2417  * Run the main loop a single time. Return 0 for "exit"; -1 for "exit with
2418  * error", and 1 for "run this again."
2419  */
2420 static int
2422 {
2423  int loop_result;
2424 
2425  if (nt_service_is_stopping())
2426  return 0;
2427 
2429  return 0;
2430 
2431 #ifndef _WIN32
2432  /* Make it easier to tell whether libevent failure is our fault or not. */
2433  errno = 0;
2434 #endif
2435 
2436  if (get_options()->MainloopStats) {
2437  /* We always enforce that EVLOOP_ONCE is passed to event_base_loop() if we
2438  * are collecting main loop statistics. */
2439  called_loop_once = 1;
2440  } else {
2441  called_loop_once = 0;
2442  }
2443 
2444  /* Make sure we know (about) what time it is. */
2445  update_approx_time(time(NULL));
2446 
2447  /* Here it is: the main loop. Here we tell Libevent to poll until we have
2448  * an event, or the second ends, or until we have some active linked
2449  * connections to trigger events for. Libevent will wait till one
2450  * of these happens, then run all the appropriate callbacks. */
2453 
2454  if (get_options()->MainloopStats) {
2455  /* Update our main loop counters. */
2456  if (loop_result == 0) {
2457  // The call was successful.
2459  } else if (loop_result == -1) {
2460  // The call was erroneous.
2462  } else if (loop_result == 1) {
2463  // The call didn't have any active or pending events
2464  // to handle.
2466  }
2467  }
2468 
2469  /* Oh, the loop failed. That might be an error that we need to
2470  * catch, but more likely, it's just an interrupted poll() call or something,
2471  * and we should try again. */
2472  if (loop_result < 0) {
2473  int e = tor_socket_errno(-1);
2474  /* let the program survive things like ^z */
2475  if (e != EINTR && !ERRNO_IS_EINPROGRESS(e)) {
2476  log_err(LD_NET,"libevent call with %s failed: %s [%d]",
2477  tor_libevent_get_method(), tor_socket_strerror(e), e);
2478  return -1;
2479 #ifndef _WIN32
2480  } else if (e == EINVAL) {
2482  "EINVAL from libevent: should you upgrade libevent?");
2484  log_err(LD_NET, "Too many libevent errors, too fast: dying");
2485  return -1;
2486  }
2487 #endif /* !defined(_WIN32) */
2488  } else {
2489  tor_assert_nonfatal_once(! ERRNO_IS_EINPROGRESS(e));
2490  log_debug(LD_NET,"libevent call interrupted.");
2491  /* You can't trust the results of this poll(). Go back to the
2492  * top of the big for loop. */
2493  return 1;
2494  }
2495  }
2496 
2498  return 0;
2499 
2500  return 1;
2501 }
2502 
2503 /** Run the run_main_loop_once() function until it declares itself done,
2504  * and return its final return value.
2505  *
2506  * Shadow won't invoke this function, so don't fill it up with things.
2507  */
2508 STATIC int
2510 {
2511  int loop_result = 1;
2512 
2515 
2516  do {
2517  loop_result = run_main_loop_once();
2518  } while (loop_result == 1);
2519 
2521  return main_loop_exit_value;
2522  else
2523  return loop_result;
2524 }
2525 
2526 /** Returns Tor's uptime. */
2527 MOCK_IMPL(long,
2528 get_uptime,(void))
2529 {
2530  return stats_n_seconds_working;
2531 }
2532 
2533 /** Reset Tor's uptime. */
2534 MOCK_IMPL(void,
2536 {
2538 }
2539 
2540 void
2541 tor_mainloop_free_all(void)
2542 {
2543  smartlist_free(connection_array);
2544  smartlist_free(closeable_connection_lst);
2545  smartlist_free(active_linked_connection_lst);
2546  teardown_periodic_events();
2547  tor_event_free(shutdown_did_not_work_event);
2548  tor_event_free(initialize_periodic_events_event);
2549  mainloop_event_free(directory_all_unreachable_cb_event);
2550  mainloop_event_free(schedule_active_linked_connections_event);
2551  mainloop_event_free(postloop_cleanup_ev);
2552  mainloop_event_free(handle_deferred_signewnym_ev);
2553  mainloop_event_free(scheduled_shutdown_ev);
2554  mainloop_event_free(rescan_periodic_events_ev);
2555 
2556 #ifdef HAVE_SYSTEMD_209
2557  periodic_timer_free(systemd_watchdog_timer);
2558 #endif
2559 
2561 
2562  memset(&global_bucket, 0, sizeof(global_bucket));
2563  memset(&global_relayed_bucket, 0, sizeof(global_relayed_bucket));
2567  newnym_epoch = 0;
2568  called_loop_once = 0;
2572  quiet_level = 0;
2573  should_init_bridge_stats = 1;
2574  heartbeat_callback_first_time = 1;
2575  current_second = 0;
2576  memset(&current_second_last_changed, 0,
2577  sizeof(current_second_last_changed));
2578 }
#define fmt_and_decorate_addr(a)
Definition: address.h:243
void addressmap_clear_transient(void)
Definition: addressmap.c:311
Header for addressmap.c.
void update_approx_time(time_t now)
Definition: approx_time.c:41
int authdir_mode_bridge(const or_options_t *options)
Definition: authmode.c:76
Header file for directory authority mode.
Header for backtrace.c.
void fetch_bridge_descriptors(const or_options_t *options, time_t now)
Definition: bridges.c:737
Header file for circuitbuild.c.
size_t buf_move_all(buf_t *buf_out, buf_t *buf_in)
Definition: buffers.c:691
size_t buf_datalen(const buf_t *buf)
Definition: buffers.c:394
Header file for buffers.c.
int buf_flush_to_socket(buf_t *buf, tor_socket_t s, size_t sz)
Definition: buffers_net.c:224
Header file for buffers_net.c.
int buf_flush_to_tls(buf_t *buf, tor_tls_t *tls, size_t flushlen)
Definition: buffers_tls.c:138
Header for buffers_tls.c.
Fixed-size cell structure.
int channel_is_bad_for_new_circs(channel_t *chan)
Definition: channel.c:2865
void channel_run_cleanup(void)
Definition: channel.c:2133
void channel_update_bad_for_new_circs(const char *digest, int force)
Definition: channel.c:3438
void channel_listener_run_cleanup(void)
Definition: channel.c:2159
unsigned int channel_num_circuits(channel_t *chan)
Definition: channel.c:3316
Header file for channel.c.
channelpadding_decision_t channelpadding_decide_to_pad_channel(channel_t *chan)
Header file for channeltls.c.
void circuit_note_clock_jumped(int64_t seconds_elapsed, bool was_idle)
void circuit_upgrade_circuits_from_guard_wait(void)
Header file for circuitbuild.c.
void circuit_close_all_marked(void)
Definition: circuitlist.c:662
void circuit_mark_all_dirty_circs_as_unusable(void)
Definition: circuitlist.c:2064
void circuit_mark_all_unused_circs(void)
Definition: circuitlist.c:2045
Header file for circuitlist.c.
void circuit_expire_waiting_for_better_guard(void)
Definition: circuituse.c:845
void circuit_expire_old_circs_as_needed(time_t now)
Definition: circuituse.c:1348
void reset_bandwidth_test(void)
Definition: circuituse.c:1603
void circuit_expire_building(void)
Definition: circuituse.c:447
void circuit_build_needed_circs(time_t now)
Definition: circuituse.c:1325
Header file for circuituse.c.
#define ABS(x)
Definition: cmp.h:40
bool tor_libevent_is_initialized(void)
struct event_base * tor_libevent_get_base(void)
mainloop_event_t * mainloop_event_postloop_new(void(*cb)(mainloop_event_t *, void *), void *userdata)
const char * tor_libevent_get_method(void)
periodic_timer_t * periodic_timer_new(struct event_base *base, const struct timeval *tv, void(*cb)(periodic_timer_t *timer, void *data), void *data)
void tor_libevent_exit_loop_after_callback(struct event_base *base)
mainloop_event_t * mainloop_event_new(void(*cb)(mainloop_event_t *, void *), void *userdata)
int tor_libevent_run_event_loop(struct event_base *base, int once)
int mainloop_event_schedule(mainloop_event_t *event, const struct timeval *tv)
void mainloop_event_activate(mainloop_event_t *event)
Header for compat_libevent.c.
static int32_t monotime_coarse_diff_msec32(const monotime_coarse_t *start, const monotime_coarse_t *end)
Definition: compat_time.h:338
int quiet
Definition: config.c:2442
const or_options_t * get_options(void)
Definition: config.c:919
int options_any_client_port_set(const or_options_t *options)
Definition: config.c:7502
const char * escaped_safe_str_client(const char *address)
Definition: config.c:1110
Header file for config.c.
#define MIN_HEARTBEAT_PERIOD
Definition: config.h:25
const char * conn_state_to_string(int type, int state)
Definition: connection.c:302
int connection_wants_to_flush(connection_t *conn)
Definition: connection.c:4259
int connection_is_moribund(connection_t *conn)
Definition: connection.c:5420
void connection_consider_empty_write_buckets(connection_t *conn)
Definition: connection.c:3727
void connection_close_immediate(connection_t *conn)
Definition: connection.c:1043
void assert_connection_ok(connection_t *conn, time_t now)
Definition: connection.c:5570
ssize_t connection_bucket_write_limit(connection_t *conn, time_t now)
Definition: connection.c:3476
int retry_all_listeners(smartlist_t *new_conns, int close_all_noncontrol)
Definition: connection.c:3203
int connection_state_is_open(connection_t *conn)
Definition: connection.c:4955
const char * conn_type_to_string(int type)
Definition: connection.c:268
connection_t * connection_get_by_type_state(int type, int state)
Definition: connection.c:4827
void log_failed_proxy_connection(connection_t *conn)
Definition: connection.c:5776
void connection_write_bw_exhausted(connection_t *conn, bool is_global_bw)
Definition: connection.c:3687
void connection_about_to_close_connection(connection_t *conn)
Definition: connection.c:1012
connection_t * connection_get_by_type_nonlinked(int type)
Definition: connection.c:4837
void connection_expire_held_open(void)
Definition: connection.c:1159
Header file for connection.c.
#define CONN_TYPE_OR
Definition: connection.h:44
#define CONN_TYPE_AP
Definition: connection.h:51
#define CONN_TYPE_DIR
Definition: connection.h:55
#define CONN_TYPE_AP_DNS_LISTENER
Definition: connection.h:68
#define CONN_TYPE_EXIT
Definition: connection.h:46
void connection_ap_expire_beginning(void)
int connection_edge_end_errno(edge_connection_t *conn)
edge_connection_t * TO_EDGE_CONN(connection_t *c)
entry_connection_t * TO_ENTRY_CONN(connection_t *c)
Header file for connection_edge.c.
#define AP_CONN_STATE_CIRCUIT_WAIT
void connection_or_write_cell_to_buf(const cell_t *cell, or_connection_t *conn)
void connection_or_clear_identity(or_connection_t *conn)
void connection_or_connect_failed(or_connection_t *conn, int reason, const char *msg)
or_connection_t * TO_OR_CONN(connection_t *c)
void connection_or_close_normally(or_connection_t *orconn, int flush)
Header file for connection_or.c.
#define CONN_IS_EDGE(x)
#define DIR_CONN_IS_SERVER(conn)
time_t conn_stats_save(time_t now)
Definition: connstats.c:260
Header for feature/stats/connstats.c.
int consdiffmgr_cleanup(void)
Definition: consdiffmgr.c:722
Header for consdiffmgr.c.
Header file for control.c.
#define LOG_FN_CONN(conn, args)
Definition: control.h:33
int control_event_conn_bandwidth(connection_t *conn)
int control_event_signal(uintptr_t signal_num)
int control_event_general_error(const char *format,...)
void control_per_second_events(void)
int control_any_per_second_event_enabled(void)
Header file for control_events.c.
Header file for cpuworker.c.
int crypto_seed_rng(void)
Definition: crypto_rand.c:452
Common functions for using (pseudo-)random number generators.
int connection_dir_reached_eof(dir_connection_t *conn)
Definition: dirclient.c:2810
int dirclient_too_idle_to_fetch_descriptors(const or_options_t *options, time_t now)
int dirclient_fetches_from_authorities(const or_options_t *options)
Header for feature/dirclient/dirclient_modes.c.
dir_connection_t * TO_DIR_CONN(connection_t *c)
Definition: directory.c:88
Header file for directory.c.
#define DIR_PURPOSE_FETCH_SERVERDESC
Definition: directory.h:36
void dns_reset_correctness_checks(void)
Definition: dns.c:2066
void assert_connection_edge_not_dns_pending(edge_connection_t *conn)
Definition: dns.c:942
Header file for dns.c.
void dnsserv_close_listener(connection_t *conn)
Definition: dnsserv.c:407
Header file for dnsserv.c.
Entry connection structure.
int guards_update_all(void)
Definition: entrynodes.c:3727
Header file for circuitbuild.c.
Header file for geoip_stats.c.
time_t geoip_entry_stats_write(time_t now)
Definition: geoip_stats.c:1373
time_t geoip_dirreq_stats_write(time_t now)
Definition: geoip_stats.c:1031
void geoip_bridge_stats_init(time_t now)
Definition: geoip_stats.c:1066
int should_record_bridge_info(const or_options_t *options)
Definition: geoip_stats.c:112
time_t geoip_bridge_stats_write(time_t now)
Definition: geoip_stats.c:1238
void consider_hibernation(time_t now)
Definition: hibernate.c:1098
int accounting_is_enabled(const or_options_t *options)
Definition: hibernate.c:305
void accounting_run_housekeeping(time_t now)
Definition: hibernate.c:585
int we_are_hibernating(void)
Definition: hibernate.c:937
Header file for hibernate.c.
void hs_cache_client_intro_state_clean(time_t now)
Definition: hs_cache.c:1001
void hs_cache_clean_as_client(time_t now)
Definition: hs_cache.c:942
void hs_cache_clean_as_dir(time_t now)
Definition: hs_cache.c:339
Header file for hs_cache.c.
void hs_client_purge_state(void)
Definition: hs_client.c:2558
Header file containing client data for the HS subsystem.
unsigned int hs_service_get_num_services(void)
Definition: hs_service.c:3918
void hs_service_run_scheduled_events(time_t now)
Definition: hs_service.c:4349
Header file containing service data for the HS subsystem.
void tor_log(int severity, log_domain_mask_t domain, const char *format,...)
Definition: log.c:590
#define log_fn(severity, domain, args,...)
Definition: log.h:283
#define log_fn_ratelim(ratelim, severity, domain, args,...)
Definition: log.h:288
#define LD_PROTOCOL
Definition: log.h:72
#define LOG_DEBUG
Definition: log.h:42
#define LD_OR
Definition: log.h:92
#define LD_BUG
Definition: log.h:86
#define LD_NET
Definition: log.h:66
#define LD_GENERAL
Definition: log.h:62
#define LD_DIR
Definition: log.h:88
#define LOG_NOTICE
Definition: log.h:50
#define LD_CONTROL
Definition: log.h:80
#define LOG_WARN
Definition: log.h:53
#define LOG_INFO
Definition: log.h:45
static monotime_coarse_t current_second_last_changed
Definition: mainloop.c:2189
static struct event * initialize_periodic_events_event
Definition: mainloop.c:1497
void stats_increment_bytes_read_and_written(uint64_t r, uint64_t w)
Definition: mainloop.c:483
#define MAX_SIGNEWNYM_RATE
Definition: mainloop.c:153
static int main_loop_should_exit
Definition: mainloop.c:178
#define LAZY_DESCRIPTOR_RETRY_INTERVAL
Definition: mainloop.c:197
void connection_watch_events(connection_t *conn, watchable_events_t events)
Definition: mainloop.c:493
void dns_servers_relaunch_checks(void)
Definition: mainloop.c:2320
STATIC int check_network_participation_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:1816
static int add_entropy_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:1798
static int periodic_events_initialized
Definition: mainloop.c:1347
static int rend_cache_failure_clean_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:2031
static time_t time_of_last_signewnym
Definition: mainloop.c:155
static void conn_read_callback(evutil_socket_t fd, short event, void *_conn)
Definition: mainloop.c:871
static int clean_caches_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:2015
static int main_loop_exit_value
Definition: mainloop.c:182
static mainloop_event_t * schedule_active_linked_connections_event
Definition: mainloop.c:378
static mainloop_event_t * scheduled_shutdown_ev
Definition: mainloop.c:1642
static void increment_main_loop_success_count(void)
Definition: mainloop.c:527
static void rescan_periodic_events_cb(mainloop_event_t *event, void *arg)
Definition: mainloop.c:1560
int connection_add_impl(connection_t *conn, int is_connecting)
Definition: mainloop.c:244
static void scheduled_shutdown_cb(mainloop_event_t *ev, void *arg)
Definition: mainloop.c:1646
void note_that_we_maybe_cant_complete_circuits(void)
Definition: mainloop.c:234
void connection_stop_reading(connection_t *conn)
Definition: mainloop.c:609
static smartlist_t * active_linked_connection_lst
Definition: mainloop.c:170
void connection_stop_reading_from_linked_conn(connection_t *conn)
Definition: mainloop.c:819
int connection_in_array(connection_t *conn)
Definition: mainloop.c:442
static struct event * shutdown_did_not_work_event
Definition: mainloop.c:727
int have_completed_a_circuit(void)
Definition: mainloop.c:218
void ip_address_changed(int on_client_conn)
Definition: mainloop.c:2289
static int retry_listeners_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:2093
void reset_uptime(void)
Definition: mainloop.c:2535
void note_that_we_completed_a_circuit(void)
Definition: mainloop.c:226
static int write_stats_file_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:1920
void connection_unregister_events(connection_t *conn)
Definition: mainloop.c:275
void directory_all_unreachable(time_t now)
Definition: mainloop.c:1097
int connection_remove(connection_t *conn)
Definition: mainloop.c:297
void add_connection_to_closeable_list(connection_t *conn)
Definition: mainloop.c:424
STATIC void close_closeable_connections(void)
Definition: mainloop.c:837
void reschedule_directory_downloads(void)
Definition: mainloop.c:1603
uint64_t get_bytes_read(void)
Definition: mainloop.c:463
void initialize_periodic_events(void)
Definition: mainloop.c:1519
void mainloop_schedule_shutdown(int delay_sec)
Definition: mainloop.c:1656
int connection_is_on_closeable_list(connection_t *conn)
Definition: mainloop.c:435
static void connection_unlink(connection_t *conn)
Definition: mainloop.c:340
void connection_start_reading(connection_t *conn)
Definition: mainloop.c:631
static void increment_main_loop_idle_count(void)
Definition: mainloop.c:555
#define GREEDY_DESCRIPTOR_RETRY_INTERVAL
Definition: mainloop.c:194
void update_current_time(time_t now)
Definition: mainloop.c:2197
void do_signewnym(time_t now)
Definition: mainloop.c:1316
static int check_expired_networkstatus_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:1873
static int launch_descriptor_fetches_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:1746
void initialize_mainloop_events(void)
Definition: mainloop.c:2332
static int fetch_networkstatus_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:2067
static uint64_t stats_n_bytes_written
Definition: mainloop.c:140
static uint64_t stats_n_bytes_read
Definition: mainloop.c:138
static int second_elapsed_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:1669
int do_main_loop(void)
Definition: mainloop.c:2346
int connection_is_writing(connection_t *conn)
Definition: mainloop.c:654
static void signewnym_impl(time_t now)
Definition: mainloop.c:1284
void schedule_rescan_periodic_events(void)
Definition: mainloop.c:1571
void connection_start_writing(connection_t *conn)
Definition: mainloop.c:687
static void run_connection_housekeeping(int i, time_t now)
Definition: mainloop.c:1156
uint64_t get_main_loop_error_count(void)
Definition: mainloop.c:548
static int connection_check_event(connection_t *conn, struct event *ev)
Definition: mainloop.c:571
static void shutdown_did_not_work_callback(evutil_socket_t fd, short event, void *arg) ATTR_NORETURN
Definition: mainloop.c:735
static void postloop_cleanup_cb(mainloop_event_t *ev, void *arg)
Definition: mainloop.c:1615
static int record_bridge_stats_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:1987
static int can_complete_circuits
Definition: mainloop.c:190
static long stats_n_seconds_working
Definition: mainloop.c:144
static int signewnym_is_pending
Definition: mainloop.c:157
uint64_t get_main_loop_idle_count(void)
Definition: mainloop.c:562
int connection_is_reading(connection_t *conn)
Definition: mainloop.c:508
void reschedule_or_state_save(void)
Definition: mainloop.c:1907
static void schedule_active_linked_connections_cb(mainloop_event_t *event, void *arg)
Definition: mainloop.c:387
void tor_shutdown_event_loop_and_exit(int exitcode)
Definition: mainloop.c:764
static ratelim_t libevent_error_ratelim
Definition: mainloop.c:2413
static int conn_close_if_marked(int i)
Definition: mainloop.c:957
void tor_init_connection_lists(void)
Definition: mainloop.c:412
smartlist_t * get_connection_array(void)
Definition: mainloop.c:451
static time_t current_second
Definition: mainloop.c:2187
static void conn_write_callback(evutil_socket_t fd, short event, void *_conn)
Definition: mainloop.c:913
void reset_all_main_loop_timers(void)
Definition: mainloop.c:1452
static unsigned newnym_epoch
Definition: mainloop.c:161
STATIC smartlist_t * connection_array
Definition: mainloop.c:164
static smartlist_t * closeable_connection_lst
Definition: mainloop.c:167
static void handle_deferred_signewnym_cb(mainloop_event_t *event, void *arg)
Definition: mainloop.c:1306
STATIC int get_my_roles(const or_options_t *options)
Definition: mainloop.c:1460
static mainloop_event_t * postloop_cleanup_ev
Definition: mainloop.c:1626
static int connection_should_read_from_linked_conn(connection_t *conn)
Definition: mainloop.c:715
int connection_count_moribund(void)
Definition: mainloop.c:853
uint64_t get_main_loop_success_count(void)
Definition: mainloop.c:534
static void connection_start_reading_from_linked_conn(connection_t *conn)
Definition: mainloop.c:801
void directory_info_has_arrived(time_t now, int from_cache, int suppress_logs)
Definition: mainloop.c:1115
void connection_stop_writing(connection_t *conn)
Definition: mainloop.c:664
uint64_t get_bytes_written(void)
Definition: mainloop.c:473
static int save_state_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:1892
static int run_main_loop_once(void)
Definition: mainloop.c:2421
static void increment_main_loop_error_count(void)
Definition: mainloop.c:541
static int heartbeat_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:2113
static uint64_t stats_n_main_loop_successes
Definition: mainloop.c:146
void reset_main_loop_counters(void)
Definition: mainloop.c:518
static uint64_t stats_n_main_loop_idle
Definition: mainloop.c:150
int tor_event_loop_shutdown_is_pending(void)
Definition: mainloop.c:792
static int rotate_x509_certificate_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:1764
static int called_loop_once
Definition: mainloop.c:174
long get_uptime(void)
Definition: mainloop.c:2528
time_t time_of_process_start
Definition: mainloop.c:142
static void directory_all_unreachable_cb(mainloop_event_t *event, void *arg)
Definition: mainloop.c:1067
void mainloop_schedule_postloop_cleanup(void)
Definition: mainloop.c:1631
static void initialize_periodic_events_cb(evutil_socket_t fd, short events, void *data)
Definition: mainloop.c:1505
void rescan_periodic_events(const or_options_t *options)
Definition: mainloop.c:1583
unsigned get_signewnym_epoch(void)
Definition: mainloop.c:1340
static int prune_old_routers_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:2045
static uint64_t stats_n_main_loop_errors
Definition: mainloop.c:148
STATIC int run_main_loop_until_done(void)
Definition: mainloop.c:2509
static mainloop_event_t * handle_deferred_signewnym_ev
Definition: mainloop.c:159
Header file for mainloop.c.
watchable_events_t
Definition: mainloop.h:35
@ WRITE_EVENT
Definition: mainloop.h:38
@ READ_EVENT
Definition: mainloop.h:37
#define tor_free(p)
Definition: malloc.h:52
int usable_consensus_flavor(void)
Definition: microdesc.c:1086
int microdesc_cache_rebuild(microdesc_cache_t *cache, int force)
Definition: microdesc.c:705
Header file for microdesc.c.
int net_is_disabled(void)
Definition: netstatus.c:25
void netstatus_note_clock_jumped(time_t seconds_diff)
Definition: netstatus.c:168
void set_network_participation(bool participation)
Definition: netstatus.c:101
time_t get_last_user_activity_time(void)
Definition: netstatus.c:91
void note_user_activity(time_t now)
Definition: netstatus.c:63
bool is_participating_on_network(void)
Definition: netstatus.c:110
Header for netstatus.c.
#define SOCKET_OK(s)
Definition: nettypes.h:39
void update_networkstatus_downloads(time_t now)
int networkstatus_consensus_reasonably_live(const networkstatus_t *consensus, time_t now)
networkstatus_t * networkstatus_get_reasonably_live_consensus(time_t now, int flavor)
networkstatus_t * networkstatus_get_latest_consensus(void)
int networkstatus_consensus_is_bootstrapping(time_t now)
int should_delay_dir_fetches(const or_options_t *options, const char **msg_out)
Header file for networkstatus.c.
Networkstatus consensus/vote structure.
void router_dir_info_changed(void)
Definition: nodelist.c:2470
const char * get_dir_info_status_string(void)
Definition: nodelist.c:2480
int router_have_minimum_dir_info(void)
Definition: nodelist.c:2427
Header file for nodelist.c.
Header file for ntmain.c.
Master header file for Tor-specific functionality.
#define MAX_SSL_KEY_LIFETIME_INTERNAL
Definition: or.h:154
#define END_STREAM_REASON_NET_UNREACHABLE
Definition: or.h:254
OR connection structure.
The or_state_t structure, which represents Tor's state file.
#define OR_CONN_STATE_CONNECTING
Definition: orconn_event.h:31
#define OR_CONN_STATE_OPEN
Definition: orconn_event.h:53
long tor_parse_long(const char *s, int base, long min, long max, int *ok, char **next)
Definition: parse_int.c:59
void periodic_events_rescan_by_roles(int roles, bool net_disabled)
Definition: periodic.c:291
void periodic_events_connect_all(void)
Definition: periodic.c:234
void periodic_events_register(periodic_event_item_t *item)
Definition: periodic.c:219
int safe_timer_diff(time_t now, time_t next)
Definition: periodic.c:351
void periodic_events_disconnect_all(void)
Definition: periodic.c:331
void periodic_event_reschedule(periodic_event_item_t *event)
Definition: periodic.c:106
void periodic_events_reset_all(void)
Definition: periodic.c:254
Header for periodic.c.
int any_predicted_circuits(time_t now)
Header file for predict_ports.c.
int proxy_mode(const or_options_t *options)
Definition: proxymode.c:21
Header file for proxymode.c.
quiet_level_t quiet_level
Definition: quiet_level.c:20
void rep_hist_reset_padding_counts(void)
Definition: rephist.c:2494
time_t rep_hist_desc_stats_write(time_t now)
Definition: rephist.c:1950
void rep_history_clean(time_t before)
Definition: rephist.c:928
time_t rep_hist_hs_stats_write(time_t now, bool is_v3)
Definition: rephist.c:2368
time_t rep_hist_buffer_stats_write(time_t now)
Definition: rephist.c:1813
time_t rep_hist_exit_stats_write(time_t now)
Definition: rephist.c:1536
Header file for rephist.c.
#define REPHIST_CELL_PADDING_COUNTS_INTERVAL
Definition: rephist.h:143
int router_initialize_tls_context(void)
Definition: router.c:813
void mark_my_descriptor_dirty(const char *reason)
Definition: router.c:2569
Router descriptor structure.
int generate_ed_link_cert(const or_options_t *options, time_t now, int force)
Definition: routerkeys.c:365
Header for routerkeys.c.
void update_extrainfo_downloads(time_t now)
Definition: routerlist.c:2779
void routerlist_remove_old_routers(void)
Definition: routerlist.c:1892
void update_all_descriptor_downloads(time_t now)
Definition: routerlist.c:2304
Header file for routerlist.c.
int dir_server_mode(const or_options_t *options)
Definition: routermode.c:23
int server_mode(const or_options_t *options)
Definition: routermode.c:34
Header file for routermode.c.
void router_do_reachability_checks(void)
Definition: selftest.c:284
void router_reset_reachability(void)
Definition: selftest.c:68
Header file for selftest.c.
smartlist_t * smartlist_new(void)
int smartlist_contains(const smartlist_t *sl, const void *element)
void smartlist_add(smartlist_t *sl, void *element)
void smartlist_remove(smartlist_t *sl, const void *element)
void smartlist_del(smartlist_t *sl, int idx)
#define SMARTLIST_FOREACH_BEGIN(sl, type, var)
#define SMARTLIST_FOREACH(sl, type, var, cmd)
Client request structure.
or_state_t * get_or_state(void)
Definition: statefile.c:220
int or_state_save(time_t now)
Definition: statefile.c:562
Header for statefile.c.
int log_heartbeat(time_t now)
Definition: status.c:154
Header for status.c.
Definition: cell_st.h:17
uint8_t command
Definition: cell_st.h:19
time_t timestamp_last_had_circuits
Definition: channel.h:448
uint64_t global_identifier
Definition: channel.h:197
time_t timestamp_last_read_allowed
unsigned int proxy_state
Definition: connection_st.h:92
uint8_t state
Definition: connection_st.h:49
unsigned int writing_to_linked_conn
Definition: connection_st.h:83
struct buf_t * inbuf
struct event * write_event
struct connection_t * linked_conn
unsigned int hold_open_until_flushed
Definition: connection_st.h:61
int conn_array_index
Definition: connection_st.h:97
unsigned int reading_from_linked_conn
Definition: connection_st.h:81
unsigned int type
Definition: connection_st.h:50
struct buf_t * outbuf
unsigned int linked
Definition: connection_st.h:78
uint16_t marked_for_close
uint16_t port
const char * marked_for_close_file
unsigned int purpose
Definition: connection_st.h:51
tor_socket_t s
Definition: connection_st.h:96
unsigned int active_on_link
Definition: connection_st.h:86
struct event * read_event
Definition: connection_st.h:99
time_t timestamp_last_write_allowed
tor_addr_t addr
unsigned int edge_has_sent_end
socks_request_t * socks_request
channel_tls_t * chan
unsigned int is_canonical
int ExitPortStatistics
int TestingDirConnectionMaxStall
uint64_t OwningControllerFD
int DormantTimeoutEnabled
int DormantTimeoutDisabledByIdleStreams
int HiddenServiceStatistics
int DormantClientTimeout
int ConnDirectionStatistics
int BridgeAuthoritativeDir
time_t next_write
Definition: or_state_st.h:26
const char * name
Definition: periodic.h:68
int n_calls_since_last_time
Definition: ratelim.h:51
char address[MAX_SOCKS_ADDR_LEN]
#define STATIC
Definition: testsupport.h:32
#define MOCK_IMPL(rv, funcname, arglist)
Definition: testsupport.h:133
Headers for transports.c.
#define tor_assert(expr)
Definition: util_bug.h:102
#define tor_fragile_assert()
Definition: util_bug.h:270
int tor_digest_is_zero(const char *digest)
Definition: util_string.c:96