reactors 0.1.4

Performance-focused cross-platform asynchronous IO implementation
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
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
use std::{
    ffi::c_void,
    io::*,
    mem::{size_of, transmute},
    net::SocketAddr,
    ptr::{null, null_mut},
    sync::{
        atomic::{AtomicBool, Ordering},
        Arc,
    },
    task::Poll,
    time::Duration,
};

use once_cell::sync::OnceCell;
use os_socketaddr::OsSocketAddr;
use winapi::{
    shared::{guiddef::*, winerror::ERROR_IO_PENDING, ws2def::*},
    um::{errhandlingapi::GetLastError, winsock2::*},
    um::{minwinbase::OVERLAPPED, mswsock::*},
};

use crate::{
    io::{EventMessage, EventName, IoReactor, RawFd, ReactorOverlapped},
    ReactorHandle,
};

use super::sys::{self, ReadBuffer, Socket, WriteBuffer};

/// Socket handle wrapper.
#[derive(Debug, Clone)]
pub struct Handle {
    /// Socket handle bind reactor
    pub reactor: IoReactor,
    /// Socket handle bind os fd.
    pub fd: Arc<SOCKET>,
    /// If this socket is ipv4 familiy
    pub ip_v4: bool,
    /// Close status
    pub closed: Arc<AtomicBool>,
}

impl Handle {
    pub fn to_raw_fd(&self) -> RawFd {
        *self.fd as RawFd
    }
}

impl Drop for Handle {
    fn drop(&mut self) {
        // Only self alive.
        if Arc::strong_count(&self.fd) == 1 {
            self.close();
        }
    }
}

impl sys::Socket for Handle {
    fn bind(fd: RawFd, addr: std::net::SocketAddr) -> Result<()> {
        unsafe {
            let addr: OsSocketAddr = addr.into();

            if bind(fd as usize, (addr.as_ptr()).cast::<SOCKADDR>(), addr.len()) < 0 {
                return Err(Error::last_os_error());
            }
        }

        Ok(())
    }

    fn listen(fd: RawFd) -> Result<()> {
        unsafe {
            if listen(fd as usize, SOMAXCONN as i32) < 0 {
                return Err(Error::last_os_error());
            } else {
                Ok(())
            }
        }
    }

    fn new(ip_v4: bool, fd: RawFd, mut reactor: IoReactor) -> Result<Self> {
        // bind fd to completion port.
        unsafe {
            match reactor.on_open_fd(fd) {
                Err(err) => {
                    // release socket resource when this method raise an error.
                    closesocket(fd as usize);
                    return Err(err);
                }
                _ => {}
            }
        }

        Ok(Self {
            reactor,
            fd: Arc::new(fd as usize),
            closed: Default::default(),
            ip_v4,
        })
    }

    fn socket(ip_v4: bool, sock_type: i32, protocol: i32) -> Result<RawFd> {
        let socket = unsafe {
            match ip_v4 {
                true => WSASocketW(
                    AF_INET as i32,
                    sock_type as i32,
                    protocol as i32,
                    null_mut(),
                    0,
                    WSA_FLAG_OVERLAPPED,
                ),
                false => WSASocketW(
                    AF_INET6 as i32,
                    sock_type as i32,
                    protocol as i32,
                    null_mut(),
                    0,
                    WSA_FLAG_OVERLAPPED,
                ),
            }
        };

        if socket == INVALID_SOCKET {
            return Err(Error::last_os_error());
        }

        Ok(socket as RawFd)
    }

    fn close(&mut self) {
        log::debug!("close socket({:?})", self.to_raw_fd());
        self.reactor.on_close_fd(self.to_raw_fd());

        unsafe {
            closesocket(*self.fd);
        }
    }

    fn tcp(ip_v4: bool) -> Result<RawFd> {
        Self::socket(
            ip_v4,
            winapi::shared::ws2def::SOCK_STREAM,
            IPPROTO_TCP as i32,
        )
    }

    fn udp(ip_v4: bool) -> Result<RawFd> {
        Self::socket(
            ip_v4,
            winapi::shared::ws2def::SOCK_DGRAM,
            IPPROTO_UDP as i32,
        )
    }

