aria2-protocol 0.3.7

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
use std::net::SocketAddr;
use std::sync::Arc;
use std::time::Duration;

use tokio::sync::mpsc;
use tokio::task::JoinSet;
use tracing::{debug, info};

use super::super::handler::DhtQueryHandler;
use super::super::message::{DhtMessage, DhtMessageType};
use super::super::node::DhtNode;
use super::super::tracker::TransactionTracker;
use super::{DhtEngine, DhtEngineContext};

const INBOUND_QUEUE_CAPACITY: usize = 1024;
const INBOUND_WORKERS: usize = 4;
const INBOUND_WORKER_DRAIN_TIMEOUT: Duration = Duration::from_millis(100);

type InboundPacket = (Vec<u8>, SocketAddr);

impl DhtEngine {
    /// Spawn the sole UDP reader and its bounded inbound workers.
    pub(super) async fn spawn_receive_loop(
        self: &Arc<Self>,
        mut shutdown_rx: tokio::sync::watch::Receiver<bool>,
    ) {
        let context = Arc::clone(&self.context);
        let socket = context.task_context.socket.clone();
        let tracker = Arc::clone(&context.task_context.tracker);
        let tracker_notify = tracker.change_notifier();
        let handler_self_id = context.task_context.self_id;
        let local_peer_lookup = context.local_peer_lookup.clone();

        self.register_background_task(async move {
            // Independent receivers keep packet processing concurrent without
            // serializing `recv().await` behind a shared receiver mutex.
            let worker_capacity = INBOUND_QUEUE_CAPACITY.div_ceil(INBOUND_WORKERS);
            let mut worker_txs: Vec<mpsc::Sender<InboundPacket>> =
                Vec::with_capacity(INBOUND_WORKERS);
            let mut workers = JoinSet::new();

            for _ in 0..INBOUND_WORKERS {
                let (worker_tx, mut worker_rx) = mpsc::channel(worker_capacity);
                worker_txs.push(worker_tx);
                let worker_context = Arc::clone(&context);
                let worker_tracker = Arc::clone(&tracker);
                let mut worker_handler = DhtQueryHandler::new(handler_self_id);
                if let Some(lookup) = local_peer_lookup.as_ref() {
                    worker_handler = worker_handler.with_local_peer_lookup(Arc::clone(lookup));
                }
                workers.spawn(async move {
                    while let Some((data, from)) = worker_rx.recv().await {
                        worker_context
                            .process_inbound_message(&data, from, &worker_tracker, &worker_handler)
                            .await;
                    }
                });
            }

            info!("DHT receive loop started");
            let mut buf = [0u8; 4096];
            let mut next_worker = 0usize;

            loop {
                if *shutdown_rx.borrow() {
                    break;
                }

                let timeout_wait = async {
                    match tracker.next_timeout() {
                        Some(timeout) => tokio::time::sleep(timeout).await,
                        None => std::future::pending::<()>().await,
                    }
                };
                tokio::pin!(timeout_wait);
                let transaction_changed = tracker_notify.notified();
                tokio::pin!(transaction_changed);
                transaction_changed.as_mut().enable();

                let timeout_elapsed = tokio::select! {
                    result = shutdown_rx.changed() => {
                        if result.is_ok() {
                            info!("DHT receive loop shutting down");
                        }
                        break;
                    }
                    result = socket.recv_from(&mut buf) => {
                        match result {
                            Ok((len, from)) if len > 0 => {
                                if !dispatch_inbound_packet(
                                    (buf[..len].to_vec(), from),
                                    &worker_txs,
                                    &mut next_worker,
                                ) {
                                    debug!(
                                        "DHT inbound workers busy; dropping packet from {}",
                                        from
                                    );
                                }
                            }
                            Ok(_) => { /* empty packet, ignore */ }
                            Err(error)
                                if error.kind() == std::io::ErrorKind::ConnectionReset =>
                            {
                                // Windows reports ICMP Port Unreachable for an outbound UDP
                                // query as WSAECONNRESET on the next receive. This is a
                                // per-datagram result, not a failure of the DHT socket.
                                debug!(
                                    local_addr = %context.task_context.socket.local_addr(),
                                    %error,
                                    "Ignoring DHT UDP connection reset"
                                );
                            }
                            Err(error) => {
                                debug!("DHT recv error: {}", error);
                                break;
                            }
                        }
                        false
                    }
                    _ = &mut timeout_wait => true,
                    _ = &mut transaction_changed => {
                        continue;
                    }
                };

                if timeout_elapsed {
                    // Query owners account for failures exactly once; doing it
                    // here would race their local response waits.
                    let expired = tracker.handle_timeouts();
                    if expired > 0 {
                        debug!(count = expired, "DHT transactions expired");
                    }
                }
            }

            // Closing senders lets workers drain queued datagrams before the
            // fixed shutdown deadline aborts any worker still blocked.
            drop(worker_txs);
            drain_inbound_workers(workers).await;
            info!("DHT receive loop exited");
        })
        .await;
    }
}

