aria2-protocol 0.3.2

Multi-protocol networking stack for aria2-rust: HTTP/HTTPS client, FTP/SFTP, full BitTorrent (DHT/PEX/MSE), and Metalink V3/V4 parser
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
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
//! Piece picker module
//!
//! Implements piece selection strategies for BitTorrent downloads.
//! Based on BEP 0019 (WebSeed) and various piece picking algorithms.

/// Piece selection strategy — determines the algorithm used to pick the next
/// piece to request from peers.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PieceSelectionStrategy {
    /// Select pieces sequentially (good for streaming)
    Sequential,
    /// Select rarest pieces first (default BitTorrent strategy)
    RarestFirst,
    /// Select pieces randomly
    Random,
    /// Select pieces to form the longest contiguous sequence
    LongestSequence,
    /// Priority-based selection (higher priority pieces first)
    Priority,
    /// Geometric distribution (prefer earlier pieces)
    Geometric,
}

/// Piece priority mode — controls how pieces are prioritised within the
/// picker, independent of the base selection strategy.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PiecePriorityMode {
    /// Prioritise pieces from the beginning of the file (head)
    SequentialHead,
    /// Prioritise pieces from the end of the file (tail)
    SequentialTail,
    /// Default rarest-first priority (no special head/tail bias)
    RarestFirst,
}

/// Legacy alias kept for backward compatibility.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PiecePickStrategy {
    /// Select pieces sequentially (good for streaming)
    Sequential,
    /// Select rarest pieces first (default BitTorrent strategy)
    RarestFirst,
    /// Select pieces randomly
    Random,
    /// Select pieces to form the longest contiguous sequence
    LongestSequence,
    /// Priority-based selection (higher priority pieces first)
    Priority,
    /// Geometric distribution (prefer earlier pieces)
    Geometric,
}

/// Information about a single piece within the picker.
///
/// Returned by [`PiecePicker::get_piece_info`].
#[derive(Debug, Clone)]
pub struct PieceInfo {
    /// Zero-based piece index
    pub index: u32,
    /// Number of peers that have this piece (availability frequency)
    pub frequency: u32,
    /// Whether this piece has been fully downloaded and verified
    pub is_completed: bool,
    /// Whether this piece has been fully downloaded and verified (alias)
    pub completed: bool,
    /// Whether this piece is currently being downloaded
    pub in_progress: bool,
    /// Priority level (0 = default, higher = more important)
    pub priority: u8,
}

/// Default remaining-piece count at or below which end-game tracking
/// activates. Mirrors aria2's `BT_ENDGAME_THRESHOLD`.
pub const DEFAULT_ENDGAME_THRESHOLD: usize = 20;

/// Scan order resolved from the (`strategy`, `priority_mode`) pair.
///
/// The legacy `priority_mode` API can still request a global head/tail scan;
/// the aria2-compatible file-boundary option is handled separately by
/// `set_priority_pieces` before this order is consulted.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum ScanOrder {
    /// Lowest index first (streaming / sequential writes)
    Forward,
    /// Highest index first
    Backward,
    /// Lowest availability frequency first, ties broken by lowest index
    Rarest,
    /// Uniform random among eligible pieces
    Random,
    /// Start of the longest contiguous run of eligible pieces
    LongestRun,
    /// Highest explicit priority first, ties broken by lowest index
    Priority,
    /// Geometric bias towards earlier eligible pieces
    Geometric,
}

/// Piece picker — selects the next piece to download based on the
/// configured strategy, peer bitfield frequency data, and priority mode.
///
/// Maintains internal state for end-game candidate tracking and
/// per-piece frequency counters used by the rarest-first algorithm.
///
/// # Complexity
///
/// Sequential orders (`Forward` / `Backward`) and unrestricted rarest-first
/// picks are amortised **O(1)** thanks to monotone cursors: every piece before
/// the cursor is known to be completed or unavailable. The rarest order is
/// rebuilt in O(n log n) when frequencies change. Peer-restricted selection
/// remains O(n), because a different peer bitfield can make any earlier piece
/// unavailable.
pub struct PiecePicker {
    /// Total number of pieces in the torrent
    num_pieces: u32,
    /// Active selection strategy
    strategy: PieceSelectionStrategy,
    /// Active priority mode
    priority_mode: PiecePriorityMode,
    /// Per-piece availability frequency (from peer bitfields)
    frequencies: Vec<u32>,
    /// Piece indexes sorted by availability, then by index for stable ties.
    rarest_order: Vec<usize>,
    /// Cursor into `rarest_order` for unrestricted normal-mode selection.
    rarest_cursor: usize,
    /// Per-piece completion tracking (true = piece verified and written)
    completed: Vec<bool>,
    /// Per-piece selection filter (true = piece is requested by this task).
    /// Every selection strategy consults this same fact.
    allowed: Vec<bool>,
    /// Per-piece in-progress tracking (true = piece is being downloaded)
    in_progress: Vec<bool>,
    /// Per-piece priority (0 = default, higher = more important)
    priorities: Vec<u8>,
    /// Explicitly prioritized pieces, in the order in which they are tried.
    /// This models aria2's `PriorityPieceSelector` wrapper.
    priority_pieces: Vec<u32>,
    /// Indices of pieces that are candidates for end-game mode
    endgame_candidates: Vec<usize>,
    /// Number of selected pieces marked completed.
    completed_allowed_count: usize,
    /// Number of pieces selected by the current filter.
    allowed_count: usize,
    /// Forward scan cursor: every piece with index `< head_cursor` is
    /// completed or in progress. Only ever moves forward (or is reset
    /// backwards by [`PiecePicker::reopen`]).
    head_cursor: usize,
    /// Backward scan cursor stored as `index + 1`, so `0` means "exhausted".
    tail_cursor: usize,
    /// Remaining-piece count at or below which end-game candidates are tracked
    endgame_threshold: usize,
    /// xorshift64* state for the `Random` / `Geometric` orders
    rng_state: u64,
}

