Tor 0.4.9.2-alpha-dev
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
relay.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 relay.h
9 * \brief Header file for relay.c.
10 **/
11
12#ifndef TOR_RELAY_H
13#define TOR_RELAY_H
14
16
17extern uint64_t stats_n_relay_cells_relayed;
18extern uint64_t stats_n_relay_cells_delivered;
19extern uint64_t stats_n_circ_max_cell_reached;
20extern uint64_t stats_n_circ_max_cell_outq_reached;
21
22const char *relay_command_to_string(uint8_t command);
23
24void relay_consensus_has_changed(const networkstatus_t *ns);
25uint32_t relay_get_param_max_circuit_cell_queue_size(
26 const networkstatus_t *ns);
28 cell_direction_t cell_direction);
29size_t cell_queues_get_total_allocation(void);
30
31#ifdef TOR_UNIT_TESTS
32void relay_header_pack(uint8_t *dest, const relay_header_t *src);
33void relay_header_unpack(relay_header_t *dest, const uint8_t *src);
34#endif
35
36MOCK_DECL(int,
38 uint8_t relay_command, const char *payload,
39 size_t payload_len, crypt_path_t *cpath_layer,
40 const char *filename, int lineno));
41/* Indicates to relay_send_command_from_edge() that it is a control cell. */
42#define CONTROL_CELL_ID 0
43#define relay_send_command_from_edge(stream_id, circ, relay_command, payload, \
44 payload_len, cpath_layer) \
45 relay_send_command_from_edge_((stream_id), (circ), (relay_command), \
46 (payload), (payload_len), (cpath_layer), \
47 __FILE__, __LINE__)
49 uint8_t relay_command, const char *payload,
50 size_t payload_len);
52 int package_partial,
53 int *max_cells);
54void connection_edge_consider_sending_sendme(edge_connection_t *conn);
56
57extern uint64_t stats_n_data_cells_packaged;
58extern uint64_t stats_n_data_bytes_packaged;
59extern uint64_t stats_n_data_cells_received;
60extern uint64_t stats_n_data_bytes_received;
61
62extern uint64_t oom_stats_n_bytes_removed_dns;
63extern uint64_t oom_stats_n_bytes_removed_cell;
64extern uint64_t oom_stats_n_bytes_removed_geoip;
65extern uint64_t oom_stats_n_bytes_removed_hsdir;
66
67void dump_cell_pool_usage(int severity);
68size_t packed_cell_mem_cost(void);
69
71
72/* For channeltls.c */
74#define packed_cell_free(cell) \
75 FREE_AND_NULL(packed_cell_t, packed_cell_free_, (cell))
76
77void cell_queue_init(cell_queue_t *queue);
81 int exitward, const cell_t *cell,
82 int wide_circ_ids, int use_stats);
83
85 cell_t *cell, cell_direction_t direction,
86 streamid_t fromstream);
87
91 circid_t circid,
92 uint8_t reason);
93
94void channel_unlink_all_circuits(channel_t *chan, smartlist_t *detached_out);
96 (channel_t *chan, int max));
98 cell_direction_t cell_direction,
99 crypt_path_t *layer_hint, streamid_t on_stream,
100 const char *filename, int lineno));
101
103 const char *file, int lineno);
104#define update_circuit_on_cmux(circ, direction) \
105 update_circuit_on_cmux_((circ), (direction), SHORT_FILE__, __LINE__)
106
107int append_address_to_payload(uint8_t *payload_out, const tor_addr_t *addr);
108const uint8_t *decode_address_from_payload(tor_addr_t *addr_out,
109 const uint8_t *payload,
110 int payload_len);
112
113circid_t packed_cell_get_circid(const packed_cell_t *cell, int wide_circ_ids);
114uint8_t packed_cell_get_command(const packed_cell_t *cell, int wide_circ_ids);
115
117 const crypt_path_t *cpath);
118size_t circuit_max_relay_payload(const circuit_t *circ,
119 const crypt_path_t *cpath,
120 uint8_t relay_command);
121
122#ifdef RELAY_PRIVATE
123STATIC int
124handle_relay_msg(const relay_msg_t *msg, circuit_t *circ,
125 edge_connection_t *conn, crypt_path_t *layer_hint,
126 int optimistic_data);
127
128STATIC int connected_cell_parse(const relay_msg_t *msg, tor_addr_t *addr_out,
129 int *ttl_out);
130/** An address-and-ttl tuple as yielded by resolved_cell_parse */
131typedef struct address_ttl_t {
132 tor_addr_t addr;
133 char *hostname;
134 int ttl;
135} address_ttl_t;
136STATIC void address_ttl_free_(address_ttl_t *addr);
137#define address_ttl_free(addr) \
138 FREE_AND_NULL(address_ttl_t, address_ttl_free_, (addr))
140 smartlist_t *addresses_out, int *errcode_out);
142 const relay_msg_t *msg);
148 circuit_t *circ,
149 edge_connection_t *conn,
150 crypt_path_t *layer_hint);
151STATIC size_t connection_edge_get_inbuf_bytes_to_package(size_t n_available,
152 int package_partial,
153 circuit_t *on_circuit,
154 crypt_path_t *cpath);
155
156#endif /* defined(RELAY_PRIVATE) */
157
158#endif /* !defined(TOR_RELAY_H) */
tor_cmdline_mode_t command
Definition: config.c:2477
uint32_t circid_t
Definition: or.h:579
uint16_t streamid_t
Definition: or.h:581
cell_direction_t
Definition: or.h:423
relay_cell_fmt_t
Definition: or.h:529
STATIC int resolved_cell_parse(const relay_msg_t *msg, smartlist_t *addresses_out, int *errcode_out)
Definition: relay.c:1154
STATIC int connection_edge_process_resolved_cell(edge_connection_t *conn, const relay_msg_t *msg)
Definition: relay.c:1324
STATIC int connection_edge_process_relay_cell(const relay_msg_t *msg, circuit_t *circ, edge_connection_t *conn, crypt_path_t *layer_hint)
Definition: relay.c:2042
STATIC packed_cell_t * packed_cell_new(void)
Definition: relay.c:2662
STATIC packed_cell_t * cell_queue_pop(cell_queue_t *queue)
Definition: relay.c:2756
STATIC destroy_cell_t * destroy_cell_queue_pop(destroy_cell_queue_t *queue)
Definition: relay.c:2790
STATIC int cell_queues_check_size(void)
Definition: relay.c:2862
STATIC int connected_cell_parse(const relay_msg_t *msg, tor_addr_t *addr_out, int *ttl_out)
Definition: relay.c:1102
STATIC size_t connection_edge_get_inbuf_bytes_to_package(size_t n_available, int package_partial, circuit_t *on_circuit, crypt_path_t *cpath)
Definition: relay.c:2211
STATIC void address_ttl_free_(address_ttl_t *addr)
Definition: relay.c:1140
STATIC int handle_relay_msg(const relay_msg_t *msg, circuit_t *circ, edge_connection_t *conn, crypt_path_t *layer_hint, int optimistic_data)
Definition: relay.c:1622
int channel_flush_from_first_active_circuit(channel_t *chan, int max)
Definition: relay.c:3093
void destroy_cell_queue_init(destroy_cell_queue_t *queue)
Definition: relay.c:2768
int append_address_to_payload(uint8_t *payload_out, const tor_addr_t *addr)
Definition: relay.c:3444
uint64_t stats_n_data_cells_received
Definition: relay.c:2186
void packed_cell_free_(packed_cell_t *cell)
Definition: relay.c:2670
void destroy_cell_queue_clear(destroy_cell_queue_t *queue)
Definition: relay.c:2776
void destroy_cell_queue_append(destroy_cell_queue_t *queue, circid_t circid, uint8_t reason)
Definition: relay.c:2802
relay_cell_fmt_t circuit_get_relay_format(const circuit_t *circ, const crypt_path_t *cpath)
Definition: relay.c:3538
int append_cell_to_circuit_queue(circuit_t *circ, channel_t *chan, cell_t *cell, cell_direction_t direction, streamid_t fromstream)
Definition: relay.c:3353
void channel_unlink_all_circuits(channel_t *chan, smartlist_t *detached_out)
Definition: relay.c:2985
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:2718
uint64_t oom_stats_n_bytes_removed_dns
Definition: relay.c:2854
void dump_cell_pool_usage(int severity)
Definition: relay.c:2680
void circuit_reset_sendme_randomness(circuit_t *circ)
Definition: relay.c:2198
uint64_t stats_n_relay_cells_relayed
Definition: relay.c:137
size_t circuit_max_relay_payload(const circuit_t *circ, const crypt_path_t *cpath, uint8_t relay_command)
Definition: relay.c:3556
uint64_t stats_n_circ_max_cell_reached
Definition: relay.c:144
uint64_t stats_n_data_cells_packaged
Definition: relay.c:2180
void cell_queue_clear(cell_queue_t *queue)
Definition: relay.c:2742
void circuit_clear_cell_queue(circuit_t *circ, channel_t *chan)
Definition: relay.c:3498
void cell_queue_init(cell_queue_t *queue)
Definition: relay.c:2734
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:397
int have_been_under_memory_pressure(void)
Definition: relay.c:2929
uint64_t stats_n_data_bytes_received
Definition: relay.c:2190
circid_t packed_cell_get_circid(const packed_cell_t *cell, int wide_circ_ids)
Definition: relay.c:3079
const uint8_t * decode_address_from_payload(tor_addr_t *addr_out, const uint8_t *payload, int payload_len)
Definition: relay.c:3470
void update_circuit_on_cmux_(circuit_t *circ, cell_direction_t direction, const char *file, int lineno)
Definition: relay.c:2940
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:588
uint8_t packed_cell_get_command(const packed_cell_t *cell, int wide_circ_ids)
Definition: relay.c:3068
uint64_t stats_n_relay_cells_delivered
Definition: relay.c:141
const char * relay_command_to_string(uint8_t command)
Definition: relay.c:533
void cell_queue_append(cell_queue_t *queue, packed_cell_t *cell)
Definition: relay.c:2707
int circuit_receive_relay_cell(cell_t *cell, circuit_t *circ, cell_direction_t cell_direction)
Definition: relay.c:236
int connection_edge_package_raw_inbuf(edge_connection_t *conn, int package_partial, int *max_cells)
Definition: relay.c:2282
int connection_edge_send_command(edge_connection_t *fromconn, uint8_t relay_command, const char *payload, size_t payload_len)
Definition: relay.c:766
uint64_t stats_n_data_bytes_packaged
Definition: relay.c:2184
size_t packed_cell_mem_cost(void)
Definition: relay.c:2835
A relay message which contains a relay command and parameters, if any, that is from a relay cell.
Definition: cell_st.h:17
#define STATIC
Definition: testsupport.h:32
#define MOCK_DECL(rv, funcname, arglist)
Definition: testsupport.h:127