irontide-session 1.0.1

BitTorrent session management: peers, torrents, and piece selection
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
#![allow(
    clippy::cast_possible_truncation,
    clippy::cast_possible_wrap,
    clippy::cast_sign_loss,
    clippy::unchecked_time_subtraction,
    reason = "M175: BEP 9 ut_metadata — piece counts bounded by metadata size; remaining time-sub sites are test fixtures"
)]

use std::collections::{HashMap, HashSet};
use std::net::SocketAddr;
use std::time::{Duration, Instant};

use bytes::Bytes;
use irontide_core::Id20;

/// BEP 9 metadata piece size: 16 KiB.
const METADATA_PIECE_SIZE: u64 = 16384;

/// Base timeout for metadata piece requests (seconds).
const METADATA_BASE_TIMEOUT_SECS: u64 = 5;

/// Maximum timeout for metadata piece requests (seconds, caps exponential backoff).
const METADATA_MAX_TIMEOUT_SECS: u64 = 60;

/// State machine for downloading torrent metadata via BEP 9 (magnet links).
///
/// Metadata is split into 16 KiB pieces. Once all pieces are received,
/// they are assembled and verified against the `info_hash`.
///
/// Supports full-redundancy parallel fetch: every peer that advertises
/// `ut_metadata` is sent requests for ALL missing pieces. The first
/// complete set (SHA1-verified) wins.
#[allow(dead_code)]
pub(crate) struct MetadataDownloader {
    info_hash: Id20,
    total_size: Option<u64>,
    pieces: HashMap<u32, Bytes>,
    num_pieces: Option<u32>,
    /// Peers that have been sent metadata requests (peer -> set of requested pieces).
    requested_peers: HashMap<SocketAddr, HashSet<u32>>,
    /// Peers that rejected our metadata requests — don't request from them again.
    rejected_peers: HashSet<SocketAddr>,
    /// When each piece was last requested (for timeout detection).
    piece_request_times: HashMap<u32, Instant>,
    /// Per-piece retry count for exponential backoff.
    piece_retry_count: HashMap<u32, u32>,
}

#[allow(dead_code)]
impl MetadataDownloader {
    /// Create a new downloader with no size known yet.
    pub fn new(info_hash: Id20) -> Self {
        Self {
            info_hash,
            total_size: None,
            pieces: HashMap::new(),
            num_pieces: None,
            requested_peers: HashMap::new(),
            rejected_peers: HashSet::new(),
            piece_request_times: HashMap::new(),
            piece_retry_count: HashMap::new(),
        }
    }

    /// Set the total metadata size and calculate the number of pieces.
    pub fn set_total_size(&mut self, size: u64) {
        self.total_size = Some(size);
        self.num_pieces = Some(size.div_ceil(METADATA_PIECE_SIZE) as u32);
    }

    /// Store a received piece. Returns `true` if all pieces have been received.
    pub fn piece_received(&mut self, piece: u32, data: Bytes) -> bool {
        self.pieces.insert(piece, data);
        match self.num_pieces {
            Some(n) => self.pieces.len() == n as usize,
            None => false,
        }
    }

    /// Concatenate all pieces in order and verify the SHA1 hash matches `info_hash`.
    ///
    /// Returns the assembled metadata bytes on success.
    pub fn assemble_and_verify(&self) -> crate::Result<Vec<u8>> {
        let num_pieces = self
            .num_pieces
            .ok_or_else(|| crate::Error::Connection("metadata incomplete".to_string()))?;

        if self.pieces.len() != num_pieces as usize {
            return Err(crate::Error::Connection("metadata incomplete".to_string()));
        }

        let mut assembled = Vec::with_capacity(self.total_size.unwrap_or(0) as usize);
        for i in 0..num_pieces {
            let piece = self
                .pieces
                .get(&i)
                .ok_or_else(|| crate::Error::Connection("metadata incomplete".to_string()))?;
            assembled.extend_from_slice(piece);
        }

        let hash = irontide_core::sha1(&assembled);
        if hash != self.info_hash {
            return Err(crate::Error::MetadataHashMismatch);
        }

        Ok(assembled)
    }

