torrust-actix 4.2.15

A rich, fast and efficient Bittorrent Tracker.
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
use crate::common::common::shutdown_waiting;
use crate::tracker::structs::cleanup_stats::CleanupStats;
use crate::tracker::structs::info_hash::InfoHash;
use crate::tracker::structs::peer_id::PeerId;
use crate::tracker::structs::torrent_entry::TorrentEntry;
use crate::tracker::structs::torrent_sharding::TorrentSharding;
use crate::tracker::structs::torrent_tracker::TorrentTracker;
use crate::tracker::types::ahash_map::AHashMap;
use log::info;
use parking_lot::RwLock;
use std::collections::hash_map::Entry;
use std::collections::BTreeMap;
use std::sync::Arc;
use std::time::Duration;
use tokio::runtime::Builder;
use tokio::task::JoinHandle;
use tokio_shutdown::Shutdown;

impl Default for TorrentSharding {
    fn default() -> Self {
        Self::new()
    }
}

#[allow(dead_code)]
impl TorrentSharding {
    /// Creates an empty sharded torrent store with 256 independently locked shards.
    ///
    /// Torrents are assigned to a shard by the first byte of their info-hash.
    pub fn new() -> TorrentSharding {
        TorrentSharding {
            shards: std::array::from_fn(|_| Arc::new(RwLock::new(AHashMap::default()))),
        }
    }

    /// Runs the periodic peer-cleanup loop until shutdown is signalled.
    ///
    /// Spawns `peers_cleanup_threads` workers on a dedicated runtime; each pass scans all 256
    /// shards and removes peers older than `peer_timeout` (or `rtc_peer_timeout` for WebRTC peers).
    /// When `persistent` is false, torrents left without peers are removed entirely.
    pub async fn cleanup_threads(&self, torrent_tracker: Arc<TorrentTracker>, shutdown: Shutdown, peer_timeout: Duration, rtc_peer_timeout: Duration, persistent: bool) {
        let cleanup_interval = torrent_tracker.config.tracker_config.peers_cleanup_interval;
        let cleanup_threads = torrent_tracker.config.tracker_config.peers_cleanup_threads;
        let cleanup_pool = Builder::new_multi_thread()
            .worker_threads(cleanup_threads as usize)
            .thread_name("cleanup-worker")
            .enable_all()
            .build()
            .unwrap();
        let timer_handle: JoinHandle<()> = cleanup_pool.spawn({
            let torrent_tracker_clone = Arc::clone(&torrent_tracker);
            let shutdown_clone = shutdown.clone();
            async move {
                loop {
                    if shutdown_waiting(
                        Duration::from_secs(cleanup_interval),
                        shutdown_clone.clone()
                    ).await {
                        break;
                    }
                    let stats = Arc::new(CleanupStats::new());
                    let mut cleanup_handles = Vec::with_capacity(cleanup_threads as usize);
                    let shards_per_thread = 256 / cleanup_threads as usize;
                    let remainder = 256 % cleanup_threads as usize;
                    for thread_idx in 0..cleanup_threads as usize {
                        let tracker_clone = Arc::clone(&torrent_tracker_clone);
                        let stats_clone = Arc::clone(&stats);
                        let start_shard = thread_idx * shards_per_thread + thread_idx.min(remainder);
                        let extra = usize::from(thread_idx < remainder);
                        let end_shard = start_shard + shards_per_thread + extra;
                        let handle = tokio::spawn(async move {
                            for shard in start_shard..end_shard {
                                Self::cleanup_shard_optimized(
                                    tracker_clone.clone(),
                                    shard as u8,
                                    peer_timeout,
                                    rtc_peer_timeout,
                                    persistent,
                                    stats_clone.clone()
                                ).await;
                            }
                        });
                        cleanup_handles.push(handle);
                    }
                    for handle in cleanup_handles {
                        let _ = handle.await;
                    }
                    stats.apply_to_tracker(&torrent_tracker_clone);
                }
            }
        });
        shutdown.handle().await;
        timer_handle.abort();
        let _ = timer_handle.await;
        cleanup_pool.shutdown_background();
    }

