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-2012, 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 circuit_t * _circuit_get_global_list(void);
  16 const char *circuit_state_to_string(int state);
  17 const char *circuit_purpose_to_controller_string(uint8_t purpose);
  18 const char *circuit_purpose_to_controller_hs_state_string(uint8_t purpose);
  19 const char *circuit_purpose_to_string(uint8_t purpose);
  20 void circuit_dump_by_conn(connection_t *conn, int severity);
  21 void circuit_set_p_circid_orconn(or_circuit_t *circ, circid_t id,
  22                                  or_connection_t *conn);
  23 void circuit_set_n_circid_orconn(circuit_t *circ, circid_t id,
  24                                  or_connection_t *conn);
  25 void circuit_set_state(circuit_t *circ, uint8_t state);
  26 void circuit_close_all_marked(void);
  27 int32_t circuit_initial_package_window(void);
  28 origin_circuit_t *origin_circuit_new(void);
  29 or_circuit_t *or_circuit_new(circid_t p_circ_id, or_connection_t *p_conn);
  30 circuit_t *circuit_get_by_circid_orconn(circid_t circ_id,
  31                                         or_connection_t *conn);
  32 int circuit_id_in_use_on_orconn(circid_t circ_id, or_connection_t *conn);
  33 circuit_t *circuit_get_by_edge_conn(edge_connection_t *conn);
  34 void circuit_unlink_all_from_or_conn(or_connection_t *conn, int reason);
  35 origin_circuit_t *circuit_get_by_global_id(uint32_t id);
  36 origin_circuit_t *circuit_get_ready_rend_circ_by_rend_data(
  37   const rend_data_t *rend_data);
  38 origin_circuit_t *circuit_get_next_by_pk_and_purpose(origin_circuit_t *start,
  39                                          const char *digest, uint8_t purpose);
  40 or_circuit_t *circuit_get_rendezvous(const char *cookie);
  41 or_circuit_t *circuit_get_intro_point(const char *digest);
  42 origin_circuit_t *circuit_find_to_cannibalize(uint8_t purpose,
  43                                               extend_info_t *info, int flags);
  44 void circuit_mark_all_unused_circs(void);
  45 void circuit_expire_all_dirty_circs(void);
  46 void _circuit_mark_for_close(circuit_t *circ, int reason,
  47                              int line, const char *file);
  48 int circuit_get_cpath_len(origin_circuit_t *circ);
  49 crypt_path_t *circuit_get_cpath_hop(origin_circuit_t *circ, int hopnum);
  50 void circuit_get_all_pending_on_or_conn(smartlist_t *out,
  51                                         or_connection_t *or_conn);
  52 int circuit_count_pending_on_or_conn(or_connection_t *or_conn);
  53
  54 #define circuit_mark_for_close(c, reason)                               \
  55   _circuit_mark_for_close((c), (reason), __LINE__, _SHORT_FILE_)
  56
  57 void assert_cpath_layer_ok(const crypt_path_t *cp);
  58 void assert_circuit_ok(const circuit_t *c);
  59 void circuit_free_all(void);
  60
  61 #endif
  62