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 */
7 /**
8  * \file relay.h
9  * \brief Header file for relay.c.
10  **/
12 #ifndef TOR_RELAY_H
13 #define TOR_RELAY_H
15 extern uint64_t stats_n_relay_cells_relayed;
16 extern uint64_t stats_n_relay_cells_delivered;
17 extern uint64_t stats_n_circ_max_cell_reached;
19 void relay_consensus_has_changed(const networkstatus_t *ns);
21  cell_direction_t cell_direction);
22 size_t cell_queues_get_total_allocation(void);
24 void relay_header_pack(uint8_t *dest, const relay_header_t *src);
25 void relay_header_unpack(relay_header_t *dest, const uint8_t *src);
26 MOCK_DECL(int,
28  uint8_t relay_command, const char *payload,
29  size_t payload_len, crypt_path_t *cpath_layer,
30  const char *filename, int lineno));
31 /* Indicates to relay_send_command_from_edge() that it is a control cell. */
32 #define CONTROL_CELL_ID 0
33 #define relay_send_command_from_edge(stream_id, circ, relay_command, payload, \
34  payload_len, cpath_layer) \
35  relay_send_command_from_edge_((stream_id), (circ), (relay_command), \
36  (payload), (payload_len), (cpath_layer), \
37  __FILE__, __LINE__)
39  uint8_t relay_command, const char *payload,
40  size_t payload_len);
42  int package_partial,
43  int *max_cells);
44 void connection_edge_consider_sending_sendme(edge_connection_t *conn);
47 extern uint64_t stats_n_data_cells_packaged;
48 extern uint64_t stats_n_data_bytes_packaged;
49 extern uint64_t stats_n_data_cells_received;
50 extern uint64_t stats_n_data_bytes_received;
52 void dump_cell_pool_usage(int severity);
53 size_t packed_cell_mem_cost(void);
57 /* For channeltls.c */
59 #define packed_cell_free(cell) \
60  FREE_AND_NULL(packed_cell_t, packed_cell_free_, (cell))
62 void cell_queue_init(cell_queue_t *queue);
63 void cell_queue_clear(cell_queue_t *queue);
64 void cell_queue_append(cell_queue_t *queue, packed_cell_t *cell);
66  int exitward, const cell_t *cell,
67  int wide_circ_ids, int use_stats);
70  cell_t *cell, cell_direction_t direction,
71  streamid_t fromstream);
76  circid_t circid,
77  uint8_t reason);
79 void channel_unlink_all_circuits(channel_t *chan, smartlist_t *detached_out);
81  (channel_t *chan, int max));
83  cell_direction_t cell_direction,
84  crypt_path_t *layer_hint, streamid_t on_stream,
85  const char *filename, int lineno));
88  const char *file, int lineno);
89 #define update_circuit_on_cmux(circ, direction) \
90  update_circuit_on_cmux_((circ), (direction), SHORT_FILE__, __LINE__)
92 int append_address_to_payload(uint8_t *payload_out, const tor_addr_t *addr);
93 const uint8_t *decode_address_from_payload(tor_addr_t *addr_out,
94  const uint8_t *payload,
95  int payload_len);
98 circid_t packed_cell_get_circid(const packed_cell_t *cell, int wide_circ_ids);
99 uint8_t packed_cell_get_command(const packed_cell_t *cell, int wide_circ_ids);
101 #ifdef RELAY_PRIVATE
102 STATIC int
104  edge_connection_t *conn, crypt_path_t *layer_hint,
105  relay_header_t *rh, int optimistic_data);
107 STATIC int connected_cell_parse(const relay_header_t *rh, const cell_t *cell,
108  tor_addr_t *addr_out, int *ttl_out);
109 /** An address-and-ttl tuple as yielded by resolved_cell_parse */
110 typedef struct address_ttl_t {
111  tor_addr_t addr;
112  char *hostname;
113  int ttl;
114 } address_ttl_t;
115 STATIC void address_ttl_free_(address_ttl_t *addr);
116 #define address_ttl_free(addr) \
117  FREE_AND_NULL(address_ttl_t, address_ttl_free_, (addr))
118 STATIC int resolved_cell_parse(const cell_t *cell, const relay_header_t *rh,
119  smartlist_t *addresses_out, int *errcode_out);
121  const cell_t *cell,
122  const relay_header_t *rh);
128  edge_connection_t *conn,
129  crypt_path_t *layer_hint);
130 STATIC size_t get_pad_cell_offset(size_t payload_len);
131 STATIC size_t connection_edge_get_inbuf_bytes_to_package(size_t n_available,
132  int package_partial,
133  circuit_t *on_circuit);
135 #endif /* defined(RELAY_PRIVATE) */
137 #endif /* !defined(TOR_RELAY_H) */
STATIC void address_ttl_free_(address_ttl_t *addr)
Definition: relay.c:1104
STATIC destroy_cell_t * destroy_cell_queue_pop(destroy_cell_queue_t *queue)
Definition: relay.c:2631
STATIC int connected_cell_parse(const relay_header_t *rh, const cell_t *cell, tor_addr_t *addr_out, int *ttl_out)
Definition: relay.c:1066
uint64_t stats_n_relay_cells_relayed
Definition: relay.c:125
const uint8_t * decode_address_from_payload(tor_addr_t *addr_out, const uint8_t *payload, int payload_len)
Definition: relay.c:3202
STATIC int cell_queues_check_size(void)
Definition: relay.c:2697
STATIC packed_cell_t * packed_cell_new(void)
Definition: relay.c:2503
uint64_t stats_n_circ_max_cell_reached
Definition: relay.c:132
void circuit_reset_sendme_randomness(circuit_t *circ)
Definition: relay.c:2060
uint64_t stats_n_data_cells_received
Definition: relay.c:2048
Definition: cell_st.h:17
void relay_header_unpack(relay_header_t *dest, const uint8_t *src)
Definition: relay.c:488
void cell_queue_init(cell_queue_t *queue)
Definition: relay.c:2575
void append_cell_to_circuit_queue(circuit_t *circ, channel_t *chan, cell_t *cell, cell_direction_t direction, streamid_t fromstream)
Definition: relay.c:3103
int channel_flush_from_first_active_circuit(channel_t *chan, int max)
Definition: relay.c:2890
void packed_cell_free_(packed_cell_t *cell)
Definition: relay.c:2511
int connection_edge_send_command(edge_connection_t *fromconn, uint8_t relay_command, const char *payload, size_t payload_len)
Definition: relay.c:729
int connection_edge_package_raw_inbuf(edge_connection_t *conn, int package_partial, int *max_cells)
Definition: relay.c:2143
STATIC int connection_edge_process_relay_cell(cell_t *cell, circuit_t *circ, edge_connection_t *conn, crypt_path_t *layer_hint)
Definition: relay.c:1972
void relay_header_pack(uint8_t *dest, const relay_header_t *src)
Definition: relay.c:475
#define STATIC
Definition: testsupport.h:32
size_t packed_cell_mem_cost(void)
Definition: relay.c:2676
void cell_queue_append(cell_queue_t *queue, packed_cell_t *cell)
Definition: relay.c:2548
Definition: or.h:482
int relay_send_command_from_edge_(streamid_t stream_id, circuit_t *circ, uint8_t relay_command, const char *payload, size_t payload_len, crypt_path_t *cpath_layer, const char *filename, int lineno)
Definition: relay.c:608
uint16_t streamid_t
Definition: or.h:610
STATIC int handle_relay_cell_command(cell_t *cell, circuit_t *circ, edge_connection_t *conn, crypt_path_t *layer_hint, relay_header_t *rh, int optimistic_data)
Definition: relay.c:1589
uint64_t stats_n_data_bytes_received
Definition: relay.c:2052
void cell_queue_append_packed_copy(circuit_t *circ, cell_queue_t *queue, int exitward, const cell_t *cell, int wide_circ_ids, int use_stats)
Definition: relay.c:2559
STATIC packed_cell_t * cell_queue_pop(cell_queue_t *queue)
Definition: relay.c:2597
void destroy_cell_queue_init(destroy_cell_queue_t *queue)
Definition: relay.c:2609
void update_circuit_on_cmux_(circuit_t *circ, cell_direction_t direction, const char *file, int lineno)
Definition: relay.c:2754
uint64_t stats_n_data_cells_packaged
Definition: relay.c:2042
void destroy_cell_queue_clear(destroy_cell_queue_t *queue)
Definition: relay.c:2617
int circuit_package_relay_cell(cell_t *cell, circuit_t *circ, cell_direction_t cell_direction, crypt_path_t *layer_hint, streamid_t on_stream, const char *filename, int lineno)
Definition: relay.c:361
uint8_t packed_cell_get_command(const packed_cell_t *cell, int wide_circ_ids)
Definition: relay.c:2865
uint64_t stats_n_data_bytes_packaged
Definition: relay.c:2046
void channel_unlink_all_circuits(channel_t *chan, smartlist_t *detached_out)
Definition: relay.c:2799
void dump_cell_pool_usage(int severity)
Definition: relay.c:2521
uint64_t stats_n_relay_cells_delivered
Definition: relay.c:129
uint32_t circid_t
Definition: or.h:608
int have_been_under_memory_pressure(void)
Definition: relay.c:2743
STATIC size_t connection_edge_get_inbuf_bytes_to_package(size_t n_available, int package_partial, circuit_t *on_circuit)
Definition: relay.c:2079
STATIC int connection_edge_process_resolved_cell(edge_connection_t *conn, const cell_t *cell, const relay_header_t *rh)
Definition: relay.c:1289
#define MOCK_DECL(rv, funcname, arglist)
Definition: testsupport.h:127
STATIC int resolved_cell_parse(const cell_t *cell, const relay_header_t *rh, smartlist_t *addresses_out, int *errcode_out)
Definition: relay.c:1118
void destroy_cell_queue_append(destroy_cell_queue_t *queue, circid_t circid, uint8_t reason)
Definition: relay.c:2643
void circuit_clear_cell_queue(circuit_t *circ, channel_t *chan)
Definition: relay.c:3230
STATIC size_t get_pad_cell_offset(size_t data_len)
Definition: relay.c:553
circid_t packed_cell_get_circid(const packed_cell_t *cell, int wide_circ_ids)
Definition: relay.c:2876
int append_address_to_payload(uint8_t *payload_out, const tor_addr_t *addr)
Definition: relay.c:3176
int circuit_receive_relay_cell(cell_t *cell, circuit_t *circ, cell_direction_t cell_direction)
Definition: relay.c:223
void cell_queue_clear(cell_queue_t *queue)
Definition: relay.c:2583