lio 0.4.1

A platform-independent async I/O library with native support for io_uring (Linux), IOCP (Windows), and kqueue (macOS)
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
#![cfg(target_os = "linux")]

use lio::Lio;
use lio::api::{self, resource::Resource};
use std::os::fd::FromRawFd;
use std::sync::mpsc;
use std::thread;
use std::time::Duration;

/// Helper to poll until we receive a result
fn poll_until_recv<T>(lio: &mut Lio, receiver: &mpsc::Receiver<T>) -> T {
  let mut attempts = 0;
  loop {
    lio.try_run().unwrap();
    match receiver.try_recv() {
      Ok(result) => return result,
      Err(mpsc::TryRecvError::Empty) => {
        attempts += 1;
        if attempts > 100 {
          panic!("Operation did not complete after 100 attempts");
        }
        thread::sleep(Duration::from_millis(10));
      }
      Err(mpsc::TryRecvError::Disconnected) => {
        panic!("Channel disconnected");
      }
    }
  }
}

#[test]
fn test_tee_basic() {
  let mut lio = Lio::new(64).unwrap();

  // Create two pipes
  let mut pipe1_fds = [0i32; 2];
  let mut pipe2_fds = [0i32; 2];

  unsafe {
    assert_eq!(libc::pipe(pipe1_fds.as_mut_ptr()), 0);
    assert_eq!(libc::pipe(pipe2_fds.as_mut_ptr()), 0);
  }

  let pipe1_write = pipe1_fds[1];
  let pipe2_read = pipe2_fds[0];

  // Create Resources and keep them alive until after we read from the pipes.
  // Resources take ownership of fds, so they'll be closed when dropped.
  let pipe1_read_res = unsafe { Resource::from_raw_fd(pipe1_fds[0]) };
  let pipe2_write_res = unsafe { Resource::from_raw_fd(pipe2_fds[1]) };

  // Write data to pipe1
  let test_data = b"Hello, tee!";
  unsafe {
    let written = libc::write(
      pipe1_write,
      test_data.as_ptr() as *const libc::c_void,
      test_data.len(),
    );
    assert_eq!(written, test_data.len() as isize);
  }

  let (sender, receiver) = mpsc::channel();

  // Use tee to copy data from pipe1 to pipe2
  api::tee(&pipe1_read_res, &pipe2_write_res, test_data.len() as u32)
    .with_lio(&mut lio)
    .send_with(sender.clone());

  let bytes_copied =
    poll_until_recv(&mut lio, &receiver).expect("Failed to tee data");
  assert_eq!(bytes_copied as usize, test_data.len());

  // Read from pipe2 to verify
  let mut buf2 = vec![0u8; test_data.len()];
  unsafe {
    let read_bytes = libc::read(
      pipe2_read,
      buf2.as_mut_ptr() as *mut libc::c_void,
      buf2.len(),
    );
    assert_eq!(read_bytes, test_data.len() as isize);
  }
  assert_eq!(&buf2, test_data);

  // Data should still be in pipe1 (tee copies without consuming)
  use std::os::fd::AsRawFd;
  let mut buf1 = vec![0u8; test_data.len()];
  unsafe {
    let read_bytes = libc::read(
      pipe1_read_res.as_raw_fd(),
      buf1.as_mut_ptr() as *mut libc::c_void,
      buf1.len(),
    );
    assert_eq!(read_bytes, test_data.len() as isize);
  }
  assert_eq!(&buf1, test_data);

  // Cleanup - only close fds not owned by Resources
  unsafe {
    libc::close(pipe1_write);
    libc::close(pipe2_read);
  }
  // pipe1_read and pipe2_write are closed when Resources are dropped
}

