openrtc 2.8.3

OpenRTC: a Rust-first P2P runtime for device discovery, signaling, and iroh/QUIC networking.
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
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
//! Mechanism-neutral Iroh custom transport backed by bounded packet queues.
//!
//! WebRTC DataChannels and MoQ reliable object streams attach to this bridge.
//! Carrier objects stay in their platform adapters; Iroh sees only custom
//! addresses and packet send/receive.

use std::{
    collections::{HashMap, VecDeque},
    io,
    sync::{
        atomic::{AtomicU64, Ordering},
        Arc, Mutex,
    },
    task::{Context, Poll, Waker},
    time::Duration,
};

use iroh::{
    endpoint::transports::{
        AddrKind, CustomEndpoint, CustomSender, CustomTransport, PathSelection,
        PathSelectionContext, PathSelectionData, PathSelector, RecvInfo, Transmit,
    },
    EndpointAddr, EndpointId, TransportAddr,
};
use iroh_base::CustomAddr;

use crate::iroh_carrier::{DEFAULT_PACKET_QUEUE_CAPACITY, MAX_INNER_PACKET_BYTES};
use crate::iroh_carrier_kind::IrohCarrierKind;

const IPV6_RTT_ADVANTAGE: Duration = Duration::from_millis(3);
const RTT_SWITCHING_MIN: Duration = Duration::from_millis(5);

#[derive(Debug, Clone, Copy)]
struct PreferredCarrierPath {
    transport_id: u64,
    token: u64,
    previous_transport_id: Option<u64>,
    committed: bool,
}

/// Endpoint path policy that preserves Iroh's normal relay/direct behavior but
/// lets the peer-session owner select one exact custom carrier per peer.
///
/// Iroh path selection is endpoint-wide for every QUIC connection to a peer.
/// A replacement connection therefore needs an explicit, peer-scoped target or
/// the incumbent custom path can immediately become selected on the candidate.
/// This policy is only an input to Iroh's path owner; it does not install or
/// retire logical OpenRTC generations.
#[derive(Debug, Clone, Default)]
pub(crate) struct PacketCarrierPathSelector {
    preferred_by_endpoint: Arc<Mutex<HashMap<Vec<u8>, PreferredCarrierPath>>>,
    next_token: Arc<AtomicU64>,
}

impl PacketCarrierPathSelector {
    pub(crate) fn begin_preference(
        &self,
        endpoint_id: EndpointId,
        transport_id: u64,
    ) -> PacketCarrierPathPreference {
        let endpoint_key = endpoint_id.as_bytes().to_vec();
        let token = self
            .next_token
            .fetch_add(1, Ordering::Relaxed)
            .saturating_add(1);
        let mut preferences = self
            .preferred_by_endpoint
            .lock()
            .expect("packet carrier path selector mutex poisoned");
        let previous_transport_id = preferences
            .get(&endpoint_key)
            .and_then(|current| {
                if current.committed {
                    Some(current.transport_id)
                } else {
                    current.previous_transport_id
                }
            })
            .filter(|previous| *previous != transport_id);
        preferences.insert(
            endpoint_key.clone(),
            PreferredCarrierPath {
                transport_id,
                token,
                previous_transport_id,
                committed: false,
            },
        );
        PacketCarrierPathPreference {
            selector: self.clone(),
            endpoint_key,
            transport_id,
            token,
            active: true,
        }
    }

    fn commit(&self, endpoint_key: &[u8], transport_id: u64, token: u64) {
        let mut preferences = self
            .preferred_by_endpoint
            .lock()
            .expect("packet carrier path selector mutex poisoned");
        if let Some(current) = preferences.get_mut(endpoint_key) {
            if current.transport_id == transport_id && current.token == token {
                current.previous_transport_id = None;
                current.committed = true;
            }
        }
    }

    fn rollback(&self, endpoint_key: &[u8], transport_id: u64, token: u64) {
        let mut preferences = self
            .preferred_by_endpoint
            .lock()
            .expect("packet carrier path selector mutex poisoned");
        let Some(current) = preferences.get(endpoint_key).copied() else {
            return;
        };
        if current.transport_id != transport_id || current.token != token || current.committed {
            return;
        }
        match current.previous_transport_id {
            Some(previous_transport_id) => {
                preferences.insert(
                    endpoint_key.to_vec(),
                    PreferredCarrierPath {
                        transport_id: previous_transport_id,
                        token,
                        previous_transport_id: None,
                        committed: true,
                    },
                );
            }
            None => {
                preferences.remove(endpoint_key);
            }
        }
    }

    pub(crate) fn clear(&self, endpoint_id: EndpointId) {
        self.preferred_by_endpoint
            .lock()
            .expect("packet carrier path selector mutex poisoned")
            .remove(endpoint_id.as_bytes().as_slice());
    }

    fn preferred_transport_for(&self, endpoint_bytes: &[u8]) -> Option<u64> {
        self.preferred_by_endpoint
            .lock()
            .expect("packet carrier path selector mutex poisoned")
            .get(endpoint_bytes)
            .map(|preference| preference.transport_id)
    }
}

