SEDSnet 4.0.1

A memory safe, no_std-capable networking stack with routing, discovery, reliability, and Rust/C/Python bindings.
Documentation
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
// tests/rust-system-test/single_threaded_test.rs
#[cfg(test)]
mod single_threaded_test {
    use sedsnet::TelemetryError;
    use sedsnet::TelemetryResult;
    use sedsnet::config::{
        DataEndpoint, DataType, data_type_definition_by_name, endpoint_definition_by_name,
        register_data_type_with_description, register_endpoint_with_description,
    };
    use sedsnet::packet::Packet;
    use sedsnet::relay::Relay;
    use sedsnet::router::{Clock, EndpointHandler, Router, RouterConfig};
    use sedsnet::{MessageClass, MessageDataType, MessageElement, ReliableMode};

    use std::sync::Arc;
    use std::sync::Once;
    use std::sync::atomic::{AtomicUsize, Ordering};
    use std::sync::mpsc::{self, Receiver, TryRecvError};

    fn env_usize(name: &str, default: usize) -> usize {
        std::env::var(name)
            .ok()
            .and_then(|v| v.parse::<usize>().ok())
            .unwrap_or(default)
    }

    /// Clock that always returns 0
    fn zero_clock() -> Box<dyn Clock + Send + Sync> {
        Box::new(|| 0u64)
    }

    fn ensure_common_test_schema() {
        static INIT: Once = Once::new();
        INIT.call_once(|| {
            if endpoint_definition_by_name("RADIO").is_none() {
                register_endpoint_with_description(
                    "RADIO",
                    "Radio or external link (telemetry uplink/downlink).",
                    false,
                )
                .unwrap();
            }
            if endpoint_definition_by_name("SD_CARD").is_none() {
                register_endpoint_with_description(
                    "SD_CARD",
                    "On-board storage (e.g. SD card / flash).",
                    false,
                )
                .unwrap();
            }
            if data_type_definition_by_name("GPS_DATA").is_none() {
                register_data_type_with_description(
                    "GPS_DATA",
                    "GPS data (typically 3x f32: latitude, longitude, altitude).",
                    MessageElement::Static(3, MessageDataType::Float32, MessageClass::Data),
                    &[DataEndpoint::named("RADIO"), DataEndpoint::named("SD_CARD")],
                    ReliableMode::Ordered,
                    80,
                )
                .unwrap();
            }
            if data_type_definition_by_name("BATTERY_STATUS").is_none() {
                register_data_type_with_description(
                    "BATTERY_STATUS",
                    "Battery status (e.g. voltage, current, etc.).",
                    MessageElement::Static(2, MessageDataType::Float32, MessageClass::Data),
                    &[DataEndpoint::named("RADIO"), DataEndpoint::named("SD_CARD")],
                    ReliableMode::None,
                    60,
                )
                .unwrap();
            }
        });
    }

    /// Simulated node in the Rust system test (single-threaded).
    struct SimNode {
        router: Router,
        radio_hits: Arc<AtomicUsize>,
        sd_hits: Arc<AtomicUsize>,
    }

    /// Build a handler that counts packets received on the Radio endpoint.
    fn make_radio_handler(counter: Arc<AtomicUsize>) -> EndpointHandler {
        EndpointHandler::new_packet_handler(DataEndpoint::named("RADIO"), move |_pkt: &Packet| {
            counter.fetch_add(1, Ordering::SeqCst);
            Ok(())
        })
    }

    /// Build a handler that counts packets received on the SdCard endpoint.
    fn make_sd_handler(counter: Arc<AtomicUsize>) -> EndpointHandler {
        EndpointHandler::new_packet_handler(DataEndpoint::named("SD_CARD"), move |_pkt: &Packet| {
            counter.fetch_add(1, Ordering::SeqCst);
            Ok(())
        })
    }

