Newer
Older
#[derive(Debug, PartialEq, Eq, Clone)]
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
pub struct Route {
pub max_hops: u8,
path: ArrayVec<u8, 254>,
has_future: bool,
}
impl Route {
pub fn new(max_hops: u8) -> Self {
let path = ArrayVec::new();
Self {
max_hops,
path,
has_future: false,
}
}
/// Returns `None` if there isn't enough space for the callsign
/// Returns `None` if attempting to pushed is_used=true after an existing is_used=false
/// is_future=false when this callsign has digipeated
/// is_future=true when this callsign is expected to be part of the route, but isn't yet
/// see the specs for more information
pub fn push_callsign(&mut self, callsign: &str, ssid: u8, is_future: bool) -> Option<()> {
let len = callsign.as_bytes().len() + 2;
let free_space = self.path.capacity() - self.path.len();
if len > free_space {
return None;
}
self.has_future = self.has_future || is_future;
if self.has_future && !is_future {
return None;
}
// safe to unwrap since we already did a length check
self.path
.try_extend_from_slice(callsign.as_bytes())
.unwrap();
self.path.push(if is_future { 0xFD } else { 0xFF });
self.path.push(ssid);
Some(())
}
/// Returns `None` if there isn't enough space
pub fn push_internet(&mut self) -> Option<()> {
let free_space = self.path.capacity() - self.path.len();
if free_space < 1 {
return None;
}
self.path.push(0xFE);
Some(())
}
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
/// Append a callsign/ssid pair to the route, intelligently.
/// I.e. replace future node if possible
/// Returns an Err if the route is out of space, or appending the node doesn't make logical sense
/// (there's a future node that doesn't match)
pub fn append_node(&mut self, callsign: &str, ssid: u8) -> Result<(), AppendNodeError> {
if usize::from(self.max_hops) == self.iter().count() {
return Err(AppendNodeError::HopsOverflow);
}
let mut new_route = Route::new(self.max_hops);
let mut already_inserted = false;
for rn in self.iter() {
match rn {
RouteNode::Internet => new_route
.push_internet()
.ok_or(AppendNodeError::RouteOverflow)?,
RouteNode::Identity(rc, rs, is_future) => {
let us = rc == callsign && rs == ssid;
if is_future {
if us {
if already_inserted {
return Err(AppendNodeError::DuplicateNode);
} else {
new_route.push_callsign(callsign, ssid, false);
already_inserted = true;
}
} else {
if already_inserted {
new_route.push_callsign(rc, rs, true);
} else {
return Err(AppendNodeError::SetFuture);
}
}
} else {
if us {
return Err(AppendNodeError::DuplicateNode);
} else {
new_route.push_callsign(rc, rs, false);
}
}
}
}
}
if !already_inserted {
new_route.push_callsign(callsign, ssid, false);
}
*self = new_route;
Ok(())
/*
let replace_future = r.iter().any(|rn| match rn {
RouteNode::Identity(rc, rs, is_future) => rc == callsign && rs == ssid && is_future,
_ => false,
});
if replace_future {
let mut new_route = Route::new(r.max_hops);
let mut already_replaced = false;
for rn in r.iter() {
match rn {
RouteNode::Identity(rc, rs, is_future)
if rc == callsign && rs == ssid && is_future && !already_replaced =>
{
already_replaced = true;
new_route.push_callsign(callsign, ssid, false)?;
}
RouteNode::Identity(rc, rs, is_future) => {
new_route.push_callsign(rc, rs, is_future)?;
}
RouteNode::Internet => {
new_route.push_internet()?;
}
}
}
*r = new_route;
} else {
r.push_callsign(callsign, ssid, false)?;
}
Some(())*/
}
pub fn iter(&'_ self) -> RouteIter<'_> {
RouteIter::new(self)
}
pub fn encode<'a>(&self, buf: &'a mut [u8]) -> Option<&'a [u8]> {
let packet_len = self.path.len() + 1;
let buf = buf.get_mut(0..(packet_len + 1))?;
buf[0] = packet_len.try_into().unwrap();
buf[1] = self.max_hops;
buf[2..(packet_len + 1)].copy_from_slice(&self.path);
Some(buf)
}
pub fn decode(data: &[u8]) -> Option<Self> {
let len: usize = (*data.first()?).into();
let data = data.get(1..(len + 1))?;
let mut path = ArrayVec::new();
path.try_extend_from_slice(&data[1..]).unwrap();
let has_future = data[1..].iter().any(|x| *x == 0xFD);

Stephen D
committed
let s = Self {

Stephen D
committed
};
if UntrustedRouteIter::new(&s).any(|v| v.is_err()) {

Stephen D
committed
return None;
}
Some(s)
}
}
#[derive(Debug, Eq, PartialEq)]
pub enum RouteNode<'a> {
Internet,
Identity(&'a str, u8, bool),
}
#[derive(Debug)]

