src/or/nodelist.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-2013, The Tor Project, Inc. */
   5 /* See LICENSE for licensing information */
   6
   7 /**
   8  * \file nodelist.h
   9  * \brief Header file for nodelist.c.
  10  **/
  11
  12 #ifndef TOR_NODELIST_H
  13 #define TOR_NODELIST_H
  14
  15 #define node_assert_ok(n) STMT_BEGIN {                          \
  16     tor_assert((n)->ri || (n)->rs);                             \
  17   } STMT_END
  18
  19 node_t *node_get_mutable_by_id(const char *identity_digest);
  20 MOCK_DECL(const node_t *, node_get_by_id, (const char *identity_digest));
  21 const node_t *node_get_by_hex_id(const char *identity_digest);
  22 node_t *nodelist_set_routerinfo(routerinfo_t *ri, routerinfo_t **ri_old_out);
  23 node_t *nodelist_add_microdesc(microdesc_t *md);
  24 void nodelist_set_consensus(networkstatus_t *ns);
  25
  26 void nodelist_remove_microdesc(const char *identity_digest, microdesc_t *md);
  27 void nodelist_remove_routerinfo(routerinfo_t *ri);
  28 void nodelist_purge(void);
  29 smartlist_t *nodelist_find_nodes_with_microdesc(const microdesc_t *md);
  30
  31 void nodelist_free_all(void);
  32 void nodelist_assert_ok(void);
  33
  34 const node_t *node_get_by_nickname(const char *nickname, int warn_if_unnamed);
  35 void node_get_verbose_nickname(const node_t *node,
  36                                char *verbose_name_out);
  37 void node_get_verbose_nickname_by_id(const char *id_digest,
  38                                 char *verbose_name_out);
  39 int node_is_named(const node_t *node);
  40 int node_is_dir(const node_t *node);
  41 int node_has_descriptor(const node_t *node);
  42 int node_get_purpose(const node_t *node);
  43 #define node_is_bridge(node) \
  44   (node_get_purpose((node)) == ROUTER_PURPOSE_BRIDGE)
  45 int node_is_me(const node_t *node);
  46 int node_exit_policy_rejects_all(const node_t *node);
  47 int node_exit_policy_is_exact(const node_t *node, sa_family_t family);
  48 smartlist_t *node_get_all_orports(const node_t *node);
  49 int node_allows_single_hop_exits(const node_t *node);
  50 const char *node_get_nickname(const node_t *node);
  51 const char *node_get_platform(const node_t *node);
  52 uint32_t node_get_prim_addr_ipv4h(const node_t *node);
  53 void node_get_address_string(const node_t *node, char *cp, size_t len);
  54 long node_get_declared_uptime(const node_t *node);
  55 time_t node_get_published_on(const node_t *node);
  56 const smartlist_t *node_get_declared_family(const node_t *node);
  57 int node_ipv6_preferred(const node_t *node);
  58 int node_get_prim_orport(const node_t *node, tor_addr_port_t *ap_out);
  59 void node_get_pref_orport(const node_t *node, tor_addr_port_t *ap_out);
  60 void node_get_pref_ipv6_orport(const node_t *node, tor_addr_port_t *ap_out);
  61 int node_has_curve25519_onion_key(const node_t *node);
  62
  63 smartlist_t *nodelist_get_list(void);
  64
  65 /* Temporary during transition to multiple addresses.  */
  66 void node_get_addr(const node_t *node, tor_addr_t *addr_out);
  67 #define node_get_addr_ipv4h(n) node_get_prim_addr_ipv4h((n))
  68
  69 void nodelist_refresh_countries(void);
  70 void node_set_country(node_t *node);
  71 void nodelist_add_node_and_family(smartlist_t *nodes, const node_t *node);
  72 int nodes_in_same_family(const node_t *node1, const node_t *node2);
  73
  74 const node_t *router_find_exact_exit_enclave(const char *address,
  75                                              uint16_t port);
  76 int node_is_unreliable(const node_t *router, int need_uptime,
  77                          int need_capacity, int need_guard);
  78 int router_exit_policy_all_nodes_reject(const tor_addr_t *addr, uint16_t port,
  79                                         int need_uptime);
  80 void router_set_status(const char *digest, int up);
  81 int router_have_minimum_dir_info(void);
  82 void router_dir_info_changed(void);
  83 const char *get_dir_info_status_string(void);
  84 int count_loading_descriptors_progress(void);
  85
  86 #endif
  87