orengine 0.7.0-alpha.1

Optimized ring engine for Rust. It is a lighter and faster asynchronous library than tokio-rs, async-std, may, and even smol.
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
use std::fmt::{Debug, Formatter};
use std::io::Result;
use std::mem::ManuallyDrop;
use std::net::SocketAddr;

use socket2::{SockAddr, SockRef};

use crate::io::recv_from::AsyncRecvFrom;
use crate::io::sys::{AsFd, AsRawFd, BorrowedFd, FromRawFd, IntoRawFd, OwnedFd, RawFd};
use crate::io::{
    AsyncBind, AsyncClose, AsyncConnectDatagram, AsyncPeekFrom, AsyncPollFd, AsyncSendTo,
};
use crate::net::creators_of_sockets::new_udp_socket;
use crate::net::udp::connected_socket::UdpConnectedSocket;
use crate::net::BindConfig;
use crate::net::{Datagram, Socket};
use crate::runtime::local_executor;

/// A UDP socket.
///
/// After creating a `UdpSocket` by [`bind`](UdpSocket::bind)ing it to a socket address, data can be
/// [sent to](AsyncSendTo) and [received from](AsyncRecvFrom) any other socket address.
///
/// Although UDP is a connectionless protocol, this implementation provides an interface
/// to set an address where data should be sent and received from.
/// [`UdpSocket::connect`](AsyncConnectDatagram)
/// returns [`UdpConnectedSocket`] which implements
/// [`ConnectedDatagram`](crate::net::connected_datagram::ConnectedDatagram),
/// [`AsyncRecv`](crate::io::AsyncRecv), [`AsyncPeek`](crate::io::AsyncPeek),
/// [`AsyncSend`](crate::io::AsyncSend).
///
/// # Examples
///
/// ## Usage without [`connect`](AsyncConnectDatagram)
///
/// ```rust
/// use orengine::net::UdpSocket;
/// use orengine::io::{full_buffer, AsyncBind, AsyncPollFd, AsyncRecvFrom, AsyncSendTo};
///
/// # async fn foo() {
/// let mut socket = UdpSocket::bind("127.0.0.1:8081").await.unwrap();
/// loop {
///    socket.poll_recv().await.expect("poll failed");
///    let mut buf = full_buffer();
///    let (n, addr) = socket.recv_from(&mut buf).await.expect("recv_from failed");
///    if n == 0 {
///        continue;
///    }
///
///    socket.send_to(&buf[..n], addr).await.expect("send_to failed");
/// }
/// # }
/// ```
///
/// ## Usage with [`connect`](AsyncConnectDatagram)
///
/// ```rust
/// use orengine::io::{full_buffer, AsyncBind, AsyncConnectDatagram, AsyncPollFd, AsyncRecv, AsyncSend};
/// use orengine::net::UdpSocket;
///
/// # async fn foo() {
/// let socket = UdpSocket::bind("127.0.0.1:8081").await.unwrap();
/// let mut connected_socket = socket.connect("127.0.0.1:8080").await.unwrap();
/// loop {
///    connected_socket.poll_recv().await.expect("poll failed");
///    let mut buf = full_buffer();
///    let n = connected_socket.recv(&mut buf).await.expect("recv_from failed");
///    if n == 0 {
///        break;
///    }
///
///    connected_socket.send(&buf.slice(..n)).await.expect("send_to failed");
/// }
/// # }
/// ```
pub struct UdpSocket {
    fd: RawFd,
}

impl From<UdpSocket> for std::net::UdpSocket {
    fn from(socket: UdpSocket) -> Self {
        unsafe { Self::from_raw_fd(ManuallyDrop::new(socket).fd) }
    }
}

impl From<std::net::UdpSocket> for UdpSocket {
    fn from(stream: std::net::UdpSocket) -> Self {
        Self {
            fd: stream.into_raw_fd(),
        }
    }
}

impl IntoRawFd for UdpSocket {
    fn into_raw_fd(self) -> RawFd {
        ManuallyDrop::new(self).fd
    }
}

impl FromRawFd for UdpSocket {
    unsafe fn from_raw_fd(fd: RawFd) -> Self {
        Self { fd }
    }
}