/// Rollback guard for one provisional path preference.
///
/// A failed candidate restores the previously committed carrier. A successful
/// atomic connection commit makes the preference durable until another switch
/// or final peer disconnect supersedes it.
#[derive(Debug)]
pub(crate) struct PacketCarrierPathPreference {
    selector: PacketCarrierPathSelector,
    endpoint_key: Vec<u8>,
    transport_id: u64,
    token: u64,
    active: bool,
}

impl PacketCarrierPathPreference {
    pub(crate) fn commit(mut self) {
        self.selector
            .commit(&self.endpoint_key, self.transport_id, self.token);
        self.active = false;
    }
}

impl Drop for PacketCarrierPathPreference {
    fn drop(&mut self) {
        if self.active {
            self.selector
                .rollback(&self.endpoint_key, self.transport_id, self.token);
        }
    }
}

fn default_path_key(kind: AddrKind, rtt: Duration) -> (u8, i128) {
    match kind {
        AddrKind::Relay => (1, rtt.as_nanos() as i128),
        AddrKind::IpV6 => (
            0,
            (rtt.as_nanos() as i128).saturating_sub(IPV6_RTT_ADVANTAGE.as_nanos() as i128),
        ),
        AddrKind::IpV4 | AddrKind::Custom(_) => (0, rtt.as_nanos() as i128),
    }
}

impl PathSelector for PacketCarrierPathSelector {
    fn select(&self, context: &PathSelectionContext<'_>) -> PathSelection {
        let mut selection = PathSelection::none();
        let preferred = context
            .paths()
            .filter_map(|path| {
                let iroh::endpoint::transports::Addr::Custom(address) =
                    path.network_path().remote()
                else {
                    return None;
                };
                (self.preferred_transport_for(address.data()) == Some(address.id()))
                    .then(|| path.stats().map(|stats| (path, stats.rtt)))
                    .flatten()
            })
            .min_by_key(|(_, rtt)| *rtt)
            .map(|(path, _)| path);
        if let Some(preferred) = preferred {
            selection.set(&preferred);
            return selection;
        }

        let current = context.current();
        let mut best: Option<(PathSelectionData<'_>, (u8, i128))> = None;
        let mut current_key: Option<(u8, i128)> = None;
        for path in context.paths() {
            let Some(stats) = path.stats() else {
                continue;
            };
            let key = default_path_key(path.network_path().addr_kind(), stats.rtt);
            if Some(path.network_path()) == current && current_key.is_none_or(|value| key < value) {
                current_key = Some(key);
            }
            if best.as_ref().is_none_or(|(_, value)| key < *value) {
                best = Some((path, key));
            }
        }

        let Some((best_path, (best_tier, best_rtt))) = best else {
            return selection;
        };
        let Some((current_tier, current_rtt)) = current_key else {
            selection.set(&best_path);
            return selection;
        };
        if current_tier != best_tier
            || best_rtt + RTT_SWITCHING_MIN.as_nanos() as i128 <= current_rtt
        {
            selection.set(&best_path);
        }
        selection
    }
}

#[derive(Debug)]
struct InboundPacket {
    session_id: u64,
    remote: CustomAddr,
    local: CustomAddr,
    bytes: Vec<u8>,
}

#[derive(Debug)]
struct PacketCarrierState {
    inbound: VecDeque<InboundPacket>,
    inbound_capacity: usize,
    recv_waker: Option<Waker>,
    outbound: HashMap<CustomAddr, OutboundSession>,
    outbound_space_wakers: HashMap<CustomAddr, (u64, Waker)>,
    next_session_id: u64,
    inbound_space: Arc<tokio::sync::Notify>,
    closed: bool,
}

#[derive(Debug, Clone)]
struct OutboundSession {
    id: u64,
    sender: async_channel::Sender<Vec<u8>>,
}

#[derive(Debug)]
struct PacketCarrierActivation {
    endpoint_id: EndpointId,
    session_id: u64,
    active_peers: Arc<Mutex<HashMap<EndpointId, u64>>>,
}

impl PacketCarrierActivation {
    fn clear(&self) {
        let mut active_peers = self
            .active_peers
            .lock()
            .expect("packet carrier provider mutex poisoned");
        if active_peers.get(&self.endpoint_id) == Some(&self.session_id) {
            active_peers.remove(&self.endpoint_id);
        }
    }
}

/// Receive side owned by a WebRTC or MoQ session pump.
#[derive(Debug)]
pub struct PacketCarrierSession {
    session_id: u64,
    remote_addr: CustomAddr,
    outbound: async_channel::Receiver<Vec<u8>>,
    state: Arc<Mutex<PacketCarrierState>>,
    local_addr: CustomAddr,
    activation: Option<PacketCarrierActivation>,
}

impl PacketCarrierSession {
    pub fn remote_addr(&self) -> &CustomAddr {
        &self.remote_addr
    }