#[test]
fn test_tee_large_data() {
  let mut lio = Lio::new(64).unwrap();

  let mut pipe1_fds = [0i32; 2];
  let mut pipe2_fds = [0i32; 2];

  unsafe {
    assert_eq!(libc::pipe(pipe1_fds.as_mut_ptr()), 0);
    assert_eq!(libc::pipe(pipe2_fds.as_mut_ptr()), 0);
  }

  let pipe1_write = pipe1_fds[1];
  let pipe2_read = pipe2_fds[0];

  // Create Resources and keep them alive until after we read from the pipes
  let pipe1_read_res = unsafe { Resource::from_raw_fd(pipe1_fds[0]) };
  let pipe2_write_res = unsafe { Resource::from_raw_fd(pipe2_fds[1]) };

  // Write larger data
  let test_data: Vec<u8> = (0..4096).map(|i| (i % 256) as u8).collect();
  unsafe {
    let written = libc::write(
      pipe1_write,
      test_data.as_ptr() as *const libc::c_void,
      test_data.len(),
    );
    assert_eq!(written, test_data.len() as isize);
  }

  let (sender, receiver) = mpsc::channel();

  // Tee the data
  api::tee(&pipe1_read_res, &pipe2_write_res, test_data.len() as u32)
    .with_lio(&mut lio)
    .send_with(sender);

  let bytes_copied =
    poll_until_recv(&mut lio, &receiver).expect("Failed to tee large data");

  assert!(bytes_copied > 0);
  assert!(bytes_copied as usize <= test_data.len());

  // Read from pipe2
  let mut buf2 = vec![0u8; bytes_copied as usize];
  unsafe {
    let read_bytes = libc::read(
      pipe2_read,
      buf2.as_mut_ptr() as *mut libc::c_void,
      buf2.len(),
    );
    assert_eq!(read_bytes, bytes_copied as isize);
  }
  assert_eq!(&buf2, &test_data[..bytes_copied as usize]);

  // Cleanup - only close fds not owned by Resources
  unsafe {
    libc::close(pipe1_write);
    libc::close(pipe2_read);
  }
  // pipe1_read and pipe2_write are closed when Resources are dropped
}

#[test]
fn test_tee_partial() {
  let mut lio = Lio::new(64).unwrap();

  let mut pipe1_fds = [0i32; 2];
  let mut pipe2_fds = [0i32; 2];

  unsafe {
    assert_eq!(libc::pipe(pipe1_fds.as_mut_ptr()), 0);
    assert_eq!(libc::pipe(pipe2_fds.as_mut_ptr()), 0);
  }

  let pipe1_write = pipe1_fds[1];
  let pipe2_read = pipe2_fds[0];

  // Create Resources and keep them alive
  let pipe1_read_res = unsafe { Resource::from_raw_fd(pipe1_fds[0]) };
  let pipe2_write_res = unsafe { Resource::from_raw_fd(pipe2_fds[1]) };

  let test_data = b"0123456789ABCDEF";
  unsafe {
    libc::write(
      pipe1_write,
      test_data.as_ptr() as *const libc::c_void,
      test_data.len(),
    );
  }

  let (sender, receiver) = mpsc::channel();

  // Tee only part of the data
  let bytes_to_tee = 8;
  api::tee(&pipe1_read_res, &pipe2_write_res, bytes_to_tee)
    .with_lio(&mut lio)
    .send_with(sender);

  let bytes_copied =
    poll_until_recv(&mut lio, &receiver).expect("Failed to tee partial data");
  assert_eq!(bytes_copied, bytes_to_tee as i32);

  // Read from pipe2
  let mut buf2 = vec![0u8; bytes_to_tee as usize];
  unsafe {
    let read_bytes = libc::read(
      pipe2_read,
      buf2.as_mut_ptr() as *mut libc::c_void,
      buf2.len(),
    );
    assert_eq!(read_bytes, bytes_to_tee as isize);
  }
  assert_eq!(&buf2, &test_data[..bytes_to_tee as usize]);

  // All data should still be in pipe1
  use std::os::fd::AsRawFd;
  let mut buf1 = vec![0u8; test_data.len()];
  unsafe {
    let read_bytes = libc::read(
      pipe1_read_res.as_raw_fd(),
      buf1.as_mut_ptr() as *mut libc::c_void,
      buf1.len(),
    );
    assert_eq!(read_bytes, test_data.len() as isize);
  }
  assert_eq!(&buf1, test_data);

  // Cleanup - only close fds not owned by Resources
  unsafe {
    libc::close(pipe1_write);
    libc::close(pipe2_read);
  }
}

