snare 3.5.1

Ergonomic in-process network testing on top of snare-interpose: write the code under test against std, describe the peer with a tester builder
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
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
use std::future::Future;
use std::hint::black_box;
use std::io::{Read, Write};
use std::net::{SocketAddr, TcpListener, TcpStream, UdpSocket};
use std::sync::{Arc, Barrier, Condvar, Mutex, mpsc};
use std::task::{Context, Wake, Waker};
use std::time::{Duration, Instant};

use snare::Sim;

#[cfg(unix)]
fn receive_message(fd: libc::c_int, buffer: &mut [u8], vectored: bool) -> usize {
    let split = if vectored {
        buffer.len() / 2
    } else {
        buffer.len()
    };
    let (first, second) = buffer.split_at_mut(split);
    let mut iov = [
        libc::iovec {
            iov_base: first.as_mut_ptr().cast(),
            iov_len: first.len(),
        },
        libc::iovec {
            iov_base: second.as_mut_ptr().cast(),
            iov_len: second.len(),
        },
    ];
    let mut message: libc::msghdr = unsafe { std::mem::zeroed() };
    message.msg_iov = iov.as_mut_ptr();
    message.msg_iovlen = if vectored { 2 } else { 1 };
    let received = unsafe { libc::recvmsg(fd, &mut message, 0) };
    assert!(received >= 0, "{}", std::io::Error::last_os_error());
    received as usize
}

fn address(port: u16) -> SocketAddr {
    SocketAddr::from(([127, 0, 0, 1], port))
}

fn stopwatch(action: impl FnOnce()) -> Duration {
    snare::real(|| eprintln!("SNARE_PROFILE_READY"));
    let start = snare::real(Instant::now);
    action();
    snare::real(|| start.elapsed())
}

struct Noop;

#[allow(
    clippy::manual_noop_waker,
    reason = "the workload measures registration and cancellation of task-owned wakers"
)]
impl Wake for Noop {
    fn wake(self: Arc<Self>) {}
}

