ringline 0.1.2

Async I/O runtime with io_uring (Linux) and mio (cross-platform) backends
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
#![allow(clippy::manual_async_fn)]
//! Integration tests for `ConnStream`: `AsyncRead`, `AsyncWrite`, `AsyncBufRead`.

use std::future::Future;
use std::io::{Read, Write};
use std::net::TcpStream;
use std::sync::Arc;
use std::sync::atomic::{AtomicUsize, Ordering};
use std::time::Duration;

use futures_util::io::{AsyncReadExt, AsyncWriteExt};
use ringline::{AsyncEventHandler, Config, ConnCtx, ConnStream, RinglineBuilder};

// ── Stream-based echo handler ────────────────────────────────────────

struct StreamEcho;

impl AsyncEventHandler for StreamEcho {
    fn on_accept(&self, conn: ConnCtx) -> impl Future<Output = ()> + 'static {
        async move {
            let mut stream = ConnStream::new(conn);
            loop {
                let data = match futures_util::AsyncBufReadExt::fill_buf(&mut stream).await {
                    Ok([]) => break, // EOF
                    Ok(buf) => buf.to_vec(),
                    Err(_) => break,
                };
                let n = data.len();
                if stream.write_all(&data).await.is_err() {
                    break;
                }
                futures_util::AsyncBufReadExt::consume_unpin(&mut stream, n);
            }
        }
    }
    fn create_for_worker(_id: usize) -> Self {
        StreamEcho
    }
}

// ── AsyncRead-based echo handler ─────────────────────────────────────

struct ReadEcho;

impl AsyncEventHandler for ReadEcho {
    fn on_accept(&self, conn: ConnCtx) -> impl Future<Output = ()> + 'static {
        async move {
            let mut stream = ConnStream::new(conn);
            let mut buf = [0u8; 4096];
            loop {
                let n = match stream.read(&mut buf).await {
                    Ok(0) => break,
                    Ok(n) => n,
                    Err(_) => break,
                };
                if stream.write_all(&buf[..n]).await.is_err() {
                    break;
                }
            }
        }
    }
    fn create_for_worker(_id: usize) -> Self {
        ReadEcho
    }
}

// ── Handler that counts EOF via poll_close ───────────────────────────

struct CloseCounter {
    closed: Arc<AtomicUsize>,
}

impl AsyncEventHandler for CloseCounter {
    fn on_accept(&self, conn: ConnCtx) -> impl Future<Output = ()> + 'static {
        let closed = self.closed.clone();
        async move {
            let mut stream = ConnStream::new(conn);
            // Echo once, then close.
            let mut buf = [0u8; 256];
            if let Ok(n) = stream.read(&mut buf).await
                && n > 0
            {
                let _ = stream.write_all(&buf[..n]).await;
            }
            // Explicitly close the stream.
            let _ = futures_util::AsyncWriteExt::close(&mut stream).await;
            closed.fetch_add(1, Ordering::Relaxed);
        }
    }
    fn create_for_worker(_id: usize) -> Self {
        CloseCounter {
            closed: Arc::new(AtomicUsize::new(0)),
        }
    }
}

// ── Small-read handler (reads 1 byte at a time) ─────────────────────

struct TinyReadEcho;

impl AsyncEventHandler for TinyReadEcho {
    fn on_accept(&self, conn: ConnCtx) -> impl Future<Output = ()> + 'static {
        async move {
            let mut stream = ConnStream::new(conn);
            let mut byte = [0u8; 1];
            loop {
                match stream.read(&mut byte).await {
                    Ok(0) => break,
                    Ok(_) => {
                        if stream.write_all(&byte).await.is_err() {
                            break;
                        }
                    }
                    Err(_) => break,
                }
            }
        }
    }
    fn create_for_worker(_id: usize) -> Self {
        TinyReadEcho
    }
}

// ── Helpers ──────────────────────────────────────────────────────────

fn test_config() -> Config {
    let mut config = Config::default();
    config.worker.threads = 1;
    config.worker.pin_to_core = false;
    config.sq_entries = 64;
    config.recv_buffer.ring_size = 64;
    config.recv_buffer.buffer_size = 4096;
    config.max_connections = 64;
    config.send_copy_count = 64;
    config
}

