vibeio 0.2.8

A high-performance, cross-platform asynchronous runtime for Rust
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
578
579
580
581
582
583
584
585
586
#[cfg(windows)]
use std::ffi::c_void;
use std::io;
#[cfg(unix)]
use std::mem::{self, MaybeUninit};
use std::net::SocketAddr;
#[cfg(unix)]
use std::os::fd::RawFd;
#[cfg(windows)]
use std::ptr;
use std::task::{Context, Poll};

use mio::Interest;
#[cfg(windows)]
use windows_sys::Win32::{
    Networking::WinSock::{
        self as WinSock, AF_INET, AF_INET6, INVALID_SOCKET, IPPROTO_TCP, SOCKADDR, SOCKADDR_IN,
        SOCKADDR_IN6, SOCKADDR_STORAGE, SOCKET, SOCK_STREAM, SOL_SOCKET, SO_UPDATE_ACCEPT_CONTEXT,
        WSAID_ACCEPTEX, WSA_FLAG_OVERLAPPED, WSA_IO_PENDING,
    },
    System::IO::OVERLAPPED,
};

use crate::driver::CompletionIoResult;
use crate::fd_inner::{InnerRawHandle, RawOsHandle};
use crate::op::Op;
use crate::{current_driver, driver::AnyDriver};

#[cfg(unix)]
fn set_cloexec(fd: RawFd) -> Result<(), io::Error> {
    // set FD_CLOEXEC on file descriptor flags
    let fdflags = unsafe { libc::fcntl(fd, libc::F_GETFD) };
    if fdflags == -1 {
        return Err(io::Error::last_os_error());
    }
    if fdflags & libc::FD_CLOEXEC == 0 {
        let result = unsafe { libc::fcntl(fd, libc::F_SETFD, fdflags | libc::FD_CLOEXEC) };
        if result == -1 {
            return Err(io::Error::last_os_error());
        }
    }

    Ok(())
}

#[cfg(unix)]
fn sockaddr_storage_to_socketaddr(
    storage: &libc::sockaddr_storage,
) -> Result<SocketAddr, io::Error> {
    // Determine family. ss_family field is platform-dependent type; cast to c_uchar then to c_int for comparison.
    let family = storage.ss_family as libc::c_int;

    if family == libc::AF_INET {
        let addr_in: &libc::sockaddr_in =
            unsafe { &*(storage as *const _ as *const libc::sockaddr_in) };
        let port = u16::from_be(addr_in.sin_port);
        // s_addr is in network byte order
        let ip_u32 = u32::from_be(addr_in.sin_addr.s_addr);
        let ip = std::net::Ipv4Addr::from(ip_u32);
        Ok(SocketAddr::V4(std::net::SocketAddrV4::new(ip, port)))
    } else if family == libc::AF_INET6 {
        let addr_in6: &libc::sockaddr_in6 =
            unsafe { &*(storage as *const _ as *const libc::sockaddr_in6) };
        let port = u16::from_be(addr_in6.sin6_port);
        let ip = std::net::Ipv6Addr::from(addr_in6.sin6_addr.s6_addr);
        Ok(SocketAddr::V6(std::net::SocketAddrV6::new(
            ip,
            port,
            addr_in6.sin6_flowinfo,
            addr_in6.sin6_scope_id,
        )))
    } else {
        Err(io::Error::new(
            io::ErrorKind::InvalidData,
            "unsupported socket family",
        ))
    }
}