fn workload(case: &str, size: usize, iterations: usize) -> Duration {
    if iterations > 1
        && matches!(
            case,
            "explicit_bind"
                | "ephemeral_bind"
                | "timer_register"
                | "timer_cancel_reverse"
                | "timer_cancel_tied"
        )
    {
        return (0..iterations).map(|_| workload(case, size, 1)).sum();
    }
    match case {
        "clock" => stopwatch(|| {
            for index in 0..iterations {
                black_box(Instant::now());
                if index % 32 == 31 {
                    std::thread::yield_now();
                }
            }
        }),
        "yield" => stopwatch(|| {
            for _ in 0..iterations {
                std::thread::yield_now();
            }
        }),
        "sleep" => stopwatch(|| {
            for _ in 0..iterations {
                std::thread::sleep(Duration::from_millis(1));
            }
        }),
        "spawn" => stopwatch(|| {
            for _ in 0..iterations {
                std::thread::spawn(|| ()).join().unwrap();
            }
        }),
        "mutex" => {
            let mutex = Mutex::new(0usize);
            stopwatch(|| {
                for _ in 0..iterations {
                    *mutex.lock().unwrap() += 1;
                }
                black_box(*mutex.lock().unwrap());
            })
        }
        "empty" => {
            let socket = UdpSocket::bind(address(9000)).unwrap();
            socket.set_nonblocking(true).unwrap();
            let mut buffer = [0u8; 64];
            stopwatch(|| {
                for _ in 0..iterations {
                    assert_eq!(
                        socket.recv(&mut buffer).unwrap_err().kind(),
                        std::io::ErrorKind::WouldBlock
                    );
                }
            })
        }
        case if case.starts_with("udp_threaded_") => {
            assert!(size >= 2 && size.is_multiple_of(2));
            let sockets: Vec<_> = (0..size)
                .map(|index| UdpSocket::bind(address(9000 + index as u16)).unwrap())
                .collect();
            let payload_size: usize = case.rsplit('_').next().unwrap().parse().unwrap();
            assert!((1..=8192).contains(&payload_size));
            let barrier = Arc::new(std::sync::Barrier::new(size + 1));
            let mut workers = Vec::with_capacity(size);
            for (index, socket) in sockets.into_iter().enumerate() {
                socket.connect(address(9000 + (index ^ 1) as u16)).unwrap();
                let barrier = barrier.clone();
                workers.push(std::thread::spawn(move || {
                    let data = vec![7u8; payload_size];
                    let mut buffer = vec![0u8; payload_size];
                    barrier.wait();
                    for _ in 0..iterations {
                        assert_eq!(socket.send(&data).unwrap(), payload_size);
                        assert_eq!(socket.recv(&mut buffer).unwrap(), payload_size);
                        black_box(&buffer);
                    }
                }));
            }
            stopwatch(|| {
                barrier.wait();
                for worker in workers {
                    worker.join().unwrap();
                }
            })
        }
        case if case.starts_with("udp_mesh_") || case.starts_with("udp_burst_") => {
            assert!(size >= 2 && size.is_multiple_of(2));
            let sockets: Vec<_> = (0..size)
                .map(|index| UdpSocket::bind(address(9000 + index as u16)).unwrap())
                .collect();
            let payload_size: usize = case.rsplit('_').next().unwrap().parse().unwrap();
            assert!((1..=8192).contains(&payload_size));
            let data = vec![7u8; payload_size];
            let mut buffer = vec![0u8; payload_size];
            let connected = case.contains("_connected_");
            let burst = case.starts_with("udp_burst_");
            if connected {
                for (index, socket) in sockets.iter().enumerate() {
                    socket.connect(address(9000 + (index ^ 1) as u16)).unwrap();
                }
            }
            let send = |index: usize| {
                let sent = if connected {
                    sockets[index].send(&data)
                } else {
                    sockets[index].send_to(&data, address(9000 + (index ^ 1) as u16))
                }
                .unwrap();
                assert_eq!(sent, payload_size);
            };
            stopwatch(|| {
                for iteration in 0..iterations {
                    if burst {
                        for index in 0..size {
                            send(index);
                        }
                        for socket in &sockets {
                            assert_eq!(socket.recv(&mut buffer).unwrap(), payload_size);
                            black_box(&buffer);
                        }
                    } else {
                        let index = iteration % size;
                        send(index);
                        assert_eq!(sockets[index ^ 1].recv(&mut buffer).unwrap(), payload_size);
                        black_box(&buffer);
                    }
                }
            })
        }
        "udp_beside_listeners" => {
            let listeners: Vec<_> = (0..size)
                .map(|index| TcpListener::bind(address(30_000 + index as u16)).unwrap())
                .collect();
            let sender = UdpSocket::bind(address(9000)).unwrap();
            let receiver = UdpSocket::bind(address(9001)).unwrap();
            let mut buffer = [0u8; 128];
            stopwatch(|| {
                for _ in 0..iterations {
                    assert_eq!(sender.send_to(&buffer, address(9001)).unwrap(), 128);
                    assert_eq!(receiver.recv(&mut buffer).unwrap(), 128);
                }
                black_box(&listeners);
            })
        }
        case if case == "udp" || case.starts_with("udp_") => {
            let sender = UdpSocket::bind(address(9000)).unwrap();
            let receiver = UdpSocket::bind(address(9001)).unwrap();
            let held: Vec<_> = (0..size.saturating_sub(2))
                .map(|index| UdpSocket::bind(address(20_000 + index as u16)).unwrap())
                .collect();
            let payload_size = case.rsplit('_').next().unwrap().parse().unwrap_or(4);
            assert!(payload_size <= 8192);
            let data = vec![7u8; payload_size];
            let mut buffer = vec![0u8; payload_size];
            let connected = case.starts_with("udp_connected_");
            if connected {
                sender.connect(address(9001)).unwrap();
                receiver.connect(address(9000)).unwrap();
            }
            stopwatch(|| {
                for _ in 0..iterations {
                    let sent = if connected {
                        sender.send(&data)
                    } else {
                        sender.send_to(&data, address(9001))
                    }
                    .unwrap();
                    assert_eq!(sent, payload_size);
                    let received = {
                        #[cfg(unix)]
                        if case.starts_with("udp_recvmsg_") {
                            use std::os::fd::AsRawFd;
                            receive_message(
                                receiver.as_raw_fd(),
                                &mut buffer,
                                case.contains("vectored"),
                            )
                        } else {
                            receiver.recv(&mut buffer).unwrap()
                        }
                        #[cfg(not(unix))]
                        receiver.recv(&mut buffer).unwrap()
                    };
                    assert_eq!(received, payload_size);
                    black_box(&buffer);
                }
                black_box(&held);
            })
        }
        case if case == "tcp" || case.starts_with("tcp_") => {
            let listener = TcpListener::bind(address(9002)).unwrap();
            let mut sender = TcpStream::connect(address(9002)).unwrap();
            let (mut receiver, _) = listener.accept().unwrap();
            let payload_size = case.rsplit('_').next().unwrap().parse().unwrap_or(1024);
            assert!(payload_size <= 8192);
            let data = vec![7u8; payload_size];
            let mut buffer = vec![0u8; payload_size];
            stopwatch(|| {
                for _ in 0..iterations {
                    sender.write_all(&data).unwrap();
                    #[cfg(unix)]
                    if case.starts_with("tcp_recvmsg_") {
                        use std::os::fd::AsRawFd;
                        let mut received = 0;
                        while received < payload_size {
                            let n = receive_message(
                                receiver.as_raw_fd(),
                                &mut buffer[received..],
                                case.contains("vectored"),
                            );
                            assert!(n > 0);
                            received += n;
                        }
                    } else {
                        receiver.read_exact(&mut buffer).unwrap();
                    }
                    #[cfg(not(unix))]
                    receiver.read_exact(&mut buffer).unwrap();
                    black_box(&buffer);
                }
            })
        }
        case if case == "poll" || case.starts_with("poll_ready_") => {
            let mut poll = mio::Poll::new().unwrap();
            let mut sockets: Vec<_> = (0..size)
                .map(|index| mio::net::UdpSocket::bind(address(20_000 + index as u16)).unwrap())
                .collect();
            for (index, socket) in sockets.iter_mut().enumerate() {
                poll.registry()
                    .register(socket, mio::Token(index), mio::Interest::READABLE)
                    .unwrap();
            }
            let payload_size: Option<usize> = case
                .strip_prefix("poll_ready_")
                .map(|value| value.parse().unwrap());
            if let Some(payload_size) = payload_size {
                assert!(payload_size <= 60_000);
                let sender = UdpSocket::bind(address(9000)).unwrap();
                let data = vec![1u8; payload_size];
                for index in 0..size {
                    sender
                        .send_to(&data, address(20_000 + index as u16))
                        .unwrap();
                }
            }
            let mut events = mio::Events::with_capacity(64);
            stopwatch(|| {
                for _ in 0..iterations {
                    poll.poll(&mut events, Some(Duration::ZERO)).unwrap();
                    if payload_size.is_none() {
                        assert!(events.is_empty());
                    }
                    black_box(&events);
                }
            })
        }
        "listen_beside_listeners" | "connect_beside_listeners" => {
            let held: Vec<_> = (0..size)
                .map(|index| TcpListener::bind(address(20_000 + index as u16)).unwrap())
                .collect();
            let target = TcpListener::bind(address(9002)).unwrap();
            stopwatch(|| {
                for _ in 0..iterations {
                    if case == "listen_beside_listeners" {
                        drop(black_box(TcpListener::bind(address(9003)).unwrap()));
                    } else {
                        let client = TcpStream::connect(address(9002)).unwrap();
                        let (server, _) = target.accept().unwrap();
                        drop(black_box((client, server)));
                    }
                }
                black_box(&held);
            })
        }
        "handoff_condvar" => condvar_ring(size, iterations),
        "handoff_channel" => channel_ring(size, iterations),
        "channel_burst" => channel_burst(size, iterations),
        "explicit_bind" | "ephemeral_bind" => {
            let mut sockets = Vec::with_capacity(size);
            stopwatch(|| {
                for index in 0..size {
                    let port = if case == "ephemeral_bind" {
                        0
                    } else {
                        20_000 + index as u16
                    };
                    sockets.push(UdpSocket::bind(address(port)).unwrap());
                }
                black_box(&sockets);
            })
        }
        "timer_register" | "timer_cancel_reverse" | "timer_cancel_tied" => {
            snare::time().pause();
            let deadline = Instant::now() + Duration::from_secs(1);
            let waker = Waker::from(Arc::new(Noop));
            let mut context = Context::from_waker(&waker);
            let mut timers = Vec::with_capacity(size);
            let mut register = |timers: &mut Vec<_>| {
                for index in 0..size {
                    let at = if case == "timer_cancel_tied" {
                        deadline
                    } else {
                        deadline + Duration::from_nanos(index as u64)
                    };
                    let mut timer = Box::pin(snare::sched::sleep_until(at));
                    assert!(timer.as_mut().poll(&mut context).is_pending());
                    timers.push(timer);
                }
            };
            if case == "timer_register" {
                stopwatch(|| register(&mut timers))
            } else {
                register(&mut timers);
                stopwatch(|| {
                    while let Some(timer) = timers.pop() {
                        drop(timer);
                    }
                })
            }
        }
        _ => panic!("unknown case: {case}"),
    }
}

