yip-io 0.1.0

High-performance I/O engines (AF_XDP zero-copy, io_uring, and vectorized recvmmsg/sendmmsg) for yip
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

use std::net::UdpSocket;
use yip_io::batch::{BatchUdpSocket, BATCH_SIZE};

#[test]
fn test_recvmmsg_and_sendmmsg_burst() {
    let s1 = UdpSocket::bind("127.0.0.1:0").expect("bind s1");
    let s2 = UdpSocket::bind("127.0.0.1:0").expect("bind s2");
    s1.set_nonblocking(true).unwrap();
    s2.set_nonblocking(true).unwrap();

    let addr2 = s2.local_addr().unwrap();
    let mut b1 = BatchUdpSocket::new(&s1);
    let mut b2 = BatchUdpSocket::new(&s2);

    let mut to_send = Vec::new();
    let payload = b"vectorized batch test packet";
    for _ in 0..16 {
        to_send.push((&payload[..], addr2));
    }

    let sent = b1.sendmmsg_batch(&to_send).expect("sendmmsg");
    assert_eq!(sent, 16);

    std::thread::sleep(std::time::Duration::from_millis(10));

    let mut buffers = [[0u8; yip_io::MAX_WIRE_DATAGRAM]; BATCH_SIZE];
    let mut out = [const { yip_io::batch::ReceivedDatagram::empty() }; BATCH_SIZE];

    let recvd = b2.recvmmsg_batch(&mut buffers, &mut out).expect("recvmmsg");
    assert_eq!(recvd, 16);
    for i in 0..16 {
        assert_eq!(&buffers[i][..out[i].len], payload);
    }
}

#[test]
fn test_full_batch_size_burst() {
    let s1 = UdpSocket::bind("127.0.0.1:0").expect("bind s1");
    let s2 = UdpSocket::bind("127.0.0.1:0").expect("bind s2");
    s1.set_nonblocking(true).unwrap();
    s2.set_nonblocking(true).unwrap();

    let addr1 = s1.local_addr().unwrap();
    let addr2 = s2.local_addr().unwrap();
    let mut b1 = BatchUdpSocket::new(&s1);
    let mut b2 = BatchUdpSocket::new(&s2);

    // Send exactly BATCH_SIZE packets with distinct payloads
    let mut payloads = Vec::with_capacity(BATCH_SIZE);
    let mut to_send = Vec::with_capacity(BATCH_SIZE);
    for i in 0..BATCH_SIZE {
        payloads.push(format!("payload-packet-index-{i}").into_bytes());
    }
    for p in &payloads {
        to_send.push((p.as_slice(), addr2));
    }

    let sent = b1.sendmmsg_batch(&to_send).expect("sendmmsg batch 32");
    assert_eq!(sent, BATCH_SIZE);

    std::thread::sleep(std::time::Duration::from_millis(15));

    let mut buffers = [[0u8; yip_io::MAX_WIRE_DATAGRAM]; BATCH_SIZE];
    let mut out = [const { yip_io::batch::ReceivedDatagram::empty() }; BATCH_SIZE];

    let recvd = b2
        .recvmmsg_batch(&mut buffers, &mut out)
        .expect("recvmmsg batch 32");
    assert_eq!(recvd, BATCH_SIZE);

    for i in 0..BATCH_SIZE {
        assert_eq!(out[i].len, payloads[i].len());
        assert_eq!(&buffers[i][..out[i].len], payloads[i].as_slice());
        assert_eq!(out[i].src, addr1);
    }
}