impl PiecePicker {
    /// Create a new picker for a torrent with `num_pieces` pieces.
    pub fn new(num_pieces: u32) -> Self {
        let n = num_pieces as usize;
        Self {
            num_pieces,
            strategy: PieceSelectionStrategy::RarestFirst,
            priority_mode: PiecePriorityMode::RarestFirst,
            frequencies: vec![0; n],
            rarest_order: (0..n).collect(),
            rarest_cursor: 0,
            completed: vec![false; n],
            allowed: vec![true; n],
            in_progress: vec![false; n],
            priorities: vec![0; n],
            priority_pieces: Vec::new(),
            endgame_candidates: Vec::new(),
            completed_allowed_count: 0,
            allowed_count: n,
            head_cursor: 0,
            tail_cursor: n,
            endgame_threshold: DEFAULT_ENDGAME_THRESHOLD,
            rng_state: Self::seed(),
        }
    }

    /// Derive a non-zero RNG seed from the standard library's randomised
    /// hasher, avoiding an external `rand` dependency in the protocol crate.
    fn seed() -> u64 {
        use std::hash::{BuildHasher, Hasher};
        let s = std::collections::hash_map::RandomState::new()
            .build_hasher()
            .finish();
        s | 1
    }

    /// Advance the xorshift64* generator and return the next value.
    fn next_rand(&mut self) -> u64 {
        let mut x = self.rng_state;
        x ^= x >> 12;
        x ^= x << 25;
        x ^= x >> 27;
        self.rng_state = x;
        x.wrapping_mul(0x2545_F491_4F6C_DD1D)
    }

    /// Set the base selection strategy.
    pub fn set_strategy(&mut self, strategy: PieceSelectionStrategy) {
        self.strategy = strategy;
    }

    /// Set the piece priority mode.
    pub fn set_priority_mode(&mut self, mode: PiecePriorityMode) {
        self.priority_mode = mode;
    }

    /// Install a prioritized piece sequence used before the normal selector.
    pub fn set_priority_pieces(&mut self, mut pieces: Vec<u32>) {
        pieces.retain(|&piece| piece < self.num_pieces);
        pieces.sort_unstable();
        pieces.dedup();
        for index in (1..pieces.len()).rev() {
            let swap = (self.next_rand() % (index as u64 + 1)) as usize;
            pieces.swap(index, swap);
        }
        self.priority_pieces = pieces;
    }

    /// Return the currently installed explicit priority sequence.
    pub fn priority_pieces(&self) -> &[u32] {
        &self.priority_pieces
    }

    /// Restrict selection and selective completion to the given piece
    /// indexes.
    ///
    /// The completion bitfield remains global: unselected pieces that were
    /// already present can still be persisted and reported, but they do not
    /// contribute to selective-download completion or future selection.
    pub fn set_allowed_pieces(&mut self, pieces: &[u32]) {
        self.allowed.fill(false);
        for &piece in pieces {
            if let Some(allowed) = self.allowed.get_mut(piece as usize) {
                *allowed = true;
            }
        }
        self.allowed_count = self.allowed.iter().filter(|allowed| **allowed).count();
        self.completed_allowed_count = self
            .completed
            .iter()
            .zip(&self.allowed)
            .filter(|(completed, allowed)| **completed && **allowed)
            .count();
        self.head_cursor = 0;
        self.tail_cursor = self.num_pieces as usize;
        self.rarest_cursor = 0;
        self.refresh_endgame_candidates();
    }

    /// Whether a piece belongs to the current selective-download set.
    pub fn is_allowed(&self, index: u32) -> bool {
        self.allowed.get(index as usize).copied().unwrap_or(false)
    }

    /// Number of pieces selected by the current filter.
    pub fn allowed_count(&self) -> usize {
        self.allowed_count
    }

    /// Override the remaining-piece count at which end-game mode activates.
    pub fn set_endgame_threshold(&mut self, threshold: usize) {
        self.endgame_threshold = threshold;
        self.refresh_endgame_candidates();
    }

    /// Set the explicit priority of a piece (used by the `Priority` strategy).
    pub fn set_priority(&mut self, index: u32, priority: u8) {
        let i = index as usize;
        if i < self.num_pieces as usize {
            self.priorities[i] = priority;
        }
    }