    pub async fn recv_outbound(&self) -> Result<Vec<u8>, PacketCarrierQueueError> {
        let packet = self
            .outbound
            .recv()
            .await
            .map_err(|_| PacketCarrierQueueError::Closed)?;
        self.wake_outbound_sender();
        Ok(packet)
    }

    pub fn try_recv_outbound(&self) -> Result<Vec<u8>, PacketCarrierQueueError> {
        let packet = self.outbound.try_recv().map_err(|error| match error {
            async_channel::TryRecvError::Empty => PacketCarrierQueueError::Empty,
            async_channel::TryRecvError::Closed => PacketCarrierQueueError::Closed,
        })?;
        self.wake_outbound_sender();
        Ok(packet)
    }

    /// Submit one already-decoded carrier packet to Iroh/noq.
    pub fn try_deliver_inbound(&self, bytes: Vec<u8>) -> Result<(), PacketCarrierQueueError> {
        if bytes.is_empty() || bytes.len() > MAX_INNER_PACKET_BYTES {
            return Err(PacketCarrierQueueError::PacketSize(bytes.len()));
        }
        let mut state = self.state.lock().expect("packet carrier mutex poisoned");
        if state.closed {
            return Err(PacketCarrierQueueError::Closed);
        }
        if !state
            .outbound
            .get(&self.remote_addr)
            .is_some_and(|session| session.id == self.session_id)
        {
            return Err(PacketCarrierQueueError::Closed);
        }
        if state.inbound.len() >= state.inbound_capacity {
            return Err(PacketCarrierQueueError::Backpressure);
        }
        state.inbound.push_back(InboundPacket {
            session_id: self.session_id,
            remote: self.remote_addr.clone(),
            local: self.local_addr.clone(),
            bytes,
        });
        if let Some(waker) = state.recv_waker.take() {
            waker.wake();
        }
        Ok(())
    }

    /// Deliver without dropping when Iroh temporarily falls behind the
    /// browser/native carrier. The bounded queue remains the single memory
    /// limit; consumers wake exactly one waiting packet after making room.
    pub async fn deliver_inbound(&self, bytes: Vec<u8>) -> Result<(), PacketCarrierQueueError> {
        loop {
            let ready = {
                let state = self.state.lock().expect("packet carrier mutex poisoned");
                state.inbound_space.clone()
            };
            let notified = ready.notified();
            match self.try_deliver_inbound(bytes.clone()) {
                Err(PacketCarrierQueueError::Backpressure) => notified.await,
                result => return result,
            }
        }
    }

    fn wake_outbound_sender(&self) {
        let mut state = self.state.lock().expect("packet carrier mutex poisoned");
        let waker = state
            .outbound_space_wakers
            .get(&self.remote_addr)
            .filter(|(session_id, _)| *session_id == self.session_id)
            .map(|(_, waker)| waker.clone());
        if waker.is_some() {
            state.outbound_space_wakers.remove(&self.remote_addr);
        }
        drop(state);
        if let Some(waker) = waker {
            waker.wake();
        }
    }

    /// Release this exact physical generation even when a browser pump still
    /// holds an `Rc` while it unwinds. A later generation for the same peer is
    /// fenced by `session_id` and cannot be removed by the stale pump.
    pub fn close(&self) {
        let mut state = self.state.lock().expect("packet carrier mutex poisoned");
        let is_current = state
            .outbound
            .get(&self.remote_addr)
            .is_some_and(|session| session.id == self.session_id);
        let waker = if is_current {
            state.outbound.remove(&self.remote_addr);
            state.inbound.retain(|packet| {
                packet.session_id != self.session_id || packet.remote != self.remote_addr
            });
            state.inbound_space.notify_waiters();
            state
                .outbound_space_wakers
                .remove(&self.remote_addr)
                .map(|(_, waker)| waker)
        } else {
            None
        };
        drop(state);
        if let Some(activation) = self.activation.as_ref() {
            activation.clear();
        }
        if let Some(waker) = waker {
            waker.wake();
        }
    }
}

impl Drop for PacketCarrierSession {
    fn drop(&mut self) {
        self.close();
    }
}

#[derive(Debug, Clone)]
pub struct PacketCarrierTransport {
    transport_id: u64,
    local_addr: CustomAddr,
    local_addrs: n0_watcher::Watchable<Vec<CustomAddr>>,
    state: Arc<Mutex<PacketCarrierState>>,
    queue_capacity: usize,
}

impl PacketCarrierTransport {
    pub fn new(transport_id: u64, endpoint_id: EndpointId) -> io::Result<Self> {
        Self::with_capacity(transport_id, endpoint_id, DEFAULT_PACKET_QUEUE_CAPACITY)
    }

