wireshift-uring 0.1.1

Native Linux io_uring backend for wireshift
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

#![allow(missing_docs)]

use std::fs::File;
use std::os::fd::AsRawFd;
use wireshift_core::backend::{Backend, BackendSubmission, CancellationHandle};
use wireshift_core::buffer::BufferPool;
use wireshift_core::config::{RegisteredBufferConfig, RingConfig};
use wireshift_core::op::OpDescriptor;
use wireshift_uring::UringBackend;

#[test]
fn test_unit_new_default_config() {
    let (tx, _rx) = std::sync::mpsc::channel();
    let config = RingConfig::default();
    let backend = UringBackend::new(&config, tx).expect("backend creation should succeed");
    assert_eq!(
        backend.kind(),
        wireshift_core::backend::BackendKind::IoUring
    );
}

#[test]
fn test_unit_new_with_sq_poll() {
    let (tx, _rx) = std::sync::mpsc::channel();
    let config = RingConfig {
        sq_poll_idle_ms: Some(100),
        ..RingConfig::default()
    };
    let backend = UringBackend::new(&config, tx).expect("backend creation should succeed");
    assert_eq!(
        backend.kind(),
        wireshift_core::backend::BackendKind::IoUring
    );
}

#[test]
fn test_unit_new_invalid_registered_buffers() {
    let (tx, _rx) = std::sync::mpsc::channel();
    let config = RingConfig {
        registered_buffers: Some(RegisteredBufferConfig {
            count: usize::MAX as u32,
            size: 4096,
        }),
        ..RingConfig::default()
    };
    let result = UringBackend::new(&config, tx);
    assert!(
        result.is_err(),
        "should fail on impossibly huge registration size"
    );
}

#[test]
fn test_unit_register_unregister_files() {
    let (tx, _rx) = std::sync::mpsc::channel();
    let config = RingConfig::default();
    let backend = UringBackend::new(&config, tx).expect("backend creation");

    let _ = backend.unregister_files(); // unregister sparse first
    let file = File::open("/dev/null").expect("open /dev/null");
    backend
        .register_files(&[file.as_raw_fd()])
        .expect("register files");
    backend.unregister_files().expect("unregister files");
}

#[test]
fn test_unit_supports_native_read() {
    let (tx, _rx) = std::sync::mpsc::channel();
    let config = RingConfig::default();
    let backend = UringBackend::new(&config, tx).expect("backend creation");

    let file = File::open("/dev/null").expect("open /dev/null");
    let buffer = BufferPool::new(4096, 1)
        .unwrap()
        .acquire()
        .unwrap()
        .into_submitted();
    let desc = OpDescriptor::Read {
        file,
        offset: 0,
        buffer,
        len: None,
    };

    assert!(
        backend.supports_native(&desc),
        "Read should be supported natively"
    );
}

#[test]
fn test_unit_submit_and_cancel() {
    let (tx, _rx) = std::sync::mpsc::channel();
    let config = RingConfig::default();
    let backend = UringBackend::new(&config, tx).expect("backend creation");

    let file = File::open("/dev/null").expect("open /dev/null");
    let buffer = BufferPool::new(4096, 1)
        .unwrap()
        .acquire()
        .unwrap()
        .into_submitted();
    let descriptor = OpDescriptor::Read {
        file,
        offset: 0,
        buffer,
        len: None,
    };

    let submission = BackendSubmission { timeout: None,  id: 1, descriptor };

    backend.submit(submission).expect("submit");

    let cancellation = CancellationHandle { target: 1 };
    backend.cancel(cancellation).expect("cancel");
}

#[test]
fn test_unit_shutdown() {
    let (tx, _rx) = std::sync::mpsc::channel();
    let config = RingConfig::default();
    let backend = UringBackend::new(&config, tx).expect("backend creation");
    backend.shutdown().expect("shutdown should succeed");

    // Test that sending after shutdown fails
    let file = File::open("/dev/null").expect("open /dev/null");
    let buffer = BufferPool::new(4096, 1)
        .unwrap()
        .acquire()
        .unwrap()
        .into_submitted();
    let descriptor = OpDescriptor::Read {
        file,
        offset: 0,
        buffer,
        len: None,
    };
    let submission = BackendSubmission { timeout: None,  id: 2, descriptor };
    let result = backend.submit(submission);
    assert!(
        result.is_err(),
        "submit after shutdown should return an error"
    );
}