Tor  0.4.3.0-alpha-dev
control_events.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 
7 /**
8  * \file control_events.h
9  * \brief Header file for control_events.c.
10  **/
11 
12 #ifndef TOR_CONTROL_EVENTS_H
13 #define TOR_CONTROL_EVENTS_H
14 
15 #include "core/or/ocirc_event.h"
16 #include "core/or/orconn_event.h"
17 
18 struct config_line_t;
19 
20 /** Used to indicate the type of a CIRC_MINOR event passed to the controller.
21  * The various types are defined in control-spec.txt . */
23  CIRC_MINOR_EVENT_PURPOSE_CHANGED,
24  CIRC_MINOR_EVENT_CANNIBALIZED,
26 
27 /** Used to indicate the type of a stream event passed to the controller.
28  * The various types are defined in control-spec.txt */
29 typedef enum stream_status_event_t {
30  STREAM_EVENT_SENT_CONNECT = 0,
31  STREAM_EVENT_SENT_RESOLVE = 1,
32  STREAM_EVENT_SUCCEEDED = 2,
33  STREAM_EVENT_FAILED = 3,
34  STREAM_EVENT_CLOSED = 4,
35  STREAM_EVENT_NEW = 5,
36  STREAM_EVENT_NEW_RESOLVE = 6,
37  STREAM_EVENT_FAILED_RETRIABLE = 7,
38  STREAM_EVENT_REMAP = 8
40 
41 /** Used to indicate the type of a buildtime event */
43  BUILDTIMEOUT_SET_EVENT_COMPUTED = 0,
44  BUILDTIMEOUT_SET_EVENT_RESET = 1,
45  BUILDTIMEOUT_SET_EVENT_SUSPENDED = 2,
46  BUILDTIMEOUT_SET_EVENT_DISCARD = 3,
47  BUILDTIMEOUT_SET_EVENT_RESUME = 4
49 
50 /** Enum describing various stages of bootstrapping, for use with controller
51  * bootstrap status events. The values range from 0 to 100. */
52 typedef enum {
53  BOOTSTRAP_STATUS_UNDEF=-1,
54  BOOTSTRAP_STATUS_STARTING=0,
55 
56  /* Initial connection to any relay */
57 
58  BOOTSTRAP_STATUS_CONN_PT=1,
59  BOOTSTRAP_STATUS_CONN_DONE_PT=2,
60  BOOTSTRAP_STATUS_CONN_PROXY=3,
61  BOOTSTRAP_STATUS_CONN_DONE_PROXY=4,
62  BOOTSTRAP_STATUS_CONN=5,
63  BOOTSTRAP_STATUS_CONN_DONE=10,
64  BOOTSTRAP_STATUS_HANDSHAKE=14,
65  BOOTSTRAP_STATUS_HANDSHAKE_DONE=15,
66 
67  /* Loading directory info */
68 
69  BOOTSTRAP_STATUS_ONEHOP_CREATE=20,
70  BOOTSTRAP_STATUS_REQUESTING_STATUS=25,
71  BOOTSTRAP_STATUS_LOADING_STATUS=30,
72  BOOTSTRAP_STATUS_LOADING_KEYS=40,
73  BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS=45,
74  BOOTSTRAP_STATUS_LOADING_DESCRIPTORS=50,
75  BOOTSTRAP_STATUS_ENOUGH_DIRINFO=75,
76 
77  /* Connecting to a relay for AP circuits */
78 
79  BOOTSTRAP_STATUS_AP_CONN_PT=76,
80  BOOTSTRAP_STATUS_AP_CONN_DONE_PT=77,
81  BOOTSTRAP_STATUS_AP_CONN_PROXY=78,
82  BOOTSTRAP_STATUS_AP_CONN_DONE_PROXY=79,
83  BOOTSTRAP_STATUS_AP_CONN=80,
84  BOOTSTRAP_STATUS_AP_CONN_DONE=85,
85  BOOTSTRAP_STATUS_AP_HANDSHAKE=89,
86  BOOTSTRAP_STATUS_AP_HANDSHAKE_DONE=90,
87 
88  /* Creating AP circuits */
89 
90  BOOTSTRAP_STATUS_CIRCUIT_CREATE=95,
91  BOOTSTRAP_STATUS_DONE=100
93 
94 /** Reason for remapping an AP connection's address: we have a cached
95  * answer. */
96 #define REMAP_STREAM_SOURCE_CACHE 1
97 /** Reason for remapping an AP connection's address: the exit node told us an
98  * answer. */
99 #define REMAP_STREAM_SOURCE_EXIT 2
100 
101 void control_initialize_event_queue(void);
102 
105 
106 #define EVENT_NS 0x000F
107 int control_event_is_interesting(int event);
108 
109 void control_per_second_events(void);
111 
113  circuit_status_event_t e, int reason);
115  int old_purpose);
117  int old_purpose,
118  const struct timeval *old_tv_created);
121  int reason);
123  or_conn_status_event_t e, int reason);
124 int control_event_bandwidth_used(uint32_t n_read, uint32_t n_written);
132 void control_event_logmsg(int severity, log_domain_mask_t domain,
133  const char *msg);
136 int control_event_address_mapped(const char *from, const char *to,
137  time_t expires, const char *error,
138  const int cached);
140 int control_event_network_liveness_update(int liveness);
142 
143 int control_event_newconsensus(const networkstatus_t *consensus);
145 int control_event_general_status(int severity, const char *format, ...)
146  CHECK_PRINTF(2,3);
147 int control_event_client_status(int severity, const char *format, ...)
148  CHECK_PRINTF(2,3);
149 int control_event_server_status(int severity, const char *format, ...)
150  CHECK_PRINTF(2,3);
151 
152 int control_event_general_error(const char *format, ...)
153  CHECK_PRINTF(1,2);
154 int control_event_client_error(const char *format, ...)
155  CHECK_PRINTF(1,2);
156 int control_event_server_error(const char *format, ...)
157  CHECK_PRINTF(1,2);
158 
159 int control_event_guard(const char *nickname, const char *digest,
160  const char *status);
161 void control_event_conf_changed(const struct config_line_t *changes);
163  const char *args);
164 int control_event_signal(uintptr_t signal);
165 
166 void control_event_bootstrap(bootstrap_status_t status, int progress);
167 MOCK_DECL(void, control_event_bootstrap_prob_or,(const char *warn,
168  int reason,
169  or_connection_t *or_conn));
170 void control_event_boot_dir(bootstrap_status_t status, int progress);
172 void control_event_bootstrap_problem(const char *warn, const char *reason,
173  const connection_t *conn, int dowarn);
174 char *control_event_boot_last_msg(void);
176 
177 void control_event_clients_seen(const char *controller_str);
178 void control_event_transport_launched(const char *mode,
179  const char *transport_name,
180  tor_addr_t *addr, uint16_t port);
181 void control_event_pt_log(const char *log);
182 void control_event_pt_status(const char *status);
183 
184 void control_event_hs_descriptor_requested(const char *onion_address,
185  rend_auth_type_t auth_type,
186  const char *id_digest,
187  const char *desc_id,
188  const char *hsdir_index);
189 void control_event_hs_descriptor_created(const char *onion_address,
190  const char *desc_id,
191  int replica);
192 void control_event_hs_descriptor_upload(const char *onion_address,
193  const char *desc_id,
194  const char *hs_dir,
195  const char *hsdir_index);
196 void control_event_hs_descriptor_upload_end(const char *action,
197  const char *onion_address,
198  const char *hs_dir,
199  const char *reason);
200 void control_event_hs_descriptor_uploaded(const char *hs_dir,
201  const char *onion_address);
202 /* Hidden service v2 HS_DESC specific. */
204  const char *id_digest,
205  const char *reason);
206 void control_event_hsv2_descriptor_received(const char *onion_address,
207  const rend_data_t *rend_data,
208  const char *id_digest);
209 /* Hidden service v3 HS_DESC specific. */
210 void control_event_hsv3_descriptor_failed(const char *onion_address,
211  const char *desc_id,
212  const char *hsdir_id_digest,
213  const char *reason);
214 void control_event_hsv3_descriptor_received(const char *onion_address,
215  const char *desc_id,
216  const char *hsdir_id_digest);
217 void control_event_hs_descriptor_upload_failed(const char *hs_dir,
218  const char *onion_address,
219  const char *reason);
220 void control_event_hs_descriptor_content(const char *onion_address,
221  const char *desc_id,
222  const char *hsdir_fp,
223  const char *content);
224 
225 void control_events_free_all(void);
226 
227 #ifdef CONTROL_MODULE_PRIVATE
228 char *get_bw_samples(void);
229 #endif /* defined(CONTROL_MODULE_PRIVATE) */
230 
231 #ifdef CONTROL_EVENTS_PRIVATE
232 /** Bitfield: The bit 1&lt;&lt;e is set if <b>any</b> open control
233  * connection is interested in events of type <b>e</b>. We use this
234  * so that we can decide to skip generating event messages that nobody
235  * has interest in without having to walk over the global connection
236  * list to find out.
237  **/
238 typedef uint64_t event_mask_t;
239 
240 /* Recognized asynchronous event types. It's okay to expand this list
241  * because it is used both as a list of v0 event types, and as indices
242  * into the bitfield to determine which controllers want which events.
243  */
244 /* This bitfield has no event zero 0x0000 */
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
258 /* There was an AUTHDIR_NEWDESCS event, but it no longer exists. We
259  can reclaim 0x000D. */
260 #define EVENT_DESCCHANGED 0x000E
261 /* Exposed above */
262 // #define EVENT_NS 0x000F
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
275 /* UNUSED : 0x001C */
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
284 
285 /* sizeof(control_connection_t.event_mask) in bits, currently a uint64_t */
286 #define EVENT_CAPACITY_ 0x0040
287 
288 /* If EVENT_MAX_ ever hits 0x0040, we need to make the mask into a
289  * different structure, as it can only handle a maximum left shift of 1<<63. */
290 
291 #if EVENT_MAX_ >= EVENT_CAPACITY_
292 #error control_connection_t.event_mask has an event greater than its capacity
293 #endif
294 
295 #define EVENT_MASK_(e) (((uint64_t)1)<<(e))
296 
297 #define EVENT_MASK_NONE_ ((uint64_t)0x0)
298 
299 #define EVENT_MASK_ABOVE_MIN_ ((~((uint64_t)0x0)) << EVENT_MIN_)
300 #define EVENT_MASK_BELOW_MAX_ ((~((uint64_t)0x0)) \
301  >> (EVENT_CAPACITY_ - EVENT_MAX_ \
302  - EVENT_MIN_))
303 
304 #define EVENT_MASK_ALL_ (EVENT_MASK_ABOVE_MIN_ \
305  & EVENT_MASK_BELOW_MAX_)
306 
307 /** Helper structure: temporarily stores cell statistics for a circuit. */
308 typedef struct cell_stats_t {
309  /** Number of cells added in app-ward direction by command. */
310  uint64_t added_cells_appward[CELL_COMMAND_MAX_ + 1];
311  /** Number of cells added in exit-ward direction by command. */
312  uint64_t added_cells_exitward[CELL_COMMAND_MAX_ + 1];
313  /** Number of cells removed in app-ward direction by command. */
314  uint64_t removed_cells_appward[CELL_COMMAND_MAX_ + 1];
315  /** Number of cells removed in exit-ward direction by command. */
316  uint64_t removed_cells_exitward[CELL_COMMAND_MAX_ + 1];
317  /** Total waiting time of cells in app-ward direction by command. */
318  uint64_t total_time_appward[CELL_COMMAND_MAX_ + 1];
319  /** Total waiting time of cells in exit-ward direction by command. */
320  uint64_t total_time_exitward[CELL_COMMAND_MAX_ + 1];
321 } cell_stats_t;
322 
324  cell_stats_t *cell_stats);
325 void append_cell_stats_by_command(smartlist_t *event_parts,
326  const char *key,
327  const uint64_t *include_if_non_zero,
328  const uint64_t *number_to_include);
329 void format_cell_stats(char **event_string, circuit_t *circ,
330  cell_stats_t *cell_stats);
331 
332 /** Helper structure: maps event values to their names. */
333 struct control_event_t {
334  uint16_t event_code;
335  const char *event_name;
336 };
337 
338 extern const struct control_event_t control_event_table[];
339 
340 #ifdef TOR_UNIT_TESTS
341 MOCK_DECL(STATIC void,
342  send_control_event_string,(uint16_t event, const char *msg));
343 
344 MOCK_DECL(STATIC void,
345  queue_control_event_string,(uint16_t event, char *msg));
346 
347 void control_testing_set_global_event_mask(uint64_t mask);
348 
349 #endif /* defined(TOR_UNIT_TESTS) */
350 
351 #endif /* defined(CONTROL_EVENTS_PRIVATE) */
352 
353 #endif /* !defined(TOR_CONTROL_EVENTS_H) */
void control_event_hs_descriptor_content(const char *onion_address, const char *desc_id, const char *hsdir_fp, const char *content)
void control_event_boot_dir(bootstrap_status_t status, int progress)
void control_event_hsv2_descriptor_received(const char *onion_address, const rend_data_t *rend_data, const char *id_digest)
int control_event_address_mapped(const char *from, const char *to, time_t expires, const char *error, const int cached)
void control_event_bootstrap_problem(const char *warn, const char *reason, const connection_t *conn, int dowarn)
STATIC void queue_control_event_string(uint16_t event, char *msg)
static void static int static void const struct control_event_t control_event_table[]
void control_event_boot_first_orconn(void)
int control_event_networkstatus_changed(smartlist_t *statuses)
void format_cell_stats(char **event_string, circuit_t *circ, cell_stats_t *cell_stats)
int control_event_stream_bandwidth(edge_connection_t *edge_conn)
int control_event_signal(uintptr_t signal)
void control_event_hs_descriptor_upload(const char *onion_address, const char *desc_id, const char *hs_dir, const char *hsdir_index)
stream_status_event_t
int control_event_descriptors_changed(smartlist_t *routers)
int control_event_client_error(const char *format,...)
int control_event_circuit_cell_stats(void)
void control_event_hs_descriptor_created(const char *onion_address, const char *desc_id, int replica)
#define STATIC
Definition: testsupport.h:32
Header file for orconn_event.c.
rend_auth_type_t
Definition: or.h:402
void control_event_hs_descriptor_upload_failed(const char *hs_dir, const char *onion_address, const char *reason)
int control_event_my_descriptor_changed(void)
int control_event_buildtimeout_set(buildtimeout_set_event_t type, const char *args)
buildtimeout_set_event_t
int control_event_general_status(int severity, const char *format,...)
void control_event_bootstrap_reset(void)
void sum_up_cell_stats_by_command(circuit_t *circ, cell_stats_t *cell_stats)
int control_event_or_conn_status(or_connection_t *conn, or_conn_status_event_t e, int reason)
void control_event_transport_launched(const char *mode, const char *transport_name, tor_addr_t *addr, uint16_t port)
int control_event_general_error(const char *format,...)
bootstrap_status_t
char * control_event_boot_last_msg(void)
int control_event_circuit_purpose_changed(origin_circuit_t *circ, int old_purpose)
int control_event_circ_bandwidth_used_for_circ(origin_circuit_t *ocirc)
int control_event_circuit_status(origin_circuit_t *circ, circuit_status_event_t e, int reason)
int control_event_stream_status(entry_connection_t *conn, stream_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_circ_bandwidth_used(void)
void control_event_bootstrap_prob_or(const char *warn, int reason, or_connection_t *or_conn)
int control_event_client_status(int severity, const char *format,...)
int control_any_per_second_event_enabled(void)
void control_event_hs_descriptor_uploaded(const char *hs_dir, const char *onion_address)
void control_event_hs_descriptor_upload_end(const char *action, const char *onion_address, const char *hs_dir, const char *reason)
void control_update_global_event_mask(void)
int control_event_is_interesting(int event)
uint64_t log_domain_mask_t
Definition: logging_types.h:21
int control_event_stream_bandwidth_used(void)
int control_event_circuit_cannibalized(origin_circuit_t *circ, int old_purpose, const struct timeval *old_tv_created)
void control_event_bootstrap(bootstrap_status_t status, int progress)
STATIC void send_control_event_string(uint16_t event, const char *msg)
void control_event_clients_seen(const char *controller_str)
int control_event_network_liveness_update(int liveness)
int control_event_networkstatus_changed_single(const routerstatus_t *rs)
#define MOCK_DECL(rv, funcname, arglist)
Definition: testsupport.h:127
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)
int control_event_server_error(const char *format,...)
Header file for ocirc_event.c.
int control_event_conn_bandwidth(connection_t *conn)
void control_event_pt_status(const char *status)
int control_event_server_status(int severity, const char *format,...)
void control_per_second_events(void)
void control_event_conf_changed(const config_line_t *changes)
void control_event_hsv2_descriptor_failed(const rend_data_t *rend_data, const char *id_digest, const char *reason)
void control_event_logmsg(int severity, log_domain_mask_t domain, const char *msg)
void control_adjust_event_log_severity(void)
or_conn_status_event_t
Definition: orconn_event.h:59
void control_event_pt_log(const char *log)
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)
void control_event_logmsg_pending(void)
int control_event_newconsensus(const networkstatus_t *consensus)
int int int int int int int control_event_guard(const char *nickname, const char *digest, const char *status)
circuit_status_minor_event_t
int control_event_conn_bandwidth_used(void)
int control_event_bandwidth_used(uint32_t n_read, uint32_t n_written)
circuit_status_event_t
Definition: ocirc_event.h:19