    /// Helper to generate a simple float series like the C helper `make_series`.
    fn make_series(buf: &mut [f32], base: f32) {
        for (i, v) in buf.iter_mut().enumerate() {
            *v = base + (i as f32) * 0.25;
        }
    }

    /// Build a packet with endpoints [SD_CARD, Radio], mirroring the C system.
    fn make_packet(ty: DataType, vals: &[f32], ts: u64) -> Packet {
        Packet::from_f32_slice(
            ty,
            vals,
            &[DataEndpoint::named("SD_CARD"), DataEndpoint::named("RADIO")],
            ts,
        )
        .unwrap()
    }

    /// Drain both buses once and run the relay once.
    ///
    /// This is intentionally "one pass": we call it repeatedly inside the main
    /// loop and again in the final drain phase to converge all traffic.
    fn drain_buses_and_relay_once(
        nodes: &mut [SimNode],
        bus1_rx: &Receiver<(usize, Vec<u8>)>,
        bus2_rx: &Receiver<(usize, Vec<u8>)>,
        relay: &Relay,
        bus1_side_id: usize,
        bus2_side_id: usize,
    ) {
        // bus1 has nodes 0 and 1
        loop {
            match bus1_rx.try_recv() {
                Ok((from, frame)) => {
                    for (idx, node) in nodes.iter_mut().enumerate() {
                        if idx > 1 {
                            continue; // only nodes 0 and 1 live on bus1
                        }
                        if idx == from {
                            continue; // no loopback to sender on this bus
                        }
                        if let Err(err) = node.router.rx_packed_queue(&frame) {
                            match err {
                                TelemetryError::Io("priority queue saturated") => {
                                    node.router
                                        .process_all_queues_with_timeout(0)
                                        .expect("bus1: process queues before retry failed");
                                    node.router
                                        .rx_packed_queue(&frame)
                                        .expect("bus1: rx_packed_queue retry failed");
                                }
                                other => {
                                    panic!("bus1: rx_packed_packet_to_queue failed: {other:?}")
                                }
                            }
                        }
                    }

                    // Feed into relay from bus1 side (even if it came from relay,
                    // dedupe in Relay will ignore duplicates).
                    relay
                        .rx_packed_from_side(bus1_side_id, &frame)
                        .expect("bus1 -> relay failed");
                }
                Err(TryRecvError::Empty) => break,
                Err(TryRecvError::Disconnected) => {
                    panic!("bus1 channel disconnected unexpectedly");
                }
            }
        }

        // bus2 has node 2
        loop {
            match bus2_rx.try_recv() {
                Ok((from, frame)) => {
                    for (idx, node) in nodes.iter_mut().enumerate() {
                        if idx != 2 {
                            continue; // only node 2 lives on bus2
                        }
                        if idx == from {
                            continue;
                        }
                        if let Err(err) = node.router.rx_packed_queue(&frame) {
                            match err {
                                TelemetryError::Io("priority queue saturated") => {
                                    node.router
                                        .process_all_queues_with_timeout(0)
                                        .expect("bus2: process queues before retry failed");
                                    node.router
                                        .rx_packed_queue(&frame)
                                        .expect("bus2: rx_packed_queue retry failed");
                                }
                                other => {
                                    panic!("bus2: rx_packed_packet_to_queue failed: {other:?}")
                                }
                            }
                        }
                    }

                    // Feed into relay from bus2 side
                    relay
                        .rx_packed_from_side(bus2_side_id, &frame)
                        .expect("bus2 -> relay failed");
                }
                Err(TryRecvError::Empty) => break,
                Err(TryRecvError::Disconnected) => {
                    panic!("bus2 channel disconnected unexpectedly");
                }
            }
        }

        // Let relay fan out whatever it has queued (both RX and TX).
        relay
            .process_all_queues_with_timeout(0)
            .expect("relay process_all_queues_with_timeout failed");
    }

