simulcrypt 0.2.0

DVB SimulCrypt (ETSI TS 103 197) head-end protocol: ECMG client, EMMG server, control words
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
//! One CAS channel: its ECMG driver, EMMG registration and streams.

use std::{
    collections::{
        HashMap,
        HashSet,
    },
    sync::{
        Arc,
        Mutex,
        Weak,
        atomic::{
            AtomicU16,
            AtomicU64,
            Ordering,
        },
    },
    time::{
        Duration,
        SystemTime,
    },
};

use tokio::{
    sync::{
        broadcast,
        mpsc,
    },
    task::AbortHandle,
};

use crate::{
    config::CasConfig,
    cw::CwAdvance,
    ecmg::driver::{
        DriverConfig,
        DriverEvent,
        DriverHandle,
        DriverState,
    },
    emmg::{
        Dispatch,
        EmmEvent,
        EmmgListeners,
    },
    error::Error,
    event::{
        CasError,
        CasParams,
        CasState,
        CasStatus,
        Event,
        StreamInfo,
        StreamStatus,
    },
    lock_ext::MutexExt,
    service::{
        Member,
        ServiceGroup,
    },
    simulcrypt::CasRef,
    spawn::spawn_supervised,
};

/// Which CW group a `(CasRef, ecm_pid)` pair is bound to on a given CAS channel.
#[derive(Clone)]
pub struct StreamMembership {
    pub stream_id: u16,
    pub group: Weak<ServiceGroup>,
}

pub struct CasEntry {
    /// Current settings; `Simulcrypt::acquire_cas` with the same `id` replaces them.
    settings: Mutex<CasSettings>,
    /// `None` when no streams are left on the channel and `Drop for Service` closed it (see
    /// [`CasEntry::shutdown`]). The `CasRef` stays valid - the next `open_service` with the same
    /// `CasRef` brings the channel back up via [`CasEntry::ensure_running`].
    driver: Mutex<Option<DriverHandle>>,
    /// Bumped on every driver start and stop: late events of a replaced driver are dropped.
    generation: AtomicU64,
    state: Mutex<CasState>,
    used_ecm_pids: Mutex<HashMap<u16, StreamMembership>>,
    next_stream_offset: AtomicU16,
    stream_sinks: Mutex<HashMap<u16, StreamSlot>>,
    /// Completed ECMG handshakes (see [`CasStatus::connects`]).
    connects: AtomicU64,
    last_error: Mutex<Option<CasError>>,
    /// Streams that have completed the handshake so far. Rebuilt completely on every
    /// `CasState::Ready` (a reconnect replays the handshake for all known streams) and extended
    /// one by one when `add_stream` on an already ready channel succeeds.
    ready_streams: Mutex<HashSet<u16>>,
    /// Pending `driver.add_stream(...)` tasks. Aborted when the stream itself goes away (see
    /// `Drop for Service`) - otherwise a task could finish after `stream_sinks`/`used_ecm_pids`
    /// for this `stream_id` were removed and leave an entry in `ready_streams` that nobody
    /// would remove.
    pending_add_stream: Mutex<HashMap<u16, AbortHandle>>,
}

struct CasSettings {
    config: CasConfig,
    /// EMMG channel, registered for the whole CAS lifetime independently of the ECMG driver.
    emmg: Option<Dispatch>,
}

impl CasSettings {
    /// The EMMG dispatcher with this CAS's `(super_cas_id, channel_id)` on it.
    fn emmg_channel(&self) -> Option<(Dispatch, u32, u16)> {
        self.emmg.clone().map(|dispatch| {
            (
                dispatch,
                self.config.super_cas_id,
                self.config.ecmg.channel_id,
            )
        })
    }
}

/// Warns when the crypto period announced for a stream is shorter than the ECMG accepts: the
/// ECMG may reject its CW_PROVISION or produce ECM late.
fn warn_if_below_min_cp(
    name: &str,
    stream_id: u16,
    nominal_cp_duration: u16,
    min_cp_duration: Duration,
) {
    let crypto_period = Duration::from_millis(u64::from(nominal_cp_duration) * 100);
    if crypto_period < min_cp_duration {
        tracing::warn!(
            name,
            stream_id,
            crypto_period = ?crypto_period,
            min_cp_duration = ?min_cp_duration,
            "crypto_period is shorter than the ECMG min_CP_duration"
        );
    }
}