#[cfg(windows)]
fn sockaddr_storage_to_socketaddr(storage: &SOCKADDR_STORAGE) -> Result<SocketAddr, io::Error> {
    // Determine family. ss_family field is platform-dependent type; cast to c_uchar then to c_int for comparison.
    let family = storage.ss_family;

    if family == AF_INET {
        let addr_in: &SOCKADDR_IN = unsafe { &*(storage as *const _ as *const SOCKADDR_IN) };
        let port = u16::from_be(addr_in.sin_port);
        // s_addr is in network byte order
        let ip_u32 = u32::from_be(unsafe { addr_in.sin_addr.S_un.S_addr });
        let ip = std::net::Ipv4Addr::from(ip_u32);
        Ok(SocketAddr::V4(std::net::SocketAddrV4::new(ip, port)))
    } else if family == AF_INET6 {
        let addr_in6: &SOCKADDR_IN6 = unsafe { &*(storage as *const _ as *const SOCKADDR_IN6) };
        let port = u16::from_be(addr_in6.sin6_port);
        let ip = std::net::Ipv6Addr::from(unsafe { addr_in6.sin6_addr.u.Byte });
        Ok(SocketAddr::V6(std::net::SocketAddrV6::new(
            ip,
            port,
            addr_in6.sin6_flowinfo,
            unsafe { addr_in6.Anonymous.sin6_scope_id },
        )))
    } else {
        Err(io::Error::new(
            io::ErrorKind::InvalidData,
            "unsupported socket family",
        ))
    }
}

#[cfg(windows)]
fn load_accept_ex(socket: SOCKET) -> Result<WinSock::LPFN_ACCEPTEX, io::Error> {
    let mut bytes_returned: u32 = 0;
    let mut accept_ex: WinSock::LPFN_ACCEPTEX = None;
    let mut guid = WSAID_ACCEPTEX;

    let ioctl_result = unsafe {
        WinSock::WSAIoctl(
            socket,
            WinSock::SIO_GET_EXTENSION_FUNCTION_POINTER,
            (&mut guid as *mut _) as *mut c_void,
            std::mem::size_of_val(&guid) as u32,
            (&mut accept_ex as *mut _) as *mut c_void,
            std::mem::size_of_val(&accept_ex) as u32,
            &mut bytes_returned,
            ptr::null_mut(),
            None,
        )
    };

    if ioctl_result == WinSock::SOCKET_ERROR {
        let err_code = unsafe { WinSock::WSAGetLastError() };
        return Err(io::Error::from_raw_os_error(err_code));
    }

    if accept_ex.is_none() {
        return Err(io::Error::new(
            io::ErrorKind::Unsupported,
            "AcceptEx extension function is unavailable",
        ));
    }

    Ok(accept_ex)
}

#[cfg(windows)]
fn listener_socket_family(listener_socket: SOCKET) -> Result<i32, io::Error> {
    let mut addr = SOCKADDR_IN6::default();
    let mut addr_len = std::mem::size_of::<SOCKADDR_IN6>() as i32;
    let result = unsafe {
        WinSock::getsockname(
            listener_socket,
            (&mut addr as *mut SOCKADDR_IN6).cast::<SOCKADDR>(),
            &mut addr_len,
        )
    };

    if result == WinSock::SOCKET_ERROR {
        let err_code = unsafe { WinSock::WSAGetLastError() };
        return Err(io::Error::from_raw_os_error(err_code));
    }

    Ok(addr.sin6_family as i32)
}

#[cfg(windows)]
fn create_accept_socket(listener_socket: SOCKET) -> Result<SOCKET, io::Error> {
    let family = listener_socket_family(listener_socket)?;
    if family != AF_INET as i32 && family != AF_INET6 as i32 {
        return Err(io::Error::new(
            io::ErrorKind::InvalidInput,
            "unsupported listening socket family for AcceptEx",
        ));
    }

    let accept_socket = unsafe {
        WinSock::WSASocketW(
            family,
            SOCK_STREAM as i32,
            IPPROTO_TCP as i32,
            ptr::null_mut(),
            0,
            WSA_FLAG_OVERLAPPED,
        )
    };
    if accept_socket == INVALID_SOCKET {
        let err_code = unsafe { WinSock::WSAGetLastError() };
        return Err(io::Error::from_raw_os_error(err_code));
    }

    Ok(accept_socket)
}

#[cfg(windows)]
fn set_accept_context(listener_socket: SOCKET, accepted_socket: SOCKET) -> Result<(), io::Error> {
    let result = unsafe {
        WinSock::setsockopt(
            accepted_socket,
            SOL_SOCKET as i32,
            SO_UPDATE_ACCEPT_CONTEXT as i32,
            (&listener_socket as *const SOCKET).cast(),
            std::mem::size_of::<SOCKET>() as i32,
        )
    };
    if result == WinSock::SOCKET_ERROR {
        let err_code = unsafe { WinSock::WSAGetLastError() };
        return Err(io::Error::from_raw_os_error(err_code));
    }
    Ok(())
}