    pub fn with_capacity(
        transport_id: u64,
        endpoint_id: EndpointId,
        queue_capacity: usize,
    ) -> io::Result<Self> {
        if transport_id == 0 {
            return Err(io::Error::new(
                io::ErrorKind::InvalidInput,
                "custom transport id must be non-zero",
            ));
        }
        if queue_capacity == 0 {
            return Err(io::Error::new(
                io::ErrorKind::InvalidInput,
                "packet carrier queue capacity must be non-zero",
            ));
        }
        let local_addr = CustomAddr::from_parts(transport_id, endpoint_id.as_bytes());
        Ok(Self {
            transport_id,
            local_addrs: n0_watcher::Watchable::new(vec![local_addr.clone()]),
            local_addr,
            state: Arc::new(Mutex::new(PacketCarrierState {
                inbound: VecDeque::new(),
                inbound_capacity: queue_capacity,
                recv_waker: None,
                outbound: HashMap::new(),
                outbound_space_wakers: HashMap::new(),
                next_session_id: 0,
                inbound_space: Arc::new(tokio::sync::Notify::new()),
                closed: false,
            })),
            queue_capacity,
        })
    }

    pub fn transport_id(&self) -> u64 {
        self.transport_id
    }

    pub fn local_addr(&self) -> &CustomAddr {
        &self.local_addr
    }

    pub fn session_addr(&self, carrier_session_id: [u8; 16]) -> CustomAddr {
        CustomAddr::from_parts(self.transport_id, &carrier_session_id)
    }

    pub fn peer_addr(&self, endpoint_id: EndpointId) -> CustomAddr {
        CustomAddr::from_parts(self.transport_id, endpoint_id.as_bytes())
    }

    pub fn attach_session(
        &self,
        remote_addr: CustomAddr,
    ) -> Result<PacketCarrierSession, PacketCarrierQueueError> {
        if remote_addr.id() != self.transport_id {
            return Err(PacketCarrierQueueError::WrongTransport {
                expected: self.transport_id,
                actual: remote_addr.id(),
            });
        }
        let (sender, receiver) = async_channel::bounded(self.queue_capacity);
        let mut state = self.state.lock().expect("packet carrier mutex poisoned");
        if state.closed {
            return Err(PacketCarrierQueueError::Closed);
        }
        if state.outbound.contains_key(&remote_addr) {
            return Err(PacketCarrierQueueError::DuplicateSession);
        }
        state.next_session_id = state.next_session_id.wrapping_add(1).max(1);
        let session_id = state.next_session_id;
        state.outbound.insert(
            remote_addr.clone(),
            OutboundSession {
                id: session_id,
                sender,
            },
        );
        drop(state);
        Ok(PacketCarrierSession {
            session_id,
            remote_addr,
            outbound: receiver,
            state: self.state.clone(),
            local_addr: self.local_addr.clone(),
            activation: None,
        })
    }

    pub fn has_session(&self, remote_addr: &CustomAddr) -> bool {
        self.state
            .lock()
            .expect("packet carrier mutex poisoned")
            .outbound
            .contains_key(remote_addr)
    }

    pub fn close(&self) {
        let mut state = self.state.lock().expect("packet carrier mutex poisoned");
        state.closed = true;
        state.outbound.clear();
        for (_, (_, waker)) in state.outbound_space_wakers.drain() {
            waker.wake();
        }
        state.inbound.clear();
        state.inbound_space.notify_waiters();
        if let Some(waker) = state.recv_waker.take() {
            waker.wake();
        }
    }
}

/// Prepared-address provider shared by the built-in WebRTC and MoQ modules.
///
/// A carrier adapter activates one peer only after its browser/native carrier
/// objects are ready. The central OpenRTC lifecycle actor then asks this
/// provider for a custom-only address and owns the replacement dial.
#[derive(Debug)]
pub struct PacketCarrierAddressProvider {
    carrier_kind: IrohCarrierKind,
    transport: Arc<PacketCarrierTransport>,
    active_peers: Arc<Mutex<HashMap<EndpointId, u64>>>,
}

impl PacketCarrierAddressProvider {
    pub fn new(carrier_kind: IrohCarrierKind, transport: Arc<PacketCarrierTransport>) -> Self {
        Self {
            carrier_kind,
            transport,
            active_peers: Arc::new(Mutex::new(HashMap::new())),
        }
    }

    pub fn carrier_kind(&self) -> IrohCarrierKind {
        self.carrier_kind
    }

    pub fn activate(
        &self,
        endpoint_id: EndpointId,
    ) -> Result<PacketCarrierSession, PacketCarrierQueueError> {
        let remote_addr = self.transport.peer_addr(endpoint_id);
        let mut session = self.transport.attach_session(remote_addr)?;
        self.active_peers
            .lock()
            .expect("packet carrier provider mutex poisoned")
            .insert(endpoint_id, session.session_id);
        session.activation = Some(PacketCarrierActivation {
            endpoint_id,
            session_id: session.session_id,
            active_peers: self.active_peers.clone(),
        });
        Ok(session)
    }