    /// Return sorted list of piece indices we don't have yet.
    ///
    /// Returns an empty vec if `num_pieces` is not yet known.
    pub fn missing_pieces(&self) -> Vec<u32> {
        match self.num_pieces {
            None => Vec::new(),
            Some(n) => (0..n).filter(|i| !self.pieces.contains_key(i)).collect(),
        }
    }

    /// Mark a peer as having rejected metadata requests.
    ///
    /// The peer is added to the rejected set and removed from the active
    /// requested set. No further requests will be sent to this peer.
    pub fn mark_rejected(&mut self, peer: SocketAddr) {
        self.rejected_peers.insert(peer);
        self.requested_peers.remove(&peer);
    }

    /// Check whether a peer has been rejected.
    pub fn is_rejected(&self, peer: &SocketAddr) -> bool {
        self.rejected_peers.contains(peer)
    }

    /// Request all missing pieces from a peer (full redundancy).
    ///
    /// Returns the list of piece indices to request from this peer.
    /// Skips pieces we already have and rejects requests to blacklisted peers.
    /// Records the peer in `requested_peers` and updates `piece_request_times`.
    pub fn request_all_from_peer(&mut self, peer: SocketAddr) -> Vec<u32> {
        if self.rejected_peers.contains(&peer) {
            return Vec::new();
        }

        let missing = self.missing_pieces();
        if missing.is_empty() {
            return Vec::new();
        }

        let now = Instant::now();
        let peer_set = self.requested_peers.entry(peer).or_default();
        for &piece in &missing {
            peer_set.insert(piece);
            // D3: fresh peer gets fresh timer, not inherited stale backoff
            self.piece_request_times.insert(piece, now);
            self.piece_retry_count.remove(&piece);
        }

        missing
    }

    /// Return piece indices whose last request time exceeds their per-piece
    /// backoff timeout. Backoff is exponential: `min(60s, 5s * 2^retry_count)`.
    pub fn timed_out_pieces(&self) -> Vec<u32> {
        let now = Instant::now();
        self.piece_request_times
            .iter()
            .filter(|(piece, requested_at)| {
                if self.pieces.contains_key(piece) {
                    return false;
                }
                let retries = self.piece_retry_count.get(piece).copied().unwrap_or(0);
                let clamped = retries.min(12);
                let timeout_secs = METADATA_BASE_TIMEOUT_SECS
                    .saturating_mul(1u64 << clamped)
                    .min(METADATA_MAX_TIMEOUT_SECS);
                let timeout = Duration::from_secs(timeout_secs);
                now.duration_since(**requested_at) >= timeout
            })
            .map(|(piece, _)| *piece)
            .collect()
    }

    /// Reset the request time for a piece and increment its retry count.
    pub fn reset_request_time(&mut self, piece: u32) {
        self.piece_request_times.insert(piece, Instant::now());
        *self.piece_retry_count.entry(piece).or_insert(0) += 1;
    }

