solana 0.17.2

Blockchain, Rebuilt for Scale
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

use rand::{thread_rng, Rng};
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::{Arc, Mutex};

#[derive(Debug, Default)]
struct RecyclerStats {
    total: AtomicUsize,
    reuse: AtomicUsize,
    max_gc: AtomicUsize,
}

#[derive(Debug)]
pub struct Recycler<T> {
    gc: Arc<Mutex<Vec<T>>>,
    stats: Arc<RecyclerStats>,
    id: usize,
}

impl<T: Default> Default for Recycler<T> {
    fn default() -> Recycler<T> {
        let id = thread_rng().gen_range(0, 1000);
        trace!("new recycler..{}", id);
        Recycler {
            gc: Arc::new(Mutex::new(vec![])),
            stats: Arc::new(RecyclerStats::default()),
            id,
        }
    }
}

impl<T: Default> Clone for Recycler<T> {
    fn clone(&self) -> Recycler<T> {
        Recycler {
            gc: self.gc.clone(),
            stats: self.stats.clone(),
            id: self.id,
        }
    }
}

pub trait Reset {
    fn reset(&mut self);
}

impl<T: Default + Reset> Recycler<T> {
    pub fn allocate(&self, name: &'static str) -> T {
        let new = self
            .gc
            .lock()
            .expect("recycler lock in pb fn allocate")
            .pop();

        if let Some(mut x) = new {
            self.stats.reuse.fetch_add(1, Ordering::Relaxed);
            x.reset();
            return x;
        }

        trace!(
            "allocating new: total {} {:?} id: {} reuse: {} max_gc: {}",
            self.stats.total.fetch_add(1, Ordering::Relaxed),
            name,
            self.id,
            self.stats.reuse.load(Ordering::Relaxed),
            self.stats.max_gc.load(Ordering::Relaxed),
        );

        T::default()
    }

    pub fn recycle(&self, x: T) {
        let len = {
            let mut gc = self.gc.lock().expect("recycler lock in pub fn recycle");
            gc.push(x);
            gc.len()
        };

        let max_gc = self.stats.max_gc.load(Ordering::Relaxed);
        if len > max_gc {
            // this is not completely accurate, but for most cases should be fine.
            self.stats
                .max_gc
                .compare_and_swap(max_gc, len, Ordering::Relaxed);
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    impl Reset for u64 {
        fn reset(&mut self) {
            *self = 10;
        }
    }

    #[test]
    fn test_recycler() {
        let recycler = Recycler::default();
        let mut y: u64 = recycler.allocate("test_recycler1");
        assert_eq!(y, 0);
        y = 20;
        let recycler2 = recycler.clone();
        recycler2.recycle(y);
        assert_eq!(recycler.gc.lock().unwrap().len(), 1);
        let z = recycler.allocate("test_recycler2");
        assert_eq!(z, 10);
        assert_eq!(recycler.gc.lock().unwrap().len(), 0);
    }
}