    // `PacketCarrierSession` is the sole deactivation capability. Its private
    // session id fences delayed cleanup from an older attempt after a new
    // attempt has activated the same endpoint. An endpoint-only deactivate
    // operation would bypass that fence and can strand the replacement on
    // relay even though its physical carrier is connected.
    pub fn prepared_endpoint_addr(&self, endpoint_id: EndpointId) -> anyhow::Result<EndpointAddr> {
        anyhow::ensure!(
            self.active_peers
                .lock()
                .expect("packet carrier provider mutex poisoned")
                .contains_key(&endpoint_id),
            "packet carrier session is not active for {endpoint_id}"
        );
        Ok(EndpointAddr::new(endpoint_id)
            .with_addrs([TransportAddr::Custom(self.transport.peer_addr(endpoint_id))]))
    }
}

#[cfg(not(target_arch = "wasm32"))]
#[async_trait::async_trait]
impl crate::client::UpgradeProvider for PacketCarrierAddressProvider {
    fn kind(&self) -> crate::client::IrohPathKind {
        match self.carrier_kind {
            IrohCarrierKind::WebRtc => crate::client::IrohPathKind::WebRtc,
            IrohCarrierKind::Moq => crate::client::IrohPathKind::Moq,
        }
    }

    fn transport_id(&self) -> u64 {
        self.transport.transport_id()
    }

    async fn prepare_endpoint_addr(&self, endpoint_id: EndpointId) -> anyhow::Result<EndpointAddr> {
        self.prepared_endpoint_addr(endpoint_id)
    }
}

impl CustomTransport for PacketCarrierTransport {
    fn bind(&self) -> io::Result<Box<dyn CustomEndpoint>> {
        Ok(Box::new(PacketCarrierEndpoint {
            local_addrs: self.local_addrs.clone(),
            state: self.state.clone(),
        }))
    }
}

#[derive(Debug)]
struct PacketCarrierEndpoint {
    local_addrs: n0_watcher::Watchable<Vec<CustomAddr>>,
    state: Arc<Mutex<PacketCarrierState>>,
}

impl CustomEndpoint for PacketCarrierEndpoint {
    fn watch_local_addrs(&self) -> n0_watcher::Direct<Vec<CustomAddr>> {
        self.local_addrs.watch()
    }

    fn create_sender(&self) -> Arc<dyn CustomSender> {
        Arc::new(PacketCarrierSender {
            state: self.state.clone(),
        })
    }

    fn poll_recv(
        &mut self,
        cx: &mut Context,
        bufs: &mut [io::IoSliceMut<'_>],
        metas: &mut [noq_udp::RecvMeta],
        recv_infos: &mut [RecvInfo],
    ) -> Poll<io::Result<usize>> {
        debug_assert_eq!(bufs.len(), metas.len());
        debug_assert_eq!(bufs.len(), recv_infos.len());
        let mut state = self.state.lock().expect("packet carrier mutex poisoned");
        let mut count = 0;
        while count < bufs.len() {
            let Some(packet) = state.inbound.pop_front() else {
                break;
            };
            if packet.bytes.len() > bufs[count].len() {
                state.inbound.push_front(packet);
                return Poll::Ready(Err(io::Error::new(
                    io::ErrorKind::InvalidData,
                    "Iroh receive buffer is smaller than carrier packet",
                )));
            }
            bufs[count][..packet.bytes.len()].copy_from_slice(&packet.bytes);
            let mut meta = noq_udp::RecvMeta::default();
            meta.len = packet.bytes.len();
            meta.stride = packet.bytes.len();
            metas[count] = meta;
            recv_infos[count] = RecvInfo::new(packet.remote, Some(packet.local));
            count += 1;
        }
        if count > 0 {
            for _ in 0..count {
                state.inbound_space.notify_one();
            }
            Poll::Ready(Ok(count))
        } else if state.closed {
            Poll::Ready(Err(io::Error::new(
                io::ErrorKind::BrokenPipe,
                "packet carrier closed",
            )))
        } else {
            state.recv_waker = Some(cx.waker().clone());
            Poll::Pending
        }
    }
}

#[derive(Debug)]
struct PacketCarrierSender {
    state: Arc<Mutex<PacketCarrierState>>,
}

impl PacketCarrierSender {
    fn poll_send_packet(
        &self,
        cx: &mut Context<'_>,
        dst: &CustomAddr,
        contents: &[u8],
    ) -> Poll<io::Result<()>> {
        let mut state = self.state.lock().expect("packet carrier mutex poisoned");
        if state.closed {
            return Poll::Ready(Err(io::Error::new(
                io::ErrorKind::BrokenPipe,
                "packet carrier closed",
            )));
        }
        let Some(session) = state.outbound.get(dst).cloned() else {
            return Poll::Ready(Err(io::Error::new(
                io::ErrorKind::NotConnected,
                "carrier session is not attached",
            )));
        };
        match session.sender.try_send(contents.to_vec()) {
            Ok(()) => Poll::Ready(Ok(())),
            Err(async_channel::TrySendError::Full(_)) => {
                state
                    .outbound_space_wakers
                    .insert(dst.clone(), (session.id, cx.waker().clone()));
                Poll::Pending
            }
            Err(async_channel::TrySendError::Closed(_)) => Poll::Ready(Err(io::Error::new(
                io::ErrorKind::BrokenPipe,
                "carrier session closed",
            ))),
        }
    }
}

impl CustomSender for PacketCarrierSender {
    fn is_valid_send_addr(&self, addr: &CustomAddr) -> bool {
        self.state
            .lock()
            .map(|state| state.outbound.contains_key(addr))
            .unwrap_or(false)
    }