fn driver_config(cfg: &CasConfig) -> DriverConfig {
    DriverConfig {
        name: cfg.name.clone(),
        channel_id: cfg.ecmg.channel_id,
        super_cas_id: cfg.super_cas_id,
        addr: cfg.ecmg.addr,
        reconnect_delay: cfg.ecmg.reconnect_delay,
        response_timeout: cfg.ecmg.response_timeout,
        idle_probe_interval: cfg.ecmg.idle_probe_interval,
    }
}

impl CasEntry {
    pub fn new(config: CasConfig, emmg: Option<Dispatch>) -> Arc<Self> {
        Arc::new(Self {
            settings: Mutex::new(CasSettings { config, emmg }),
            driver: Mutex::new(None),
            generation: AtomicU64::new(0),
            state: Mutex::new(CasState::Connecting),
            used_ecm_pids: Mutex::new(HashMap::new()),
            next_stream_offset: AtomicU16::new(0),
            stream_sinks: Mutex::new(HashMap::new()),
            connects: AtomicU64::new(0),
            last_error: Mutex::new(None),
            ready_streams: Mutex::new(HashSet::new()),
            pending_add_stream: Mutex::new(HashMap::new()),
        })
    }

    /// Starts the ECMG driver if the channel is "sleeping" after the `Drop` of the last `Service`
    /// closed it (see [`CasEntry::shutdown`]); otherwise does nothing. Called under
    /// `Inner::topology`, together with binding the first new stream on this channel: a concurrent
    /// `Drop` that could see the channel in an intermediate state is excluded by the same lock.
    pub fn ensure_running(self: &Arc<Self>, cas: CasRef) {
        let mut driver_slot = self.driver.lock_or_recover();
        if driver_slot.is_some() {
            return;
        }

        let driver_config = driver_config(&self.settings.lock_or_recover().config);
        let generation = self.generation.fetch_add(1, Ordering::Relaxed) + 1;
        let (events_tx, events_rx) = mpsc::unbounded_channel();
        let handle = DriverHandle::spawn(driver_config, events_tx);
        spawn_supervised(
            "forward-driver-events",
            Arc::clone(self).forward_driver_events(cas, generation, events_rx),
        );

        *self.state.lock_or_recover() = CasState::Connecting;
        *driver_slot = Some(handle);
    }

    /// Stops the ECMG driver. The `CasRef` stays valid - the next `open_service` with it brings
    /// the channel back up via [`CasEntry::ensure_running`].
    fn shutdown(&self) {
        // Dropping the last `DriverHandle` closes the channel with CHANNEL_CLOSE; pending
        // `add_stream` tasks hold clones of it.
        for (_, handle) in self.pending_add_stream.lock_or_recover().drain() {
            handle.abort();
        }
        self.driver.lock_or_recover().take();
        self.generation.fetch_add(1, Ordering::Relaxed);
        self.ready_streams.lock_or_recover().clear();
        *self.state.lock_or_recover() = CasState::Disconnected;
    }

