mtorrent-core 0.5.4

Fundamentals for building asynchronous BitTorrent clients
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
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
use bytes::{Bytes, BytesMut};
use futures_util::StreamExt;
use local_async_utils::prelude::*;
use log::log_enabled;
use mtorrent_utils::loop_select::loop_select;
use std::collections::hash_map::{Entry, HashMap};
use std::io;
use std::mem::MaybeUninit;
use std::net::SocketAddr;
use std::ops::ControlFlow;
use std::task::{Context, Poll, ready};
use tokio::io::ReadBuf;
use tokio::net::UdpSocket;
use tokio::sync::mpsc;
use tokio::time::Instant;

pub(super) enum Command {
    AddConnection((SocketAddr, ConnectionHandle)),
    ResetConnections,
}

pub(super) struct ConnectionHandle {
    egress: local_bounded::Receiver<Bytes>,
    ingress: local_bounded::Sender<Bytes>,
}

impl ConnectionHandle {
    pub(super) fn new(
        egress: local_bounded::Receiver<Bytes>,
        ingress: local_bounded::Sender<Bytes>,
    ) -> Self {
        Self { egress, ingress }
    }
}

const MAX_UDP_PACKET_SIZE: usize = 65536;

fn is_transient_error(e: &io::ErrorKind) -> bool {
    use io::ErrorKind::*;
    matches!(
        e,
        ConnectionRefused
            | ConnectionReset
            | HostUnreachable
            | NetworkUnreachable
            | ConnectionAborted
    )
}

/// Actor that handles network I/O. Routes incoming and outgoing packets
/// between the UDP socket and the upstream layer (connection).
pub struct IoDriver {
    commands: mpsc::Receiver<Command>,
    socket: UdpSocket,
    connections: HashMap<SocketAddr, ConnectionHandle>,
    pending_tx: Vec<(SocketAddr, Bytes)>,
    rx_buffer: Box<[MaybeUninit<u8>]>,
    new_source_reporter: local_bounded::Sender<(SocketAddr, Bytes)>,
    reset_in_progress: bool,
    dropped_packets: u64,
}

impl IoDriver {
    pub(super) fn new(
        command_receiver: mpsc::Receiver<Command>,
        socket: UdpSocket,
        new_source_reporter: local_bounded::Sender<(SocketAddr, Bytes)>,
    ) -> Self {
        Self {
            commands: command_receiver,
            socket,
            connections: HashMap::new(),
            pending_tx: Vec::new(),
            rx_buffer: Box::new_uninit_slice(MAX_UDP_PACKET_SIZE),
            new_source_reporter,
            reset_in_progress: false,
            dropped_packets: 0,
        }
    }

    /// Run the I/O (de-)multiplexing.
    pub async fn run(mut self) {
        log::info!("uTP IoDriver started");
        let start_time = Instant::now();
        loop_select(&mut self, [Self::poll_commands, Self::poll_egress, Self::poll_ingress]).await;
        log::info!(
            "uTP IoDriver finished in {:?}, dropped {} packets",
            start_time.elapsed(),
            self.dropped_packets
        );
    }

    fn poll_commands(&mut self, cx: &mut Context<'_>) -> Poll<ControlFlow<()>> {
        if self.reset_in_progress {
            if self.connections.is_empty() {
                self.reset_in_progress = false;
                log::info!("uTP reset complete");
            } else {
                // wait for all connections to close
                return Poll::Pending;
            }
        }

        macro_rules! trigger_reset {
            ($reason:expr) => {{
                if !self.reset_in_progress {
                    log::info!("uTP IoDriver {} initiated", $reason);
                    self.pending_tx.clear();
                    for connection in self.connections.values_mut() {
                        // fake an empty inbound packet which will fail parsing and trigger an
                        // outbound RST and connection exit
                        connection.ingress.queue().clear();
                        _ = connection.ingress.try_send(Bytes::new());
                    }
                    self.reset_in_progress = true;
                }
            }};
        }

        match ready!(self.commands.poll_recv(cx)) {
            Some(Command::AddConnection((peer_addr, connection))) => {
                match self.connections.entry(peer_addr) {
                    Entry::Occupied(mut entry) => {
                        if entry.get().ingress.is_closed() || entry.get().egress.is_closed() {
                            // replace closed connection
                            entry.insert(connection);
                        } else {
                            log::error!("Not adding connection to {peer_addr}: already exists");
                        }
                    }
                    Entry::Vacant(e) => {
                        e.insert(connection);
                    }
                }
                Poll::Ready(ControlFlow::Continue(()))
            }
            Some(Command::ResetConnections) => {
                if self.connections.is_empty() {
                    Poll::Ready(ControlFlow::Continue(()))
                } else {
                    trigger_reset!("reset");
                    Poll::Pending // yield to allow connections to process the reset
                }
            }
            None => {
                // application exiting
                if self.connections.is_empty() {
                    Poll::Ready(ControlFlow::Break(()))
                } else {
                    trigger_reset!("shutdown");
                    Poll::Pending // yield to allow connections to process the reset
                }
            }
        }
    }