impl AsFd for UdpSocket {
    fn as_fd(&self) -> BorrowedFd<'_> {
        unsafe { BorrowedFd::borrow_raw(self.fd) }
    }
}

impl AsRawFd for UdpSocket {
    #[inline(always)]
    fn as_raw_fd(&self) -> RawFd {
        self.fd
    }
}

impl From<OwnedFd> for UdpSocket {
    fn from(fd: OwnedFd) -> Self {
        unsafe { Self::from_raw_fd(fd.into_raw_fd()) }
    }
}

impl From<UdpSocket> for OwnedFd {
    fn from(socket: UdpSocket) -> Self {
        unsafe { Self::from_raw_fd(socket.into_raw_fd()) }
    }
}

impl AsyncBind for UdpSocket {
    async fn new_socket(addr: &SocketAddr) -> Result<RawFd> {
        new_udp_socket(addr).await
    }

    fn bind_and_listen_if_needed(
        sock_ref: SockRef<'_>,
        addr: SocketAddr,
        _config: &BindConfig,
    ) -> Result<()> {
        sock_ref.bind(&SockAddr::from(addr))
    }
}

impl AsyncConnectDatagram<UdpConnectedSocket> for UdpSocket {}

impl AsyncPollFd for UdpSocket {}

impl AsyncRecvFrom for UdpSocket {}

impl AsyncPeekFrom for UdpSocket {}

impl AsyncSendTo for UdpSocket {}

impl AsyncClose for UdpSocket {}

impl Socket for UdpSocket {}

impl Datagram for UdpSocket {
    type ConnectedDatagram = UdpConnectedSocket;
}

impl Debug for UdpSocket {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let mut res = f.debug_struct("UdpSocket");

        if let Ok(addr) = self.local_addr() {
            res.field("local addr", &addr);
        }

        let name = if cfg!(windows) { "socket" } else { "fd" };
        res.field(name, &self.as_raw_fd()).finish()
    }
}

impl Drop for UdpSocket {
    fn drop(&mut self) {
        let close_future = self.close();
        local_executor().exec_local_future(async {
            close_future.await.expect("Failed to close UDP socket");
        });
    }
}

#[cfg(test)]
mod tests {
    use std::net::SocketAddr;
    use std::rc::Rc;
    use std::str::FromStr;
    use std::sync::{Arc, Mutex};
    use std::time::Duration;
    use std::{io, thread};

    use super::*;
    use crate as orengine;
    use crate::io::{AsyncBind, AsyncRecv, AsyncSend};
    use crate::net::ReusePort;
    use crate::runtime::local_executor;
    use crate::sync::{AsyncCondVar, AsyncMutex, LocalCondVar, LocalMutex};
    use crate::yield_now;

    const REQUEST: &[u8] = b"GET / HTTP/1.1\r\n\r\n";
    const RESPONSE: &[u8] = b"HTTP/1.1 200 OK\r\n\r\n";
    const TIMES: usize = 20;

    #[orengine::test::test_local]
    fn test_udp_client() {
        const SERVER_ADDR: &str = "127.0.0.1:10086";

        let is_server_ready = Arc::new((Mutex::new(false), std::sync::Condvar::new()));
        let is_server_ready_server_clone = is_server_ready.clone();

        let server_thread = thread::spawn(move || {
            let socket = std::net::UdpSocket::bind(SERVER_ADDR).expect("std bind failed");

            {
                let (is_ready_mu, condvar) = &*is_server_ready;
                let mut is_ready = is_ready_mu.lock().unwrap();
                *is_ready = true;
                drop(is_ready);
                condvar.notify_one();
            }

            let mut buf = vec![0u8; REQUEST.len()];

            for _ in 0..TIMES {
                let (n, src) = socket.recv_from(&mut buf).expect("accept failed");
                assert_eq!(REQUEST, &buf[..n]);

                socket.send_to(RESPONSE, src).expect("std write failed");
            }
        });

        {
            let (is_server_ready_mu, condvar) = &*is_server_ready_server_clone;

            loop {
                let is_server_ready = is_server_ready_mu.lock().expect("lock failed");
                if *is_server_ready {
                    drop(is_server_ready);
                    break;
                }

                let _unused = condvar.wait(is_server_ready).expect("wait failed");
            }
        }

        let mut stream = UdpSocket::bind("127.0.0.1:9081")
            .await
            .expect("bind failed");

        for _ in 0..TIMES {
            stream
                .send_to(REQUEST, SERVER_ADDR)
                .await
                .expect("send failed");
            let mut buf = vec![0u8; RESPONSE.len()];

            stream.recv_from(&mut buf).await.expect("recv failed");
            assert_eq!(RESPONSE, buf);
        }

        server_thread.join().expect("server thread join failed");
    }