    /// Resolve the effective scan order from strategy + priority mode.
    fn scan_order(&self) -> ScanOrder {
        match self.priority_mode {
            PiecePriorityMode::SequentialHead => ScanOrder::Forward,
            PiecePriorityMode::SequentialTail => ScanOrder::Backward,
            PiecePriorityMode::RarestFirst => match self.strategy {
                PieceSelectionStrategy::Sequential => ScanOrder::Forward,
                PieceSelectionStrategy::RarestFirst => ScanOrder::Rarest,
                PieceSelectionStrategy::Random => ScanOrder::Random,
                PieceSelectionStrategy::LongestSequence => ScanOrder::LongestRun,
                PieceSelectionStrategy::Priority => ScanOrder::Priority,
                PieceSelectionStrategy::Geometric => ScanOrder::Geometric,
            },
        }
    }

    /// A piece is *available* when it is neither completed nor already
    /// being downloaded by another request.
    #[inline]
    fn is_available(&self, i: usize) -> bool {
        self.allowed[i] && !self.completed[i] && !self.in_progress[i]
    }

    /// Test bit `i` of an MSB-first bitfield. `None` means "peer has everything".
    #[inline]
    fn peer_has(bitfield: Option<&[u8]>, i: usize) -> bool {
        match bitfield {
            None => true,
            Some(bf) => {
                let byte = i / 8;
                let bit = 7 - (i % 8);
                byte < bf.len() && (bf[byte] & (1 << bit)) != 0
            }
        }
    }

    /// Move `head_cursor` up to the first globally available piece.
    fn advance_head(&mut self) {
        let n = self.num_pieces as usize;
        while self.head_cursor < n {
            let i = self.head_cursor;
            if self.is_available(i) {
                break;
            }
            self.head_cursor = i + 1;
        }
    }

    /// Move `tail_cursor` down to the last globally available piece.
    fn advance_tail(&mut self) {
        while self.tail_cursor > 0 {
            let i = self.tail_cursor - 1;
            if self.is_available(i) {
                break;
            }
            self.tail_cursor = i;
        }
    }

    /// A piece became available again — pull the cursors back so it is
    /// not skipped by subsequent sequential scans.
    fn reopen(&mut self, i: usize) {
        if i < self.head_cursor {
            self.head_cursor = i;
        }
        if i + 1 > self.tail_cursor {
            self.tail_cursor = i + 1;
        }
        // The sorted rarity order is independent from the piece index, so a
        // reopened piece may live anywhere before the cursor.
        self.rarest_cursor = 0;
    }

    /// Core selection routine shared by [`Self::select`] and [`Self::pick_next`].
    ///
    /// `bitfield` restricts the candidates to pieces the peer advertises;
    /// `allow_in_progress` is set in end-game mode, where duplicate requests
    /// for in-flight pieces are intentional.
    fn pick_internal(
        &mut self,
        bitfield: Option<&[u8]>,
        nbits: usize,
        allow_in_progress: bool,
    ) -> Option<u32> {
        let n = (self.num_pieces as usize).min(nbits);
        if n == 0 {
            return None;
        }
        // `PriorityPieceSelector` in aria2_original tries its explicit list
        // first, but still respects the peer bitfield and completion state.
        for &piece in &self.priority_pieces {
            let index = piece as usize;
            if index < n
                && self.allowed[index]
                && !self.completed[index]
                && (allow_in_progress || !self.in_progress[index])
                && Self::peer_has(bitfield, index)
            {
                return Some(piece);
            }
        }

        let order = self.scan_order();

        // The BT download scheduler asks for an unrestricted piece. In that
        // case the sorted rarity order can advance once per piece instead of
        // rescanning every completed piece on every selection.
        if bitfield.is_none() && !allow_in_progress && matches!(order, ScanOrder::Rarest) {
            while self.rarest_cursor < self.rarest_order.len() {
                let i = self.rarest_order[self.rarest_cursor];
                self.rarest_cursor += 1;
                if i < n && self.is_available(i) {
                    return Some(i as u32);
                }
            }
            return None;
        }

        // Cursor fast paths — only valid when in-progress pieces are excluded,
        // because the cursor invariant counts them as unavailable.
        if !allow_in_progress {
            match order {
                ScanOrder::Forward => {
                    self.advance_head();
                    for i in self.head_cursor..n {
                        if self.is_available(i) && Self::peer_has(bitfield, i) {
                            return Some(i as u32);
                        }
                    }
                    return None;
                }
                ScanOrder::Backward => {
                    self.advance_tail();
                    let mut i = self.tail_cursor.min(n);
                    while i > 0 {
                        i -= 1;
                        if self.is_available(i) && Self::peer_has(bitfield, i) {
                            return Some(i as u32);
                        }
                    }
                    return None;
                }
                _ => {}
            }
        }

        let usable = |p: &Self, i: usize| -> bool {
            p.allowed[i]
                && !p.completed[i]
                && (allow_in_progress || !p.in_progress[i])
                && Self::peer_has(bitfield, i)
        };

        match order {
            ScanOrder::Forward => (0..n).find(|&i| usable(self, i)).map(|i| i as u32),
            ScanOrder::Backward => (0..n).rev().find(|&i| usable(self, i)).map(|i| i as u32),
            ScanOrder::Rarest => {
                let mut best: Option<(u32, usize)> = None;
                for i in 0..n {
                    if usable(self, i) {
                        let f = self.frequencies[i];
                        if best.is_none_or(|(bf, _)| f < bf) {
                            best = Some((f, i));
                        }
                    }
                }
                best.map(|(_, i)| i as u32)
            }
            ScanOrder::Priority => {
                let mut best: Option<(u8, usize)> = None;
                for i in 0..n {
                    if usable(self, i) {
                        let p = self.priorities[i];
                        if best.is_none_or(|(bp, _)| p > bp) {
                            best = Some((p, i));
                        }
                    }
                }
                best.map(|(_, i)| i as u32)
            }
            ScanOrder::LongestRun => {
                let (mut best_start, mut best_len) = (None, 0usize);
                let (mut cur_start, mut cur_len) = (None, 0usize);
                for i in 0..n {
                    if usable(self, i) {
                        if cur_start.is_none() {
                            cur_start = Some(i);
                            cur_len = 0;
                        }
                        cur_len += 1;
                        if cur_len > best_len {
                            best_len = cur_len;
                            best_start = cur_start;
                        }
                    } else {
                        cur_start = None;
                        cur_len = 0;
                    }
                }
                best_start.map(|i| i as u32)
            }
            ScanOrder::Random => {
                // Reservoir sampling: one pass, uniform over eligible pieces.
                let mut chosen: Option<usize> = None;
                let mut seen: u64 = 0;
                for i in 0..n {
                    if usable(self, i) {
                        seen += 1;
                        if self.next_rand().is_multiple_of(seen) {
                            chosen = Some(i);
                        }
                    }
                }
                chosen.map(|i| i as u32)
            }
            ScanOrder::Geometric => {
                let candidates = (0..n).filter(|&i| usable(self, i)).count();
                if candidates == 0 {
                    return None;
                }
                // P(k-th candidate) = 2^-(k+1): strong bias towards the head.
                let r = self.next_rand();
                let k = (r.trailing_zeros() as usize).min(candidates - 1);
                (0..n).filter(|&i| usable(self, i)).nth(k).map(|i| i as u32)
            }
        }
    }

