mainloop.h (4176B)
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.h 9 * \brief Header file for mainloop.c. 10 **/ 11 12 #ifndef TOR_MAINLOOP_H 13 #define TOR_MAINLOOP_H 14 15 int have_completed_a_circuit(void); 16 void note_that_we_completed_a_circuit(void); 17 void note_that_we_maybe_cant_complete_circuits(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) 22 int connection_remove(connection_t *conn); 23 void connection_unregister_events(connection_t *conn); 24 int connection_in_array(connection_t *conn); 25 void add_connection_to_closeable_list(connection_t *conn); 26 int connection_is_on_closeable_list(connection_t *conn); 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 33 /** Bitmask for events that we can turn on and off with 34 * connection_watch_events. */ 35 typedef enum watchable_events { 36 /* Yes, it is intentional that these match Libevent's EV_READ and EV_WRITE */ 37 READ_EVENT=0x02, /**< We want to know when a connection is readable */ 38 WRITE_EVENT=0x04 /**< We want to know when a connection is writable */ 39 } watchable_events_t; 40 void connection_watch_events(connection_t *conn, watchable_events_t events); 41 int connection_is_reading(const connection_t *conn); 42 MOCK_DECL(void,connection_stop_reading,(connection_t *conn)); 43 MOCK_DECL(void,connection_start_reading,(connection_t *conn)); 44 45 int connection_is_writing(connection_t *conn); 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); 50 int tor_event_loop_shutdown_is_pending(void); 51 52 void connection_stop_reading_from_linked_conn(connection_t *conn); 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 on_client_conn); 60 void dns_servers_relaunch_checks(void); 61 void reset_all_main_loop_timers(void); 62 void reschedule_directory_downloads(void); 63 void reschedule_or_state_save(void); 64 void mainloop_schedule_postloop_cleanup(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); 90 void initialize_mainloop_events(void); 91 void initialize_periodic_events(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 struct token_bucket_rw_t global_bucket; 98 extern struct token_bucket_rw_t global_relayed_bucket; 99 100 #ifdef MAINLOOP_PRIVATE 101 STATIC int run_main_loop_until_done(void); 102 STATIC void close_closeable_connections(void); 103 STATIC void teardown_periodic_events(void); 104 STATIC int get_my_roles(const or_options_t *); 105 STATIC int check_network_participation_callback(time_t now, 106 const or_options_t *options); 107 108 #ifdef TOR_UNIT_TESTS 109 extern smartlist_t *connection_array; 110 111 /* We need the periodic_event_item_t definition. */ 112 #include "core/mainloop/periodic.h" 113 extern periodic_event_item_t mainloop_periodic_events[]; 114 #endif /* defined(TOR_UNIT_TESTS) */ 115 #endif /* defined(MAINLOOP_PRIVATE) */ 116 117 #endif /* !defined(TOR_MAINLOOP_H) */