compio 0.19.1

Completion based async runtime
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
use std::{
    net::Ipv4Addr,
    time::{Duration, Instant},
};

use criterion::{Bencher, Criterion, Throughput, criterion_group, criterion_main};
use rand::{Rng, rng};

#[cfg(all(target_os = "linux", target_env = "gnu"))]
mod monoio_wrap;
#[cfg(all(target_os = "linux", target_env = "gnu"))]
use monoio_wrap::MonoioRuntime;

#[cfg(feature = "compat")]
mod compat;
#[cfg(feature = "compat")]
use compat::*;

criterion_group!(net, echo);
criterion_main!(net);

const BUFFER_SIZE: usize = 524288;
const BUFFER_COUNT: usize = 8;

async fn echo_tokio_impl<T, R>(
    mut tx: T,
    mut rx: R,
    content: &[u8],
    client_buffer: &mut [u8],
    server_buffer: &mut [u8],
) where
    T: tokio::io::AsyncRead + tokio::io::AsyncWrite + Unpin,
    R: tokio::io::AsyncRead + tokio::io::AsyncWrite + Unpin,
{
    use tokio::io::{AsyncReadExt, AsyncWriteExt};

    let client = async move {
        for _i in 0..BUFFER_COUNT {
            tx.write_all(content).await.unwrap();
            tx.read_exact(client_buffer).await.unwrap();
        }
    };
    let server = async move {
        for _i in 0..BUFFER_COUNT {
            rx.read_exact(server_buffer).await.unwrap();
            rx.write_all(server_buffer).await.unwrap();
        }
    };
    tokio::join!(client, server);
}

async fn echo_compio_impl<T, R>(
    mut tx: T,
    mut rx: R,
    mut content: Vec<u8>,
    mut client_buffer: Vec<u8>,
    mut server_buffer: Vec<u8>,
) -> (Vec<u8>, Vec<u8>, Vec<u8>)
where
    T: compio::io::AsyncRead + compio::io::AsyncWrite,
    R: compio::io::AsyncRead + compio::io::AsyncWrite,
{
    use compio::io::{AsyncReadExt, AsyncWriteExt};

    let client = async move {
        for _i in 0..BUFFER_COUNT {
            (_, content) = tx.write_all(content).await.unwrap();
            (_, client_buffer) = tx.read_exact(client_buffer).await.unwrap();
        }
        (content, client_buffer)
    };
    let server = async move {
        for _i in 0..BUFFER_COUNT {
            (_, server_buffer) = rx.read_exact(server_buffer).await.unwrap();
            (_, server_buffer) = rx.write_all(server_buffer).await.unwrap();
        }
        server_buffer
    };
    let ((content, client_buffer), server_buffer) = futures_util::join!(client, server);
    (content, client_buffer, server_buffer)
}

#[cfg(all(target_os = "linux", target_env = "gnu"))]
async fn echo_monoio_impl<T, R>(
    mut tx: T,
    mut rx: R,
    mut content: Vec<u8>,
    mut client_buffer: Vec<u8>,
    mut server_buffer: Vec<u8>,
) -> (Vec<u8>, Vec<u8>, Vec<u8>)
where
    T: monoio::io::AsyncReadRent + monoio::io::AsyncWriteRent,
    R: monoio::io::AsyncReadRent + monoio::io::AsyncWriteRent,
{
    use monoio::io::{AsyncReadRentExt, AsyncWriteRentExt};

    let client = async {
        let mut res;
        for _i in 0..BUFFER_COUNT {
            (res, content) = tx.write_all(content).await;
            res.unwrap();
            (res, client_buffer) = tx.read_exact(client_buffer).await;
            res.unwrap();
        }
        (content, client_buffer)
    };
    let server = async move {
        let mut res;
        for _i in 0..BUFFER_COUNT {
            (res, server_buffer) = rx.read_exact(server_buffer).await;
            res.unwrap();
            (res, server_buffer) = rx.write_all(server_buffer).await;
            res.unwrap();
        }
        server_buffer
    };
    let ((content, client_buffer), server_buffer) = futures_util::join!(client, server);
    (content, client_buffer, server_buffer)
}