    /// Applies new settings to a live CAS: the EMMG channel moves if its port or `channel_id`
    /// changed, `udp` turned on binds UDP on the port, and a running ECMG driver restarts if its
    /// connection settings changed. Open streams are kept and set up again on the new connection.
    /// The caller holds `topology`.
    pub fn update(
        self: &Arc<Self>,
        listeners: &EmmgListeners,
        cas: CasRef,
        cfg: CasConfig,
    ) -> Result<(), Error> {
        let (old, old_emmg) = {
            let settings = self.settings.lock_or_recover();
            (settings.config.clone(), settings.emmg.clone())
        };
        if old == cfg {
            return Ok(());
        }

        let old_port = old.emmg.as_ref().map(|emmg| emmg.port);
        let new_port = cfg.emmg.as_ref().map(|emmg| emmg.port);
        let emmg = if old_port.is_some()
            && old_port == new_port
            && old.ecmg.channel_id == cfg.ecmg.channel_id
            && old.super_cas_id == cfg.super_cas_id
        {
            if let (Some(dispatch), Some(emmg)) = (&old_emmg, &cfg.emmg) {
                listeners.ensure_udp(emmg)?;
                dispatch.set_broadcast(cfg.super_cas_id, cfg.ecmg.channel_id, emmg.broadcast);
            }
            old_emmg
        } else {
            let new_emmg = match &cfg.emmg {
                Some(emmg) => Some(listeners.register(&cfg, emmg)?),
                None => None,
            };
            if let Some(dispatch) = &new_emmg {
                let sinks: Vec<_> = self
                    .stream_sinks
                    .lock_or_recover()
                    .iter()
                    .map(|(stream_id, slot)| (*stream_id, slot.clone()))
                    .collect();
                for (stream_id, slot) in sinks {
                    register_emmg_stream(
                        cas,
                        &cfg.name,
                        dispatch,
                        (cfg.super_cas_id, cfg.ecmg.channel_id),
                        stream_id,
                        &slot,
                    );
                }
            }
            if let (Some(dispatch), Some(port)) = (old_emmg, old_port) {
                listeners.unregister(&dispatch, port, old.super_cas_id, old.ecmg.channel_id);
            }
            new_emmg
        };

        let restart =
            (&old.name, old.super_cas_id, &old.ecmg) != (&cfg.name, cfg.super_cas_id, &cfg.ecmg);
        *self.settings.lock_or_recover() = CasSettings { config: cfg, emmg };

        if restart && self.driver.lock_or_recover().is_some() {
            self.shutdown();
            self.ensure_running(cas);
            let streams: Vec<_> = self
                .used_ecm_pids
                .lock_or_recover()
                .values()
                .filter_map(|membership| {
                    let group = membership.group.upgrade()?;
                    Some((membership.stream_id, group.nominal_cp_duration()))
                })
                .collect();
            for (stream_id, nominal_cp_duration) in streams {
                add_ecmg_stream(self, stream_id, nominal_cp_duration);
            }
        }

        Ok(())
    }

    fn check_min_cp_duration(&self, min_cp_duration: Duration) {
        let name = self.settings.lock_or_recover().config.name.clone();
        for membership in self.used_ecm_pids.lock_or_recover().values() {
            if let Some(group) = membership.group.upgrade() {
                warn_if_below_min_cp(
                    &name,
                    membership.stream_id,
                    group.nominal_cp_duration(),
                    min_cp_duration,
                );
            }
        }
    }

    pub fn status(&self, cas: CasRef) -> CasStatus {
        let memberships: Vec<_> = self
            .used_ecm_pids
            .lock_or_recover()
            .iter()
            .map(|(ecm_pid, membership)| (*ecm_pid, membership.clone()))
            .collect();
        let mut streams: Vec<StreamStatus> = memberships
            .into_iter()
            .map(|(ecm_pid, membership)| {
                let stream_id = membership.stream_id;
                let counters = self
                    .stream_sinks
                    .lock_or_recover()
                    .get(&stream_id)
                    .map(|slot| Arc::clone(&slot.counters))
                    .unwrap_or_default();
                StreamStatus {
                    stream_id,
                    ecm_pid,
                    ready: self.ready_streams.lock_or_recover().contains(&stream_id),
                    cp_number: membership
                        .group
                        .upgrade()
                        .and_then(|group| group.cp_number()),
                    ecm: counters.ecm.load(Ordering::Relaxed),
                    ecm_stale: counters.ecm_stale.load(Ordering::Relaxed),
                    emm: counters.emm.load(Ordering::Relaxed),
                }
            })
            .collect();
        streams.sort_by_key(|stream| stream.stream_id);

        CasStatus {
            cas,
            name: self.settings.lock_or_recover().config.name.clone(),
            state: self.state.lock_or_recover().clone(),
            last_error: self.last_error.lock_or_recover().clone(),
            connects: self.connects.load(Ordering::Relaxed),
            streams,
        }
    }

    /// Closes the channel for good when its last lease drops: stops the driver, unregisters the
    /// EMMG channel and detaches the streams from their CW groups. The caller holds `topology`.
    pub fn detach(&self, emmg: &EmmgListeners, cas: CasRef) {
        self.shutdown();

        let settings = self.settings.lock_or_recover();
        if let (Some(dispatch), Some(emmg_cfg)) = (&settings.emmg, &settings.config.emmg) {
            emmg.unregister(
                dispatch,
                emmg_cfg.port,
                settings.config.super_cas_id,
                settings.config.ecmg.channel_id,
            );
        }
        drop(settings);

        for (_, membership) in self.used_ecm_pids.lock_or_recover().drain() {
            if let Some(group) = membership.group.upgrade() {
                group.remove_member(cas, membership.stream_id);
            }
        }
        for (_, slot) in self.stream_sinks.lock_or_recover().drain() {
            let _ = slot.sink.send(Event::State {
                cas,
                state: CasState::Disconnected,
            });
        }
    }