    fn poll_send(
        &self,
        cx: &mut Context,
        dst: &CustomAddr,
        _src: Option<&CustomAddr>,
        transmit: &Transmit<'_>,
    ) -> Poll<io::Result<()>> {
        if transmit.segment_size.is_some() {
            return Poll::Ready(Err(io::Error::new(
                io::ErrorKind::InvalidInput,
                "packet carrier does not accept GSO batches",
            )));
        }
        if transmit.contents.is_empty() || transmit.contents.len() > MAX_INNER_PACKET_BYTES {
            return Poll::Ready(Err(io::Error::new(
                io::ErrorKind::InvalidData,
                "invalid inner Iroh packet size",
            )));
        }
        self.poll_send_packet(cx, dst, transmit.contents)
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum PacketCarrierQueueError {
    Empty,
    Closed,
    Backpressure,
    PacketSize(usize),
    WrongTransport { expected: u64, actual: u64 },
    DuplicateSession,
}

impl std::fmt::Display for PacketCarrierQueueError {
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(formatter, "{self:?}")
    }
}

impl std::error::Error for PacketCarrierQueueError {}

#[cfg(test)]
mod tests {
    use super::*;
    use iroh::endpoint::transports::CustomTransport;
    use iroh::Watcher;

    #[derive(Debug, Default)]
    struct WakeFlag(std::sync::atomic::AtomicBool);

    impl std::task::Wake for WakeFlag {
        fn wake(self: Arc<Self>) {
            self.0.store(true, std::sync::atomic::Ordering::SeqCst);
        }

        fn wake_by_ref(self: &Arc<Self>) {
            self.0.store(true, std::sync::atomic::Ordering::SeqCst);
        }
    }

    #[test]
    fn attach_is_transport_scoped_and_duplicate_safe() {
        let transport =
            PacketCarrierTransport::new(0x57_52_54_43, iroh::SecretKey::generate().public())
                .unwrap();
        let remote = transport.session_addr([9; 16]);
        let session = transport.attach_session(remote.clone()).unwrap();
        assert_eq!(session.remote_addr(), &remote);
        assert_eq!(
            transport.attach_session(remote).unwrap_err(),
            PacketCarrierQueueError::DuplicateSession
        );
        assert_eq!(
            session.try_recv_outbound(),
            Err(PacketCarrierQueueError::Empty),
            "a rejected duplicate must not replace or close the live session"
        );
    }

    #[test]
    fn explicit_retirement_allows_replacement_and_stale_drop_cannot_remove_it() {
        let transport =
            PacketCarrierTransport::new(0x4d_4f_51, iroh::SecretKey::generate().public()).unwrap();
        let remote = transport.session_addr([7; 16]);
        let stale = transport.attach_session(remote.clone()).unwrap();
        stale.close();
        let replacement = transport.attach_session(remote.clone()).unwrap();

        drop(stale);

        let sender = PacketCarrierSender {
            state: transport.state.clone(),
        };
        let waker = futures::task::noop_waker();
        let mut context = Context::from_waker(&waker);
        assert!(matches!(
            sender.poll_send_packet(&mut context, &remote, b"replacement"),
            Poll::Ready(Ok(()))
        ));
        assert_eq!(replacement.try_recv_outbound().unwrap(), b"replacement");
    }

    #[test]
    fn inbound_queue_applies_bounded_backpressure() {
        let transport = PacketCarrierTransport::with_capacity(
            0x4d_4f_51,
            iroh::SecretKey::generate().public(),
            1,
        )
        .unwrap();
        let session = transport
            .attach_session(transport.session_addr([3; 16]))
            .unwrap();
        session.try_deliver_inbound(vec![1]).unwrap();
        assert_eq!(
            session.try_deliver_inbound(vec![2]),
            Err(PacketCarrierQueueError::Backpressure)
        );
    }

    #[test]
    fn outbound_queue_wakes_iroh_after_bounded_backpressure() {
        let transport = PacketCarrierTransport::with_capacity(
            0x4d_4f_51,
            iroh::SecretKey::generate().public(),
            1,
        )
        .unwrap();
        let remote = transport.session_addr([5; 16]);
        let session = transport.attach_session(remote.clone()).unwrap();
        let sender = PacketCarrierSender {
            state: transport.state.clone(),
        };
        let wake_flag = Arc::new(WakeFlag::default());
        let waker = std::task::Waker::from(wake_flag.clone());
        let mut context = Context::from_waker(&waker);

        assert!(matches!(
            sender.poll_send_packet(&mut context, &remote, &[1]),
            Poll::Ready(Ok(()))
        ));
        assert!(matches!(
            sender.poll_send_packet(&mut context, &remote, &[2]),
            Poll::Pending
        ));
        assert!(!wake_flag.0.load(std::sync::atomic::Ordering::SeqCst));

        assert_eq!(session.try_recv_outbound().unwrap(), vec![1]);
        assert!(wake_flag.0.load(std::sync::atomic::Ordering::SeqCst));
        assert!(matches!(
            sender.poll_send_packet(&mut context, &remote, &[2]),
            Poll::Ready(Ok(()))
        ));
    }