fn echo_tokio_tcp(b: &mut Bencher, content: &[u8]) {
    use tokio::net::{TcpListener, TcpStream};

    let runtime = tokio::runtime::Builder::new_current_thread()
        .enable_all()
        .build()
        .unwrap();
    b.to_async(&runtime).iter_custom(|iter| async move {
        let listener = TcpListener::bind((Ipv4Addr::LOCALHOST, 0)).await.unwrap();
        let addr = listener.local_addr().unwrap();

        let mut client_buffer = vec![0u8; BUFFER_SIZE];
        let mut server_buffer = vec![0u8; BUFFER_SIZE];

        let start = Instant::now();
        for _i in 0..iter {
            let (tx, (rx, _)) =
                tokio::try_join!(TcpStream::connect(addr), listener.accept()).unwrap();
            echo_tokio_impl(tx, rx, content, &mut client_buffer, &mut server_buffer).await;
        }
        start.elapsed()
    })
}

async fn echo_compio_tcp_impl(iter: u64, mut content: Vec<u8>) -> Duration {
    use compio::net::{TcpListener, TcpStream};

    let listener = TcpListener::bind((Ipv4Addr::LOCALHOST, 0)).await.unwrap();
    let addr = listener.local_addr().unwrap();

    let mut client_buffer = vec![0u8; BUFFER_SIZE];
    let mut server_buffer = vec![0u8; BUFFER_SIZE];

    let start = Instant::now();
    for _i in 0..iter {
        let (tx, (rx, _)) =
            futures_util::try_join!(TcpStream::connect(addr), listener.accept()).unwrap();
        (content, client_buffer, server_buffer) =
            echo_compio_impl(tx, rx, content, client_buffer, server_buffer).await;
    }
    start.elapsed()
}

fn echo_compio_tcp(b: &mut Bencher, content: Vec<u8>) {
    let runtime = compio::runtime::Runtime::new().unwrap();
    b.to_async(&runtime)
        .iter_custom(|iter| echo_compio_tcp_impl(iter, content.clone()))
}

#[cfg(feature = "compat-tokio")]
fn echo_compio_in_tokio_tcp(b: &mut Bencher, content: Vec<u8>) {
    let runtime = CompioInTokio::default();
    b.to_async(&runtime)
        .iter_custom(|iter| echo_compio_tcp_impl(iter, content.clone()))
}

#[cfg(feature = "compat-futures")]
fn echo_compio_in_futures_tcp(b: &mut Bencher, content: Vec<u8>) {
    let runtime = CompioInFutures::default();
    b.to_async(&runtime)
        .iter_custom(|iter| echo_compio_tcp_impl(iter, content.clone()))
}

#[cfg(all(target_os = "linux", target_env = "gnu"))]
fn echo_monoio_tcp(b: &mut Bencher, content: Vec<u8>) {
    use monoio::net::{TcpListener, TcpStream};

    let runtime = MonoioRuntime::new();
    b.to_async(&runtime).iter_custom(|iter| {
        let mut content = content.clone();
        async move {
            let listener = TcpListener::bind((Ipv4Addr::LOCALHOST, 0)).unwrap();
            let addr = listener.local_addr().unwrap();

            let mut client_buffer = vec![0u8; BUFFER_SIZE];
            let mut server_buffer = vec![0u8; BUFFER_SIZE];

            let start = Instant::now();
            for _i in 0..iter {
                let (tx, (rx, _)) =
                    futures_util::try_join!(TcpStream::connect(addr), listener.accept()).unwrap();
                (content, client_buffer, server_buffer) =
                    echo_monoio_impl(tx, rx, content, client_buffer, server_buffer).await;
            }
            start.elapsed()
        }
    })
}

