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