aria2-core 0.3.13

aria2-rust core download engine: multi-protocol segmented downloads, rate limiting, configuration, session persistence, and BitTorrent seeding
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
//! Shared upload policy and request handling for torrent-owned peer actors.
//!
//! This module does not own peer transport I/O; the long-lived peer actor is
//! the sole runtime owner of each connection.

use async_trait::async_trait;
use std::collections::VecDeque;
use std::time::Duration;
use tracing::{debug, warn};

use crate::error::Result;
use crate::rate_limiter::RateLimiter;

use crate::engine::bittorrent::peer::message_validation::BtMessageValidator;
use aria2_protocol::bittorrent::message::types::BtMessage;
use aria2_protocol::bittorrent::message::types::PieceBlockRequest;

mod in_memory_provider;
pub use in_memory_provider::InMemoryPieceProvider;

/// Supplies verified torrent pieces to peer upload sessions.
///
/// Implementations must report a piece available only after its integrity has
/// been verified. Reads return the exact requested range, or `None` when the
/// piece/range is unavailable; short reads are treated as unavailable data.
#[allow(clippy::double_must_use)]
#[async_trait]
pub trait PieceDataProvider: Send + Sync {
    /// Read an exact byte range from a verified piece.
    async fn get_piece_data(&self, piece_index: u32, offset: u32, length: u32) -> Option<Vec<u8>>;

    /// Whether the complete piece is locally available and verified.
    fn has_piece(&self, piece_index: u32) -> bool;

    /// Number of pieces described by this provider.
    fn num_pieces(&self) -> u32;

    /// Nominal size of each piece; the final piece may be shorter.
    fn piece_length(&self) -> u32;
}

/// Upload rate and unchoke policy shared by peer actors and seed managers.
#[derive(Clone)]
pub struct BtSeedingConfig {
    /// Per-torrent upload limit in bytes per second. `None` is unlimited.
    pub max_upload_bytes_per_sec: Option<u64>,
    /// Process-wide limiter shared by all download/seeding commands.
    pub global_limiter: Option<RateLimiter>,
    /// Maximum number of interested peers to unchoke at once.
    pub max_peers_to_unchoke: usize,
    /// Period between optimistic-unchoke rotations, in seconds.
    pub optimistic_unchoke_interval_secs: u64,
}

impl Default for BtSeedingConfig {
    fn default() -> Self {
        Self {
            max_upload_bytes_per_sec: None,
            global_limiter: None,
            max_peers_to_unchoke: crate::constants::BT_DEFAULT_MAX_UPLOAD_SLOTS,
            optimistic_unchoke_interval_secs: crate::constants::BT_OPTIMISTIC_UNCHOKE_INTERVAL_SECS,
        }
    }
}

/// The per-peer upload state shared by downloading and seeding sessions.
///
/// A peer connection is duplex: while its download side is waiting for
/// `Piece` messages, the remote side may send `Interested` and `Request` for
/// pieces we already have. Keeping this state independent from the transport
/// lets the same request handling run on an active download connection.
pub(crate) struct BtUploadState {
    am_choke_state: bool,
    auto_unchoke: bool,
    uploaded_bytes: u64,
    upload_limiter: RateLimiter,
    global_upload_limiter: Option<RateLimiter>,
    message_validator: Option<BtMessageValidator>,
    upload_counter: Option<std::sync::Arc<std::sync::atomic::AtomicU64>>,
    outbound: VecDeque<PendingUploadMessage>,
}

const MAX_PENDING_UPLOAD_MESSAGES: usize = 64;
const UPLOAD_TOKEN_WAIT_SLICE: Duration = Duration::from_millis(25);

enum PendingUploadMessage {
    /// Piece data is loaded only when the queue is flushed, so a matching
    /// inbound Cancel can invalidate this item first.
    Piece {
        request: PieceBlockRequest,
        local_tokens_acquired: bool,
    },
    Message(BtMessage),
}

#[allow(clippy::double_must_use)]
#[async_trait]
pub(crate) trait BtUploadTransport {
    fn supports_fast_extension(&self) -> bool {
        false
    }
    fn am_allowed_fast(&self, _piece_index: u32) -> bool {
        false
    }
    async fn send_upload_message(&mut self, message: &BtMessage)
    -> std::result::Result<(), String>;
    async fn send_upload_choke(&mut self) -> std::result::Result<(), String>;
    async fn send_upload_unchoke(&mut self) -> std::result::Result<(), String>;
}