    /// Single-threaded stress test to profile router + relay performance.
    ///
    /// This is intentionally heavy; run it explicitly (e.g. with cargo-flamegraph).
    #[test]
    fn single_threaded_router_stress() {
        ensure_common_test_schema();
        // ---------- 1) Two buses + Relay ----------
        type BusMsg = (usize, Vec<u8>);

        let (bus1_tx, bus1_rx) = mpsc::channel::<BusMsg>();
        let (bus2_tx, bus2_rx) = mpsc::channel::<BusMsg>();

        // Relay bridges bus1 <-> bus2.
        let relay = Relay::new(zero_clock());

        // Relay side for bus1: TX from relay -> bus1_rx
        let relay_bus1_tx = bus1_tx.clone();
        let bus1_side_id =
            relay.add_side_packed("bus1", move |bytes: &[u8]| -> TelemetryResult<()> {
                // from = usize::MAX so we never skip this in bus1 delivery
                relay_bus1_tx.send((usize::MAX, bytes.to_vec())).unwrap();
                Ok(())
            });

        // Relay side for bus2: TX from relay -> bus2_rx
        let relay_bus2_tx = bus2_tx.clone();
        let bus2_side_id =
            relay.add_side_packed("bus2", move |bytes: &[u8]| -> TelemetryResult<()> {
                relay_bus2_tx.send((usize::MAX, bytes.to_vec())).unwrap();
                Ok(())
            });

        // ---------- 2) Build nodes (same topology as threaded test) ----------
        //
        // Node 0: "Radio Board" (radio_hits via Radio endpoint) on bus1
        // Node 1: "Flight Controller Board" (sd_hits via SdCard endpoint) on bus1
        // Node 2: "Power Board" (no local endpoints) on bus2
        let mut nodes: Vec<SimNode> = Vec::new();

        for (idx, _name) in ["Radio Board", "Flight Controller Board", "Power Board"]
            .iter()
            .enumerate()
        {
            let radio_hits = Arc::new(AtomicUsize::new(0));
            let sd_hits = Arc::new(AtomicUsize::new(0));

            let mut handlers = Vec::<EndpointHandler>::new();
            match idx {
                // Radio Board: only "radio" is local
                0 => {
                    handlers.push(make_radio_handler(radio_hits.clone()));
                }
                // Flight Controller Board: only "SD card" is local
                1 => {
                    handlers.push(make_sd_handler(sd_hits.clone()));
                }
                // Power Board: no local endpoints
                _ => {}
            }

            let clock = zero_clock();

            // Choose which bus this node uses for TX.
            let local_bus_tx = if idx <= 1 {
                // nodes 0 and 1 on bus1
                bus1_tx.clone()
            } else {
                // node 2 on bus2
                bus2_tx.clone()
            };

            // tx: push a copy of the wire bytes onto the node's bus with source id
            let tx = move |bytes: &[u8]| -> TelemetryResult<()> {
                local_bus_tx.send((idx, bytes.to_vec())).unwrap();
                Ok(())
            };

            let router = if handlers.is_empty() {
                Router::new_with_clock(RouterConfig::default(), clock)
            } else {
                Router::new_with_clock(RouterConfig::new(handlers), clock)
            };
            router.add_side_packed("bus", tx);

            nodes.push(SimNode {
                router,
                radio_hits,
                sd_hits,
            });
        }

        // ---------- 3) Stress loop: single-threaded send + route + relay ----------
        //
        // Each iteration:
        //   A: GPS
        //   B: GYRO + BARO
        //   C: BATTERY + MESSAGE
        // → 5 packets / iteration, all with [SD_CARD, Radio] endpoints.
        //
        let repeats = env_usize("SEDSNET_SINGLE_THREADED_REPEATS", 1);
        let iters = env_usize("SEDSNET_SINGLE_THREADED_ITERS", 10);
        const PACKETS_PER_ITER: usize = 5;

        let mut gps_buf = [0.0_f32; 8];
        let mut gyro_buf = [0.0_f32; 8];
        let mut baro_buf = [0.0_f32; 8];
        let mut batt_buf = [0.0_f32; 8];
        let msg = "hello world!";

        for repeat_idx in 0..repeats {
            for i in 0..iters {
                let seq_base = (repeat_idx * iters + i) as u64;
                {
                    let node = &mut nodes[0];
                    make_series(&mut gps_buf[..3], 10.0);
                    let pkt = make_packet(DataType::named("GPS_DATA"), &gps_buf[..3], seq_base);
                    node.router.tx(pkt).unwrap();
                }

                {
                    let node = &mut nodes[1];
                    make_series(&mut gyro_buf[..3], 0.5);
                    let pkt1 = make_packet(
                        DataType::named("GPS_DATA"),
                        &gyro_buf[..3],
                        seq_base + 10_000,
                    );
                    node.router.tx(pkt1).unwrap();

                    make_series(&mut baro_buf[..3], 101.3);
                    let pkt2 = make_packet(
                        DataType::named("GPS_DATA"),
                        &baro_buf[..3],
                        seq_base + 20_000,
                    );
                    node.router.tx(pkt2).unwrap();
                }

                {
                    let node = &mut nodes[2];
                    make_series(&mut batt_buf[..2], 3.7);
                    let pkt1 = make_packet(
                        DataType::named("BATTERY_STATUS"),
                        &batt_buf[..2],
                        seq_base + 30_000,
                    );
                    node.router.tx(pkt1).unwrap();

                    let pkt2 = Packet::from_str_slice(
                        DataType::TelemetryError,
                        msg,
                        &[DataEndpoint::named("SD_CARD"), DataEndpoint::named("RADIO")],
                        seq_base + 40_000,
                    )
                    .unwrap();
                    node.router.tx(pkt2).unwrap();
                }

                drain_buses_and_relay_once(
                    &mut nodes,
                    &bus1_rx,
                    &bus2_rx,
                    &relay,
                    bus1_side_id,
                    bus2_side_id,
                );

                for node in nodes.iter_mut() {
                    node.router
                        .process_all_queues_with_timeout(0)
                        .expect("process_all_queues_with_timeout failed");
                }
            }
        }

        // ---------- 4) Final drain: repeat bus + relay + router passes ----------
        for _ in 0..10 {
            drain_buses_and_relay_once(
                &mut nodes,
                &bus1_rx,
                &bus2_rx,
                &relay,
                bus1_side_id,
                bus2_side_id,
            );

            for node in nodes.iter_mut() {
                node.router
                    .process_all_queues_with_timeout(0)
                    .expect("process_all_queues_with_timeout failed in final drain");
            }
        }

        // ---------- 5) Assertions (scaled by ITERS) ----------
        let expected_total = repeats * iters * PACKETS_PER_ITER;

        let radio_board = &nodes[0];
        let flight_board = &nodes[1];
        let power_board = &nodes[2];

        let a_radio = radio_board.radio_hits.load(Ordering::SeqCst);
        let b_sd = flight_board.sd_hits.load(Ordering::SeqCst);
        let c_radio = power_board.radio_hits.load(Ordering::SeqCst);
        let c_sd = power_board.sd_hits.load(Ordering::SeqCst);

        println!(
            "single-threaded (with relay): repeats={}, iters={}, A.radio_hits={}, B.sd_hits={}, C.radio_hits={}, C.sd_hits={}",
            repeats, iters, a_radio, b_sd, c_radio, c_sd
        );

        assert!(
            a_radio >= expected_total,
            "Radio Board hit count should be at least {}",
            expected_total
        );
        assert!(
            b_sd >= expected_total,
            "Flight Controller SD hit count should be at least {}",
            expected_total
        );
        assert_eq!(c_radio, 0, "Power Board must not have a radio handler");
        assert_eq!(c_sd, 0, "Power Board must not have an SD handler");
    }
}