fn free_port() -> u16 {
    let listener = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
    listener.local_addr().unwrap().port()
}

fn wait_for_server(addr: &str) {
    for _ in 0..200 {
        if TcpStream::connect(addr).is_ok() {
            return;
        }
        std::thread::sleep(Duration::from_millis(10));
    }
    panic!("server did not start on {addr}");
}

fn echo_round_trip(addr: &str, msg: &[u8]) -> Vec<u8> {
    let mut stream = TcpStream::connect(addr).unwrap();
    stream
        .set_read_timeout(Some(Duration::from_secs(5)))
        .unwrap();
    stream.write_all(msg).unwrap();
    stream.flush().unwrap();

    let mut buf = vec![0u8; msg.len()];
    let mut total = 0;
    while total < msg.len() {
        match stream.read(&mut buf[total..]) {
            Ok(0) => break,
            Ok(n) => total += n,
            Err(e) if e.kind() == std::io::ErrorKind::WouldBlock => {
                std::thread::sleep(Duration::from_millis(10));
            }
            Err(e) => panic!("read error: {e}"),
        }
    }
    buf.truncate(total);
    buf
}

// ── Tests ────────────────────────────────────────────────────────────

#[test]
fn stream_echo_bufread() {
    let port = free_port();
    let addr = format!("127.0.0.1:{port}");
    let bind: std::net::SocketAddr = addr.parse().unwrap();

    let (shutdown, handles) = RinglineBuilder::new(test_config())
        .bind(bind)
        .launch::<StreamEcho>()
        .unwrap();

    wait_for_server(&addr);

    let msg = b"hello from ConnStream";
    let got = echo_round_trip(&addr, msg);
    assert_eq!(got, msg);

    // Multi-round trip.
    let mut stream = TcpStream::connect(&addr).unwrap();
    stream
        .set_read_timeout(Some(Duration::from_secs(5)))
        .unwrap();
    for i in 0..10 {
        let payload = format!("message {i}");
        stream.write_all(payload.as_bytes()).unwrap();
        stream.flush().unwrap();
        let mut buf = vec![0u8; payload.len()];
        stream.read_exact(&mut buf).unwrap();
        assert_eq!(buf, payload.as_bytes());
    }

    shutdown.shutdown();
    for h in handles {
        h.join().unwrap().unwrap();
    }
}

#[test]
fn stream_echo_async_read() {
    let port = free_port();
    let addr = format!("127.0.0.1:{port}");
    let bind: std::net::SocketAddr = addr.parse().unwrap();

    let (shutdown, handles) = RinglineBuilder::new(test_config())
        .bind(bind)
        .launch::<ReadEcho>()
        .unwrap();

    wait_for_server(&addr);

    let msg = b"async read echo test";
    let got = echo_round_trip(&addr, msg);
    assert_eq!(got, msg);

    // Larger payload.
    let big = vec![0xABu8; 8192];
    let got = echo_round_trip(&addr, &big);
    assert_eq!(got, big);

    shutdown.shutdown();
    for h in handles {
        h.join().unwrap().unwrap();
    }
}

/// EOF: client disconnects cleanly, server sees Ok(0) from read.
#[test]
fn stream_eof_on_client_close() {
    let port = free_port();
    let addr = format!("127.0.0.1:{port}");
    let bind: std::net::SocketAddr = addr.parse().unwrap();

    let (shutdown, handles) = RinglineBuilder::new(test_config())
        .bind(bind)
        .launch::<ReadEcho>()
        .unwrap();

    wait_for_server(&addr);

    // Connect, send nothing, close immediately.
    let stream = TcpStream::connect(&addr).unwrap();
    drop(stream);

    // Connect, send data, read echo, then close.
    let mut stream = TcpStream::connect(&addr).unwrap();
    stream
        .set_read_timeout(Some(Duration::from_secs(5)))
        .unwrap();
    stream.write_all(b"bye").unwrap();
    let mut buf = [0u8; 3];
    stream.read_exact(&mut buf).unwrap();
    assert_eq!(&buf, b"bye");
    drop(stream);

    // Small delay so server processes the close.
    std::thread::sleep(Duration::from_millis(50));

    shutdown.shutdown();
    for h in handles {
        h.join().unwrap().unwrap();
    }
}