    #[tokio::test]
    async fn async_inbound_delivery_waits_for_bounded_queue_space() {
        let transport = PacketCarrierTransport::with_capacity(
            0x4d_4f_51,
            iroh::SecretKey::generate().public(),
            1,
        )
        .unwrap();
        let session = Arc::new(
            transport
                .attach_session(transport.session_addr([4; 16]))
                .unwrap(),
        );
        session.try_deliver_inbound(vec![1]).unwrap();
        let pending = {
            let session = session.clone();
            tokio::spawn(async move { session.deliver_inbound(vec![2]).await })
        };
        tokio::task::yield_now().await;
        assert!(!pending.is_finished());

        let mut endpoint = transport.bind().unwrap();
        let mut bytes = [0_u8; MAX_INNER_PACKET_BYTES];
        let mut buffers = [io::IoSliceMut::new(&mut bytes)];
        let mut metas = [noq_udp::RecvMeta::default()];
        let mut infos = [RecvInfo::default()];
        let waker = futures::task::noop_waker();
        let mut context = Context::from_waker(&waker);
        assert!(matches!(
            endpoint.poll_recv(&mut context, &mut buffers, &mut metas, &mut infos),
            Poll::Ready(Ok(1))
        ));
        pending.await.unwrap().unwrap();
    }

    #[tokio::test]
    async fn retired_session_cannot_deliver_into_its_replacement_generation() {
        let transport = PacketCarrierTransport::with_capacity(
            0x4d_4f_51,
            iroh::SecretKey::generate().public(),
            1,
        )
        .unwrap();
        let remote = transport.session_addr([6; 16]);
        let stale = Arc::new(transport.attach_session(remote.clone()).unwrap());
        stale.try_deliver_inbound(vec![1]).unwrap();
        let pending = {
            let stale = stale.clone();
            tokio::spawn(async move { stale.deliver_inbound(vec![2]).await })
        };
        tokio::task::yield_now().await;
        assert!(!pending.is_finished());

        stale.close();
        let replacement = transport.attach_session(remote).unwrap();
        assert_eq!(
            tokio::time::timeout(std::time::Duration::from_secs(1), pending)
                .await
                .expect("retiring the stale session must wake its blocked delivery")
                .unwrap(),
            Err(PacketCarrierQueueError::Closed),
            "a delivery blocked by the retired session must not enter the replacement queue",
        );
        replacement.try_deliver_inbound(vec![3]).unwrap();

        let mut endpoint = transport.bind().unwrap();
        let mut bytes = [0_u8; MAX_INNER_PACKET_BYTES];
        let mut buffers = [io::IoSliceMut::new(&mut bytes)];
        let mut metas = [noq_udp::RecvMeta::default()];
        let mut infos = [RecvInfo::default()];
        let waker = futures::task::noop_waker();
        let mut context = Context::from_waker(&waker);
        assert!(matches!(
            endpoint.poll_recv(&mut context, &mut buffers, &mut metas, &mut infos),
            Poll::Ready(Ok(1))
        ));
        assert_eq!(&bytes[..metas[0].len], &[3]);
    }

    #[test]
    fn custom_transport_binds_without_owning_an_iroh_endpoint() {
        let transport =
            PacketCarrierTransport::new(0x57_52_54_43, iroh::SecretKey::generate().public())
                .unwrap();
        let endpoint = transport.bind().unwrap();
        assert_eq!(
            endpoint.watch_local_addrs().get(),
            vec![transport.local_addr().clone()]
        );
    }

    #[tokio::test]
    async fn prepared_address_is_custom_only_and_requires_active_session() {
        let transport_id = 0x57_52_54_43;
        let local = iroh::SecretKey::generate().public();
        let remote = iroh::SecretKey::generate().public();
        let transport = Arc::new(PacketCarrierTransport::new(transport_id, local).unwrap());
        let provider = PacketCarrierAddressProvider::new(IrohCarrierKind::WebRtc, transport);

        assert!(provider.prepared_endpoint_addr(remote).is_err());
        let _session = provider.activate(remote).unwrap();
        let addr = provider.prepared_endpoint_addr(remote).unwrap();

        assert_eq!(addr.addrs.len(), 1);
        assert!(addr.addrs.iter().all(TransportAddr::is_custom));
    }

