src/or/routerset.h

   1 /* Copyright (c) 2001-2004, Roger Dingledine.
   2  * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
   3  * Copyright (c) 2007-2017, The Tor Project, Inc. */
   4 /* See LICENSE for licensing information */
   5
   6 /**
   7  * \file routerlist.h
   8  * \brief Header file for routerset.c
   9  **/
  10
  11 #ifndef TOR_ROUTERSET_H
  12 #define TOR_ROUTERSET_H
  13
  14 routerset_t *routerset_new(void);
  15 void routerset_refresh_countries(routerset_t *rs);
  16 int routerset_parse(routerset_t *target, const char *s,
  17                     const char *description);
  18 void routerset_union(routerset_t *target, const routerset_t *source);
  19 int routerset_is_list(const routerset_t *set);
  20 int routerset_needs_geoip(const routerset_t *set);
  21 int routerset_is_empty(const routerset_t *set);
  22 int routerset_contains_router(const routerset_t *set, const routerinfo_t *ri,
  23                               country_t country);
  24 int routerset_contains_routerstatus(const routerset_t *set,
  25                                     const routerstatus_t *rs,
  26                                     country_t country);
  27 int routerset_contains_extendinfo(const routerset_t *set,
  28                                   const extend_info_t *ei);
  29 struct bridge_info_t;
  30 int routerset_contains_bridge(const routerset_t *set,
  31                               const struct bridge_info_t *bridge);
  32 int routerset_contains_node(const routerset_t *set, const node_t *node);
  33
  34 void routerset_get_all_nodes(smartlist_t *out, const routerset_t *routerset,
  35                              const routerset_t *excludeset,
  36                              int running_only);
  37 int routerset_add_unknown_ccs(routerset_t **setp, int only_if_some_cc_set);
  38 void routerset_subtract_nodes(smartlist_t *out,
  39                                 const routerset_t *routerset);
  40
  41 char *routerset_to_string(const routerset_t *routerset);
  42 int routerset_equal(const routerset_t *old, const routerset_t *new);
  43 void routerset_free(routerset_t *routerset);
  44 int routerset_len(const routerset_t *set);
  45
  46 #ifdef ROUTERSET_PRIVATE
  47 STATIC char * routerset_get_countryname(const char *c);
  48 STATIC int routerset_contains(const routerset_t *set, const tor_addr_t *addr,
  49                    uint16_t orport,
  50                    const char *nickname, const char *id_digest,
  51                    country_t country);
  52
  53 /** A routerset specifies constraints on a set of possible routerinfos, based
  54  * on their names, identities, or addresses.  It is optimized for determining
  55  * whether a router is a member or not, in O(1+P) time, where P is the number
  56  * of address policy constraints. */
  57 struct routerset_t {
  58   /** A list of strings for the elements of the policy.  Each string is either
  59    * a nickname, a hexadecimal identity fingerprint, or an address policy.  A
  60    * router belongs to the set if its nickname OR its identity OR its address
  61    * matches an entry here. */
  62   smartlist_t *list;
  63   /** A map from lowercase nicknames of routers in the set to (void*)1 */
  64   strmap_t *names;
  65   /** A map from identity digests routers in the set to (void*)1 */
  66   digestmap_t *digests;
  67   /** An address policy for routers in the set.  For implementation reasons,
  68    * a router belongs to the set if it is _rejected_ by this policy. */
  69   smartlist_t *policies;
  70
  71   /** A human-readable description of what this routerset is for.  Used in
  72    * log messages. */
  73   char *description;
  74
  75   /** A list of the country codes in this set. */
  76   smartlist_t *country_names;
  77   /** Total number of countries we knew about when we built <b>countries</b>.*/
  78   int n_countries;
  79   /** Bit array mapping the return value of geoip_get_country() to 1 iff the
  80    * country is a member of this routerset.  Note that we MUST call
  81    * routerset_refresh_countries() whenever the geoip country list is
  82    * reloaded. */
  83   bitarray_t *countries;
  84 };
  85 #endif /* defined(ROUTERSET_PRIVATE) */
  86 #endif /* !defined(TOR_ROUTERSET_H) */
  87