1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
use crate::skew::SkewObservation;
use rand::seq::IteratorRandom;
use std::time::{Duration, Instant};
use super::{DirStatus, FallbackDir, FallbackDirBuilder};
use crate::fallback::default_fallbacks;
use crate::{ids::FallbackId, PickGuardError};
use tor_config::define_list_builder_helper;
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct FallbackList {
fallbacks: Vec<FallbackDir>,
}
impl<T: IntoIterator<Item = FallbackDir>> From<T> for FallbackList {
fn from(fallbacks: T) -> Self {
FallbackList {
fallbacks: fallbacks.into_iter().collect(),
}
}
}
define_list_builder_helper! {
pub struct FallbackListBuilder {
pub(crate) fallbacks: [FallbackDirBuilder],
}
built: FallbackList = FallbackList { fallbacks };
default = default_fallbacks();
}
impl FallbackList {
pub fn len(&self) -> usize {
self.fallbacks.len()
}
pub fn is_empty(&self) -> bool {
self.fallbacks.is_empty()
}
pub fn choose<R: rand::Rng>(&self, rng: &mut R) -> Result<&FallbackDir, PickGuardError> {
self.fallbacks
.iter()
.choose(rng)
.ok_or(PickGuardError::AllFallbacksDown { retry_at: None })
}
}
#[derive(Debug, Clone)]
pub(crate) struct FallbackState {
fallbacks: Vec<Entry>,
}
#[derive(Debug, Clone)]
pub(super) struct Entry {
fallback: crate::FirstHop,
status: DirStatus,
clock_skew: Option<SkewObservation>,
}
const FALLBACK_RETRY_FLOOR: Duration = Duration::from_secs(150);
impl From<FallbackDir> for Entry {
fn from(fallback: FallbackDir) -> Self {
let fallback = fallback.as_guard();
let status = DirStatus::new(FALLBACK_RETRY_FLOOR);
Entry {
fallback,
status,
clock_skew: None,
}
}
}
impl Entry {
fn id(&self) -> &FallbackId {
use crate::ids::FirstHopIdInner::*;
match &self.fallback.id().0 {
Fallback(id) => id,
_ => panic!("Somehow we constructed a fallback object with a non-fallback id!"),
}
}
}
impl From<FallbackList> for FallbackState {
fn from(list: FallbackList) -> Self {
let mut fallbacks: Vec<Entry> = list.fallbacks.into_iter().map(|fb| fb.into()).collect();
fallbacks.sort_by(|x, y| x.id().cmp(y.id()));
fallbacks.dedup_by(|x, y| x.id() == y.id());
FallbackState { fallbacks }
}
}
impl FallbackState {
pub(crate) fn choose<R: rand::Rng>(
&self,
rng: &mut R,
now: Instant,
filter: &crate::GuardFilter,
) -> Result<&crate::FirstHop, PickGuardError> {
if self.fallbacks.is_empty() {
return Err(PickGuardError::NoCandidatesAvailable);
}
self.fallbacks
.iter()
.filter(|ent| ent.status.usable_at(now) && filter.permits(&ent.fallback))
.choose(rng)
.map(|ent| &ent.fallback)
.ok_or_else(|| PickGuardError::AllFallbacksDown {
retry_at: self.next_retry(),
})
}
fn next_retry(&self) -> Option<Instant> {
self.fallbacks
.iter()
.filter_map(|ent| ent.status.next_retriable())
.min()
}
fn get(&self, id: &FallbackId) -> Option<&Entry> {
match self.fallbacks.binary_search_by(|e| e.id().cmp(id)) {
Ok(idx) => Some(&self.fallbacks[idx]),
Err(_) => None,
}
}
fn get_mut(&mut self, id: &FallbackId) -> Option<&mut Entry> {
match self.fallbacks.binary_search_by(|e| e.id().cmp(id)) {
Ok(idx) => Some(&mut self.fallbacks[idx]),
Err(_) => None,
}
}
pub(crate) fn contains(&self, id: &FallbackId) -> bool {
self.get(id).is_some()
}
pub(crate) fn note_success(&mut self, id: &FallbackId) {
if let Some(entry) = self.get_mut(id) {
entry.status.note_success();
}
}
pub(crate) fn note_failure(&mut self, id: &FallbackId, now: Instant) {
if let Some(entry) = self.get_mut(id) {
entry.status.note_failure(now);
}
}
pub(crate) fn take_status_from(&mut self, other: FallbackState) {
use itertools::EitherOrBoth::Both;
itertools::merge_join_by(
self.fallbacks.iter_mut(),
other.fallbacks.into_iter(),
|a, b| a.fallback.id().cmp(b.fallback.id()),
)
.for_each(|entry| {
if let Both(entry, other) = entry {
debug_assert_eq!(entry.fallback.id(), other.fallback.id());
entry.status = other.status;
}
});
}
pub(crate) fn note_skew(&mut self, id: &FallbackId, observation: SkewObservation) {
if let Some(entry) = self.get_mut(id) {
entry.clock_skew = Some(observation);
}
}
pub(crate) fn skew_observations(&self) -> impl Iterator<Item = &SkewObservation> {
self.fallbacks
.iter()
.filter_map(|fb| fb.clock_skew.as_ref())
}
}
#[cfg(test)]
mod test {
#![allow(clippy::unwrap_used)]
use super::*;
use crate::FirstHopId;
use rand::Rng;
use tor_basic_utils::test_rng::testing_rng;
fn rand_fb<R: Rng>(rng: &mut R) -> FallbackDir {
let ed: [u8; 32] = rng.gen();
let rsa: [u8; 20] = rng.gen();
let ip: u32 = rng.gen();
let mut bld = FallbackDir::builder();
bld.ed_identity(ed.into())
.rsa_identity(rsa.into())
.orports()
.push(std::net::SocketAddrV4::new(ip.into(), 9090).into());
bld.build().unwrap()
}
#[test]
fn construct_fallback_set() {
use rand::seq::SliceRandom;
let mut rng = testing_rng();
let fbs = vec![
rand_fb(&mut rng),
rand_fb(&mut rng),
rand_fb(&mut rng),
rand_fb(&mut rng),
];
let fb_other = rand_fb(&mut rng);
let id_other = FallbackId::from_chan_target(&fb_other);
let list: FallbackList = fbs.clone().into();
assert!(!list.is_empty());
assert_eq!(list.len(), 4);
let mut set: FallbackState = list.clone().into();
assert_eq!(set.fallbacks.len(), 4);
assert!(set.fallbacks[0].id() < set.fallbacks[1].id());
assert!(set.fallbacks[1].id() < set.fallbacks[2].id());
assert!(set.fallbacks[2].id() < set.fallbacks[3].id());
for fb in fbs.iter() {
let id = FallbackId::from_chan_target(fb);
assert_eq!(set.get_mut(&id).unwrap().id(), &id);
}
assert!(set.get_mut(&id_other).is_none());
let mut redundant_fbs = fbs.clone();
redundant_fbs.extend(fbs.clone());
redundant_fbs.extend(fbs[0..2].iter().map(Clone::clone));
redundant_fbs[..].shuffle(&mut testing_rng());
let list2 = redundant_fbs.into();
assert_ne!(&list, &list2);
let set2: FallbackState = list2.into();
assert_eq!(set.fallbacks.len(), set2.fallbacks.len());
assert!(set
.fallbacks
.iter()
.zip(set2.fallbacks.iter())
.all(|(ent1, ent2)| ent1.id() == ent2.id()));
}
#[test]
fn set_choose() {
dbg!("X");
let mut rng = testing_rng();
let fbs = vec![
rand_fb(&mut rng),
rand_fb(&mut rng),
rand_fb(&mut rng),
rand_fb(&mut rng),
];
let list: FallbackList = fbs.into();
let mut set: FallbackState = list.into();
let filter = crate::GuardFilter::unfiltered();
let mut counts = [0_usize; 4];
let now = Instant::now();
dbg!("A");
fn lookup_idx(set: &FallbackState, id: &FirstHopId) -> Option<usize> {
if let FirstHopId(crate::ids::FirstHopIdInner::Fallback(id)) = id {
set.fallbacks.binary_search_by(|ent| ent.id().cmp(id)).ok()
} else {
None
}
}
for _ in 0..100 {
let fb = set.choose(&mut rng, now, &filter).unwrap();
let idx = lookup_idx(&set, fb.id()).unwrap();
counts[idx] += 1;
}
dbg!("B");
assert!(counts.iter().all(|v| *v > 0));
let ids: Vec<_> = set.fallbacks.iter().map(|fb| fb.id().clone()).collect();
set.note_failure(&ids[2], now);
counts = [0; 4];
for _ in 0..100 {
let fb = set.choose(&mut rng, now, &filter).unwrap();
let idx = lookup_idx(&set, fb.id()).unwrap();
counts[idx] += 1;
}
assert_eq!(counts.iter().filter(|v| **v > 0).count(), 3);
assert_eq!(counts[2], 0);
for id in ids.iter() {
set.note_failure(id, now);
}
assert!(matches!(
set.choose(&mut rng, now, &filter),
Err(PickGuardError::AllFallbacksDown { .. })
));
let empty_set = FallbackState::from(FallbackList::from(vec![]));
assert!(matches!(
empty_set.choose(&mut rng, now, &filter),
Err(PickGuardError::NoCandidatesAvailable)
));
}
#[test]
fn test_status() {
let mut rng = testing_rng();
let fbs = vec![
rand_fb(&mut rng),
rand_fb(&mut rng),
rand_fb(&mut rng),
rand_fb(&mut rng),
];
let list: FallbackList = fbs.clone().into();
let mut set: FallbackState = list.into();
let ids: Vec<_> = set.fallbacks.iter().map(|fb| fb.id().clone()).collect();
let now = Instant::now();
assert!(set.next_retry().is_none());
set.note_failure(&ids[3], now);
assert!(set.fallbacks[3].status.next_retriable().unwrap() > now);
assert!(!set.fallbacks[3].status.usable_at(now));
assert_eq!(set.next_retry(), set.fallbacks[3].status.next_retriable());
set.note_failure(&ids[0], now);
assert!(set.fallbacks[0].status.next_retriable().unwrap() > now);
assert!(!set.fallbacks[0].status.usable_at(now));
assert_eq!(
set.next_retry().unwrap(),
std::cmp::min(
set.fallbacks[0].status.next_retriable().unwrap(),
set.fallbacks[3].status.next_retriable().unwrap()
)
);
set.note_success(&ids[0]);
assert!(set.fallbacks[0].status.next_retriable().is_none());
assert!(set.fallbacks[0].status.usable_at(now));
for id in ids.iter() {
dbg!(id, set.get_mut(id).map(|e| e.id()));
}
let mut fbs2: Vec<_> = fbs
.into_iter()
.filter(|fb| FallbackId::from_chan_target(fb) != ids[2])
.collect();
let fbs_new = vec![rand_fb(&mut rng), rand_fb(&mut rng), rand_fb(&mut rng)];
fbs2.extend(fbs_new.clone());
let mut set2 = FallbackState::from(FallbackList::from(fbs2.clone()));
set2.take_status_from(set);
assert_eq!(set2.fallbacks.len(), 6);
assert!(set2.get_mut(&ids[0]).unwrap().status.usable_at(now));
assert!(set2.get_mut(&ids[1]).unwrap().status.usable_at(now));
assert!(set2.get_mut(&ids[2]).is_none());
assert!(!set2.get_mut(&ids[3]).unwrap().status.usable_at(now));
for new_fb in fbs_new {
assert!(set2
.get_mut(&FallbackId::from_chan_target(&new_fb))
.unwrap()
.status
.usable_at(now));
}
}
}