impl DhtEngineContext {
    async fn process_inbound_message(
        &self,
        data: &[u8],
        from: SocketAddr,
        tracker: &TransactionTracker,
        handler: &DhtQueryHandler,
    ) {
        let Ok(message) = DhtMessage::decode(data) else {
            return;
        };

        match message.y {
            DhtMessageType::Response | DhtMessageType::Error => {
                tracker.handle_response(message, from);
            }
            DhtMessageType::Query => {
                let (response, sender_to_promote) = {
                    let routing_table = self.task_context.routing_table.read().await;
                    let tokens = self
                        .token_tracker
                        .lock()
                        .unwrap_or_else(|error| error.into_inner());
                    let result = handler.handle_query(
                        &message,
                        from,
                        &routing_table,
                        &tokens,
                        &self.peer_storage,
                        Some(&self.item_store),
                    );
                    (result.response, result.sender_to_promote)
                };

                if let Some(response) = response {
                    let encoded = response.encode();
                    if let Err(error) = self.task_context.socket.send_to(from, &encoded).await {
                        debug!(to = %from, "Failed to send DHT response: {}", error);
                    }
                }

                if let Some(sender_id) = sender_to_promote {
                    let mut routing_table = self.task_context.routing_table.write().await;
                    routing_table.mark_good(&sender_id);
                    routing_table.insert(DhtNode::new(sender_id, from));
                }
            }
        }
    }
}

fn dispatch_inbound_packet(
    mut packet: InboundPacket,
    worker_txs: &[mpsc::Sender<InboundPacket>],
    next_worker: &mut usize,
) -> bool {
    let worker_count = worker_txs.len();
    if worker_count == 0 {
        return false;
    }

    for offset in 0..worker_count {
        let worker_index = (*next_worker + offset) % worker_count;
        match worker_txs[worker_index].try_send(packet) {
            Ok(()) => {
                *next_worker = (worker_index + 1) % worker_count;
                return true;
            }
            Err(error) => packet = error.into_inner(),
        }
    }
    false
}

async fn drain_inbound_workers(mut workers: JoinSet<()>) {
    let wait_for_workers = async { while workers.join_next().await.is_some() {} };
    if tokio::time::timeout(INBOUND_WORKER_DRAIN_TIMEOUT, wait_for_workers)
        .await
        .is_err()
    {
        workers.abort_all();
        while workers.join_next().await.is_some() {}
    }
}

#[cfg(test)]
mod tests {
    use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
    use std::time::Duration;

    use super::*;
    use crate::bittorrent::bencode::codec::BencodeValue;
    use crate::bittorrent::dht::engine::DhtEngineConfig;
    use crate::bittorrent::dht::message::DhtMessageBuilder;
    use crate::bittorrent::dht::tracker::QueryType;

    fn packet(id: u8) -> InboundPacket {
        (vec![id], "127.0.0.1:6881".parse().unwrap())
    }

    #[tokio::test]
    async fn malformed_response_does_not_consume_pending_transaction() {
        let engine = DhtEngine::start(DhtEngineConfig::local())
            .await
            .expect("local DHT engine should start");
        let tracker = Arc::clone(&engine.context.task_context.tracker);
        let from: SocketAddr = "127.0.0.1:6881".parse().unwrap();
        let (transaction_id, response_wait) =
            tracker.allocate_wait(QueryType::Ping, from, Duration::from_secs(30));
        let mut invalid_type =
            DhtMessageBuilder::ping_response(&transaction_id.to_be_bytes(), &[0x22; 20]).encode();
        let response_type = b"1:y1:r";
        let type_offset = invalid_type
            .windows(response_type.len())
            .rposition(|window| window == response_type)
            .expect("encoded response should contain its y field");
        invalid_type.splice(
            type_offset..type_offset + response_type.len(),
            b"1:y2:rx".iter().copied(),
        );
        let missing_result = BencodeValue::Dict(std::collections::BTreeMap::from([
            (
                b"t".to_vec(),
                BencodeValue::Bytes(transaction_id.to_be_bytes().to_vec()),
            ),
            (b"y".to_vec(), BencodeValue::Bytes(b"r".to_vec())),
        ]))
        .encode();

        for malformed in [invalid_type, missing_result] {
            engine
                .context
                .process_inbound_message(
                    &malformed,
                    from,
                    tracker.as_ref(),
                    &DhtQueryHandler::new(engine.context.task_context.self_id),
                )
                .await;
        }

        assert_eq!(tracker.pending_count(), 1);
        drop(response_wait);
        engine.shutdown_async().await;
    }