#[test]
fn test_tee_empty_pipe() {
  use std::os::fd::AsRawFd;
  let mut lio = Lio::new(64).unwrap();

  let mut pipe1_fds = [0i32; 2];
  let mut pipe2_fds = [0i32; 2];

  unsafe {
    assert_eq!(libc::pipe(pipe1_fds.as_mut_ptr()), 0);
    assert_eq!(libc::pipe(pipe2_fds.as_mut_ptr()), 0);
  }

  // Create Resources and keep them alive
  let pipe1_read_res = unsafe { Resource::from_raw_fd(pipe1_fds[0]) };
  let pipe2_write_res = unsafe { Resource::from_raw_fd(pipe2_fds[1]) };

  // Set pipes to non-blocking
  unsafe {
    let flags = libc::fcntl(pipe1_read_res.as_raw_fd(), libc::F_GETFL, 0);
    libc::fcntl(
      pipe1_read_res.as_raw_fd(),
      libc::F_SETFL,
      flags | libc::O_NONBLOCK,
    );
  }

  let (sender, receiver) = mpsc::channel();

  // Try to tee from empty pipe
  api::tee(&pipe1_read_res, &pipe2_write_res, 100)
    .with_lio(&mut lio)
    .send_with(sender);

  let result = poll_until_recv(&mut lio, &receiver);

  // Should fail with EAGAIN or similar
  assert!(result.is_err(), "Tee from empty pipe should fail");

  // Cleanup - only close fds not owned by Resources
  unsafe {
    libc::close(pipe1_fds[1]);
    libc::close(pipe2_fds[0]);
  }
}

#[test]
fn test_tee_zero_size() {
  let mut lio = Lio::new(64).unwrap();

  let mut pipe1_fds = [0i32; 2];
  let mut pipe2_fds = [0i32; 2];

  unsafe {
    assert_eq!(libc::pipe(pipe1_fds.as_mut_ptr()), 0);
    assert_eq!(libc::pipe(pipe2_fds.as_mut_ptr()), 0);
  }

  let pipe1_write = pipe1_fds[1];

  // Create Resources and keep them alive
  let pipe1_read_res = unsafe { Resource::from_raw_fd(pipe1_fds[0]) };
  let pipe2_write_res = unsafe { Resource::from_raw_fd(pipe2_fds[1]) };

  let test_data = b"Some data";
  unsafe {
    libc::write(
      pipe1_write,
      test_data.as_ptr() as *const libc::c_void,
      test_data.len(),
    );
  }

  let (sender, receiver) = mpsc::channel();

  // Tee with size 0
  api::tee(&pipe1_read_res, &pipe2_write_res, 0)
    .with_lio(&mut lio)
    .send_with(sender);

  let bytes_copied = poll_until_recv(&mut lio, &receiver)
    .expect("Tee with size 0 should succeed");
  assert_eq!(bytes_copied, 0);

  // Cleanup - only close fds not owned by Resources
  unsafe {
    libc::close(pipe1_write);
    libc::close(pipe2_fds[0]);
  }
}