    /// Start an async connect operator.
    #[allow(unused)]
    fn poll_connect(
        mut self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
        remote: SocketAddr,
        timeout: Option<Duration>,
    ) -> Poll<Result<()>> {
        // socket fd
        let fd = self.to_raw_fd();

        if let Some(event) = self.reactor.poll_io_event(fd, EventName::Connect)? {
            match event.message? {
                EventMessage::Connect => {
                    return Poll::Ready(Ok(()));
                }
                _ => {
                    panic!("Inner error")
                }
            }
        }

        let overlapped = ReactorOverlapped::new_raw(fd, EventName::Connect);

        #[allow(non_snake_case)]
        let ConnectEx = self.get_connect_ex()?.unwrap();

        let addr: OsSocketAddr = remote.into();

        self.reactor
            .once(fd, EventName::Connect, cx.waker().clone(), timeout);

        let ret = unsafe {
            ConnectEx(
                fd as usize,
                addr.as_ptr() as *const SOCKADDR,
                addr.len(),
                null_mut(),
                0,
                null_mut(),
                overlapped as *mut OVERLAPPED,
            )
        };

        log::trace!("socket({:?}) connect({})", fd, ret);

        if ret > 0 {
            // obtain point ownership
            // let overlapped: Box<ReactorOverlapped> = overlapped.into();

            return Poll::Pending;
        }

        // This operation will completing Asynchronously
        if unsafe { GetLastError() } == ERROR_IO_PENDING {
            log::trace!("socket({:?}) connect asynchronously", fd);

            return Poll::Pending;
        }

        self.reactor.remove_once(fd, EventName::Connect);

        return Poll::Ready(Err(Error::last_os_error()));
    }
}

#[allow(unused)]
impl ReactorHandle for Handle {
    type ReadBuffer<'cx> = sys::ReadBuffer<'cx>;
    type WriteBuffer<'cx> = sys::WriteBuffer<'cx>;

    fn poll_write<'cx>(
        self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
        buffer: Self::WriteBuffer<'cx>,
        timeout: Option<std::time::Duration>,
    ) -> std::task::Poll<Result<usize>> {
        match buffer {
            WriteBuffer::Datagram(buff, remote) => {
                self.poll_write_datagram(cx, buff, remote, timeout)
            }
            WriteBuffer::Stream(buff) => self.poll_write_stream(cx, buff, timeout),
        }
    }

    fn poll_close(
        mut self: std::pin::Pin<&mut Self>,
        _cx: &mut std::task::Context<'_>,
    ) -> std::task::Poll<Result<()>> {
        match self
            .closed
            .compare_exchange(false, true, Ordering::SeqCst, Ordering::SeqCst)
        {
            Err(_) => Poll::Ready(Ok(())),
            _ => {
                self.close();

                Poll::Ready(Ok(()))
            }
        }
    }

    fn poll_read<'cx>(
        self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
        buffer: Self::ReadBuffer<'cx>,
        timeout: Option<std::time::Duration>,
    ) -> std::task::Poll<Result<usize>> {
        match buffer {
            ReadBuffer::Accept(fd, remote) => self.poll_accept(cx, fd, remote, timeout),
            ReadBuffer::Datagram(buff, remote) => {
                self.poll_read_datagram(cx, buff, remote, timeout)
            }
            ReadBuffer::Stream(buff) => self.poll_read_stream(cx, buff, timeout),
        }
    }
}

impl Handle {
    fn get_connect_ex(&self) -> Result<&'static LPFN_CONNECTEX> {
        static CONNECT_EX: OnceCell<LPFN_CONNECTEX> = OnceCell::new();

        let fd = self.to_raw_fd();