Stephen D
committed
struct UntrustedRouteIter<'a> {

Stephen D
committed
seen_future: bool,
dead: bool,

Stephen D
committed
impl<'a> UntrustedRouteIter<'a> {

Stephen D
committed
Self {
route,
i: 0,
seen_future: false,
dead: false,
}
// Returns Err(()) if invalid
fn maybe_next(&mut self) -> Result<RouteNode<'a>, ()> {
let i_start = self.i;
self.i += 1;
if *self.route.path.get(i_start).ok_or(())? == 0xFE {
return Ok(RouteNode::Internet);
while *self.route.path.get(self.i).ok_or(())? != 0xFD && self.route.path[self.i] != 0xFF {
let callsign = core::str::from_utf8(self.route.path.get(i_start..self.i).ok_or(())?)
.map_err(|_| ())?;

Stephen D
committed
let is_future = *self.route.path.get(self.i).ok_or(())? == 0xFD;

Stephen D
committed
if self.seen_future && !is_future {
// past after future - not allowed

Stephen D
committed
}
self.seen_future |= is_future;
let ssid = *self.route.path.get(self.i).ok_or(())?;
Ok(RouteNode::Identity(callsign, ssid, is_future))

Stephen D
committed
}
}
impl<'a> Iterator for UntrustedRouteIter<'a> {

Stephen D
committed
fn next(&mut self) -> Option<Self::Item> {
if self.dead {
return None;
}
if self.i == self.route.path.len() {
return None;
}
let r = self.maybe_next();
if r.is_err() {
self.dead = true;

Stephen D
committed
}

Stephen D
committed
}
}
pub struct RouteIter<'a> {
iter: UntrustedRouteIter<'a>,
}
impl<'a> RouteIter<'a> {
fn new(route: &'a Route) -> Self {
Self {
iter: UntrustedRouteIter::new(route),
}
}
}
impl<'a> Iterator for RouteIter<'a> {
type Item = RouteNode<'a>;
fn next(&mut self) -> Option<Self::Item> {
Some(self.iter.next()?.unwrap())
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
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn append_fails_when_existing_future() {
let mut r = Route::new(5);
r.push_callsign("C1", 0, false);
r.push_callsign("C2", 0, false);
r.push_callsign("C3", 0, true);
assert_eq!(
AppendNodeError::SetFuture,
r.append_node("C3", 1).unwrap_err()
);
assert_eq!(
AppendNodeError::SetFuture,
r.append_node("C4", 0).unwrap_err()
);
}
#[test]
fn append_fails_when_would_exceed_max_hops() {
let mut r = Route::new(3);
r.append_node("C1", 0).unwrap();
r.append_node("C2", 0).unwrap();
r.append_node("C2", 1).unwrap();
assert_eq!(
AppendNodeError::HopsOverflow,
r.append_node("C4", 0).unwrap_err()
);
}
#[test]
fn append_fails_when_already_in_route() {
let mut r = Route::new(3);
r.append_node("C1", 0).unwrap();
assert_eq!(
AppendNodeError::DuplicateNode,
r.append_node("C1", 0).unwrap_err()
);
}
#[test]
fn append_overwrites_future() {
let mut r = Route::new(5);
r.push_callsign("C1", 0, false);
r.push_callsign("C2", 0, false);
r.push_callsign("C3", 0, true);
r.push_callsign("C4", 0, true);
r.append_node("C3", 0).unwrap();
let mut iter = r.iter();
assert_eq!(Some(RouteNode::Identity("C1", 0, false)), iter.next());
assert_eq!(Some(RouteNode::Identity("C2", 0, false)), iter.next());
assert_eq!(Some(RouteNode::Identity("C3", 0, false)), iter.next());
assert_eq!(Some(RouteNode::Identity("C4", 0, true)), iter.next());
assert_eq!(None, iter.next());
}
#[test]
fn append_appends_when_no_future() {
let mut r = Route::new(5);
r.push_callsign("C1", 0, false);
r.push_callsign("C2", 0, false);
r.push_callsign("C3", 0, false);
r.append_node("C4", 0).unwrap();
let mut iter = r.iter();
assert_eq!(Some(RouteNode::Identity("C1", 0, false)), iter.next());
assert_eq!(Some(RouteNode::Identity("C2", 0, false)), iter.next());
assert_eq!(Some(RouteNode::Identity("C3", 0, false)), iter.next());
assert_eq!(Some(RouteNode::Identity("C4", 0, false)), iter.next());
assert_eq!(None, iter.next());
}
}