/// poll_close (shutdown_write) doesn't panic and the handler completes cleanly.
#[test]
fn stream_poll_close() {
    let port = free_port();
    let addr = format!("127.0.0.1:{port}");
    let bind: std::net::SocketAddr = addr.parse().unwrap();

    let (shutdown, handles) = RinglineBuilder::new(test_config())
        .bind(bind)
        .launch::<CloseCounter>()
        .unwrap();

    wait_for_server(&addr);

    // Send data, get echo. The handler calls close() then returns.
    let msg = b"ping";
    let got = echo_round_trip(&addr, msg);
    assert_eq!(got, msg);

    // Do it a few times to exercise close on multiple connections.
    for _ in 0..5 {
        let got = echo_round_trip(&addr, b"test");
        assert_eq!(got, b"test");
    }

    shutdown.shutdown();
    for h in handles {
        h.join().unwrap().unwrap();
    }
}

/// Multiple concurrent connections on the same server.
#[test]
fn stream_concurrent_connections() {
    let port = free_port();
    let addr = format!("127.0.0.1:{port}");
    let bind: std::net::SocketAddr = addr.parse().unwrap();

    let (shutdown, handles) = RinglineBuilder::new(test_config())
        .bind(bind)
        .launch::<StreamEcho>()
        .unwrap();

    wait_for_server(&addr);

    let threads: Vec<_> = (0..8)
        .map(|i| {
            let addr = addr.clone();
            std::thread::spawn(move || {
                let mut stream = TcpStream::connect(&addr).unwrap();
                stream
                    .set_read_timeout(Some(Duration::from_secs(5)))
                    .unwrap();
                for j in 0..5 {
                    let msg = format!("conn{i}-msg{j}");
                    stream.write_all(msg.as_bytes()).unwrap();
                    stream.flush().unwrap();
                    let mut buf = vec![0u8; msg.len()];
                    stream.read_exact(&mut buf).unwrap();
                    assert_eq!(buf, msg.as_bytes());
                }
            })
        })
        .collect();

    for t in threads {
        t.join().unwrap();
    }

    shutdown.shutdown();
    for h in handles {
        h.join().unwrap().unwrap();
    }
}

/// Small 1-byte reads exercise the accumulator drain path thoroughly.
#[test]
fn stream_tiny_reads() {
    let port = free_port();
    let addr = format!("127.0.0.1:{port}");
    let bind: std::net::SocketAddr = addr.parse().unwrap();

    let (shutdown, handles) = RinglineBuilder::new(test_config())
        .bind(bind)
        .launch::<TinyReadEcho>()
        .unwrap();

    wait_for_server(&addr);

    let msg = b"abcdefghijklmnop";
    let got = echo_round_trip(&addr, msg);
    assert_eq!(got, msg);

    shutdown.shutdown();
    for h in handles {
        h.join().unwrap().unwrap();
    }
}

/// Large payload that exceeds a single send pool slot (default 16384 bytes).
/// Exercises partial writes in poll_write.
#[test]
fn stream_large_payload() {
    let port = free_port();
    let addr = format!("127.0.0.1:{port}");
    let bind: std::net::SocketAddr = addr.parse().unwrap();

    let (shutdown, handles) = RinglineBuilder::new(test_config())
        .bind(bind)
        .launch::<ReadEcho>()
        .unwrap();

    wait_for_server(&addr);

    // 64 KiB — larger than the default 16 KiB slot size, so write_all will
    // need multiple poll_write calls internally.
    let big = vec![0x42u8; 65536];
    let got = echo_round_trip(&addr, &big);
    assert_eq!(got, big);

    shutdown.shutdown();
    for h in handles {
        h.join().unwrap().unwrap();
    }
}