tor  0.4.2.0-alpha-dev
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);
63 void reschedule_or_state_save(void);
65 void rescan_periodic_events(const or_options_t *options);
66 MOCK_DECL(void, schedule_rescan_periodic_events,(void));
67 
68 void update_current_time(time_t now);
69 
70 MOCK_DECL(long,get_uptime,(void));
71 MOCK_DECL(void,reset_uptime,(void));
72 
73 unsigned get_signewnym_epoch(void);
74 
75 int do_main_loop(void);
76 
77 void reset_main_loop_counters(void);
78 uint64_t get_main_loop_success_count(void);
79 uint64_t get_main_loop_error_count(void);
80 uint64_t get_main_loop_idle_count(void);
81 
82 void periodic_events_on_new_options(const or_options_t *options);
83 
84 void do_signewnym(time_t);
85 time_t get_last_signewnym_time(void);
86 
87 void mainloop_schedule_shutdown(int delay_sec);
88 
89 void tor_init_connection_lists(void);
92 void tor_mainloop_free_all(void);
93 
94 struct token_bucket_rw_t;
95 
96 extern time_t time_of_process_start;
97 extern int quiet_level;
98 extern struct token_bucket_rw_t global_bucket;
99 extern struct token_bucket_rw_t global_relayed_bucket;
100 
101 #ifdef MAINLOOP_PRIVATE
102 STATIC int run_main_loop_until_done(void);
103 STATIC void close_closeable_connections(void);
104 STATIC void teardown_periodic_events(void);
105 STATIC int get_my_roles(const or_options_t *);
106 STATIC int check_network_participation_callback(time_t now,
107  const or_options_t *options);
108 
109 #ifdef TOR_UNIT_TESTS
111 
112 /* We need the periodic_event_item_t definition. */
113 #include "core/mainloop/periodic.h"
114 extern periodic_event_item_t mainloop_periodic_events[];
115 #endif /* defined(TOR_UNIT_TESTS) */
116 #endif /* defined(MAINLOOP_PRIVATE) */
117 
118 #endif /* !defined(TOR_MAINLOOP_H) */
int connection_in_array(connection_t *conn)
Definition: mainloop.c:442
STATIC int run_main_loop_until_done(void)
Definition: mainloop.c:2481
void initialize_periodic_events(void)
Definition: mainloop.c:1506
int connection_is_writing(connection_t *conn)
Definition: mainloop.c:654
void ip_address_changed(int at_interface)
Definition: mainloop.c:2258
int quiet_level
Definition: main.c:116
void connection_watch_events(connection_t *conn, watchable_events_t events)
Definition: mainloop.c:493
void add_connection_to_closeable_list(connection_t *conn)
Definition: mainloop.c:424
void mainloop_schedule_shutdown(int delay_sec)
Definition: mainloop.c:1641
int tor_event_loop_shutdown_is_pending(void)
Definition: mainloop.c:788
uint64_t get_main_loop_error_count(void)
Definition: mainloop.c:548
void directory_all_unreachable(time_t now)
Definition: mainloop.c:1088
void reset_main_loop_counters(void)
Definition: mainloop.c:518
int have_completed_a_circuit(void)
Definition: mainloop.c:218
void rescan_periodic_events(const or_options_t *options)
Definition: mainloop.c:1568
int connection_remove(connection_t *conn)
Definition: mainloop.c:297
void mainloop_schedule_postloop_cleanup(void)
Definition: mainloop.c:1616
enum watchable_events watchable_events_t
void initialize_mainloop_events(void)
Definition: mainloop.c:2304
void tor_init_connection_lists(void)
Definition: mainloop.c:412
uint64_t get_main_loop_success_count(void)
Definition: mainloop.c:534
void connection_stop_reading_from_linked_conn(connection_t *conn)
Definition: mainloop.c:815
void connection_unregister_events(connection_t *conn)
Definition: mainloop.c:275
STATIC void close_closeable_connections(void)
Definition: mainloop.c:833
void reschedule_directory_downloads(void)
Definition: mainloop.c:1588
void note_that_we_maybe_cant_complete_circuits(void)
Definition: mainloop.c:234
unsigned get_signewnym_epoch(void)
Definition: mainloop.c:1331
void do_signewnym(time_t)
Definition: mainloop.c:1307
time_t time_of_process_start
Definition: mainloop.c:142
void note_that_we_completed_a_circuit(void)
Definition: mainloop.c:226
void directory_info_has_arrived(time_t now, int from_cache, int suppress_logs)
Definition: mainloop.c:1106
STATIC int check_network_participation_callback(time_t now, const or_options_t *options)
Definition: mainloop.c:1801
int connection_add_impl(connection_t *conn, int is_connecting)
Definition: mainloop.c:244
uint64_t get_main_loop_idle_count(void)
Definition: mainloop.c:562
void update_current_time(time_t now)
Definition: mainloop.c:2173
void tor_shutdown_event_loop_and_exit(int exitcode)
Definition: mainloop.c:764
STATIC int get_my_roles(const or_options_t *options)
Definition: mainloop.c:1446
STATIC smartlist_t * connection_array
Definition: mainloop.c:164
void reschedule_or_state_save(void)
Definition: mainloop.c:1886
void stats_increment_bytes_read_and_written(uint64_t r, uint64_t w)
Definition: mainloop.c:483
void reset_all_main_loop_timers(void)
Definition: mainloop.c:1438
void dns_servers_relaunch_checks(void)
Definition: mainloop.c:2292
#define MOCK_DECL(rv, funcname, arglist)
Definition: testsupport.h:94
int do_main_loop(void)
Definition: mainloop.c:2318
int connection_is_reading(connection_t *conn)
Definition: mainloop.c:508
watchable_events
Definition: mainloop.h:35
int connection_is_on_closeable_list(connection_t *conn)
Definition: mainloop.c:435