    /// Pick the next piece index using the configured strategy.
    ///
    /// `bitfield` is the peer's have-bitfield (MSB-first), `nbits` is the
    /// number of valid bits (typically `num_pieces`). Returns `None` when the
    /// peer has nothing we still need.
    pub fn select(&mut self, bitfield: &[u8], nbits: usize) -> Option<u32> {
        self.pick_internal(Some(bitfield), nbits, false)
    }

    /// Pick the next piece without a peer restriction.
    ///
    /// In end-game mode (remaining pieces at or below the threshold) pieces
    /// already in flight become eligible again, so they can be requested from
    /// several peers at once.
    pub fn pick_next(&mut self) -> Option<u32> {
        let allow_in_progress = self.endgame_active();
        let n = self.num_pieces as usize;
        self.pick_internal(None, n, allow_in_progress)
    }

    /// Pick the next piece without peer restrictions or end-game duplicates.
    ///
    /// The BT scheduler uses this when its own end-game threshold says normal
    /// selection is still active. Keeping the flag explicit avoids coupling
    /// the protocol picker to a caller-owned threshold.
    pub fn pick_next_without_endgame(&mut self) -> Option<u32> {
        let n = self.num_pieces as usize;
        self.pick_internal(None, n, false)
    }

    /// Whether end-game mode is currently active.
    pub fn endgame_active(&self) -> bool {
        let remaining = self.remaining_count();
        remaining > 0 && remaining <= self.endgame_threshold
    }

    /// Recompute the end-game candidate list (incomplete pieces).
    ///
    /// O(n), but only runs once end-game mode is active, i.e. at most
    /// `endgame_threshold` times per download.
    fn refresh_endgame_candidates(&mut self) {
        self.endgame_candidates.clear();
        if !self.endgame_active() {
            return;
        }
        for i in 0..self.num_pieces as usize {
            if self.allowed[i] && !self.completed[i] {
                self.endgame_candidates.push(i);
            }
        }
    }

    /// Return the list of piece indices that are end-game candidates.
    pub fn endgame_candidates(&self) -> &[usize] {
        &self.endgame_candidates
    }

    /// Update per-piece frequency data from a peer frequency slice.
    pub fn set_frequencies_from_peers(&mut self, freqs: &[usize]) {
        let len = freqs.len().min(self.frequencies.len());
        for (dst, src) in self.frequencies.iter_mut().zip(freqs.iter()).take(len) {
            *dst = *src as u32;
        }
        self.rarest_order
            .sort_unstable_by_key(|&index| (self.frequencies[index], index));
        self.rarest_cursor = 0;
    }

