Expand description
Functions for applying the correct weights to relays when choosing a relay at random.
The weight to use when picking a relay depends on several factors:
- The relayβs apparent bandwidth. (This is ideally measured by a set of bandwidth authorities, but if no bandwidth authorities are running (as on a test network), we might fall back either to relaysβ self-declared values, or we might treat all relays as having equal bandwidth.)
- The role that weβre selecting a relay to play. (See
WeightRole). - The flags that a relay has in the consensus, and their scarcity. If a relay provides particularly scarce functionality, we might choose not to use it for other roles, or to use it less commonly for them.
Re-exportsΒ§
use crate::ConsensusRelays;πuse crate::params::NetParameters;πuse bitflags::bitflags;πuse tor_netdoc::doc::netstatus;πuse tor_netdoc::doc::netstatus::MdConsensus;πuse tor_netdoc::doc::netstatus::MdRouterStatus;πuse tor_netdoc::doc::netstatus::ParamValues;π
StructsΒ§
- Relay
Weight π - Description for how to weight a single kind of relay for each WeightRole.
- Weight
Kind π - A kind of relay, for the purposes of selecting a relay by weight.
- Weight
Set π - Information derived from a consensus to use when picking relays by weighted bandwidth.
EnumsΒ§
- Bandwidth
Fn π - Internal: how should we find the base bandwidth of each relay? This value is global over a whole directory, and depends on the bandwidth weights in the consensus.
- Weight
Role - Possible ways to weight relays when selecting them a random.
ConstantsΒ§
- DFLT_
WEIGHT π - The value to return if a weight parameter is absent.
FunctionsΒ§
- calculate_
shift π - Compute a βshiftβ value such that
(a * b) >> shiftwill be contained inside 64 bits. - clamp_
to_ πpos - If
inpis less than 0, return 0. Otherwise returninpas a u32. - log2_
upper π - Return an upper bound for the log2 of n.
- pick_
bandwidth_ πfn - Helper: Calculate the function we should use to find initial relay bandwidths.
- w_param π
- Return the weight param named βkwdβ in p.