#[cfg(target_os = "linux")]
#[test]
fn test_tee_multiple() {
  let mut lio = Lio::new(64).unwrap();

  let mut pipe1_fds = [0i32; 2];
  let mut pipe2_fds = [0i32; 2];
  let mut pipe3_fds = [0i32; 2];

  unsafe {
    assert_eq!(libc::pipe(pipe1_fds.as_mut_ptr()), 0);
    assert_eq!(libc::pipe(pipe2_fds.as_mut_ptr()), 0);
    assert_eq!(libc::pipe(pipe3_fds.as_mut_ptr()), 0);
  }

  let pipe1_write = pipe1_fds[1];
  let pipe2_read = pipe2_fds[0];
  let pipe3_read = pipe3_fds[0];

  // Create Resources and keep them alive for multiple tee operations
  let pipe1_read_res = unsafe { Resource::from_raw_fd(pipe1_fds[0]) };
  let pipe2_write_res = unsafe { Resource::from_raw_fd(pipe2_fds[1]) };
  let pipe3_write_res = unsafe { Resource::from_raw_fd(pipe3_fds[1]) };

  let test_data = b"Tee multiple times";
  unsafe {
    libc::write(
      pipe1_write,
      test_data.as_ptr() as *const libc::c_void,
      test_data.len(),
    );
  }

  let (sender, receiver) = mpsc::channel();

  // Tee to pipe2
  api::tee(&pipe1_read_res, &pipe2_write_res, test_data.len() as u32)
    .with_lio(&mut lio)
    .send_with(sender.clone());

  let bytes1 = poll_until_recv(&mut lio, &receiver).expect("First tee failed");
  assert_eq!(bytes1 as usize, test_data.len());

  let (sender2, receiver2) = mpsc::channel();

  // Tee to pipe3 (data still in pipe1)
  api::tee(&pipe1_read_res, &pipe3_write_res, test_data.len() as u32)
    .with_lio(&mut lio)
    .send_with(sender2);

  let bytes2 =
    poll_until_recv(&mut lio, &receiver2).expect("Second tee failed");
  assert_eq!(bytes2 as usize, test_data.len());

  // Verify data in pipe2
  let mut buf2 = vec![0u8; test_data.len()];
  unsafe {
    libc::read(pipe2_read, buf2.as_mut_ptr() as *mut libc::c_void, buf2.len());
  }
  assert_eq!(&buf2, test_data);

  // Verify data in pipe3
  let mut buf3 = vec![0u8; test_data.len()];
  unsafe {
    libc::read(pipe3_read, buf3.as_mut_ptr() as *mut libc::c_void, buf3.len());
  }
  assert_eq!(&buf3, test_data);

  // Cleanup - only close fds not owned by Resources
  unsafe {
    libc::close(pipe1_write);
    libc::close(pipe2_read);
    libc::close(pipe3_read);
  }
  // pipe1_read, pipe2_write, pipe3_write are closed when Resources are dropped
}

#[test]
fn test_tee_concurrent() {
  let mut lio = Lio::new(64).unwrap();

  // Test multiple concurrent tee operations
  // Create pipes and Resources, keeping Resources alive until after results are received
  let tasks: Vec<_> = (0..5)
    .map(|i| {
      let mut pipe1_fds = [0i32; 2];
      let mut pipe2_fds = [0i32; 2];

      unsafe {
        libc::pipe(pipe1_fds.as_mut_ptr());
        libc::pipe(pipe2_fds.as_mut_ptr());
      }

      let data = format!("Task {}", i);
      unsafe {
        libc::write(
          pipe1_fds[1],
          data.as_ptr() as *const libc::c_void,
          data.len(),
        );
      }

      // Create Resources that will be kept alive
      let pipe1_read_res = unsafe { Resource::from_raw_fd(pipe1_fds[0]) };
      let pipe2_write_res = unsafe { Resource::from_raw_fd(pipe2_fds[1]) };

      (pipe1_fds[1], pipe2_fds[0], pipe1_read_res, pipe2_write_res, data)
    })
    .collect();

  let (sender, receiver) = mpsc::channel();

  for (_, _, pipe1_read_res, pipe2_write_res, data) in &tasks {
    let data_len = data.len();
    api::tee(pipe1_read_res, pipe2_write_res, data_len as u32)
      .with_lio(&mut lio)
      .send_with(sender.clone());
  }

  for (_, _, _, _, data) in &tasks {
    let bytes_copied =
      poll_until_recv(&mut lio, &receiver).expect("Concurrent tee failed");
    assert_eq!(bytes_copied as usize, data.len());
  }

  // Cleanup - only close fds not owned by Resources
  for (pipe1_write, pipe2_read, _, _, _) in &tasks {
    unsafe {
      libc::close(*pipe1_write);
      libc::close(*pipe2_read);
    }
  }
  // pipe1_read and pipe2_write are closed when Resources are dropped
}