    /// Iterator over all pieces, yielding [`PieceInfo`] for each.
    pub fn pieces_iter(&self) -> impl Iterator<Item = PieceInfo> + '_ {
        let n = self.num_pieces as usize;
        (0..n).map(move |i| PieceInfo {
            index: i as u32,
            frequency: self.frequencies[i],
            is_completed: self.completed[i],
            completed: self.completed[i],
            in_progress: self.in_progress[i],
            priority: self.priorities[i],
        })
    }

    /// Return info about a specific piece, or `None` if out of range.
    pub fn get_piece_info(&self, index: u32) -> Option<PieceInfo> {
        let i = index as usize;
        if i >= self.num_pieces as usize {
            return None;
        }
        Some(PieceInfo {
            index,
            frequency: self.frequencies[i],
            is_completed: self.completed[i],
            completed: self.completed[i],
            in_progress: self.in_progress[i],
            priority: self.priorities[i],
        })
    }

    /// Return the current priority mode.
    pub fn priority_mode(&self) -> PiecePriorityMode {
        self.priority_mode
    }

    /// Number of pieces not yet completed. O(1).
    pub fn remaining_count(&self) -> usize {
        self.allowed_count()
            .saturating_sub(self.completed_allowed_count)
    }

    /// Mark a piece as completed.
    ///
    /// Idempotent: marking an already-completed piece is a no-op. Also clears
    /// the in-progress flag, since a completed piece is no longer in flight.
    ///
    /// # Panics
    /// Panics if `index` is out of range in debug builds.
    pub fn mark_completed(&mut self, index: u32) {
        let i = index as usize;
        debug_assert!(
            i < self.num_pieces as usize,
            "mark_completed: index out of range"
        );
        if i >= self.num_pieces as usize {
            return;
        }
        if !self.completed[i] {
            self.completed[i] = true;
            if self.allowed[i] {
                self.completed_allowed_count += 1;
            }
        }
        self.in_progress[i] = false;
        self.refresh_endgame_candidates();
    }

    /// Mark a piece as being downloaded (or release it back to the pool).
    ///
    /// Releasing a piece (`in_progress = false`) rewinds the sequential
    /// cursors so the piece is picked up again by later scans.
    ///
    /// # Panics
    /// Panics if `index` is out of range in debug builds.
    pub fn mark_in_progress(&mut self, index: u32, in_progress: bool) {
        let i = index as usize;
        debug_assert!(
            i < self.num_pieces as usize,
            "mark_in_progress: index out of range"
        );
        if i >= self.num_pieces as usize {
            return;
        }
        self.in_progress[i] = in_progress;
        if !in_progress {
            self.reopen(i);
        }
    }

    /// Whether a piece is currently being downloaded.
    pub fn is_in_progress(&self, index: u32) -> bool {
        let i = index as usize;
        i < self.num_pieces as usize && self.in_progress[i]
    }

    /// Whether a piece has been completed and verified.
    pub fn is_completed(&self, index: u32) -> bool {
        let i = index as usize;
        i < self.num_pieces as usize && self.completed[i]
    }

    /// Export completed pieces as a bitfield byte vector (MSB-first).
    pub fn export_bitfield(&self) -> Vec<u8> {
        let n = self.num_pieces as usize;
        let bf_len = n.div_ceil(8);
        let mut bitfield = vec![0u8; bf_len];
        for (i, &done) in self.completed.iter().enumerate() {
            if done {
                let byte_idx = i / 8;
                let bit_idx = 7 - (i % 8);
                bitfield[byte_idx] |= 1 << bit_idx;
            }
        }
        bitfield
    }

    /// Check if all pieces are completed. O(1).
    pub fn is_complete(&self) -> bool {
        self.completed_allowed_count == self.allowed_count()
    }
}

/// Piece picker configuration
#[derive(Debug, Clone)]
pub struct PiecePickerConfig {
    /// Selection strategy
    pub strategy: PiecePickStrategy,
    /// Number of pieces to request ahead
    pub request_queue_size: usize,
    /// Whether to prioritize end-game mode
    pub end_game_threshold: f64,
}

impl Default for PiecePickerConfig {
    fn default() -> Self {
        Self {
            strategy: PiecePickStrategy::RarestFirst,
            request_queue_size: 16,
            end_game_threshold: 0.95,
        }
    }
}

/// Result of a piece pick operation
#[derive(Debug, Clone)]
pub struct PickedPiece {
    /// Index of the picked piece
    pub index: usize,
    /// Priority of the piece (higher = more important)
    pub priority: u8,
    /// Whether this piece is in end-game mode
    pub is_end_game: bool,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_piece_selection_strategy_variants() {
        assert_ne!(
            PieceSelectionStrategy::Sequential,
            PieceSelectionStrategy::RarestFirst
        );
        assert_ne!(
            PieceSelectionStrategy::Random,
            PieceSelectionStrategy::Geometric
        );
    }

    #[test]
    fn test_piece_priority_mode_variants() {
        assert_ne!(
            PiecePriorityMode::SequentialHead,
            PiecePriorityMode::SequentialTail
        );
        assert_ne!(
            PiecePriorityMode::SequentialTail,
            PiecePriorityMode::RarestFirst
        );
    }

    #[test]
    fn test_piece_picker_new() {
        let picker = PiecePicker::new(100);
        assert!(picker.endgame_candidates().is_empty());
        assert_eq!(picker.remaining_count(), 100);
        assert!(!picker.is_complete());
    }

