February 2015 - tor-commits - lists.torproject.org

[tor/master] Calculate relay weighted bandwidth using guardfraction bandwidths.
by nickm＠torproject.org 18 Feb '15

18 Feb '15

commit b941f109ac037b270da6f07ffb4947ee237e468a Author: George Kadianakis <desnacked(a)riseup.net> Date: Thu Jan 29 15:07:35 2015 +0000 Calculate relay weighted bandwidth using guardfraction bandwidths. Now use the guardfraction function to calculate individual relay bandwidth weights. --- src/or/routerlist.c | 42 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 41 insertions(+), 1 deletion(-) diff --git a/src/or/routerlist.c b/src/or/routerlist.c index fe92ac0..61b2f74 100644 --- a/src/or/routerlist.c +++ b/src/or/routerlist.c @@ -2003,6 +2003,7 @@ compute_weighted_bandwidths(const smartlist_t *sl, double Wg = -1, Wm = -1, We = -1, Wd = -1; double Wgb = -1, Wmb = -1, Web = -1, Wdb = -1; uint64_t weighted_bw = 0; + guardfraction_bandwidth_t guardfraction_bw; u64_dbl_t *bandwidths; /* Can't choose exit and guard at same time */ @@ -2092,6 +2093,8 @@ compute_weighted_bandwidths(const smartlist_t *sl, SMARTLIST_FOREACH_BEGIN(sl, const node_t *, node) { int is_exit = 0, is_guard = 0, is_dir = 0, this_bw = 0; double weight = 1; + double weight_without_guard_flag = 0; /* Used for guardfraction */ + double final_weight = 0; is_exit = node->is_exit && ! node->is_bad_exit; is_guard = node->is_possible_guard; is_dir = node_is_dir(node); @@ -2119,8 +2122,10 @@ compute_weighted_bandwidths(const smartlist_t *sl, if (is_guard && is_exit) { weight = (is_dir ? Wdb*Wd : Wd); + weight_without_guard_flag = (is_dir ? Web*We : We); } else if (is_guard) { weight = (is_dir ? Wgb*Wg : Wg); + weight_without_guard_flag = (is_dir ? Wmb*Wm : Wm); } else if (is_exit) { weight = (is_dir ? Web*We : We); } else { // middle @@ -2132,8 +2137,43 @@ compute_weighted_bandwidths(const smartlist_t *sl, this_bw = 0; if (weight < 0.0) weight = 0.0; + if (weight_without_guard_flag < 0.0) + weight_without_guard_flag = 0.0; - bandwidths[node_sl_idx].dbl = weight*this_bw + 0.5; + /* If guardfraction information is available in the consensus, we + * want to calculate this router's bandwidth according to its + * guardfraction. Quoting from proposal236: + * + * Let Wpf denote the weight from the 'bandwidth-weights' line a + * client would apply to N for position p if it had the guard + * flag, Wpn the weight if it did not have the guard flag, and B the + * measured bandwidth of N in the consensus. Then instead of choosing + * N for position p proportionally to Wpf*B or Wpn*B, clients should + * choose N proportionally to F*Wpf*B + (1-F)*Wpn*B. + */ + if (node->rs && node->rs->has_guardfraction && rule != WEIGHT_FOR_GUARD) { + /* XXX The assert should actually check for is_guard. However, + * that crashes dirauths because of #13297. This should be + * equivalent: */ + tor_assert(node->rs->is_possible_guard); + + guard_get_guardfraction_bandwidth(&guardfraction_bw, + this_bw, + node->rs->guardfraction_percentage); + + /* Calculate final_weight = F*Wpf*B + (1-F)*Wpn*B */ + final_weight = + guardfraction_bw.guard_bw * weight + + guardfraction_bw.non_guard_bw * weight_without_guard_flag; + + log_warn(LD_GENERAL, "%s: Guardfraction weight %f instead of %f (%s)", + node->rs->nickname, final_weight, weight*this_bw, + bandwidth_weight_rule_to_string(rule)); + } else { /* no guardfraction information. calculate the weight normally. */ + final_weight = weight*this_bw; + } + + bandwidths[node_sl_idx].dbl = final_weight + 0.5; } SMARTLIST_FOREACH_END(node); log_debug(LD_CIRC, "Generated weighted bandwidths for rule %s based "

1 0

[tor/master] Parse GuardFraction info from consensuses and votes.
by nickm＠torproject.org 18 Feb '15

18 Feb '15

commit f4a63f8eabbdd842ebeb97aabba92ea47c37a607 Author: George Kadianakis <desnacked(a)riseup.net> Date: Thu Jan 29 14:57:00 2015 +0000 Parse GuardFraction info from consensuses and votes. Also introduce the UseGuardFraction torrc option which decides whether clients should use guardfraction information found in the consensus. --- doc/tor.1.txt | 6 +++++ src/or/config.c | 1 + src/or/entrynodes.c | 21 ++++++++++++++++ src/or/entrynodes.h | 2 ++ src/or/or.h | 6 +++++ src/or/routerparse.c | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++ src/or/routerparse.h | 7 ++++++ 7 files changed, 108 insertions(+) diff --git a/doc/tor.1.txt b/doc/tor.1.txt index 3de3048..8ecece0 100644 --- a/doc/tor.1.txt +++ b/doc/tor.1.txt @@ -1122,6 +1122,12 @@ The following options are useful only for clients (that is, if guardfraction file which contains information about how long relays have been guards. (Default: unset) +[[UseGuardFraction]] **UseGuardFraction** **0**|**1**|**auto**:: + This torrc option specifies whether clients should use the + guardfraction information found in the consensus during path + selection. If it's set to 'auto', clients will do what the + UseGuardFraction consensus parameter tells them to do. + [[NumEntryGuards]] **NumEntryGuards** __NUM__:: If UseEntryGuards is set to 1, we will try to pick a total of NUM routers as long-term entries for our circuits. If NUM is 0, we try to learn diff --git a/src/or/config.c b/src/or/config.c index 6349445..230ea7f 100644 --- a/src/or/config.c +++ b/src/or/config.c @@ -411,6 +411,7 @@ static config_var_t option_vars_[] = { V(UseBridges, BOOL, "0"), V(UseEntryGuards, BOOL, "1"), V(UseEntryGuardsAsDirGuards, BOOL, "1"), + V(UseGuardFraction, AUTOBOOL, "auto"), V(UseMicrodescriptors, AUTOBOOL, "auto"), V(UseNTorHandshake, AUTOBOOL, "1"), V(User, STRING, NULL), diff --git a/src/or/entrynodes.c b/src/or/entrynodes.c index 5b0e342..a766f6c 100644 --- a/src/or/entrynodes.c +++ b/src/or/entrynodes.c @@ -1694,6 +1694,27 @@ getinfo_helper_entry_guards(control_connection_t *conn, return 0; } +/** Return 0 if we should apply guardfraction information found in the + * consensus. A specific consensus can be specified with the + * ns argument, if NULL the most recent one will be picked.*/ +int +should_apply_guardfraction(const networkstatus_t *ns) +{ + /* We need to check the corresponding torrc option and the consensus + * parameter if we need to. */ + const or_options_t *options = get_options(); + + /* If UseGuardFraction is 'auto' then check the same-named consensus + * parameter. If the consensus parameter is not present, default to + * "off". */ + if (options->UseGuardFraction == -1) { + return networkstatus_get_param(ns, "UseGuardFraction", + 0, /* default to "off" */ + 0, 1); + } + + return options->UseGuardFraction; +} /** A list of configured bridges. Whenever we actually get a descriptor * for one, we add it as an entry guard. Note that the order of bridges * in this list does not necessarily correspond to the order of bridges diff --git a/src/or/entrynodes.h b/src/or/entrynodes.h index 7f3a4fb..96d832e 100644 --- a/src/or/entrynodes.h +++ b/src/or/entrynodes.h @@ -160,5 +160,7 @@ int validate_pluggable_transports_config(void); double pathbias_get_close_success_count(entry_guard_t *guard); double pathbias_get_use_success_count(entry_guard_t *guard); +int should_apply_guardfraction(const networkstatus_t *ns); + #endif diff --git a/src/or/or.h b/src/or/or.h index 1f2231e..b8d4e1a 100644 --- a/src/or/or.h +++ b/src/or/or.h @@ -3818,6 +3818,12 @@ typedef struct { int NumEntryGuards; /**< How many entry guards do we try to establish? */ int UseEntryGuardsAsDirGuards; /** Boolean: Do we try to get directory info * from a smallish number of fixed nodes? */ + + /** If 1, we use any guardfraction information we see in the + * consensus. If 0, we don't. If -1, let the consensus parameter + * decide. */ + int UseGuardFraction; + int NumDirectoryGuards; /**< How many dir guards do we try to establish? * If 0, use value from NumEntryGuards. */ int RephistTrackTime; /**< How many seconds do we keep rephist info? */ diff --git a/src/or/routerparse.c b/src/or/routerparse.c index a2bc8fb..8a00544 100644 --- a/src/or/routerparse.c +++ b/src/or/routerparse.c @@ -9,6 +9,8 @@ * \brief Code to parse and validate router descriptors and directories. **/ +#define ROUTERPARSE_PRIVATE + #include "or.h" #include "config.h" #include "circuitstats.h" @@ -23,6 +25,7 @@ #include "networkstatus.h" #include "rephist.h" #include "routerparse.h" +#include "entrynodes.h" #undef log #include <math.h> @@ -1792,6 +1795,63 @@ find_start_of_next_routerstatus(const char *s) return eos; } +/** Parse the GuardFraction string from a consensus or vote. + * + * If vote or vote_rs are set the document getting + * parsed is a vote routerstatus. Otherwise it's a consensus. This is + * the same semantic as in routerstatus_parse_entry_from_string(). */ +STATIC int +routerstatus_parse_guardfraction(const char *guardfraction_str, + networkstatus_t *vote, + vote_routerstatus_t *vote_rs, + routerstatus_t *rs) +{ + int ok; + const char *end_of_header = NULL; + int is_consensus = !vote_rs; + uint32_t guardfraction; + + tor_assert(bool_eq(vote, vote_rs)); + + /* If this info comes from a consensus, but we should't apply + guardfraction, just exit. */ + if (is_consensus && !should_apply_guardfraction(NULL)) { + return 0; + } + + end_of_header = strchr(guardfraction_str, '='); + if (!end_of_header) { + return -1; + } + + guardfraction = (uint32_t)tor_parse_ulong(end_of_header+1, + 10, 0, 100, &ok, NULL); + if (!ok) { + log_warn(LD_DIR, "Invalid GuardFraction %s", escaped(guardfraction_str)); + return -1; + } + + log_warn(LD_GENERAL, "[*] Parsed %s guardfraction '%s' for '%s'.", + is_consensus ? "consensus" : "vote", + guardfraction_str, rs->nickname); + + if (!is_consensus) { /* We are parsing a vote */ + vote_rs->status.guardfraction_percentage = guardfraction; + vote_rs->status.has_guardfraction = 1; + } else { + /* We are parsing a consensus. Only apply guardfraction to guards. */ + if (rs->is_possible_guard) { + rs->guardfraction_percentage = guardfraction; + rs->has_guardfraction = 1; + } else { + log_warn(LD_BUG, "Got GuardFraction for non-guard %s. " + "This is not supposed to happen. Not applying. ", rs->nickname); + } + } + + return 0; +} + /** Given a string at *s, containing a routerstatus object, and an * empty smartlist at tokens, parse and return the first router status * object in the string, and advance *s to just after the end of the @@ -1994,6 +2054,11 @@ routerstatus_parse_entry_from_string(memarea_t *area, vote->has_measured_bws = 1; } else if (!strcmpstart(tok->args[i], "Unmeasured=1")) { rs->bw_is_unmeasured = 1; + } else if (!strcmpstart(tok->args[i], "GuardFraction=")) { + if (routerstatus_parse_guardfraction(tok->args[i], + vote, vote_rs, rs) < 0) { + goto err; + } } } } diff --git a/src/or/routerparse.h b/src/or/routerparse.h index 18a7d25..fc21cb1 100644 --- a/src/or/routerparse.h +++ b/src/or/routerparse.h @@ -85,5 +85,12 @@ int rend_parse_introduction_points(rend_service_descriptor_t *parsed, size_t intro_points_encoded_size); int rend_parse_client_keys(strmap_t *parsed_clients, const char *str); +#ifdef ROUTERPARSE_PRIVATE +STATIC int routerstatus_parse_guardfraction(const char *guardfraction_str, + networkstatus_t *vote, + vote_routerstatus_t *vote_rs, + routerstatus_t *rs); +#endif + #endif

1 0

[tor/master] Calculate the guardfraction bandwidth of a guard.
by nickm＠torproject.org 18 Feb '15

18 Feb '15

commit 14a3c17ce658c47ae9a0b8e689970efe37ca3b22 Author: George Kadianakis <desnacked(a)riseup.net> Date: Thu Jan 29 15:05:30 2015 +0000 Calculate the guardfraction bandwidth of a guard. --- src/or/entrynodes.c | 36 ++++++++++++++++++++++++++++++++++++ src/or/entrynodes.h | 14 ++++++++++++++ 2 files changed, 50 insertions(+) diff --git a/src/or/entrynodes.c b/src/or/entrynodes.c index a766f6c..93b23f6 100644 --- a/src/or/entrynodes.c +++ b/src/or/entrynodes.c @@ -1715,6 +1715,42 @@ should_apply_guardfraction(const networkstatus_t *ns) return options->UseGuardFraction; } + +/* Given the original bandwidth of a guard and its guardfraction, + * calculate how much bandwidth the guard should have as a guard and + * as a non-guard. + * + * Quoting from proposal236: + * + * Let Wpf denote the weight from the 'bandwidth-weights' line a + * client would apply to N for position p if it had the guard + * flag, Wpn the weight if it did not have the guard flag, and B the + * measured bandwidth of N in the consensus. Then instead of choosing + * N for position p proportionally to Wpf*B or Wpn*B, clients should + * choose N proportionally to F*Wpf*B + (1-F)*Wpn*B. + * + * This function fills the guardfraction_bw structure. It sets + * guard_bw to F*B and non_guard_bw to (1-F)*B. + */ +void +guard_get_guardfraction_bandwidth(guardfraction_bandwidth_t *guardfraction_bw, + int orig_bandwidth, + uint32_t guardfraction_percentage) +{ + double guardfraction_fraction; + + /* Turn the percentage into a fraction. */ + tor_assert(guardfraction_percentage <= 100); + guardfraction_fraction = guardfraction_percentage / 100.0; + + long guard_bw = tor_lround(guardfraction_fraction * orig_bandwidth); + tor_assert(guard_bw <= INT_MAX); + + guardfraction_bw->guard_bw = (int) guard_bw; + + guardfraction_bw->non_guard_bw = orig_bandwidth - guard_bw; +} + /** A list of configured bridges. Whenever we actually get a descriptor * for one, we add it as an entry guard. Note that the order of bridges * in this list does not necessarily correspond to the order of bridges diff --git a/src/or/entrynodes.h b/src/or/entrynodes.h index 96d832e..35bd748 100644 --- a/src/or/entrynodes.h +++ b/src/or/entrynodes.h @@ -160,7 +160,21 @@ int validate_pluggable_transports_config(void); double pathbias_get_close_success_count(entry_guard_t *guard); double pathbias_get_use_success_count(entry_guard_t *guard); +/** Contains the bandwidth of a relay as a guard and as a non-guard + * after the guardfraction has been considered. */ +typedef struct guardfraction_bandwidth_t { + /* Bandwidth as a guard after guardfraction has been considered. */ + int guard_bw; + /* Bandwidth as a non-guard after guardfraction has been considered. */ + int non_guard_bw; +} guardfraction_bandwidth_t; + int should_apply_guardfraction(const networkstatus_t *ns); +void +guard_get_guardfraction_bandwidth(guardfraction_bandwidth_t *guardfraction_bw, + int orig_bandwidth, + uint32_t guardfraction_percentage); + #endif

1 0

[tor/master] Unittest prep: Move get_yesterday_date_str() to helper file.
by nickm＠torproject.org 18 Feb '15

18 Feb '15

commit c2b13e22e7c03f6e318b516ae1faf76f8ba30e83 Author: George Kadianakis <desnacked(a)riseup.net> Date: Thu Jan 29 15:09:53 2015 +0000 Unittest prep: Move get_yesterday_date_str() to helper file. We want to use this function in our guardfraction unittests, so make a test_helpers module and move it there. --- src/test/include.am | 2 ++ src/test/test_entrynodes.c | 14 +------------- src/test/test_helpers.c | 26 ++++++++++++++++++++++++++ src/test/test_helpers.h | 10 ++++++++++ 4 files changed, 39 insertions(+), 13 deletions(-) diff --git a/src/test/include.am b/src/test/include.am index 595be0b..a41b221 100644 --- a/src/test/include.am +++ b/src/test/include.am @@ -61,6 +61,7 @@ src_test_test_SOURCES = \ src/test/test_status.c \ src/test/test_threads.c \ src/test/test_util.c \ + src/test/test_helpers.c \ src/test/testing_common.c \ src/ext/tinytest.c @@ -119,6 +120,7 @@ src_test_test_workqueue_LDADD = src/or/libtor-testing.a \ noinst_HEADERS+= \ src/test/fakechans.h \ src/test/test.h \ + src/test/test_helpers.h \ src/test/test_descriptors.inc \ src/test/example_extrainfo.inc \ src/test/failing_routerdescs.inc \ diff --git a/src/test/test_entrynodes.c b/src/test/test_entrynodes.c index 19071a1..b60b233 100644 --- a/src/test/test_entrynodes.c +++ b/src/test/test_entrynodes.c @@ -19,6 +19,7 @@ #include "config.h" #include "test_descriptors.inc" +#include "test_helpers.h" /* TODO: * choose_random_entry() test with state set. @@ -326,19 +327,6 @@ state_lines_free(smartlist_t *entry_guard_lines) smartlist_free(entry_guard_lines); } -/* Return a statically allocated string representing yesterday's date - * in ISO format. We use it so that state file items are not found to - * be outdated. */ -static const char * -get_yesterday_date_str(void) -{ - static char buf[ISO_TIME_LEN+1]; - - time_t yesterday = time(NULL) - 24*60*60; - format_iso_time(buf, yesterday); - return buf; -} - /* Tests entry_guards_parse_state(). It creates a fake Tor state with a saved entry guard and makes sure that Tor can parse it and creates the right entry node out of it. diff --git a/src/test/test_helpers.c b/src/test/test_helpers.c new file mode 100644 index 0000000..e5a76e0 --- /dev/null +++ b/src/test/test_helpers.c @@ -0,0 +1,26 @@ +/* Copyright (c) 2014, The Tor Project, Inc. */ +/* See LICENSE for licensing information */ + +/** + * \file test_helpers.c + * \brief Some helper functions to avoid code duplication in unit tests. + */ + +#include "orconfig.h" +#include "or.h" + +#include "test_helpers.h" + +/* Return a statically allocated string representing yesterday's date + * in ISO format. We use it so that state file items are not found to + * be outdated. */ +const char * +get_yesterday_date_str(void) +{ + static char buf[ISO_TIME_LEN+1]; + + time_t yesterday = time(NULL) - 24*60*60; + format_iso_time(buf, yesterday); + return buf; +} + diff --git a/src/test/test_helpers.h b/src/test/test_helpers.h new file mode 100644 index 0000000..2618e81 --- /dev/null +++ b/src/test/test_helpers.h @@ -0,0 +1,10 @@ +/* Copyright (c) 2014, The Tor Project, Inc. */ +/* See LICENSE for licensing information */ + +#ifndef TOR_TEST_HELPERS_H +#define TOR_TEST_HELPERS_H + +const char *get_yesterday_date_str(void); + +#endif +

1 0

[tor/master] Final guardfraction preparations for upstream merge.
by nickm＠torproject.org 18 Feb '15

18 Feb '15

commit 33053d50a0c3a3545285bac8b6883f7c66cf748c Author: George Kadianakis <desnacked(a)riseup.net> Date: Thu Jan 29 15:49:23 2015 +0000 Final guardfraction preparations for upstream merge. - Write a changes file. - Change some logs to lesser severities. --- changes/bug9321 | 7 +++++++ src/or/dirserv.c | 2 +- src/or/dirvote.c | 2 +- src/or/routerlist.c | 6 +++--- src/or/routerparse.c | 6 +++--- 5 files changed, 15 insertions(+), 8 deletions(-) diff --git a/changes/bug9321 b/changes/bug9321 new file mode 100644 index 0000000..9826084 --- /dev/null +++ b/changes/bug9321 @@ -0,0 +1,7 @@ + o Major features: + - Introduce the Guardfraction feature which improves the load + balancing of path selection towards guard nodes. Specifically, + it aims to reduce the traffic gap that guard nodes experience + when they first get the Guard flag. This is a required step if + we want to increase the guard lifetime to 9 months or greater. + Resolves ticket 9321. diff --git a/src/or/dirserv.c b/src/or/dirserv.c index 10b9e63..9939c31 100644 --- a/src/or/dirserv.c +++ b/src/or/dirserv.c @@ -2436,7 +2436,7 @@ dirserv_read_guardfraction_file_from_str(const char *guardfraction_file_str, retval = 0; - log_warn(LD_CONFIG, + log_info(LD_CONFIG, "Successfully parsed guardfraction file with %d consensuses over " "%d days. Parsed %d nodes and applied %d of them%s.", total_consensuses, total_days, guards_read_n, guards_applied_n, diff --git a/src/or/dirvote.c b/src/or/dirvote.c index 0e48485..8a73beb 100644 --- a/src/or/dirvote.c +++ b/src/or/dirvote.c @@ -1020,7 +1020,7 @@ update_total_bandwidth_weights(const routerstatus_t *rs, int guardfraction_bandwidth = 0; if (!rs->has_bandwidth) { - log_warn(LD_BUG, "Missing consensus bandwidth for router %s", + log_info(LD_BUG, "Missing consensus bandwidth for router %s", rs->nickname); return; } diff --git a/src/or/routerlist.c b/src/or/routerlist.c index 61b2f74..41fdb7a 100644 --- a/src/or/routerlist.c +++ b/src/or/routerlist.c @@ -2166,9 +2166,9 @@ compute_weighted_bandwidths(const smartlist_t *sl, guardfraction_bw.guard_bw * weight + guardfraction_bw.non_guard_bw * weight_without_guard_flag; - log_warn(LD_GENERAL, "%s: Guardfraction weight %f instead of %f (%s)", - node->rs->nickname, final_weight, weight*this_bw, - bandwidth_weight_rule_to_string(rule)); + log_debug(LD_GENERAL, "%s: Guardfraction weight %f instead of %f (%s)", + node->rs->nickname, final_weight, weight*this_bw, + bandwidth_weight_rule_to_string(rule)); } else { /* no guardfraction information. calculate the weight normally. */ final_weight = weight*this_bw; } diff --git a/src/or/routerparse.c b/src/or/routerparse.c index 8a00544..93274fa 100644 --- a/src/or/routerparse.c +++ b/src/or/routerparse.c @@ -1831,9 +1831,9 @@ routerstatus_parse_guardfraction(const char *guardfraction_str, return -1; } - log_warn(LD_GENERAL, "[*] Parsed %s guardfraction '%s' for '%s'.", - is_consensus ? "consensus" : "vote", - guardfraction_str, rs->nickname); + log_debug(LD_GENERAL, "[*] Parsed %s guardfraction '%s' for '%s'.", + is_consensus ? "consensus" : "vote", + guardfraction_str, rs->nickname); if (!is_consensus) { /* We are parsing a vote */ vote_rs->status.guardfraction_percentage = guardfraction;

1 0

[tor/master] Calculate total bandwidth weights using the guardfraction bandwidths.
by nickm＠torproject.org 18 Feb '15

18 Feb '15

commit f7a8b1918446ad5c88955a76911955daba6684ac Author: George Kadianakis <desnacked(a)riseup.net> Date: Thu Jan 29 15:06:33 2015 +0000 Calculate total bandwidth weights using the guardfraction bandwidths. Now use the function introduced in the previous commit, to calculate the total bandwidth weights when making the consensus. --- src/or/dirvote.c | 99 ++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 85 insertions(+), 14 deletions(-) diff --git a/src/or/dirvote.c b/src/or/dirvote.c index f637fb6..0e48485 100644 --- a/src/or/dirvote.c +++ b/src/or/dirvote.c @@ -16,6 +16,7 @@ #include "router.h" #include "routerlist.h" #include "routerparse.h" +#include "entrynodes.h" /* needed for guardfraction methods */ /** * \file dirvote.c @@ -1007,6 +1008,86 @@ networkstatus_compute_bw_weights_v10(smartlist_t *chunks, int64_t G, return 1; } +/** Update total bandwidth weights (G/M/E/D/T) with the bandwidth of + * the router in rs. */ +static void +update_total_bandwidth_weights(const routerstatus_t *rs, + int is_exit, int is_guard, + int64_t *G, int64_t *M, int64_t *E, int64_t *D, + int64_t *T) +{ + int default_bandwidth = rs->bandwidth_kb; + int guardfraction_bandwidth = 0; + + if (!rs->has_bandwidth) { + log_warn(LD_BUG, "Missing consensus bandwidth for router %s", + rs->nickname); + return; + } + + /* If this routerstatus represents a guard that we have + * guardfraction information on, use it to calculate its actual + * bandwidth. From proposal236: + * + * Similarly, when calculating the bandwidth-weights line as in + * section 3.8.3 of dir-spec.txt, directory authorities should treat N + * as if fraction F of its bandwidth has the guard flag and (1-F) does + * not. So when computing the totals G,M,E,D, each relay N with guard + * visibility fraction F and bandwidth B should be added as follows: + * + * G' = G + F*B, if N does not have the exit flag + * M' = M + (1-F)*B, if N does not have the exit flag + * + * or + * + * D' = D + F*B, if N has the exit flag + * E' = E + (1-F)*B, if N has the exit flag + * + * In this block of code, we prepare the bandwidth values by setting + * the default_bandwidth to F*B and guardfraction_bandwidth to (1-F)*B. */ + if (rs->has_guardfraction) { + guardfraction_bandwidth_t guardfraction_bw; + + tor_assert(is_guard); + + guard_get_guardfraction_bandwidth(&guardfraction_bw, + rs->bandwidth_kb, + rs->guardfraction_percentage); + + default_bandwidth = guardfraction_bw.guard_bw; + guardfraction_bandwidth = guardfraction_bw.non_guard_bw; + } + + /* Now calculate the total bandwidth weights with or without + guardfraction. Depending on the flags of the relay, add its + bandwidth to the appropriate weight pool. If it's a guard and + guardfraction is enabled, add its bandwidth to both pools as + indicated by the previous comment. */ + *T += default_bandwidth; + if (is_exit && is_guard) { + + *D += default_bandwidth; + if (rs->has_guardfraction) { + *E += guardfraction_bandwidth; + } + + } else if (is_exit) { + + *E += default_bandwidth; + + } else if (is_guard) { + + *G += default_bandwidth; + if (rs->has_guardfraction) { + *M += guardfraction_bandwidth; + } + + } else { + + *M += default_bandwidth; + } +} + /** Given a list of vote networkstatus_t in votes, our public * authority identity_key, our private authority signing_key, * and the number of total_authorities that we believe exist in our @@ -1582,21 +1663,11 @@ networkstatus_compute_consensus(smartlist_t *votes, /* Fix bug 2203: Do not count BadExit nodes as Exits for bw weights */ is_exit = is_exit && !is_bad_exit; + /* Update total bandwidth weights with the bandwidths of this router. */ { - if (rs_out.has_bandwidth) { - T += rs_out.bandwidth_kb; - if (is_exit && is_guard) - D += rs_out.bandwidth_kb; - else if (is_exit) - E += rs_out.bandwidth_kb; - else if (is_guard) - G += rs_out.bandwidth_kb; - else - M += rs_out.bandwidth_kb; - } else { - log_warn(LD_BUG, "Missing consensus bandwidth for router %s", - rs_out.nickname); - } + update_total_bandwidth_weights(&rs_out, + is_exit, is_guard, + &G, &M, &E, &D, &T); } /* Ok, we already picked a descriptor digest we want to list

1 0

[tor/master] Add unittests for the guardfraction feature.
by nickm＠torproject.org 18 Feb '15

18 Feb '15

commit 028ede2f5e4ca3f5695cf9ca73fb9bd17a7de898 Author: George Kadianakis <desnacked(a)riseup.net> Date: Thu Jan 29 15:10:28 2015 +0000 Add unittests for the guardfraction feature. --- src/test/include.am | 1 + src/test/test.c | 2 + src/test/test_guardfraction.c | 418 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 421 insertions(+) diff --git a/src/test/include.am b/src/test/include.am index a41b221..2b2294f 100644 --- a/src/test/include.am +++ b/src/test/include.am @@ -40,6 +40,7 @@ src_test_test_SOURCES = \ src/test/test_dir.c \ src/test/test_entryconn.c \ src/test/test_entrynodes.c \ + src/test/test_guardfraction.c \ src/test/test_extorport.c \ src/test/test_hs.c \ src/test/test_introduce.c \ diff --git a/src/test/test.c b/src/test/test.c index ff4f517..ed5b445 100644 --- a/src/test/test.c +++ b/src/test/test.c @@ -1126,6 +1126,7 @@ extern struct testcase_t crypto_tests[]; extern struct testcase_t dir_tests[]; extern struct testcase_t entryconn_tests[]; extern struct testcase_t entrynodes_tests[]; +extern struct testcase_t guardfraction_tests[]; extern struct testcase_t extorport_tests[]; extern struct testcase_t hs_tests[]; extern struct testcase_t introduce_tests[]; @@ -1170,6 +1171,7 @@ struct testgroup_t testgroups[] = { { "dir/md/", microdesc_tests }, { "entryconn/", entryconn_tests }, { "entrynodes/", entrynodes_tests }, + { "guardfraction/", guardfraction_tests }, { "extorport/", extorport_tests }, { "hs/", hs_tests }, { "introduce/", introduce_tests }, diff --git a/src/test/test_guardfraction.c b/src/test/test_guardfraction.c new file mode 100644 index 0000000..e9cf890 --- /dev/null +++ b/src/test/test_guardfraction.c @@ -0,0 +1,418 @@ +/* Copyright (c) 2014, The Tor Project, Inc. */ +/* See LICENSE for licensing information */ + +#define DIRSERV_PRIVATE +#define ROUTERPARSE_PRIVATE +#define NETWORKSTATUS_PRIVATE + +#include "orconfig.h" +#include "or.h" +#include "config.h" +#include "dirserv.h" +#include "container.h" +#include "entrynodes.h" +#include "util.h" +#include "routerparse.h" +#include "networkstatus.h" + +#include "test.h" +#include "test_helpers.h" + +/* Generate a vote_routerstatus_t for a router with identity digest + digest_in_hex. */ +static vote_routerstatus_t * +gen_vote_routerstatus_for_tests(const char *digest_in_hex, int is_guard) +{ + int retval; + vote_routerstatus_t *vrs = NULL; + routerstatus_t *rs; + + vrs = tor_malloc_zero(sizeof(vote_routerstatus_t)); + rs = &vrs->status; + + { /* Useful information for tests */ + char digest_tmp[DIGEST_LEN]; + + /* Guard or not? */ + rs->is_possible_guard = is_guard; + + /* Fill in the fpr */ + tt_int_op(strlen(digest_in_hex), ==, HEX_DIGEST_LEN); + retval = base16_decode(digest_tmp, sizeof(digest_tmp), + digest_in_hex, HEX_DIGEST_LEN); + tt_int_op(retval, ==, 0); + memcpy(rs->identity_digest, digest_tmp, DIGEST_LEN); + } + + { /* Misc info (maybe not used in tests) */ + vrs->version = tor_strdup("0.1.2.14"); + strlcpy(rs->nickname, "router2", sizeof(rs->nickname)); + memset(rs->descriptor_digest, 78, DIGEST_LEN); + rs->addr = 0x99008801; + rs->or_port = 443; + rs->dir_port = 8000; + /* all flags but running cleared */ + rs->is_flagged_running = 1; + vrs->has_measured_bw = 1; + rs->has_bandwidth = 1; + } + + return vrs; + + done: + vote_routerstatus_free(vrs); + + return NULL; +} + +/** Make sure our parsers reject corrupted guardfraction files. */ +static void +test_parse_guardfraction_file_bad(void *arg) +{ + int retval; + char *guardfraction_bad = NULL; + const char *yesterday_date_str = get_yesterday_date_str(); + + (void) arg; + + /* Start parsing all those corrupted guardfraction files! */ + + /* Guardfraction file version is not a number! */ + tor_asprintf(&guardfraction_bad, + "guardfraction-file-version nan\n" + "written-at %s\n" + "n-inputs 420 3\n" + "guard-seen D0EDB47BEAD32D26D0A837F7D5357EC3AD3B8777 100 420\n" + "guard-seen 07B5547026DF3E229806E135CFA8552D56AFBABC 5 420\n", + yesterday_date_str); + + retval = dirserv_read_guardfraction_file_from_str(guardfraction_bad, NULL); + tt_int_op(retval, ==, -1); + tor_free(guardfraction_bad); + + /* This one does not have a date! Parsing should fail. */ + tor_asprintf(&guardfraction_bad, + "guardfraction-file-version 1\n" + "written-at not_date\n" + "n-inputs 420 3\n" + "guard-seen D0EDB47BEAD32D26D0A837F7D5357EC3AD3B8777 100 420\n" + "guard-seen 07B5547026DF3E229806E135CFA8552D56AFBABC 5 420\n"); + + retval = dirserv_read_guardfraction_file_from_str(guardfraction_bad, NULL); + tt_int_op(retval, ==, -1); + tor_free(guardfraction_bad); + + /* This one has an incomplete n-inputs line, but parsing should + still continue. */ + tor_asprintf(&guardfraction_bad, + "guardfraction-file-version 1\n" + "written-at %s\n" + "n-inputs biggie\n" + "guard-seen D0EDB47BEAD32D26D0A837F7D5357EC3AD3B8777 100 420\n" + "guard-seen 07B5547026DF3E229806E135CFA8552D56AFBABC 5 420\n", + yesterday_date_str); + + retval = dirserv_read_guardfraction_file_from_str(guardfraction_bad, NULL); + tt_int_op(retval, ==, 2); + tor_free(guardfraction_bad); + + /* This one does not have a fingerprint in the guard line! */ + tor_asprintf(&guardfraction_bad, + "guardfraction-file-version 1\n" + "written-at %s\n" + "n-inputs 420 3\n" + "guard-seen not_a_fingerprint 100 420\n", + yesterday_date_str); + + retval = dirserv_read_guardfraction_file_from_str(guardfraction_bad, NULL); + tt_int_op(retval, ==, 0); + tor_free(guardfraction_bad); + + /* This one does not even have an integer guardfraction value. */ + tor_asprintf(&guardfraction_bad, + "guardfraction-file-version 1\n" + "written-at %s\n" + "n-inputs 420 3\n" + "guard-seen D0EDB47BEAD32D26D0A837F7D5357EC3AD3B8777 NaN 420\n" + "guard-seen 07B5547026DF3E229806E135CFA8552D56AFBABC 5 420\n", + yesterday_date_str); + + retval = dirserv_read_guardfraction_file_from_str(guardfraction_bad, NULL); + tt_int_op(retval, ==, 1); + tor_free(guardfraction_bad); + + /* This one is not a percentage (not in [0, 100]) */ + tor_asprintf(&guardfraction_bad, + "guardfraction-file-version 1\n" + "written-at %s\n" + "n-inputs 420 3\n" + "guard-seen D0EDB47BEAD32D26D0A837F7D5357EC3AD3B8777 666 420\n" + "guard-seen 07B5547026DF3E229806E135CFA8552D56AFBABC 5 420\n", + yesterday_date_str); + + retval = dirserv_read_guardfraction_file_from_str(guardfraction_bad, NULL); + tt_int_op(retval, ==, 1); + tor_free(guardfraction_bad); + + /* This one is not a percentage either (not in [0, 100]) */ + tor_asprintf(&guardfraction_bad, + "guardfraction-file-version 1\n" + "written-at %s\n" + "n-inputs 420 3\n" + "guard-seen D0EDB47BEAD32D26D0A837F7D5357EC3AD3B8777 -3 420\n", + yesterday_date_str); + + retval = dirserv_read_guardfraction_file_from_str(guardfraction_bad, NULL); + tt_int_op(retval, ==, 0); + + done: + tor_free(guardfraction_bad); +} + +/* Make sure that our test guardfraction file gets parsed properly, and + * its information are applied properly to our routerstatuses. */ +static void +test_parse_guardfraction_file_good(void *arg) +{ + int retval; + vote_routerstatus_t *vrs_guard = NULL; + vote_routerstatus_t *vrs_dummy = NULL; + char *guardfraction_good = NULL; + const char *yesterday_date_str = get_yesterday_date_str(); + smartlist_t *routerstatuses = smartlist_new(); + + /* Some test values that we need to validate later */ + const char fpr_guard[] = "D0EDB47BEAD32D26D0A837F7D5357EC3AD3B8777"; + const char fpr_unlisted[] = "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"; + const int guardfraction_value = 42; + + (void) arg; + + { + /* Populate the smartlist with some fake routerstatuses, so that + after parsing the guardfraction file we can check that their + elements got filled properly. */ + + /* This one is a guard */ + vrs_guard = gen_vote_routerstatus_for_tests(fpr_guard, 1); + tt_assert(vrs_guard); + smartlist_add(routerstatuses, vrs_guard); + + /* This one is a guard but it's not in the guardfraction file */ + vrs_dummy = gen_vote_routerstatus_for_tests(fpr_unlisted, 1); + tt_assert(vrs_dummy); + smartlist_add(routerstatuses, vrs_dummy); + } + + tor_asprintf(&guardfraction_good, + "guardfraction-file-version 1\n" + "written-at %s\n" + "n-inputs 420 3\n" + "guard-seen %s %d 420\n", + yesterday_date_str, + fpr_guard, guardfraction_value); + + /* Read the guardfraction file */ + retval = dirserv_read_guardfraction_file_from_str(guardfraction_good, + routerstatuses); + tt_int_op(retval, ==, 1); + + { /* Test that routerstatus fields got filled properly */ + + /* The guardfraction fields of the guard should be filled. */ + tt_assert(vrs_guard->status.has_guardfraction); + tt_int_op(vrs_guard->status.guardfraction_percentage, + ==, + guardfraction_value); + + /* The guard that was not in the guardfraction file should not have + been touched either. */ + tt_assert(!vrs_dummy->status.has_guardfraction); + } + + done: + vote_routerstatus_free(vrs_guard); + vote_routerstatus_free(vrs_dummy); + smartlist_free(routerstatuses); + tor_free(guardfraction_good); +} + +/** Make sure that the guardfraction bandwidths get calculated properly. */ +static void +test_get_guardfraction_bandwidth(void *arg) +{ + guardfraction_bandwidth_t gf_bw; + const int orig_bw = 1000; + + (void) arg; + + /* A guard with bandwidth 1000 and GuardFraction 0.25, should have + bandwidth 250 as a guard and bandwidth 750 as a non-guard. */ + guard_get_guardfraction_bandwidth(&gf_bw, + orig_bw, 25); + + tt_int_op(gf_bw.guard_bw, ==, 250); + tt_int_op(gf_bw.non_guard_bw, ==, 750); + + /* Also check the 'guard_bw + non_guard_bw == original_bw' + * invariant. */ + tt_int_op(gf_bw.non_guard_bw + gf_bw.guard_bw, ==, orig_bw); + + done: + ; +} + +/** Parse the GuardFraction element of the consensus, and make sure it + * gets parsed correctly. */ +static void +test_parse_guardfraction_consensus(void *arg) +{ + int retval; + or_options_t *options = get_options_mutable(); + + const char *guardfraction_str_good = "GuardFraction=66"; + routerstatus_t rs_good; + routerstatus_t rs_no_guard; + + const char *guardfraction_str_bad1 = "GuardFraction="; /* no value */ + routerstatus_t rs_bad1; + + const char *guardfraction_str_bad2 = "GuardFraction=166"; /* no percentage */ + routerstatus_t rs_bad2; + + (void) arg; + + /* GuardFraction use is currently disabled by default. So we need to + manually enable it. */ + options->UseGuardFraction = 1; + + { /* Properly formatted GuardFraction. Check that it gets applied + correctly. */ + memset(&rs_good, 0, sizeof(routerstatus_t)); + rs_good.is_possible_guard = 1; + + retval = routerstatus_parse_guardfraction(guardfraction_str_good, + NULL, NULL, + &rs_good); + tt_int_op(retval, ==, 0); + tt_assert(rs_good.has_guardfraction); + tt_int_op(rs_good.guardfraction_percentage, ==, 66); + } + + { /* Properly formatted GuardFraction but router is not a + guard. GuardFraction should not get applied. */ + memset(&rs_no_guard, 0, sizeof(routerstatus_t)); + tt_assert(!rs_no_guard.is_possible_guard); + + retval = routerstatus_parse_guardfraction(guardfraction_str_good, + NULL, NULL, + &rs_no_guard); + tt_int_op(retval, ==, 0); + tt_assert(!rs_no_guard.has_guardfraction); + } + + { /* Bad GuardFraction. Function should fail and not apply. */ + memset(&rs_bad1, 0, sizeof(routerstatus_t)); + rs_bad1.is_possible_guard = 1; + + retval = routerstatus_parse_guardfraction(guardfraction_str_bad1, + NULL, NULL, + &rs_bad1); + tt_int_op(retval, ==, -1); + tt_assert(!rs_bad1.has_guardfraction); + } + + { /* Bad GuardFraction. Function should fail and not apply. */ + memset(&rs_bad2, 0, sizeof(routerstatus_t)); + rs_bad2.is_possible_guard = 1; + + retval = routerstatus_parse_guardfraction(guardfraction_str_bad2, + NULL, NULL, + &rs_bad2); + tt_int_op(retval, ==, -1); + tt_assert(!rs_bad2.has_guardfraction); + } + + done: + ; +} + +/* Make sure that we use GuardFraction information when we should, + according to the torrc option and consensus parameter. */ +static void +test_should_apply_guardfraction(void *arg) +{ + networkstatus_t vote_enabled, vote_disabled, vote_missing; + or_options_t *options = get_options_mutable(); + + (void) arg; + + { /* Fill the votes for later */ + /* This one suggests enabled GuardFraction. */ + memset(&vote_enabled, 0, sizeof(vote_enabled)); + vote_enabled.net_params = smartlist_new(); + smartlist_split_string(vote_enabled.net_params, + "UseGuardFraction=1", NULL, 0, 0); + + /* This one suggests disabled GuardFraction. */ + memset(&vote_disabled, 0, sizeof(vote_disabled)); + vote_disabled.net_params = smartlist_new(); + smartlist_split_string(vote_disabled.net_params, + "UseGuardFraction=0", NULL, 0, 0); + + /* This one doesn't have GuardFraction at all. */ + memset(&vote_missing, 0, sizeof(vote_missing)); + vote_missing.net_params = smartlist_new(); + smartlist_split_string(vote_missing.net_params, + "leon=trout", NULL, 0, 0); + } + + /* If torrc option is set to yes, we should always use + * guardfraction.*/ + options->UseGuardFraction = 1; + tt_int_op(should_apply_guardfraction(&vote_disabled), ==, 1); + + /* If torrc option is set to no, we should never use + * guardfraction.*/ + options->UseGuardFraction = 0; + tt_int_op(should_apply_guardfraction(&vote_enabled), ==, 0); + + /* Now let's test torrc option set to auto. */ + options->UseGuardFraction = -1; + + /* If torrc option is set to auto, and consensus parameter is set to + * yes, we should use guardfraction. */ + tt_int_op(should_apply_guardfraction(&vote_enabled), ==, 1); + + /* If torrc option is set to auto, and consensus parameter is set to + * no, we should use guardfraction. */ + tt_int_op(should_apply_guardfraction(&vote_disabled), ==, 0); + + /* If torrc option is set to auto, and consensus parameter is not + * set, we should fallback to "no". */ + tt_int_op(should_apply_guardfraction(&vote_missing), ==, 0); + + done: + SMARTLIST_FOREACH(vote_enabled.net_params, char *, cp, tor_free(cp)); + SMARTLIST_FOREACH(vote_disabled.net_params, char *, cp, tor_free(cp)); + SMARTLIST_FOREACH(vote_missing.net_params, char *, cp, tor_free(cp)); + smartlist_free(vote_enabled.net_params); + smartlist_free(vote_disabled.net_params); + smartlist_free(vote_missing.net_params); +} + +struct testcase_t guardfraction_tests[] = { + { "parse_guardfraction_file_bad", test_parse_guardfraction_file_bad, + TT_FORK, NULL, NULL }, + { "parse_guardfraction_file_good", test_parse_guardfraction_file_good, + TT_FORK, NULL, NULL }, + { "parse_guardfraction_consensus", test_parse_guardfraction_consensus, + TT_FORK, NULL, NULL }, + { "get_guardfraction_bandwidth", test_get_guardfraction_bandwidth, + TT_FORK, NULL, NULL }, + { "should_apply_guardfraction", test_should_apply_guardfraction, + TT_FORK, NULL, NULL }, + + END_OF_TESTCASES +}; +

1 0

[tor/master] Don't exit if we can't find the GuardfractionFile when booting.
by nickm＠torproject.org 18 Feb '15

18 Feb '15

commit 5c34a53068f5556f5648dfe522030983f552a1fd Author: George Kadianakis <desnacked(a)riseup.net> Date: Fri Feb 6 12:20:24 2015 +0000 Don't exit if we can't find the GuardfractionFile when booting. ...just disable the feature in that case. --- src/or/config.c | 7 ------- 1 file changed, 7 deletions(-) diff --git a/src/or/config.c b/src/or/config.c index 230ea7f..b62b9f7 100644 --- a/src/or/config.c +++ b/src/or/config.c @@ -2791,13 +2791,6 @@ options_validate(or_options_t *old_options, or_options_t *options, } /* same for guardfraction file */ if (options->GuardfractionFile && !old_options) { - file_status_t fs = file_status(options->GuardfractionFile); - if (fs == FN_EMPTY) { - REJECT("GuardfractionFile set but it's an empty file? Failing"); - } else if (fs != FN_FILE) { - REJECT("GuardfractionFile set but not a file? Failing"); - } - dirserv_read_guardfraction_file(options->GuardfractionFile, NULL); } }

1 0

[tor/master] Merge branch 'bug9321_rerebase'
by nickm＠torproject.org 18 Feb '15

18 Feb '15

commit 96211bcf714ac739f605dc0b5b8754418080591f Merge: 164eeef 5c34a53 Author: Nick Mathewson <nickm(a)torproject.org> Date: Wed Feb 18 09:17:02 2015 -0500 Merge branch 'bug9321_rerebase' Conflicts: src/or/dirvote.h src/test/include.am src/test/test_entrynodes.c changes/bug9321 | 7 + doc/tor.1.txt | 11 ++ src/or/config.c | 6 + src/or/dirserv.c | 326 ++++++++++++++++++++++++++++++++ src/or/dirserv.h | 7 + src/or/dirvote.c | 136 ++++++++++++-- src/or/dirvote.h | 9 +- src/or/entrynodes.c | 57 ++++++ src/or/entrynodes.h | 16 ++ src/or/or.h | 15 ++ src/or/routerlist.c | 42 ++++- src/or/routerparse.c | 65 +++++++ src/or/routerparse.h | 7 + src/test/include.am | 3 + src/test/test.c | 2 + src/test/test_entrynodes.c | 14 +- src/test/test_guardfraction.c | 418 +++++++++++++++++++++++++++++++++++++++++ src/test/test_helpers.c | 26 +++ src/test/test_helpers.h | 10 + src/test/testhelper.h | 2 + 20 files changed, 1146 insertions(+), 33 deletions(-) diff --cc src/or/dirvote.h index 20dcbcd,f5ecdaf..542563b --- a/src/or/dirvote.h +++ b/src/or/dirvote.h @@@ -55,7 -55,7 +55,7 @@@ #define MIN_SUPPORTED_CONSENSUS_METHOD 13 /** The highest consensus method that we currently support. */ --#define MAX_SUPPORTED_CONSENSUS_METHOD 19 ++#define MAX_SUPPORTED_CONSENSUS_METHOD 20 /** Lowest consensus method where microdesc consensuses omit any entry * with no microdesc. */ @@@ -79,11 -79,12 +79,16 @@@ * microdescriptors. */ #define MIN_METHOD_FOR_ID_HASH_IN_MD 18 +/** Lowest consensus method where we include "package" lines*/ +#define MIN_METHOD_FOR_PACKAGE_LINES 19 + + /** Lowest consensus method where authorities may include + * GuardFraction information in microdescriptors. */ -#define MIN_METHOD_FOR_GUARDFRACTION 19 ++#define MIN_METHOD_FOR_GUARDFRACTION 20 + /** Default bandwidth to clip unmeasured bandwidths to using method >= -- * MIN_METHOD_TO_CLIP_UNMEASURED_BW */ ++ * MIN_METHOD_TO_CLIP_UNMEASURED_BW. (This is not a consensus method; do not ++ * get confused with the above macros.) */ #define DEFAULT_MAX_UNMEASURED_BW_KB 20 void dirvote_free_all(void); diff --cc src/test/include.am index 71041b1,2b2294f..1c44ff1 --- a/src/test/include.am +++ b/src/test/include.am @@@ -61,8 -62,8 +62,9 @@@ src_test_test_SOURCES = src/test/test_status.c \ src/test/test_threads.c \ src/test/test_util.c \ + src/test/test_helpers.c \ src/test/testing_common.c \ + src/test/testhelper.c \ src/ext/tinytest.c src_test_test_slow_SOURCES = \ @@@ -120,7 -121,7 +122,8 @@@ src_test_test_workqueue_LDADD = src/or/ noinst_HEADERS+= \ src/test/fakechans.h \ src/test/test.h \ + src/test/testhelper.h \ + src/test/test_helpers.h \ src/test/test_descriptors.inc \ src/test/example_extrainfo.inc \ src/test/failing_routerdescs.inc \ diff --cc src/test/test_entrynodes.c index a7e18cd,b60b233..3137edb --- a/src/test/test_entrynodes.c +++ b/src/test/test_entrynodes.c @@@ -18,7 -18,8 +18,8 @@@ #include "statefile.h" #include "config.h" -#include "test_descriptors.inc" +#include "testhelper.h" + #include "test_helpers.h" /* TODO: * choose_random_entry() test with state set. diff --cc src/test/testhelper.h index 6b1bde6,0000000..4a6718a mode 100644,000000..100644 --- a/src/test/testhelper.h +++ b/src/test/testhelper.h @@@ -1,10 -1,0 +1,12 @@@ +#ifndef TOR_TEST_HELPER_H +#define TOR_TEST_HELPER_H + +/* Number of descriptors contained in test_descriptors.txt. */ +#define HELPER_NUMBER_OF_DESCRIPTORS 8 + +void helper_setup_fake_routerlist(void); + ++extern const char TEST_DESCRIPTORS[]; ++ +#endif +

1 0

[tor/master] Combine test_helpers.[ch] and testhelper.[ch]
by nickm＠torproject.org 18 Feb '15

18 Feb '15

commit 6cdb213b6cb9f682c3f72bba974f53f588d71b61 Author: Nick Mathewson <nickm(a)torproject.org> Date: Wed Feb 18 09:19:38 2015 -0500 Combine test_helpers.[ch] and testhelper.[ch] --- src/test/include.am | 2 -- src/test/test_entrynodes.c | 1 - src/test/test_helpers.c | 63 +++++++++++++++++++++++++++++++++++++++++ src/test/test_helpers.h | 9 +++++- src/test/test_hs.c | 2 +- src/test/testhelper.c | 67 -------------------------------------------- src/test/testhelper.h | 12 -------- 7 files changed, 72 insertions(+), 84 deletions(-) diff --git a/src/test/include.am b/src/test/include.am index 1c44ff1..d20d2f6 100644 --- a/src/test/include.am +++ b/src/test/include.am @@ -64,7 +64,6 @@ src_test_test_SOURCES = \ src/test/test_util.c \ src/test/test_helpers.c \ src/test/testing_common.c \ - src/test/testhelper.c \ src/ext/tinytest.c src_test_test_slow_SOURCES = \ @@ -122,7 +121,6 @@ src_test_test_workqueue_LDADD = src/or/libtor-testing.a \ noinst_HEADERS+= \ src/test/fakechans.h \ src/test/test.h \ - src/test/testhelper.h \ src/test/test_helpers.h \ src/test/test_descriptors.inc \ src/test/example_extrainfo.inc \ diff --git a/src/test/test_entrynodes.c b/src/test/test_entrynodes.c index 3137edb..17cb9d9 100644 --- a/src/test/test_entrynodes.c +++ b/src/test/test_entrynodes.c @@ -18,7 +18,6 @@ #include "statefile.h" #include "config.h" -#include "testhelper.h" #include "test_helpers.h" /* TODO: diff --git a/src/test/test_helpers.c b/src/test/test_helpers.c index e5a76e0..8f4a3a9 100644 --- a/src/test/test_helpers.c +++ b/src/test/test_helpers.c @@ -6,11 +6,18 @@ * \brief Some helper functions to avoid code duplication in unit tests. */ +#define ROUTERLIST_PRIVATE #include "orconfig.h" #include "or.h" +#include "routerlist.h" +#include "nodelist.h" + +#include "test.h" #include "test_helpers.h" +#include "test_descriptors.inc" + /* Return a statically allocated string representing yesterday's date * in ISO format. We use it so that state file items are not found to * be outdated. */ @@ -24,3 +31,59 @@ get_yesterday_date_str(void) return buf; } + +/* NOP replacement for router_descriptor_is_older_than() */ +static int +router_descriptor_is_older_than_replacement(const routerinfo_t *router, + int seconds) +{ + (void) router; + (void) seconds; + return 0; +} + +/** Parse a file containing router descriptors and load them to our + routerlist. This function is used to setup an artificial network + so that we can conduct tests on it. */ +void +helper_setup_fake_routerlist(void) +{ + int retval; + routerlist_t *our_routerlist = NULL; + smartlist_t *our_nodelist = NULL; + + /* Read the file that contains our test descriptors. */ + + /* We need to mock this function otherwise the descriptors will not + accepted as they are too old. */ + MOCK(router_descriptor_is_older_than, + router_descriptor_is_older_than_replacement); + + /* Load all the test descriptors to the routerlist. */ + retval = router_load_routers_from_string(TEST_DESCRIPTORS, + NULL, SAVED_IN_JOURNAL, + NULL, 0, NULL); + tt_int_op(retval, ==, HELPER_NUMBER_OF_DESCRIPTORS); + + /* Sanity checking of routerlist and nodelist. */ + our_routerlist = router_get_routerlist(); + tt_int_op(smartlist_len(our_routerlist->routers), ==, + HELPER_NUMBER_OF_DESCRIPTORS); + routerlist_assert_ok(our_routerlist); + + our_nodelist = nodelist_get_list(); + tt_int_op(smartlist_len(our_nodelist), ==, HELPER_NUMBER_OF_DESCRIPTORS); + + /* Mark all routers as non-guards but up and running! */ + SMARTLIST_FOREACH_BEGIN(our_nodelist, node_t *, node) { + node->is_running = 1; + node->is_valid = 1; + node->is_possible_guard = 0; + } SMARTLIST_FOREACH_END(node); + + done: + UNMOCK(router_descriptor_is_older_than); +} + + + diff --git a/src/test/test_helpers.h b/src/test/test_helpers.h index 2618e81..369243b 100644 --- a/src/test/test_helpers.h +++ b/src/test/test_helpers.h @@ -1,4 +1,4 @@ -/* Copyright (c) 2014, The Tor Project, Inc. */ +/* Copyright (c) 2014-2015, The Tor Project, Inc. */ /* See LICENSE for licensing information */ #ifndef TOR_TEST_HELPERS_H @@ -6,5 +6,12 @@ const char *get_yesterday_date_str(void); +/* Number of descriptors contained in test_descriptors.txt. */ +#define HELPER_NUMBER_OF_DESCRIPTORS 8 + +void helper_setup_fake_routerlist(void); + +extern const char TEST_DESCRIPTORS[]; + #endif diff --git a/src/test/test_hs.c b/src/test/test_hs.c index e70ca5e..67ef646 100644 --- a/src/test/test_hs.c +++ b/src/test/test_hs.c @@ -12,10 +12,10 @@ #include "or.h" #include "test.h" #include "control.h" -#include "testhelper.h" #include "config.h" #include "routerset.h" #include "circuitbuild.h" +#include "test_helpers.h" /* mock ID digest and longname for node that's in nodelist */ #define HSDIR_EXIST_ID "\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA\xAA" \ diff --git a/src/test/testhelper.c b/src/test/testhelper.c deleted file mode 100644 index 8bbc192..0000000 --- a/src/test/testhelper.c +++ /dev/null @@ -1,67 +0,0 @@ -/* Copyright (c) 2014, The Tor Project, Inc. */ -/* See LICENSE for licensing information */ - -#define ROUTERLIST_PRIVATE - -#include "or.h" -#include "routerlist.h" -#include "testhelper.h" -#include "nodelist.h" - -#include "test.h" - -#include "test_descriptors.inc" - -/* NOP replacement for router_descriptor_is_older_than() */ -static int -router_descriptor_is_older_than_replacement(const routerinfo_t *router, - int seconds) -{ - (void) router; - (void) seconds; - return 0; -} - -/** Parse a file containing router descriptors and load them to our - routerlist. This function is used to setup an artificial network - so that we can conduct tests on it. */ -void -helper_setup_fake_routerlist(void) -{ - int retval; - routerlist_t *our_routerlist = NULL; - smartlist_t *our_nodelist = NULL; - - /* Read the file that contains our test descriptors. */ - - /* We need to mock this function otherwise the descriptors will not - accepted as they are too old. */ - MOCK(router_descriptor_is_older_than, - router_descriptor_is_older_than_replacement); - - /* Load all the test descriptors to the routerlist. */ - retval = router_load_routers_from_string(TEST_DESCRIPTORS, - NULL, SAVED_IN_JOURNAL, - NULL, 0, NULL); - tt_int_op(retval, ==, HELPER_NUMBER_OF_DESCRIPTORS); - - /* Sanity checking of routerlist and nodelist. */ - our_routerlist = router_get_routerlist(); - tt_int_op(smartlist_len(our_routerlist->routers), ==, - HELPER_NUMBER_OF_DESCRIPTORS); - routerlist_assert_ok(our_routerlist); - - our_nodelist = nodelist_get_list(); - tt_int_op(smartlist_len(our_nodelist), ==, HELPER_NUMBER_OF_DESCRIPTORS); - - /* Mark all routers as non-guards but up and running! */ - SMARTLIST_FOREACH_BEGIN(our_nodelist, node_t *, node) { - node->is_running = 1; - node->is_valid = 1; - node->is_possible_guard = 0; - } SMARTLIST_FOREACH_END(node); - - done: - UNMOCK(router_descriptor_is_older_than); -} - diff --git a/src/test/testhelper.h b/src/test/testhelper.h deleted file mode 100644 index 4a6718a..0000000 --- a/src/test/testhelper.h +++ /dev/null @@ -1,12 +0,0 @@ -#ifndef TOR_TEST_HELPER_H -#define TOR_TEST_HELPER_H - -/* Number of descriptors contained in test_descriptors.txt. */ -#define HELPER_NUMBER_OF_DESCRIPTORS 8 - -void helper_setup_fake_routerlist(void); - -extern const char TEST_DESCRIPTORS[]; - -#endif -

1 0