#[cfg(windows)]
fn echo_tokio_win_named_pipe(b: &mut Bencher, content: &[u8]) {
    use tokio::net::windows::named_pipe::{ClientOptions, ServerOptions};

    let runtime = tokio::runtime::Builder::new_current_thread()
        .enable_all()
        .build()
        .unwrap();
    b.to_async(&runtime).iter_custom(|iter| async move {
        const PIPE_NAME: &str = r"\\.\pipe\tokio-named-pipe";

        let mut client_buffer = vec![0u8; BUFFER_SIZE];
        let mut server_buffer = vec![0u8; BUFFER_SIZE];

        let start = Instant::now();
        for _i in 0..iter {
            let rx = ServerOptions::new().create(PIPE_NAME).unwrap();
            let tx = ClientOptions::new().open(PIPE_NAME).unwrap();

            rx.connect().await.unwrap();

            echo_tokio_impl(tx, rx, content, &mut client_buffer, &mut server_buffer).await;
        }
        start.elapsed()
    })
}

#[cfg(windows)]
fn echo_compio_win_named_pipe(b: &mut Bencher, content: Vec<u8>) {
    use compio::fs::named_pipe::{ClientOptions, ServerOptions};

    let runtime = compio::runtime::Runtime::new().unwrap();
    b.to_async(&runtime).iter_custom(|iter| {
        let mut content = content.clone();
        async move {
            const PIPE_NAME: &str = r"\\.\pipe\compio-named-pipe";

            let mut client_buffer = vec![0u8; BUFFER_SIZE];
            let mut server_buffer = vec![0u8; BUFFER_SIZE];

            let start = Instant::now();
            let options = ClientOptions::new();
            for _i in 0..iter {
                let rx = ServerOptions::new().create(PIPE_NAME).unwrap();
                let (tx, ()) =
                    futures_util::try_join!(options.open(PIPE_NAME), rx.connect()).unwrap();
                (content, client_buffer, server_buffer) =
                    echo_compio_impl(tx, rx, content, client_buffer, server_buffer).await;
            }
            start.elapsed()
        }
    })
}

#[cfg(unix)]
fn echo_tokio_unix(b: &mut Bencher, content: &[u8]) {
    use tokio::net::{UnixListener, UnixStream};

    let runtime = tokio::runtime::Builder::new_current_thread()
        .enable_all()
        .build()
        .unwrap();
    b.to_async(&runtime).iter_custom(|iter| async move {
        let dir = tempfile::Builder::new()
            .prefix("tokio-uds")
            .tempdir()
            .unwrap();
        let sock_path = dir.path().join("connect.sock");
        let listener = UnixListener::bind(&sock_path).unwrap();

        let mut client_buffer = vec![0u8; BUFFER_SIZE];
        let mut server_buffer = vec![0u8; BUFFER_SIZE];

        let start = Instant::now();
        for _i in 0..iter {
            let (tx, (rx, _)) =
                tokio::try_join!(UnixStream::connect(&sock_path), listener.accept()).unwrap();
            echo_tokio_impl(tx, rx, content, &mut client_buffer, &mut server_buffer).await;
        }
        start.elapsed()
    })
}

async fn echo_compio_unix_impl(iter: u64, mut content: Vec<u8>) -> Duration {
    use compio::net::{UnixListener, UnixStream};

    let dir = tempfile::Builder::new()
        .prefix("compio-uds")
        .tempdir()
        .unwrap();
    let sock_path = dir.path().join("connect.sock");
    let listener = UnixListener::bind(&sock_path).await.unwrap();

    let mut client_buffer = vec![0u8; BUFFER_SIZE];
    let mut server_buffer = vec![0u8; BUFFER_SIZE];

    let start = Instant::now();
    for _i in 0..iter {
        let (tx, (rx, _)) =
            futures_util::try_join!(UnixStream::connect(&sock_path), listener.accept()).unwrap();
        (content, client_buffer, server_buffer) =
            echo_compio_impl(tx, rx, content, client_buffer, server_buffer).await;
    }
    start.elapsed()
}

fn echo_compio_unix(b: &mut Bencher, content: Vec<u8>) {
    let runtime = compio::runtime::Runtime::new().unwrap();
    b.to_async(&runtime)
        .iter_custom(|iter| echo_compio_unix_impl(iter, content.clone()))
}