struct Baton {
    turn: usize,
    passes: usize,
}

/// `workers` long-lived threads pass a baton round a ring `passes` times, each waiting on its
/// own condition variable until the previous one hands over.
fn condvar_ring(workers: usize, passes: usize) -> Duration {
    assert!(workers >= 2);
    let ring = Arc::new((
        Mutex::new(Baton {
            turn: usize::MAX,
            passes: 0,
        }),
        (0..workers).map(|_| Condvar::new()).collect::<Vec<_>>(),
    ));
    let ready = Arc::new(Barrier::new(workers + 1));
    let threads: Vec<_> = (0..workers)
        .map(|me| {
            let ring = ring.clone();
            let ready = ready.clone();
            std::thread::spawn(move || {
                let (baton, turns) = &*ring;
                ready.wait();
                let mut held = baton.lock().unwrap();
                loop {
                    while held.turn != me && held.passes < passes {
                        held = turns[me].wait(held).unwrap();
                    }
                    if held.passes >= passes {
                        return;
                    }
                    held.passes += 1;
                    if held.passes == passes {
                        turns.iter().for_each(Condvar::notify_one);
                        return;
                    }
                    held.turn = (me + 1) % workers;
                    turns[held.turn].notify_one();
                }
            })
        })
        .collect();
    ready.wait();
    stopwatch(|| {
        let (baton, turns) = &*ring;
        baton.lock().unwrap().turn = 0;
        turns[0].notify_one();
        for thread in threads {
            thread.join().unwrap();
        }
    })
}