    #[test]
    fn test_allowed_piece_filter_controls_selection_and_completion() {
        let mut picker = PiecePicker::new(4);
        picker.set_endgame_threshold(0);
        picker.set_allowed_pieces(&[1, 3]);

        assert_eq!(picker.allowed_count(), 2);
        assert_eq!(picker.remaining_count(), 2);
        assert!(!picker.is_allowed(0));
        assert!(picker.is_allowed(1));
        assert_eq!(picker.pick_next(), Some(1));

        picker.mark_completed(1);
        assert_eq!(picker.remaining_count(), 1);
        assert!(!picker.is_complete());
        assert_eq!(picker.pick_next(), Some(3));

        picker.mark_completed(3);
        assert!(picker.is_complete());
        assert_eq!(picker.remaining_count(), 0);
        assert_eq!(picker.pick_next(), None);
    }

    #[test]
    fn test_allowed_piece_filter_keeps_endgame_candidates_selective() {
        let mut picker = PiecePicker::new(5);
        picker.set_allowed_pieces(&[2, 4]);

        assert_eq!(picker.endgame_candidates(), &[2, 4]);
        picker.mark_completed(0);
        assert_eq!(picker.endgame_candidates(), &[2, 4]);
        picker.mark_completed(2);
        assert_eq!(picker.endgame_candidates(), &[4]);
    }

    #[test]
    fn test_piece_picker_new_u32() {
        let picker = PiecePicker::new(50u32);
        assert_eq!(picker.remaining_count(), 50);
    }

    #[test]
    fn test_piece_picker_set_strategy() {
        let mut picker = PiecePicker::new(100);
        picker.set_strategy(PieceSelectionStrategy::Sequential);
        // Verify it compiles and runs without panic
        let _ = picker.select(&[0xFF; 13], 100);
    }

    #[test]
    fn test_piece_picker_set_priority_mode() {
        let mut picker = PiecePicker::new(100);
        picker.set_priority_mode(PiecePriorityMode::SequentialHead);
        assert_eq!(picker.priority_mode(), PiecePriorityMode::SequentialHead);
    }

    #[test]
    fn test_explicit_priority_pieces_precede_base_selector() {
        let mut picker = PiecePicker::new(5);
        picker.set_strategy(PieceSelectionStrategy::RarestFirst);
        picker.set_frequencies_from_peers(&[0, 0, 0, 9, 0]);
        picker.set_priority_pieces(vec![3, 1, 3]);

        assert_eq!(picker.priority_pieces().len(), 2);
        assert!(picker.priority_pieces().contains(&1));
        assert!(picker.priority_pieces().contains(&3));

        let first = picker
            .pick_next()
            .expect("priority piece should be selected");
        assert!(first == 1 || first == 3);
        picker.mark_completed(first);
        let second = picker
            .pick_next()
            .expect("second priority piece should follow");
        assert!(second == 1 || second == 3);
        assert_ne!(first, second);
    }

    #[test]
    fn test_explicit_priority_pieces_respect_peer_bitfield() {
        let mut picker = PiecePicker::new(4);
        picker.set_priority_pieces(vec![2, 1]);

        // The peer has piece 1 but not piece 2 (MSB-first bitfield).
        assert_eq!(picker.select(&[0b0100_0000], 4), Some(1));
    }

    #[test]
    fn test_piece_pick_strategy_variants() {
        assert_ne!(
            PiecePickStrategy::Sequential,
            PiecePickStrategy::RarestFirst
        );
        assert_ne!(PiecePickStrategy::Random, PiecePickStrategy::Geometric);
    }

    #[test]
    fn test_piece_picker_config_default() {
        let config = PiecePickerConfig::default();
        assert_eq!(config.strategy, PiecePickStrategy::RarestFirst);
        assert_eq!(config.request_queue_size, 16);
        assert!(config.end_game_threshold > 0.9);
    }

    #[test]
    fn test_picked_piece() {
        let picked = PickedPiece {
            index: 42,
            priority: 5,
            is_end_game: false,
        };
        assert_eq!(picked.index, 42);
        assert_eq!(picked.priority, 5);
        assert!(!picked.is_end_game);
    }

    #[test]
    fn test_mark_completed_and_is_complete() {
        let mut picker = PiecePicker::new(3u32);
        assert!(!picker.is_complete());
        assert_eq!(picker.remaining_count(), 3);

        picker.mark_completed(0);
        assert!(!picker.is_complete());
        assert_eq!(picker.remaining_count(), 2);

        picker.mark_completed(1);
        picker.mark_completed(2);
        assert!(picker.is_complete());
        assert_eq!(picker.remaining_count(), 0);
    }

    #[test]
    fn test_export_bitfield() {
        let mut picker = PiecePicker::new(8u32);
        picker.mark_completed(0);
        picker.mark_completed(7);
        let bf = picker.export_bitfield();
        assert_eq!(bf.len(), 1);
        // Bit 0 (MSB) and bit 7 (LSB) set => 10000001 = 0x81
        assert_eq!(bf[0], 0x81);
    }