#[cfg(feature = "compat-tokio")]
fn echo_compio_in_tokio_unix(b: &mut Bencher, content: Vec<u8>) {
    let runtime = CompioInTokio::default();
    b.to_async(&runtime)
        .iter_custom(|iter| echo_compio_unix_impl(iter, content.clone()))
}

#[cfg(feature = "compat-futures")]
fn echo_compio_in_futures_unix(b: &mut Bencher, content: Vec<u8>) {
    let runtime = CompioInFutures::default();
    b.to_async(&runtime)
        .iter_custom(|iter| echo_compio_unix_impl(iter, content.clone()))
}

#[cfg(all(target_os = "linux", target_env = "gnu"))]
fn echo_monoio_unix(b: &mut Bencher, content: Vec<u8>) {
    use monoio::net::{ListenerOpts, UnixListener, UnixStream};

    let runtime = MonoioRuntime::new();
    b.to_async(&runtime).iter_custom(|iter| {
        let mut content = content.clone();
        async move {
            let dir = tempfile::Builder::new()
                .prefix("monoio-uds")
                .tempdir()
                .unwrap();
            let sock_path = dir.path().join("connect.sock");
            let listener = UnixListener::bind_with_config(
                &sock_path,
                &ListenerOpts::default().reuse_addr(false).reuse_port(false),
            )
            .unwrap();

            let mut client_buffer = vec![0u8; BUFFER_SIZE];
            let mut server_buffer = vec![0u8; BUFFER_SIZE];

            let start = Instant::now();
            for _i in 0..iter {
                let (tx, (rx, _)) =
                    futures_util::try_join!(UnixStream::connect(&sock_path), listener.accept())
                        .unwrap();
                (content, client_buffer, server_buffer) =
                    echo_monoio_impl(tx, rx, content, client_buffer, server_buffer).await;
            }
            start.elapsed()
        }
    })
}

fn echo(c: &mut Criterion) {
    let mut rng = rng();

    let mut content = vec![0u8; BUFFER_SIZE];
    rng.fill_bytes(&mut content);

    let mut group = c.benchmark_group("echo");
    group.throughput(Throughput::Bytes((BUFFER_SIZE * BUFFER_COUNT * 2) as u64));

    group.bench_function("tokio-tcp", |b| echo_tokio_tcp(b, &content));
    group.bench_function("compio-tcp", |b| echo_compio_tcp(b, content.clone()));
    #[cfg(feature = "compat-tokio")]
    group.bench_function("compio-in-tokio-tcp", |b| {
        echo_compio_in_tokio_tcp(b, content.clone())
    });
    #[cfg(feature = "compat-futures")]
    group.bench_function("compio-in-futures-tcp", |b| {
        echo_compio_in_futures_tcp(b, content.clone())
    });
    #[cfg(all(target_os = "linux", target_env = "gnu"))]
    group.bench_function("monoio-tcp", |b| echo_monoio_tcp(b, content.clone()));

    #[cfg(windows)]
    group.bench_function("tokio-pipe", |b| echo_tokio_win_named_pipe(b, &content));
    #[cfg(windows)]
    group.bench_function("compio-pipe", |b| {
        echo_compio_win_named_pipe(b, content.clone())
    });

    #[cfg(unix)]
    group.bench_function("tokio-unix", |b| echo_tokio_unix(b, &content));
    group.bench_function("compio-unix", |b| echo_compio_unix(b, content.clone()));
    #[cfg(feature = "compat-tokio")]
    group.bench_function("compio-in-tokio-unix", |b| {
        echo_compio_in_tokio_unix(b, content.clone())
    });
    #[cfg(feature = "compat-futures")]
    group.bench_function("compio-in-futures-unix", |b| {
        echo_compio_in_futures_unix(b, content.clone())
    });
    #[cfg(all(target_os = "linux", target_env = "gnu"))]
    group.bench_function("monoio-unix", |b| echo_monoio_unix(b, content.clone()));

    group.finish();
}