12 #ifndef TOR_CONTROL_EVENTS_H
13 #define TOR_CONTROL_EVENTS_H
24 CIRC_MINOR_EVENT_PURPOSE_CHANGED,
25 CIRC_MINOR_EVENT_CANNIBALIZED,
31 STREAM_EVENT_SENT_CONNECT = 0,
32 STREAM_EVENT_SENT_RESOLVE = 1,
33 STREAM_EVENT_SUCCEEDED = 2,
34 STREAM_EVENT_FAILED = 3,
35 STREAM_EVENT_CLOSED = 4,
37 STREAM_EVENT_NEW_RESOLVE = 6,
38 STREAM_EVENT_FAILED_RETRIABLE = 7,
39 STREAM_EVENT_REMAP = 8,
40 STREAM_EVENT_CONTROLLER_WAIT = 9
45 BUILDTIMEOUT_SET_EVENT_COMPUTED = 0,
46 BUILDTIMEOUT_SET_EVENT_RESET = 1,
47 BUILDTIMEOUT_SET_EVENT_SUSPENDED = 2,
48 BUILDTIMEOUT_SET_EVENT_DISCARD = 3,
49 BUILDTIMEOUT_SET_EVENT_RESUME = 4
55 BOOTSTRAP_STATUS_UNDEF=-1,
56 BOOTSTRAP_STATUS_STARTING=0,
60 BOOTSTRAP_STATUS_CONN_PT=1,
61 BOOTSTRAP_STATUS_CONN_DONE_PT=2,
62 BOOTSTRAP_STATUS_CONN_PROXY=3,
63 BOOTSTRAP_STATUS_CONN_DONE_PROXY=4,
64 BOOTSTRAP_STATUS_CONN=5,
65 BOOTSTRAP_STATUS_CONN_DONE=10,
66 BOOTSTRAP_STATUS_HANDSHAKE=14,
67 BOOTSTRAP_STATUS_HANDSHAKE_DONE=15,
71 BOOTSTRAP_STATUS_ONEHOP_CREATE=20,
72 BOOTSTRAP_STATUS_REQUESTING_STATUS=25,
73 BOOTSTRAP_STATUS_LOADING_STATUS=30,
74 BOOTSTRAP_STATUS_LOADING_KEYS=40,
75 BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS=45,
76 BOOTSTRAP_STATUS_LOADING_DESCRIPTORS=50,
77 BOOTSTRAP_STATUS_ENOUGH_DIRINFO=75,
81 BOOTSTRAP_STATUS_AP_CONN_PT=76,
82 BOOTSTRAP_STATUS_AP_CONN_DONE_PT=77,
83 BOOTSTRAP_STATUS_AP_CONN_PROXY=78,
84 BOOTSTRAP_STATUS_AP_CONN_DONE_PROXY=79,
85 BOOTSTRAP_STATUS_AP_CONN=80,
86 BOOTSTRAP_STATUS_AP_CONN_DONE=85,
87 BOOTSTRAP_STATUS_AP_HANDSHAKE=89,
88 BOOTSTRAP_STATUS_AP_HANDSHAKE_DONE=90,
92 BOOTSTRAP_STATUS_CIRCUIT_CREATE=95,
93 BOOTSTRAP_STATUS_DONE=100
98 #define REMAP_STREAM_SOURCE_CACHE 1
101 #define REMAP_STREAM_SOURCE_EXIT 2
103 void control_initialize_event_queue(
void);
108 #define EVENT_NS 0x000F
120 const struct timeval *old_tv_created);
139 time_t expires,
const char *error,
140 const int cached, uint64_t stream_id);
169 int control_get_bootstrap_percent(
void);
182 const
char *transport_name,
189 const
char *id_digest,
191 const
char *hsdir_index);
198 const
char *hsdir_index);
200 const
char *onion_address,
204 const
char *onion_address);
208 const
char *hsdir_id_digest,
210 void control_event_hsv3_descriptor_received(const
char *onion_address,
212 const
char *hsdir_id_digest);
214 const
char *onion_address,
218 const
char *hsdir_fp,
219 const
char *content);
223 int control_event_enter_controller_wait(
void);
225 void control_events_free_all(
void);
227 #ifdef CONTROL_MODULE_PRIVATE
228 char *get_bw_samples(
void);
231 #ifdef CONTROL_EVENTS_PRIVATE
238 typedef uint64_t event_mask_t;
245 #define EVENT_MIN_ 0x0001
246 #define EVENT_CIRCUIT_STATUS 0x0001
247 #define EVENT_STREAM_STATUS 0x0002
248 #define EVENT_OR_CONN_STATUS 0x0003
249 #define EVENT_BANDWIDTH_USED 0x0004
250 #define EVENT_CIRCUIT_STATUS_MINOR 0x0005
251 #define EVENT_NEW_DESC 0x0006
252 #define EVENT_DEBUG_MSG 0x0007
253 #define EVENT_INFO_MSG 0x0008
254 #define EVENT_NOTICE_MSG 0x0009
255 #define EVENT_WARN_MSG 0x000A
256 #define EVENT_ERR_MSG 0x000B
257 #define EVENT_ADDRMAP 0x000C
260 #define EVENT_DESCCHANGED 0x000E
263 #define EVENT_STATUS_CLIENT 0x0010
264 #define EVENT_STATUS_SERVER 0x0011
265 #define EVENT_STATUS_GENERAL 0x0012
266 #define EVENT_GUARD 0x0013
267 #define EVENT_STREAM_BANDWIDTH_USED 0x0014
268 #define EVENT_CLIENTS_SEEN 0x0015
269 #define EVENT_NEWCONSENSUS 0x0016
270 #define EVENT_BUILDTIMEOUT_SET 0x0017
271 #define EVENT_GOT_SIGNAL 0x0018
272 #define EVENT_CONF_CHANGED 0x0019
273 #define EVENT_CONN_BW 0x001A
274 #define EVENT_CELL_STATS 0x001B
276 #define EVENT_CIRC_BANDWIDTH_USED 0x001D
277 #define EVENT_TRANSPORT_LAUNCHED 0x0020
278 #define EVENT_HS_DESC 0x0021
279 #define EVENT_HS_DESC_CONTENT 0x0022
280 #define EVENT_NETWORK_LIVENESS 0x0023
281 #define EVENT_PT_LOG 0x0024
282 #define EVENT_PT_STATUS 0x0025
283 #define EVENT_MAX_ 0x0025
286 #define EVENT_CAPACITY_ 0x0040
290 CTASSERT(EVENT_MAX_ < EVENT_CAPACITY_);
292 #define EVENT_MASK_(e) (((uint64_t)1)<<(e))
294 #define EVENT_MASK_NONE_ ((uint64_t)0x0)
296 #define EVENT_MASK_ABOVE_MIN_ ((~((uint64_t)0x0)) << EVENT_MIN_)
297 #define EVENT_MASK_BELOW_MAX_ ((~((uint64_t)0x0)) \
298 >> (EVENT_CAPACITY_ - EVENT_MAX_ \
301 #define EVENT_MASK_ALL_ (EVENT_MASK_ABOVE_MIN_ \
302 & EVENT_MASK_BELOW_MAX_)
305 typedef struct cell_stats_t {
307 uint64_t added_cells_appward[CELL_COMMAND_MAX_ + 1];
309 uint64_t added_cells_exitward[CELL_COMMAND_MAX_ + 1];
311 uint64_t removed_cells_appward[CELL_COMMAND_MAX_ + 1];
313 uint64_t removed_cells_exitward[CELL_COMMAND_MAX_ + 1];
315 uint64_t total_time_appward[CELL_COMMAND_MAX_ + 1];
317 uint64_t total_time_exitward[CELL_COMMAND_MAX_ + 1];
321 cell_stats_t *cell_stats);
324 const uint64_t *include_if_non_zero,
325 const uint64_t *number_to_include);
327 cell_stats_t *cell_stats);
330 struct control_event_t {
332 const char *event_name;
339 #ifdef TOR_UNIT_TESTS
346 void control_testing_set_global_event_mask(uint64_t mask);
const struct control_event_t control_event_table[]
void format_cell_stats(char **event_string, circuit_t *circ, cell_stats_t *cell_stats)
STATIC void send_control_event_string(uint16_t event, const char *msg)
void sum_up_cell_stats_by_command(circuit_t *circ, cell_stats_t *cell_stats)
STATIC void queue_control_event_string(uint16_t event, char *msg)
void append_cell_stats_by_command(smartlist_t *event_parts, const char *key, const uint64_t *include_if_non_zero, const uint64_t *number_to_include)
void control_logmsg_strip_newlines(char *msg)
void control_event_conf_changed(const config_line_t *changes)
void control_event_pt_status(const char *status)
int control_event_my_descriptor_changed(void)
int control_event_server_error(const char *format,...)
int control_event_stream_bandwidth(edge_connection_t *edge_conn)
void control_event_pt_log(const char *log)
void control_event_bootstrap_reset(void)
void control_event_hs_descriptor_upload(const char *onion_address, const char *desc_id, const char *hs_dir, const char *hsdir_index)
int control_event_general_status(int severity, const char *format,...)
void control_event_clients_seen(const char *controller_str)
int control_event_bandwidth_used(uint32_t n_read, uint32_t n_written)
int control_event_circuit_purpose_changed(origin_circuit_t *circ, int old_purpose)
int control_event_conn_bandwidth(connection_t *conn)
int control_event_circuit_cell_stats(void)
char * control_event_boot_last_msg(void)
int control_event_or_conn_status(or_connection_t *conn, or_conn_status_event_t e, int reason)
int control_event_buildtimeout_set(buildtimeout_set_event_t type, const char *args)
void control_event_hs_descriptor_requested(const char *onion_address, rend_auth_type_t auth_type, const char *id_digest, const char *desc_id, const char *hsdir_index)
int control_event_stream_bandwidth_used(void)
int control_event_guard(const char *nickname, const char *digest, const char *status)
int control_event_general_error(const char *format,...)
int control_event_networkstatus_changed(smartlist_t *statuses)
int control_event_server_status(int severity, const char *format,...)
void control_event_hs_descriptor_upload_end(const char *action, const char *onion_address, const char *hs_dir, const char *reason)
int control_event_circ_bandwidth_used_for_circ(origin_circuit_t *ocirc)
int control_event_is_interesting(int event)
int control_event_client_error(const char *format,...)
int control_event_circ_bandwidth_used(void)
circuit_status_minor_event_t
int control_event_circuit_status(origin_circuit_t *circ, circuit_status_event_t e, int reason)
void control_event_hsv3_descriptor_failed(const char *onion_address, const char *desc_id, const char *hsdir_id_digest, const char *reason)
int control_event_network_liveness_update(int liveness)
void control_event_transport_launched(const char *mode, const char *transport_name, tor_addr_t *addr, uint16_t port)
void control_event_bootstrap_problem(const char *warn, const char *reason, const connection_t *conn, int dowarn)
int control_event_conn_bandwidth_used(void)
void control_adjust_event_log_severity(void)
int control_event_client_status(int severity, const char *format,...)
void control_event_hs_descriptor_content(const char *onion_address, const char *desc_id, const char *hsdir_fp, const char *content)
void control_event_hs_descriptor_uploaded(const char *hs_dir, const char *onion_address)
int control_event_networkstatus_changed_single(const routerstatus_t *rs)
int control_event_stream_status(entry_connection_t *conn, stream_status_event_t e, int reason)
int control_event_circuit_cannibalized(origin_circuit_t *circ, int old_purpose, const struct timeval *old_tv_created)
void control_event_boot_dir(bootstrap_status_t status, int progress)
void control_event_hs_descriptor_upload_failed(const char *hs_dir, const char *onion_address, const char *reason)
int control_event_descriptors_changed(smartlist_t *routers)
int control_event_newconsensus(const networkstatus_t *consensus)
void control_event_bootstrap(bootstrap_status_t status, int progress)
void control_event_boot_first_orconn(void)
int control_event_address_mapped(const char *from, const char *to, time_t expires, const char *error, const int cached, uint64_t stream_id)
int control_event_signal(uintptr_t signal)
void control_event_hs_descriptor_created(const char *onion_address, const char *desc_id, int replica)
void control_event_logmsg_pending(void)
void control_update_global_event_mask(void)
void control_per_second_events(void)
void control_event_logmsg(int severity, log_domain_mask_t domain, const char *msg)
void control_event_bootstrap_prob_or(const char *warn, int reason, or_connection_t *or_conn)
int control_any_per_second_event_enabled(void)
Compile-time assertions: CTASSERT(expression).
uint64_t log_domain_mask_t
Header file for ocirc_event.c.
Header file for orconn_event.c.
#define MOCK_DECL(rv, funcname, arglist)