    /// The current connection state, as the first event of a new `Service`.
    pub fn state_event(&self, cas: CasRef) -> Event {
        Event::State {
            cas,
            state: self.state.lock_or_recover().clone(),
        }
    }

    /// Parameters of a ready channel.
    pub fn params(&self) -> Option<CasParams> {
        match &*self.state.lock_or_recover() {
            CasState::Ready(params) => Some(*params),
            _ => None,
        }
    }

    /// EMM PID and broadcast flag of the EMMG.
    pub fn emm_pid(&self) -> Option<(u16, bool)> {
        let settings = self.settings.lock_or_recover();
        let emmg = settings.config.emmg.as_ref()?;
        Some((emmg.pid?, emmg.broadcast))
    }

    /// The last ECM of `stream_id`, for a `Service` that joins it and for its ECM carousel.
    pub fn last_ecm(&self, stream_id: u16) -> Option<Event> {
        let slot = self
            .stream_sinks
            .lock_or_recover()
            .get(&stream_id)
            .cloned()?;
        slot.last_ecm.lock_or_recover().clone()
    }

    pub fn membership(&self, ecm_pid: u16) -> Option<StreamMembership> {
        self.used_ecm_pids.lock_or_recover().get(&ecm_pid).cloned()
    }

    pub fn is_stream_ready(&self, stream_id: u16) -> bool {
        self.ready_streams.lock_or_recover().contains(&stream_id)
    }

    /// Queues the group's new CW for one member stream.
    pub fn provision_cw(&self, member: Member, advance: &CwAdvance) {
        // The channel may have closed between reading the members and this point: skip this
        // member only, the next tick sees the group as it is.
        let Some(driver) = self.driver.lock_or_recover().clone() else {
            return;
        };
        let access_criteria =
            (!member.access_criteria.is_empty()).then_some(member.access_criteria);
        if let Err(error) = driver.provision_cw(
            member.stream_id,
            advance.cp_number,
            advance.current,
            advance.next,
            access_criteria,
        ) {
            tracing::warn!(
                name = %self.settings.lock_or_recover().config.name,
                stream_id = member.stream_id,
                error = %error,
                "failed to queue CW_PROVISION"
            );
        }
    }

    /// Allocates a free `stream_id` for `ecm_pid` and binds it to `group`. The caller must make
    /// sure beforehand (under `Inner::topology`) that `ecm_pid` is not taken by a LIVE FOREIGN
    /// group - this function simply overwrites the entry.
    pub fn attach_stream(&self, ecm_pid: u16, group: &Weak<ServiceGroup>) -> u16 {
        let first_stream_id = self.settings.lock_or_recover().config.first_stream_id;
        let mut used_ecm_pids = self.used_ecm_pids.lock_or_recover();
        // Terminates: at most 8192 ecm_pids are in use out of 65536 stream_ids.
        let stream_id = loop {
            let offset = self.next_stream_offset.fetch_add(1, Ordering::Relaxed);
            let stream_id = first_stream_id.wrapping_add(offset);
            if !used_ecm_pids
                .values()
                .any(|membership| membership.stream_id == stream_id)
            {
                break stream_id;
            }
        };
        used_ecm_pids.insert(
            ecm_pid,
            StreamMembership {
                stream_id,
                group: group.clone(),
            },
        );
        stream_id
    }