    fn poll_egress(&mut self, cx: &mut Context<'_>) -> Poll<ControlFlow<()>> {
        let mut made_progress = false;

        if let Some((remote_addr, packet)) = self.pending_tx.last() {
            // has pending egress, try sending it
            if let Poll::Ready(ret) = self.socket.poll_send_to(cx, packet, *remote_addr) {
                match ret {
                    Ok(bytes_sent) if bytes_sent != packet.len() => {
                        log::error!(
                            "Incomplete send to {remote_addr}: {bytes_sent}/{}",
                            packet.len()
                        );
                        self.connections.remove(remote_addr);
                    }
                    Err(e) => {
                        // `e` is guaranteed to never be WouldBlock here
                        log::error!("Send failed to {remote_addr}: {e}");
                        self.connections.remove(remote_addr);
                    }
                    Ok(_) => {
                        if log_enabled!(log::Level::Trace) {
                            log::trace!("TX-{remote_addr}: {}", String::from_utf8_lossy(packet));
                        }
                    }
                }
                self.pending_tx.pop();
                made_progress = true;
            }
        } else {
            // iterate through connections and fill the egress queue with at most 1 packet from each
            // connection
            self.connections.retain(|remote_addr, connection| {
                match connection.egress.poll_next_unpin(cx) {
                    Poll::Ready(None) => {
                        made_progress = true;
                        false
                    }
                    Poll::Ready(Some(packet)) => {
                        made_progress = true;
                        self.pending_tx.push((*remote_addr, packet));
                        true
                    }
                    Poll::Pending => true,
                }
            });
        }

        if made_progress {
            Poll::Ready(ControlFlow::Continue(()))
        } else {
            Poll::Pending
        }
    }

