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 */
9 * \brief Header file for nodelist.c.
12 #ifndef TOR_NODELIST_H
13 #define TOR_NODELIST_H
15 #define node_assert_ok(n) STMT_BEGIN { \
16 tor_assert((n)->ri || (n)->rs); \
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
);
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
);
31 void nodelist_free_all(void);
32 void nodelist_assert_ok(void);
34 MOCK_DECL(const node_t
*, node_get_by_nickname
,
35 (const char *nickname
, int warn_if_unnamed
));
36 void node_get_verbose_nickname(const node_t
*node
,
37 char *verbose_name_out
);
38 void node_get_verbose_nickname_by_id(const char *id_digest
,
39 char *verbose_name_out
);
40 int node_is_named(const node_t
*node
);
41 int node_is_dir(const node_t
*node
);
42 int node_has_descriptor(const node_t
*node
);
43 int node_get_purpose(const node_t
*node
);
44 #define node_is_bridge(node) \
45 (node_get_purpose((node)) == ROUTER_PURPOSE_BRIDGE)
46 int node_is_me(const node_t
*node
);
47 int node_exit_policy_rejects_all(const node_t
*node
);
48 int node_exit_policy_is_exact(const node_t
*node
, sa_family_t family
);
49 smartlist_t
*node_get_all_orports(const node_t
*node
);
50 int node_allows_single_hop_exits(const node_t
*node
);
51 const char *node_get_nickname(const node_t
*node
);
52 const char *node_get_platform(const node_t
*node
);
53 uint32_t node_get_prim_addr_ipv4h(const node_t
*node
);
54 void node_get_address_string(const node_t
*node
, char *cp
, size_t len
);
55 long node_get_declared_uptime(const node_t
*node
);
56 time_t node_get_published_on(const node_t
*node
);
57 const smartlist_t
*node_get_declared_family(const node_t
*node
);
58 int node_ipv6_preferred(const node_t
*node
);
59 int node_get_prim_orport(const node_t
*node
, tor_addr_port_t
*ap_out
);
60 void node_get_pref_orport(const node_t
*node
, tor_addr_port_t
*ap_out
);
61 void node_get_pref_ipv6_orport(const node_t
*node
, tor_addr_port_t
*ap_out
);
62 int node_has_curve25519_onion_key(const node_t
*node
);
64 MOCK_DECL(smartlist_t
*, nodelist_get_list
, (void));
66 /* Temporary during transition to multiple addresses. */
67 void node_get_addr(const node_t
*node
, tor_addr_t
*addr_out
);
68 #define node_get_addr_ipv4h(n) node_get_prim_addr_ipv4h((n))
70 void nodelist_refresh_countries(void);
71 void node_set_country(node_t
*node
);
72 void nodelist_add_node_and_family(smartlist_t
*nodes
, const node_t
*node
);
73 int nodes_in_same_family(const node_t
*node1
, const node_t
*node2
);
75 const node_t
*router_find_exact_exit_enclave(const char *address
,
77 int node_is_unreliable(const node_t
*router
, int need_uptime
,
78 int need_capacity
, int need_guard
);
79 int router_exit_policy_all_nodes_reject(const tor_addr_t
*addr
, uint16_t port
,
81 void router_set_status(const char *digest
, int up
);
83 /** router_have_minimum_dir_info tests to see if we have enough
84 * descriptor information to create circuits.
85 * If there are exits in the consensus, we wait until we have enough
86 * info to create exit paths before creating any circuits. If there are
87 * no exits in the consensus, we wait for enough info to create internal
88 * paths, and should avoid creating exit paths, as they will simply fail.
89 * We make sure we create all available circuit types at the same time. */
90 int router_have_minimum_dir_info(void);
92 /** Set to CONSENSUS_PATH_EXIT if there is at least one exit node
93 * in the consensus. We update this flag in compute_frac_paths_available if
94 * there is at least one relay that has an Exit flag in the consensus.
95 * Used to avoid building exit circuits when they will almost certainly fail.
96 * Set to CONSENSUS_PATH_INTERNAL if there are no exits in the consensus.
97 * (This situation typically occurs during bootstrap of a test network.)
98 * Set to CONSENSUS_PATH_UNKNOWN if we have never checked, or have
99 * reason to believe our last known value was invalid or has expired.
102 /* we haven't checked yet, or we have invalidated our previous check */
103 CONSENSUS_PATH_UNKNOWN
= -1,
104 /* The consensus only has internal relays, and we should only
105 * create internal paths, circuits, streams, ... */
106 CONSENSUS_PATH_INTERNAL
= 0,
107 /* The consensus has at least one exit, and can therefore (potentially)
108 * create exit and internal paths, circuits, streams, ... */
109 CONSENSUS_PATH_EXIT
= 1
110 } consensus_path_type_t
;
111 consensus_path_type_t
router_have_consensus_path(void);
113 void router_dir_info_changed(void);
114 const char *get_dir_info_status_string(void);
115 int count_loading_descriptors_progress(void);