    #[tokio::test]
    async fn delayed_stale_cleanup_cannot_deactivate_replacement_session() {
        let transport_id = 0x57_52_54_43;
        let local = iroh::SecretKey::generate().public();
        let remote = iroh::SecretKey::generate().public();
        let transport = Arc::new(PacketCarrierTransport::new(transport_id, local).unwrap());
        let provider = PacketCarrierAddressProvider::new(IrohCarrierKind::WebRtc, transport);

        let stale = provider.activate(remote).unwrap();
        assert!(provider.prepared_endpoint_addr(remote).is_ok());
        stale.close();
        assert!(
            provider.prepared_endpoint_addr(remote).is_err(),
            "a failed or retired setup must not leave a prepared carrier marker behind",
        );

        let replacement = provider.activate(remote).unwrap();
        stale.close();
        drop(stale);
        assert!(
            provider.prepared_endpoint_addr(remote).is_ok(),
            "a stale session drop must not deactivate its replacement",
        );
        drop(replacement);
        assert!(provider.prepared_endpoint_addr(remote).is_err());
    }

    #[tokio::test]
    async fn normal_iroh_alpn_and_bi_stream_cross_packet_carrier() {
        use iroh::{endpoint::presets, Endpoint, RelayMode};

        const TEST_ALPN: &[u8] = b"openrtc/test/packet-carrier/1";
        const TEST_TRANSPORT_ID: u64 = 0x4f_52_54_54;

        let secret_a = iroh::SecretKey::generate();
        let secret_b = iroh::SecretKey::generate();
        let endpoint_id_a = secret_a.public();
        let endpoint_id_b = secret_b.public();
        let transport_a =
            Arc::new(PacketCarrierTransport::new(TEST_TRANSPORT_ID, endpoint_id_a).unwrap());
        let transport_b =
            Arc::new(PacketCarrierTransport::new(TEST_TRANSPORT_ID, endpoint_id_b).unwrap());
        let session_a = Arc::new(
            transport_a
                .attach_session(transport_a.peer_addr(endpoint_id_b))
                .unwrap(),
        );
        let session_b = Arc::new(
            transport_b
                .attach_session(transport_b.peer_addr(endpoint_id_a))
                .unwrap(),
        );

        let endpoint_a = Endpoint::builder(presets::N0)
            .secret_key(secret_a)
            .relay_mode(RelayMode::Disabled)
            .clear_ip_transports()
            .alpns(vec![TEST_ALPN.to_vec()])
            .add_custom_transport(transport_a)
            .bind()
            .await
            .unwrap();
        let endpoint_b = Endpoint::builder(presets::N0)
            .secret_key(secret_b)
            .relay_mode(RelayMode::Disabled)
            .clear_ip_transports()
            .alpns(vec![TEST_ALPN.to_vec()])
            .add_custom_transport(transport_b)
            .bind()
            .await
            .unwrap();

        let pump_a = {
            let source = session_a.clone();
            let destination = session_b.clone();
            tokio::spawn(async move {
                while let Ok(packet) = source.recv_outbound().await {
                    destination.try_deliver_inbound(packet).unwrap();
                }
            })
        };
        let pump_b = {
            let source = session_b.clone();
            let destination = session_a.clone();
            tokio::spawn(async move {
                while let Ok(packet) = source.recv_outbound().await {
                    destination.try_deliver_inbound(packet).unwrap();
                }
            })
        };

        let server = {
            let endpoint_b = endpoint_b.clone();
            tokio::spawn(async move {
                let incoming = endpoint_b.accept().await.expect("incoming connection");
                let connection = incoming.await.expect("accepted packet-carrier connection");
                assert_eq!(connection.alpn(), TEST_ALPN);
                let (mut send, mut recv) = connection.accept_bi().await.unwrap();
                let request = recv.read_to_end(1024).await.unwrap();
                assert_eq!(request, b"normal-iroh-stream");
                send.write_all(b"protected-response").await.unwrap();
                send.finish().unwrap();
                // Retain the accepted connection until the initiator has read
                // the response and explicitly closes it. Dropping the final
                // server-side handle here would race the stream read with an
                // application-close frame.
                let _ = connection.closed().await;
            })
        };

        let address_b = EndpointAddr::new(endpoint_id_b)
            .with_addrs([TransportAddr::Custom(session_a.remote_addr().clone())]);
        let connection = tokio::time::timeout(
            std::time::Duration::from_secs(10),
            endpoint_a.connect(address_b, TEST_ALPN),
        )
        .await
        .expect("packet-carrier connect timed out")
        .expect("packet-carrier connect failed");
        let selected_custom = connection.paths().iter().any(|path| {
            path.is_selected()
                && matches!(
                    path.remote_addr(),
                    TransportAddr::Custom(address) if address.id() == TEST_TRANSPORT_ID
                )
        });
        assert!(selected_custom, "custom carrier path was not selected");

        let (mut send, mut recv) = connection.open_bi().await.unwrap();
        send.write_all(b"normal-iroh-stream").await.unwrap();
        send.finish().unwrap();
        let response = recv.read_to_end(1024).await.unwrap();
        assert_eq!(response, b"protected-response");

        connection.close(0u8.into(), b"test-complete");
        server.await.unwrap();
        endpoint_a.close().await;
        endpoint_b.close().await;
        pump_a.abort();
        pump_b.abort();
    }
}