    async fn forward_driver_events(
        self: Arc<Self>,
        cas: CasRef,
        generation: u64,
        mut events_rx: mpsc::UnboundedReceiver<DriverEvent>,
    ) {
        while let Some(event) = events_rx.recv().await {
            if self.generation.load(Ordering::Relaxed) != generation {
                return;
            }
            match event {
                DriverEvent::Ecm {
                    stream_id,
                    cp_number,
                    format,
                    data,
                } => {
                    let slot = self.stream_sinks.lock_or_recover().get(&stream_id).cloned();
                    if let Some(slot) = slot {
                        slot.counters.ecm.fetch_add(1, Ordering::Relaxed);
                        let event = Event::Ecm {
                            cas,
                            stream_id,
                            cp_number,
                            format: format.into(),
                            data,
                        };
                        *slot.last_ecm.lock_or_recover() = Some(event.clone());
                        let _ = slot.sink.send(event);
                    }
                }
                DriverEvent::StaleEcm { stream_id } => {
                    if let Some(slot) = self.stream_sinks.lock_or_recover().get(&stream_id) {
                        slot.counters.ecm_stale.fetch_add(1, Ordering::Relaxed);
                    }
                }
                DriverEvent::State(state) => {
                    let (cas_state, ready_stream_ids) = match state {
                        DriverState::Connecting => (CasState::Connecting, None),
                        DriverState::Ready {
                            section_ts_pkt_flag,
                            params,
                            ready_stream_ids,
                        } => (
                            CasState::Ready(CasParams::from_wire(section_ts_pkt_flag, params)),
                            Some(ready_stream_ids),
                        ),
                        DriverState::Error { code, info } => (CasState::Error { code, info }, None),
                        DriverState::Disconnected => (CasState::Disconnected, None),
                    };

                    match &cas_state {
                        CasState::Ready(params) => {
                            self.connects.fetch_add(1, Ordering::Relaxed);
                            if let Some(min_cp_duration) = params.min_cp_duration {
                                self.check_min_cp_duration(min_cp_duration);
                            }
                        }
                        CasState::Error { code, info } => {
                            *self.last_error.lock_or_recover() = Some(CasError {
                                code: *code,
                                info: info.clone(),
                                at: SystemTime::now(),
                            });
                        }
                        CasState::Connecting | CasState::Disconnected => {}
                    }
                    *self.state.lock_or_recover() = cas_state.clone();

                    {
                        let mut ready = self.ready_streams.lock_or_recover();
                        if let Some(ids) = ready_stream_ids {
                            *ready = ids.into_iter().collect();
                        } else {
                            ready.clear();
                        }
                    }

                    let sinks: Vec<_> = self
                        .stream_sinks
                        .lock_or_recover()
                        .values()
                        .map(|slot| slot.sink.clone())
                        .collect();
                    for sink in sinks {
                        let _ = sink.send(Event::State {
                            cas,
                            state: cas_state.clone(),
                        });
                    }
                }
            }
        }
    }
}

/// Where events of one stream go, with its counters for [`CasStatus::streams`].
#[derive(Clone)]
struct StreamSlot {
    sink: broadcast::Sender<Event>,
    counters: Arc<StreamCounters>,
    /// The last ECM, replayed to a `Service` that joins the stream.
    last_ecm: Arc<Mutex<Option<Event>>>,
}

#[derive(Default)]
struct StreamCounters {
    ecm: AtomicU64,
    ecm_stale: AtomicU64,
    emm: AtomicU64,
}

/// Registers a freshly allocated stream: the EMMG subscription (if the channel has an EMMG) and
/// ECMG `add_stream`. Shared by a new group and by a new pair added to an existing group on join.
pub fn register_new_member_io(
    cas: CasRef,
    entry: &Arc<CasEntry>,
    stream_id: u16,
    events_tx: &broadcast::Sender<Event>,
    nominal_cp_duration: u16,
) {
    let slot = StreamSlot {
        sink: events_tx.clone(),
        counters: Arc::default(),
        last_ecm: Arc::default(),
    };
    entry
        .stream_sinks
        .lock_or_recover()
        .insert(stream_id, slot.clone());

    let (cas_name, emmg) = {
        let settings = entry.settings.lock_or_recover();
        (settings.config.name.clone(), settings.emmg_channel())
    };
    if let Some((dispatch, super_cas_id, channel_id)) = emmg {
        register_emmg_stream(
            cas,
            &cas_name,
            &dispatch,
            (super_cas_id, channel_id),
            stream_id,
            &slot,
        );
    }

    add_ecmg_stream(entry, stream_id, nominal_cp_duration);
}

fn register_emmg_stream(
    cas: CasRef,
    cas_name: &str,
    dispatch: &Dispatch,
    (super_cas_id, channel_id): (u32, u16),
    stream_id: u16,
    slot: &StreamSlot,
) {
    let (emm_tx, emm_rx) = mpsc::unbounded_channel();
    match dispatch.register_stream(super_cas_id, channel_id, stream_id, emm_tx) {
        Ok(()) => {
            spawn_supervised(
                "forward-emm-events",
                forward_emm_events(cas, emm_rx, slot.clone()),
            );
        }
        Err(error) => {
            tracing::warn!(
                name = cas_name,
                channel_id,
                stream_id,
                error = %error,
                "failed to register EMMG stream"
            );
        }
    }
}

