tor  0.4.1.0-alpha-dev
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-2019, The Tor Project, Inc. */
5 /* See LICENSE for licensing information */
6 
12 #ifndef TOR_RELAY_H
13 #define TOR_RELAY_H
14 
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;
18 
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);
23 
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,
27 relay_send_command_from_edge_,(streamid_t stream_id, circuit_t *circ,
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);
45 
46 extern uint64_t stats_n_data_cells_packaged;
47 extern uint64_t stats_n_data_bytes_packaged;
48 extern uint64_t stats_n_data_cells_received;
49 extern uint64_t stats_n_data_bytes_received;
50 
51 void dump_cell_pool_usage(int severity);
52 size_t packed_cell_mem_cost(void);
53 
55 
56 /* For channeltls.c */
58 #define packed_cell_free(cell) \
59  FREE_AND_NULL(packed_cell_t, packed_cell_free_, (cell))
60 
61 void cell_queue_init(cell_queue_t *queue);
62 void cell_queue_clear(cell_queue_t *queue);
63 void cell_queue_append(cell_queue_t *queue, packed_cell_t *cell);
65  int exitward, const cell_t *cell,
66  int wide_circ_ids, int use_stats);
67 
69  cell_t *cell, cell_direction_t direction,
70  streamid_t fromstream);
71 
75  circid_t circid,
76  uint8_t reason);
77 
78 void channel_unlink_all_circuits(channel_t *chan, smartlist_t *detached_out);
79 MOCK_DECL(int, channel_flush_from_first_active_circuit,
80  (channel_t *chan, int max));
81 MOCK_DECL(int, circuit_package_relay_cell, (cell_t *cell, circuit_t *circ,
82  cell_direction_t cell_direction,
83  crypt_path_t *layer_hint, streamid_t on_stream,
84  const char *filename, int lineno));
85 
87  const char *file, int lineno);
88 #define update_circuit_on_cmux(circ, direction) \
89  update_circuit_on_cmux_((circ), (direction), SHORT_FILE__, __LINE__)
90 
91 int append_address_to_payload(uint8_t *payload_out, const tor_addr_t *addr);
92 const uint8_t *decode_address_from_payload(tor_addr_t *addr_out,
93  const uint8_t *payload,
94  int payload_len);
96 
97 circid_t packed_cell_get_circid(const packed_cell_t *cell, int wide_circ_ids);
98 
99 #ifdef RELAY_PRIVATE
100 STATIC int connected_cell_parse(const relay_header_t *rh, const cell_t *cell,
101  tor_addr_t *addr_out, int *ttl_out);
103 typedef struct address_ttl_s {
104  tor_addr_t addr;
105  char *hostname;
106  int ttl;
107 } address_ttl_t;
108 STATIC void address_ttl_free_(address_ttl_t *addr);
109 #define address_ttl_free(addr) \
110  FREE_AND_NULL(address_ttl_t, address_ttl_free_, (addr))
111 STATIC int resolved_cell_parse(const cell_t *cell, const relay_header_t *rh,
112  smartlist_t *addresses_out, int *errcode_out);
114  const cell_t *cell,
115  const relay_header_t *rh);
116 STATIC packed_cell_t *packed_cell_new(void);
119 STATIC int cell_queues_check_size(void);
120 STATIC int connection_edge_process_relay_cell(cell_t *cell, circuit_t *circ,
121  edge_connection_t *conn,
122  crypt_path_t *layer_hint);
123 
124 #endif /* defined(RELAY_PRIVATE) */
125 
126 #endif /* !defined(TOR_RELAY_H) */
STATIC void address_ttl_free_(address_ttl_t *addr)
Definition: relay.c:1031
STATIC destroy_cell_t * destroy_cell_queue_pop(destroy_cell_queue_t *queue)
Definition: relay.c:2540
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:993
uint64_t stats_n_relay_cells_relayed
Definition: relay.c:126
const uint8_t * decode_address_from_payload(tor_addr_t *addr_out, const uint8_t *payload, int payload_len)
Definition: relay.c:3111
STATIC int cell_queues_check_size(void)
Definition: relay.c:2606
STATIC packed_cell_t * packed_cell_new(void)
Definition: relay.c:2412
uint64_t stats_n_circ_max_cell_reached
Definition: relay.c:133
uint64_t stats_n_data_cells_received
Definition: relay.c:1971
Definition: cell_st.h:12
void relay_header_unpack(relay_header_t *dest, const uint8_t *src)
Definition: relay.c:484
void cell_queue_init(cell_queue_t *queue)
Definition: relay.c:2484
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:3012
void packed_cell_free_(packed_cell_t *cell)
Definition: relay.c:2420
int connection_edge_send_command(edge_connection_t *fromconn, uint8_t relay_command, const char *payload, size_t payload_len)
Definition: relay.c:656
int connection_edge_package_raw_inbuf(edge_connection_t *conn, int package_partial, int *max_cells)
Definition: relay.c:1988
void connection_edge_consider_sending_sendme(edge_connection_t *conn)
Definition: relay.c:2128
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:1442
void relay_header_pack(uint8_t *dest, const relay_header_t *src)
Definition: relay.c:471
size_t packed_cell_mem_cost(void)
Definition: relay.c:2585
void cell_queue_append(cell_queue_t *queue, packed_cell_t *cell)
Definition: relay.c:2457
cell_direction_t
Definition: or.h:482
uint16_t streamid_t
Definition: or.h:610
uint64_t stats_n_data_bytes_received
Definition: relay.c:1975
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:2468
STATIC packed_cell_t * cell_queue_pop(cell_queue_t *queue)
Definition: relay.c:2506
void destroy_cell_queue_init(destroy_cell_queue_t *queue)
Definition: relay.c:2518
void update_circuit_on_cmux_(circuit_t *circ, cell_direction_t direction, const char *file, int lineno)
Definition: relay.c:2663
uint64_t stats_n_data_cells_packaged
Definition: relay.c:1965
void destroy_cell_queue_clear(destroy_cell_queue_t *queue)
Definition: relay.c:2526
uint64_t stats_n_data_bytes_packaged
Definition: relay.c:1969
void channel_unlink_all_circuits(channel_t *chan, smartlist_t *detached_out)
Definition: relay.c:2708
void dump_cell_pool_usage(int severity)
Definition: relay.c:2430
uint64_t stats_n_relay_cells_delivered
Definition: relay.c:130
uint32_t circid_t
Definition: or.h:608
int have_been_under_memory_pressure(void)
Definition: relay.c:2652
STATIC int connection_edge_process_resolved_cell(edge_connection_t *conn, const cell_t *cell, const relay_header_t *rh)
Definition: relay.c:1216
#define MOCK_DECL(rv, funcname, arglist)
Definition: testsupport.h:94
STATIC int resolved_cell_parse(const cell_t *cell, const relay_header_t *rh, smartlist_t *addresses_out, int *errcode_out)
Definition: relay.c:1045
void destroy_cell_queue_append(destroy_cell_queue_t *queue, circid_t circid, uint8_t reason)
Definition: relay.c:2552
void circuit_clear_cell_queue(circuit_t *circ, channel_t *chan)
Definition: relay.c:3139
circid_t packed_cell_get_circid(const packed_cell_t *cell, int wide_circ_ids)
Definition: relay.c:2785
int append_address_to_payload(uint8_t *payload_out, const tor_addr_t *addr)
Definition: relay.c:3085
int circuit_receive_relay_cell(cell_t *cell, circuit_t *circ, cell_direction_t cell_direction)
Definition: relay.c:224
void cell_queue_clear(cell_queue_t *queue)
Definition: relay.c:2492