    /// Whether any non-rejected peers have outstanding requests.
    pub fn has_active_peers(&self) -> bool {
        self.requested_peers
            .keys()
            .any(|peer| !self.rejected_peers.contains(peer))
    }
}

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

    #[test]
    fn new_empty() {
        let info_hash = Id20::ZERO;
        let dl = MetadataDownloader::new(info_hash);
        assert!(dl.total_size.is_none());
        assert!(dl.num_pieces.is_none());
        assert!(dl.pieces.is_empty());
        assert!(dl.requested_peers.is_empty());
        assert!(dl.rejected_peers.is_empty());
        assert!(dl.piece_request_times.is_empty());
    }

    #[test]
    fn set_total_size_calculates_num_pieces() {
        let mut dl = MetadataDownloader::new(Id20::ZERO);

        dl.set_total_size(32768);
        assert_eq!(dl.num_pieces, Some(2));

        dl.set_total_size(16384);
        assert_eq!(dl.num_pieces, Some(1));

        dl.set_total_size(16385);
        assert_eq!(dl.num_pieces, Some(2));
    }

    #[test]
    fn single_piece_metadata() {
        let mut dl = MetadataDownloader::new(Id20::ZERO);
        dl.set_total_size(100);
        let complete = dl.piece_received(0, Bytes::from(vec![0u8; 100]));
        assert!(complete);
    }

    #[test]
    fn multi_piece_metadata() {
        let mut dl = MetadataDownloader::new(Id20::ZERO);
        dl.set_total_size(32768); // 2 pieces

        let complete = dl.piece_received(0, Bytes::from(vec![0u8; 16384]));
        assert!(!complete);

        let complete = dl.piece_received(1, Bytes::from(vec![0u8; 16384]));
        assert!(complete);
    }

    #[test]
    fn piece_received_returns_false_when_incomplete() {
        let mut dl = MetadataDownloader::new(Id20::ZERO);
        dl.set_total_size(32768); // 2 pieces

        let complete = dl.piece_received(0, Bytes::from(vec![0u8; 16384]));
        assert!(!complete);
    }

    #[test]
    fn assemble_and_verify_correct_hash() {
        // Create known test data that fits in a single piece.
        let data = b"hello world metadata test data!!";
        let info_hash = irontide_core::sha1(data);

        let mut dl = MetadataDownloader::new(info_hash);
        dl.set_total_size(data.len() as u64);
        dl.piece_received(0, Bytes::from(data.to_vec()));

        let result = dl.assemble_and_verify().unwrap();
        assert_eq!(result, data);
    }

    #[test]
    fn assemble_and_verify_wrong_hash() {
        let data = b"hello world metadata test data!!";
        // Use a wrong info_hash (all zeros will not match).
        let wrong_hash = Id20::ZERO;

        let mut dl = MetadataDownloader::new(wrong_hash);
        dl.set_total_size(data.len() as u64);
        dl.piece_received(0, Bytes::from(data.to_vec()));

        let result = dl.assemble_and_verify();
        assert!(result.is_err());
        let err = result.unwrap_err();
        assert!(
            matches!(err, crate::Error::MetadataHashMismatch),
            "expected MetadataHashMismatch, got: {err:?}"
        );
    }

    // --- M107: New tests for parallel metadata fetch ---

    #[test]
    fn metadata_full_redundancy_all_pieces_to_each_peer() {
        let mut dl = MetadataDownloader::new(Id20::ZERO);
        dl.set_total_size(32768); // 2 pieces

        let peer_a: SocketAddr = "10.0.0.1:6881".parse().expect("valid addr");
        let peer_b: SocketAddr = "10.0.0.2:6881".parse().expect("valid addr");

        // Both peers should get all missing pieces (full redundancy).
        let pieces_a = dl.request_all_from_peer(peer_a);
        assert_eq!(pieces_a, vec![0, 1]);

        let pieces_b = dl.request_all_from_peer(peer_b);
        assert_eq!(pieces_b, vec![0, 1]);

        // Both peers recorded in requested_peers.
        assert!(dl.requested_peers.contains_key(&peer_a));
        assert!(dl.requested_peers.contains_key(&peer_b));
        assert_eq!(dl.requested_peers[&peer_a].len(), 2);
        assert_eq!(dl.requested_peers[&peer_b].len(), 2);

        // Request times set for both pieces.
        assert!(dl.piece_request_times.contains_key(&0));
        assert!(dl.piece_request_times.contains_key(&1));
    }

    #[test]
    fn metadata_reject_blacklists_peer() {
        let mut dl = MetadataDownloader::new(Id20::ZERO);
        dl.set_total_size(32768); // 2 pieces

        let peer_a: SocketAddr = "10.0.0.1:6881".parse().expect("valid addr");
        let peer_b: SocketAddr = "10.0.0.2:6881".parse().expect("valid addr");

        // Request from both peers.
        let _ = dl.request_all_from_peer(peer_a);
        let _ = dl.request_all_from_peer(peer_b);

        // Reject peer_a.
        dl.mark_rejected(peer_a);

        assert!(dl.is_rejected(&peer_a));
        assert!(!dl.is_rejected(&peer_b));

        // Rejected peer removed from requested_peers.
        assert!(!dl.requested_peers.contains_key(&peer_a));

        // No further requests to rejected peer.
        let pieces = dl.request_all_from_peer(peer_a);
        assert!(pieces.is_empty());

        // peer_b still works.
        let pieces = dl.request_all_from_peer(peer_b);
        assert_eq!(pieces, vec![0, 1]);
    }

    #[test]
    fn metadata_timeout_triggers_rerequest() {
        let mut dl = MetadataDownloader::new(Id20::ZERO);
        dl.set_total_size(32768); // 2 pieces

        let peer_a: SocketAddr = "10.0.0.1:6881".parse().expect("valid addr");
        let _ = dl.request_all_from_peer(peer_a);

        // Simulate time passing by backdating the request times.
        let old_time = Instant::now() - Duration::from_secs(10);
        dl.piece_request_times.insert(0, old_time);
        dl.piece_request_times.insert(1, old_time);

        // Both pieces should be timed out (base 5s, no retries yet).
        let timed_out = dl.timed_out_pieces();
        assert_eq!(timed_out.len(), 2);
        assert!(timed_out.contains(&0));
        assert!(timed_out.contains(&1));

        // After receiving piece 0, only piece 1 should time out.
        dl.piece_received(0, Bytes::from(vec![0u8; 16384]));
        let timed_out = dl.timed_out_pieces();
        assert_eq!(timed_out, vec![1]);
    }

    #[test]
    fn metadata_parallel_fetch_from_multiple_peers() {
        // Two peers each provide different pieces — assembly succeeds.
        let data = b"hello world metadata test data!!";
        let info_hash = irontide_core::sha1(data);

        let mut dl = MetadataDownloader::new(info_hash);
        dl.set_total_size(data.len() as u64); // 1 piece (< 16 KiB)

        let peer_a: SocketAddr = "10.0.0.1:6881".parse().expect("valid addr");
        let peer_b: SocketAddr = "10.0.0.2:6881".parse().expect("valid addr");

        // Both peers get piece 0.
        let pieces_a = dl.request_all_from_peer(peer_a);
        let pieces_b = dl.request_all_from_peer(peer_b);
        assert_eq!(pieces_a, vec![0]);
        assert_eq!(pieces_b, vec![0]);

        // Peer A delivers first — completes the download.
        let complete = dl.piece_received(0, Bytes::from(data.to_vec()));
        assert!(complete);

        // Assembly works despite peer B never delivering.
        let result = dl.assemble_and_verify().unwrap();
        assert_eq!(result, data);
    }

    #[test]
    fn metadata_parallel_multi_piece_assembly() {
        // 3-piece metadata: peer A delivers piece 0, peer B delivers piece 1,
        // peer A delivers piece 2. Verifies cross-peer assembly.
        let data = vec![0xAA_u8; 16384 * 2 + 100]; // 2 full pieces + partial = 3 pieces
        let info_hash = irontide_core::sha1(&data);

        let mut dl = MetadataDownloader::new(info_hash);
        dl.set_total_size(data.len() as u64);
        assert_eq!(dl.num_pieces, Some(3));

        let peer_a: SocketAddr = "10.0.0.1:6881".parse().expect("valid addr");
        let peer_b: SocketAddr = "10.0.0.2:6881".parse().expect("valid addr");

        let _ = dl.request_all_from_peer(peer_a);
        let _ = dl.request_all_from_peer(peer_b);

        // Peer A delivers piece 0.
        assert!(!dl.piece_received(0, Bytes::from(data[..16384].to_vec())));
        // Peer B delivers piece 1.
        assert!(!dl.piece_received(1, Bytes::from(data[16384..32768].to_vec())));
        // Peer A delivers piece 2 — completes.
        assert!(dl.piece_received(2, Bytes::from(data[32768..].to_vec())));

        let result = dl.assemble_and_verify().unwrap();
        assert_eq!(result, data);
    }

    #[test]
    fn has_active_peers_reflects_state() {
        let mut dl = MetadataDownloader::new(Id20::ZERO);
        dl.set_total_size(16384);

        // No peers yet.
        assert!(!dl.has_active_peers());

        let peer_a: SocketAddr = "10.0.0.1:6881".parse().expect("valid addr");
        let _ = dl.request_all_from_peer(peer_a);
        assert!(dl.has_active_peers());

        // Reject the only active peer.
        dl.mark_rejected(peer_a);
        assert!(!dl.has_active_peers());
    }

    #[test]
    fn request_all_from_peer_skips_received_pieces() {
        let mut dl = MetadataDownloader::new(Id20::ZERO);
        dl.set_total_size(32768); // 2 pieces

        // Receive piece 0 first.
        dl.piece_received(0, Bytes::from(vec![0u8; 16384]));

        let peer: SocketAddr = "10.0.0.1:6881".parse().expect("valid addr");
        let pieces = dl.request_all_from_peer(peer);
        // Only piece 1 should be requested.
        assert_eq!(pieces, vec![1]);
    }

    #[test]
    fn reset_request_time_updates_timestamp() {
        let mut dl = MetadataDownloader::new(Id20::ZERO);
        dl.set_total_size(16384);

        let peer: SocketAddr = "10.0.0.1:6881".parse().expect("valid addr");
        let _ = dl.request_all_from_peer(peer);

        // Backdate the request time past the base 5s timeout.
        let old_time = Instant::now() - Duration::from_secs(10);
        dl.piece_request_times.insert(0, old_time);

        // Piece should be timed out.
        assert_eq!(dl.timed_out_pieces().len(), 1);

        // Reset the time — this also increments retry count to 1 (10s backoff).
        dl.reset_request_time(0);

        // No longer timed out (fresh timestamp, need 10s to expire).
        assert!(dl.timed_out_pieces().is_empty());
    }

    #[test]
    fn backoff_increases_timeout_per_retry() {
        let mut dl = MetadataDownloader::new(Id20::ZERO);
        dl.set_total_size(16384);

        let peer: SocketAddr = "10.0.0.1:6881".parse().expect("valid addr");
        let _ = dl.request_all_from_peer(peer);

        // Retry 0: 5s, Retry 1: 10s, Retry 2: 20s, Retry 3: 40s, Retry 4: 60s
        let expected = [5, 10, 20, 40, 60];
        for (i, &expected_secs) in expected.iter().enumerate() {
            let backdate = Duration::from_secs(expected_secs);
            dl.piece_request_times.insert(0, Instant::now() - backdate);
            assert_eq!(
                dl.timed_out_pieces().len(),
                1,
                "retry {i}: should time out after {expected_secs}s"
            );
            dl.reset_request_time(0);
        }
    }

    #[test]
    fn backoff_capped_at_60s() {
        let mut dl = MetadataDownloader::new(Id20::ZERO);
        dl.set_total_size(16384);

        let peer: SocketAddr = "10.0.0.1:6881".parse().expect("valid addr");
        let _ = dl.request_all_from_peer(peer);

        // Simulate many retries
        for _ in 0..20 {
            dl.reset_request_time(0);
        }

        // Backdate 59s — should NOT time out (cap is 60s)
        dl.piece_request_times
            .insert(0, Instant::now() - Duration::from_secs(59));
        assert!(dl.timed_out_pieces().is_empty());

        // Backdate 61s — should time out
        dl.piece_request_times
            .insert(0, Instant::now() - Duration::from_secs(61));
        assert_eq!(dl.timed_out_pieces().len(), 1);
    }

    #[test]
    fn independent_retry_counts_per_piece() {
        let mut dl = MetadataDownloader::new(Id20::ZERO);
        dl.set_total_size(32768); // 2 pieces

        let peer: SocketAddr = "10.0.0.1:6881".parse().expect("valid addr");
        let _ = dl.request_all_from_peer(peer);

        // Reset piece 0 three times (next timeout: 40s)
        dl.reset_request_time(0);
        dl.reset_request_time(0);
        dl.reset_request_time(0);

        // Piece 1 has zero retries (timeout: 5s)
        // Backdate both to 6s ago
        let backdate = Instant::now() - Duration::from_secs(6);
        dl.piece_request_times.insert(0, backdate);
        dl.piece_request_times.insert(1, backdate);

        let timed_out = dl.timed_out_pieces();
        // Only piece 1 should time out (5s threshold), piece 0 needs 40s
        assert_eq!(timed_out, vec![1]);
    }
}