    /// Run a single cleanup pass over all shards synchronously. Intended for tests.
    pub async fn cleanup_once(torrent_tracker: Arc<TorrentTracker>, peer_timeout: Duration, rtc_peer_timeout: Duration, persistent: bool) {
        let stats = Arc::new(CleanupStats::new());
        for shard in 0u8..=255 {
            Self::cleanup_shard_optimized(torrent_tracker.clone(), shard, peer_timeout, rtc_peer_timeout, persistent, stats.clone()).await;
        }
        stats.apply_to_tracker(&torrent_tracker);
    }

    async fn cleanup_shard_optimized(
        torrent_tracker: Arc<TorrentTracker>,
        shard: u8,
        peer_timeout: Duration,
        rtc_peer_timeout: Duration,
        persistent: bool,
        stats: Arc<CleanupStats>
    ) {
        let (mut torrents_removed, mut seeds_removed, mut peers_removed) = (0u64, 0u64, 0u64);
        if let Some(shard_arc) = torrent_tracker.torrents_sharding.shards.get(shard as usize) {
            let now = std::time::Instant::now();
            let cutoff = now.checked_sub(peer_timeout).unwrap();
            let rtc_cutoff = now.checked_sub(rtc_peer_timeout).unwrap();
            let mut expired_full: Vec<InfoHash> = Vec::new();
            #[allow(clippy::type_complexity)]
            let mut expired_partial: Vec<(InfoHash, Vec<PeerId>, Vec<PeerId>, Vec<PeerId>, Vec<PeerId>, Vec<PeerId>, Vec<PeerId>)> = Vec::new();
            {
                let shard_read = shard_arc.read();
                for (info_hash, torrent_entry) in shard_read.iter() {
                    if torrent_entry.updated < cutoff {
                        expired_full.push(*info_hash);
                        continue;
                    }
                    let mut has_expired = false;
                    let mut expired_seeds = Vec::new();
                    let mut expired_seeds_ipv6 = Vec::new();
                    let mut expired_peers = Vec::new();
                    let mut expired_peers_ipv6 = Vec::new();
                    let mut expired_rtc_seeds = Vec::new();
                    let mut expired_rtc_peers = Vec::new();
                    for (peer_id, torrent_peer) in &torrent_entry.seeds {
                        if torrent_peer.updated < cutoff {
                            expired_seeds.push(*peer_id);
                            has_expired = true;
                        }
                    }
                    for (peer_id, torrent_peer) in &torrent_entry.seeds_ipv6 {
                        if torrent_peer.updated < cutoff {
                            expired_seeds_ipv6.push(*peer_id);
                            has_expired = true;
                        }
                    }
                    for (peer_id, torrent_peer) in &torrent_entry.peers {
                        if torrent_peer.updated < cutoff {
                            expired_peers.push(*peer_id);
                            has_expired = true;
                        }
                    }
                    for (peer_id, torrent_peer) in &torrent_entry.peers_ipv6 {
                        if torrent_peer.updated < cutoff {
                            expired_peers_ipv6.push(*peer_id);
                            has_expired = true;
                        }
                    }
                    for (peer_id, torrent_peer) in &torrent_entry.rtc_seeds {
                        if torrent_peer.updated < rtc_cutoff {
                            expired_rtc_seeds.push(*peer_id);
                            has_expired = true;
                        }
                    }
                    for (peer_id, torrent_peer) in &torrent_entry.rtc_peers {
                        if torrent_peer.updated < rtc_cutoff {
                            expired_rtc_peers.push(*peer_id);
                            has_expired = true;
                        }
                    }
                    if has_expired {
                        expired_partial.push((*info_hash, expired_seeds, expired_seeds_ipv6, expired_peers, expired_peers_ipv6, expired_rtc_seeds, expired_rtc_peers));
                    }
                }
            }
            if !expired_partial.is_empty() || !expired_full.is_empty() {
                let mut shard_write = shard_arc.write();
                for (info_hash, expired_seeds, expired_seeds_ipv6, expired_peers, expired_peers_ipv6, expired_rtc_seeds, expired_rtc_peers) in &expired_partial {
                    if let Entry::Occupied(mut entry) = shard_write.entry(*info_hash) {
                        let torrent_entry = entry.get_mut();
                        for peer_id in expired_seeds {
                            if torrent_entry.seeds.remove(peer_id).is_some() {
                                seeds_removed += 1;
                            }
                        }
                        for peer_id in expired_seeds_ipv6 {
                            if torrent_entry.seeds_ipv6.remove(peer_id).is_some() {
                                seeds_removed += 1;
                            }
                        }
                        for peer_id in expired_peers {
                            if torrent_entry.peers.remove(peer_id).is_some() {
                                peers_removed += 1;
                            }
                        }
                        for peer_id in expired_peers_ipv6 {
                            if torrent_entry.peers_ipv6.remove(peer_id).is_some() {
                                peers_removed += 1;
                            }
                        }
                        for peer_id in expired_rtc_seeds {
                            if torrent_entry.rtc_seeds.remove(peer_id).is_some() {
                                seeds_removed += 1;
                            }
                        }
                        for peer_id in expired_rtc_peers {
                            if torrent_entry.rtc_peers.remove(peer_id).is_some() {
                                peers_removed += 1;
                            }
                        }
                        if !persistent
                            && torrent_entry.seeds.is_empty()
                            && torrent_entry.seeds_ipv6.is_empty()
                            && torrent_entry.peers.is_empty()
                            && torrent_entry.peers_ipv6.is_empty()
                            && torrent_entry.rtc_seeds.is_empty()
                            && torrent_entry.rtc_peers.is_empty()
                        {
                            entry.remove();
                            torrents_removed += 1;
                        }
                    }
                }
                for info_hash in &expired_full {
                    if let Entry::Occupied(entry) = shard_write.entry(*info_hash) {
                        let mut entry = entry;
                        if entry.get().updated >= cutoff { continue; }
                        let torrent_entry = entry.get_mut();
                        let seeds_len = torrent_entry.seeds.len() as u64;
                        let seeds_ipv6_len = torrent_entry.seeds_ipv6.len() as u64;
                        let peers_len = torrent_entry.peers.len() as u64;
                        let peers_ipv6_len = torrent_entry.peers_ipv6.len() as u64;
                        let rtc_seeds_len = torrent_entry.rtc_seeds.len() as u64;
                        let rtc_peers_len = torrent_entry.rtc_peers.len() as u64;
                        if persistent {
                            if seeds_len > 0 {
                                torrent_entry.seeds.clear();
                                seeds_removed += seeds_len;
                            }
                            if seeds_ipv6_len > 0 {
                                torrent_entry.seeds_ipv6.clear();
                                seeds_removed += seeds_ipv6_len;
                            }
                            if peers_len > 0 {
                                torrent_entry.peers.clear();
                                peers_removed += peers_len;
                            }
                            if peers_ipv6_len > 0 {
                                torrent_entry.peers_ipv6.clear();
                                peers_removed += peers_ipv6_len;
                            }
                            if rtc_seeds_len > 0 {
                                torrent_entry.rtc_seeds.clear();
                                seeds_removed += rtc_seeds_len;
                            }
                            if rtc_peers_len > 0 {
                                torrent_entry.rtc_peers.clear();
                                peers_removed += rtc_peers_len;
                            }
                        } else {
                            entry.remove();
                            torrents_removed += 1;
                            seeds_removed += seeds_len + seeds_ipv6_len + rtc_seeds_len;
                            peers_removed += peers_len + peers_ipv6_len + rtc_peers_len;
                        }
                    }
                }
            }
        }
        if torrents_removed > 0 {
            stats.add_torrents(torrents_removed);
        }
        if seeds_removed > 0 {
            stats.add_seeds(seeds_removed);
        }
        if peers_removed > 0 {
            stats.add_peers(peers_removed);
        }
        if seeds_removed > 0 || peers_removed > 0 || torrents_removed > 0 {
            info!("[PEERS] Shard: {shard} - Torrents: {torrents_removed} - Seeds: {seeds_removed} - Peers: {peers_removed}");
        }
    }