    #[allow(clippy::future_not_send, reason = "It is a test")]
    async fn test_server_with_config(
        server_addr_str: String,
        client_addr_str: String,
        config: BindConfig,
    ) {
        let is_server_ready = Rc::new((LocalMutex::new(false), LocalCondVar::new()));
        let is_server_ready_clone = is_server_ready.clone();
        let addr_clone = server_addr_str.clone();

        local_executor().spawn_local(async move {
            let mut server = UdpSocket::bind_with_config(addr_clone, &config)
                .await
                .expect("bind failed");

            *is_server_ready_clone.0.lock().await = true;
            is_server_ready_clone.1.notify_one();

            for _ in 0..TIMES {
                server
                    .poll_recv_with_timeout(Duration::from_secs(10))
                    .await
                    .expect("poll failed");
                let mut buf = vec![0u8; REQUEST.len()];
                let (n, src) = server
                    .recv_from_with_timeout(&mut buf, Duration::from_secs(10))
                    .await
                    .expect("accept failed");
                assert_eq!(REQUEST, &buf[..n]);

                server
                    .send_to_with_timeout(RESPONSE, &src, Duration::from_secs(10))
                    .await
                    .expect("send failed");
            }
        });

        let mut is_server_ready_guard = is_server_ready.0.lock().await;
        while !*is_server_ready_guard {
            is_server_ready_guard = is_server_ready.1.wait(is_server_ready_guard).await;
        }

        let mut socket = UdpSocket::bind(client_addr_str)
            .await
            .expect("connect failed")
            .connect_with_timeout(server_addr_str, Duration::from_secs(10))
            .await
            .expect("connect failed");

        for _ in 0..TIMES {
            socket
                .send_bytes_with_timeout(REQUEST, Duration::from_secs(10))
                .await
                .expect("send failed");

            let mut buf = vec![0u8; RESPONSE.len()];
            socket
                .recv_bytes_with_timeout(&mut buf, Duration::from_secs(10))
                .await
                .expect("recv failed");
        }

        yield_now().await;
        thread::yield_now();
    }

    #[orengine::test::test_local]
    fn test_server_without_reuse_port() {
        let config = BindConfig::default();
        test_server_with_config(
            "127.0.0.1:10037".to_string(),
            "127.0.0.1:9082".to_string(),
            config.reuse_port(ReusePort::Disabled),
        )
        .await;
    }

    #[orengine::test::test_local]
    fn test_server_with_default_reuse_port() {
        let config = BindConfig::default();
        test_server_with_config(
            "127.0.0.1:10038".to_string(),
            "127.0.0.1:9083".to_string(),
            config.reuse_port(ReusePort::Default),
        )
        .await;
    }

    #[orengine::test::test_local]
    fn test_server_with_cpu_reuse_port() {
        let config = BindConfig::default();
        test_server_with_config(
            "127.0.0.1:10039".to_string(),
            "127.0.0.1:9084".to_string(),
            config.reuse_port(ReusePort::CPU),
        )
        .await;
    }

