msrt 0.1.5

Portable MSRT protocol implementation.
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
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
use std::{
    env, io,
    net::{SocketAddr, UdpSocket},
    sync::mpsc::{self, Receiver},
    thread,
    time::{Duration, Instant, SystemTime, UNIX_EPOCH},
};

mod support;

use msrt::{
    Engine,
    endpoint::{ClientEndpoint, EndpointPoll, PeerState},
    engine::{EngineConfig, EnginePoll, ReceiveReport},
};

use support::noise::{
    NoiseConfig, NoiseLcg, make_noise_bytes, mutate_or_copy, parse_percent_per_mille,
};

const TX_BUF_BYTES: usize = 256;
const RX_BUF_BYTES: usize = 2048;
const CHAOS_NOISE_CHUNK_BYTES: usize = 512;
const MAX_MESSAGE_BYTES: usize = 256;
const DEFAULT_MESSAGE_BYTES: usize = 240;
const TEST_FRAGMENT_BYTES: usize = 48;
const DEFAULT_CORRUPT_PER_MILLE: u16 = 30;
const DEFAULT_DROP_BYTE_PER_MILLE: u16 = 30;
const DEFAULT_INSERT_BYTE_PER_MILLE: u16 = 30;

#[derive(Clone, Debug)]
struct Args {
    bind: SocketAddr,
    peer: SocketAddr,
    interval: Duration,
    message: Vec<u8>,
    count: Option<usize>,
    wire_chaos: bool,
    drop_tx: Duration,
    noise: NoiseConfig,
}

