Tor 0.4.9.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_event_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"
54#include "app/main/ntmain.h"
60#include "core/or/channel.h"
61#include "core/or/channelpadding.h"
62#include "core/or/channeltls.h"
64#include "core/or/circuitlist.h"
65#include "core/or/circuituse.h"
68#include "core/or/dos.h"
69#include "core/or/status.h"
83#include "feature/hs/hs_cache.h"
90#include "feature/relay/dns.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"
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. */
131token_bucket_rw_t global_bucket;
132
133/* Token bucket for relayed traffic. */
134token_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? */
138static uint64_t stats_n_bytes_read = 0;
139/** How many bytes have we written since we started the process? */
140static uint64_t stats_n_bytes_written = 0;
141/** What time did this process start up? */
143/** How many seconds have we been running? */
145/** How many times have we returned from the main loop successfully? */
146static uint64_t stats_n_main_loop_successes = 0;
147/** How many times have we received an error from the main loop? */
148static uint64_t stats_n_main_loop_errors = 0;
149/** How many times have we returned from the main loop with no events. */
150static 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? */
155static time_t time_of_last_signewnym = 0;
156/** Is there a signewnym request we're currently waiting to handle? */
157static int signewnym_is_pending = 0;
158/** Mainloop event for the deferred signewnym call. */
160/** How many times have we called newnym? */
161static 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. */
174static 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 */
179/** The return value that the main loop should yield when it exits, if
180 * main_loop_should_exit is true.
181 */
182static 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 */
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
199static int conn_close_if_marked(int i);
202static void conn_read_callback(evutil_socket_t fd, short event, void *_conn);
203static void conn_write_callback(evutil_socket_t fd, short event, void *_conn);
204static 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 */
217int
219{
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. */
225void
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. */
233void
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 */
243int
244connection_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. */
274void
276{
277 tor_event_free(conn->read_event);
278 tor_event_free(conn->write_event);
279 if (conn->type == CONN_TYPE_AP_DNS_LISTENER) {
281 }
282}
283
284/** Remove the connection from the global list, and remove the
285 * corresponding poll entry. Calling this function will shift the last
286 * connection (if any) into the position occupied by conn.
287 */
288int
290{
291 int current_index;
292 connection_t *tmp;
293
294 tor_assert(conn);
295
296 log_debug(LD_NET,"removing socket %d (type %s), n_conns now %d",
297 (int)conn->s, conn_type_to_string(conn->type),
298 smartlist_len(connection_array));
299
300 if (conn->type == CONN_TYPE_AP && conn->socket_family == AF_UNIX) {
301 log_info(LD_NET, "Closing SOCKS Unix socket connection");
302 }
303
305
306 tor_assert(conn->conn_array_index >= 0);
307 current_index = conn->conn_array_index;
308 connection_unregister_events(conn); /* This is redundant, but cheap. */
309 if (current_index == smartlist_len(connection_array)-1) { /* at the end */
310 smartlist_del(connection_array, current_index);
311 return 0;
312 }
313
314 /* replace this one with the one at the end */
315 smartlist_del(connection_array, current_index);
316 tmp = smartlist_get(connection_array, current_index);
317 tmp->conn_array_index = current_index;
318
319 return 0;
320}
321
322/** If <b>conn</b> is an edge conn, remove it from the list
323 * of conn's on this circuit. If it's not on an edge,
324 * flush and send destroys for all circuits on this conn.
325 *
326 * Remove it from connection_array (if applicable) and
327 * from closeable_connection_list.
328 *
329 * Then free it.
330 */
331static void
333{
335 if (conn->conn_array_index >= 0) {
336 connection_remove(conn);
337 }
338 if (conn->linked_conn) {
339 conn->linked_conn->linked_conn = NULL;
340 if (! conn->linked_conn->marked_for_close &&
343 conn->linked_conn = NULL;
344 }
347 if (conn->type == CONN_TYPE_EXIT) {
349 }
350 if (conn->type == CONN_TYPE_OR) {
351 if (!tor_digest_is_zero(TO_OR_CONN(conn)->identity_digest))
353 /* connection_unlink() can only get called if the connection
354 * was already on the closeable list, and it got there by
355 * connection_mark_for_close(), which was called from
356 * connection_or_close_normally() or
357 * connection_or_close_for_error(), so the channel should
358 * already be in CHANNEL_STATE_CLOSING, and then the
359 * connection_about_to_close_connection() goes to
360 * connection_or_about_to_close(), which calls channel_closed()
361 * to notify the channel_t layer, and closed the channel, so
362 * nothing more to do here to deal with the channel associated
363 * with an orconn.
364 */
365 }
366 connection_free(conn);
367}
368
369/** Event that invokes schedule_active_linked_connections_cb. */
371
372/**
373 * Callback: used to activate read events for all linked connections, so
374 * libevent knows to call their read callbacks. This callback run as a
375 * postloop event, so that the events _it_ activates don't happen until
376 * Libevent has a chance to check for other events.
377 */
378static void
380{
381 (void)event;
382 (void)arg;
383
384 /* All active linked conns should get their read events activated,
385 * so that libevent knows to run their callbacks. */
387 event_active(conn->read_event, EV_READ, 1));
388
389 /* Reactivate the event if we still have connections in the active list.
390 *
391 * A linked connection doesn't get woken up by I/O but rather artificially
392 * by this event callback. It has directory data spooled in it and it is
393 * sent incrementally by small chunks unless spool_eagerly is true. For that
394 * to happen, we need to induce the activation of the read event so it can
395 * be flushed. */
396 if (smartlist_len(active_linked_connection_lst)) {
398 }
399}
400
401/** Initialize the global connection list, closeable connection list,
402 * and active connection list. */
403void
405{
406 if (!connection_array)
412}
413
414/** Schedule <b>conn</b> to be closed. **/
415void
417{
420 assert_connection_ok(conn, time(NULL));
423}
424
425/** Return 1 if conn is on the closeable list, else return 0. */
426int
428{
430}
431
432/** Return true iff conn is in the current poll array. */
433int
435{
437}
438
439/** Set <b>*array</b> to an array of all connections. <b>*array</b> must not
440 * be modified.
441 */
444{
445 if (!connection_array)
447 return connection_array;
448}
449
450/**
451 * Return the amount of network traffic read, in bytes, over the life of this
452 * process.
453 */
454MOCK_IMPL(uint64_t,
456{
457 return stats_n_bytes_read;
458}
459
460/**
461 * Return the amount of network traffic read, in bytes, over the life of this
462 * process.
463 */
464MOCK_IMPL(uint64_t,
466{
468}
469
470/**
471 * Increment the amount of network traffic read and written, over the life of
472 * this process.
473 */
474void
476{
479}
480
481/** Set the event mask on <b>conn</b> to <b>events</b>. (The event
482 * mask is a bitmask whose bits are READ_EVENT and WRITE_EVENT)
483 */
484void
486{
487 if (events & READ_EVENT)
489 else
491
492 if (events & WRITE_EVENT)
494 else
496}
497
498/** Return true iff <b>conn</b> is listening for read events. */
499int
501{
502 tor_assert(conn);
503
504 return conn->reading_from_linked_conn ||
505 (conn->read_event && event_pending(conn->read_event, EV_READ, NULL));
506}
507
508/** Reset our main loop counters. */
509void
511{
515}
516
517/** Increment the main loop success counter. */
518static void
520{
522}
523
524/** Get the main loop success counter. */
525uint64_t
527{
529}
530
531/** Increment the main loop error counter. */
532static void
534{
536}
537
538/** Get the main loop error counter. */
539uint64_t
541{
543}
544
545/** Increment the main loop idle counter. */
546static void
548{
550}
551
552/** Get the main loop idle counter. */
553uint64_t
555{
557}
558
559/** Check whether <b>conn</b> is correct in having (or not having) a
560 * read/write event (passed in <b>ev</b>). On success, return 0. On failure,
561 * log a warning and return -1. */
562static int
563connection_check_event(connection_t *conn, struct event *ev)
564{
565 int bad;
566
567 if (conn->type == CONN_TYPE_AP && TO_EDGE_CONN(conn)->is_dns_request) {
568 /* DNS requests which we launch through the dnsserv.c module do not have
569 * any underlying socket or any underlying linked connection, so they
570 * shouldn't have any attached events either.
571 */
572 bad = ev != NULL;
573 } else {
574 /* Everything else should have an underlying socket, or a linked
575 * connection (which is also tracked with a read_event/write_event pair).
576 */
577 bad = ev == NULL;
578 }
579
580 if (bad) {
581 log_warn(LD_BUG, "Event missing on connection %p [%s;%s]. "
582 "socket=%d. linked=%d. "
583 "is_dns_request=%d. Marked_for_close=%s:%d",
584 conn,
586 conn_state_to_string(conn->type, conn->state),
587 (int)conn->s, (int)conn->linked,
588 (conn->type == CONN_TYPE_AP &&
589 TO_EDGE_CONN(conn)->is_dns_request),
591 conn->marked_for_close
592 );
593 log_backtrace(LOG_WARN, LD_BUG, "Backtrace attached.");
594 return -1;
595 }
596 return 0;
597}
598
599/** Tell the main loop to stop notifying <b>conn</b> of any read events. */
600MOCK_IMPL(void,
602{
603 tor_assert(conn);
604
605 if (connection_check_event(conn, conn->read_event) < 0) {
606 return;
607 }
608
609 if (conn->linked) {
610 conn->reading_from_linked_conn = 0;
612 } else {
613 if (event_del(conn->read_event))
614 log_warn(LD_NET, "Error from libevent setting read event state for %d "
615 "to unwatched: %s",
616 (int)conn->s,
617 tor_socket_strerror(tor_socket_errno(conn->s)));
618 }
619}
620
621/** Tell the main loop to start notifying <b>conn</b> of any read events. */
622MOCK_IMPL(void,
624{
625 tor_assert(conn);
626
627 if (connection_check_event(conn, conn->read_event) < 0) {
628 return;
629 }
630
631 if (conn->linked) {
632 conn->reading_from_linked_conn = 1;
635 } else {
636 if (CONN_IS_EDGE(conn) && TO_EDGE_CONN(conn)->xoff_received) {
637 /* We should not get called here if we're waiting for an XON, but
638 * belt-and-suspenders */
639 log_info(LD_NET,
640 "Request to start reading on an edgeconn blocked with XOFF");
641 return;
642 }
643 if (event_add(conn->read_event, NULL))
644 log_warn(LD_NET, "Error from libevent setting read event state for %d "
645 "to watched: %s",
646 (int)conn->s,
647 tor_socket_strerror(tor_socket_errno(conn->s)));
648
649 /* Process the inbuf if it is not empty because the only way to empty it is
650 * through a read event or a SENDME which might not come if the package
651 * window is proper or if the application has nothing more for us to read.
652 *
653 * If this is not done here, we risk having data lingering in the inbuf
654 * forever. */
655 if (conn->inbuf && buf_datalen(conn->inbuf) > 0) {
657 }
658 }
659}
660
661/** Return true iff <b>conn</b> is listening for write events. */
662int
664{
665 tor_assert(conn);
666
667 return conn->writing_to_linked_conn ||
668 (conn->write_event && event_pending(conn->write_event, EV_WRITE, NULL));
669}
670
671/** Tell the main loop to stop notifying <b>conn</b> of any write events. */
672MOCK_IMPL(void,
674{
675 tor_assert(conn);
676
677 if (connection_check_event(conn, conn->write_event) < 0) {
678 return;
679 }
680
681 if (conn->linked) {
682 conn->writing_to_linked_conn = 0;
683 if (conn->linked_conn)
685 } else {
686 if (event_del(conn->write_event))
687 log_warn(LD_NET, "Error from libevent setting write event state for %d "
688 "to unwatched: %s",
689 (int)conn->s,
690 tor_socket_strerror(tor_socket_errno(conn->s)));
691 }
692}
693
694/** Tell the main loop to start notifying <b>conn</b> of any write events. */
695MOCK_IMPL(void,
697{
698 tor_assert(conn);
699
700 if (connection_check_event(conn, conn->write_event) < 0) {
701 return;
702 }
703
704 if (conn->linked) {
705 conn->writing_to_linked_conn = 1;
706 if (conn->linked_conn &&
709 } else {
710 if (event_add(conn->write_event, NULL))
711 log_warn(LD_NET, "Error from libevent setting write event state for %d "
712 "to watched: %s",
713 (int)conn->s,
714 tor_socket_strerror(tor_socket_errno(conn->s)));
715 }
716}
717
718/** Return true iff <b>conn</b> is linked conn, and reading from the conn
719 * linked to it would be good and feasible. (Reading is "feasible" if the
720 * other conn exists and has data in its outbuf, and is "good" if we have our
721 * reading_from_linked_conn flag set and the other conn has its
722 * writing_to_linked_conn flag set.)*/
723static int
725{
726 if (conn->linked && conn->reading_from_linked_conn) {
727 if (! conn->linked_conn ||
730 return 1;
731 }
732 return 0;
733}
734
735/** Event to run 'shutdown did not work callback'. */
736static struct event *shutdown_did_not_work_event = NULL;
737
738/** Failsafe measure that should never actually be necessary: If
739 * tor_shutdown_event_loop_and_exit() somehow doesn't successfully exit the
740 * event loop, then this callback will kill Tor with an assertion failure
741 * seconds later
742 */
743static void
744shutdown_did_not_work_callback(evutil_socket_t fd, short event, void *arg)
745{
746 // LCOV_EXCL_START
747 (void) fd;
748 (void) event;
749 (void) arg;
750 tor_assert_unreached();
751 // LCOV_EXCL_STOP
752}
753
754#ifdef ENABLE_RESTART_DEBUGGING
755static struct event *tor_shutdown_event_loop_for_restart_event = NULL;
756static void
757tor_shutdown_event_loop_for_restart_cb(
758 evutil_socket_t fd, short event, void *arg)
759{
760 (void)fd;
761 (void)event;
762 (void)arg;
763 tor_event_free(tor_shutdown_event_loop_for_restart_event);
765}
766#endif /* defined(ENABLE_RESTART_DEBUGGING) */
767
768/**
769 * After finishing the current callback (if any), shut down the main loop,
770 * clean up the process, and exit with <b>exitcode</b>.
771 */
772void
774{
776 return; /* Ignore multiple calls to this function. */
777
779 main_loop_exit_value = exitcode;
780
782 return; /* No event loop to shut down. */
783 }
784
785 /* Die with an assertion failure in ten seconds, if for some reason we don't
786 * exit normally. */
787 /* XXXX We should consider this code if it's never used. */
788 struct timeval ten_seconds = { 10, 0 };
789 shutdown_did_not_work_event = tor_evtimer_new(
792 event_add(shutdown_did_not_work_event, &ten_seconds);
793
794 /* Unlike exit_loop_after_delay(), exit_loop_after_callback
795 * prevents other callbacks from running. */
797}
798
799/** Return true iff tor_shutdown_event_loop_and_exit() has been called. */
800int
802{
804}
805
806/** Helper: Tell the main loop to begin reading bytes into <b>conn</b> from
807 * its linked connection, if it is not doing so already. Called by
808 * connection_start_reading and connection_start_writing as appropriate. */
809static void
811{
812 tor_assert(conn);
813 tor_assert(conn->linked == 1);
814
815 if (!conn->active_on_link) {
816 conn->active_on_link = 1;
819 } else {
821 }
822}
823
824/** Tell the main loop to stop reading bytes into <b>conn</b> from its linked
825 * connection, if is currently doing so. Called by connection_stop_reading,
826 * connection_stop_writing, and connection_read. */
827void
829{
830 tor_assert(conn);
831 tor_assert(conn->linked == 1);
832
833 if (conn->active_on_link) {
834 conn->active_on_link = 0;
835 /* FFFF We could keep an index here so we can smartlist_del
836 * cleanly. On the other hand, this doesn't show up on profiles,
837 * so let's leave it alone for now. */
839 } else {
841 }
842}
843
844/** Close all connections that have been scheduled to get closed. */
845STATIC void
847{
848 int i;
849 for (i = 0; i < smartlist_len(closeable_connection_lst); ) {
850 connection_t *conn = smartlist_get(closeable_connection_lst, i);
851 if (conn->conn_array_index < 0) {
852 connection_unlink(conn); /* blow it away right now */
853 } else {
855 ++i;
856 }
857 }
858}
859
860/** Count moribund connections for the OOS handler */
861MOCK_IMPL(int,
863{
864 int moribund = 0;
865
866 /*
867 * Count things we'll try to kill when close_closeable_connections()
868 * runs next.
869 */
871 if (SOCKET_OK(conn->s) && connection_is_moribund(conn)) ++moribund;
872 } SMARTLIST_FOREACH_END(conn);
873
874 return moribund;
875}
876
877/** Libevent callback: this gets invoked when (connection_t*)<b>conn</b> has
878 * some data to read. */
879static void
880conn_read_callback(evutil_socket_t fd, short event, void *_conn)
881{
882 connection_t *conn = _conn;
883 (void)fd;
884 (void)event;
885
886 log_debug(LD_NET,"socket %d wants to read.",(int)conn->s);
887
888 /* assert_connection_ok(conn, time(NULL)); */
889
890 /* Handle marked for close connections early */
891 if (conn->marked_for_close && connection_is_reading(conn)) {
892 /* Libevent says we can read, but we are marked for close so we will never
893 * try to read again. We will try to close the connection below inside of
894 * close_closeable_connections(), but let's make sure not to cause Libevent
895 * to spin on conn_read_callback() while we wait for the socket to let us
896 * flush to it.*/
898 }
899
900 if (connection_handle_read(conn) < 0) {
901 if (!conn->marked_for_close) {
902#ifndef _WIN32
903 log_warn(LD_BUG,"Unhandled error on read for %s connection "
904 "(fd %d); removing",
905 conn_type_to_string(conn->type), (int)conn->s);
907#endif /* !defined(_WIN32) */
908 if (CONN_IS_EDGE(conn))
910 connection_mark_for_close(conn);
911 }
912 }
913 assert_connection_ok(conn, time(NULL));
914
915 if (smartlist_len(closeable_connection_lst))
917}
918
919/** Libevent callback: this gets invoked when (connection_t*)<b>conn</b> has
920 * some data to write. */
921static void
922conn_write_callback(evutil_socket_t fd, short events, void *_conn)
923{
924 connection_t *conn = _conn;
925 (void)fd;
926 (void)events;
927
928 LOG_FN_CONN(conn, (LOG_DEBUG, LD_NET, "socket %d wants to write.",
929 (int)conn->s));
930
931 /* assert_connection_ok(conn, time(NULL)); */
932
933 if (connection_handle_write(conn, 0) < 0) {
934 if (!conn->marked_for_close) {
935 /* this connection is broken. remove it. */
937 "unhandled error on write for %s connection (fd %d); removing",
938 conn_type_to_string(conn->type), (int)conn->s);
940 if (CONN_IS_EDGE(conn)) {
941 /* otherwise we cry wolf about duplicate close */
942 edge_connection_t *edge_conn = TO_EDGE_CONN(conn);
943 if (!edge_conn->end_reason)
944 edge_conn->end_reason = END_STREAM_REASON_INTERNAL;
945 edge_conn->edge_has_sent_end = 1;
946 }
947 connection_close_immediate(conn); /* So we don't try to flush. */
948 connection_mark_for_close(conn);
949 }
950 }
951 assert_connection_ok(conn, time(NULL));
952
953 if (smartlist_len(closeable_connection_lst))
955}
956
957/** If the connection at connection_array[i] is marked for close, then:
958 * - If it has data that it wants to flush, try to flush it.
959 * - If it _still_ has data to flush, and conn->hold_open_until_flushed is
960 * true, then leave the connection open and return.
961 * - Otherwise, remove the connection from connection_array and from
962 * all other lists, close it, and free it.
963 * Returns 1 if the connection was closed, 0 otherwise.
964 */
965static int
967{
968 connection_t *conn;
969 int retval;
970 time_t now;
971
972 conn = smartlist_get(connection_array, i);
973 if (!conn->marked_for_close)
974 return 0; /* nothing to see here, move along */
975 now = time(NULL);
976 assert_connection_ok(conn, now);
977
978 log_debug(LD_NET,"Cleaning up connection (fd "TOR_SOCKET_T_FORMAT").",
979 conn->s);
980
981 /* If the connection we are about to close was trying to connect to
982 a proxy server and failed, the client won't be able to use that
983 proxy. We should warn the user about this. */
984 if (conn->proxy_state == PROXY_INFANT)
986
987 if ((SOCKET_OK(conn->s) || conn->linked_conn) &&
989 /* s == -1 means it's an incomplete edge connection, or that the socket
990 * has already been closed as unflushable. */
991 ssize_t sz = connection_bucket_write_limit(conn, now);
992 if (!conn->hold_open_until_flushed)
993 log_info(LD_NET,
994 "Conn (addr %s, fd %d, type %s, state %d) marked, but wants "
995 "to flush %"TOR_PRIuSZ" bytes. (Marked at %s:%d)",
997 (int)conn->s, conn_type_to_string(conn->type), conn->state,
998 connection_get_outbuf_len(conn),
1000 if (conn->linked_conn) {
1001 retval = (int) buf_move_all(conn->linked_conn->inbuf, conn->outbuf);
1002 if (retval >= 0) {
1003 /* The linked conn will notice that it has data when it notices that
1004 * we're gone. */
1006 }
1007 log_debug(LD_GENERAL, "Flushed last %d bytes from a linked conn; "
1008 "%d left; wants-to-flush==%d", retval,
1009 (int)connection_get_outbuf_len(conn),
1011 } else if (connection_speaks_cells(conn)) {
1012 if (conn->state == OR_CONN_STATE_OPEN) {
1013 retval = buf_flush_to_tls(conn->outbuf, TO_OR_CONN(conn)->tls, sz);
1014 } else
1015 retval = -1; /* never flush non-open broken tls connections */
1016 } else {
1017 retval = buf_flush_to_socket(conn->outbuf, conn->s, sz);
1018 }
1019 if (retval >= 0 && /* Technically, we could survive things like
1020 TLS_WANT_WRITE here. But don't bother for now. */
1022 if (retval > 0) {
1024 "Holding conn (fd %d) open for more flushing.",
1025 (int)conn->s));
1026 conn->timestamp_last_write_allowed = now; /* reset so we can flush
1027 * more */
1028 } else if (sz == 0) {
1029 /* Also, retval==0. If we get here, we didn't want to write anything
1030 * (because of rate-limiting) and we didn't. */
1031
1032 /* Connection must flush before closing, but it's being rate-limited.
1033 * Let's remove from Libevent, and mark it as blocked on bandwidth
1034 * so it will be re-added on next token bucket refill. Prevents
1035 * busy Libevent loops where we keep ending up here and returning
1036 * 0 until we are no longer blocked on bandwidth.
1037 */
1039 /* Make sure that consider_empty_buckets really disabled the
1040 * connection: */
1041 if (BUG(connection_is_writing(conn))) {
1043 }
1044
1045 /* The connection is being held due to write rate limit and thus will
1046 * flush its data later. We need to stop reading because this
1047 * connection is about to be closed once flushed. It should not
1048 * process anything more coming in at this stage. */
1050 }
1051 return 0;
1052 }
1053 if (connection_wants_to_flush(conn)) {
1054 log_fn(LOG_INFO, LD_NET, "We stalled too much while trying to write %d "
1055 "bytes to address %s. If this happens a lot, either "
1056 "something is wrong with your network connection, or "
1057 "something is wrong with theirs. "
1058 "(fd %d, type %s, state %d, marked at %s:%d).",
1059 (int)connection_get_outbuf_len(conn),
1061 (int)conn->s, conn_type_to_string(conn->type), conn->state,
1063 conn->marked_for_close);
1064 }
1065 }
1066
1067 connection_unlink(conn); /* unlink, remove, free */
1068 return 1;
1069}
1070
1071/** Implementation for directory_all_unreachable. This is done in a callback,
1072 * since otherwise it would complicate Tor's control-flow graph beyond all
1073 * reason.
1074 */
1075static void
1077{
1078 (void)event;
1079 (void)arg;
1080
1081 connection_t *conn;
1082
1085 entry_connection_t *entry_conn = TO_ENTRY_CONN(conn);
1086 log_notice(LD_NET,
1087 "Is your network connection down? "
1088 "Failing connection to '%s:%d'.",
1089 safe_str_client(entry_conn->socks_request->address),
1090 entry_conn->socks_request->port);
1091 connection_mark_unattached_ap(entry_conn,
1093 }
1094 control_event_general_error("DIR_ALL_UNREACHABLE");
1095}
1096
1097static mainloop_event_t *directory_all_unreachable_cb_event = NULL;
1098
1099/** We've just tried every dirserver we know about, and none of
1100 * them were reachable. Assume the network is down. Change state
1101 * so next time an application connection arrives we'll delay it
1102 * and try another directory fetch. Kill off all the circuit_wait
1103 * streams that are waiting now, since they will all timeout anyway.
1104 */
1105void
1107{
1108 (void)now;
1109
1110 reset_uptime(); /* reset it */
1111
1112 if (!directory_all_unreachable_cb_event) {
1113 directory_all_unreachable_cb_event =
1115 tor_assert(directory_all_unreachable_cb_event);
1116 }
1117
1118 mainloop_event_activate(directory_all_unreachable_cb_event);
1119}
1120
1121/** This function is called whenever we successfully pull down some new
1122 * network statuses or server descriptors. */
1123void
1124directory_info_has_arrived(time_t now, int from_cache, int suppress_logs)
1125{
1126 const or_options_t *options = get_options();
1127
1128 /* if we have enough dir info, then update our guard status with
1129 * whatever we just learned. */
1130 int invalidate_circs = guards_update_all();
1131
1132 if (invalidate_circs) {
1135 }
1136
1138 int quiet = suppress_logs || from_cache ||
1141 "I learned some more directory information, but not enough to "
1142 "build a circuit: %s", get_dir_info_status_string());
1144 return;
1145 } else {
1148 }
1149
1150 /* Don't even bother trying to get extrainfo until the rest of our
1151 * directory info is up-to-date */
1152 if (options->DownloadExtraInfo)
1154 }
1155
1156 if (server_mode(options) && !net_is_disabled() && !from_cache &&
1159}
1160
1161/** Perform regular maintenance tasks for a single connection. This
1162 * function gets run once per second per connection by run_scheduled_events.
1163 */
1164static void
1166{
1167 cell_t cell;
1168 connection_t *conn = smartlist_get(connection_array, i);
1169 const or_options_t *options = get_options();
1170 or_connection_t *or_conn;
1171 channel_t *chan = NULL;
1172 int have_any_circuits;
1173 int past_keepalive =
1174 now >= conn->timestamp_last_write_allowed + options->KeepalivePeriod;
1175
1176 if (conn->outbuf && !connection_get_outbuf_len(conn) &&
1177 conn->type == CONN_TYPE_OR)
1178 TO_OR_CONN(conn)->timestamp_lastempty = now;
1179
1180 if (conn->marked_for_close) {
1181 /* nothing to do here */
1182 return;
1183 }
1184
1185 /* Expire any directory connections that haven't been active (sent
1186 * if a server or received if a client) for 5 min */
1187 if (conn->type == CONN_TYPE_DIR &&
1188 ((DIR_CONN_IS_SERVER(conn) &&
1190 + options->TestingDirConnectionMaxStall < now) ||
1191 (!DIR_CONN_IS_SERVER(conn) &&
1193 + options->TestingDirConnectionMaxStall < now))) {
1194 log_info(LD_DIR,"Expiring wedged directory conn (fd %d, purpose %d)",
1195 (int)conn->s, conn->purpose);
1196 /* This check is temporary; it's to let us know whether we should consider
1197 * parsing partial serverdesc responses. */
1199 connection_get_inbuf_len(conn) >= 1024) {
1200 log_info(LD_DIR,"Trying to extract information from wedged server desc "
1201 "download.");
1203 } else {
1204 connection_mark_for_close(conn);
1205 }
1206 return;
1207 }
1208
1209 if (!connection_speaks_cells(conn))
1210 return; /* we're all done here, the rest is just for OR conns */
1211
1212 /* If we haven't flushed to an OR connection for a while, then either nuke
1213 the connection or send a keepalive, depending. */
1214
1215 or_conn = TO_OR_CONN(conn);
1216 tor_assert(conn->outbuf);
1217
1218 chan = TLS_CHAN_TO_BASE(or_conn->chan);
1219 tor_assert(chan);
1220
1221 if (channel_num_circuits(chan) != 0) {
1222 have_any_circuits = 1;
1223 chan->timestamp_last_had_circuits = now;
1224 } else {
1225 have_any_circuits = 0;
1226 }
1227
1228 if (channel_is_bad_for_new_circs(TLS_CHAN_TO_BASE(or_conn->chan)) &&
1229 ! have_any_circuits) {
1230 /* It's bad for new circuits, and has no unmarked circuits on it:
1231 * mark it now. */
1232 log_info(LD_OR,
1233 "Expiring non-used OR connection to fd %d (%s:%d) [Too old].",
1234 (int)conn->s, fmt_and_decorate_addr(&conn->addr), conn->port);
1235 if (conn->state == OR_CONN_STATE_CONNECTING)
1237 END_OR_CONN_REASON_TIMEOUT,
1238 "Tor gave up on the connection");
1240 } else if (!connection_state_is_open(conn)) {
1241 if (past_keepalive) {
1242 /* We never managed to actually get this connection open and happy. */
1243 log_info(LD_OR,"Expiring non-open OR connection to fd %d (%s:%d).",
1244 (int)conn->s, fmt_and_decorate_addr(&conn->addr), conn->port);
1246 }
1247 } else if (we_are_hibernating() &&
1248 ! have_any_circuits &&
1249 !connection_get_outbuf_len(conn)) {
1250 /* We're hibernating or shutting down, there's no circuits, and nothing to
1251 * flush.*/
1252 log_info(LD_OR,"Expiring non-used OR connection to fd %d (%s:%d) "
1253 "[Hibernating or exiting].",
1254 (int)conn->s, fmt_and_decorate_addr(&conn->addr), conn->port);
1256 } else if (!have_any_circuits &&
1257 now - or_conn->idle_timeout >=
1259 log_info(LD_OR,"Expiring non-used OR connection %"PRIu64" to fd %d "
1260 "(%s:%d) [no circuits for %d; timeout %d; %scanonical].",
1261 (chan->global_identifier),
1262 (int)conn->s, fmt_and_decorate_addr(&conn->addr), conn->port,
1263 (int)(now - chan->timestamp_last_had_circuits),
1264 or_conn->idle_timeout,
1265 or_conn->is_canonical ? "" : "non");
1267 } else if (
1268 now >= or_conn->timestamp_lastempty + options->KeepalivePeriod*10 &&
1269 now >=
1270 conn->timestamp_last_write_allowed + options->KeepalivePeriod*10) {
1271 log_fn(LOG_PROTOCOL_WARN,LD_PROTOCOL,
1272 "Expiring stuck OR connection to fd %d (%s:%d). (%d bytes to "
1273 "flush; %d seconds since last write)",
1274 (int)conn->s, safe_str(fmt_and_decorate_addr(&conn->addr)),
1275 conn->port, (int)connection_get_outbuf_len(conn),
1276 (int)(now-conn->timestamp_last_write_allowed));
1278 } else if (past_keepalive && !connection_get_outbuf_len(conn)) {
1279 /* send a padding cell */
1280 log_fn(LOG_DEBUG,LD_OR,"Sending keepalive to (%s:%d)",
1281 fmt_and_decorate_addr(&conn->addr), conn->port);
1282 memset(&cell,0,sizeof(cell_t));
1283 cell.command = CELL_PADDING;
1284 connection_or_write_cell_to_buf(&cell, or_conn);
1285 } else {
1287 }
1288}
1289
1290/** Honor a NEWNYM request: make future requests unlinkable to past
1291 * requests. */
1292static void
1294{
1295 const or_options_t *options = get_options();
1296 if (!proxy_mode(options)) {
1297 log_info(LD_CONTROL, "Ignoring SIGNAL NEWNYM because client functionality "
1298 "is disabled.");
1299 return;
1300 }
1301
1308
1309 ++newnym_epoch;
1310
1311 control_event_signal(SIGNEWNYM);
1312}
1313
1314/** Callback: run a deferred signewnym. */
1315static void
1317{
1318 (void)event;
1319 (void)arg;
1320 log_info(LD_CONTROL, "Honoring delayed NEWNYM request");
1321 do_signewnym(time(NULL));
1322}
1323
1324/** Either perform a signewnym or schedule one, depending on rate limiting. */
1325void
1326do_signewnym(time_t now)
1327{
1329 const time_t delay_sec =
1331 if (! signewnym_is_pending) {
1336 }
1337 const struct timeval delay_tv = { delay_sec, 0 };
1339 }
1340 log_notice(LD_CONTROL,
1341 "Rate limiting NEWNYM request: delaying by %d second(s)",
1342 (int)(delay_sec));
1343 } else {
1344 signewnym_impl(now);
1345 }
1346}
1347
1348/** Return the number of times that signewnym has been called. */
1349unsigned
1351{
1352 return newnym_epoch;
1353}
1354
1355/** True iff we have initialized all the members of <b>periodic_events</b>.
1356 * Used to prevent double-initialization. */
1358
1359/* Declare all the timer callback functions... */
1360#ifndef COCCI
1361#undef CALLBACK
1362#define CALLBACK(name) \
1363 static int name ## _callback(time_t, const or_options_t *)
1364
1365CALLBACK(add_entropy);
1366CALLBACK(check_expired_networkstatus);
1367CALLBACK(clean_caches);
1368CALLBACK(clean_consdiffmgr);
1369CALLBACK(fetch_networkstatus);
1370CALLBACK(heartbeat);
1371CALLBACK(hs_service);
1372CALLBACK(launch_descriptor_fetches);
1373CALLBACK(prune_old_routers);
1374CALLBACK(record_bridge_stats);
1375CALLBACK(rend_cache_failure_clean);
1376CALLBACK(reset_padding_counts);
1377CALLBACK(retry_listeners);
1378CALLBACK(rotate_x509_certificate);
1379CALLBACK(save_state);
1380CALLBACK(write_stats_file);
1382CALLBACK(second_elapsed);
1383CALLBACK(manage_vglite);
1384
1385#undef CALLBACK
1386
1387/* Now we declare an array of periodic_event_item_t for each periodic event */
1388#define CALLBACK(name, r, f) \
1389 PERIODIC_EVENT(name, PERIODIC_EVENT_ROLE_ ## r, f)
1390#define FL(name) (PERIODIC_EVENT_FLAG_ ## name)
1391#endif /* !defined(COCCI) */
1392
1393STATIC periodic_event_item_t mainloop_periodic_events[] = {
1394
1395 /* Everyone needs to run these. They need to have very long timeouts for
1396 * that to be safe. */
1397 CALLBACK(add_entropy, ALL, 0),
1398 CALLBACK(heartbeat, ALL, 0),
1399 CALLBACK(reset_padding_counts, ALL, 0),
1400
1401 /* This is a legacy catch-all callback that runs once per second if
1402 * we are online and active. */
1403 CALLBACK(second_elapsed, NET_PARTICIPANT,
1404 FL(RUN_ON_DISABLE)),
1405
1406 /* Update vanguards-lite once per hour, if we have networking */
1407 CALLBACK(manage_vglite, NET_PARTICIPANT, FL(NEED_NET)),
1408
1409 /* XXXX Do we have a reason to do this on a callback? Does it do any good at
1410 * all? For now, if we're dormant, we can let our listeners decay. */
1411 CALLBACK(retry_listeners, NET_PARTICIPANT, FL(NEED_NET)),
1412
1413 /* We need to do these if we're participating in the Tor network. */
1414 CALLBACK(check_expired_networkstatus, NET_PARTICIPANT, 0),
1415 CALLBACK(fetch_networkstatus, NET_PARTICIPANT, 0),
1416 CALLBACK(launch_descriptor_fetches, NET_PARTICIPANT, FL(NEED_NET)),
1417 CALLBACK(rotate_x509_certificate, NET_PARTICIPANT, 0),
1418 CALLBACK(check_network_participation, NET_PARTICIPANT, 0),
1419
1420 /* We need to do these if we're participating in the Tor network, and
1421 * immediately before we stop. */
1422 CALLBACK(clean_caches, NET_PARTICIPANT, FL(RUN_ON_DISABLE)),
1423 CALLBACK(save_state, NET_PARTICIPANT, FL(RUN_ON_DISABLE)),
1424 CALLBACK(write_stats_file, NET_PARTICIPANT, FL(RUN_ON_DISABLE)),
1425 CALLBACK(prune_old_routers, NET_PARTICIPANT, FL(RUN_ON_DISABLE)),
1426
1427 /* Hidden Service service only. */
1428 CALLBACK(hs_service, HS_SERVICE, FL(NEED_NET)), // XXXX break this down more
1429
1430 /* Bridge only. */
1431 CALLBACK(record_bridge_stats, BRIDGE, 0),
1432
1433 /* Client only. */
1434 /* XXXX this could be restricted to CLIENT+NET_PARTICIPANT */
1435 CALLBACK(rend_cache_failure_clean, NET_PARTICIPANT, FL(RUN_ON_DISABLE)),
1436
1437 /* Directory server only. */
1438 CALLBACK(clean_consdiffmgr, DIRSERVER, 0),
1439
1440 /* Controller with per-second events only. */
1441 CALLBACK(control_per_second_events, CONTROLEV, 0),
1442
1443 END_OF_PERIODIC_EVENTS
1444};
1445#ifndef COCCI
1446#undef CALLBACK
1447#undef FL
1448#endif
1449
1450/* These are pointers to members of periodic_events[] that are used to
1451 * implement particular callbacks. We keep them separate here so that we
1452 * can access them by name. We also keep them inside periodic_events[]
1453 * so that we can implement "reset all timers" in a reasonable way. */
1454static periodic_event_item_t *fetch_networkstatus_event=NULL;
1455static periodic_event_item_t *launch_descriptor_fetches_event=NULL;
1456static periodic_event_item_t *check_dns_honesty_event=NULL;
1457static periodic_event_item_t *save_state_event=NULL;
1458static periodic_event_item_t *prune_old_routers_event=NULL;
1459
1460/** Reset all the periodic events so we'll do all our actions again as if we
1461 * just started up.
1462 * Useful if our clock just moved back a long time from the future,
1463 * so we don't wait until that future arrives again before acting.
1464 */
1465void
1467{
1469}
1470
1471/** Return a bitmask of the roles this tor instance is configured for using
1472 * the given options. */
1473STATIC int
1475{
1476 tor_assert(options);
1477
1478 int roles = PERIODIC_EVENT_ROLE_ALL;
1479 int is_bridge = options->BridgeRelay;
1480 int is_relay = server_mode(options);
1481 int is_dirauth = authdir_mode_v3(options);
1482 int is_bridgeauth = authdir_mode_bridge(options);
1483 int is_hidden_service = !!hs_service_get_num_services();
1484 int is_dirserver = dir_server_mode(options);
1485 int sending_control_events = control_any_per_second_event_enabled();
1486
1487 /* We also consider tor to have the role of a client if the ControlPort is
1488 * set because a lot of things can be done over the control port which
1489 * requires tor to have basic functionalities. */
1490 int is_client = options_any_client_port_set(options) ||
1491 options->ControlPort_set ||
1492 options->OwningControllerFD != UINT64_MAX;
1493
1494 int is_net_participant = is_participating_on_network() ||
1495 is_relay || is_hidden_service;
1496
1497 if (is_bridge) roles |= PERIODIC_EVENT_ROLE_BRIDGE;
1498 if (is_client) roles |= PERIODIC_EVENT_ROLE_CLIENT;
1499 if (is_relay) roles |= PERIODIC_EVENT_ROLE_RELAY;
1500 if (is_dirauth) roles |= PERIODIC_EVENT_ROLE_DIRAUTH;
1501 if (is_bridgeauth) roles |= PERIODIC_EVENT_ROLE_BRIDGEAUTH;
1502 if (is_hidden_service) roles |= PERIODIC_EVENT_ROLE_HS_SERVICE;
1503 if (is_dirserver) roles |= PERIODIC_EVENT_ROLE_DIRSERVER;
1504 if (is_net_participant) roles |= PERIODIC_EVENT_ROLE_NET_PARTICIPANT;
1505 if (sending_control_events) roles |= PERIODIC_EVENT_ROLE_CONTROLEV;
1506
1507 return roles;
1508}
1509
1510/** Event to run initialize_periodic_events_cb */
1511static struct event *initialize_periodic_events_event = NULL;
1512
1513/** Helper, run one second after setup:
1514 * Initializes all members of periodic_events and starts them running.
1515 *
1516 * (We do this one second after setup for backward-compatibility reasons;
1517 * it might not actually be necessary.) */
1518static void
1519initialize_periodic_events_cb(evutil_socket_t fd, short events, void *data)
1520{
1521 (void) fd;
1522 (void) events;
1523 (void) data;
1524
1525 tor_event_free(initialize_periodic_events_event);
1526
1528}
1529
1530/** Set up all the members of mainloop_periodic_events[], and configure them
1531 * all to be launched from a callback. */
1532void
1534{
1536 return;
1537
1539
1540 for (int i = 0; mainloop_periodic_events[i].name; ++i) {
1541 periodic_events_register(&mainloop_periodic_events[i]);
1542 }
1543
1544 /* Set up all periodic events. We'll launch them by roles. */
1545
1546#ifndef COCCI
1547#define NAMED_CALLBACK(name) \
1548 STMT_BEGIN name ## _event = periodic_events_find( #name ); STMT_END
1549#endif
1550
1551 NAMED_CALLBACK(prune_old_routers);
1552 NAMED_CALLBACK(fetch_networkstatus);
1553 NAMED_CALLBACK(launch_descriptor_fetches);
1554 NAMED_CALLBACK(check_dns_honesty);
1555 NAMED_CALLBACK(save_state);
1556}
1557
1558STATIC void
1559teardown_periodic_events(void)
1560{
1562 fetch_networkstatus_event = NULL;
1563 launch_descriptor_fetches_event = NULL;
1564 check_dns_honesty_event = NULL;
1565 save_state_event = NULL;
1566 prune_old_routers_event = NULL;
1568}
1569
1570static mainloop_event_t *rescan_periodic_events_ev = NULL;
1571
1572/** Callback: rescan the periodic event list. */
1573static void
1575{
1576 (void)event;
1577 (void)arg;
1579}
1580
1581/**
1582 * Schedule an event that will rescan which periodic events should run.
1583 **/
1584MOCK_IMPL(void,
1586{
1587 if (!rescan_periodic_events_ev) {
1588 rescan_periodic_events_ev =
1590 }
1591 mainloop_event_activate(rescan_periodic_events_ev);
1592}
1593
1594/** Do a pass at all our periodic events, disable those we don't need anymore
1595 * and enable those we need now using the given options. */
1596void
1598{
1599 tor_assert(options);
1600
1602}
1603
1604/* We just got new options globally set, see if we need to enabled or disable
1605 * periodic events. */
1606void
1607periodic_events_on_new_options(const or_options_t *options)
1608{
1609 rescan_periodic_events(options);
1610}
1611
1612/**
1613 * Update our schedule so that we'll check whether we need to fetch directory
1614 * info immediately.
1615 */
1616void
1618{
1619 tor_assert(fetch_networkstatus_event);
1620 tor_assert(launch_descriptor_fetches_event);
1621
1622 periodic_event_reschedule(fetch_networkstatus_event);
1623 periodic_event_reschedule(launch_descriptor_fetches_event);
1624}
1625
1626/** Mainloop callback: clean up circuits, channels, and connections
1627 * that are pending close. */
1628static void
1630{
1631 (void)ev;
1632 (void)arg;
1637}
1638
1639/** Event to run postloop_cleanup_cb */
1641
1642/** Schedule a post-loop event to clean up marked channels, connections, and
1643 * circuits. */
1644void
1646{
1647 if (PREDICT_UNLIKELY(postloop_cleanup_ev == NULL)) {
1648 // (It's possible that we can get here if we decide to close a connection
1649 // in the earliest stages of our configuration, before we create events.)
1650 return;
1651 }
1653}
1654
1655/** Event to run 'scheduled_shutdown_cb' */
1657
1658/** Callback: run a scheduled shutdown */
1659static void
1661{
1662 (void)ev;
1663 (void)arg;
1664 log_notice(LD_GENERAL, "Clean shutdown finished. Exiting.");
1666}
1667
1668/** Schedule the mainloop to exit after <b>delay_sec</b> seconds. */
1669void
1671{
1672 const struct timeval delay_tv = { delay_sec, 0 };
1673 if (! scheduled_shutdown_ev) {
1675 }
1677}
1678
1679/**
1680 * Update vanguards-lite layer2 nodes, once every 15 minutes
1681 */
1682static int
1683manage_vglite_callback(time_t now, const or_options_t *options)
1684{
1685 (void)now;
1686 (void)options;
1687#define VANGUARDS_LITE_INTERVAL (15*60)
1688
1690
1691 return VANGUARDS_LITE_INTERVAL;
1692}
1693
1694/** Perform regular maintenance tasks. This function gets run once per
1695 * second.
1696 */
1697static int
1698second_elapsed_callback(time_t now, const or_options_t *options)
1699{
1700 /* 0. See if our bandwidth limits are exhausted and we should hibernate
1701 *
1702 * Note: we have redundant mechanisms to handle the case where it's
1703 * time to wake up from hibernation; or where we have a scheduled
1704 * shutdown and it's time to run it, but this will also handle those.
1705 */
1707
1708 /* Maybe enough time elapsed for us to reconsider a circuit. */
1710
1711 if (options->UseBridges && !net_is_disabled()) {
1712 /* Note: this check uses net_is_disabled(), not should_delay_dir_fetches()
1713 * -- the latter is only for fetching consensus-derived directory info. */
1714 // TODO: client
1715 // Also, schedule this rather than probing 1x / sec
1716 fetch_bridge_descriptors(options, now);
1717 }
1718
1719 if (accounting_is_enabled(options)) {
1720 // TODO: refactor or rewrite?
1722 }
1723
1724 /* 3a. Every second, we examine pending circuits and prune the
1725 * ones which have been pending for more than a few seconds.
1726 * We do this before step 4, so it can try building more if
1727 * it's not comfortable with the number of available circuits.
1728 */
1729 /* (If our circuit build timeout can ever become lower than a second (which
1730 * it can't, currently), we should do this more often.) */
1731 // TODO: All expire stuff can become NET_PARTICIPANT, RUN_ON_DISABLE
1734
1735 /* 3b. Also look at pending streams and prune the ones that 'began'
1736 * a long time ago but haven't gotten a 'connected' yet.
1737 * Do this before step 4, so we can put them back into pending
1738 * state to be picked up by the new circuit.
1739 */
1741
1742 /* 3c. And expire connections that we've held open for too long.
1743 */
1745
1746 /* 4. Every second, we try a new circuit if there are no valid
1747 * circuits. Every NewCircuitPeriod seconds, we expire circuits
1748 * that became dirty more than MaxCircuitDirtiness seconds ago,
1749 * and we make a new circ if there are no clean circuits.
1750 */
1751 const int have_dir_info = router_have_minimum_dir_info();
1752 if (have_dir_info && !net_is_disabled()) {
1754 } else {
1756 }
1757
1758 /* 5. We do housekeeping for each connection... */
1760 int i;
1761 for (i=0;i<smartlist_len(connection_array);i++) {
1763 }
1764
1765 /* Run again in a second. */
1766 return 1;
1767}
1768
1769/**
1770 * Periodic callback: Every {LAZY,GREEDY}_DESCRIPTOR_RETRY_INTERVAL,
1771 * see about fetching descriptors, microdescriptors, and extrainfo
1772 * documents.
1773 */
1774static int
1776{
1777 if (should_delay_dir_fetches(options, NULL))
1778 return PERIODIC_EVENT_NO_UPDATE;
1779
1784 else
1786}
1787
1788/**
1789 * Periodic event: Rotate our X.509 certificates and TLS keys once every
1790 * MAX_SSL_KEY_LIFETIME_INTERNAL.
1791 */
1792static int
1794{
1795 static int first = 1;
1796 (void)now;
1797 (void)options;
1798 if (first) {
1799 first = 0;
1801 }
1802
1803 /* 1b. Every MAX_SSL_KEY_LIFETIME_INTERNAL seconds, we change our
1804 * TLS context. */
1805 log_info(LD_GENERAL,"Rotating tls context.");
1807 log_err(LD_BUG, "Error reinitializing TLS context");
1808 tor_assert_unreached();
1809 }
1810 if (generate_ed_link_cert(options, now, 1)) {
1811 log_err(LD_OR, "Unable to update Ed25519->TLS link certificate for "
1812 "new TLS context.");
1813 tor_assert_unreached();
1814 }
1815
1816 /* We also make sure to rotate the TLS connections themselves if they've
1817 * been up for too long -- but that's done via is_bad_for_new_circs in
1818 * run_connection_housekeeping() above. */
1820}
1821
1822/**
1823 * Periodic callback: once an hour, grab some more entropy from the
1824 * kernel and feed it to our CSPRNG.
1825 **/
1826static int
1827add_entropy_callback(time_t now, const or_options_t *options)
1828{
1829 (void)now;
1830 (void)options;
1831 /* We already seeded once, so don't die on failure. */
1832 if (crypto_seed_rng() < 0) {
1833 log_warn(LD_GENERAL, "Tried to re-seed RNG, but failed. We already "
1834 "seeded once, though, so we won't exit here.");
1835 }
1836
1837 /** How often do we add more entropy to OpenSSL's RNG pool? */
1838#define ENTROPY_INTERVAL (60*60)
1839 return ENTROPY_INTERVAL;
1840}
1841
1842/** Periodic callback: if there has been no network usage in a while,
1843 * enter a dormant state. */
1844STATIC int
1846{
1847 /* If we're a server, we can't become dormant. */
1848 if (server_mode(options)) {
1849 goto found_activity;
1850 }
1851
1852 /* If we aren't allowed to become dormant, then participation doesn't
1853 matter */
1854 if (! options->DormantTimeoutEnabled) {
1855 goto found_activity;
1856 }
1857
1858 /* If we're running an onion service, we can't become dormant. */
1859 /* XXXX this would be nice to change, so that we can be dormant with a
1860 * service. */
1862 goto found_activity;
1863 }
1864
1865 /* If we have any currently open entry streams other than "linked"
1866 * connections used for directory requests, those count as user activity.
1867 */
1870 goto found_activity;
1871 }
1872 }
1873
1874 /* XXXX Make this configurable? */
1875/** How often do we check whether we have had network activity? */
1876#define CHECK_PARTICIPATION_INTERVAL (5*60)
1877
1878 /* Become dormant if there has been no user activity in a long time.
1879 * (The funny checks below are in order to prevent overflow.) */
1880 time_t time_since_last_activity = 0;
1881 if (get_last_user_activity_time() < now)
1882 time_since_last_activity = now - get_last_user_activity_time();
1883 if (time_since_last_activity >= options->DormantClientTimeout) {
1884 log_notice(LD_GENERAL, "No user activity in a long time: becoming"
1885 " dormant.");
1887 rescan_periodic_events(options);
1888 }
1889
1890 return CHECK_PARTICIPATION_INTERVAL;
1891
1892 found_activity:
1893 note_user_activity(now);
1894 return CHECK_PARTICIPATION_INTERVAL;
1895}
1896
1897/**
1898 * Periodic callback: If our consensus is too old, recalculate whether
1899 * we can actually use it.
1900 */
1901static int
1903{
1904 (void)options;
1905 /* Check whether our networkstatus has expired. */
1907 /* Use reasonably live consensuses until they are no longer reasonably live.
1908 */
1909 if (ns && !networkstatus_consensus_reasonably_live(ns, now) &&
1912 }
1913#define CHECK_EXPIRED_NS_INTERVAL (2*60)
1914 return CHECK_EXPIRED_NS_INTERVAL;
1915}
1916
1917/**
1918 * Scheduled callback: Save the state file to disk if appropriate.
1919 */
1920static int
1921save_state_callback(time_t now, const or_options_t *options)
1922{
1923 (void) options;
1924 (void) or_state_save(now); // only saves if appropriate
1925 const time_t next_write = get_or_state()->next_write;
1926 if (next_write == TIME_MAX) {
1927 return 86400;
1928 }
1929 return safe_timer_diff(now, next_write);
1930}
1931
1932/** Reschedule the event for saving the state file.
1933 *
1934 * Run this when the state becomes dirty. */
1935void
1937{
1938 if (save_state_event == NULL) {
1939 /* This can happen early on during startup. */
1940 return;
1941 }
1942 periodic_event_reschedule(save_state_event);
1943}
1944
1945/**
1946 * Periodic callback: Write statistics to disk if appropriate.
1947 */
1948static int
1949write_stats_file_callback(time_t now, const or_options_t *options)
1950{
1951 /* 1g. Check whether we should write statistics to disk.
1952 */
1953#define CHECK_WRITE_STATS_INTERVAL (60*60)
1954 time_t next_time_to_write_stats_files = now + CHECK_WRITE_STATS_INTERVAL;
1955 if (options->CellStatistics) {
1956 time_t next_write =
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->DirReqStatistics) {
1962 time_t next_write = geoip_dirreq_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 if (options->EntryStatistics) {
1967 time_t next_write = geoip_entry_stats_write(now);
1968 if (next_write && next_write < next_time_to_write_stats_files)
1969 next_time_to_write_stats_files = next_write;
1970 }
1971 if (options->HiddenServiceStatistics) {
1972 time_t next_write = rep_hist_hs_stats_write(now, false);
1973 if (next_write && next_write < next_time_to_write_stats_files)
1974 next_time_to_write_stats_files = next_write;
1975
1976 next_write = rep_hist_hs_stats_write(now, true);
1977 if (next_write && next_write < next_time_to_write_stats_files)
1978 next_time_to_write_stats_files = next_write;
1979 }
1980 if (options->ExitPortStatistics) {
1981 time_t next_write = rep_hist_exit_stats_write(now);
1982 if (next_write && next_write < next_time_to_write_stats_files)
1983 next_time_to_write_stats_files = next_write;
1984 }
1985 if (options->ConnDirectionStatistics) {
1986 time_t next_write = conn_stats_save(now);
1987 if (next_write && next_write < next_time_to_write_stats_files)
1988 next_time_to_write_stats_files = next_write;
1989 }
1990 if (options->BridgeAuthoritativeDir) {
1991 time_t next_write = rep_hist_desc_stats_write(now);
1992 if (next_write && next_write < next_time_to_write_stats_files)
1993 next_time_to_write_stats_files = next_write;
1994 }
1995
1996 return safe_timer_diff(now, next_time_to_write_stats_files);
1997}
1998
1999static int
2000reset_padding_counts_callback(time_t now, const or_options_t *options)
2001{
2002 if (options->PaddingStatistics) {
2003 rep_hist_prep_published_padding_counts(now);
2004 }
2005
2008}
2009
2010static int should_init_bridge_stats = 1;
2011
2012/**
2013 * Periodic callback: Write bridge statistics to disk if appropriate.
2014 */
2015static int
2017{
2018 /* 1h. Check whether we should write bridge statistics to disk.
2019 */
2020 if (should_record_bridge_info(options)) {
2021 if (should_init_bridge_stats) {
2022 /* (Re-)initialize bridge statistics. */
2024 should_init_bridge_stats = 0;
2025 return WRITE_STATS_INTERVAL;
2026 } else {
2027 /* Possibly write bridge statistics to disk and ask when to write
2028 * them next time. */
2029 time_t next = geoip_bridge_stats_write(now);
2030 return safe_timer_diff(now, next);
2031 }
2032 } else if (!should_init_bridge_stats) {
2033 /* Bridge mode was turned off. Ensure that stats are re-initialized
2034 * next time bridge mode is turned on. */
2035 should_init_bridge_stats = 1;
2036 }
2037 return PERIODIC_EVENT_NO_UPDATE;
2038}
2039
2040/**
2041 * Periodic callback: Clean in-memory caches every once in a while
2042 */
2043static int
2044clean_caches_callback(time_t now, const or_options_t *options)
2045{
2046 /* Remove old information from rephist and the rend cache. */
2047 rep_history_clean(now - options->RephistTrackTime);
2050 microdesc_cache_rebuild(NULL, 0);
2051#define CLEAN_CACHES_INTERVAL (30*60)
2052 return CLEAN_CACHES_INTERVAL;
2053}
2054
2055/**
2056 * Periodic callback: Clean the cache of failed hidden service lookups
2057 * frequently.
2058 */
2059static int
2061{
2062 (void)options;
2063 /* We don't keep entries that are more than five minutes old so we try to
2064 * clean it as soon as we can since we want to make sure the client waits
2065 * as little as possible for reachability reasons. */
2067 return 30;
2068}
2069
2070/**
2071 * Periodic callback: prune routerlist of old information about Tor network.
2072 */
2073static int
2074prune_old_routers_callback(time_t now, const or_options_t *options)
2075{
2076#define ROUTERLIST_PRUNING_INTERVAL (60*60) // 1 hour.
2077 (void)now;
2078 (void)options;
2079
2080 if (!net_is_disabled()) {
2081 /* If any networkstatus documents are no longer recent, we need to
2082 * update all the descriptors' running status. */
2083 /* Remove dead routers. */
2084 log_debug(LD_GENERAL, "Pruning routerlist...");
2086 }
2087
2088 return ROUTERLIST_PRUNING_INTERVAL;
2089}
2090
2091/**
2092 * Periodic event: once a minute, (or every second if TestingTorNetwork, or
2093 * during client bootstrap), check whether we want to download any
2094 * networkstatus documents. */
2095static int
2097{
2098 /* How often do we check whether we should download network status
2099 * documents? */
2100 const int we_are_bootstrapping = networkstatus_consensus_is_bootstrapping(
2101 now);
2102 const int prefer_mirrors = !dirclient_fetches_from_authorities(
2103 get_options());
2104 int networkstatus_dl_check_interval = 60;
2105 /* check more often when testing, or when bootstrapping from mirrors
2106 * (connection limits prevent too many connections being made) */
2107 if (options->TestingTorNetwork
2108 || (we_are_bootstrapping && prefer_mirrors)) {
2109 networkstatus_dl_check_interval = 1;
2110 }
2111
2112 if (should_delay_dir_fetches(options, NULL))
2113 return PERIODIC_EVENT_NO_UPDATE;
2114
2116 return networkstatus_dl_check_interval;
2117}
2118
2119/**
2120 * Periodic callback: Every 60 seconds, we relaunch listeners if any died. */
2121static int
2122retry_listeners_callback(time_t now, const or_options_t *options)
2123{
2124 (void)now;
2125 (void)options;
2126 if (!net_is_disabled()) {
2127 retry_all_listeners(NULL, 0);
2128 return 60;
2129 }
2130 return PERIODIC_EVENT_NO_UPDATE;
2131}
2132
2133static int heartbeat_callback_first_time = 1;
2134
2135/**
2136 * Periodic callback: write the heartbeat message in the logs.
2137 *
2138 * If writing the heartbeat message to the logs fails for some reason, retry
2139 * again after <b>MIN_HEARTBEAT_PERIOD</b> seconds.
2140 */
2141static int
2142heartbeat_callback(time_t now, const or_options_t *options)
2143{
2144 /* Check if heartbeat is disabled */
2145 if (!options->HeartbeatPeriod) {
2146 return PERIODIC_EVENT_NO_UPDATE;
2147 }
2148
2149 /* Skip the first one. */
2150 if (heartbeat_callback_first_time) {
2151 heartbeat_callback_first_time = 0;
2152 return options->HeartbeatPeriod;
2153 }
2154
2155 /* Write the heartbeat message */
2156 if (log_heartbeat(now) == 0) {
2157 return options->HeartbeatPeriod;
2158 } else {
2159 /* If we couldn't write the heartbeat log message, try again in the minimum
2160 * interval of time. */
2161 return MIN_HEARTBEAT_PERIOD;
2162 }
2163}
2164
2165#define CDM_CLEAN_CALLBACK_INTERVAL 600
2166static int
2167clean_consdiffmgr_callback(time_t now, const or_options_t *options)
2168{
2169 (void)now;
2170 if (dir_server_mode(options)) {
2172 }
2173 return CDM_CLEAN_CALLBACK_INTERVAL;
2174}
2175
2176/*
2177 * Periodic callback: Run scheduled events for HS service. This is called
2178 * every second.
2179 */
2180static int
2181hs_service_callback(time_t now, const or_options_t *options)
2182{
2183 (void) options;
2184
2185 /* We need to at least be able to build circuits and that we actually have
2186 * a working network. */
2190 goto end;
2191 }
2192
2194
2195 end:
2196 /* Every 1 second. */
2197 return 1;
2198}
2199
2200/*
2201 * Periodic callback: Send once-per-second events to the controller(s).
2202 * This is called every second.
2203 */
2204static int
2205control_per_second_events_callback(time_t now, const or_options_t *options)
2206{
2207 (void) options;
2208 (void) now;
2209
2211
2212 return 1;
2213}
2214
2215/** Last time that update_current_time was called. */
2216static time_t current_second = 0;
2217/** Last time that update_current_time updated current_second. */
2218static monotime_coarse_t current_second_last_changed;
2219
2220/**
2221 * Set the current time to "now", which should be the value returned by
2222 * time(). Check for clock jumps and track the total number of seconds we
2223 * have been running.
2224 */
2225void
2227{
2228 if (PREDICT_LIKELY(now == current_second)) {
2229 /* We call this function a lot. Most frequently, the current second
2230 * will not have changed, so we just return. */
2231 return;
2232 }
2233
2234 const time_t seconds_elapsed = current_second ? (now - current_second) : 0;
2235
2236 /* Check the wall clock against the monotonic clock, so we can
2237 * better tell idleness from clock jumps and/or other shenanigans. */
2238 monotime_coarse_t last_updated;
2239 memcpy(&last_updated, &current_second_last_changed, sizeof(last_updated));
2240 monotime_coarse_get(&current_second_last_changed);
2241
2242 /** How much clock jumping means that we should adjust our idea of when
2243 * to go dormant? */
2244#define NUM_JUMPED_SECONDS_BEFORE_NETSTATUS_UPDATE 20
2245
2246 /* Don't go dormant early or late just because we jumped in time. */
2247 if (ABS(seconds_elapsed) >= NUM_JUMPED_SECONDS_BEFORE_NETSTATUS_UPDATE) {
2249 netstatus_note_clock_jumped(seconds_elapsed);
2250 }
2251 }
2252
2253 /** How much clock jumping do we tolerate? */
2254#define NUM_JUMPED_SECONDS_BEFORE_WARN 100
2255
2256 /** How much idleness do we tolerate? */
2257#define NUM_IDLE_SECONDS_BEFORE_WARN 3600
2258
2259 if (seconds_elapsed < -NUM_JUMPED_SECONDS_BEFORE_WARN) {
2260 // moving back in time is always a bad sign.
2261 circuit_note_clock_jumped(seconds_elapsed, false);
2262
2263 } else if (seconds_elapsed >= NUM_JUMPED_SECONDS_BEFORE_WARN) {
2264 /* Compare the monotonic clock to the result of time(). */
2265 const int32_t monotime_msec_passed =
2266 monotime_coarse_diff_msec32(&last_updated,
2268 const int monotime_sec_passed = monotime_msec_passed / 1000;
2269 const int discrepancy = monotime_sec_passed - (int)seconds_elapsed;
2270 /* If the monotonic clock deviates from time(NULL), we have a couple of
2271 * possibilities. On some systems, this means we have been suspended or
2272 * sleeping. Everywhere, it can mean that the wall-clock time has
2273 * been changed -- for example, with settimeofday().
2274 *
2275 * On the other hand, if the monotonic time matches with the wall-clock
2276 * time, we've probably just been idle for a while, with no events firing.
2277 * we tolerate much more of that.
2278 */
2279 const bool clock_jumped = abs(discrepancy) > 2;
2280
2281 if (clock_jumped || seconds_elapsed >= NUM_IDLE_SECONDS_BEFORE_WARN) {
2282 circuit_note_clock_jumped(seconds_elapsed, ! clock_jumped);
2283 }
2284 } else if (seconds_elapsed > 0) {
2285 stats_n_seconds_working += seconds_elapsed;
2286 }
2287
2288 update_approx_time(now);
2289 current_second = now;
2290}
2291
2292#ifdef HAVE_SYSTEMD_209
2293static periodic_timer_t *systemd_watchdog_timer = NULL;
2294
2295/** Libevent callback: invoked to reset systemd watchdog. */
2296static void
2297systemd_watchdog_callback(periodic_timer_t *timer, void *arg)
2298{
2299 (void)timer;
2300 (void)arg;
2301 sd_notify(0, "WATCHDOG=1");
2302}
2303#endif /* defined(HAVE_SYSTEMD_209) */
2304
2305#define UPTIME_CUTOFF_FOR_NEW_BANDWIDTH_TEST (6*60*60)
2306
2307/** Called when our IP address seems to have changed. <b>on_client_conn</b>
2308 * should be true if:
2309 * - we detected a change in our interface address, using an outbound
2310 * connection, and therefore
2311 * - our client TLS keys need to be rotated.
2312 * Otherwise, it should be false, and:
2313 * - we detected a change in our published address
2314 * (using some other method), and therefore
2315 * - the published addresses in our descriptor need to change.
2316 */
2317void
2318ip_address_changed(int on_client_conn)
2319{
2320 const or_options_t *options = get_options();
2321 int server = server_mode(options);
2322
2323 if (on_client_conn) {
2324 if (! server) {
2325 /* Okay, change our keys. */
2326 if (init_keys_client() < 0)
2327 log_warn(LD_GENERAL, "Unable to rotate keys after IP change!");
2328 }
2329 } else {
2330 if (server) {
2331 if (get_uptime() > UPTIME_CUTOFF_FOR_NEW_BANDWIDTH_TEST)
2333 reset_uptime();
2335 /* All relays include their IP addresses as their ORPort addresses in
2336 * their descriptor.
2337 * Exit relays also incorporate interface addresses in their exit
2338 * policies, when ExitPolicyRejectLocalInterfaces is set. */
2339 mark_my_descriptor_dirty("IP address changed");
2340 }
2341 }
2342
2344}
2345
2346/** Forget what we've learned about the correctness of our DNS servers, and
2347 * start learning again. */
2348void
2350{
2351 if (server_mode(get_options())) {
2353 if (check_dns_honesty_event) {
2354 periodic_event_reschedule(check_dns_honesty_event);
2355 }
2356 }
2357}
2358
2359/** Initialize some mainloop_event_t objects that we require. */
2360void
2362{
2366 }
2367 if (!postloop_cleanup_ev) {
2370 }
2371}
2372
2373/** Tor main loop. */
2374int
2376{
2377 /* initialize the periodic events first, so that code that depends on the
2378 * events being present does not assert.
2379 */
2382
2384
2385 struct timeval one_second = { 1, 0 };
2386 initialize_periodic_events_event = tor_evtimer_new(
2389 event_add(initialize_periodic_events_event, &one_second);
2390
2391#ifdef HAVE_SYSTEMD_209
2392 uint64_t watchdog_delay;
2393 /* set up systemd watchdog notification. */
2394 if (sd_watchdog_enabled(1, &watchdog_delay) > 0) {
2395 if (! systemd_watchdog_timer) {
2396 struct timeval watchdog;
2397 /* The manager will "act on" us if we don't send them a notification
2398 * every 'watchdog_delay' microseconds. So, send notifications twice
2399 * that often. */
2400 watchdog_delay /= 2;
2401 watchdog.tv_sec = watchdog_delay / 1000000;
2402 watchdog.tv_usec = watchdog_delay % 1000000;
2403
2404 systemd_watchdog_timer = periodic_timer_new(tor_libevent_get_base(),
2405 &watchdog,
2406 systemd_watchdog_callback,
2407 NULL);
2408 tor_assert(systemd_watchdog_timer);
2409 }
2410 }
2411#endif /* defined(HAVE_SYSTEMD_209) */
2412#ifdef ENABLE_RESTART_DEBUGGING
2413 {
2414 static int first_time = 1;
2415
2416 if (first_time && getenv("TOR_DEBUG_RESTART")) {
2417 first_time = 0;
2418 const char *sec_str = getenv("TOR_DEBUG_RESTART_AFTER_SECONDS");
2419 long sec;
2420 int sec_ok=0;
2421 if (sec_str &&
2422 (sec = tor_parse_long(sec_str, 10, 0, INT_MAX, &sec_ok, NULL)) &&
2423 sec_ok) {
2424 /* Okay, we parsed the seconds. */
2425 } else {
2426 sec = 5;
2427 }
2428 struct timeval restart_after = { (time_t) sec, 0 };
2429 tor_shutdown_event_loop_for_restart_event =
2430 tor_evtimer_new(tor_libevent_get_base(),
2431 tor_shutdown_event_loop_for_restart_cb, NULL);
2432 event_add(tor_shutdown_event_loop_for_restart_event, &restart_after);
2433 }
2434 }
2435#endif /* defined(ENABLE_RESTART_DEBUGGING) */
2436
2437 return run_main_loop_until_done();
2438}
2439
2440#ifndef _WIN32
2441/** Rate-limiter for EINVAL-type libevent warnings. */
2442static ratelim_t libevent_error_ratelim = RATELIM_INIT(10);
2443#endif
2444
2445/**
2446 * Run the main loop a single time. Return 0 for "exit"; -1 for "exit with
2447 * error", and 1 for "run this again."
2448 */
2449static int
2451{
2452 int loop_result;
2453
2454 if (nt_service_is_stopping())
2455 return 0;
2456
2458 return 0;
2459
2460#ifndef _WIN32
2461 /* Make it easier to tell whether libevent failure is our fault or not. */
2462 errno = 0;
2463#endif
2464
2465 if (get_options()->MainloopStats) {
2466 /* We always enforce that EVLOOP_ONCE is passed to event_base_loop() if we
2467 * are collecting main loop statistics. */
2468 called_loop_once = 1;
2469 } else {
2470 called_loop_once = 0;
2471 }
2472
2473 /* Make sure we know (about) what time it is. */
2474 update_approx_time(time(NULL));
2475
2476 /* Here it is: the main loop. Here we tell Libevent to poll until we have
2477 * an event, or the second ends, or until we have some active linked
2478 * connections to trigger events for. Libevent will wait till one
2479 * of these happens, then run all the appropriate callbacks. */
2482
2483 if (get_options()->MainloopStats) {
2484 /* Update our main loop counters. */
2485 if (loop_result == 0) {
2486 // The call was successful.
2488 } else if (loop_result == -1) {
2489 // The call was erroneous.
2491 } else if (loop_result == 1) {
2492 // The call didn't have any active or pending events
2493 // to handle.
2495 }
2496 }
2497
2498 /* Oh, the loop failed. That might be an error that we need to
2499 * catch, but more likely, it's just an interrupted poll() call or something,
2500 * and we should try again. */
2501 if (loop_result < 0) {
2502 int e = tor_socket_errno(-1);
2503 /* let the program survive things like ^z */
2504 if (e != EINTR && !ERRNO_IS_EINPROGRESS(e)) {
2505 log_err(LD_NET,"libevent call with %s failed: %s [%d]",
2506 tor_libevent_get_method(), tor_socket_strerror(e), e);
2507 return -1;
2508#ifndef _WIN32
2509 } else if (e == EINVAL) {
2511 "EINVAL from libevent: should you upgrade libevent?");
2513 log_err(LD_NET, "Too many libevent errors, too fast: dying");
2514 return -1;
2515 }
2516#endif /* !defined(_WIN32) */
2517 } else {
2518 tor_assert_nonfatal_once(! ERRNO_IS_EINPROGRESS(e));
2519 log_debug(LD_NET,"libevent call interrupted.");
2520 /* You can't trust the results of this poll(). Go back to the
2521 * top of the big for loop. */
2522 return 1;
2523 }
2524 }
2525
2527 return 0;
2528
2529 return 1;
2530}
2531
2532/** Run the run_main_loop_once() function until it declares itself done,
2533 * and return its final return value.
2534 *
2535 * Shadow won't invoke this function, so don't fill it up with things.
2536 */
2537STATIC int
2539{
2540 int loop_result = 1;
2541
2544
2545 do {
2546 loop_result = run_main_loop_once();
2547 } while (loop_result == 1);
2548
2550 return main_loop_exit_value;
2551 else
2552 return loop_result;
2553}
2554
2555/** Returns Tor's uptime. */
2556MOCK_IMPL(long,
2558{
2560}
2561
2562/** Reset Tor's uptime. */
2563MOCK_IMPL(void,
2565{
2567}
2568
2569void
2570tor_mainloop_free_all(void)
2571{
2572 smartlist_free(connection_array);
2573 smartlist_free(closeable_connection_lst);
2574 smartlist_free(active_linked_connection_lst);
2575 teardown_periodic_events();
2576 tor_event_free(shutdown_did_not_work_event);
2577 tor_event_free(initialize_periodic_events_event);
2578 mainloop_event_free(directory_all_unreachable_cb_event);
2579 mainloop_event_free(schedule_active_linked_connections_event);
2580 mainloop_event_free(postloop_cleanup_ev);
2581 mainloop_event_free(handle_deferred_signewnym_ev);
2582 mainloop_event_free(scheduled_shutdown_ev);
2583 mainloop_event_free(rescan_periodic_events_ev);
2584
2585#ifdef HAVE_SYSTEMD_209
2586 periodic_timer_free(systemd_watchdog_timer);
2587#endif
2588
2590
2591 memset(&global_bucket, 0, sizeof(global_bucket));
2592 memset(&global_relayed_bucket, 0, sizeof(global_relayed_bucket));
2596 newnym_epoch = 0;
2597 called_loop_once = 0;
2601 quiet_level = 0;
2602 should_init_bridge_stats = 1;
2603 heartbeat_callback_first_time = 1;
2604 current_second = 0;
2605 memset(&current_second_last_changed, 0,
2607}
#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:772
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:2890
void channel_run_cleanup(void)
Definition: channel.c:2140
void channel_update_bad_for_new_circs(const char *digest, int force)
Definition: channel.c:3463
void channel_listener_run_cleanup(void)
Definition: channel.c:2166
unsigned int channel_num_circuits(channel_t *chan)
Definition: channel.c:3341
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:681
void circuit_mark_all_dirty_circs_as_unusable(void)
Definition: circuitlist.c:2106
void circuit_mark_all_unused_circs(void)
Definition: circuitlist.c:2087
Header file for circuitlist.c.
void circuit_expire_waiting_for_better_guard(void)
Definition: circuituse.c:828
void circuit_expire_old_circs_as_needed(time_t now)
Definition: circuituse.c:1321
void reset_bandwidth_test(void)
Definition: circuituse.c:1582
void circuit_expire_building(void)
Definition: circuituse.c:445
void circuit_build_needed_circs(time_t now)
Definition: circuituse.c:1298
Header file for circuituse.c.
#define ABS(x)
Definition: cmp.h:40
bool tor_libevent_is_initialized(void)
void tor_libevent_exit_loop_after_callback(struct event_base *base)
int tor_libevent_run_event_loop(struct event_base *base, int once)
mainloop_event_t * mainloop_event_postloop_new(void(*cb)(mainloop_event_t *, void *), void *userdata)
int mainloop_event_schedule(mainloop_event_t *event, const struct timeval *tv)
periodic_timer_t * periodic_timer_new(struct event_base *base, const struct timeval *tv, void(*cb)(periodic_timer_t *timer, void *data), void *data)
const char * tor_libevent_get_method(void)
struct event_base * tor_libevent_get_base(void)
mainloop_event_t * mainloop_event_new(void(*cb)(mainloop_event_t *, void *), void *userdata)
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:352
const char * escaped_safe_str_client(const char *address)
Definition: config.c:1136
int quiet
Definition: config.c:2470
int options_any_client_port_set(const or_options_t *options)
Definition: config.c:7544
const or_options_t * get_options(void)
Definition: config.c:944
Header file for config.c.
#define MIN_HEARTBEAT_PERIOD
Definition: config.h:25
connection_t * connection_get_by_type_nonlinked(int type)
Definition: connection.c:4939
int connection_wants_to_flush(connection_t *conn)
Definition: connection.c:4351
int connection_is_moribund(connection_t *conn)
Definition: connection.c:5523
void connection_consider_empty_write_buckets(connection_t *conn)
Definition: connection.c:3808
void connection_close_immediate(connection_t *conn)
Definition: connection.c:1055
const char * conn_type_to_string(int type)
Definition: connection.c:270
void assert_connection_ok(connection_t *conn, time_t now)
Definition: connection.c:5673
int connection_process_inbuf(connection_t *conn, int package_partial)
Definition: connection.c:5215
ssize_t connection_bucket_write_limit(connection_t *conn, time_t now)
Definition: connection.c:3540
int retry_all_listeners(smartlist_t *new_conns, int close_all_noncontrol)
Definition: connection.c:3253
int connection_state_is_open(connection_t *conn)
Definition: connection.c:5058
connection_t * connection_get_by_type_state(int type, int state)
Definition: connection.c:4929
void log_failed_proxy_connection(connection_t *conn)
Definition: connection.c:5879
void connection_write_bw_exhausted(connection_t *conn, bool is_global_bw)
Definition: connection.c:3765
void connection_about_to_close_connection(connection_t *conn)
Definition: connection.c:1024
void connection_expire_held_open(void)
Definition: connection.c:1175
const char * conn_state_to_string(int type, int state)
Definition: connection.c:304
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)
entry_connection_t * TO_ENTRY_CONN(connection_t *c)
edge_connection_t * TO_EDGE_CONN(connection_t *c)
Header file for connection_edge.c.
#define AP_CONN_STATE_CIRCUIT_WAIT
or_connection_t * TO_OR_CONN(connection_t *c)
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)
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:454
Common functions for using (pseudo-)random number generators.
int connection_dir_reached_eof(dir_connection_t *conn)
Definition: dirclient.c:2847
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:2153
void assert_connection_edge_not_dns_pending(edge_connection_t *conn)
Definition: dns.c:966
Header file for dns.c.
void dnsserv_close_listener(connection_t *conn)
Definition: dnsserv.c:410
Header file for dnsserv.c.
Entry connection structure.
void purge_vanguards_lite(void)
Definition: entrynodes.c:4288
void maintain_layer2_guards(void)
Definition: entrynodes.c:4183
int guards_update_all(void)
Definition: entrynodes.c:3851
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:1003
void hs_cache_clean_as_client(time_t now)
Definition: hs_cache.c:944
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:2752
Header file containing client data for the HS subsystem.
unsigned int hs_service_get_num_services(void)
Definition: hs_service.c:4229
void hs_service_run_scheduled_events(time_t now)
Definition: hs_service.c:4663
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:591
#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:2218
static struct event * initialize_periodic_events_event
Definition: mainloop.c:1511
void stats_increment_bytes_read_and_written(uint64_t r, uint64_t w)
Definition: mainloop.c:475
#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:485
void dns_servers_relaunch_checks(void)
Definition: mainloop.c:2349
STATIC int check_network_participation_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:1845
static int add_entropy_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:1827
static int periodic_events_initialized
Definition: mainloop.c:1357
static int rend_cache_failure_clean_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:2060
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:880
static int clean_caches_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:2044
static int main_loop_exit_value
Definition: mainloop.c:182
static mainloop_event_t * schedule_active_linked_connections_event
Definition: mainloop.c:370
static mainloop_event_t * scheduled_shutdown_ev
Definition: mainloop.c:1656
static void increment_main_loop_success_count(void)
Definition: mainloop.c:519
static void rescan_periodic_events_cb(mainloop_event_t *event, void *arg)
Definition: mainloop.c:1574
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:1660
void note_that_we_maybe_cant_complete_circuits(void)
Definition: mainloop.c:234
void connection_stop_reading(connection_t *conn)
Definition: mainloop.c:601
static smartlist_t * active_linked_connection_lst
Definition: mainloop.c:170
void connection_stop_reading_from_linked_conn(connection_t *conn)
Definition: mainloop.c:828
int connection_in_array(connection_t *conn)
Definition: mainloop.c:434
static struct event * shutdown_did_not_work_event
Definition: mainloop.c:736
int have_completed_a_circuit(void)
Definition: mainloop.c:218
void ip_address_changed(int on_client_conn)
Definition: mainloop.c:2318
static int retry_listeners_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:2122
void reset_uptime(void)
Definition: mainloop.c:2564
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:1949
void connection_unregister_events(connection_t *conn)
Definition: mainloop.c:275
void directory_all_unreachable(time_t now)
Definition: mainloop.c:1106
int connection_remove(connection_t *conn)
Definition: mainloop.c:289
void add_connection_to_closeable_list(connection_t *conn)
Definition: mainloop.c:416
STATIC void close_closeable_connections(void)
Definition: mainloop.c:846
void reschedule_directory_downloads(void)
Definition: mainloop.c:1617
uint64_t get_bytes_read(void)
Definition: mainloop.c:455
void initialize_periodic_events(void)
Definition: mainloop.c:1533
void mainloop_schedule_shutdown(int delay_sec)
Definition: mainloop.c:1670
int connection_is_on_closeable_list(connection_t *conn)
Definition: mainloop.c:427
static void connection_unlink(connection_t *conn)
Definition: mainloop.c:332
void connection_start_reading(connection_t *conn)
Definition: mainloop.c:623
static void increment_main_loop_idle_count(void)
Definition: mainloop.c:547
static int manage_vglite_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:1683
#define GREEDY_DESCRIPTOR_RETRY_INTERVAL
Definition: mainloop.c:194
void update_current_time(time_t now)
Definition: mainloop.c:2226
void do_signewnym(time_t now)
Definition: mainloop.c:1326
static int check_expired_networkstatus_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:1902
static int launch_descriptor_fetches_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:1775
void initialize_mainloop_events(void)
Definition: mainloop.c:2361
static int fetch_networkstatus_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:2096
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:1698
int do_main_loop(void)
Definition: mainloop.c:2375
int connection_is_writing(connection_t *conn)
Definition: mainloop.c:663
static void signewnym_impl(time_t now)
Definition: mainloop.c:1293
int connection_is_reading(const connection_t *conn)
Definition: mainloop.c:500
void schedule_rescan_periodic_events(void)
Definition: mainloop.c:1585
void connection_start_writing(connection_t *conn)
Definition: mainloop.c:696
static void run_connection_housekeeping(int i, time_t now)
Definition: mainloop.c:1165
uint64_t get_main_loop_error_count(void)
Definition: mainloop.c:540
static int connection_check_event(connection_t *conn, struct event *ev)
Definition: mainloop.c:563
static void shutdown_did_not_work_callback(evutil_socket_t fd, short event, void *arg) ATTR_NORETURN
Definition: mainloop.c:744
static void postloop_cleanup_cb(mainloop_event_t *ev, void *arg)
Definition: mainloop.c:1629
static int record_bridge_stats_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:2016
static int can_complete_circuits
Definition: mainloop.c:190
static long stats_n_seconds_working
Definition: mainloop.c:144
smartlist_t * get_connection_array(void)
Definition: mainloop.c:443
static int signewnym_is_pending
Definition: mainloop.c:157
uint64_t get_main_loop_idle_count(void)
Definition: mainloop.c:554
void reschedule_or_state_save(void)
Definition: mainloop.c:1936
static void schedule_active_linked_connections_cb(mainloop_event_t *event, void *arg)
Definition: mainloop.c:379
void tor_shutdown_event_loop_and_exit(int exitcode)
Definition: mainloop.c:773
static ratelim_t libevent_error_ratelim
Definition: mainloop.c:2442
static int conn_close_if_marked(int i)
Definition: mainloop.c:966
void tor_init_connection_lists(void)
Definition: mainloop.c:404
static time_t current_second
Definition: mainloop.c:2216
static void conn_write_callback(evutil_socket_t fd, short event, void *_conn)
Definition: mainloop.c:922
void reset_all_main_loop_timers(void)
Definition: mainloop.c:1466
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:1316
STATIC int get_my_roles(const or_options_t *options)
Definition: mainloop.c:1474
static mainloop_event_t * postloop_cleanup_ev
Definition: mainloop.c:1640
static int connection_should_read_from_linked_conn(connection_t *conn)
Definition: mainloop.c:724
int connection_count_moribund(void)
Definition: mainloop.c:862
uint64_t get_main_loop_success_count(void)
Definition: mainloop.c:526
static void connection_start_reading_from_linked_conn(connection_t *conn)
Definition: mainloop.c:810
void directory_info_has_arrived(time_t now, int from_cache, int suppress_logs)
Definition: mainloop.c:1124
void connection_stop_writing(connection_t *conn)
Definition: mainloop.c:673
uint64_t get_bytes_written(void)
Definition: mainloop.c:465
static int save_state_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:1921
static int run_main_loop_once(void)
Definition: mainloop.c:2450
static void increment_main_loop_error_count(void)
Definition: mainloop.c:533
static int heartbeat_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:2142
static uint64_t stats_n_main_loop_successes
Definition: mainloop.c:146
void reset_main_loop_counters(void)
Definition: mainloop.c:510
static uint64_t stats_n_main_loop_idle
Definition: mainloop.c:150
int tor_event_loop_shutdown_is_pending(void)
Definition: mainloop.c:801
static int rotate_x509_certificate_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:1793
static int called_loop_once
Definition: mainloop.c:174
long get_uptime(void)
Definition: mainloop.c:2557
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:1076
void mainloop_schedule_postloop_cleanup(void)
Definition: mainloop.c:1645
static void initialize_periodic_events_cb(evutil_socket_t fd, short events, void *data)
Definition: mainloop.c:1519
void rescan_periodic_events(const or_options_t *options)
Definition: mainloop.c:1597
unsigned get_signewnym_epoch(void)
Definition: mainloop.c:1350
static int prune_old_routers_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:2074
static uint64_t stats_n_main_loop_errors
Definition: mainloop.c:148
STATIC int run_main_loop_until_done(void)
Definition: mainloop.c:2538
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
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:2479
const char * get_dir_info_status_string(void)
Definition: nodelist.c:2489
int router_have_minimum_dir_info(void)
Definition: nodelist.c:2436
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:266
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:2871
time_t rep_hist_desc_stats_write(time_t now)
Definition: rephist.c:2184
void rep_history_clean(time_t before)
Definition: rephist.c:985
time_t rep_hist_hs_stats_write(time_t now, bool is_v3)
Definition: rephist.c:2743
time_t rep_hist_buffer_stats_write(time_t now)
Definition: rephist.c:2047
time_t rep_hist_exit_stats_write(time_t now)
Definition: rephist.c:1593
Header file for rephist.c.
#define REPHIST_CELL_PADDING_COUNTS_INTERVAL
Definition: rephist.h:162
int router_initialize_tls_context(void)
Definition: router.c:818
void mark_my_descriptor_dirty(const char *reason)
Definition: router.c:2572
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:2821
void routerlist_remove_old_routers(void)
Definition: routerlist.c:1902
void update_all_descriptor_downloads(time_t now)
Definition: routerlist.c:2336
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:292
void router_reset_reachability(void)
Definition: selftest.c:68
Header file for selftest.c.
int smartlist_contains(const smartlist_t *sl, const void *element)
smartlist_t * smartlist_new(void)
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:183
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:96
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
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
unsigned int active_on_link
Definition: connection_st.h:86
struct event * read_event
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
time_t timestamp_lastempty
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:103
#define tor_fragile_assert()
Definition: util_bug.h:278
int tor_digest_is_zero(const char *digest)
Definition: util_string.c:98