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
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
use std::{fmt::Debug, sync::Arc, time::Duration};
use ahash::{AHashMap, AHashSet};
use anyhow::{anyhow, Result};
use cid::Cid;
use iroh_metrics::{bitswap::BitswapMetrics, inc, record};
use libp2p::PeerId;
use tokio::{
sync::{oneshot, Mutex, Notify, RwLock},
task::JoinHandle,
};
use tracing::{debug, error, info, warn};
use crate::{
block::Block,
client::wantlist,
message::{BitswapMessage, BlockPresence, BlockPresenceType, Entry, WantType},
peer_task_queue::{Config as PTQConfig, PeerTaskQueue, Task},
Store,
};
use super::{
blockstore_manager::BlockstoreManager,
ledger::Ledger,
peer_ledger::PeerLedger,
score_ledger::{DefaultScoreLedger, Receipt},
task_merger::{TaskData, TaskMerger},
};
use iroh_metrics::core::MRecorder;
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct TaskInfo {
peer: PeerId,
cid: Cid,
is_want_block: bool,
send_dont_have: bool,
block_size: usize,
have_block: bool,
}
pub trait PeerBlockRequestFilter:
Fn(&PeerId, &Cid) -> bool + Debug + 'static + Sync + Send
{
}
impl<F: Fn(&PeerId, &Cid) -> bool + Debug + 'static + Sync + Send> PeerBlockRequestFilter for F {}
pub trait ScorePeerFunc: Fn(&PeerId, usize) + Send + Sync {}
impl<F: Fn(&PeerId, usize) + Send + Sync> ScorePeerFunc for F {}
#[derive(Debug)]
pub struct Config {
pub peer_block_request_filter: Option<Box<dyn PeerBlockRequestFilter>>,
pub engine_task_worker_count: usize,
pub send_dont_haves: bool,
pub engine_blockstore_worker_count: usize,
pub target_message_size: usize,
pub max_outstanding_bytes_per_peer: usize,
pub max_replace_size: usize,
}
impl Default for Config {
fn default() -> Self {
Config {
peer_block_request_filter: None,
engine_task_worker_count: 8,
send_dont_haves: true,
engine_blockstore_worker_count: 128,
target_message_size: 16 * 1024,
max_outstanding_bytes_per_peer: 1 << 20,
max_replace_size: 1024,
}
}
}
#[derive(Debug)]
pub struct Engine<S: Store> {
peer_task_queue: PeerTaskQueue<Cid, TaskData, TaskMerger>,
outbox: async_channel::Receiver<Result<Envelope>>,
blockstore_manager: Arc<RwLock<BlockstoreManager<S>>>,
ledger_map: RwLock<AHashMap<PeerId, Arc<Mutex<Ledger>>>>,
peer_ledger: Mutex<PeerLedger>,
score_ledger: DefaultScoreLedger,
max_block_size_replace_has_with_block: usize,
send_dont_haves: bool,
metrics_update_counter: Mutex<usize>, peer_block_request_filter: Option<Box<dyn PeerBlockRequestFilter>>,
workers: Vec<(oneshot::Sender<()>, JoinHandle<()>)>,
work_signal: Arc<Notify>,
}
impl<S: Store> Engine<S> {
pub async fn new(store: S, _self_id: PeerId, config: Config) -> Self {
let outbox = async_channel::bounded(1024);
let work_signal = Arc::new(Notify::new());
let task_merger = TaskMerger::default();
let peer_task_queue = PeerTaskQueue::new(
task_merger,
PTQConfig {
max_outstanding_work_per_peer: config.max_outstanding_bytes_per_peer,
ignore_freezing: true,
},
);
let peer_task_hook = peer_task_queue.add_hook(64).await;
let blockstore_manager = Arc::new(RwLock::new(
BlockstoreManager::new(store, config.engine_blockstore_worker_count).await,
));
let score_ledger = DefaultScoreLedger::new(Box::new(|_peer, _score| {
}))
.await;
let target_message_size = config.target_message_size;
let task_worker_count = config.engine_task_worker_count;
let mut workers = Vec::with_capacity(task_worker_count);
let rt = tokio::runtime::Handle::current();
for i in 0..task_worker_count {
let outbox = outbox.0.clone();
let (closer_s, mut closer_r) = oneshot::channel();
let peer_task_queue = peer_task_queue.clone();
let mut ticker = tokio::time::interval(Duration::from_millis(100));
let work_signal = work_signal.clone();
let blockstore_manager = blockstore_manager.clone();
let peer_task_hook = peer_task_hook.clone();
let handle = rt.spawn(async move {
loop {
inc!(BitswapMetrics::EngineLoopTick);
tokio::select! {
biased;
_ = &mut closer_r => {
break;
}
event = peer_task_hook.recv() => {
debug!("peer queue event: {:?}", event);
}
_ = work_signal.notified() => {
}
_ = ticker.tick() => {
if let Some((peer, next_tasks, pending_bytes)) = peer_task_queue.pop_tasks(target_message_size).await {
if next_tasks.is_empty() {
continue;
}
debug!("engine:{} next envelope:tick tasks: {}", i, next_tasks.len());
let mut msg = BitswapMessage::new(false);
msg.set_pending_bytes(pending_bytes as _);
let mut block_cids = Vec::new();
let mut block_tasks = AHashMap::new();
for task in &next_tasks {
if task.data.have_block {
if task.data.is_want_block {
block_cids.push(task.topic);
block_tasks.insert(task.topic, task);
} else {
msg.add_have(task.topic);
}
} else {
msg.add_dont_have(task.topic);
}
}
let mut blocks = match blockstore_manager
.read()
.await
.get_blocks(&block_cids)
.await {
Ok(blocks) => blocks,
Err(err) => {
warn!("failed to load blocks: {:?}", err);
continue;
}
};
for (cid, task) in block_tasks {
if let Some(block) = blocks.remove(&cid) {
msg.add_block(block);
} else {
if task.data.send_dont_have {
msg.add_dont_have(cid);
}
}
}
if msg.is_empty() {
peer_task_queue.tasks_done(peer, &next_tasks).await;
continue;
}
let envelope = Ok(Envelope {
peer,
message: msg,
sent_tasks: next_tasks,
queue: peer_task_queue.clone(),
work_signal: work_signal.clone(),
});
if let Err(err) = outbox.send(envelope).await {
error!("failed to deliver envelope: {:?}", err);
}
}
}
}
}
});
workers.push((closer_s, handle));
}
Engine {
peer_task_queue,
outbox: outbox.1,
blockstore_manager,
ledger_map: Default::default(),
peer_ledger: Mutex::new(PeerLedger::default()),
score_ledger,
max_block_size_replace_has_with_block: config.max_replace_size,
send_dont_haves: config.send_dont_haves,
metrics_update_counter: Default::default(),
peer_block_request_filter: config.peer_block_request_filter,
workers,
work_signal,
}
}
async fn update_metrics(&self) {
let mut counter = self.metrics_update_counter.lock().await;
*counter += 1;
if *counter % 100 == 0 {
let stats = self.peer_task_queue.stats().await;
record!(BitswapMetrics::EnginePendingTasks, stats.num_pending as u64);
record!(BitswapMetrics::EngineActiveTasks, stats.num_active as u64);
}
}
pub fn outbox(&self) -> async_channel::Receiver<Result<Envelope>> {
self.outbox.clone()
}
pub async fn stop(mut self) -> Result<()> {
Arc::try_unwrap(self.blockstore_manager)
.map_err(|_| anyhow!("blockstore manager refs not shutdown"))?
.into_inner()
.stop()
.await?;
self.score_ledger.stop().await?;
while let Some((closer, handle)) = self.workers.pop() {
closer
.send(())
.map_err(|e| anyhow!("failed to send close {:?}", e))?;
handle.await.map_err(|e| anyhow!("{:?}", e))?;
}
Ok(())
}
pub async fn wantlist_for_peer(&self, peer: &PeerId) -> Vec<wantlist::Entry> {
let p = self.find_or_create(peer).await;
let mut partner = p.lock().await;
partner.wantlist_mut().entries().collect()
}
pub async fn ledger_for_peer(&self, peer: &PeerId) -> Option<Receipt> {
self.score_ledger.receipt(peer).await
}
pub async fn peers(&self) -> AHashSet<PeerId> {
self.ledger_map.read().await.keys().copied().collect()
}
pub async fn message_received(&self, peer: &PeerId, message: &BitswapMessage) {
if message.is_empty() {
info!("received empty message from {}", peer);
}
let mut new_work_exists = false;
let (wants, cancels, denials) = self.split_wants(peer, message.wantlist());
let mut want_ks = AHashSet::new();
for entry in &wants {
want_ks.insert(entry.cid);
}
let want_ks: Vec<_> = want_ks.into_iter().collect();
let block_sizes = match self
.blockstore_manager
.read()
.await
.get_block_sizes(&want_ks)
.await
{
Ok(s) => s,
Err(err) => {
warn!("failed to fetch block sizes: {:?}", err);
return;
}
};
{
let mut peer_ledger = self.peer_ledger.lock().await;
for want in &wants {
peer_ledger.wants(*peer, want.cid);
}
for canel in &cancels {
peer_ledger.cancel_want(peer, &canel.cid);
}
}
let l = self.find_or_create(peer).await;
let mut ledger = l.lock().await;
if message.full() {
ledger.clear_wantlist();
}
let mut active_entries = Vec::new();
for entry in &cancels {
if ledger.cancel_want(&entry.cid).is_some() {
self.peer_task_queue.remove(&entry.cid, *peer).await;
}
}
let send_dont_have = |entries: &mut Vec<_>, new_work_exists: &mut bool, entry: &Entry| {
if self.send_dont_haves && entry.send_dont_have {
let cid = entry.cid;
*new_work_exists = true;
let is_want_block = entry.want_type == WantType::Block;
entries.push(Task {
topic: cid,
priority: entry.priority as isize,
work: BlockPresence::encoded_len_for_cid(cid),
data: TaskData {
block_size: 0,
have_block: false,
is_want_block,
send_dont_have: entry.send_dont_have,
},
});
}
};
for entry in &denials {
send_dont_have(&mut active_entries, &mut new_work_exists, entry);
}
for entry in &wants {
let cid = entry.cid;
ledger.wants(cid, entry.priority, entry.want_type);
if let Some(block_size) = block_sizes.get(&cid) {
new_work_exists = true;
let is_want_block = self.send_as_block(entry.want_type, *block_size);
let entry_size = if is_want_block {
*block_size
} else {
BlockPresence::encoded_len_for_cid(cid)
};
active_entries.push(Task {
topic: cid,
priority: entry.priority as isize,
work: entry_size,
data: TaskData {
is_want_block,
send_dont_have: entry.send_dont_have,
block_size: *block_size,
have_block: true,
},
});
} else {
send_dont_have(&mut active_entries, &mut new_work_exists, entry);
}
}
if !active_entries.is_empty() {
self.peer_task_queue.push_tasks(*peer, active_entries).await;
self.update_metrics().await;
}
if new_work_exists {
self.signal_new_work();
}
}
pub async fn message_sent(&self, peer: &PeerId, message: &BitswapMessage) {
let l = self.find_or_create(peer).await;
let mut ledger = l.lock().await;
for block in message.blocks() {
self.score_ledger
.add_to_sent_bytes(ledger.partner(), block.data().len())
.await;
ledger
.wantlist_mut()
.remove_type(block.cid(), WantType::Block);
}
for bp in message.block_presences() {
if bp.typ == BlockPresenceType::Have {
ledger.wantlist_mut().remove_type(&bp.cid, WantType::Have);
}
}
}
fn split_wants<'a>(
&self,
peer: &PeerId,
entries: impl Iterator<Item = &'a Entry>,
) -> (Vec<&'a Entry>, Vec<&'a Entry>, Vec<&'a Entry>) {
let mut wants = Vec::new();
let mut cancels = Vec::new();
let mut denials = Vec::new();
for entry in entries {
if entry.cancel {
cancels.push(entry);
} else if let Some(ref filter) = self.peer_block_request_filter {
if (filter)(peer, &entry.cid) {
wants.push(entry);
} else {
denials.push(entry);
}
} else {
wants.push(entry);
}
}
(wants, cancels, denials)
}
pub async fn received_blocks(&self, from: PeerId, blocks: Vec<Block>) {
if blocks.is_empty() {
return;
}
let l = self.find_or_create(&from).await;
let ledger = l.lock().await;
for block in blocks {
self.score_ledger
.add_to_recv_bytes(ledger.partner(), block.data().len())
.await;
}
}
pub async fn notify_new_blocks(&self, blocks: &[Block]) {
if blocks.is_empty() {
return;
}
let block_sizes: AHashMap<_, _> = blocks
.iter()
.map(|block| (block.cid(), block.data().len()))
.collect();
let mut work = false;
let mut missing_wants: AHashMap<PeerId, Vec<Cid>> = AHashMap::new();
for block in blocks {
let cid = block.cid();
let peer_ledger = self.peer_ledger.lock().await;
let peers = peer_ledger.peers(cid);
if peers.is_none() {
continue;
}
for peer in peers.unwrap() {
let l = self.ledger_map.read().await.get(peer).cloned();
if l.is_none() {
missing_wants.entry(*peer).or_default().push(*cid);
continue;
}
let l = l.unwrap();
let ledger = l.lock().await;
let entry = ledger.wantlist_get(cid);
if entry.is_none() {
missing_wants.entry(*peer).or_default().push(*cid);
continue;
}
let entry = entry.unwrap();
work = true;
let block_size = block_sizes.get(cid).copied().unwrap_or_default();
let is_want_block = self.send_as_block(entry.want_type, block_size);
let entry_size = if is_want_block {
block_size
} else {
BlockPresence::encoded_len_for_cid(*cid)
};
self.peer_task_queue
.push_task(
*peer,
Task {
topic: entry.cid,
priority: entry.priority as isize,
work: entry_size,
data: TaskData {
block_size,
have_block: true,
is_want_block,
send_dont_have: false,
},
},
)
.await;
self.update_metrics().await;
}
}
if !missing_wants.is_empty() {
let ledger_map = self.ledger_map.read().await;
let mut peer_ledger = self.peer_ledger.lock().await;
for (peer, wants) in missing_wants.into_iter() {
if let Some(l) = ledger_map.get(&peer) {
let ledger = l.lock().await;
for cid in wants {
if ledger.wantlist_get(&cid).is_some() {
continue;
}
peer_ledger.cancel_want(&peer, &cid);
}
} else {
for cid in wants {
peer_ledger.cancel_want(&peer, &cid);
}
}
}
}
if work {
self.signal_new_work();
}
}
pub async fn peer_connected(&self, peer: &PeerId) {
let mut ledger_map = self.ledger_map.write().await;
let _ = ledger_map
.entry(*peer)
.or_insert_with(|| Arc::new(Mutex::new(Ledger::new(*peer))));
self.score_ledger.peer_connected(peer).await;
}
pub async fn peer_disconnected(&self, peer: &PeerId) {
let mut ledger_map = self.ledger_map.write().await;
if let Some(e) = ledger_map.remove(peer) {
let mut entry = e.lock().await;
let mut peer_ledger = self.peer_ledger.lock().await;
for want in entry.entries() {
peer_ledger.cancel_want(peer, &want.cid);
}
}
self.score_ledger.peer_disconnected(peer).await;
}
fn signal_new_work(&self) {
debug!("signal_new_work");
self.work_signal.notify_one();
}
fn send_as_block(&self, want_type: WantType, block_size: usize) -> bool {
let is_want_block = want_type == WantType::Block;
is_want_block || block_size <= self.max_block_size_replace_has_with_block
}
async fn find_or_create(&self, peer: &PeerId) -> Arc<Mutex<Ledger>> {
self.ledger_map
.write()
.await
.entry(*peer)
.or_insert_with(|| Arc::new(Mutex::new(Ledger::new(*peer))))
.clone()
}
}
#[derive(Debug)]
pub struct Envelope {
pub peer: PeerId,
pub message: BitswapMessage,
pub sent_tasks: Vec<Task<Cid, TaskData>>,
pub queue: PeerTaskQueue<Cid, TaskData, TaskMerger>,
pub work_signal: Arc<Notify>,
}