    #[test]
    fn test_get_piece_info() {
        let mut picker = PiecePicker::new(10u32);
        picker.mark_completed(3);
        picker.set_frequencies_from_peers(&[0, 2, 0, 0, 5, 0, 0, 0, 0, 0]);

        let info = picker.get_piece_info(3).unwrap();
        assert!(info.is_completed);
        assert_eq!(info.index, 3);
        assert_eq!(info.frequency, 0);

        let info4 = picker.get_piece_info(4).unwrap();
        assert!(!info4.is_completed);
        assert_eq!(info4.frequency, 5);

        assert!(picker.get_piece_info(100).is_none());
    }

    #[test]
    fn test_pieces_iter() {
        let picker = PiecePicker::new(5u32);
        let indices: Vec<u32> = picker.pieces_iter().map(|p| p.index).collect();
        assert_eq!(indices, vec![0, 1, 2, 3, 4]);
    }

    #[test]
    fn test_pieces_iter_empty() {
        let picker = PiecePicker::new(0u32);
        let indices: Vec<u32> = picker.pieces_iter().map(|p| p.index).collect();
        assert!(indices.is_empty());
    }

    #[test]
    fn test_export_bitfield_partial() {
        let mut picker = PiecePicker::new(16u32);
        // Set pieces 0, 3, 7
        picker.mark_completed(0);
        picker.mark_completed(3);
        picker.mark_completed(7);
        let bf = picker.export_bitfield();
        // MSB-first: piece0=bit7(0x80), piece3=bit4(0x10), piece7=bit0(0x01)
        // 0x80|0x10|0x01 = 0x91
        assert_eq!(bf.len(), 2);
        assert_eq!(bf[0], 0x91);
        assert_eq!(bf[1], 0x00);
    }

    #[test]
    fn test_is_complete_zero_pieces() {
        let picker = PiecePicker::new(0u32);
        // Zero pieces: vacuously true
        assert!(picker.is_complete());
        assert_eq!(picker.remaining_count(), 0);
    }

    #[test]
    fn test_set_frequencies_from_peers() {
        let mut picker = PiecePicker::new(4u32);
        let freqs: Vec<usize> = vec![3, 1, 5, 2];
        picker.set_frequencies_from_peers(&freqs);

        let info = picker.get_piece_info(2).unwrap();
        assert_eq!(info.frequency, 5);
    }

    // ── Selection behaviour ──────────────────────────────────────────────

    #[test]
    fn test_sequential_pick_advances_in_order() {
        let mut picker = PiecePicker::new(5u32);
        picker.set_strategy(PieceSelectionStrategy::Sequential);

        for expected in 0..5u32 {
            assert_eq!(picker.pick_next(), Some(expected));
            picker.mark_completed(expected);
        }
        assert_eq!(picker.pick_next(), None);
        assert!(picker.is_complete());
    }

    #[test]
    fn test_sequential_skips_in_progress() {
        let mut picker = PiecePicker::new(4u32);
        picker.set_strategy(PieceSelectionStrategy::Sequential);
        // Disable end-game, which would otherwise re-offer in-flight pieces
        // (a 4-piece torrent is below the default threshold).
        picker.set_endgame_threshold(0);

        picker.mark_in_progress(0, true);
        assert_eq!(picker.pick_next(), Some(1));

        // Releasing piece 0 rewinds the cursor.
        picker.mark_in_progress(0, false);
        assert_eq!(picker.pick_next(), Some(0));
    }

    #[test]
    fn test_tail_mode_picks_from_the_end() {
        let mut picker = PiecePicker::new(6u32);
        picker.set_priority_mode(PiecePriorityMode::SequentialTail);

        assert_eq!(picker.pick_next(), Some(5));
        picker.mark_completed(5);
        assert_eq!(picker.pick_next(), Some(4));
    }

    #[test]
    fn test_head_mode_picks_from_the_start() {
        let mut picker = PiecePicker::new(6u32);
        picker.set_priority_mode(PiecePriorityMode::SequentialHead);

        assert_eq!(picker.pick_next(), Some(0));
        picker.mark_completed(0);
        assert_eq!(picker.pick_next(), Some(1));
    }

    #[test]
    fn test_rarest_first_prefers_lowest_frequency() {
        let mut picker = PiecePicker::new(4u32);
        picker.set_strategy(PieceSelectionStrategy::RarestFirst);
        picker.set_frequencies_from_peers(&[9, 4, 1, 7]);

        assert_eq!(picker.pick_next(), Some(2));
        picker.mark_completed(2);
        assert_eq!(picker.pick_next(), Some(1));
    }

    #[test]
    fn test_rarest_cursor_reopens_piece_after_frequency_order_scan() {
        let mut picker = PiecePicker::new(4u32);
        picker.set_frequencies_from_peers(&[9, 1, 4, 7]);
        picker.mark_in_progress(1, true);

        assert_eq!(picker.pick_next_without_endgame(), Some(2));
        picker.mark_in_progress(1, false);
        assert_eq!(picker.pick_next_without_endgame(), Some(1));
    }

    #[test]
    fn test_pick_next_without_endgame_excludes_in_progress_piece() {
        let mut picker = PiecePicker::new(4u32);
        picker.set_endgame_threshold(4);
        picker.mark_in_progress(0, true);

        assert_eq!(picker.pick_next(), Some(0));
        assert_eq!(picker.pick_next_without_endgame(), Some(1));
    }