    #[tokio::test]
    async fn protocol_error_reaches_waiter_as_failure() {
        let engine = DhtEngine::start(DhtEngineConfig::local())
            .await
            .expect("local DHT engine should start");
        let tracker = Arc::clone(&engine.context.task_context.tracker);
        let from: SocketAddr = "127.0.0.1:6881".parse().unwrap();
        let (transaction_id, response_wait) =
            tracker.allocate_wait(QueryType::Ping, from, Duration::from_secs(30));
        let error =
            DhtMessageBuilder::error_response(&transaction_id.to_be_bytes(), 203, "Protocol Error")
                .encode();

        engine
            .context
            .process_inbound_message(
                &error,
                from,
                tracker.as_ref(),
                &DhtQueryHandler::new(engine.context.task_context.self_id),
            )
            .await;

        assert_eq!(tracker.pending_count(), 0);
        assert!(response_wait.wait().await.is_none());
        engine.shutdown_async().await;
    }

    #[test]
    fn dispatch_skips_full_workers_and_rotates_start() {
        let (first_tx, mut first_rx) = mpsc::channel(1);
        first_tx.try_send(packet(1)).unwrap();
        let (second_tx, mut second_rx) = mpsc::channel(1);
        let worker_txs = [first_tx, second_tx];
        let mut next_worker = 0;

        assert!(dispatch_inbound_packet(
            packet(2),
            &worker_txs,
            &mut next_worker
        ));
        assert_eq!(next_worker, 0);
        assert_eq!(first_rx.try_recv().unwrap().0, vec![1]);
        assert_eq!(second_rx.try_recv().unwrap().0, vec![2]);

        assert!(dispatch_inbound_packet(
            packet(3),
            &worker_txs,
            &mut next_worker
        ));
        assert_eq!(next_worker, 1);
        assert_eq!(first_rx.try_recv().unwrap().0, vec![3]);
    }

    #[test]
    fn dispatch_drops_packet_when_all_worker_queues_are_full() {
        let (first_tx, mut first_rx) = mpsc::channel(1);
        first_tx.try_send(packet(1)).unwrap();
        let (second_tx, mut second_rx) = mpsc::channel(1);
        second_tx.try_send(packet(2)).unwrap();
        let worker_txs = [first_tx, second_tx];
        let mut next_worker = 0;

        assert!(!dispatch_inbound_packet(
            packet(3),
            &worker_txs,
            &mut next_worker
        ));
        assert_eq!(first_rx.try_recv().unwrap().0, vec![1]);
        assert_eq!(second_rx.try_recv().unwrap().0, vec![2]);
    }

    #[test]
    fn dispatch_skips_closed_worker() {
        let (closed_tx, closed_rx) = mpsc::channel(1);
        drop(closed_rx);
        let (live_tx, mut live_rx) = mpsc::channel(1);
        let worker_txs = [closed_tx, live_tx];
        let mut next_worker = 0;

        assert!(dispatch_inbound_packet(
            packet(4),
            &worker_txs,
            &mut next_worker
        ));
        assert_eq!(live_rx.try_recv().unwrap().0, vec![4]);
    }

    #[tokio::test]
    async fn shutdown_drains_queued_packets_before_workers_exit() {
        let (sender, mut receiver) = mpsc::channel(2);
        let processed = Arc::new(AtomicUsize::new(0));
        let worker_processed = Arc::clone(&processed);
        let mut workers = JoinSet::new();
        workers.spawn(async move {
            while receiver.recv().await.is_some() {
                worker_processed.fetch_add(1, Ordering::Relaxed);
            }
        });

        sender.send(packet(1)).await.unwrap();
        sender.send(packet(2)).await.unwrap();
        drop(sender);
        drain_inbound_workers(workers).await;

        assert_eq!(processed.load(Ordering::Relaxed), 2);
    }

    #[tokio::test]
    async fn shutdown_aborts_workers_that_exceed_drain_deadline() {
        struct DropSignal(Arc<AtomicBool>);

        impl Drop for DropSignal {
            fn drop(&mut self) {
                self.0.store(true, Ordering::Release);
            }
        }

        let started = Arc::new(tokio::sync::Notify::new());
        let dropped = Arc::new(AtomicBool::new(false));
        let worker_started = Arc::clone(&started);
        let worker_dropped = Arc::clone(&dropped);
        let mut workers = JoinSet::new();
        workers.spawn(async move {
            let _drop_signal = DropSignal(worker_dropped);
            worker_started.notify_one();
            std::future::pending::<()>().await;
        });
        started.notified().await;

        drain_inbound_workers(workers).await;

        assert!(dropped.load(Ordering::Acquire));
    }
}