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
use std::collections::BTreeSet;

use rustc_hash::FxHashMap;
use std::net::SocketAddr;

use irontide_storage::Bitfield;

#[cfg(test)]
use crate::piece_selector::InFlightPiece;

/// Block requests for a given (piece, offset) pair.
type PendingBlocks = Vec<(SocketAddr, Vec<(u32, u32, u32)>)>;

/// End-game mode state tracker.
///
/// When all remaining pieces have at least one request in-flight,
/// end-game mode allows requesting the same block from multiple peers.
/// Tracks which peers have been assigned each block so we can send
/// Cancel messages when a block arrives.
pub(crate) struct EndGame {
    active: bool,
    /// (`piece_index`, begin) → { length, list of peers assigned this block }
    blocks: FxHashMap<(u32, u32), BlockEntry>,
}

struct BlockEntry {
    length: u32,
    peers: Vec<SocketAddr>,
}

impl EndGame {
    pub fn new() -> Self {
        Self {
            active: false,
            blocks: FxHashMap::default(),
        }
    }

    pub fn is_active(&self) -> bool {
        self.active
    }

    /// Activate end-game by scanning all peers' pending requests.
    /// `pending` is: [(`peer_addr`, [(piece, begin, length), ...])]
    #[cfg_attr(not(test), allow(dead_code))]
    pub fn activate(&mut self, pending: &PendingBlocks) {
        self.active = true;
        self.blocks.clear();
        for (addr, requests) in pending {
            for &(index, begin, length) in requests {
                self.blocks
                    .entry((index, begin))
                    .or_insert_with(|| BlockEntry {
                        length,
                        peers: Vec::new(),
                    })
                    .peers
                    .push(*addr);
            }
        }
    }

    pub fn deactivate(&mut self) {
        self.active = false;
        self.blocks.clear();
    }

    /// Get the list of peers that have been assigned a given block.
    #[cfg_attr(not(test), allow(dead_code))]
    pub fn block_requesters(&self, index: u32, begin: u32) -> &[SocketAddr] {
        self.blocks
            .get(&(index, begin))
            .map_or(&[], |e| e.peers.as_slice())
    }

    /// Number of blocks being tracked.
    pub fn block_count(&self) -> usize {
        self.blocks.len()
    }

    /// Pick a single block for `peer_addr` to duplicate-request.
    /// Returns `Some((index, begin, length))` or `None`.
    pub fn pick_block(
        &self,
        peer_addr: SocketAddr,
        peer_has: &Bitfield,
    ) -> Option<(u32, u32, u32)> {
        for (&(index, begin), entry) in &self.blocks {
            if !peer_has.get(index) {
                continue;
            }
            if entry.peers.contains(&peer_addr) {
                continue;
            }
            return Some((index, begin, entry.length));
        }
        None
    }

    /// Strict variant: returns `None` if `uncovered_pieces` is non-empty
    /// (meaning there are pieces with no outstanding requests — don't
    /// duplicate-request while those exist).
    pub fn pick_block_strict(
        &self,
        peer_addr: SocketAddr,
        peer_has: &Bitfield,
        uncovered_pieces: &[u32],
    ) -> Option<(u32, u32, u32)> {
        if !uncovered_pieces.is_empty() {
            return None;
        }
        self.pick_block(peer_addr, peer_has)
    }

    /// Record that a block was received from `from_peer`.
    /// Returns list of `(peer_addr, index, begin, length)` to send Cancel to.
    pub fn block_received(
        &mut self,
        index: u32,
        begin: u32,
        from_peer: SocketAddr,
    ) -> Vec<(SocketAddr, u32, u32, u32)> {
        let Some(entry) = self.blocks.remove(&(index, begin)) else {
            return Vec::new();
        };
        entry
            .peers
            .into_iter()
            .filter(|&addr| addr != from_peer)
            .map(|addr| (addr, index, begin, entry.length))
            .collect()
    }

    /// Register that `peer_addr` has been assigned block `(index, begin)`.
    pub fn register_request(&mut self, index: u32, begin: u32, peer_addr: SocketAddr) {
        if let Some(entry) = self.blocks.get_mut(&(index, begin))
            && !entry.peers.contains(&peer_addr)
        {
            entry.peers.push(peer_addr);
        }
    }

    /// Remove all entries for a disconnected peer.
    pub fn peer_disconnected(&mut self, addr: SocketAddr) {
        for entry in self.blocks.values_mut() {
            entry.peers.retain(|&a| a != addr);
        }
    }

    /// Remove all block entries for a given piece (e.g., after verification or hash failure).
    pub fn remove_piece(&mut self, index: u32) {
        self.blocks.retain(|&(pi, _), _| pi != index);
    }