/// Sets the stream up on the ECMG and marks it ready once the ECMG confirms it.
fn add_ecmg_stream(entry: &Arc<CasEntry>, stream_id: u16, nominal_cp_duration: u16) {
    let cas_name = entry.settings.lock_or_recover().config.name.clone();
    // Invariant: the caller has already run `ensure_running` for this entry under the same
    // `topology` lock, so the driver must be present here.
    let Some(driver) = entry.driver.lock_or_recover().clone() else {
        tracing::warn!(
            name = %cas_name,
            stream_id,
            "ECMG driver is not running, cannot add stream"
        );
        return;
    };
    let entry_for_ready = Arc::clone(entry);
    let handle = spawn_supervised("add-stream", async move {
        match driver.add_stream(stream_id, nominal_cp_duration).await {
            Ok(()) => {
                entry_for_ready
                    .ready_streams
                    .lock_or_recover()
                    .insert(stream_id);
                if let CasState::Ready(params) = &*entry_for_ready.state.lock_or_recover()
                    && let Some(min_cp_duration) = params.min_cp_duration
                {
                    warn_if_below_min_cp(
                        &cas_name,
                        stream_id,
                        nominal_cp_duration,
                        min_cp_duration,
                    );
                }
            }
            Err(error) => {
                tracing::warn!(
                    name = %cas_name,
                    stream_id,
                    error = %error,
                    "failed to add ECMG stream"
                );
            }
        }
    });
    entry
        .pending_add_stream
        .lock_or_recover()
        .insert(stream_id, handle);
}

impl CasEntry {
    /// Releases a stream no `Service` uses any more; stops the ECMG driver when it was the last
    /// one. The caller holds `topology`.
    pub fn release_stream(&self, info: &StreamInfo) {
        self.stream_sinks.lock_or_recover().remove(&info.stream_id);
        self.ready_streams.lock_or_recover().remove(&info.stream_id);
        self.used_ecm_pids.lock_or_recover().remove(&info.ecm_pid);

        if let Some(handle) = self
            .pending_add_stream
            .lock_or_recover()
            .remove(&info.stream_id)
        {
            handle.abort();
        }

        let emmg = self.settings.lock_or_recover().emmg_channel();
        if let Some((dispatch, super_cas_id, channel_id)) = emmg {
            dispatch.unregister_stream(super_cas_id, channel_id, info.stream_id);
        }

        // The last stream stops the ECMG driver instead of keeping it until the process exits;
        // the `CasRef` stays valid and the next `open_service` with it brings the channel back up
        // (see `CasEntry::ensure_running`). A full channel close sends CHANNEL_CLOSE by itself
        // (see `driver::handle_command`); a channel that stays alive for other streams gets an
        // explicit STREAM_CLOSE_REQUEST.
        if self.used_ecm_pids.lock_or_recover().is_empty() {
            self.shutdown();
        } else if let Some(driver) = self.driver.lock_or_recover().clone() {
            let _ = driver.remove_stream(info.stream_id);
        }
    }
}

async fn forward_emm_events(
    cas: CasRef,
    mut emm_rx: mpsc::UnboundedReceiver<EmmEvent>,
    slot: StreamSlot,
) {
    while let Some(emm) = emm_rx.recv().await {
        slot.counters.emm.fetch_add(1, Ordering::Relaxed);
        let _ = slot.sink.send(Event::Emm {
            cas,
            stream_id: emm.stream_id,
            data_id: emm.data_id,
            data_type: emm.data_type,
            format: emm.format.into(),
            data: emm.data,
        });
    }
}

#[cfg(test)]
mod tests {
    use std::net::SocketAddr;

    use tokio::net::TcpListener;

    use super::*;
    use crate::{
        EcmgConfig,
        ServiceCas,
        ServiceConfig,
        Simulcrypt,
        messages::{
            RawSimulcryptMessage,
            ecmg::{
                ECMG_MSG_CHANNEL_STATUS,
                ECMG_MSG_STREAM_SETUP,
                ECMG_MSG_STREAM_STATUS,
                ECMG_VAR_CHANNEL_ID,
                ECMG_VAR_SECTION_TS_PKT_FLAG,
                ECMG_VAR_STREAM_ID,
            },
        },
    };

