nodelist.h 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128
  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-2016, The Tor Project, Inc. */
  5. /* See LICENSE for licensing information */
  6. /**
  7. * \file nodelist.h
  8. * \brief Header file for nodelist.c.
  9. **/
  10. #ifndef TOR_NODELIST_H
  11. #define TOR_NODELIST_H
  12. #define node_assert_ok(n) STMT_BEGIN { \
  13. tor_assert((n)->ri || (n)->rs); \
  14. } STMT_END
  15. node_t *node_get_mutable_by_id(const char *identity_digest);
  16. MOCK_DECL(const node_t *, node_get_by_id, (const char *identity_digest));
  17. const node_t *node_get_by_hex_id(const char *identity_digest);
  18. node_t *nodelist_set_routerinfo(routerinfo_t *ri, routerinfo_t **ri_old_out);
  19. node_t *nodelist_add_microdesc(microdesc_t *md);
  20. void nodelist_set_consensus(networkstatus_t *ns);
  21. void nodelist_remove_microdesc(const char *identity_digest, microdesc_t *md);
  22. void nodelist_remove_routerinfo(routerinfo_t *ri);
  23. void nodelist_purge(void);
  24. smartlist_t *nodelist_find_nodes_with_microdesc(const microdesc_t *md);
  25. void nodelist_free_all(void);
  26. void nodelist_assert_ok(void);
  27. MOCK_DECL(const node_t *, node_get_by_nickname,
  28. (const char *nickname, int warn_if_unnamed));
  29. void node_get_verbose_nickname(const node_t *node,
  30. char *verbose_name_out);
  31. void node_get_verbose_nickname_by_id(const char *id_digest,
  32. char *verbose_name_out);
  33. int node_is_named(const node_t *node);
  34. int node_is_dir(const node_t *node);
  35. int node_has_descriptor(const node_t *node);
  36. int node_get_purpose(const node_t *node);
  37. #define node_is_bridge(node) \
  38. (node_get_purpose((node)) == ROUTER_PURPOSE_BRIDGE)
  39. int node_is_me(const node_t *node);
  40. int node_exit_policy_rejects_all(const node_t *node);
  41. int node_exit_policy_is_exact(const node_t *node, sa_family_t family);
  42. smartlist_t *node_get_all_orports(const node_t *node);
  43. int node_allows_single_hop_exits(const node_t *node);
  44. const char *node_get_nickname(const node_t *node);
  45. const char *node_get_platform(const node_t *node);
  46. uint32_t node_get_prim_addr_ipv4h(const node_t *node);
  47. void node_get_address_string(const node_t *node, char *cp, size_t len);
  48. long node_get_declared_uptime(const node_t *node);
  49. time_t node_get_published_on(const node_t *node);
  50. const smartlist_t *node_get_declared_family(const node_t *node);
  51. int node_has_ipv6_addr(const node_t *node);
  52. int node_has_ipv6_orport(const node_t *node);
  53. int node_has_ipv6_dirport(const node_t *node);
  54. /* Deprecated - use node_ipv6_or_preferred or node_ipv6_dir_preferred */
  55. #define node_ipv6_preferred(node) node_ipv6_or_preferred(node)
  56. int node_ipv6_or_preferred(const node_t *node);
  57. int node_get_prim_orport(const node_t *node, tor_addr_port_t *ap_out);
  58. void node_get_pref_orport(const node_t *node, tor_addr_port_t *ap_out);
  59. void node_get_pref_ipv6_orport(const node_t *node, tor_addr_port_t *ap_out);
  60. int node_ipv6_dir_preferred(const node_t *node);
  61. int node_get_prim_dirport(const node_t *node, tor_addr_port_t *ap_out);
  62. void node_get_pref_dirport(const node_t *node, tor_addr_port_t *ap_out);
  63. void node_get_pref_ipv6_dirport(const node_t *node, tor_addr_port_t *ap_out);
  64. int node_has_curve25519_onion_key(const node_t *node);
  65. 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))
  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. const node_t *router_find_exact_exit_enclave(const char *address,
  74. uint16_t port);
  75. int node_is_unreliable(const node_t *router, int need_uptime,
  76. int need_capacity, int need_guard);
  77. int router_exit_policy_all_nodes_reject(const tor_addr_t *addr, uint16_t port,
  78. int need_uptime);
  79. void router_set_status(const char *digest, int up);
  80. /** router_have_minimum_dir_info tests to see if we have enough
  81. * descriptor information to create circuits.
  82. * If there are exits in the consensus, we wait until we have enough
  83. * info to create exit paths before creating any circuits. If there are
  84. * no exits in the consensus, we wait for enough info to create internal
  85. * paths, and should avoid creating exit paths, as they will simply fail.
  86. * We make sure we create all available circuit types at the same time. */
  87. int router_have_minimum_dir_info(void);
  88. /** Set to CONSENSUS_PATH_EXIT if there is at least one exit node
  89. * in the consensus. We update this flag in compute_frac_paths_available if
  90. * there is at least one relay that has an Exit flag in the consensus.
  91. * Used to avoid building exit circuits when they will almost certainly fail.
  92. * Set to CONSENSUS_PATH_INTERNAL if there are no exits in the consensus.
  93. * (This situation typically occurs during bootstrap of a test network.)
  94. * Set to CONSENSUS_PATH_UNKNOWN if we have never checked, or have
  95. * reason to believe our last known value was invalid or has expired.
  96. */
  97. typedef enum {
  98. /* we haven't checked yet, or we have invalidated our previous check */
  99. CONSENSUS_PATH_UNKNOWN = -1,
  100. /* The consensus only has internal relays, and we should only
  101. * create internal paths, circuits, streams, ... */
  102. CONSENSUS_PATH_INTERNAL = 0,
  103. /* The consensus has at least one exit, and can therefore (potentially)
  104. * create exit and internal paths, circuits, streams, ... */
  105. CONSENSUS_PATH_EXIT = 1
  106. } consensus_path_type_t;
  107. consensus_path_type_t router_have_consensus_path(void);
  108. void router_dir_info_changed(void);
  109. const char *get_dir_info_status_string(void);
  110. int count_loading_descriptors_progress(void);
  111. #endif