    #[test]
    fn test_priority_strategy_prefers_highest_priority() {
        let mut picker = PiecePicker::new(4u32);
        picker.set_strategy(PieceSelectionStrategy::Priority);
        picker.set_priority(3, 9);
        picker.set_priority(1, 5);

        assert_eq!(picker.pick_next(), Some(3));
        picker.mark_completed(3);
        assert_eq!(picker.pick_next(), Some(1));
    }

    #[test]
    fn test_longest_sequence_picks_run_start() {
        let mut picker = PiecePicker::new(8u32);
        picker.set_strategy(PieceSelectionStrategy::LongestSequence);
        // Leave 0 available (run length 1) and 3..=7 available (run length 5).
        picker.mark_completed(1);
        picker.mark_completed(2);

        assert_eq!(picker.pick_next(), Some(3));
    }

    #[test]
    fn test_random_strategy_returns_available_piece() {
        let mut picker = PiecePicker::new(16u32);
        picker.set_strategy(PieceSelectionStrategy::Random);
        for i in 0..15u32 {
            picker.mark_completed(i);
        }
        // Only piece 15 is left, so the random pick is deterministic.
        assert_eq!(picker.pick_next(), Some(15));
    }

    #[test]
    fn test_geometric_strategy_returns_available_piece() {
        let mut picker = PiecePicker::new(32u32);
        picker.set_strategy(PieceSelectionStrategy::Geometric);
        for _ in 0..50 {
            let picked = picker.pick_next().expect("piece must be available");
            assert!(picked < 32);
            assert!(!picker.is_completed(picked));
        }
    }

    #[test]
    fn test_select_respects_peer_bitfield() {
        let mut picker = PiecePicker::new(8u32);
        picker.set_strategy(PieceSelectionStrategy::Sequential);

        // Peer only has piece 5 (MSB-first: bit index 5 => 0b0000_0100).
        let bf = [0b0000_0100u8];
        assert_eq!(picker.select(&bf, 8), Some(5));

        picker.mark_completed(5);
        assert_eq!(picker.select(&bf, 8), None);
    }

    #[test]
    fn test_select_with_zero_nbits_returns_none() {
        let mut picker = PiecePicker::new(8u32);
        assert_eq!(picker.select(&[0xFF], 0), None);
    }

    #[test]
    fn test_select_ignores_bits_beyond_bitfield_length() {
        let mut picker = PiecePicker::new(16u32);
        picker.set_strategy(PieceSelectionStrategy::Sequential);
        // Short bitfield: only the first byte is present.
        let bf = [0x00u8];
        assert_eq!(picker.select(&bf, 16), None);
    }

    #[test]
    fn test_endgame_allows_duplicate_requests() {
        let mut picker = PiecePicker::new(4u32);
        picker.set_strategy(PieceSelectionStrategy::Sequential);
        picker.set_endgame_threshold(4);

        picker.mark_in_progress(0, true);
        picker.mark_in_progress(1, true);
        picker.mark_in_progress(2, true);
        picker.mark_in_progress(3, true);

        // All pieces are in flight, but end-game mode re-offers them.
        assert!(picker.endgame_active());
        assert_eq!(picker.pick_next(), Some(0));
    }

    #[test]
    fn test_endgame_candidates_populated_near_completion() {
        let mut picker = PiecePicker::new(4u32);
        picker.set_endgame_threshold(2);

        picker.mark_completed(0);
        assert!(picker.endgame_candidates().is_empty(), "remaining=3 > 2");

        picker.mark_completed(1);
        assert_eq!(picker.endgame_candidates(), &[2, 3]);

        picker.mark_completed(2);
        picker.mark_completed(3);
        assert!(picker.endgame_candidates().is_empty(), "download finished");
    }

    #[test]
    fn test_mark_completed_is_idempotent() {
        let mut picker = PiecePicker::new(3u32);
        picker.mark_completed(1);
        picker.mark_completed(1);
        picker.mark_completed(1);
        assert_eq!(picker.remaining_count(), 2);
        assert!(!picker.is_complete());
    }

    #[test]
    fn test_pick_next_on_empty_torrent() {
        let mut picker = PiecePicker::new(0u32);
        assert_eq!(picker.pick_next(), None);
        assert!(!picker.endgame_active());
    }

    #[test]
    fn test_mark_in_progress_flag_roundtrip() {
        let mut picker = PiecePicker::new(2u32);
        assert!(!picker.is_in_progress(0));
        picker.mark_in_progress(0, true);
        assert!(picker.is_in_progress(0));
        assert!(picker.get_piece_info(0).unwrap().in_progress);
        picker.mark_in_progress(0, false);
        assert!(!picker.is_in_progress(0));
    }

    #[test]
    fn test_mark_completed_clears_in_progress() {
        let mut picker = PiecePicker::new(2u32);
        picker.mark_in_progress(1, true);
        picker.mark_completed(1);
        assert!(!picker.is_in_progress(1));
        assert!(picker.is_completed(1));
    }
}