impl BtUploadState {
    pub(crate) fn new_with_limiter(config: &BtSeedingConfig, upload_limiter: RateLimiter) -> Self {
        Self {
            am_choke_state: false,
            auto_unchoke: true,
            uploaded_bytes: 0,
            upload_limiter,
            global_upload_limiter: config.global_limiter.clone(),
            message_validator: None,
            upload_counter: None,
            outbound: VecDeque::new(),
        }
    }

    #[cfg(test)]
    fn new(config: &BtSeedingConfig) -> Self {
        Self::new_with_limiter(config, RateLimiter::unlimited())
    }

    pub(crate) fn set_upload_counter(
        &mut self,
        counter: std::sync::Arc<std::sync::atomic::AtomicU64>,
    ) {
        self.upload_counter = Some(counter);
    }

    pub(crate) fn set_auto_unchoke(&mut self, enabled: bool) {
        self.auto_unchoke = enabled;
        if !enabled {
            self.am_choke_state = true;
        }
    }

    pub(crate) fn configure_message_validator(&mut self, num_pieces: u32, piece_length: u32) {
        self.message_validator = Some(BtMessageValidator::new(num_pieces, piece_length));
    }

    pub(crate) async fn send_piece_availability<T: BtUploadTransport>(
        &mut self,
        transport: &mut T,
        provider: &dyn PieceDataProvider,
    ) -> Result<()> {
        let num_pieces = provider.num_pieces();
        let supports_fast_extension = transport.supports_fast_extension();
        let mut bitfield = vec![0u8; (num_pieces as usize).div_ceil(8)];
        let mut has_any_piece = false;
        let mut has_all_pieces = true;
        for piece_index in 0..num_pieces {
            if provider.has_piece(piece_index) {
                bitfield[piece_index as usize / 8] |= 1 << (7 - piece_index % 8);
                has_any_piece = true;
            } else {
                has_all_pieces = false;
            }
        }

        let message = if supports_fast_extension && has_all_pieces {
            BtMessage::HaveAll
        } else if !has_any_piece {
            if supports_fast_extension {
                BtMessage::HaveNone
            } else {
                return Ok(());
            }
        } else {
            BtMessage::Bitfield { data: bitfield }
        };
        transport
            .send_upload_message(&message)
            .await
            .map_err(|error| {
                crate::error::Aria2Error::Recoverable(
                    crate::error::RecoverableError::TemporaryNetworkFailure { message: error },
                )
            })
    }

    pub(crate) async fn handle_message<T: BtUploadTransport>(
        &mut self,
        transport: &mut T,
        message: BtMessage,
        provider: &dyn PieceDataProvider,
    ) -> Result<u64> {
        if let Some(validator) = &self.message_validator {
            validator.validate(&message).map_err(|error| {
                crate::error::Aria2Error::Recoverable(
                    crate::error::RecoverableError::TemporaryNetworkFailure {
                        message: format!("invalid BitTorrent upload message: {error}"),
                    },
                )
            })?;
        }

        match message {
            BtMessage::Request { request } => {
                let allowed_while_choked = transport.am_allowed_fast(request.index);
                let has_piece = provider.has_piece(request.index);
                if (!self.am_choke_state || allowed_while_choked) && has_piece {
                    debug!(
                        "Upload request: piece={}, offset={}, len={}",
                        request.index, request.begin, request.length
                    );
                    if self.outbound.len() < MAX_PENDING_UPLOAD_MESSAGES {
                        self.outbound.push_back(PendingUploadMessage::Piece {
                            request,
                            local_tokens_acquired: false,
                        });
                    } else if transport.supports_fast_extension() {
                        self.queue_reject_if_fast(transport, &request).await?;
                    } else {
                        return Err(crate::error::Aria2Error::Recoverable(
                            crate::error::RecoverableError::TemporaryNetworkFailure {
                                message: format!(
                                    "peer exceeded the {}-request upload queue limit",
                                    MAX_PENDING_UPLOAD_MESSAGES
                                ),
                            },
                        ));
                    }
                } else {
                    debug!(
                        piece = request.index,
                        choked = self.am_choke_state && !allowed_while_choked,
                        has_piece,
                        "Cannot queue upload response for request"
                    );
                    self.queue_reject_if_fast(transport, &request).await?;
                }
            }
            BtMessage::Interested => {
                if self.auto_unchoke && !self.am_choke_state {
                    transport.send_upload_unchoke().await.ok();
                }
            }
            BtMessage::Choke => debug!("Peer choked us"),
            BtMessage::Unchoke => debug!("Peer unchoked us"),
            BtMessage::Have { piece_index } => debug!("Peer has piece {}", piece_index),
            BtMessage::Cancel { request } => {
                let before = self.outbound.len();
                let mut refund_local_tokens = 0u64;
                self.outbound.retain(|message| match message {
                    PendingUploadMessage::Piece {
                        request: pending,
                        local_tokens_acquired,
                    } if pending == &request => {
                        if *local_tokens_acquired {
                            refund_local_tokens =
                                refund_local_tokens.saturating_add(u64::from(pending.length));
                        }
                        false
                    }
                    _ => true,
                });
                if refund_local_tokens > 0 {
                    self.upload_limiter.refund_upload(refund_local_tokens);
                }
                let canceled = before != self.outbound.len();
                debug!(
                    piece = request.index,
                    offset = request.begin,
                    canceled,
                    "Peer cancelled queued upload response"
                );
                if canceled {
                    self.queue_reject_if_fast(transport, &request).await?;
                }
            }
            BtMessage::Piece { .. } => debug!("Unexpected Piece from peer during upload"),
            BtMessage::Bitfield { .. }
            | BtMessage::KeepAlive
            | BtMessage::Port { .. }
            | BtMessage::AllowedFast { .. }
            | BtMessage::Reject { .. }
            | BtMessage::Suggest { .. }
            | BtMessage::NotInterested
            | BtMessage::HaveAll
            | BtMessage::HaveNone
            | BtMessage::Extended { .. } => {}
        }

        Ok(0)
    }