    /// Pick a block with streaming priority: try streaming pieces first,
    /// then fall back to regular pick.
    pub fn pick_block_streaming(
        &self,
        peer_addr: SocketAddr,
        peer_has: &Bitfield,
        streaming_pieces: &BTreeSet<u32>,
    ) -> Option<(u32, u32, u32)> {
        // First try streaming pieces
        for &piece in streaming_pieces {
            if !peer_has.get(piece) {
                continue;
            }
            for (&(idx, begin), entry) in &self.blocks {
                if idx == piece && !entry.peers.contains(&peer_addr) {
                    return Some((idx, begin, entry.length));
                }
            }
        }
        // Fall back to regular pick
        self.pick_block(peer_addr, peer_has)
    }
}

#[cfg(test)]
impl EndGame {
    /// Activate end-game using `InFlightPiece` data in addition to pending requests.
    ///
    /// This merges block-level tracking from `in_flight_pieces` with pending
    /// requests, ensuring all outstanding blocks are covered.
    #[allow(dead_code)]
    pub fn activate_with_inflight(
        &mut self,
        in_flight_pieces: &FxHashMap<u32, InFlightPiece>,
        pending: &PendingBlocks,
    ) {
        self.active = true;
        self.blocks.clear();
        // First, populate from InFlightPiece assigned_blocks
        for ifp in in_flight_pieces.values() {
            for (&(index, begin), &addr) in &ifp.assigned_blocks {
                self.blocks
                    .entry((index, begin))
                    .or_insert_with(|| BlockEntry {
                        length: irontide_core::DEFAULT_CHUNK_SIZE,
                        peers: Vec::new(),
                    })
                    .peers
                    .push(addr);
            }
        }
        // Then merge pending requests (may add peers not yet in InFlightPiece)
        for (addr, requests) in pending {
            for &(index, begin, length) in requests {
                let entry = self
                    .blocks
                    .entry((index, begin))
                    .or_insert_with(|| BlockEntry {
                        length,
                        peers: Vec::new(),
                    });
                if !entry.peers.contains(addr) {
                    entry.peers.push(*addr);
                }
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::net::{IpAddr, Ipv4Addr, SocketAddr};

    fn addr(port: u16) -> SocketAddr {
        SocketAddr::new(IpAddr::V4(Ipv4Addr::LOCALHOST), port)
    }

    #[test]
    fn new_is_inactive() {
        let eg = EndGame::new();
        assert!(!eg.is_active());
    }

    #[test]
    fn activate_populates_blocks_from_pending() {
        let mut eg = EndGame::new();

        let peer_a = addr(1);
        let peer_b = addr(2);
        let pending = vec![
            (peer_a, vec![(0, 0, 16384), (0, 16384, 16384)]),
            (peer_b, vec![(1, 0, 16384), (1, 16384, 16384)]),
        ];

        eg.activate(&pending);

        assert!(eg.is_active());
        assert_eq!(eg.block_requesters(0, 0).len(), 1);
        assert!(eg.block_requesters(0, 0).contains(&peer_a));
        assert_eq!(eg.block_requesters(1, 0).len(), 1);
        assert!(eg.block_requesters(1, 0).contains(&peer_b));
    }

    #[test]
    fn deactivate_clears_state() {
        let mut eg = EndGame::new();
        let pending = vec![(addr(1), vec![(0, 0, 16384)])];
        eg.activate(&pending);
        assert!(eg.is_active());

        eg.deactivate();
        assert!(!eg.is_active());
        assert_eq!(eg.block_requesters(0, 0).len(), 0);
    }

    #[test]
    fn pick_block_returns_unassigned_block() {
        let mut eg = EndGame::new();
        let peer_a = addr(1);
        let peer_b = addr(2);
        let pending = vec![(peer_a, vec![(0, 0, 16384), (0, 16384, 16384)])];
        eg.activate(&pending);

        // peer_b has piece 0 — should get one of the blocks already assigned to peer_a
        let mut peer_b_has = Bitfield::new(4);
        peer_b_has.set(0);

        let block = eg.pick_block(peer_b, &peer_b_has);
        assert!(block.is_some());
        let (idx, begin, len) = block.unwrap();
        assert_eq!(idx, 0);
        assert_eq!(len, 16384);
        assert!(begin == 0 || begin == 16384);
    }

    #[test]
    fn pick_block_skips_already_assigned_peer() {
        let mut eg = EndGame::new();
        let peer_a = addr(1);
        // Only one block, already assigned to peer_a
        let pending = vec![(peer_a, vec![(0, 0, 16384)])];
        eg.activate(&pending);

        let mut peer_a_has = Bitfield::new(4);
        peer_a_has.set(0);

        // peer_a already has this block — should get None
        let block = eg.pick_block(peer_a, &peer_a_has);
        assert!(block.is_none());
    }

    #[test]
    fn pick_block_skips_piece_peer_lacks() {
        let mut eg = EndGame::new();
        let peer_a = addr(1);
        let peer_b = addr(2);
        let pending = vec![(peer_a, vec![(0, 0, 16384)])];
        eg.activate(&pending);

        // peer_b does NOT have piece 0
        let peer_b_has = Bitfield::new(4);
        let block = eg.pick_block(peer_b, &peer_b_has);
        assert!(block.is_none());
    }

    #[test]
    fn pick_block_strict_blocks_when_piece_uncovered() {
        let mut eg = EndGame::new();
        let peer_a = addr(1);
        let pending = vec![(peer_a, vec![(0, 0, 16384)])];
        eg.activate(&pending);

        let peer_b = addr(2);
        let mut peer_b_has = Bitfield::new(4);
        peer_b_has.set(0);

        // strict=true + uncovered pieces exist → should return None
        let block = eg.pick_block_strict(peer_b, &peer_b_has, &[1u32]);
        assert!(block.is_none());

        // strict=true + no uncovered pieces → should return a block
        let block = eg.pick_block_strict(peer_b, &peer_b_has, &[]);
        assert!(block.is_some());
    }

    #[test]
    fn block_received_returns_cancel_targets() {
        let mut eg = EndGame::new();
        let peer_a = addr(1);
        let peer_b = addr(2);
        let peer_c = addr(3);

        let pending = vec![
            (peer_a, vec![(0, 0, 16384)]),
            (peer_b, vec![(0, 0, 16384)]),
            (peer_c, vec![(0, 0, 16384)]),
        ];
        eg.activate(&pending);

        // Block arrives from peer_a — should return cancels for peer_b and peer_c
        let cancels = eg.block_received(0, 0, peer_a);
        assert_eq!(cancels.len(), 2);
        assert!(cancels.contains(&(peer_b, 0, 0, 16384)));
        assert!(cancels.contains(&(peer_c, 0, 0, 16384)));
    }

    #[test]
    fn block_received_removes_entry() {
        let mut eg = EndGame::new();
        let peer_a = addr(1);
        let pending = vec![(peer_a, vec![(0, 0, 16384)])];
        eg.activate(&pending);

        let _ = eg.block_received(0, 0, peer_a);
        assert_eq!(eg.block_requesters(0, 0).len(), 0);
    }

    #[test]
    fn peer_disconnected_removes_from_all_entries() {
        let mut eg = EndGame::new();
        let peer_a = addr(1);
        let peer_b = addr(2);
        let pending = vec![(peer_a, vec![(0, 0, 16384)]), (peer_b, vec![(0, 0, 16384)])];
        eg.activate(&pending);
        assert_eq!(eg.block_requesters(0, 0).len(), 2);

        eg.peer_disconnected(peer_a);
        assert_eq!(eg.block_requesters(0, 0).len(), 1);
        assert!(eg.block_requesters(0, 0).contains(&peer_b));
    }

    #[test]
    fn remove_piece_clears_all_blocks_for_piece() {
        let mut eg = EndGame::new();
        let peer_a = addr(1);
        let pending = vec![(
            peer_a,
            vec![(0, 0, 16384), (0, 16384, 16384), (1, 0, 16384)],
        )];
        eg.activate(&pending);
        assert_eq!(eg.block_requesters(0, 0).len(), 1);
        assert_eq!(eg.block_requesters(1, 0).len(), 1);

        eg.remove_piece(0);
        assert_eq!(eg.block_requesters(0, 0).len(), 0);
        assert_eq!(eg.block_requesters(0, 16384).len(), 0);
        // Piece 1 untouched
        assert_eq!(eg.block_requesters(1, 0).len(), 1);
    }

    #[test]
    fn register_request_adds_peer() {
        let mut eg = EndGame::new();
        let peer_a = addr(1);
        let peer_b = addr(2);
        let pending = vec![(peer_a, vec![(0, 0, 16384)])];
        eg.activate(&pending);

        eg.register_request(0, 0, peer_b);
        assert_eq!(eg.block_requesters(0, 0).len(), 2);
        assert!(eg.block_requesters(0, 0).contains(&peer_b));

        // Duplicate register is idempotent
        eg.register_request(0, 0, peer_b);
        assert_eq!(eg.block_requesters(0, 0).len(), 2);
    }
}