Tor  0.4.4.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-2020, 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 "lib/cc/ctassert.h"
16 #include "core/or/ocirc_event.h"
17 #include "core/or/orconn_event.h"
18 
19 struct config_line_t;
20 
21 /** Used to indicate the type of a CIRC_MINOR event passed to the controller.
22  * The various types are defined in control-spec.txt . */
24  CIRC_MINOR_EVENT_PURPOSE_CHANGED,
25  CIRC_MINOR_EVENT_CANNIBALIZED,
27 
28 /** Used to indicate the type of a stream event passed to the controller.
29  * The various types are defined in control-spec.txt */
30 typedef enum stream_status_event_t {
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,
36  STREAM_EVENT_NEW = 5,
37  STREAM_EVENT_NEW_RESOLVE = 6,
38  STREAM_EVENT_FAILED_RETRIABLE = 7,
39  STREAM_EVENT_REMAP = 8
41 
42 /** Used to indicate the type of a buildtime event */
44  BUILDTIMEOUT_SET_EVENT_COMPUTED = 0,
45  BUILDTIMEOUT_SET_EVENT_RESET = 1,
46  BUILDTIMEOUT_SET_EVENT_SUSPENDED = 2,
47  BUILDTIMEOUT_SET_EVENT_DISCARD = 3,
48  BUILDTIMEOUT_SET_EVENT_RESUME = 4
50 
51 /** Enum describing various stages of bootstrapping, for use with controller
52  * bootstrap status events. The values range from 0 to 100. */
53 typedef enum {
54  BOOTSTRAP_STATUS_UNDEF=-1,
55  BOOTSTRAP_STATUS_STARTING=0,
56 
57  /* Initial connection to any relay */
58 
59  BOOTSTRAP_STATUS_CONN_PT=1,
60  BOOTSTRAP_STATUS_CONN_DONE_PT=2,
61  BOOTSTRAP_STATUS_CONN_PROXY=3,
62  BOOTSTRAP_STATUS_CONN_DONE_PROXY=4,
63  BOOTSTRAP_STATUS_CONN=5,
64  BOOTSTRAP_STATUS_CONN_DONE=10,
65  BOOTSTRAP_STATUS_HANDSHAKE=14,
66  BOOTSTRAP_STATUS_HANDSHAKE_DONE=15,
67 
68  /* Loading directory info */
69 
70  BOOTSTRAP_STATUS_ONEHOP_CREATE=20,
71  BOOTSTRAP_STATUS_REQUESTING_STATUS=25,
72  BOOTSTRAP_STATUS_LOADING_STATUS=30,
73  BOOTSTRAP_STATUS_LOADING_KEYS=40,
74  BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS=45,
75  BOOTSTRAP_STATUS_LOADING_DESCRIPTORS=50,
76  BOOTSTRAP_STATUS_ENOUGH_DIRINFO=75,
77 
78  /* Connecting to a relay for AP circuits */
79 
80  BOOTSTRAP_STATUS_AP_CONN_PT=76,
81  BOOTSTRAP_STATUS_AP_CONN_DONE_PT=77,
82  BOOTSTRAP_STATUS_AP_CONN_PROXY=78,
83  BOOTSTRAP_STATUS_AP_CONN_DONE_PROXY=79,
84  BOOTSTRAP_STATUS_AP_CONN=80,
85  BOOTSTRAP_STATUS_AP_CONN_DONE=85,
86  BOOTSTRAP_STATUS_AP_HANDSHAKE=89,
87  BOOTSTRAP_STATUS_AP_HANDSHAKE_DONE=90,
88 
89  /* Creating AP circuits */
90 
91  BOOTSTRAP_STATUS_CIRCUIT_CREATE=95,
92  BOOTSTRAP_STATUS_DONE=100
94 
95 /** Reason for remapping an AP connection's address: we have a cached
96  * answer. */
97 #define REMAP_STREAM_SOURCE_CACHE 1
98 /** Reason for remapping an AP connection's address: the exit node told us an
99  * answer. */
100 #define REMAP_STREAM_SOURCE_EXIT 2
101 
102 void control_initialize_event_queue(void);
103 
106 
107 #define EVENT_NS 0x000F
108 int control_event_is_interesting(int event);
109 
110 void control_per_second_events(void);
112 
114  circuit_status_event_t e, int reason);
116  int old_purpose);
118  int old_purpose,
119  const struct timeval *old_tv_created);
122  int reason);
124  or_conn_status_event_t e, int reason);
125 int control_event_bandwidth_used(uint32_t n_read, uint32_t n_written);
133 void control_event_logmsg(int severity, log_domain_mask_t domain,
134  const char *msg);
137 int control_event_address_mapped(const char *from, const char *to,
138  time_t expires, const char *error,
139  const int cached);
141 int control_event_network_liveness_update(int liveness);
143 
144 int control_event_newconsensus(const networkstatus_t *consensus);
146 int control_event_general_status(int severity, const char *format, ...)
147  CHECK_PRINTF(2,3);
148 int control_event_client_status(int severity, const char *format, ...)
149  CHECK_PRINTF(2,3);
150 int control_event_server_status(int severity, const char *format, ...)
151  CHECK_PRINTF(2,3);
152 
153 int control_event_general_error(const char *format, ...)
154  CHECK_PRINTF(1,2);
155 int control_event_client_error(const char *format, ...)
156  CHECK_PRINTF(1,2);
157 int control_event_server_error(const char *format, ...)
158  CHECK_PRINTF(1,2);
159 
160 int control_event_guard(const char *nickname, const char *digest,
161  const char *status);
162 void control_event_conf_changed(const struct config_line_t *changes);
164  const char *args);
165 int control_event_signal(uintptr_t signal);
166 
167 void control_event_bootstrap(bootstrap_status_t status, int progress);
168 int control_get_bootstrap_percent(void);
169 MOCK_DECL(void, control_event_bootstrap_prob_or,(const char *warn,
170  int reason,
171  or_connection_t *or_conn));
172 void control_event_boot_dir(bootstrap_status_t status, int progress);
174 void control_event_bootstrap_problem(const char *warn, const char *reason,
175  const connection_t *conn, int dowarn);
176 char *control_event_boot_last_msg(void);
178 
179 void control_event_clients_seen(const char *controller_str);
180 void control_event_transport_launched(const char *mode,
181  const char *transport_name,
182  tor_addr_t *addr, uint16_t port);
183 void control_event_pt_log(const char *log);
184 void control_event_pt_status(const char *status);
185 
186 void control_event_hs_descriptor_requested(const char *onion_address,
187  rend_auth_type_t auth_type,
188  const char *id_digest,
189  const char *desc_id,
190  const char *hsdir_index);
191 void control_event_hs_descriptor_created(const char *onion_address,
192  const char *desc_id,
193  int replica);
194 void control_event_hs_descriptor_upload(const char *onion_address,
195  const char *desc_id,
196  const char *hs_dir,
197  const char *hsdir_index);
198 void control_event_hs_descriptor_upload_end(const char *action,
199  const char *onion_address,
200  const char *hs_dir,
201  const char *reason);
202 void control_event_hs_descriptor_uploaded(const char *hs_dir,
203  const char *onion_address);
204 /* Hidden service v2 HS_DESC specific. */
206  const char *id_digest,
207  const char *reason);
208 void control_event_hsv2_descriptor_received(const char *onion_address,
209  const rend_data_t *rend_data,
210  const char *id_digest);
211 /* Hidden service v3 HS_DESC specific. */
212 void control_event_hsv3_descriptor_failed(const char *onion_address,
213  const char *desc_id,
214  const char *hsdir_id_digest,
215  const char *reason);
216 void control_event_hsv3_descriptor_received(const char *onion_address,
217  const char *desc_id,
218  const char *hsdir_id_digest);
219 void control_event_hs_descriptor_upload_failed(const char *hs_dir,
220  const char *onion_address,
221  const char *reason);
222 void control_event_hs_descriptor_content(const char *onion_address,
223  const char *desc_id,
224  const char *hsdir_fp,
225  const char *content);
226 
227 void control_events_free_all(void);
228 
229 #ifdef CONTROL_MODULE_PRIVATE
230 char *get_bw_samples(void);
231 #endif /* defined(CONTROL_MODULE_PRIVATE) */
232 
233 #ifdef CONTROL_EVENTS_PRIVATE
234 /** Bitfield: The bit 1&lt;&lt;e is set if <b>any</b> open control
235  * connection is interested in events of type <b>e</b>. We use this
236  * so that we can decide to skip generating event messages that nobody
237  * has interest in without having to walk over the global connection
238  * list to find out.
239  **/
240 typedef uint64_t event_mask_t;
241 
242 /* Recognized asynchronous event types. It's okay to expand this list
243  * because it is used both as a list of v0 event types, and as indices
244  * into the bitfield to determine which controllers want which events.
245  */
246 /* This bitfield has no event zero 0x0000 */
247 #define EVENT_MIN_ 0x0001
248 #define EVENT_CIRCUIT_STATUS 0x0001
249 #define EVENT_STREAM_STATUS 0x0002
250 #define EVENT_OR_CONN_STATUS 0x0003
251 #define EVENT_BANDWIDTH_USED 0x0004
252 #define EVENT_CIRCUIT_STATUS_MINOR 0x0005
253 #define EVENT_NEW_DESC 0x0006
254 #define EVENT_DEBUG_MSG 0x0007
255 #define EVENT_INFO_MSG 0x0008
256 #define EVENT_NOTICE_MSG 0x0009
257 #define EVENT_WARN_MSG 0x000A
258 #define EVENT_ERR_MSG 0x000B
259 #define EVENT_ADDRMAP 0x000C
260 /* There was an AUTHDIR_NEWDESCS event, but it no longer exists. We
261  can reclaim 0x000D. */
262 #define EVENT_DESCCHANGED 0x000E
263 /* Exposed above */
264 // #define EVENT_NS 0x000F
265 #define EVENT_STATUS_CLIENT 0x0010
266 #define EVENT_STATUS_SERVER 0x0011
267 #define EVENT_STATUS_GENERAL 0x0012
268 #define EVENT_GUARD 0x0013
269 #define EVENT_STREAM_BANDWIDTH_USED 0x0014
270 #define EVENT_CLIENTS_SEEN 0x0015
271 #define EVENT_NEWCONSENSUS 0x0016
272 #define EVENT_BUILDTIMEOUT_SET 0x0017
273 #define EVENT_GOT_SIGNAL 0x0018
274 #define EVENT_CONF_CHANGED 0x0019
275 #define EVENT_CONN_BW 0x001A
276 #define EVENT_CELL_STATS 0x001B
277 /* UNUSED : 0x001C */
278 #define EVENT_CIRC_BANDWIDTH_USED 0x001D
279 #define EVENT_TRANSPORT_LAUNCHED 0x0020
280 #define EVENT_HS_DESC 0x0021
281 #define EVENT_HS_DESC_CONTENT 0x0022
282 #define EVENT_NETWORK_LIVENESS 0x0023
283 #define EVENT_PT_LOG 0x0024
284 #define EVENT_PT_STATUS 0x0025
285 #define EVENT_MAX_ 0x0025
286 
287 /* sizeof(control_connection_t.event_mask) in bits, currently a uint64_t */
288 #define EVENT_CAPACITY_ 0x0040
289 
290 /* If EVENT_MAX_ ever hits 0x0040, we need to make the mask into a
291  * different structure, as it can only handle a maximum left shift of 1<<63. */
292 CTASSERT(EVENT_MAX_ < EVENT_CAPACITY_);
293 
294 #define EVENT_MASK_(e) (((uint64_t)1)<<(e))
295 
296 #define EVENT_MASK_NONE_ ((uint64_t)0x0)
297 
298 #define EVENT_MASK_ABOVE_MIN_ ((~((uint64_t)0x0)) << EVENT_MIN_)
299 #define EVENT_MASK_BELOW_MAX_ ((~((uint64_t)0x0)) \
300  >> (EVENT_CAPACITY_ - EVENT_MAX_ \
301  - EVENT_MIN_))
302 
303 #define EVENT_MASK_ALL_ (EVENT_MASK_ABOVE_MIN_ \
304  & EVENT_MASK_BELOW_MAX_)
305 
306 /** Helper structure: temporarily stores cell statistics for a circuit. */
307 typedef struct cell_stats_t {
308  /** Number of cells added in app-ward direction by command. */
309  uint64_t added_cells_appward[CELL_COMMAND_MAX_ + 1];
310  /** Number of cells added in exit-ward direction by command. */
311  uint64_t added_cells_exitward[CELL_COMMAND_MAX_ + 1];
312  /** Number of cells removed in app-ward direction by command. */
313  uint64_t removed_cells_appward[CELL_COMMAND_MAX_ + 1];
314  /** Number of cells removed in exit-ward direction by command. */
315  uint64_t removed_cells_exitward[CELL_COMMAND_MAX_ + 1];
316  /** Total waiting time of cells in app-ward direction by command. */
317  uint64_t total_time_appward[CELL_COMMAND_MAX_ + 1];
318  /** Total waiting time of cells in exit-ward direction by command. */
319  uint64_t total_time_exitward[CELL_COMMAND_MAX_ + 1];
320 } cell_stats_t;
321 
323  cell_stats_t *cell_stats);
324 void append_cell_stats_by_command(smartlist_t *event_parts,
325  const char *key,
326  const uint64_t *include_if_non_zero,
327  const uint64_t *number_to_include);
328 void format_cell_stats(char **event_string, circuit_t *circ,
329  cell_stats_t *cell_stats);
330 
331 /** Helper structure: maps event values to their names. */
332 struct control_event_t {
333  uint16_t event_code;
334  const char *event_name;
335 };
336 
337 extern const struct control_event_t control_event_table[];
338 
339 #ifdef TOR_UNIT_TESTS
340 MOCK_DECL(STATIC void,
341  send_control_event_string,(uint16_t event, const char *msg));
342 
343 MOCK_DECL(STATIC void,
344  queue_control_event_string,(uint16_t event, char *msg));
345 
346 void control_testing_set_global_event_mask(uint64_t mask);
347 
348 #endif /* defined(TOR_UNIT_TESTS) */
349 
350 #endif /* defined(CONTROL_EVENTS_PRIVATE) */
351 
352 #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)
int control_event_client_error(const char *format,...)
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)
int control_event_server_status(int severity, const char *format,...)
#define CTASSERT(x)
Definition: ctassert.h:44
STATIC void queue_control_event_string(uint16_t event, char *msg)
void control_event_boot_first_orconn(void)
int control_event_general_status(int severity, const char *format,...)
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_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
int control_event_general_error(const char *format,...)
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
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)
const struct control_event_t control_event_table[]
void control_event_transport_launched(const char *mode, const char *transport_name, tor_addr_t *addr, uint16_t port)
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_any_per_second_event_enabled(void)
int control_event_server_error(const char *format,...)
void control_event_hs_descriptor_uploaded(const char *hs_dir, const char *onion_address)
Compile-time assertions: CTASSERT(expression).
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_client_status(int severity, const char *format,...)
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)
Header file for ocirc_event.c.
int control_event_conn_bandwidth(connection_t *conn)
void control_event_pt_status(const char *status)
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)
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
int control_event_guard(const char *nickname, const char *digest, const char *status)