    /// Answers `CHANNEL_SETUP` immediately but delays `STREAM_STATUS` by `delay` - to reliably
    /// hit the window where `driver.add_stream(...)` has not finished yet.
    async fn slow_ecmg(listener: TcpListener, channel_id: u16, delay: Duration) {
        let Ok((mut socket, _)) = listener.accept().await else {
            return;
        };

        if RawSimulcryptMessage::read_from(&mut socket).await.is_err() {
            return;
        }

        let mut status = RawSimulcryptMessage::new(ECMG_MSG_CHANNEL_STATUS);
        status.set_u16(ECMG_VAR_CHANNEL_ID, channel_id);
        status.set_u8(ECMG_VAR_SECTION_TS_PKT_FLAG, 0x00);
        if status.write_to(&mut socket).await.is_err() {
            return;
        }

        loop {
            let Ok(request) = RawSimulcryptMessage::read_from(&mut socket).await else {
                return;
            };

            if request.message_type == ECMG_MSG_STREAM_SETUP
                && let Some(stream_id) = request.get_u16(ECMG_VAR_STREAM_ID)
            {
                tokio::time::sleep(delay).await;
                let mut status = RawSimulcryptMessage::new(ECMG_MSG_STREAM_STATUS);
                status.set_u16(ECMG_VAR_CHANNEL_ID, channel_id);
                status.set_u16(ECMG_VAR_STREAM_ID, stream_id);
                if status.write_to(&mut socket).await.is_err() {
                    return;
                }
            }
        }
    }

    #[tokio::test]
    async fn dropping_service_before_add_stream_completes_leaves_no_ghost_entries() {
        let channel_id = 21;
        let super_cas_id = 0x0600_0006;
        let delay = Duration::from_millis(300);

        let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
        let port = listener.local_addr().unwrap().port();
        tokio::spawn(slow_ecmg(listener, channel_id, delay));

        let mut ecmg_cfg = EcmgConfig::new(channel_id, SocketAddr::from(([127, 0, 0, 1], port)));
        ecmg_cfg.reconnect_delay = Duration::from_millis(200);
        ecmg_cfg.response_timeout = Duration::from_secs(5);

        let simulcrypt = Simulcrypt::new();
        let lease = simulcrypt
            .acquire_cas(CasConfig {
                id: "cas-ghost".into(),
                name: "ghost-cas".into(),
                super_cas_id,
                first_stream_id: 1,
                ecmg: ecmg_cfg,
                emmg: None,
            })
            .unwrap();

        let service = simulcrypt
            .open_service(&ServiceConfig {
                name: "svc-ghost".into(),
                crypto_period: Duration::from_millis(150),
                cas: vec![ServiceCas {
                    cas: lease.cas(),
                    ecm_pid: 900,
                    access_criteria: vec![],
                }],
            })
            .unwrap();
        let stream_id = service.streams()[0].stream_id;

        // Drop right away - STREAM_STATUS from the ECMG only arrives after `delay`, so
        // driver.add_stream(...) for this stream_id has certainly not returned yet.
        drop(service);

        // Wait longer than the ECMG delay: had the task not been aborted, it would have finished
        // and inserted a "ghost" into ready_streams after Drop removed the rest of the
        // registration.
        tokio::time::sleep(delay * 2).await;

        let entry = simulcrypt.entry(lease.cas());

        assert!(
            !entry.ready_streams.lock_or_recover().contains(&stream_id),
            "aborted add_stream task must not resurrect ready_streams after Drop"
        );
        assert!(
            !entry
                .pending_add_stream
                .lock()
                .unwrap()
                .contains_key(&stream_id),
            "the join handle must be removed once the stream is torn down"
        );
        assert!(
            !entry.used_ecm_pids.lock_or_recover().contains_key(&900),
            "ecm_pid must be freed"
        );
    }

