rbit 0.2.2

A BitTorrent library implementing BEP specifications
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

use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Arc;

use tokio::sync::Notify;

#[allow(dead_code)]
pub const DEFAULT_CACHE_MEMORY: usize = 256 * 1024 * 1024;
pub const MAX_CACHE_MEMORY: usize = 1024 * 1024 * 1024;
pub const BLOCK_CACHE_RATIO: f32 = 0.6;
pub const PIECE_CACHE_RATIO: f32 = 0.3;

pub struct MemoryBudget {
    total_limit: usize,
    current_usage: AtomicUsize,
    block_cache_limit: usize,
    piece_cache_limit: usize,
    pressure_notify: Notify,
}

impl MemoryBudget {
    pub fn new(total_limit: usize) -> Arc<Self> {
        let limit = total_limit.min(MAX_CACHE_MEMORY);
        Arc::new(Self {
            total_limit: limit,
            current_usage: AtomicUsize::new(0),
            block_cache_limit: (limit as f32 * BLOCK_CACHE_RATIO) as usize,
            piece_cache_limit: (limit as f32 * PIECE_CACHE_RATIO) as usize,
            pressure_notify: Notify::new(),
        })
    }

    pub fn try_allocate(self: &Arc<Self>, bytes: usize) -> Option<MemoryPermit> {
        let mut current = self.current_usage.load(Ordering::Relaxed);
        loop {
            if current + bytes > self.total_limit {
                return None;
            }
            match self.current_usage.compare_exchange_weak(
                current,
                current + bytes,
                Ordering::SeqCst,
                Ordering::Relaxed,
            ) {
                Ok(_) => {
                    return Some(MemoryPermit {
                        budget: Arc::clone(self),
                        bytes,
                    })
                }
                Err(actual) => current = actual,
            }
        }
    }

    pub async fn allocate(self: &Arc<Self>, bytes: usize) -> MemoryPermit {
        loop {
            if let Some(permit) = self.try_allocate(bytes) {
                return permit;
            }
            self.pressure_notify.notify_waiters();
            tokio::task::yield_now().await;
        }
    }

    pub fn release(&self, bytes: usize) {
        self.current_usage.fetch_sub(bytes, Ordering::SeqCst);
    }

    pub fn current_usage(&self) -> usize {
        self.current_usage.load(Ordering::Relaxed)
    }

    pub fn total_limit(&self) -> usize {
        self.total_limit
    }

    pub fn block_cache_limit(&self) -> usize {
        self.block_cache_limit
    }

    pub fn piece_cache_limit(&self) -> usize {
        self.piece_cache_limit
    }

    pub fn is_under_pressure(&self) -> bool {
        let usage = self.current_usage.load(Ordering::Relaxed);
        usage > (self.total_limit as f32 * 0.9) as usize
    }

    pub async fn wait_for_pressure(&self) {
        self.pressure_notify.notified().await;
    }
}

pub struct MemoryPermit {
    budget: Arc<MemoryBudget>,
    bytes: usize,
}

impl MemoryPermit {
    pub fn bytes(&self) -> usize {
        self.bytes
    }

    pub fn resize(&mut self, new_bytes: usize) {
        if new_bytes > self.bytes {
            let diff = new_bytes - self.bytes;
            self.budget.current_usage.fetch_add(diff, Ordering::SeqCst);
        } else {
            let diff = self.bytes - new_bytes;
            self.budget.current_usage.fetch_sub(diff, Ordering::SeqCst);
        }
        self.bytes = new_bytes;
    }
}

impl Drop for MemoryPermit {
    fn drop(&mut self) {
        self.budget.release(self.bytes);
    }
}