    fn poll_ingress(&mut self, cx: &mut Context<'_>) -> Poll<ControlFlow<()>> {
        let mut buf = ReadBuf::uninit(&mut self.rx_buffer);

        let (source_addr, packet) = match ready!(self.socket.poll_recv_from(cx, &mut buf)) {
            Ok(addr) => {
                let packet = BytesMut::from(buf.filled());
                (addr, packet.freeze())
            }
            Err(e) => {
                log::error!("Receive failed: {e:?}");
                // the error might be caused by the last send()
                return Poll::Ready(if is_transient_error(&e.kind()) {
                    ControlFlow::Continue(())
                } else {
                    ControlFlow::Break(())
                });
            }
        };
        if log_enabled!(log::Level::Trace) {
            log::trace!("RX-{source_addr}: {}", String::from_utf8_lossy(&packet));
        }

        match self.connections.entry(source_addr) {
            Entry::Occupied(mut connection) => {
                match connection.get_mut().ingress.try_send(packet) {
                    Ok(_) => {}
                    Err(local_sync_error::TrySendError::Full(_buf)) => {
                        log::warn!("Dropping received packet from {source_addr}");
                    }
                    Err(local_sync_error::TrySendError::Closed(_buf)) => {
                        connection.remove();
                        self.dropped_packets += 1;
                        // TODO: should we report this as unknown source?
                    }
                }
            }
            Entry::Vacant(_) => match self.new_source_reporter.try_send((source_addr, packet)) {
                Ok(_) => {}
                Err(_) => {
                    // don't exit even if the channel is closed
                    self.dropped_packets += 1;
                }
            },
        }
        Poll::Ready(ControlFlow::Continue(()))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use futures_util::FutureExt;
    use std::net::Ipv4Addr;
    use tokio::task;

    struct Connection {
        egress: local_bounded::Sender<Bytes>,
        ingress: local_bounded::Receiver<Bytes>,
    }

    const INGRESS_CHANNEL_CAPACITY: usize = 10;

    fn new_connection() -> (Connection, ConnectionHandle) {
        let (egress_tx, egress_rx) = local_bounded::channel(1);
        let (ingress_tx, ingress_rx) = local_bounded::channel(INGRESS_CHANNEL_CAPACITY);
        (
            Connection {
                egress: egress_tx,
                ingress: ingress_rx,
            },
            ConnectionHandle {
                egress: egress_rx,
                ingress: ingress_tx,
            },
        )
    }

    #[tokio::test(flavor = "local")]
    async fn test_egress_to_multiple_connections() {
        let peer1_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let peer1_addr = peer1_socket.local_addr().unwrap();

        let peer2_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let peer2_addr = peer2_socket.local_addr().unwrap();

        let driver_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let driver_addr = driver_socket.local_addr().unwrap();

        let (cmd_tx, cmd_rx) = mpsc::channel(1);
        let (unknown_tx, _unknown_rx) = local_bounded::channel(1);
        let driver = IoDriver::new(cmd_rx, driver_socket, unknown_tx);
        task::spawn_local(driver.run());

        let (mut conn1, handle1) = new_connection();
        cmd_tx.send(Command::AddConnection((peer1_addr, handle1))).await.unwrap();

        let (mut conn2, handle2) = new_connection();
        cmd_tx.send(Command::AddConnection((peer2_addr, handle2))).await.unwrap();

        let msg1 = Bytes::from("Hello, Peer 1!");
        conn1.egress.send(msg1.clone()).await.unwrap();

        let mut buf1 = [0u8; 1024];
        let (len1, addr) = peer1_socket.recv_from(&mut buf1).await.unwrap();
        assert_eq!(addr, driver_addr);
        assert_eq!(&buf1[..len1], &msg1[..]);

        let msg2 = Bytes::from("Hello, Peer 2!");
        conn2.egress.send(msg2.clone()).await.unwrap();

        let mut buf2 = [0u8; 1024];
        let (len2, addr) = peer2_socket.recv_from(&mut buf2).await.unwrap();
        assert_eq!(addr, driver_addr);
        assert_eq!(&buf2[..len2], &msg2[..]);

        let msg2 = Bytes::from("Second message to Peer 2");
        conn2.egress.send(msg2.clone()).await.unwrap();

        let msg1 = Bytes::from("Second message to Peer 1");
        for _ in 0..5 {
            conn1.egress.send(msg1.clone()).await.unwrap();
        }

        let mut buf2 = [0u8; 1024];
        let (len2, addr) = peer2_socket.recv_from(&mut buf2).await.unwrap();
        assert_eq!(addr, driver_addr);
        assert_eq!(&buf2[..len2], &msg2[..]);

        for _ in 0..5 {
            let mut buf1 = [0u8; 1024];
            let (len1, addr) = peer1_socket.recv_from(&mut buf1).await.unwrap();
            assert_eq!(addr, driver_addr);
            assert_eq!(&buf1[..len1], &msg1[..]);
        }
    }

    #[tokio::test(flavor = "local")]
    async fn test_ingress_from_multiple_connections() {
        let peer1_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let peer1_addr = peer1_socket.local_addr().unwrap();

        let peer2_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let peer2_addr = peer2_socket.local_addr().unwrap();

        let driver_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let driver_addr = driver_socket.local_addr().unwrap();

        let (cmd_tx, cmd_rx) = mpsc::channel(1);
        let (unknown_tx, _unknown_rx) = local_bounded::channel(1);
        let driver = IoDriver::new(cmd_rx, driver_socket, unknown_tx);
        task::spawn_local(driver.run());

        let (mut conn1, handle1) = new_connection();
        cmd_tx.send(Command::AddConnection((peer1_addr, handle1))).await.unwrap();

        let (mut conn2, handle2) = new_connection();
        cmd_tx.send(Command::AddConnection((peer2_addr, handle2))).await.unwrap();

        let msg1 = Bytes::from("Hello from Peer 1!");
        peer1_socket.send_to(&msg1, driver_addr).await.unwrap();

        let msg2 = Bytes::from("Hello from Peer 2!");
        peer2_socket.send_to(&msg2, driver_addr).await.unwrap();

        let received1 = conn1.ingress.next().await.unwrap();
        assert_eq!(received1, msg1);

        let received2 = conn2.ingress.next().await.unwrap();
        assert_eq!(received2, msg2);

        assert!(conn1.ingress.next().now_or_never().is_none());
        assert!(conn2.ingress.next().now_or_never().is_none());
    }

    #[tokio::test(flavor = "local")]
    async fn test_unknown_source_reporting() {
        let peer_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let peer_addr = peer_socket.local_addr().unwrap();

        let driver_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let driver_addr = driver_socket.local_addr().unwrap();

        let (_cmd_tx, cmd_rx) = mpsc::channel(1);
        let (unknown_tx, mut unknown_rx) = local_bounded::channel(10);
        let driver = IoDriver::new(cmd_rx, driver_socket, unknown_tx);
        task::spawn_local(driver.run());

        let msg = Bytes::from("Hello from unknown source!");
        peer_socket.send_to(&msg, driver_addr).await.unwrap();

        let (reported_addr, reported_msg) = unknown_rx.next().await.unwrap();
        assert_eq!(reported_addr, peer_addr);
        assert_eq!(reported_msg, msg);
    }

    #[tokio::test(flavor = "local")]
    async fn test_reset_all_connections() {
        let driver_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let driver_addr = driver_socket.local_addr().unwrap();

        let (cmd_tx, cmd_rx) = mpsc::channel(1);
        let (unknown_tx, mut unknown_rx) = local_bounded::channel(1);
        let driver = IoDriver::new(cmd_rx, driver_socket, unknown_tx);
        task::spawn_local(driver.run());

        let (mut conn1, handle1) = new_connection();
        cmd_tx
            .send(Command::AddConnection(((Ipv4Addr::LOCALHOST, 12345u16).into(), handle1)))
            .await
            .unwrap();

        let (mut conn2, handle2) = new_connection();
        cmd_tx
            .send(Command::AddConnection(((Ipv4Addr::LOCALHOST, 23456u16).into(), handle2)))
            .await
            .unwrap();

        cmd_tx.send(Command::ResetConnections).await.unwrap();

        // Connections should receive empty packets to trigger reset
        let received1 = conn1.ingress.next().await.unwrap();
        assert!(received1.is_empty());

        let received2 = conn2.ingress.next().await.unwrap();
        assert!(received2.is_empty());

        // try adding a new connection during reset
        let peer_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let peer_addr = peer_socket.local_addr().unwrap();

        let (mut conn, handle) = new_connection();
        cmd_tx.send(Command::AddConnection((peer_addr, handle))).await.unwrap();
        task::yield_now().await;

        // verify the connection hasn't been added yet
        let msg = Bytes::from("Hello during reset!");
        peer_socket.send_to(&msg, driver_addr).await.unwrap();

        let (reported_addr, reported_msg) = unknown_rx.next().await.unwrap();
        assert_eq!(reported_addr, peer_addr);
        assert_eq!(reported_msg, msg);

        assert!(conn.ingress.next().now_or_never().is_none());

        // finish reset by dropping connections
        drop(conn1);
        drop(conn2);
        task::yield_now().await;

        // now the pending command should be processed
        let msg = Bytes::from("Hello after reset complete!");
        peer_socket.send_to(&msg, driver_addr).await.unwrap();

        let received_msg = conn.ingress.next().await.unwrap();
        assert_eq!(received_msg, msg);
    }

    #[tokio::test(flavor = "local")]
    async fn test_initial_reset() {
        let peer_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let peer_addr = peer_socket.local_addr().unwrap();

        let driver_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let driver_addr = driver_socket.local_addr().unwrap();

        let (cmd_tx, cmd_rx) = mpsc::channel(1);
        let (unknown_tx, _unknown_rx) = local_bounded::channel(1);
        let driver = IoDriver::new(cmd_rx, driver_socket, unknown_tx);
        task::spawn_local(driver.run());

        cmd_tx.send(Command::ResetConnections).await.unwrap();

        let (mut conn, handle) = new_connection();
        cmd_tx.send(Command::AddConnection((peer_addr, handle))).await.unwrap();

        let msg = Bytes::from("Hello after initial reset!");
        conn.egress.send(msg.clone()).await.unwrap();

        let mut buf = [0u8; 1024];
        let (len, addr) = peer_socket.recv_from(&mut buf).await.unwrap();
        assert_eq!(addr, driver_addr);
        assert_eq!(&buf[..len], &msg[..]);

        let msg = Bytes::from("Hello from Peer after initial reset!");
        peer_socket.send_to(&msg, driver_addr).await.unwrap();

        let received_msg = conn.ingress.next().await.unwrap();
        assert_eq!(received_msg, msg);
    }

    #[tokio::test(flavor = "local")]
    async fn test_closed_connection_reported_as_unknown() {
        let peer_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let peer_addr = peer_socket.local_addr().unwrap();

        let driver_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let driver_addr = driver_socket.local_addr().unwrap();

        let (cmd_tx, cmd_rx) = mpsc::channel(1);
        let (unknown_tx, mut unknown_rx) = local_bounded::channel(10);
        let driver = IoDriver::new(cmd_rx, driver_socket, unknown_tx);
        task::spawn_local(driver.run());

        let (conn, handle) = new_connection();
        cmd_tx.send(Command::AddConnection((peer_addr, handle))).await.unwrap();

        // Close the connection
        drop(conn.ingress);
        drop(conn.egress);

        // Send a packet from the same peer
        let msg = Bytes::from("Hello after deletion!");
        peer_socket.send_to(&msg, driver_addr).await.unwrap();

        // It should be reported as unknown
        let (reported_addr, reported_msg) = unknown_rx.next().await.unwrap();
        assert_eq!(reported_addr, peer_addr);
        assert_eq!(reported_msg, msg);
    }

    #[cfg_attr(not(target_os = "linux"), ignore)]
    #[tokio::test(flavor = "local")]
    async fn test_unreachable_connection_is_deleted() {
        let peer_addr: SocketAddr = (Ipv4Addr::LOCALHOST, 0u16).into();

        let driver_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();

        let (cmd_tx, cmd_rx) = mpsc::channel(1);
        let (unknown_tx, _unknown_rx) = local_bounded::channel(10);
        let driver = IoDriver::new(cmd_rx, driver_socket, unknown_tx);
        task::spawn_local(driver.run());

        let (mut conn, handle) = new_connection();
        cmd_tx.send(Command::AddConnection((peer_addr, handle))).await.unwrap();

        let msg = Bytes::from("Hello to unreachable peer!");
        conn.egress.send(msg.clone()).await.unwrap();

        assert!(conn.ingress.next().await.is_none());
        assert!(conn.egress.send(msg).await.is_err());
    }

    #[tokio::test(flavor = "local")]
    async fn test_dont_exit_on_receive_error() {
        let _ = simple_logger::SimpleLogger::new()
            .with_level(log::LevelFilter::Off)
            .with_module_level("mtorrent_core::utp", log::LevelFilter::Trace)
            .init();
        let peer_addr: SocketAddr = (Ipv4Addr::LOCALHOST, 0u16).into();

        let driver_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();

        let (cmd_tx, cmd_rx) = mpsc::channel(1);
        let (unknown_tx, _unknown_rx) = local_bounded::channel(10);
        let driver = IoDriver::new(cmd_rx, driver_socket, unknown_tx);
        let driver_handle = task::spawn_local(driver.run());

        {
            let (mut conn, handle) = new_connection();
            cmd_tx.send(Command::AddConnection((peer_addr, handle))).await.unwrap();

            let msg = Bytes::from("Hello to unreachable peer!");
            conn.egress.send(msg.clone()).await.unwrap();
        }

        // on windows the send error only shows up later during the next call to recv()
        tokio::time::sleep(millisec!(100)).await;
        assert!(!driver_handle.is_finished());

        {
            let (mut conn, handle) = new_connection();
            cmd_tx.send(Command::AddConnection((peer_addr, handle))).await.unwrap();

            let msg = Bytes::from("Retry hello to unreachable peer!");
            conn.egress.send(msg.clone()).await.unwrap();
        }
    }

    #[tokio::test(flavor = "local")]
    async fn test_send_and_receive_big_packets() {
        _ = simple_logger::SimpleLogger::new().with_level(log::LevelFilter::Debug).init();

        let peer_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let peer_addr = peer_socket.local_addr().unwrap();

        let driver_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let driver_addr = driver_socket.local_addr().unwrap();

        let (cmd_tx, cmd_rx) = mpsc::channel(1);
        let (unknown_tx, mut unknown_rx) = local_bounded::channel(10);
        let driver = IoDriver::new(cmd_rx, driver_socket, unknown_tx);
        task::spawn_local(driver.run());

        // By default OSX won't allow a larger datagram size than 9216 bytes, see https://github.com/BanTheRewind/Cinder-Asio/issues/9#issuecomment-67540675
        let packet_size = if cfg!(target_os = "macos") {
            9216
        } else {
            32 * 1024
        };

        let long_msg = Bytes::from(vec![rand::random::<u8>(); packet_size]);
        peer_socket.send_to(&long_msg, driver_addr).await.unwrap();

        let (reported_addr, reported_msg) = unknown_rx.next().await.unwrap();
        assert_eq!(reported_addr, peer_addr);
        assert_eq!(reported_msg.len(), long_msg.len());
        assert_eq!(reported_msg, long_msg);

        let (mut conn, handle) = new_connection();
        cmd_tx.send(Command::AddConnection((peer_addr, handle))).await.unwrap();

        conn.egress.send(long_msg.clone()).await.unwrap();
        let mut buf = vec![0u8; packet_size];
        let (len, addr) = peer_socket.recv_from(&mut buf).await.unwrap();
        assert_eq!(addr, driver_addr);
        assert_eq!(len, long_msg.len());
        assert_eq!(&buf[..len], &long_msg[..]);

        let long_msg = Bytes::from(vec![rand::random::<u8>(); packet_size]);
        peer_socket.send_to(&long_msg, driver_addr).await.unwrap();

        let received_msg = conn.ingress.next().await.unwrap();
        assert_eq!(received_msg.len(), long_msg.len());
        assert_eq!(received_msg, long_msg);
    }

    #[tokio::test(flavor = "local")]
    async fn test_driver_shutdown_on_command_channel_close() {
        let peer_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let peer_addr = peer_socket.local_addr().unwrap();

        let driver_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let driver_addr = driver_socket.local_addr().unwrap();

        let (cmd_tx, cmd_rx) = mpsc::channel(1);
        let (unknown_tx, _unknown_rx) = local_bounded::channel(1);
        let driver = IoDriver::new(cmd_rx, driver_socket, unknown_tx);
        let driver_handle = task::spawn_local(driver.run());

        // add a connection
        let (mut conn, handle) = new_connection();
        cmd_tx.send(Command::AddConnection((peer_addr, handle))).await.unwrap();

        // sending a message succeeds
        conn.egress.send(Bytes::from("hello")).await.unwrap();
        let mut buf = [0u8; 1024];
        let (len, addr) = peer_socket.recv_from(&mut buf).await.unwrap();
        assert_eq!(addr, driver_addr);
        assert_eq!(&buf[..len], b"hello");

        // Drop the command sender to close the channel
        drop(cmd_tx);
        task::yield_now().await;

        // the connection should receive an empty packet to signal shutdown
        let received = conn.ingress.next().await.unwrap();
        assert!(received.is_empty());

        // the connection should be able to send the final message
        conn.egress.send(Bytes::from("bye")).await.unwrap();
        drop(conn);
        let (len, addr) = peer_socket.recv_from(&mut buf).await.unwrap();
        assert_eq!(addr, driver_addr);
        assert_eq!(&buf[..len], b"bye");

        // The driver should've exited gracefully after sending the last message
        driver_handle.now_or_never().unwrap().unwrap();
    }

    #[tokio::test(flavor = "local")]
    async fn test_drop_received_packet_when_ingress_full() {
        // let _ = simple_logger::SimpleLogger::new()
        //     .with_level(log::LevelFilter::Off)
        //     .with_module_level("mtorrent_core::utp", log::LevelFilter::Trace)
        //     .init();
        let peer_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let peer_addr = peer_socket.local_addr().unwrap();

        let driver_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let driver_addr = driver_socket.local_addr().unwrap();

        let (cmd_tx, cmd_rx) = mpsc::channel(1);
        let (unknown_tx, _unknown_rx) = local_bounded::channel(10);
        let driver = IoDriver::new(cmd_rx, driver_socket, unknown_tx);
        task::spawn_local(driver.run());

        let (mut conn, handle) = new_connection();
        cmd_tx.send(Command::AddConnection((peer_addr, handle))).await.unwrap();

        // Fill the ingress channel
        let packets: Vec<_> = (0..=INGRESS_CHANNEL_CAPACITY)
            .map(|i| Bytes::from(format!("Packet {}", i)))
            .collect();

        for packet in &packets {
            peer_socket.send_to(packet, driver_addr).await.unwrap();
        }

        // Receive packets up to capacity
        for expected_packet in &packets[..INGRESS_CHANNEL_CAPACITY] {
            let received_packet = conn.ingress.next().await.unwrap();
            assert_eq!(&received_packet, expected_packet);
        }

        // The last packet should be dropped
        task::yield_now().await;
        assert!(conn.ingress.next().now_or_never().is_none());

        let msg = Bytes::from("This packet will be received instead of packet 10");
        peer_socket.send_to(&msg, driver_addr).await.unwrap();

        let received_packet = conn.ingress.next().await.unwrap();
        assert_eq!(received_packet, msg);
    }

    #[tokio::test(flavor = "local")]
    async fn test_dont_add_same_connection_twice() {
        let driver_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();

        let (cmd_tx, cmd_rx) = mpsc::channel(1);
        let (unknown_tx, _unknown_rx) = local_bounded::channel(10);
        let driver = IoDriver::new(cmd_rx, driver_socket, unknown_tx);
        task::spawn_local(driver.run());

        let peer_addr: SocketAddr = (Ipv4Addr::LOCALHOST, 12345u16).into();

        let (mut conn1, handle1) = new_connection();
        cmd_tx.send(Command::AddConnection((peer_addr, handle1))).await.unwrap();

        let (mut conn2, handle2) = new_connection();
        cmd_tx.send(Command::AddConnection((peer_addr, handle2))).await.unwrap();

        task::yield_now().await;

        conn1.egress.send(Bytes::new()).await.unwrap();
        let e = conn2.egress.send(Bytes::new()).await.unwrap_err();
        assert!(matches!(e, local_sync_error::SendError::Closed(_)));
    }

    #[tokio::test(flavor = "local")]
    async fn test_replace_locally_closed_connection() {
        let peer_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let peer_addr = peer_socket.local_addr().unwrap();

        let driver_socket = UdpSocket::bind((Ipv4Addr::LOCALHOST, 0u16)).await.unwrap();
        let driver_addr = driver_socket.local_addr().unwrap();

        let (cmd_tx, cmd_rx) = mpsc::channel(1);
        let (unknown_tx, _unknown_rx) = local_bounded::channel(10);
        let driver = IoDriver::new(cmd_rx, driver_socket, unknown_tx);
        task::spawn_local(driver.run());

        let (mut conn1, handle1) = new_connection();
        cmd_tx.send(Command::AddConnection((peer_addr, handle1))).await.unwrap();

        drop(conn1.ingress);

        let (mut conn2, handle2) = new_connection();
        cmd_tx.send(Command::AddConnection((peer_addr, handle2))).await.unwrap();

        let msg1 = Bytes::from("Hello from new connection 1");
        conn1.egress.send(msg1.clone()).await.unwrap();

        let msg2 = Bytes::from("Hello from new connection 2");
        conn2.egress.send(msg2.clone()).await.unwrap();

        let mut buf = [0u8; 1024];
        let (len, addr) = peer_socket.recv_from(&mut buf).await.unwrap();
        assert_eq!(addr, driver_addr);
        assert_eq!(&buf[..len], &msg2[..]);

        let msg = Bytes::from("Hello from Peer to new connection!");
        peer_socket.send_to(&msg, driver_addr).await.unwrap();

        let received_msg = conn2.ingress.next().await.unwrap();
        assert_eq!(received_msg, msg);

        assert!(peer_socket.recv_from(&mut buf).now_or_never().is_none());
    }
}