#[test]
fn test_empty_and_overflow_batches() {
    let s1 = UdpSocket::bind("127.0.0.1:0").expect("bind s1");
    let s2 = UdpSocket::bind("127.0.0.1:0").expect("bind s2");
    s1.set_nonblocking(true).unwrap();
    s2.set_nonblocking(true).unwrap();

    let addr2 = s2.local_addr().unwrap();
    let mut b1 = BatchUdpSocket::new(&s1);
    let mut b2 = BatchUdpSocket::new(&s2);

    // Empty send
    let sent = b1.sendmmsg_batch(&[]).expect("empty sendmmsg");
    assert_eq!(sent, 0);

    // Empty recv on non-blocking socket
    let mut buffers = [[0u8; yip_io::MAX_WIRE_DATAGRAM]; BATCH_SIZE];
    let mut out = [const { yip_io::batch::ReceivedDatagram::empty() }; BATCH_SIZE];
    let recvd = b2
        .recvmmsg_batch(&mut buffers, &mut out)
        .expect("empty recvmmsg");
    assert_eq!(recvd, 0);

    // Overflow send: 40 packets provided, sendmmsg_batch should send BATCH_SIZE (32)
    let payload = b"overflow test";
    let to_send: Vec<(&[u8], std::net::SocketAddr)> =
        (0..40).map(|_| (&payload[..], addr2)).collect();
    let sent = b1.sendmmsg_batch(&to_send).expect("overflow sendmmsg");
    assert_eq!(sent, BATCH_SIZE);
}

#[test]
fn test_ipv6_batch_roundtrip() {
    let Ok(s1) = UdpSocket::bind("[::1]:0") else {
        // Skip test if IPv6 loopback is not available
        return;
    };
    let Ok(s2) = UdpSocket::bind("[::1]:0") else {
        return;
    };
    s1.set_nonblocking(true).unwrap();
    s2.set_nonblocking(true).unwrap();

    let addr1 = s1.local_addr().unwrap();
    let addr2 = s2.local_addr().unwrap();
    let mut b1 = BatchUdpSocket::new(&s1);
    let mut b2 = BatchUdpSocket::new(&s2);

    let payload = b"ipv6 batch test";
    let to_send: Vec<(&[u8], std::net::SocketAddr)> =
        (0..8).map(|_| (&payload[..], addr2)).collect();

    let sent = b1.sendmmsg_batch(&to_send).expect("sendmmsg ipv6");
    assert_eq!(sent, 8);

    std::thread::sleep(std::time::Duration::from_millis(10));

    let mut buffers = [[0u8; yip_io::MAX_WIRE_DATAGRAM]; BATCH_SIZE];
    let mut out = [const { yip_io::batch::ReceivedDatagram::empty() }; BATCH_SIZE];

    let recvd = b2
        .recvmmsg_batch(&mut buffers, &mut out)
        .expect("recvmmsg ipv6");
    assert_eq!(recvd, 8);
    for i in 0..8 {
        assert_eq!(&buffers[i][..out[i].len], payload);
        assert_eq!(out[i].src, addr1);
    }
}

#[test]
fn test_udp_gso_segment_and_superpacket() {
    let s1 = UdpSocket::bind("127.0.0.1:0").expect("bind s1");
    let s2 = UdpSocket::bind("127.0.0.1:0").expect("bind s2");
    let addr2 = s2.local_addr().unwrap();

    // Probe set_udp_gso_segment
    let _ = yip_io::batch::set_udp_gso_segment(&s1, 1420);

    // Test send_gso_superpacket
    let payload = vec![0x5a; 2840];
    let res = yip_io::batch::send_gso_superpacket(&s1, &payload, 1420, addr2);
    let _ = res;
}