/// A producer sends `messages` values over a channel in bursts of `burst`, waiting after each
/// burst for the consumer to acknowledge it.
fn channel_burst(burst: usize, messages: usize) -> Duration {
    let (values, inbox) = mpsc::channel::<usize>();
    let (ack, acks) = mpsc::channel::<()>();
    let ready = Arc::new(Barrier::new(2));
    let consumer = {
        let ready = ready.clone();
        std::thread::spawn(move || {
            ready.wait();
            for got in 1..=messages {
                black_box(inbox.recv().unwrap());
                if got % burst == 0 || got == messages {
                    ack.send(()).unwrap();
                }
            }
        })
    };
    ready.wait();
    stopwatch(|| {
        let mut sent = 0;
        while sent < messages {
            let n = burst.min(messages - sent);
            (sent..sent + n).for_each(|value| values.send(value).unwrap());
            sent += n;
            acks.recv().unwrap();
        }
        consumer.join().unwrap();
    })
}

/// `workers` long-lived threads pass a counter round a ring of channels `passes` times.
fn channel_ring(workers: usize, passes: usize) -> Duration {
    assert!(workers >= 2);
    let (senders, receivers): (Vec<_>, Vec<_>) =
        (0..workers).map(|_| mpsc::channel::<usize>()).unzip();
    let first = senders[0].clone();
    let ready = Arc::new(Barrier::new(workers + 1));
    let threads: Vec<_> = receivers
        .into_iter()
        .enumerate()
        .map(|(me, inbox)| {
            let next = senders[(me + 1) % workers].clone();
            let ready = ready.clone();
            std::thread::spawn(move || {
                ready.wait();
                loop {
                    let count = inbox.recv().unwrap();
                    if count >= passes {
                        let _ = next.send(count);
                        return;
                    }
                    let _ = next.send(count + 1);
                }
            })
        })
        .collect();
    drop(senders);
    ready.wait();
    stopwatch(|| {
        first.send(0).unwrap();
        drop(first);
        for thread in threads {
            thread.join().unwrap();
        }
    })
}