impl Args {
    fn parse() -> Result<Self, String> {
        let mut args = env::args().skip(1);
        let mut parsed = Self {
            bind: "127.0.0.1:9001".parse().expect("valid default bind addr"),
            peer: "127.0.0.1:9002".parse().expect("valid default peer addr"),
            interval: Duration::from_millis(10),
            message: make_message(DEFAULT_MESSAGE_BYTES),
            count: None,
            wire_chaos: false,
            drop_tx: Duration::ZERO,
            noise: NoiseConfig {
                corrupt_per_mille: DEFAULT_CORRUPT_PER_MILLE,
                drop_byte_per_mille: DEFAULT_DROP_BYTE_PER_MILLE,
                insert_byte_per_mille: DEFAULT_INSERT_BYTE_PER_MILLE,
                burst_corrupt_per_mille: 0,
                burst_drop_per_mille: 0,
                packet_drop_per_mille: 0,
            },
        };

        while let Some(arg) = args.next() {
            match arg.as_str() {
                "--bind" => {
                    parsed.bind = next_value(&mut args, "--bind")?
                        .parse()
                        .map_err(|error| format!("invalid --bind address: {error}"))?;
                }
                "--peer" => {
                    parsed.peer = next_value(&mut args, "--peer")?
                        .parse()
                        .map_err(|error| format!("invalid --peer address: {error}"))?;
                }
                "--interval-ms" => {
                    let millis = next_value(&mut args, "--interval-ms")?
                        .parse()
                        .map_err(|error| format!("invalid --interval-ms: {error}"))?;
                    parsed.interval = Duration::from_millis(millis);
                }
                "--message" => {
                    parsed.message = next_value(&mut args, "--message")?.into_bytes();
                }
                "--message-size" => {
                    let len = next_value(&mut args, "--message-size")?
                        .parse()
                        .map_err(|error| format!("invalid --message-size: {error}"))?;
                    parsed.message = make_message(len);
                }
                "--count" => {
                    parsed.count = Some(
                        next_value(&mut args, "--count")?
                            .parse()
                            .map_err(|error| format!("invalid --count: {error}"))?,
                    );
                }
                "--wire-chaos" => {
                    parsed.wire_chaos = true;
                }
                "--drop-tx-ms" => {
                    let millis = next_value(&mut args, "--drop-tx-ms")?
                        .parse()
                        .map_err(|error| format!("invalid --drop-tx-ms: {error}"))?;
                    parsed.drop_tx = Duration::from_millis(millis);
                }
                "--noise-percent" => {
                    parsed.noise.corrupt_per_mille = parse_percent_per_mille(
                        next_value(&mut args, "--noise-percent")?,
                        "--noise-percent",
                    )?;
                }
                "--drop-byte-percent" => {
                    parsed.noise.drop_byte_per_mille = parse_percent_per_mille(
                        next_value(&mut args, "--drop-byte-percent")?,
                        "--drop-byte-percent",
                    )?;
                }
                "--insert-byte-percent" => {
                    parsed.noise.insert_byte_per_mille = parse_percent_per_mille(
                        next_value(&mut args, "--insert-byte-percent")?,
                        "--insert-byte-percent",
                    )?;
                }
                "--help" | "-h" => return Err(usage()),
                other => return Err(format!("unknown argument: {other}\n\n{}", usage())),
            }
        }

        if parsed.message.len() > MAX_MESSAGE_BYTES {
            return Err(format!("message length must be <= {MAX_MESSAGE_BYTES}"));
        }

        Ok(parsed)
    }
}

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let args = match Args::parse() {
        Ok(args) => args,
        Err(message) => {
            eprintln!("{message}");
            std::process::exit(2);
        }
    };
    let socket = UdpSocket::bind(args.bind)?;

    if args.wire_chaos {
        socket.set_nonblocking(true)?;
        return run_wire_chaos(socket, args);
    }

    let rx_packets = spawn_udp_rx(&socket)?;
    let start = Instant::now();
    let mut endpoint = ClientEndpoint::new(test_config());
    let mut last_state = PeerState::Disconnected;
    if let Err(error) = endpoint.connect(0) {
        eprintln!("host connect error: {error:?}");
        std::process::exit(1);
    }
    log_state_change("host", &mut last_state, endpoint.peer().state());
    let mut last_send = Instant::now() - args.interval;
    let mut sent_messages = 0;
    let mut noise_state = NoiseLcg::with_seed(0x484f5354);
    let mut last_connect_attempt = Instant::now();

    loop {
        let now = elapsed_ms(start);
        let link_connected = start.elapsed() >= args.drop_tx;
        recv_udp_endpoint(
            &rx_packets,
            &socket,
            &args.peer,
            &mut endpoint,
            now,
            link_connected,
            args.noise,
            &mut noise_state,
        )?;

        if !endpoint.peer().has_session() && last_connect_attempt.elapsed() >= args.interval {
            if endpoint.connect(now).is_err() {
                std::process::exit(1);
            }
            last_connect_attempt = Instant::now();
        }

        let noise = if endpoint.peer().is_connected() {
            args.noise
        } else {
            NoiseConfig::default()
        };
        pump_endpoint(
            &socket,
            &args.peer,
            &mut endpoint,
            now,
            link_connected,
            noise,
            &mut noise_state,
        )?;
        log_state_change("host", &mut last_state, endpoint.peer().state());

        if endpoint.peer().is_connected() && should_send(&args, sent_messages, last_send) {
            match endpoint.peer_mut().send(&args.message) {
                Ok(Some(_)) => {
                    sent_messages += 1;
                    last_send = Instant::now();
                }
                Ok(None) => {}
                Err(_) => {}
            }
        }

        if let Some(count) = args.count
            && sent_messages >= count
        {
            return Ok(());
        }

        thread::sleep(Duration::from_millis(5));
    }
}

