src/or/circuitlist.h

   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-2015, 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 "testsupport.h"
  16
  17 MOCK_DECL(smartlist_t *, circuit_get_global_list, (void));
  18 const char *circuit_state_to_string(int state);
  19 const char *circuit_purpose_to_controller_string(uint8_t purpose);
  20 const char *circuit_purpose_to_controller_hs_state_string(uint8_t purpose);
  21 const char *circuit_purpose_to_string(uint8_t purpose);
  22 void circuit_dump_by_conn(connection_t *conn, int severity);
  23 void circuit_set_p_circid_chan(or_circuit_t *circ, circid_t id,
  24                                channel_t *chan);
  25 void circuit_set_n_circid_chan(circuit_t *circ, circid_t id,
  26                                channel_t *chan);
  27 void channel_mark_circid_unusable(channel_t *chan, circid_t id);
  28 void channel_mark_circid_usable(channel_t *chan, circid_t id);
  29 time_t circuit_id_when_marked_unusable_on_channel(circid_t circ_id,
  30                                                   channel_t *chan);
  31 void circuit_set_state(circuit_t *circ, uint8_t state);
  32 void circuit_close_all_marked(void);
  33 int32_t circuit_initial_package_window(void);
  34 origin_circuit_t *origin_circuit_new(void);
  35 or_circuit_t *or_circuit_new(circid_t p_circ_id, channel_t *p_chan);
  36 circuit_t *circuit_get_by_circid_channel(circid_t circ_id,
  37                                          channel_t *chan);
  38 circuit_t *
  39 circuit_get_by_circid_channel_even_if_marked(circid_t circ_id,
  40                                              channel_t *chan);
  41 int circuit_id_in_use_on_channel(circid_t circ_id, channel_t *chan);
  42 circuit_t *circuit_get_by_edge_conn(edge_connection_t *conn);
  43 void circuit_unlink_all_from_channel(channel_t *chan, int reason);
  44 origin_circuit_t *circuit_get_by_global_id(uint32_t id);
  45 origin_circuit_t *circuit_get_ready_rend_circ_by_rend_data(
  46   const rend_data_t *rend_data);
  47 origin_circuit_t *circuit_get_next_by_pk_and_purpose(origin_circuit_t *start,
  48                                          const char *digest, uint8_t purpose);
  49 or_circuit_t *circuit_get_rendezvous(const uint8_t *cookie);
  50 or_circuit_t *circuit_get_intro_point(const uint8_t *digest);
  51 void circuit_set_rendezvous_cookie(or_circuit_t *circ, const uint8_t *cookie);
  52 void circuit_set_intro_point_digest(or_circuit_t *circ, const uint8_t *digest);
  53 origin_circuit_t *circuit_find_to_cannibalize(uint8_t purpose,
  54                                               extend_info_t *info, int flags);
  55 void circuit_mark_all_unused_circs(void);
  56 void circuit_mark_all_dirty_circs_as_unusable(void);
  57 MOCK_DECL(void, circuit_mark_for_close_, (circuit_t *circ, int reason,
  58                                           int line, const char *file));
  59 int circuit_get_cpath_len(origin_circuit_t *circ);
  60 void circuit_clear_cpath(origin_circuit_t *circ);
  61 crypt_path_t *circuit_get_cpath_hop(origin_circuit_t *circ, int hopnum);
  62 void circuit_get_all_pending_on_channel(smartlist_t *out,
  63                                         channel_t *chan);
  64 int circuit_count_pending_on_channel(channel_t *chan);
  65
  66 #define circuit_mark_for_close(c, reason)                               \
  67   circuit_mark_for_close_((c), (reason), __LINE__, SHORT_FILE__)
  68
  69 void assert_cpath_layer_ok(const crypt_path_t *cp);
  70 void assert_circuit_ok(const circuit_t *c);
  71 void circuit_free_all(void);
  72 void circuits_handle_oom(size_t current_allocation);
  73
  74 void channel_note_destroy_pending(channel_t *chan, circid_t id);
  75 MOCK_DECL(void, channel_note_destroy_not_pending,
  76           (channel_t *chan, circid_t id));
  77
  78 #ifdef CIRCUITLIST_PRIVATE
  79 STATIC void circuit_free(circuit_t *circ);
  80 STATIC size_t n_cells_in_circ_queues(const circuit_t *c);
  81 STATIC uint32_t circuit_max_queued_data_age(const circuit_t *c, uint32_t now);
  82 STATIC uint32_t circuit_max_queued_cell_age(const circuit_t *c, uint32_t now);
  83 STATIC uint32_t circuit_max_queued_item_age(const circuit_t *c, uint32_t now);
  84 #endif
  85
  86 #endif
  87