Tor  0.4.7.0-alpha-dev
circuitlist.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-2021, The Tor Project, Inc. */
5 /* See LICENSE for licensing information */
6 
7 /**
8  * \file circuitlist.h
9  * \brief Header file for circuitlist.c.
10  **/
11 
12 #ifndef TOR_CIRCUITLIST_H
13 #define TOR_CIRCUITLIST_H
14 
15 #include "lib/container/handles.h"
17 #include "feature/hs/hs_ident.h"
18 #include "core/or/ocirc_event.h"
19 
20 /** Circuit state: I'm the origin, still haven't done all my handshakes. */
21 #define CIRCUIT_STATE_BUILDING 0
22 /** Circuit state: Waiting to process the onionskin. */
23 #define CIRCUIT_STATE_ONIONSKIN_PENDING 1
24 /** Circuit state: I'd like to deliver a create, but my n_chan is still
25  * connecting. */
26 #define CIRCUIT_STATE_CHAN_WAIT 2
27 /** Circuit state: the circuit is open but we don't want to actually use it
28  * until we find out if a better guard will be available.
29  */
30 #define CIRCUIT_STATE_GUARD_WAIT 3
31 /** Circuit state: onionskin(s) processed, ready to send/receive cells. */
32 #define CIRCUIT_STATE_OPEN 4
33 
34 #define CIRCUIT_PURPOSE_MIN_ 1
35 
36 /* these circuits were initiated elsewhere */
37 #define CIRCUIT_PURPOSE_OR_MIN_ 1
38 /** OR-side circuit purpose: normal circuit, at OR. */
39 #define CIRCUIT_PURPOSE_OR 1
40 /** OR-side circuit purpose: At OR, from the service, waiting for intro from
41  * clients. */
42 #define CIRCUIT_PURPOSE_INTRO_POINT 2
43 /** OR-side circuit purpose: At OR, from the client, waiting for the service.
44  */
45 #define CIRCUIT_PURPOSE_REND_POINT_WAITING 3
46 /** OR-side circuit purpose: At OR, both circuits have this purpose. */
47 #define CIRCUIT_PURPOSE_REND_ESTABLISHED 4
48 #define CIRCUIT_PURPOSE_OR_MAX_ 4
49 
50 /* these circuits originate at this node */
51 
52 /* here's how circ client-side purposes work:
53  * normal circuits are C_GENERAL.
54  * circuits that are c_introducing are either on their way to
55  * becoming open, or they are open and waiting for a
56  * suitable rendcirc before they send the intro.
57  * circuits that are c_introduce_ack_wait have sent the intro,
58  * but haven't gotten a response yet.
59  * circuits that are c_establish_rend are either on their way
60  * to becoming open, or they are open and have sent the
61  * establish_rendezvous cell but haven't received an ack.
62  * circuits that are c_rend_ready are open and have received a
63  * rend ack, but haven't heard from the service yet.
64  * circuits that are c_rend_ready_intro_acked are open, and
65  * some intro circ has sent its intro and received an ack.
66  * circuits that are c_rend_joined are open, have heard from
67  * the service, and are talking to it.
68  */
69 /** Client-side circuit purpose: Normal circuit, with cpath. */
70 #define CIRCUIT_PURPOSE_C_GENERAL 5
71 #define CIRCUIT_PURPOSE_C_HS_MIN_ 6
72 /** Client-side circuit purpose: at the client, connecting to intro point. */
73 #define CIRCUIT_PURPOSE_C_INTRODUCING 6
74 /** Client-side circuit purpose: at the client, sent INTRODUCE1 to intro point,
75  * waiting for ACK/NAK. */
76 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACK_WAIT 7
77 /** Client-side circuit purpose: at the client, introduced and acked, closing.
78  */
79 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACKED 8
80 /** Client-side circuit purpose: at the client, waiting for ack. */
81 #define CIRCUIT_PURPOSE_C_ESTABLISH_REND 9
82 /** Client-side circuit purpose: at the client, waiting for the service. */
83 #define CIRCUIT_PURPOSE_C_REND_READY 10
84 /** Client-side circuit purpose: at the client, waiting for the service,
85  * INTRODUCE has been acknowledged. */
86 #define CIRCUIT_PURPOSE_C_REND_READY_INTRO_ACKED 11
87 /** Client-side circuit purpose: at the client, rendezvous established. */
88 #define CIRCUIT_PURPOSE_C_REND_JOINED 12
89 /** This circuit is used for getting hsdirs */
90 #define CIRCUIT_PURPOSE_C_HSDIR_GET 13
91 #define CIRCUIT_PURPOSE_C_HS_MAX_ 13
92 /** This circuit is used for build time measurement only */
93 #define CIRCUIT_PURPOSE_C_MEASURE_TIMEOUT 14
94 /** This circuit is being held open by circuit padding */
95 #define CIRCUIT_PURPOSE_C_CIRCUIT_PADDING 15
96 #define CIRCUIT_PURPOSE_C_MAX_ 15
97 
98 #define CIRCUIT_PURPOSE_S_HS_MIN_ 16
99 /** Hidden-service-side circuit purpose: at the service, waiting for
100  * introductions. */
101 #define CIRCUIT_PURPOSE_S_ESTABLISH_INTRO 16
102 /** Hidden-service-side circuit purpose: at the service, successfully
103  * established intro. */
104 #define CIRCUIT_PURPOSE_S_INTRO 17
105 /** Hidden-service-side circuit purpose: at the service, connecting to rend
106  * point. */
107 #define CIRCUIT_PURPOSE_S_CONNECT_REND 18
108 /** Hidden-service-side circuit purpose: at the service, rendezvous
109  * established. */
110 #define CIRCUIT_PURPOSE_S_REND_JOINED 19
111 /** This circuit is used for uploading hsdirs */
112 #define CIRCUIT_PURPOSE_S_HSDIR_POST 20
113 #define CIRCUIT_PURPOSE_S_HS_MAX_ 20
114 
115 /** A testing circuit; not meant to be used for actual traffic. It is used for
116  * bandwidth measurement, reachability test and address discovery from an
117  * authority using the NETINFO cell. */
118 #define CIRCUIT_PURPOSE_TESTING 21
119 /** A controller made this circuit and Tor should not cannibalize it or attach
120  * streams to it without explicitly being told. */
121 #define CIRCUIT_PURPOSE_CONTROLLER 22
122 /** This circuit is used for path bias probing only */
123 #define CIRCUIT_PURPOSE_PATH_BIAS_TESTING 23
124 
125 /** This circuit is used for vanguards/restricted paths.
126  *
127  * This type of circuit is *only* created preemptively and never
128  * on-demand. When an HS operation needs to take place (e.g. connect to an
129  * intro point), these circuits are then cannibalized and repurposed to the
130  * actual needed HS purpose. */
131 #define CIRCUIT_PURPOSE_HS_VANGUARDS 24
132 
133 #define CIRCUIT_PURPOSE_MAX_ 24
134 /** A catch-all for unrecognized purposes. Currently we don't expect
135  * to make or see any circuits with this purpose. */
136 #define CIRCUIT_PURPOSE_UNKNOWN 255
137 
138 /** True iff the circuit purpose <b>p</b> is for a circuit that
139  * originated at this node. */
140 #define CIRCUIT_PURPOSE_IS_ORIGIN(p) ((p)>CIRCUIT_PURPOSE_OR_MAX_)
141 /** True iff the circuit purpose <b>p</b> is for a circuit that originated
142  * here to serve as a client. (Hidden services don't count here.) */
143 #define CIRCUIT_PURPOSE_IS_CLIENT(p) \
144  ((p)> CIRCUIT_PURPOSE_OR_MAX_ && \
145  (p)<=CIRCUIT_PURPOSE_C_MAX_)
146 /** True iff the circuit_t <b>c</b> is actually an origin_circuit_t. */
147 #define CIRCUIT_IS_ORIGIN(c) (CIRCUIT_PURPOSE_IS_ORIGIN((c)->purpose))
148 /** True iff the circuit purpose <b>p</b> is for an established rendezvous
149  * circuit. */
150 #define CIRCUIT_PURPOSE_IS_ESTABLISHED_REND(p) \
151  ((p) == CIRCUIT_PURPOSE_C_REND_JOINED || \
152  (p) == CIRCUIT_PURPOSE_S_REND_JOINED)
153 /** True iff the circuit_t c is actually an or_circuit_t */
154 #define CIRCUIT_IS_ORCIRC(c) (((circuit_t *)(c))->magic == OR_CIRCUIT_MAGIC)
155 
156 /** True iff this circuit purpose should count towards the global
157  * pending rate limit (set by MaxClientCircuitsPending). We count all
158  * general purpose circuits, as well as the first step of client onion
159  * service connections (HSDir gets). */
160 #define CIRCUIT_PURPOSE_COUNTS_TOWARDS_MAXPENDING(p) \
161  ((p) == CIRCUIT_PURPOSE_C_GENERAL || \
162  (p) == CIRCUIT_PURPOSE_C_HSDIR_GET)
163 
164 /** Convert a circuit_t* to a pointer to the enclosing or_circuit_t. Assert
165  * if the cast is impossible. */
167 const or_circuit_t *CONST_TO_OR_CIRCUIT(const circuit_t *);
168 /** Convert a circuit_t* to a pointer to the enclosing origin_circuit_t.
169  * Assert if the cast is impossible. */
171 const origin_circuit_t *CONST_TO_ORIGIN_CIRCUIT(const circuit_t *);
172 
177 void circuit_cache_opened_circuit_state(int circuits_are_opened);
178 
179 const char *circuit_state_to_string(int state);
180 const char *circuit_purpose_to_controller_string(uint8_t purpose);
181 const char *circuit_purpose_to_controller_hs_state_string(uint8_t purpose);
182 const char *circuit_purpose_to_string(uint8_t purpose);
183 void circuit_dump_by_conn(connection_t *conn, int severity);
185  channel_t *chan);
187  channel_t *chan);
191  channel_t *chan);
193  int reason_code);
194 void circuit_set_state(circuit_t *circ, uint8_t state);
195 void circuit_close_all_marked(void);
196 int32_t circuit_initial_package_window(void);
198 or_circuit_t *or_circuit_new(circid_t p_circ_id, channel_t *p_chan);
200  channel_t *chan);
201 circuit_t *
203  channel_t *chan);
206 void circuit_unlink_all_from_channel(channel_t *chan, int reason);
209  uint8_t purpose);
211  bool want_client_circ);
213 origin_circuit_t *circuit_get_next_service_hsdir_circ(origin_circuit_t *start);
215  extend_info_t *info, int flags);
220 MOCK_DECL(void, circuit_mark_for_close_, (circuit_t *circ, int reason,
221  int line, const char *cfile));
227  channel_t *chan);
229 
230 #define circuit_mark_for_close(c, reason) \
231  circuit_mark_for_close_((c), (reason), __LINE__, SHORT_FILE__)
232 
233 MOCK_DECL(void, assert_circuit_ok,(const circuit_t *c));
234 void circuit_free_all(void);
235 size_t circuits_handle_oom(size_t current_allocation);
236 
238 
241  (channel_t *chan, circid_t id));
242 
244 
245 /* Declare the handle helpers */
246 HANDLE_DECL(circuit, circuit_t, )
247 #define circuit_handle_free(h) \
248  FREE_AND_NULL(circuit_handle_t, circuit_handle_free_, (h))
249 
250 #ifdef CIRCUITLIST_PRIVATE
251 STATIC void circuit_free_(circuit_t *circ);
252 #define circuit_free(circ) FREE_AND_NULL(circuit_t, circuit_free_, (circ))
253 STATIC size_t n_cells_in_circ_queues(const circuit_t *c);
254 STATIC uint32_t circuit_max_queued_data_age(const circuit_t *c, uint32_t now);
255 STATIC uint32_t circuit_max_queued_cell_age(const circuit_t *c, uint32_t now);
256 STATIC uint32_t circuit_max_queued_item_age(const circuit_t *c, uint32_t now);
257 #endif /* defined(CIRCUITLIST_PRIVATE) */
258 
259 #endif /* !defined(TOR_CIRCUITLIST_H) */
STATIC uint32_t circuit_max_queued_item_age(const circuit_t *c, uint32_t now)
Definition: circuitlist.c:2537
STATIC void circuit_free_(circuit_t *circ)
Definition: circuitlist.c:1126
STATIC size_t n_cells_in_circ_queues(const circuit_t *c)
Definition: circuitlist.c:2424
STATIC uint32_t circuit_max_queued_data_age(const circuit_t *c, uint32_t now)
Definition: circuitlist.c:2522
STATIC uint32_t circuit_max_queued_cell_age(const circuit_t *c, uint32_t now)
Definition: circuitlist.c:2457
const char * circuit_purpose_to_controller_hs_state_string(uint8_t purpose)
Definition: circuitlist.c:843
circuit_t * circuit_get_by_circid_channel_even_if_marked(circid_t circ_id, channel_t *chan)
Definition: circuitlist.c:1525
void circuit_mark_for_close_(circuit_t *circ, int reason, int line, const char *cfile)
Definition: circuitlist.c:2155
void circuit_close_all_marked(void)
Definition: circuitlist.c:662
int circuit_any_opened_circuits_cached(void)
Definition: circuitlist.c:755
void channel_note_destroy_pending(channel_t *chan, circid_t id)
Definition: circuitlist.c:409
origin_circuit_t * circuit_get_next_intro_circ(const origin_circuit_t *start, bool want_client_circ)
Definition: circuitlist.c:1686
int circuit_id_in_use_on_channel(circid_t circ_id, channel_t *chan)
Definition: circuitlist.c:1539
void circuit_synchronize_written_or_bandwidth(const circuit_t *c, circuit_channel_direction_t dir)
Definition: circuitlist.c:2092
void circuit_set_n_circid_chan(circuit_t *circ, circid_t id, channel_t *chan)
Definition: circuitlist.c:474
or_circuit_t * TO_OR_CIRCUIT(circuit_t *)
Definition: circuitlist.c:154
circuit_t * circuit_get_by_circid_channel(circid_t circ_id, channel_t *chan)
Definition: circuitlist.c:1510
void circuit_mark_all_dirty_circs_as_unusable(void)
Definition: circuitlist.c:2064
origin_circuit_t * origin_circuit_new(void)
Definition: circuitlist.c:1018
void circuit_clear_cpath(origin_circuit_t *circ)
Definition: circuitlist.c:1278
void circuit_set_state(circuit_t *circ, uint8_t state)
Definition: circuitlist.c:543
void circuit_free_all(void)
Definition: circuitlist.c:1302
origin_circuit_t * circuit_get_next_by_purpose(origin_circuit_t *start, uint8_t purpose)
Definition: circuitlist.c:1769
circuit_t * circuit_get_by_edge_conn(edge_connection_t *conn)
Definition: circuitlist.c:1571
origin_circuit_t * TO_ORIGIN_CIRCUIT(circuit_t *)
Definition: circuitlist.c:166
int circuit_get_cpath_opened_len(const origin_circuit_t *)
Definition: circuitlist.c:2009
const char * circuit_purpose_to_string(uint8_t purpose)
Definition: circuitlist.c:903
void channel_mark_circid_unusable(channel_t *chan, circid_t id)
Definition: circuitlist.c:353
void circuit_dump_by_conn(connection_t *conn, int severity)
Definition: circuitlist.c:1377
int circuit_any_opened_circuits(void)
Definition: circuitlist.c:718
const char * circuit_purpose_to_controller_string(uint8_t purpose)
Definition: circuitlist.c:782
int circuit_get_cpath_len(origin_circuit_t *circ)
Definition: circuitlist.c:1993
smartlist_t * circuit_find_circuits_to_upgrade_from_guard_wait(void)
Definition: circuitlist.c:1965
void channel_mark_circid_usable(channel_t *chan, circid_t id)
Definition: circuitlist.c:386
void circuit_set_p_circid_chan(or_circuit_t *circ, circid_t id, channel_t *chan)
Definition: circuitlist.c:451
void assert_circuit_ok(const circuit_t *c)
Definition: circuitlist.c:2716
smartlist_t * circuit_get_global_list(void)
Definition: circuitlist.c:694
origin_circuit_t * circuit_find_to_cannibalize(uint8_t purpose, extend_info_t *info, int flags)
Definition: circuitlist.c:1855
int circuit_count_pending_on_channel(channel_t *chan)
Definition: circuitlist.c:609
size_t circuits_handle_oom(size_t current_allocation)
Definition: circuitlist.c:2593
void circuit_get_all_pending_on_channel(smartlist_t *out, channel_t *chan)
Definition: circuitlist.c:578
smartlist_t * circuit_get_global_origin_circuit_list(void)
Definition: circuitlist.c:703
int circuit_event_status(origin_circuit_t *circ, circuit_status_event_t tp, int reason_code)
Definition: circuitlist.c:499
crypt_path_t * circuit_get_cpath_hop(origin_circuit_t *circ, int hopnum)
Definition: circuitlist.c:2029
time_t circuit_id_when_marked_unusable_on_channel(circid_t circ_id, channel_t *chan)
Definition: circuitlist.c:1552
void circuit_cache_opened_circuit_state(int circuits_are_opened)
Definition: circuitlist.c:744
origin_circuit_t * circuit_get_next_service_rp_circ(origin_circuit_t *start)
Definition: circuitlist.c:1738
void channel_note_destroy_not_pending(channel_t *chan, circid_t id)
Definition: circuitlist.c:429
const char * circuit_state_to_string(int state)
Definition: circuitlist.c:762
void circuit_clear_testing_cell_stats(circuit_t *circ)
Definition: circuitlist.c:1113
void circuit_unlink_all_from_channel(channel_t *chan, int reason)
Definition: circuitlist.c:1588
or_circuit_t * or_circuit_new(circid_t p_circ_id, channel_t *p_chan)
Definition: circuitlist.c:1091
origin_circuit_t * circuit_get_by_global_id(uint32_t id)
Definition: circuitlist.c:1418
void circuit_mark_all_unused_circs(void)
Definition: circuitlist.c:2045
int32_t circuit_initial_package_window(void)
Definition: circuitlist.c:975
Macros for C weak-handle implementation.
Header file containing circuit and connection identifier data for the whole HS subsystem.
Header file for ocirc_event.c.
circuit_status_event_t
Definition: ocirc_event.h:19
uint32_t circid_t
Definition: or.h:489
circuit_channel_direction_t
Definition: or.h:375
Macros to implement mocking and selective exposure for the test code.
#define STATIC
Definition: testsupport.h:32
#define MOCK_DECL(rv, funcname, arglist)
Definition: testsupport.h:127