fn run_wire_chaos(socket: UdpSocket, args: Args) -> Result<(), Box<dyn std::error::Error>> {
    println!(
        "msrt udp host wire-chaos bind={} peer={}",
        args.bind, args.peer
    );

    let start = Instant::now();
    let mut engine = Engine::default();
    let mut rx_buf = [0; RX_BUF_BYTES];

    let noise = make_noise_bytes(512);
    for chunk in noise.chunks(CHAOS_NOISE_CHUNK_BYTES) {
        socket.send_to(chunk, args.peer)?;
        println!("host chaos send noise chunk len={}", chunk.len());
    }

    engine.send(b"crc-corrupt").expect("queue corrupt fixture");
    let mut corrupt = next_transmit(&mut engine, elapsed_ms(start));
    if let Some(last) = corrupt.last_mut() {
        *last ^= 0xff;
    }
    socket.send_to(&corrupt, args.peer)?;
    println!("host chaos send corrupted packet len={}", corrupt.len());

    engine.send(b"split-packet").expect("queue split fixture");
    let split = next_transmit(&mut engine, elapsed_ms(start));
    let split_at = core::cmp::min(3, split.len());
    socket.send_to(&split[..split_at], args.peer)?;
    println!("host chaos send split first len={split_at}");
    thread::sleep(Duration::from_millis(20));
    socket.send_to(&split[split_at..], args.peer)?;
    println!("host chaos send split rest len={}", split.len() - split_at);

    engine
        .send(b"sticky-one")
        .expect("queue first sticky fixture");
    engine
        .send(b"sticky-two")
        .expect("queue second sticky fixture");
    let first = next_transmit(&mut engine, elapsed_ms(start));
    let second = next_transmit(&mut engine, elapsed_ms(start));
    let mut sticky = Vec::with_capacity(first.len() + second.len());
    sticky.extend_from_slice(&first);
    sticky.extend_from_slice(&second);
    socket.send_to(&sticky, args.peer)?;
    println!("host chaos send sticky len={}", sticky.len());

    let deadline = Instant::now() + Duration::from_millis(200);
    while Instant::now() < deadline {
        recv_udp(&socket, &mut engine, &mut rx_buf)?;
        thread::sleep(Duration::from_millis(5));
    }

    println!("host chaos complete");
    Ok(())
}

fn should_send(args: &Args, sent_messages: usize, last_send: Instant) -> bool {
    if args.count.is_some_and(|count| sent_messages >= count) {
        return false;
    }

    last_send.elapsed() >= args.interval
}

#[allow(clippy::too_many_arguments)]
fn recv_udp_endpoint(
    rx_packets: &Receiver<Vec<u8>>,
    socket: &UdpSocket,
    peer: &SocketAddr,
    endpoint: &mut ClientEndpoint,
    now_ms: u64,
    link_connected: bool,
    noise: NoiseConfig,
    noise_state: &mut NoiseLcg,
) -> io::Result<()> {
    while let Ok(packet) = rx_packets.try_recv() {
        let tx_noise = if endpoint.peer().is_connected() {
            noise
        } else {
            NoiseConfig::default()
        };
        // Keep the UART/ISR model: UDP only carries test bytes, the engine is fed one byte at a time.
        for byte in &packet {
            let report = endpoint.receive(now_ms, std::slice::from_ref(byte));
            let _ = matches!(
                report,
                ReceiveReport::Packet { .. }
                    | ReceiveReport::Duplicate { .. }
                    | ReceiveReport::Ack { .. }
                    | ReceiveReport::Ping
                    | ReceiveReport::Pong
                    | ReceiveReport::Incomplete { .. }
            );
        }

        pump_endpoint(
            socket,
            peer,
            endpoint,
            now_ms,
            link_connected,
            tx_noise,
            noise_state,
        )?;
    }

    Ok(())
}

fn recv_udp(socket: &UdpSocket, engine: &mut Engine, rx_buf: &mut [u8]) -> io::Result<()> {
    loop {
        match socket.recv_from(rx_buf) {
            Ok((len, _from)) => {
                for byte in &rx_buf[..len] {
                    let report = engine.receive(std::slice::from_ref(byte));
                    let _ = matches!(
                        report,
                        ReceiveReport::Packet { .. }
                            | ReceiveReport::Duplicate { .. }
                            | ReceiveReport::Ack { .. }
                            | ReceiveReport::Ping
                            | ReceiveReport::Pong
                            | ReceiveReport::Incomplete { .. }
                    );
                }
            }
            Err(error) if error.kind() == io::ErrorKind::WouldBlock => return Ok(()),
            Err(error) => return Err(error),
        }
    }
}