fn main() {
    let arguments: Vec<_> = std::env::args().skip(1).collect();
    assert_eq!(arguments.len(), 4, "MODE CASE SIZE ITERATIONS");
    let mode = &arguments[0];
    let case = &arguments[1];
    let size: usize = arguments[2].parse().unwrap();
    let iterations: usize = arguments[3].parse().unwrap();
    assert!(size <= 20_000 && size > 0 && iterations > 0);
    assert!(mode != "native" && mode != "passthrough" || !case.starts_with("timer_"));
    let start = Instant::now();
    let (elapsed, startup) = match mode.as_str() {
        "native" => (workload(case, size, iterations), Duration::ZERO),
        "passthrough" => {
            Sim::new().run(|| ());
            let startup = start.elapsed();
            (snare::real(|| workload(case, size, iterations)), startup)
        }
        "plain" | "det" => {
            let builder = Sim::builder();
            let sim = if mode == "det" {
                builder.deterministic()
            } else {
                builder
            }
            .build();
            let startup = start.elapsed();
            (sim.run(|| workload(case, size, iterations)), startup)
        }
        #[cfg(unix)]
        "host" => {
            let sim = Sim::builder()
                .host(snare::HostProfile::new().build())
                .build();
            let startup = start.elapsed();
            (sim.run(|| workload(case, size, iterations)), startup)
        }
        _ => panic!("unknown mode: {mode}"),
    };
    let operations = if matches!(
        case.as_str(),
        "explicit_bind"
            | "ephemeral_bind"
            | "timer_register"
            | "timer_cancel_reverse"
            | "timer_cancel_tied"
    ) || case.starts_with("udp_burst_")
        || case.starts_with("udp_threaded_")
    {
        size.checked_mul(iterations).unwrap()
    } else {
        iterations
    };
    println!(
        "{{\"mode\":\"{mode}\",\"case\":\"{case}\",\"size\":{size},\"iterations\":{iterations},\"operations\":{operations},\"elapsed_ns\":{},\"ns_per_operation\":{},\"startup_ns\":{}}}",
        elapsed.as_nanos(),
        elapsed.as_nanos() as f64 / operations as f64,
        startup.as_nanos()
    );
}