tor  0.4.0.1-alpha
mainloop.h
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-2019, The Tor Project, Inc. */
5 /* See LICENSE for licensing information */
6 
12 #ifndef TOR_MAINLOOP_H
13 #define TOR_MAINLOOP_H
14 
15 int have_completed_a_circuit(void);
18 
19 int connection_add_impl(connection_t *conn, int is_connecting);
20 #define connection_add(conn) connection_add_impl((conn), 0)
21 #define connection_add_connecting(conn) connection_add_impl((conn), 1)
27 
28 MOCK_DECL(smartlist_t *, get_connection_array, (void));
29 MOCK_DECL(uint64_t,get_bytes_read,(void));
30 MOCK_DECL(uint64_t,get_bytes_written,(void));
31 void stats_increment_bytes_read_and_written(uint64_t r, uint64_t w);
32 
35 typedef enum watchable_events {
36  /* Yes, it is intentional that these match Libevent's EV_READ and EV_WRITE */
37  READ_EVENT=0x02,
42 MOCK_DECL(void,connection_stop_reading,(connection_t *conn));
43 MOCK_DECL(void,connection_start_reading,(connection_t *conn));
44 
46 MOCK_DECL(void,connection_stop_writing,(connection_t *conn));
47 MOCK_DECL(void,connection_start_writing,(connection_t *conn));
48 
49 void tor_shutdown_event_loop_and_exit(int exitcode);
51 
53 
54 MOCK_DECL(int, connection_count_moribund, (void));
55 
56 void directory_all_unreachable(time_t now);
57 void directory_info_has_arrived(time_t now, int from_cache, int suppress_logs);
58 
59 void ip_address_changed(int at_interface);
64 void reschedule_or_state_save(void);
65 void reschedule_dirvote(const or_options_t *options);
67 void rescan_periodic_events(const or_options_t *options);
68 MOCK_DECL(void, schedule_rescan_periodic_events,(void));
69 
70 void update_current_time(time_t now);
71 
72 MOCK_DECL(long,get_uptime,(void));
73 MOCK_DECL(void,reset_uptime,(void));
74 
75 unsigned get_signewnym_epoch(void);
76 
77 int do_main_loop(void);
78 
79 void reset_main_loop_counters(void);
80 uint64_t get_main_loop_success_count(void);
81 uint64_t get_main_loop_error_count(void);
82 uint64_t get_main_loop_idle_count(void);
83 
84 void periodic_events_on_new_options(const or_options_t *options);
85 
86 void do_signewnym(time_t);
87 time_t get_last_signewnym_time(void);
88 
89 void mainloop_schedule_shutdown(int delay_sec);
90 
91 void tor_init_connection_lists(void);
93 void tor_mainloop_free_all(void);
94 
95 struct token_bucket_rw_t;
96 
97 extern time_t time_of_process_start;
98 extern int quiet_level;
99 extern struct token_bucket_rw_t global_bucket;
100 extern struct token_bucket_rw_t global_relayed_bucket;
101 
102 #ifdef MAINLOOP_PRIVATE
103 STATIC int run_main_loop_until_done(void);
104 STATIC void close_closeable_connections(void);
105 STATIC void initialize_periodic_events(void);
106 STATIC void teardown_periodic_events(void);
107 STATIC int get_my_roles(const or_options_t *);
108 STATIC int check_network_participation_callback(time_t now,
109  const or_options_t *options);
110 
111 #ifdef TOR_UNIT_TESTS
113 
114 /* We need the periodic_event_item_t definition. */
115 #include "core/mainloop/periodic.h"
116 extern periodic_event_item_t periodic_events[];
117 #endif
118 #endif /* defined(MAIN_PRIVATE) */
119 
120 #endif
int connection_in_array(connection_t *conn)
Definition: mainloop.c:445
STATIC int run_main_loop_until_done(void)
Definition: mainloop.c:2980
int connection_is_writing(connection_t *conn)
Definition: mainloop.c:657
void ip_address_changed(int at_interface)
Definition: mainloop.c:2762
int quiet_level
Definition: main.c:134
void connection_watch_events(connection_t *conn, watchable_events_t events)
Definition: mainloop.c:496
STATIC void initialize_periodic_events(void)
Definition: mainloop.c:1570
void add_connection_to_closeable_list(connection_t *conn)
Definition: mainloop.c:427
void reschedule_descriptor_update_check(void)
Definition: mainloop.c:1698
void mainloop_schedule_shutdown(int delay_sec)
Definition: mainloop.c:1763
int tor_event_loop_shutdown_is_pending(void)
Definition: mainloop.c:791
uint64_t get_main_loop_error_count(void)
Definition: mainloop.c:551
void directory_all_unreachable(time_t now)
Definition: mainloop.c:1091
void reset_main_loop_counters(void)
Definition: mainloop.c:521
int have_completed_a_circuit(void)
Definition: mainloop.c:221
void rescan_periodic_events(const or_options_t *options)
Definition: mainloop.c:1638
int connection_remove(connection_t *conn)
Definition: mainloop.c:300
void mainloop_schedule_postloop_cleanup(void)
Definition: mainloop.c:1738
enum watchable_events watchable_events_t
void initialize_mainloop_events(void)
Definition: mainloop.c:2809
void tor_init_connection_lists(void)
Definition: mainloop.c:415
uint64_t get_main_loop_success_count(void)
Definition: mainloop.c:537
void connection_stop_reading_from_linked_conn(connection_t *conn)
Definition: mainloop.c:818
void connection_unregister_events(connection_t *conn)
Definition: mainloop.c:278
STATIC void close_closeable_connections(void)
Definition: mainloop.c:836
void reschedule_directory_downloads(void)
Definition: mainloop.c:1710
void note_that_we_maybe_cant_complete_circuits(void)
Definition: mainloop.c:237
unsigned get_signewnym_epoch(void)
Definition: mainloop.c:1334
void do_signewnym(time_t)
Definition: mainloop.c:1310
time_t time_of_process_start
Definition: mainloop.c:145
void note_that_we_completed_a_circuit(void)
Definition: mainloop.c:229
void directory_info_has_arrived(time_t now, int from_cache, int suppress_logs)
Definition: mainloop.c:1109
STATIC int check_network_participation_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:2017
int connection_add_impl(connection_t *conn, int is_connecting)
Definition: mainloop.c:247
uint64_t get_main_loop_idle_count(void)
Definition: mainloop.c:565
void update_current_time(time_t now)
Definition: mainloop.c:2677
void tor_shutdown_event_loop_and_exit(int exitcode)
Definition: mainloop.c:767
STATIC int get_my_roles(const or_options_t *options)
Definition: mainloop.c:1510
STATIC smartlist_t * connection_array
Definition: mainloop.c:167
void reschedule_or_state_save(void)
Definition: mainloop.c:2198
void stats_increment_bytes_read_and_written(uint64_t r, uint64_t w)
Definition: mainloop.c:486
void reset_all_main_loop_timers(void)
Definition: mainloop.c:1485
void dns_servers_relaunch_checks(void)
Definition: mainloop.c:2796
#define MOCK_DECL(rv, funcname, arglist)
Definition: testsupport.h:94
int do_main_loop(void)
Definition: mainloop.c:2825
int connection_is_reading(connection_t *conn)
Definition: mainloop.c:511
void reschedule_dirvote(const or_options_t *options)
Definition: mainloop.c:2152
watchable_events
Definition: mainloop.h:35
int connection_is_on_closeable_list(connection_t *conn)
Definition: mainloop.c:438