    pub(crate) fn has_pending_messages(&self) -> bool {
        !self.outbound.is_empty()
    }

    pub(crate) fn outstanding_upload_count(&self) -> usize {
        self.outbound
            .iter()
            .filter(|message| matches!(message, PendingUploadMessage::Piece { .. }))
            .count()
    }

    pub(crate) fn pending_flush_delay(&self) -> Option<Duration> {
        match self.outbound.front()? {
            PendingUploadMessage::Message(_) => Some(Duration::ZERO),
            PendingUploadMessage::Piece {
                request,
                local_tokens_acquired: false,
            } => {
                let bytes = u64::from(request.length);
                let local_wait = self.upload_limiter.upload_wait(bytes);
                let global_wait = self
                    .global_upload_limiter
                    .as_ref()
                    .filter(|limiter| limiter.is_upload_limited())
                    .map_or(Duration::ZERO, |limiter| limiter.upload_wait(bytes));
                Some(local_wait.max(global_wait))
            }
            PendingUploadMessage::Piece {
                request,
                local_tokens_acquired: true,
            } => Some(
                self.global_upload_limiter
                    .as_ref()
                    .filter(|limiter| limiter.is_upload_limited())
                    .map_or(Duration::ZERO, |limiter| {
                        limiter.upload_wait(u64::from(request.length))
                    }),
            ),
        }
    }

    pub(crate) fn rate_change_receivers(
        &self,
    ) -> (
        tokio::sync::watch::Receiver<u64>,
        Option<tokio::sync::watch::Receiver<u64>>,
    ) {
        (
            self.upload_limiter.subscribe_upload_rate_changes(),
            self.global_upload_limiter
                .as_ref()
                .map(RateLimiter::subscribe_upload_rate_changes),
        )
    }

