vane-kernel 0.2.3

io_uring/mio dual-backend, thread-per-core transport engine for Vane
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
567
568
569
570
571
572
573
574
575
576
577
//! Minimal vane-core worker test: TCP echo through the mio engine.

#![allow(clippy::unwrap_used, clippy::expect_used)]
use std::io::{Read, Write};
use std::net::TcpStream;
use std::os::fd::AsRawFd;
use std::sync::Arc;

use vane_core::handler::{Handler, HandlerFactory, Mode, SessionIo};
use vane_core::{WorkerConfig, spawn_worker};
use vane_observe::metrics::Registry;

struct Echo;

impl Handler for Echo {
    fn on_downstream_data(&mut self, io: &mut SessionIo<'_>, data: &[u8]) {
        io.respond(data);
    }

    fn on_upstream_connected(&mut self, _io: &mut SessionIo<'_>) {}
    fn on_upstream_data(&mut self, _io: &mut SessionIo<'_>, _data: &[u8]) {}
    fn on_downstream_eof(&mut self, _io: &mut SessionIo<'_>) {}
    fn on_upstream_eof(&mut self, _io: &mut SessionIo<'_>) {}
    fn on_upstream_error(&mut self, io: &mut SessionIo<'_>, _e: std::io::Error) {
        io.close();
    }
}

struct EchoFactory;

impl HandlerFactory for EchoFactory {
    fn mode(&self) -> Mode {
        Mode::Http
    }

    fn build(&self, _ctx: &vane_core::WorkerCtx) -> Box<dyn Handler> {
        Box::new(Echo)
    }
}

fn run_echo(force_mio: bool) {
    let listener =
        vane_core::tcp_listener("127.0.0.1:0".parse().expect("addr"), true, 64).expect("bind");
    let addr = listener.local_addr().expect("addr");

    let registry = Arc::new(Registry::new());
    let events = Arc::new(vane_observe::ring::EventRing::new());
    let cfg = WorkerConfig {
        force_mio,
        ..WorkerConfig::default()
    };
    let factory = EchoFactory;
    let mut handle = spawn_worker(0, cfg, listener, registry, events, &factory).expect("spawn");

    let mut client = TcpStream::connect(addr).expect("connect");
    client.write_all(b"ping").expect("write");
    client
        .set_read_timeout(Some(std::time::Duration::from_secs(3)))
        .ok();
    let mut buf = [0u8; 4];
    match client.read_exact(&mut buf) {
        Ok(()) => assert_eq!(&buf, b"ping"),
        Err(e) => panic!("no echo: {e}"),
    }
    let _ = handle
        .cmd
        .send(vane_core::WorkerCmd::Shutdown { deadline_ms: 100 });
    handle.join();
}

#[test]
fn echo_through_worker_mio() {
    run_echo(true);
}

#[test]
fn echo_through_worker_uring() {
    run_echo(false);
}

/// Client RSTs mid-session: the worker must reap the session without
/// panicking or wedging (engine error path).
#[test]
fn client_reset_is_reaped() {
    let listener =
        vane_core::tcp_listener("127.0.0.1:0".parse().expect("addr"), true, 64).expect("bind");
    let addr = listener.local_addr().expect("addr");

    let registry = Arc::new(Registry::new());
    let events = Arc::new(vane_observe::ring::EventRing::new());
    let cfg = WorkerConfig {
        force_mio: true,
        ..WorkerConfig::default()
    };
    let factory = EchoFactory;
    let mut handle = spawn_worker(0, cfg, listener, registry, events, &factory).expect("spawn");

    // Connect, exchange, then abort with SO_LINGER 0 (RST on close).
    let mut client = TcpStream::connect(addr).expect("connect");
    client.write_all(b"ping").expect("write");
    client
        .set_read_timeout(Some(std::time::Duration::from_secs(3)))
        .ok();
    let mut buf = [0u8; 4];
    client.read_exact(&mut buf).expect("echo");
    // SAFETY: standard setsockopt on a live socket.
    unsafe {
        let linger = libc::linger {
            l_onoff: 1,
            l_linger: 0,
        };
        libc::setsockopt(
            client.as_raw_fd(),
            libc::SOL_SOCKET,
            libc::SO_LINGER,
            std::ptr::addr_of!(linger).cast(),
            std::mem::size_of::<libc::linger>() as u32,
        );
    }
    drop(client); // RST

    // Worker still serves a fresh connection afterwards.
    let mut fresh = TcpStream::connect(addr).expect("reconnect");
    fresh.write_all(b"ok!").expect("write");
    fresh
        .set_read_timeout(Some(std::time::Duration::from_secs(3)))
        .ok();
    let mut buf2 = [0u8; 3];
    fresh.read_exact(&mut buf2).expect("echo2");
    assert_eq!(&buf2, b"ok!");

    let _ = handle
        .cmd
        .send(vane_core::WorkerCmd::Shutdown { deadline_ms: 100 });
    handle.join();
}

/// Client half-close (FIN) after a request: worker observes EOF and
/// closes the session; a subsequent connection still works.
#[test]
fn client_half_close_is_handled() {
    let listener =
        vane_core::tcp_listener("127.0.0.1:0".parse().expect("addr"), true, 64).expect("bind");
    let addr = listener.local_addr().expect("addr");

    let registry = Arc::new(Registry::new());
    let events = Arc::new(vane_observe::ring::EventRing::new());
    let cfg = WorkerConfig {
        force_mio: true,
        ..WorkerConfig::default()
    };
    let factory = EchoFactory;
    let mut handle = spawn_worker(0, cfg, listener, registry, events, &factory).expect("spawn");

    let mut client = TcpStream::connect(addr).expect("connect");
    client.write_all(b"fin").expect("write");
    // Half-close: FIN after data.
    client
        .shutdown(std::net::Shutdown::Write)
        .expect("half close");
    client
        .set_read_timeout(Some(std::time::Duration::from_secs(3)))
        .ok();
    let _buf = [0u8; 3];
    // The echo handler may or may not reply after EOF — either way the
    // session must be reaped: shutdown of our read side too, then verify
    // the worker stays alive with a new connection.
    drop(client);

    let mut fresh = TcpStream::connect(addr).expect("reconnect after fin");
    fresh.write_all(b"yes").expect("write");
    fresh
        .set_read_timeout(Some(std::time::Duration::from_secs(3)))
        .ok();
    let mut buf2 = [0u8; 3];
    fresh.read_exact(&mut buf2).expect("echo after fin session");
    assert_eq!(&buf2, b"yes");

    let _ = handle
        .cmd
        .send(vane_core::WorkerCmd::Shutdown { deadline_ms: 100 });
    handle.join();
}

/// Handler that buffers upstream-bound bytes without ever connecting:
/// exercises the pending_up overflow guard.
struct Flood;

impl Handler for Flood {
    fn on_downstream_data(&mut self, io: &mut SessionIo<'_>, data: &[u8]) {
        let _ = data;
        io.write_upstream(&[0xABu8; 8192]);
    }

    fn on_upstream_connected(&mut self, _io: &mut SessionIo<'_>) {}
    fn on_upstream_data(&mut self, _io: &mut SessionIo<'_>, _data: &[u8]) {}
    fn on_downstream_eof(&mut self, _io: &mut SessionIo<'_>) {}
    fn on_upstream_eof(&mut self, _io: &mut SessionIo<'_>) {}
    fn on_upstream_error(&mut self, io: &mut SessionIo<'_>, _e: std::io::Error) {
        io.close();
    }
}

struct FloodFactory;

impl HandlerFactory for FloodFactory {
    fn mode(&self) -> Mode {
        Mode::Http
    }

    fn build(&self, _ctx: &vane_core::WorkerCtx) -> Box<dyn Handler> {
        Box::new(Flood)
    }
}

/// Unbounded upstream buffering: read throttling pauses the client
/// (backpressure) instead of killing the session — the worker stays
/// alive and the flooded session is bounded, not reaped.
#[test]
fn upstream_backpressure_pauses_reads() {
    let listener =
        vane_core::tcp_listener("127.0.0.1:0".parse().expect("addr"), true, 64).expect("bind");
    let addr = listener.local_addr().expect("addr");

    let registry = Arc::new(Registry::new());
    let events = Arc::new(vane_observe::ring::EventRing::new());
    let cfg = WorkerConfig {
        force_mio: true,
        ..WorkerConfig::default()
    };
    let factory = FloodFactory;
    let mut handle = spawn_worker(0, cfg, listener, registry, events, &factory).expect("spawn");

    // Four 8 KiB handler bursts: reads pause once the upstream queue
    // exceeds two slots (backpressure), so the session must survive.
    let mut client = TcpStream::connect(addr).expect("connect");
    for _ in 0..4 {
        client.write_all(b"go").expect("write");
        std::thread::sleep(std::time::Duration::from_millis(50));
    }
    client
        .set_read_timeout(Some(std::time::Duration::from_secs(3)))
        .ok();
    let mut buf = [0u8; 8];
    // Give the flood time to land; the session must NOT be reaped
    // (reads would return 0/EOF).
    let mut reaped = false;
    for _ in 0..10 {
        if matches!(client.read(&mut buf), Ok(0)) {
            reaped = true;
            break;
        }
    }
    assert!(!reaped, "backpressured session must survive");

    // The worker still accepts new sessions.
    let probe = TcpStream::connect(addr);
    assert!(probe.is_ok(), "worker must stay alive");

    let _ = handle
        .cmd
        .send(vane_core::WorkerCmd::Shutdown { deadline_ms: 100 });
    handle.join();
}

/// Handler that dials a UDS upstream on connect (exercises
/// SessionIo::connect_upstream_unix through the worker).
struct UnixDialer {
    path: std::path::PathBuf,
}

impl Handler for UnixDialer {
    fn on_connected(&mut self, io: &mut SessionIo<'_>) {
        // Write BEFORE dialing: exercises the pre-connect pending_up
        // buffer and the post-connect flush kick.
        io.write_upstream(b"early-bytes");
        if !io.connect_upstream_unix(self.path.clone()) {
            io.close();
        }
    }

    fn on_downstream_data(&mut self, _io: &mut SessionIo<'_>, _data: &[u8]) {}

    fn on_upstream_connected(&mut self, io: &mut SessionIo<'_>) {
        io.write_upstream(b"uds-ping");
    }
    fn on_upstream_data(&mut self, io: &mut SessionIo<'_>, data: &[u8]) {
        io.respond(data);
    }
    fn on_downstream_eof(&mut self, _io: &mut SessionIo<'_>) {}
    fn on_upstream_eof(&mut self, _io: &mut SessionIo<'_>) {}
    fn on_upstream_error(&mut self, io: &mut SessionIo<'_>, _e: std::io::Error) {
        io.close();
    }
}

struct UnixDialerFactory {
    path: std::path::PathBuf,
}

impl HandlerFactory for UnixDialerFactory {
    fn mode(&self) -> Mode {
        Mode::Http
    }

    fn build(&self, _ctx: &vane_core::WorkerCtx) -> Box<dyn Handler> {
        Box::new(UnixDialer {
            path: self.path.clone(),
        })
    }
}

/// UDS upstream echo through the worker (connect_upstream_unix path).
#[test]
fn unix_upstream_roundtrip() {
    let dir = tempfile::tempdir().expect("dir");
    let sock_path = dir.path().join("up.sock");

    // UDS echo upstream.
    let uds_listener = std::os::unix::net::UnixListener::bind(&sock_path).expect("uds bind");
    std::thread::spawn(move || {
        for stream in uds_listener.incoming().flatten() {
            let mut s = stream;
            std::thread::spawn(move || {
                use std::io::{Read, Write};
                let mut buf = [0u8; 4096];
                loop {
                    match s.read(&mut buf) {
                        Ok(0) | Err(_) => break,
                        Ok(n) => {
                            if s.write_all(&buf[..n]).is_err() {
                                break;
                            }
                        }
                    }
                }
            });
        }
    });

    let listener =
        vane_core::tcp_listener("127.0.0.1:0".parse().expect("addr"), true, 64).expect("bind");
    let addr = listener.local_addr().expect("addr");

    let registry = Arc::new(Registry::new());
    let events = Arc::new(vane_observe::ring::EventRing::new());
    let cfg = WorkerConfig {
        force_mio: true,
        ..WorkerConfig::default()
    };
    let factory = UnixDialerFactory { path: sock_path };
    let mut handle = spawn_worker(0, cfg, listener, registry, events, &factory).expect("spawn");

    let mut client = TcpStream::connect(addr).expect("connect");
    client
        .set_read_timeout(Some(std::time::Duration::from_secs(3)))
        .ok();
    // Two round-trips: the pre-connect "early-bytes" flush (kick path)
    // and the post-connect "uds-ping". The UDS echo may coalesce both
    // writes into one read, so match on accumulated content.
    let mut seen_early = false;
    let mut seen_ping = false;
    let mut acc = Vec::new();
    let mut buf = [0u8; 64];
    for _ in 0..60 {
        match client.read(&mut buf) {
            Ok(0) | Err(_) => {}
            Ok(n) => acc.extend_from_slice(&buf[..n]),
        }
        if !seen_early {
            seen_early = twoway_contains(&acc, b"early-bytes");
        }
        if !seen_ping {
            seen_ping = twoway_contains(&acc, b"uds-ping");
        }
        if seen_early && seen_ping {
            break;
        }
        std::thread::sleep(std::time::Duration::from_millis(50));
    }
    assert!(
        seen_early,
        "pre-connect flush kick must deliver early bytes"
    );
    assert!(seen_ping, "uds-ping must round-trip");

    let _ = handle
        .cmd
        .send(vane_core::WorkerCmd::Shutdown { deadline_ms: 100 });
    handle.join();
}

/// Handler exercising SessionIo::start_splice: dials a socketpair upstream
/// on connect, splices, and the kernel pumps raw bytes both directions.
struct Splicer;

impl Handler for Splicer {
    fn on_connected(&mut self, io: &mut SessionIo<'_>) {
        let Some(addr) = *SPLICE_UPSTREAM_ADDR
            .lock()
            .unwrap_or_else(|e| e.into_inner())
        else {
            // Legacy port-only mode (v4 loopback).
            let addr = std::net::SocketAddr::new(
                std::net::IpAddr::V4(std::net::Ipv4Addr::LOCALHOST),
                SPLICE_UPSTREAM_PORT.load(std::sync::atomic::Ordering::Relaxed),
            );
            if !io.connect_upstream(addr) {
                io.close();
            }
            return;
        };
        if !io.connect_upstream(addr) {
            io.close();
        }
    }

    fn on_downstream_data(&mut self, io: &mut SessionIo<'_>, data: &[u8]) {
        // Mirror the proxy L4 branch: forward pre-splice bytes upstream
        // (the worker buffers them until the dial completes).
        io.write_upstream(data);
    }

    fn on_upstream_connected(&mut self, io: &mut SessionIo<'_>) {
        assert!(io.upstream_fd().is_some(), "upstream fd must be visible");
        if !io.start_splice() {
            io.close();
        }
    }
    fn on_upstream_data(&mut self, _io: &mut SessionIo<'_>, _data: &[u8]) {
        eprintln!("DBG splicer upstream data (post-splice leak)");
    }
    fn on_downstream_eof(&mut self, _io: &mut SessionIo<'_>) {}
    fn on_upstream_eof(&mut self, _io: &mut SessionIo<'_>) {}
    fn on_upstream_error(&mut self, io: &mut SessionIo<'_>, _e: std::io::Error) {
        io.close();
    }
}

struct SplicerFactory;

impl HandlerFactory for SplicerFactory {
    fn mode(&self) -> Mode {
        Mode::Http
    }

    fn build(&self, _ctx: &vane_core::WorkerCtx) -> Box<dyn Handler> {
        Box::new(Splicer)
    }
}

static SPLICE_UPSTREAM_PORT: std::sync::atomic::AtomicU16 = std::sync::atomic::AtomicU16::new(0);
static SPLICE_UPSTREAM_ADDR: std::sync::Mutex<Option<std::net::SocketAddr>> =
    std::sync::Mutex::new(None);

/// Worker-level splice: downstream bytes cross to the upstream through
/// the kernel pipe (handler only sets the pump up).
#[test]
fn worker_splice_pumps_raw_bytes() {
    // Upstream echo on a known port.
    let listener = std::net::TcpListener::bind("127.0.0.1:0").expect("bind");
    let upstream_addr = listener.local_addr().expect("addr");
    SPLICE_UPSTREAM_PORT.store(upstream_addr.port(), std::sync::atomic::Ordering::Relaxed);
    *SPLICE_UPSTREAM_ADDR
        .lock()
        .unwrap_or_else(|e| e.into_inner()) = Some(upstream_addr);
    *SPLICE_UPSTREAM_ADDR
        .lock()
        .unwrap_or_else(|e| e.into_inner()) = Some(upstream_addr);
    std::thread::spawn(move || {
        for stream in listener.incoming().flatten() {
            let mut s = stream;
            std::thread::spawn(move || {
                use std::io::{Read, Write};
                let mut buf = [0u8; 4096];
                loop {
                    match s.read(&mut buf) {
                        Ok(0) | Err(_) => break,
                        Ok(n) => {
                            if s.write_all(&buf[..n]).is_err() {
                                break;
                            }
                        }
                    }
                }
            });
        }
    });

    let tcp_listener =
        vane_core::tcp_listener("127.0.0.1:0".parse().expect("addr"), true, 64).expect("bind");
    let addr = tcp_listener.local_addr().expect("addr");

    let registry = Arc::new(Registry::new());
    let events = Arc::new(vane_observe::ring::EventRing::new());
    let cfg = WorkerConfig {
        force_mio: true,
        ..WorkerConfig::default()
    };
    let factory = SplicerFactory;
    let mut handle = spawn_worker(0, cfg, tcp_listener, registry, events, &factory).expect("spawn");

    let mut client = TcpStream::connect(addr).expect("connect");
    client
        .set_read_timeout(Some(std::time::Duration::from_secs(5)))
        .ok();
    client.write_all(b"splice-me").expect("write");
    let mut buf = [0u8; 9];
    client.read_exact(&mut buf).expect("splice echo");
    assert_eq!(&buf, b"splice-me");

    let _ = handle
        .cmd
        .send(vane_core::WorkerCmd::Shutdown { deadline_ms: 100 });
    handle.join();
}

/// Naive substring search over accumulated echo bytes.
fn twoway_contains(haystack: &[u8], needle: &[u8]) -> bool {
    haystack.windows(needle.len()).any(|w| w == needle)
}

/// IPv6 upstream dial through the engine (v6 sockaddr path).
#[test]
fn connect_ipv6_upstream() {
    // v6 loopback listener.
    let listener = match std::net::TcpListener::bind("[::1]:0") {
        Ok(l) => l,
        Err(_) => return, // no v6 in this environment
    };
    let upstream_addr = listener.local_addr().expect("addr");
    let port = upstream_addr.port();
    *SPLICE_UPSTREAM_ADDR
        .lock()
        .unwrap_or_else(|e| e.into_inner()) = Some(upstream_addr);
    std::thread::spawn(move || {
        for stream in listener.incoming().flatten() {
            let mut s = stream;
            std::thread::spawn(move || {
                use std::io::{Read, Write};
                let mut buf = [0u8; 64];
                if let Ok(n) = s.read(&mut buf) {
                    let _ = s.write_all(&buf[..n]);
                }
            });
        }
    });

    let tcp_listener =
        vane_core::tcp_listener("127.0.0.1:0".parse().expect("addr"), true, 64).expect("bind");
    let addr = tcp_listener.local_addr().expect("addr");

    let registry = Arc::new(Registry::new());
    let events = Arc::new(vane_observe::ring::EventRing::new());
    let cfg = WorkerConfig {
        force_mio: true,
        ..WorkerConfig::default()
    };
    let factory = SplicerFactory;
    // Reuse Splicer: it dials the atomic port; store the v6 port.
    SPLICE_UPSTREAM_PORT.store(port, std::sync::atomic::Ordering::Relaxed);
    let mut handle = spawn_worker(1, cfg, tcp_listener, registry, events, &factory).expect("spawn");

    let mut client = TcpStream::connect(addr).expect("connect");
    client
        .set_read_timeout(Some(std::time::Duration::from_secs(5)))
        .ok();
    client.write_all(b"v6").expect("write");
    let mut buf = [0u8; 2];
    client.read_exact(&mut buf).expect("v6 echo");
    assert_eq!(&buf, b"v6");

    let _ = handle
        .cmd
        .send(vane_core::WorkerCmd::Shutdown { deadline_ms: 100 });
    handle.join();
}