routerlist.h 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  1. /* Copyright (c) 2001-2004, Roger Dingledine.
  2. * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
  3. * Copyright (c) 2007-2011, The Tor Project, Inc. */
  4. /* See LICENSE for licensing information */
  5. /**
  6. * \file routerlist.h
  7. * \brief Header file for routerlist.c.
  8. **/
  9. #ifndef _TOR_ROUTERLIST_H
  10. #define _TOR_ROUTERLIST_H
  11. int get_n_authorities(authority_type_t type);
  12. int trusted_dirs_reload_certs(void);
  13. int trusted_dirs_load_certs_from_string(const char *contents, int from_store,
  14. int flush);
  15. void trusted_dirs_flush_certs_to_disk(void);
  16. authority_cert_t *authority_cert_get_newest_by_id(const char *id_digest);
  17. authority_cert_t *authority_cert_get_by_sk_digest(const char *sk_digest);
  18. authority_cert_t *authority_cert_get_by_digests(const char *id_digest,
  19. const char *sk_digest);
  20. void authority_cert_get_all(smartlist_t *certs_out);
  21. void authority_cert_dl_failed(const char *id_digest, int status);
  22. void authority_certs_fetch_missing(networkstatus_t *status, time_t now);
  23. int router_reload_router_list(void);
  24. int authority_cert_dl_looks_uncertain(const char *id_digest);
  25. smartlist_t *router_get_trusted_dir_servers(void);
  26. routerstatus_t *router_pick_directory_server(authority_type_t type, int flags);
  27. trusted_dir_server_t *router_get_trusteddirserver_by_digest(const char *d);
  28. trusted_dir_server_t *trusteddirserver_get_by_v3_auth_digest(const char *d);
  29. routerstatus_t *router_pick_trusteddirserver(authority_type_t type, int flags);
  30. int router_get_my_share_of_directory_requests(double *v2_share_out,
  31. double *v3_share_out);
  32. void router_reset_status_download_failures(void);
  33. void routerlist_add_family(smartlist_t *sl, routerinfo_t *router);
  34. int routers_in_same_family(routerinfo_t *r1, routerinfo_t *r2);
  35. int routers_have_same_or_addr(const routerinfo_t *r1, const routerinfo_t *r2);
  36. void add_nickname_list_to_smartlist(smartlist_t *sl, const char *list,
  37. int must_be_running);
  38. int router_nickname_is_in_list(routerinfo_t *router, const char *list);
  39. routerinfo_t *routerlist_find_my_routerinfo(void);
  40. routerinfo_t *router_find_exact_exit_enclave(const char *address,
  41. uint16_t port);
  42. int router_is_unreliable(routerinfo_t *router, int need_uptime,
  43. int need_capacity, int need_guard);
  44. uint32_t router_get_advertised_bandwidth(routerinfo_t *router);
  45. uint32_t router_get_advertised_bandwidth_capped(routerinfo_t *router);
  46. routerinfo_t *routerlist_sl_choose_by_bandwidth(smartlist_t *sl,
  47. bandwidth_weight_rule_t rule);
  48. routerstatus_t *routerstatus_sl_choose_by_bandwidth(smartlist_t *sl,
  49. bandwidth_weight_rule_t rule);
  50. routerinfo_t *router_choose_random_node(smartlist_t *excludedsmartlist,
  51. struct routerset_t *excludedset,
  52. router_crn_flags_t flags);
  53. routerinfo_t *router_get_by_nickname(const char *nickname,
  54. int warn_if_unnamed);
  55. int router_digest_version_as_new_as(const char *digest, const char *cutoff);
  56. int router_digest_is_trusted_dir_type(const char *digest,
  57. authority_type_t type);
  58. #define router_digest_is_trusted_dir(d) \
  59. router_digest_is_trusted_dir_type((d), NO_AUTHORITY)
  60. int router_addr_is_trusted_dir(uint32_t addr);
  61. int hexdigest_to_digest(const char *hexdigest, char *digest);
  62. routerinfo_t *router_get_by_hexdigest(const char *hexdigest);
  63. routerinfo_t *router_get_by_digest(const char *digest);
  64. signed_descriptor_t *router_get_by_descriptor_digest(const char *digest);
  65. signed_descriptor_t *router_get_by_extrainfo_digest(const char *digest);
  66. signed_descriptor_t *extrainfo_get_by_descriptor_digest(const char *digest);
  67. const char *signed_descriptor_get_body(signed_descriptor_t *desc);
  68. const char *signed_descriptor_get_annotations(signed_descriptor_t *desc);
  69. routerlist_t *router_get_routerlist(void);
  70. void routerinfo_free(routerinfo_t *router);
  71. void extrainfo_free(extrainfo_t *extrainfo);
  72. void routerlist_free(routerlist_t *rl);
  73. void dump_routerlist_mem_usage(int severity);
  74. void routerlist_remove(routerlist_t *rl, routerinfo_t *ri, int make_old,
  75. time_t now);
  76. void routerlist_free_all(void);
  77. void routerlist_reset_warnings(void);
  78. void router_set_status(const char *digest, int up);
  79. static int WRA_WAS_ADDED(was_router_added_t s);
  80. static int WRA_WAS_OUTDATED(was_router_added_t s);
  81. static int WRA_WAS_REJECTED(was_router_added_t s);
  82. /** Return true iff the descriptor was added. It might still be necessary to
  83. * check whether the descriptor generator should be notified.
  84. */
  85. static INLINE int
  86. WRA_WAS_ADDED(was_router_added_t s) {
  87. return s == ROUTER_ADDED_SUCCESSFULLY || s == ROUTER_ADDED_NOTIFY_GENERATOR;
  88. }
  89. /** Return true iff the descriptor was not added because it was either:
  90. * - not in the consensus
  91. * - neither in the consensus nor in any networkstatus document
  92. * - it was outdated.
  93. */
  94. static INLINE int WRA_WAS_OUTDATED(was_router_added_t s)
  95. {
  96. return (s == ROUTER_WAS_NOT_NEW ||
  97. s == ROUTER_NOT_IN_CONSENSUS ||
  98. s == ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS);
  99. }
  100. static INLINE int WRA_WAS_REJECTED(was_router_added_t s)
  101. {
  102. return (s == ROUTER_AUTHDIR_REJECTS);
  103. }
  104. was_router_added_t router_add_to_routerlist(routerinfo_t *router,
  105. const char **msg,
  106. int from_cache,
  107. int from_fetch);
  108. was_router_added_t router_add_extrainfo_to_routerlist(
  109. extrainfo_t *ei, const char **msg,
  110. int from_cache, int from_fetch);
  111. void routerlist_descriptors_added(smartlist_t *sl, int from_cache);
  112. void routerlist_remove_old_routers(void);
  113. int router_load_single_router(const char *s, uint8_t purpose, int cache,
  114. const char **msg);
  115. int router_load_routers_from_string(const char *s, const char *eos,
  116. saved_location_t saved_location,
  117. smartlist_t *requested_fingerprints,
  118. int descriptor_digests,
  119. const char *prepend_annotations);
  120. void router_load_extrainfo_from_string(const char *s, const char *eos,
  121. saved_location_t saved_location,
  122. smartlist_t *requested_fingerprints,
  123. int descriptor_digests);
  124. void routerlist_retry_directory_downloads(time_t now);
  125. int router_exit_policy_all_routers_reject(uint32_t addr, uint16_t port,
  126. int need_uptime);
  127. int router_exit_policy_rejects_all(routerinfo_t *router);
  128. trusted_dir_server_t *add_trusted_dir_server(const char *nickname,
  129. const char *address,
  130. uint16_t dir_port, uint16_t or_port,
  131. const char *digest, const char *v3_auth_digest,
  132. authority_type_t type);
  133. void authority_cert_free(authority_cert_t *cert);
  134. void clear_trusted_dir_servers(void);
  135. int any_trusted_dir_is_v1_authority(void);
  136. void update_consensus_router_descriptor_downloads(time_t now, int is_vote,
  137. networkstatus_t *consensus);
  138. void update_router_descriptor_downloads(time_t now);
  139. void update_extrainfo_downloads(time_t now);
  140. int router_have_minimum_dir_info(void);
  141. void router_dir_info_changed(void);
  142. const char *get_dir_info_status_string(void);
  143. int count_loading_descriptors_progress(void);
  144. void router_reset_descriptor_download_failures(void);
  145. int router_differences_are_cosmetic(routerinfo_t *r1, routerinfo_t *r2);
  146. int routerinfo_incompatible_with_extrainfo(routerinfo_t *ri, extrainfo_t *ei,
  147. signed_descriptor_t *sd,
  148. const char **msg);
  149. void routerlist_assert_ok(routerlist_t *rl);
  150. const char *esc_router_info(routerinfo_t *router);
  151. void routers_sort_by_identity(smartlist_t *routers);
  152. routerset_t *routerset_new(void);
  153. int routerset_parse(routerset_t *target, const char *s,
  154. const char *description);
  155. void routerset_union(routerset_t *target, const routerset_t *source);
  156. int routerset_is_list(const routerset_t *set);
  157. int routerset_needs_geoip(const routerset_t *set);
  158. int routerset_contains_router(const routerset_t *set, routerinfo_t *ri);
  159. int routerset_contains_routerstatus(const routerset_t *set,
  160. routerstatus_t *rs);
  161. int routerset_contains_extendinfo(const routerset_t *set,
  162. const extend_info_t *ei);
  163. void routerset_get_all_routers(smartlist_t *out, const routerset_t *routerset,
  164. int running_only);
  165. void routersets_get_disjunction(smartlist_t *target, const smartlist_t *source,
  166. const routerset_t *include,
  167. const routerset_t *exclude, int running_only);
  168. void routerset_subtract_routers(smartlist_t *out,
  169. const routerset_t *routerset);
  170. char *routerset_to_string(const routerset_t *routerset);
  171. void routerset_refresh_countries(routerset_t *target);
  172. int routerset_equal(const routerset_t *old, const routerset_t *new);
  173. void routerset_free(routerset_t *routerset);
  174. void routerinfo_set_country(routerinfo_t *ri);
  175. void routerlist_refresh_countries(void);
  176. void refresh_all_country_info(void);
  177. int hid_serv_get_responsible_directories(smartlist_t *responsible_dirs,
  178. const char *id);
  179. int hid_serv_acting_as_directory(void);
  180. int hid_serv_responsible_for_desc_id(const char *id);
  181. #endif