#[test]
fn test_batch_size_64_burst() {
    use yip_io::batch::BATCH_SIZE_64;

    let s1 = UdpSocket::bind("127.0.0.1:0").expect("bind s1");
    let s2 = UdpSocket::bind("127.0.0.1:0").expect("bind s2");
    s1.set_nonblocking(true).unwrap();
    s2.set_nonblocking(true).unwrap();

    let addr1 = s1.local_addr().unwrap();
    let addr2 = s2.local_addr().unwrap();
    let mut b1 = BatchUdpSocket::new(&s1);
    let mut b2 = BatchUdpSocket::new(&s2);

    let mut payloads = Vec::with_capacity(BATCH_SIZE_64);
    let mut to_send = Vec::with_capacity(BATCH_SIZE_64);
    for i in 0..BATCH_SIZE_64 {
        payloads.push(format!("payload-64-burst-{i}").into_bytes());
    }
    for p in &payloads {
        to_send.push((p.as_slice(), addr2));
    }

    let sent = b1
        .sendmmsg_burst::<BATCH_SIZE_64>(&to_send)
        .expect("sendmmsg 64");
    assert_eq!(sent, BATCH_SIZE_64);

    std::thread::sleep(std::time::Duration::from_millis(25));

    let mut buffers = [[0u8; yip_io::MAX_WIRE_DATAGRAM]; BATCH_SIZE_64];
    let mut out = [const { yip_io::batch::ReceivedDatagram::empty() }; BATCH_SIZE_64];

    let mut total_recvd = 0;
    while total_recvd < BATCH_SIZE_64 {
        let recvd = b2
            .recvmmsg_batch(&mut buffers, &mut out)
            .expect("recvmmsg 64");
        if recvd == 0 {
            std::thread::sleep(std::time::Duration::from_millis(10));
            continue;
        }
        for i in 0..recvd {
            let idx = total_recvd + i;
            assert_eq!(out[i].len, payloads[idx].len());
            assert_eq!(&buffers[i][..out[i].len], payloads[idx].as_slice());
            assert_eq!(out[i].src, addr1);
        }
        total_recvd += recvd;
    }
    assert_eq!(total_recvd, BATCH_SIZE_64);
}

#[test]
fn test_batch_size_128_burst() {
    use yip_io::batch::BATCH_SIZE_128;

    let s1 = UdpSocket::bind("127.0.0.1:0").expect("bind s1");
    let s2 = UdpSocket::bind("127.0.0.1:0").expect("bind s2");
    s1.set_nonblocking(true).unwrap();
    s2.set_nonblocking(true).unwrap();

    let addr1 = s1.local_addr().unwrap();
    let addr2 = s2.local_addr().unwrap();
    let mut b1 = BatchUdpSocket::new(&s1);
    let mut b2 = BatchUdpSocket::new(&s2);

    let mut payloads = Vec::with_capacity(BATCH_SIZE_128);
    let mut to_send = Vec::with_capacity(BATCH_SIZE_128);
    for i in 0..BATCH_SIZE_128 {
        payloads.push(format!("payload-128-burst-{i}").into_bytes());
    }
    for p in &payloads {
        to_send.push((p.as_slice(), addr2));
    }

    let sent = b1
        .sendmmsg_burst::<BATCH_SIZE_128>(&to_send)
        .expect("sendmmsg 128");
    assert_eq!(sent, BATCH_SIZE_128);

    std::thread::sleep(std::time::Duration::from_millis(30));

    let mut buffers = [[0u8; yip_io::MAX_WIRE_DATAGRAM]; BATCH_SIZE_128];
    let mut out = [const { yip_io::batch::ReceivedDatagram::empty() }; BATCH_SIZE_128];

    let mut total_recvd = 0;
    while total_recvd < BATCH_SIZE_128 {
        let recvd = b2
            .recvmmsg_batch(&mut buffers, &mut out)
            .expect("recvmmsg 128");
        if recvd == 0 {
            std::thread::sleep(std::time::Duration::from_millis(10));
            continue;
        }
        for i in 0..recvd {
            let idx = total_recvd + i;
            assert_eq!(out[i].len, payloads[idx].len());
            assert_eq!(&buffers[i][..out[i].len], payloads[idx].as_slice());
            assert_eq!(out[i].src, addr1);
        }
        total_recvd += recvd;
    }
    assert_eq!(total_recvd, BATCH_SIZE_128);
}