    /// Returns `true` when the given info-hash is currently tracked.
    #[inline]
    pub fn contains_torrent(&self, info_hash: InfoHash) -> bool {
        let shard_index = info_hash.0[0] as usize;
        self.shards.get(shard_index)
            .is_some_and(|s| s.read().contains_key(&info_hash))
    }

    /// Returns `true` when the given peer id is present in any peer map of the torrent.
    #[inline]
    pub fn contains_peer(&self, info_hash: InfoHash, peer_id: PeerId) -> bool {
        let shard_index = info_hash.0[0] as usize;
        self.shards.get(shard_index)
            .and_then(|s| {
                let shard = s.read();
                shard.get(&info_hash).map(|entry| {
                    entry.seeds.contains_key(&peer_id)
                        || entry.seeds_ipv6.contains_key(&peer_id)
                        || entry.peers.contains_key(&peer_id)
                        || entry.peers_ipv6.contains_key(&peer_id)
                        || entry.rtc_seeds.contains_key(&peer_id)
                        || entry.rtc_peers.contains_key(&peer_id)
                })
            })
            .unwrap_or(false)
    }

    /// Returns the shard (an `Arc<RwLock<..>>` map) that stores torrents whose info-hash starts with `shard`.
    #[inline]
    pub fn get_shard(&self, shard: u8) -> Option<Arc<RwLock<AHashMap<InfoHash, TorrentEntry>>>> {
        self.shards.get(shard as usize).cloned()
    }