        CONNECT_EX.get_or_try_init(|| unsafe {
            let connectex: *const c_void = null();
            let mut bytes_returned = 0u32;
            if WSAIoctl(
                fd as usize,
                SIO_GET_EXTENSION_FUNCTION_POINTER,
                transmute(&WSAID_CONNECTEX),
                size_of::<GUID>() as u32,
                transmute(&connectex),
                size_of::<*mut c_void>() as u32,
                &mut bytes_returned as *mut u32,
                null_mut(),
                None,
            ) == SOCKET_ERROR
            {
                return Err(Error::last_os_error());
            }

            Ok(transmute(connectex))
        })
    }
    fn poll_accept<'cx>(
        mut self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
        conn_fd: &'cx mut Option<RawFd>,
        remote: &'cx mut Option<SocketAddr>,
        timeout: Option<std::time::Duration>,
    ) -> std::task::Poll<Result<usize>> {
        let fd = self.to_raw_fd();

        log::debug!("poll_accept({:?})", fd);

        if let Some(event) = self.reactor.poll_io_event(fd, EventName::Accept)? {
            match event.message? {
                EventMessage::Accept(remote_fd, addr) => {
                    *remote = addr;
                    *conn_fd = Some(remote_fd);

                    log::debug!("acceptor({:?}) accept({:?})", fd, remote_fd);

                    return Poll::Ready(Ok(0));
                }
                _ => {
                    panic!("Inner error")
                }
            }
        }

        log::debug!("poll_accept({:?}) poll_io_event", fd);

        let accept_socket = Self::tcp(self.ip_v4)?;

        let overlapped = ReactorOverlapped::new_raw(fd, EventName::Accept);

        let mut bytes_received = 0u32;

        self.reactor
            .once(fd, EventName::Accept, cx.waker().clone(), timeout);

        unsafe {
            (*overlapped).accept_fd = accept_socket;

            let ret = AcceptEx(
                fd as usize,
                accept_socket as usize,
                (*overlapped).addrs.as_mut_ptr() as *mut winapi::ctypes::c_void,
                0,
                (*overlapped).addr_len as u32,
                (*overlapped).addr_len as u32,
                &mut bytes_received,
                overlapped as *mut OVERLAPPED,
            );

            log::trace!("socket({:?}) accept({})", fd, ret);

            if ret > 0 {
                // obtain point ownership
                // let overlapped: Box<ReactorOverlapped> = overlapped.into();

                // let remote_addr = OsSocketAddr::copy_from_raw(
                //     overlapped.addrs[16..].as_ptr() as *const SOCKADDR,
                //     16,
                // );

                // *remote = remote_addr.into();
                // *conn_fd = Some(accept_socket);

                // return Poll::Ready(Ok(0));

                return Poll::Pending;
            } else {
                let e = WSAGetLastError();

                // This operation will completing Asynchronously
                if e == ERROR_IO_PENDING as i32 {
                    log::trace!("socket({:?}) accept asynchronously", fd);

                    return Poll::Pending;
                }

                log::error!("WSA error {}", e);

                self.reactor.remove_once(fd, EventName::Accept);

                // Release overlapped
                let _: Box<ReactorOverlapped> = overlapped.into();

                return Poll::Ready(Err(Error::last_os_error()));
            }
        }
    }

    fn poll_read_datagram<'cx>(
        mut self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
        buff: &'cx mut [u8],
        remote: &'cx mut Option<SocketAddr>,
        timeout: Option<std::time::Duration>,
    ) -> std::task::Poll<Result<usize>> {
        let fd = self.to_raw_fd();

        if let Some(event) = self.reactor.poll_io_event(fd, EventName::RecvFrom)? {
            match event.message? {
                EventMessage::RecvFrom(len, addr) => {
                    *remote = addr;

                    return Poll::Ready(Ok(len));
                }
                _ => {
                    panic!("Inner error")
                }
            }
        }

        let overlapped = ReactorOverlapped::new_raw(fd, EventName::RecvFrom);

        self.reactor
            .once(fd, EventName::RecvFrom, cx.waker().clone(), timeout);

        unsafe {
            (*overlapped).buff[0].buf = buff.as_mut_ptr() as *mut i8;

            (*overlapped).buff[0].len = buff.len() as u32;

            let mut bytes_received = 0u32;

            let mut flag = 0u32;

            let ret = WSARecvFrom(
                fd as usize,
                (*overlapped).buff.as_mut_ptr() as *mut WSABUF,
                1,
                &mut bytes_received,
                &mut flag,
                (*overlapped).addrs.as_mut_ptr() as *mut SOCKADDR,
                &mut (*overlapped).addr_len,
                overlapped as *mut OVERLAPPED,
                None,
            );

            //  operation has completed immediately
            if ret == 0 {
                return Poll::Pending;
            } else {
                let e = WSAGetLastError();

                if WSA_IO_PENDING == e {
                    return Poll::Pending;
                }

                self.reactor.remove_once(fd, EventName::RecvFrom);

                // Release overlapped
                let _: Box<ReactorOverlapped> = overlapped.into();

                return Poll::Ready(Err(Error::last_os_error()));
            }
        }
    }

    fn poll_read_stream<'cx>(
        mut self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
        buff: &'cx mut [u8],
        timeout: Option<std::time::Duration>,
    ) -> std::task::Poll<Result<usize>> {
        let fd = self.to_raw_fd();

        if let Some(event) = self.reactor.poll_io_event(fd, EventName::Read)? {
            match event.message? {
                EventMessage::Read(len) => {
                    return Poll::Ready(Ok(len));
                }
                _ => {
                    panic!("Inner error")
                }
            }
        }

        let overlapped = ReactorOverlapped::new_raw(fd, EventName::Read);

        log::trace!("socket({:?}) recv({})", fd, buff.len(),);

        let mut flag = 0u32;

        self.reactor
            .once(fd, EventName::Read, cx.waker().clone(), timeout);

        unsafe {
            (*overlapped).buff[0].buf = buff.as_ptr() as *mut i8;

            (*overlapped).buff[0].len = buff.len() as u32;

            let mut bytes_received = 0u32;

            let ret = WSARecv(
                fd as usize,
                &mut (*overlapped).buff as *mut WSABUF,
                1,
                &mut bytes_received,
                &mut flag,
                overlapped as *mut OVERLAPPED,
                None,
            );

            log::trace!("socket({:?}) recv({}) result({})", fd, buff.len(), ret);

            //  operation has completed immediately
            if ret == 0 {
                return Poll::Pending;
            } else {
                let e = WSAGetLastError();

                if WSA_IO_PENDING == e {
                    return Poll::Pending;
                }

                self.reactor.remove_once(fd, EventName::Read);

                // Release overlapped
                let _: Box<ReactorOverlapped> = overlapped.into();

                return Poll::Ready(Err(Error::last_os_error()));
            }
        }
    }

    fn poll_write_datagram<'cx>(
        mut self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
        buff: &'cx [u8],
        remote: &'cx SocketAddr,
        timeout: Option<std::time::Duration>,
    ) -> std::task::Poll<Result<usize>> {
        let fd = self.to_raw_fd();

        if let Some(event) = self.reactor.poll_io_event(fd, EventName::SendTo)? {
            match event.message? {
                EventMessage::SendTo(len) => {
                    return Poll::Ready(Ok(len));
                }
                _ => {
                    panic!("Inner error")
                }
            }
        }

        let overlapped = ReactorOverlapped::new_raw(fd, EventName::SendTo);

        let addr = OsSocketAddr::from(remote.clone());

        unsafe {
            (*overlapped).buff[0].buf = buff.as_ptr() as *mut i8;

            (*overlapped).buff[0].len = buff.len() as u32;

            let mut bytes_received = 0u32;

            self.reactor
                .once(fd, EventName::SendTo, cx.waker().clone(), timeout);

            let ret = WSASendTo(
                fd as usize,
                (*overlapped).buff.as_mut_ptr() as *mut WSABUF,
                1,
                &mut bytes_received,
                0,
                addr.as_ptr() as *mut SOCKADDR,
                addr.len(),
                overlapped as *mut OVERLAPPED,
                None,
            );

            //  operation has completed immediately
            if ret == 0 {
                return Poll::Pending;
            } else {
                let e = WSAGetLastError();

                if WSA_IO_PENDING == e {
                    return Poll::Pending;
                }

                self.reactor.remove_once(fd, EventName::SendTo);

                // Release overlapped
                let _: Box<ReactorOverlapped> = overlapped.into();

                return Poll::Ready(Err(Error::last_os_error()));
            }
        }
    }

    fn poll_write_stream<'cx>(
        mut self: std::pin::Pin<&mut Self>,
        cx: &std::task::Context<'_>,
        buff: &'cx [u8],
        timeout: Option<std::time::Duration>,
    ) -> std::task::Poll<Result<usize>> {
        let fd = self.to_raw_fd();

        if let Some(event) = self.reactor.poll_io_event(fd, EventName::Write)? {
            match event.message? {
                EventMessage::Write(len) => {
                    return Poll::Ready(Ok(len));
                }
                _ => {
                    panic!("Inner error")
                }
            }
        }

        let overlapped = ReactorOverlapped::new_raw(fd, EventName::Write);

        log::trace!("socket({:?}) send({})", fd, buff.len());

        unsafe {
            (*overlapped).buff[0].buf = buff.as_ptr() as *mut i8;

            (*overlapped).buff[0].len = buff.len() as u32;

            let mut bytes_received = 0u32;

            self.reactor
                .once(fd, EventName::Write, cx.waker().clone(), timeout);

            let ret = WSASend(
                fd as usize,
                (*overlapped).buff.as_mut_ptr() as *mut WSABUF,
                1,
                &mut bytes_received,
                0,
                overlapped as *mut OVERLAPPED,
                None,
            );

            log::trace!("socket({:?}) send({}) result({})", fd, buff.len(), ret);

            //  operation has completed immediately
            if ret == 0 {
                return Poll::Pending;
            } else {
                let e = WSAGetLastError();

                if WSA_IO_PENDING == e {
                    return Poll::Pending;
                }

                self.reactor.remove_once(fd, EventName::Write);

                // Release overlapped
                let _: Box<ReactorOverlapped> = overlapped.into();

                return Poll::Ready(Err(Error::last_os_error()));
            }
        }
    }
}