    /// Keeps the connection open after the handshake (does not answer `STREAM_SETUP`) and counts
    /// accepted connections - needed to tell "the driver keeps running" from "the driver really
    /// exited and reconnected".
    async fn counting_ecmg(
        listener: TcpListener,
        channel_id: u16,
        accept_count: Arc<std::sync::atomic::AtomicUsize>,
    ) {
        loop {
            let Ok((mut socket, _)) = listener.accept().await else {
                return;
            };
            accept_count.fetch_add(1, std::sync::atomic::Ordering::SeqCst);

            if RawSimulcryptMessage::read_from(&mut socket).await.is_err() {
                continue;
            }
            let mut status = RawSimulcryptMessage::new(ECMG_MSG_CHANNEL_STATUS);
            status.set_u16(ECMG_VAR_CHANNEL_ID, channel_id);
            status.set_u8(ECMG_VAR_SECTION_TS_PKT_FLAG, 0x00);
            if status.write_to(&mut socket).await.is_err() {
                continue;
            }

            // Answer STREAM_SETUP, otherwise `add_stream` times out and triggers a reconnect on
            // its own - that would skew the test's connection counter.
            loop {
                let Ok(request) = RawSimulcryptMessage::read_from(&mut socket).await else {
                    break;
                };
                if request.message_type == ECMG_MSG_STREAM_SETUP
                    && let Some(stream_id) = request.get_u16(ECMG_VAR_STREAM_ID)
                {
                    let mut status = RawSimulcryptMessage::new(ECMG_MSG_STREAM_STATUS);
                    status.set_u16(ECMG_VAR_CHANNEL_ID, channel_id);
                    status.set_u16(ECMG_VAR_STREAM_ID, stream_id);
                    if status.write_to(&mut socket).await.is_err() {
                        break;
                    }
                }
            }
        }
    }

    #[tokio::test]
    async fn dropping_last_stream_shuts_down_channel_and_reopening_revives_it() {
        let channel_id = 22;
        let super_cas_id = 0x0600_0007;
        let reconnect_delay = Duration::from_millis(50);

        let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
        let port = listener.local_addr().unwrap().port();
        let accept_count = Arc::new(std::sync::atomic::AtomicUsize::new(0));
        tokio::spawn(counting_ecmg(
            listener,
            channel_id,
            Arc::clone(&accept_count),
        ));

        let mut ecmg_cfg = EcmgConfig::new(channel_id, SocketAddr::from(([127, 0, 0, 1], port)));
        ecmg_cfg.reconnect_delay = reconnect_delay;
        ecmg_cfg.response_timeout = Duration::from_secs(5);

        let simulcrypt = Simulcrypt::new();
        let lease = simulcrypt
            .acquire_cas(CasConfig {
                id: "cas-teardown".into(),
                name: "teardown-cas".into(),
                super_cas_id,
                first_stream_id: 1,
                ecmg: ecmg_cfg,
                emmg: None,
            })
            .unwrap();

        let service = simulcrypt
            .open_service(&ServiceConfig {
                name: "svc-teardown".into(),
                crypto_period: Duration::from_millis(150),
                cas: vec![ServiceCas {
                    cas: lease.cas(),
                    ecm_pid: 1000,
                    access_criteria: vec![],
                }],
            })
            .unwrap();

        tokio::time::sleep(Duration::from_millis(100)).await;
        assert_eq!(
            accept_count.load(std::sync::atomic::Ordering::SeqCst),
            1,
            "acquire_cas must connect eagerly"
        );

        drop(service);
        // shutdown() drops the DriverHandle synchronously, but the driver task itself (and closing
        // the TCP socket) finishes slightly later, on the next iteration of its loop.
        tokio::time::sleep(Duration::from_millis(100)).await;

        {
            let entry = simulcrypt.entry(lease.cas());
            assert!(
                entry.driver.lock_or_recover().is_none(),
                "driver must be torn down once the channel has no streams left"
            );
            assert!(matches!(
                *entry.state.lock_or_recover(),
                CasState::Disconnected
            ));
        }

        // An empty channel must not revive itself through reconnects.
        tokio::time::sleep(reconnect_delay * 3).await;
        assert_eq!(
            accept_count.load(std::sync::atomic::Ordering::SeqCst),
            1,
            "a torn-down channel must not keep reconnecting on its own"
        );

        let service2 = simulcrypt
            .open_service(&ServiceConfig {
                name: "svc-teardown-2".into(),
                crypto_period: Duration::from_millis(150),
                cas: vec![ServiceCas {
                    cas: lease.cas(),
                    ecm_pid: 1001,
                    access_criteria: vec![],
                }],
            })
            .unwrap();

        tokio::time::sleep(Duration::from_millis(100)).await;
        assert_eq!(
            accept_count.load(std::sync::atomic::Ordering::SeqCst),
            2,
            "reopening a service on the same CasRef must revive the channel with a fresh connection"
        );
        {
            let entry = simulcrypt.entry(lease.cas());
            assert!(
                entry.driver.lock_or_recover().is_some(),
                "driver must be running again after revival"
            );
        }

        drop(service2);
    }
}