#[allow(clippy::too_many_arguments)]
fn pump_endpoint(
    socket: &UdpSocket,
    peer: &SocketAddr,
    endpoint: &mut ClientEndpoint,
    now_ms: u64,
    link_connected: bool,
    noise: NoiseConfig,
    noise_state: &mut NoiseLcg,
) -> io::Result<()> {
    loop {
        let mut tx_buf = [0; TX_BUF_BYTES];
        match endpoint.poll(now_ms, &mut tx_buf).expect("endpoint poll") {
            EndpointPoll::Transmit { bytes, attempts: _ } => {
                if link_connected {
                    let (packet, _) = mutate_or_copy(noise_state, bytes, noise);
                    socket.send_to(&packet, peer)?;
                }
            }
            EndpointPoll::Message(_) => {}
            EndpointPoll::SendFailed(_) => {}
            EndpointPoll::Idle => return Ok(()),
        }
    }
}

fn log_state_change(prefix: &str, last: &mut PeerState, current: PeerState) {
    if *last == current {
        return;
    }

    match current {
        PeerState::Disconnected => println!("{prefix} disconnect"),
        PeerState::Connecting => println!("{prefix} connect state=Connecting"),
        PeerState::Connected => println!("{prefix} connect state=Connected"),
    }
    *last = current;
}

fn next_transmit(engine: &mut Engine, now_ms: u64) -> Vec<u8> {
    let mut tx_buf = [0; TX_BUF_BYTES];

    match engine.poll(now_ms, &mut tx_buf).expect("engine poll") {
        EnginePoll::Transmit { bytes, .. } => bytes.to_vec(),
        other => panic!("expected transmit packet in chaos fixture, got {other:?}"),
    }
}

fn make_message(len: usize) -> Vec<u8> {
    let mut message = Vec::with_capacity(len);

    for index in 0..len {
        message.push(b'a' + (index % 26) as u8);
    }

    message
}

fn elapsed_ms(start: Instant) -> u64 {
    start.elapsed().as_millis().try_into().unwrap_or(u64::MAX)
}

fn spawn_udp_rx(socket: &UdpSocket) -> io::Result<Receiver<Vec<u8>>> {
    let socket = socket.try_clone()?;
    let (tx, rx) = mpsc::channel();

    thread::spawn(move || {
        let mut rx_buf = [0; RX_BUF_BYTES];

        while let Ok((len, _from)) = socket.recv_from(&mut rx_buf) {
            if tx.send(rx_buf[..len].to_vec()).is_err() {
                break;
            }
        }
    });

    Ok(rx)
}

fn process_session_id() -> u32 {
    let millis = SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .unwrap_or(Duration::ZERO)
        .as_millis();

    millis as u32
}

fn test_config() -> EngineConfig {
    let session_id = process_session_id();
    EngineConfig {
        initial_message_id: msrt::core::MessageId::new(session_id),
        fragment_bytes: TEST_FRAGMENT_BYTES,
        ..EngineConfig::default()
    }
}

fn next_value(args: &mut impl Iterator<Item = String>, name: &str) -> Result<String, String> {
    args.next()
        .ok_or_else(|| format!("{name} requires a value\n\n{}", usage()))
}

fn usage() -> String {
    "usage: msrt-udp-host [--bind ADDR] [--peer ADDR] [--interval-ms N] [--message TEXT] [--message-size N] [--count N] [--noise-percent N] [--drop-byte-percent N] [--insert-byte-percent N] [--wire-chaos] [--drop-tx-ms N]"
        .to_string()
}