#[cfg(windows)]
const ACCEPTEX_ADDR_LEN: usize = std::mem::size_of::<SOCKADDR_STORAGE>() + 16;
#[cfg(windows)]
const ACCEPTEX_OUTPUT_BUFFER_LEN: usize = ACCEPTEX_ADDR_LEN;

pub struct AcceptOp<'a> {
    handle: &'a InnerRawHandle,
    #[cfg(windows)]
    accept_ex: Option<WinSock::LPFN_ACCEPTEX>,
    #[cfg(windows)]
    accept_socket: Option<SOCKET>,
    #[cfg(windows)]
    bytes_received: u32,
    #[cfg(windows)]
    accept_output_buffer: Option<Box<[u8]>>,
    completion_token: Option<usize>,
}

impl<'a> AcceptOp<'a> {
    #[inline]
    pub fn new(handle: &'a InnerRawHandle) -> Self {
        Self {
            handle,
            #[cfg(windows)]
            accept_ex: None,
            #[cfg(windows)]
            accept_socket: None,
            #[cfg(windows)]
            bytes_received: 0,
            #[cfg(windows)]
            accept_output_buffer: None,
            completion_token: None,
        }
    }
}

impl Op for AcceptOp<'_> {
    type Output = (RawOsHandle, SocketAddr);

    #[cfg(any(unix, windows))]
    #[inline]
    fn poll_poll(
        &mut self,
        cx: &mut Context<'_>,
        driver: &AnyDriver,
    ) -> Poll<io::Result<Self::Output>> {
        #[cfg(unix)]
        {
            let accepted_fd = unsafe {
                libc::accept(
                    self.handle.handle,
                    std::ptr::null_mut(),
                    std::ptr::null_mut(),
                )
            };
            if accepted_fd == -1 {
                let error = io::Error::last_os_error();
                if error.kind() == io::ErrorKind::WouldBlock {
                    if let Err(err) =
                        driver.submit_poll(self.handle, cx.waker().clone(), Interest::READABLE)
                    {
                        return Poll::Ready(Err(err));
                    }
                    return Poll::Pending;
                }
                return Poll::Ready(Err(error));
            }

            let fd = accepted_fd as RawFd;

            // Ensure close-on-exec for the accepted fd
            if let Err(err) = set_cloexec(fd) {
                return Poll::Ready(Err(err));
            }

            // Obtain peer address via getpeername into a sockaddr_storage
            let mut peer = MaybeUninit::<libc::sockaddr_storage>::zeroed();
            let mut peer_len = mem::size_of::<libc::sockaddr_storage>() as libc::socklen_t;
            let getpeername_result = unsafe {
                libc::getpeername(
                    fd,
                    peer.as_mut_ptr().cast::<libc::sockaddr>(),
                    &mut peer_len,
                )
            };

            if getpeername_result == -1 {
                let error = io::Error::last_os_error();
                if error.kind() == io::ErrorKind::WouldBlock {
                    if let Err(err) =
                        driver.submit_poll(self.handle, cx.waker().clone(), Interest::READABLE)
                    {
                        return Poll::Ready(Err(err));
                    }
                    return Poll::Pending;
                }
                return Poll::Ready(Err(error));
            }

            let peer = unsafe { peer.assume_init() };
            let address = sockaddr_storage_to_socketaddr(&peer)?;
            Poll::Ready(Ok((fd as RawOsHandle, address)))
        }

        #[cfg(windows)]
        {
            let RawOsHandle::Socket(listener_socket) = self.handle.handle else {
                return Poll::Ready(Err(io::Error::new(
                    io::ErrorKind::InvalidInput,
                    "invalid raw handle",
                )));
            };

            let accepted_socket = unsafe {
                WinSock::accept(listener_socket as SOCKET, ptr::null_mut(), ptr::null_mut())
            };
            if accepted_socket == INVALID_SOCKET {
                let error = io::Error::from_raw_os_error(unsafe { WinSock::WSAGetLastError() });
                if error.kind() == io::ErrorKind::WouldBlock {
                    if let Err(err) =
                        driver.submit_poll(self.handle, cx.waker().clone(), Interest::READABLE)
                    {
                        return Poll::Ready(Err(err));
                    }
                    return Poll::Pending;
                }
                return Poll::Ready(Err(error));
            }

            let mut peer = SOCKADDR_STORAGE::default();
            let mut peer_len = std::mem::size_of::<SOCKADDR_STORAGE>() as i32;
            let getpeername_result = unsafe {
                WinSock::getpeername(
                    accepted_socket,
                    (&mut peer as *mut SOCKADDR_STORAGE).cast::<SOCKADDR>(),
                    &mut peer_len,
                )
            };
            if getpeername_result == WinSock::SOCKET_ERROR {
                let error = io::Error::from_raw_os_error(unsafe { WinSock::WSAGetLastError() });
                unsafe { WinSock::closesocket(accepted_socket) };
                return Poll::Ready(Err(error));
            }

            let address = match sockaddr_storage_to_socketaddr(&peer) {
                Ok(address) => address,
                Err(err) => {
                    unsafe { WinSock::closesocket(accepted_socket) };
                    return Poll::Ready(Err(err));
                }
            };

            Poll::Ready(Ok((
                RawOsHandle::Socket(accepted_socket as std::os::windows::io::RawSocket),
                address,
            )))
        }
    }

    #[cfg(any(unix, windows))]
    #[inline]
    fn poll_completion(
        &mut self,
        cx: &mut Context<'_>,
        driver: &AnyDriver,
    ) -> Poll<io::Result<Self::Output>> {
        let result = if let Some(completion_token) = self.completion_token {
            // Get the completion result
            match driver.get_completion_result(completion_token) {
                Some(result) => {
                    self.completion_token = None;
                    result
                }
                None => {
                    // The completion is not ready yet
                    driver.set_completion_waker(completion_token, cx.waker().clone());
                    return Poll::Pending;
                }
            }
        } else {
            // Submit the op
            match driver.submit_completion(self, cx.waker().clone()) {
                CompletionIoResult::Ok(result) => result,
                CompletionIoResult::Retry(token) => {
                    self.completion_token = Some(token);
                    return Poll::Pending;
                }
                CompletionIoResult::SubmitErr(err) => return Poll::Ready(Err(err)),
            }
        };
        if result < 0 {
            #[cfg(windows)]
            if let Some(accept_socket) = self.accept_socket.take() {
                unsafe { WinSock::closesocket(accept_socket) };
            }
            return Poll::Ready(Err(io::Error::from_raw_os_error(-result)));
        }

        #[cfg(unix)]
        {
            let fd = result as RawFd;

            // Ensure close-on-exec for the accepted fd (io_uring may have already set them)
            if let Err(err) = set_cloexec(fd) {
                return Poll::Ready(Err(err));
            }

            // Get peer address via getpeername
            let mut peer = MaybeUninit::<libc::sockaddr_storage>::zeroed();
            let mut peer_len = mem::size_of::<libc::sockaddr_storage>() as libc::socklen_t;
            let getpeername_result = unsafe {
                libc::getpeername(
                    fd,
                    peer.as_mut_ptr().cast::<libc::sockaddr>(),
                    &mut peer_len,
                )
            };

            if getpeername_result == -1 {
                return Poll::Ready(Err(io::Error::last_os_error()));
            }

            let peer = unsafe { peer.assume_init() };
            let address = sockaddr_storage_to_socketaddr(&peer)?;
            Poll::Ready(Ok((fd as RawOsHandle, address)))
        }

        #[cfg(windows)]
        {
            let RawOsHandle::Socket(listener_socket) = self.handle.handle else {
                return Poll::Ready(Err(io::Error::new(
                    io::ErrorKind::InvalidInput,
                    "AcceptEx can be used only with listening sockets",
                )));
            };

            let Some(accept_socket) = self.accept_socket.take() else {
                return Poll::Ready(Err(io::Error::new(
                    io::ErrorKind::Other,
                    "AcceptEx completion missing accepted socket",
                )));
            };

            if let Err(err) = set_accept_context(listener_socket as SOCKET, accept_socket) {
                unsafe { WinSock::closesocket(accept_socket) };
                return Poll::Ready(Err(err));
            }

            let peer = match self.accept_output_buffer.take() {
                Some(buf) => buf,
                None => {
                    return Poll::Ready(Err(io::Error::new(
                        io::ErrorKind::Other,
                        "AcceptEx completion missing peer address",
                    )));
                }
            };
            let address = match sockaddr_storage_to_socketaddr(unsafe {
                &*(peer.as_ptr() as *const SOCKADDR_STORAGE)
            }) {
                Ok(address) => address,
                Err(err) => {
                    unsafe { WinSock::closesocket(accept_socket) };
                    return Poll::Ready(Err(err));
                }
            };

            return Poll::Ready(Ok((RawOsHandle::Socket(accept_socket as _), address)));
        }
    }

    #[cfg(windows)]
    #[inline]
    fn submit_windows(&mut self, overlapped: *mut OVERLAPPED) -> Result<(), io::Error> {
        let RawOsHandle::Socket(listener_socket) = self.handle.handle else {
            return Err(io::Error::new(
                io::ErrorKind::InvalidInput,
                "AcceptEx can be used only with listening sockets",
            ));
        };
        let listener_socket = listener_socket as SOCKET;

        if self.accept_ex.is_none() {
            self.accept_ex = Some(load_accept_ex(listener_socket)?);
        }
        let accept_ex = self.accept_ex.ok_or_else(|| {
            io::Error::new(
                io::ErrorKind::Unsupported,
                "AcceptEx extension function is unavailable",
            )
        })?;

        if self.accept_socket.is_none() {
            self.accept_socket = Some(create_accept_socket(listener_socket)?);
        }
        let accept_socket = self
            .accept_socket
            .expect("accept_socket must be initialized");
        if self.accept_output_buffer.is_none() {
            self.accept_output_buffer =
                Some(vec![0u8; ACCEPTEX_OUTPUT_BUFFER_LEN].into_boxed_slice());
        }
        let accept_output_buffer = self
            .accept_output_buffer
            .as_mut()
            .expect("accept_output_buffer must be initialized");

        let Some(accept_ex_fn) = accept_ex else {
            return Err(io::Error::new(
                io::ErrorKind::Unsupported,
                "AcceptEx extension function is unavailable",
            ));
        };

        let accept_result = unsafe {
            accept_ex_fn(
                listener_socket,
                accept_socket,
                accept_output_buffer.as_mut_ptr().cast::<c_void>(),
                0,
                0,
                ACCEPTEX_ADDR_LEN as u32,
                &mut self.bytes_received,
                overlapped,
            )
        };
        if accept_result != 0 {
            return Ok(());
        }

        let err_code = unsafe { WinSock::WSAGetLastError() };
        if err_code == WSA_IO_PENDING {
            Ok(())
        } else {
            if let Some(socket) = self.accept_socket.take() {
                unsafe { WinSock::closesocket(socket) };
            }
            Err(io::Error::from_raw_os_error(err_code))
        }
    }

    #[cfg(target_os = "linux")]
    #[inline]
    fn build_completion_entry(
        &mut self,
        user_data: u64,
    ) -> Result<io_uring::squeue::Entry, io::Error> {
        use io_uring::{opcode, types};

        let entry = opcode::Accept::new(
            types::Fd(self.handle.handle),
            std::ptr::null_mut(),
            std::ptr::null_mut(),
        )
        .flags(libc::SOCK_NONBLOCK | libc::SOCK_CLOEXEC)
        .build()
        .user_data(user_data);

        Ok(entry)
    }
}

impl Drop for AcceptOp<'_> {
    #[inline]
    fn drop(&mut self) {
        if let Some(completion_token) = self.completion_token {
            if let Some(driver) = current_driver() {
                driver.ignore_completion(completion_token, Box::new(()));
            }
        }
        #[cfg(windows)]
        if let Some(socket) = self.accept_socket.take() {
            unsafe { WinSock::closesocket(socket) };
        }
    }
}