    pub(crate) async fn flush_pending_messages<T: BtUploadTransport>(
        &mut self,
        transport: &mut T,
        provider: &dyn PieceDataProvider,
    ) -> Result<u64> {
        let uploaded_before = self.uploaded_bytes;
        while let Some(message) = self.outbound.pop_front() {
            match message {
                PendingUploadMessage::Message(message) => {
                    send_upload_message(transport, &message).await?;
                }
                PendingUploadMessage::Piece {
                    request,
                    mut local_tokens_acquired,
                } => {
                    let requested_len = u64::from(request.length);
                    if !local_tokens_acquired {
                        if tokio::time::timeout(
                            UPLOAD_TOKEN_WAIT_SLICE,
                            self.upload_limiter.acquire_upload(requested_len),
                        )
                        .await
                        .is_err()
                        {
                            self.outbound.push_front(PendingUploadMessage::Piece {
                                request,
                                local_tokens_acquired: false,
                            });
                            return Ok(self.uploaded_bytes - uploaded_before);
                        }
                        local_tokens_acquired = true;
                    }
                    if let Some(limiter) = self.global_upload_limiter.as_ref()
                        && limiter.is_upload_limited()
                        && tokio::time::timeout(
                            UPLOAD_TOKEN_WAIT_SLICE,
                            limiter.acquire_upload(requested_len),
                        )
                        .await
                        .is_err()
                    {
                        self.outbound.push_front(PendingUploadMessage::Piece {
                            request,
                            local_tokens_acquired,
                        });
                        return Ok(self.uploaded_bytes - uploaded_before);
                    }
                    let Some(data) = provider
                        .get_piece_data(request.index, request.begin, request.length)
                        .await
                    else {
                        if local_tokens_acquired {
                            self.upload_limiter.refund_upload(requested_len);
                        }
                        if let Some(limiter) = self.global_upload_limiter.as_ref()
                            && limiter.is_upload_limited()
                        {
                            limiter.refund_upload(requested_len);
                        }
                        warn!(
                            piece = request.index,
                            offset = request.begin,
                            "No data for queued upload request"
                        );
                        self.queue_reject_if_fast(transport, &request).await?;
                        continue;
                    };
                    let data_len = data.len() as u64;
                    if data_len != requested_len {
                        if local_tokens_acquired {
                            self.upload_limiter.refund_upload(requested_len);
                        }
                        if let Some(limiter) = self.global_upload_limiter.as_ref()
                            && limiter.is_upload_limited()
                        {
                            limiter.refund_upload(requested_len);
                        }
                        warn!(
                            "Piece provider returned {} bytes for a {}-byte request (piece={}, offset={})",
                            data_len, request.length, request.index, request.begin
                        );
                        self.queue_reject_if_fast(transport, &request).await?;
                        continue;
                    }
                    let message = BtMessage::Piece {
                        index: request.index,
                        begin: request.begin,
                        data: data.into(),
                    };
                    send_upload_message(transport, &message).await?;
                    self.uploaded_bytes += data_len;
                    if let Some(counter) = &self.upload_counter {
                        counter.fetch_add(data_len, std::sync::atomic::Ordering::Relaxed);
                    }
                }
            }
        }
        Ok(self.uploaded_bytes - uploaded_before)
    }

    async fn queue_reject_if_fast<T: BtUploadTransport>(
        &mut self,
        transport: &mut T,
        request: &PieceBlockRequest,
    ) -> Result<()> {
        if !transport.supports_fast_extension() {
            return Ok(());
        }
        let reject = BtMessage::Reject {
            index: request.index,
            offset: request.begin,
            length: request.length,
        };
        if self.outbound.len() < MAX_PENDING_UPLOAD_MESSAGES {
            self.outbound
                .push_back(PendingUploadMessage::Message(reject));
            return Ok(());
        }
        send_upload_message(transport, &reject).await
    }

    pub(crate) fn discard_pending_messages(&mut self) {
        let mut refund_local_tokens = 0u64;
        for message in self.outbound.drain(..) {
            if let PendingUploadMessage::Piece {
                request,
                local_tokens_acquired: true,
            } = message
            {
                refund_local_tokens = refund_local_tokens.saturating_add(u64::from(request.length));
            }
        }
        if refund_local_tokens > 0 {
            self.upload_limiter.refund_upload(refund_local_tokens);
        }
    }

    pub(crate) async fn unchoke_peer<T: BtUploadTransport>(
        &mut self,
        transport: &mut T,
    ) -> Result<()> {
        if self.am_choke_state {
            transport.send_upload_unchoke().await.map_err(|error| {
                crate::error::Aria2Error::Recoverable(
                    crate::error::RecoverableError::TemporaryNetworkFailure { message: error },
                )
            })?;
            self.am_choke_state = false;
        }
        Ok(())
    }

    pub(crate) async fn choke_peer<T: BtUploadTransport>(
        &mut self,
        transport: &mut T,
    ) -> Result<()> {
        if !self.am_choke_state {
            transport.send_upload_choke().await.map_err(|error| {
                crate::error::Aria2Error::Recoverable(
                    crate::error::RecoverableError::TemporaryNetworkFailure { message: error },
                )
            })?;
            self.am_choke_state = true;
        }
        Ok(())
    }

    pub(crate) fn is_peer_choked(&self) -> bool {
        self.am_choke_state
    }

    #[cfg(test)]
    pub(crate) fn uploaded_bytes(&self) -> u64 {
        self.uploaded_bytes
    }
}

async fn send_upload_message<T: BtUploadTransport>(
    transport: &mut T,
    message: &BtMessage,
) -> Result<()> {
    transport
        .send_upload_message(message)
        .await
        .map_err(|message| {
            crate::error::Aria2Error::Recoverable(
                crate::error::RecoverableError::TemporaryNetworkFailure { message },
            )
        })?;
    Ok(())
}

#[cfg(test)]
#[path = "upload_session/tests.rs"]
mod tests;