src/or/routerlist.h

   1 /* Copyright (c) 2001-2004, Roger Dingledine.
   2  * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
   3  * Copyright (c) 2007-2013, The Tor Project, Inc. */
   4 /* See LICENSE for licensing information */
   5
   6 /**
   7  * \file routerlist.h
   8  * \brief Header file for routerlist.c.
   9  **/
  10
  11 #ifndef TOR_ROUTERLIST_H
  12 #define TOR_ROUTERLIST_H
  13
  14 int get_n_authorities(dirinfo_type_t type);
  15 int trusted_dirs_reload_certs(void);
  16 int trusted_dirs_load_certs_from_string(const char *contents, int from_store,
  17                                         int flush);
  18 void trusted_dirs_flush_certs_to_disk(void);
  19 authority_cert_t *authority_cert_get_newest_by_id(const char *id_digest);
  20 authority_cert_t *authority_cert_get_by_sk_digest(const char *sk_digest);
  21 authority_cert_t *authority_cert_get_by_digests(const char *id_digest,
  22                                                 const char *sk_digest);
  23 void authority_cert_get_all(smartlist_t *certs_out);
  24 void authority_cert_dl_failed(const char *id_digest, int status);
  25 void authority_certs_fetch_missing(networkstatus_t *status, time_t now);
  26 int router_reload_router_list(void);
  27 int authority_cert_dl_looks_uncertain(const char *id_digest);
  28 const smartlist_t *router_get_trusted_dir_servers(void);
  29 const smartlist_t *router_get_fallback_dir_servers(void);
  30
  31 const routerstatus_t *router_pick_directory_server(dirinfo_type_t type,
  32                                                    int flags);
  33 dir_server_t *router_get_trusteddirserver_by_digest(const char *d);
  34 dir_server_t *router_get_fallback_dirserver_by_digest(
  35                                                    const char *digest);
  36 dir_server_t *trusteddirserver_get_by_v3_auth_digest(const char *d);
  37 const routerstatus_t *router_pick_trusteddirserver(dirinfo_type_t type,
  38                                                    int flags);
  39 const routerstatus_t *router_pick_fallback_dirserver(dirinfo_type_t type,
  40                                                      int flags);
  41 int router_get_my_share_of_directory_requests(double *v2_share_out,
  42                                               double *v3_share_out);
  43 void router_reset_status_download_failures(void);
  44 int routers_have_same_or_addrs(const routerinfo_t *r1, const routerinfo_t *r2);
  45 const routerinfo_t *routerlist_find_my_routerinfo(void);
  46 uint32_t router_get_advertised_bandwidth(const routerinfo_t *router);
  47 uint32_t router_get_advertised_bandwidth_capped(const routerinfo_t *router);
  48
  49 const node_t *node_sl_choose_by_bandwidth(const smartlist_t *sl,
  50                                           bandwidth_weight_rule_t rule);
  51 double frac_nodes_with_descriptors(const smartlist_t *sl,
  52                                    bandwidth_weight_rule_t rule);
  53
  54 const node_t *router_choose_random_node(smartlist_t *excludedsmartlist,
  55                                         struct routerset_t *excludedset,
  56                                         router_crn_flags_t flags);
  57
  58 int router_is_named(const routerinfo_t *router);
  59 int router_digest_is_trusted_dir_type(const char *digest,
  60                                       dirinfo_type_t type);
  61 #define router_digest_is_trusted_dir(d) \
  62   router_digest_is_trusted_dir_type((d), NO_DIRINFO)
  63
  64 int router_addr_is_trusted_dir(uint32_t addr);
  65 int hexdigest_to_digest(const char *hexdigest, char *digest);
  66 const routerinfo_t *router_get_by_id_digest(const char *digest);
  67 routerinfo_t *router_get_mutable_by_digest(const char *digest);
  68 signed_descriptor_t *router_get_by_descriptor_digest(const char *digest);
  69 signed_descriptor_t *router_get_by_extrainfo_digest(const char *digest);
  70 signed_descriptor_t *extrainfo_get_by_descriptor_digest(const char *digest);
  71 const char *signed_descriptor_get_body(const signed_descriptor_t *desc);
  72 const char *signed_descriptor_get_annotations(const signed_descriptor_t *desc);
  73 routerlist_t *router_get_routerlist(void);
  74 void routerinfo_free(routerinfo_t *router);
  75 void extrainfo_free(extrainfo_t *extrainfo);
  76 void routerlist_free(routerlist_t *rl);
  77 void dump_routerlist_mem_usage(int severity);
  78 void routerlist_remove(routerlist_t *rl, routerinfo_t *ri, int make_old,
  79                        time_t now);
  80 void routerlist_free_all(void);
  81 void routerlist_reset_warnings(void);
  82
  83 static int WRA_WAS_ADDED(was_router_added_t s);
  84 static int WRA_WAS_OUTDATED(was_router_added_t s);
  85 static int WRA_WAS_REJECTED(was_router_added_t s);
  86 /** Return true iff the outcome code in <b>s</b> indicates that the descriptor
  87  * was added. It might still be necessary to check whether the descriptor
  88  * generator should be notified.
  89  */
  90 static INLINE int
  91 WRA_WAS_ADDED(was_router_added_t s) {
  92   return s == ROUTER_ADDED_SUCCESSFULLY || s == ROUTER_ADDED_NOTIFY_GENERATOR;
  93 }
  94 /** Return true iff the outcome code in <b>s</b> indicates that the descriptor
  95  * was not added because it was either:
  96  * - not in the consensus
  97  * - neither in the consensus nor in any networkstatus document
  98  * - it was outdated.
  99  */
 100 static INLINE int WRA_WAS_OUTDATED(was_router_added_t s)
 101 {
 102   return (s == ROUTER_WAS_NOT_NEW ||
 103           s == ROUTER_NOT_IN_CONSENSUS ||
 104           s == ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS);
 105 }
 106 /** Return true iff the outcome code in <b>s</b> indicates that the descriptor
 107  * was flat-out rejected. */
 108 static INLINE int WRA_WAS_REJECTED(was_router_added_t s)
 109 {
 110   return (s == ROUTER_AUTHDIR_REJECTS);
 111 }
 112 was_router_added_t router_add_to_routerlist(routerinfo_t *router,
 113                                             const char **msg,
 114                                             int from_cache,
 115                                             int from_fetch);
 116 was_router_added_t router_add_extrainfo_to_routerlist(
 117                                         extrainfo_t *ei, const char **msg,
 118                                         int from_cache, int from_fetch);
 119 void routerlist_descriptors_added(smartlist_t *sl, int from_cache);
 120 void routerlist_remove_old_routers(void);
 121 int router_load_single_router(const char *s, uint8_t purpose, int cache,
 122                               const char **msg);
 123 int router_load_routers_from_string(const char *s, const char *eos,
 124                                      saved_location_t saved_location,
 125                                      smartlist_t *requested_fingerprints,
 126                                      int descriptor_digests,
 127                                      const char *prepend_annotations);
 128 void router_load_extrainfo_from_string(const char *s, const char *eos,
 129                                        saved_location_t saved_location,
 130                                        smartlist_t *requested_fingerprints,
 131                                        int descriptor_digests);
 132
 133 void routerlist_retry_directory_downloads(time_t now);
 134
 135 int router_exit_policy_rejects_all(const routerinfo_t *router);
 136
 137 dir_server_t *trusted_dir_server_new(const char *nickname, const char *address,
 138                        uint16_t dir_port, uint16_t or_port,
 139                        const char *digest, const char *v3_auth_digest,
 140                        dirinfo_type_t type, double weight);
 141 dir_server_t *fallback_dir_server_new(const tor_addr_t *addr,
 142                                       uint16_t dir_port, uint16_t or_port,
 143                                       const char *id_digest, double weight);
 144 void dir_server_add(dir_server_t *ent);
 145
 146 void authority_cert_free(authority_cert_t *cert);
 147 void clear_dir_servers(void);
 148 void update_consensus_router_descriptor_downloads(time_t now, int is_vote,
 149                                                   networkstatus_t *consensus);
 150 void update_router_descriptor_downloads(time_t now);
 151 void update_all_descriptor_downloads(time_t now);
 152 void update_extrainfo_downloads(time_t now);
 153 void router_reset_descriptor_download_failures(void);
 154 int router_differences_are_cosmetic(const routerinfo_t *r1,
 155                                     const routerinfo_t *r2);
 156 int routerinfo_incompatible_with_extrainfo(const routerinfo_t *ri,
 157                                            extrainfo_t *ei,
 158                                            signed_descriptor_t *sd,
 159                                            const char **msg);
 160
 161 void routerlist_assert_ok(const routerlist_t *rl);
 162 const char *esc_router_info(const routerinfo_t *router);
 163 void routers_sort_by_identity(smartlist_t *routers);
 164
 165 void refresh_all_country_info(void);
 166
 167 int hid_serv_get_responsible_directories(smartlist_t *responsible_dirs,
 168                                          const char *id);
 169 int hid_serv_acting_as_directory(void);
 170 int hid_serv_responsible_for_desc_id(const char *id);
 171
 172 void list_pending_microdesc_downloads(digestmap_t *result);
 173 void launch_descriptor_downloads(int purpose,
 174                                  smartlist_t *downloadable,
 175                                  const routerstatus_t *source,
 176                                  time_t now);
 177
 178 int hex_digest_nickname_decode(const char *hexdigest,
 179                                char *digest_out,
 180                                char *nickname_qualifier_out,
 181                                char *nickname_out);
 182 int hex_digest_nickname_matches(const char *hexdigest,
 183                                 const char *identity_digest,
 184                                 const char *nickname, int is_named);
 185
 186 #ifdef ROUTERLIST_PRIVATE
 187 /** Helper type for choosing routers by bandwidth: contains a union of
 188  * double and uint64_t. Before we call scale_array_elements_to_u64, it holds
 189  * a double; after, it holds a uint64_t. */
 190 typedef union u64_dbl_t {
 191   uint64_t u64;
 192   double dbl;
 193 } u64_dbl_t;
 194
 195 int choose_array_element_by_weight(const u64_dbl_t *entries, int n_entries);
 196 void scale_array_elements_to_u64(u64_dbl_t *entries, int n_entries,
 197                                  uint64_t *total_out);
 198 #endif
 199
 200 #endif
 201