    #[orengine::test::test_local]
    fn test_socket() {
        const SERVER_ADDR: &str = "127.0.0.1:10090";
        const CLIENT_ADDR: &str = "127.0.0.1:10091";
        const TIMEOUT: Duration = Duration::from_secs(3);

        let is_server_ready = Rc::new((LocalMutex::new(false), LocalCondVar::new()));
        let is_server_ready_server_clone = is_server_ready.clone();

        local_executor().exec_local_future(async move {
            let mut server = UdpSocket::bind(SERVER_ADDR).await.expect("bind failed");

            {
                let (is_ready_mu, condvar) = &*is_server_ready;
                let mut is_ready = is_ready_mu.lock().await;
                *is_ready = true;
                condvar.notify_one();
            }

            for _ in 0..TIMES {
                server
                    .poll_recv_with_timeout(TIMEOUT)
                    .await
                    .expect("poll failed");
                let mut buf = vec![0u8; REQUEST.len()];
                let (n, src) = server
                    .recv_from_with_timeout(&mut buf, TIMEOUT)
                    .await
                    .expect("accept failed");
                assert_eq!(REQUEST, &buf[..n]);

                server
                    .send_to_with_timeout(RESPONSE, &src, TIMEOUT)
                    .await
                    .expect("send failed");
            }
        });

        {
            let (is_server_ready_mu, condvar) = &*is_server_ready_server_clone;
            let mut is_server_ready = is_server_ready_mu.lock().await;
            while !(*is_server_ready) {
                is_server_ready = condvar.wait(is_server_ready).await;
            }
        }

        let mut stream = UdpSocket::bind(CLIENT_ADDR).await.expect("bind failed");

        assert_eq!(
            stream.local_addr().expect("Failed to get local addr"),
            SocketAddr::from_str(CLIENT_ADDR).unwrap()
        );

        stream
            .set_broadcast(false)
            .expect("Failed to set broadcast");
        assert!(!stream.broadcast().expect("Failed to get broadcast"));
        stream.set_broadcast(true).expect("Failed to set broadcast");
        assert!(stream.broadcast().expect("Failed to get broadcast"));

        stream
            .set_multicast_loop_v4(false)
            .expect("Failed to set multicast_loop_v4");
        assert!(!stream
            .multicast_loop_v4()
            .expect("Failed to get multicast_loop_v4"));
        stream
            .set_multicast_loop_v4(true)
            .expect("Failed to set multicast_loop_v4");
        assert!(stream
            .multicast_loop_v4()
            .expect("Failed to get multicast_loop_v4"));

        stream
            .set_multicast_ttl_v4(124)
            .expect("Failed to set multicast_ttl_v4");
        assert_eq!(
            stream
                .multicast_ttl_v4()
                .expect("Failed to get multicast_ttl_v4"),
            124
        );

        stream.set_ttl(144).expect("Failed to set ttl");
        assert_eq!(stream.ttl().expect("Failed to get ttl"), 144);

        match stream.take_error() {
            Ok(err_) => {
                if let Some(err) = err_ {
                    panic!("Take error returned with an error: {err:?}")
                }
            }
            Err(err) => panic!("Take error failed: {err:?}"),
        }

        for _ in 0..TIMES {
            stream
                .send_to_with_timeout(REQUEST, SERVER_ADDR, TIMEOUT)
                .await
                .expect("send failed");

            stream
                .poll_recv_with_timeout(TIMEOUT)
                .await
                .expect("poll failed");
            let mut buf = vec![0u8; RESPONSE.len()];

            stream
                .peek_from_with_timeout(&mut buf, TIMEOUT)
                .await
                .expect("peek failed");
            stream
                .peek_from_with_timeout(&mut buf, TIMEOUT)
                .await
                .expect("peek failed");

            stream
                .poll_recv_with_timeout(TIMEOUT)
                .await
                .expect("poll failed");
            stream
                .recv_from_with_timeout(&mut buf, TIMEOUT)
                .await
                .expect("recv failed");
        }
    }

    #[orengine::test::test_local]
    fn test_timeout() {
        const ADDR: &str = "127.0.0.1:10141";
        const TIMEOUT: Duration = Duration::from_micros(1);

        let mut socket = UdpSocket::bind(ADDR).await.expect("bind failed");

        match socket.poll_recv_with_timeout(TIMEOUT).await {
            Ok(()) => panic!("poll_recv should timeout"),
            Err(err) => assert_eq!(err.kind(), io::ErrorKind::TimedOut),
        }

        match socket.recv_from_with_timeout(&mut [0u8; 10], TIMEOUT).await {
            Ok(_) => panic!("recv_from should timeout"),
            Err(err) => assert_eq!(err.kind(), io::ErrorKind::TimedOut, "{err}"),
        }

        match socket.peek_from_with_timeout(&mut [0u8; 10], TIMEOUT).await {
            Ok(_) => panic!("peek_from should timeout"),
            Err(err) => assert_eq!(err.kind(), io::ErrorKind::TimedOut, "{err}"),
        }
    }
}