    /// Returns a cloned, ordered snapshot of every torrent in the given shard.
    pub fn get_shard_content(&self, shard: u8) -> BTreeMap<InfoHash, TorrentEntry> {
        self.shards.get(shard as usize)
            .map(|s| s.read().iter().map(|(k, v)| (*k, v.clone())).collect())
            .unwrap_or_default()
    }

    /// Returns a cloned, ordered snapshot of every tracked torrent across all shards.
    ///
    /// This clones the full swarm state; intended for export/persistence, not per-request use.
    pub fn get_all_content(&self) -> BTreeMap<InfoHash, TorrentEntry> {
        let mut torrents_return = BTreeMap::new();
        for shard in &self.shards {
            let shard_data = shard.read();
            for (k, v) in shard_data.iter() {
                torrents_return.insert(*k, v.clone());
            }
        }
        torrents_return
    }

    /// Returns the total number of tracked torrents across all shards.
    pub fn get_torrents_amount(&self) -> u64 {
        self.shards.iter()
            .map(|shard| shard.read().len() as u64)
            .sum()
    }

    /// Fetches multiple torrents in one pass, grouping the lookups per shard to minimise locking.
    ///
    /// Absent torrents map to `None`.
    pub fn get_multiple_torrents(&self, info_hashes: &[InfoHash]) -> BTreeMap<InfoHash, Option<TorrentEntry>> {
        let mut results = BTreeMap::new();
        let mut shard_groups: [Vec<InfoHash>; 256] = std::array::from_fn(|_| Vec::new());
        for &info_hash in info_hashes {
            shard_groups[info_hash.0[0] as usize].push(info_hash);
        }
        for (shard_index, hashes) in shard_groups.iter().enumerate() {
            if !hashes.is_empty() {
                let shard = self.shards[shard_index].read();
                for &hash in hashes {
                    results.insert(hash, shard.get(&hash).cloned());
                }
            }
        }
        results
    }

    /// Checks `(info_hash, peer_id)` pairs in one pass, grouping the lookups per shard.
    ///
    /// The result vector matches the order of `queries`.
    pub fn batch_contains_peers(&self, queries: &[(InfoHash, PeerId)]) -> Vec<bool> {
        let mut results = vec![false; queries.len()];
        let mut shard_groups: [Vec<usize>; 256] = std::array::from_fn(|_| Vec::new());
        for (idx, &(info_hash, _)) in queries.iter().enumerate() {
            shard_groups[info_hash.0[0] as usize].push(idx);
        }
        for (shard_index, indices) in shard_groups.iter().enumerate() {
            if !indices.is_empty() {
                let shard = self.shards[shard_index].read();
                for &idx in indices {
                    let (info_hash, peer_id) = queries[idx];
                    results[idx] = shard.get(&info_hash)
                        .is_some_and(|entry| {
                            entry.seeds.contains_key(&peer_id)
                                || entry.seeds_ipv6.contains_key(&peer_id)
                                || entry.peers.contains_key(&peer_id)
                                || entry.peers_ipv6.contains_key(&peer_id)
                                || entry.rtc_seeds.contains_key(&peer_id)
                                || entry.rtc_peers.contains_key(&peer_id)
                        });
                }
            }
        }
        results
    }

    /// Invokes `f` for every tracked torrent, shard by shard, without cloning entries.
    ///
    /// Each shard's read lock is held while its entries are visited.
    pub fn iter_all_torrents<F>(&self, mut f: F)
    where
        F: FnMut(&InfoHash, &TorrentEntry)
    {
        for shard in &self.shards {
            let shard_data = shard.read();
            for (k, v) in shard_data.iter() {
                f(k, v);
            }
        }
    }
}