xstm 0.1.0

A Rust-implemented Software Transactional Memory (STM) library using TL2 (Transactional Locking II) algorithm
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

use super::any_var::AnyTVar;
use crate::TVar;

#[cfg(feature = "small_alloc")]
use smallvec::SmallVec;

pub struct ReadSet<'var> {
    #[cfg(not(feature = "small_alloc"))]
    entries: Vec<Entry<'var>>,
    
    #[cfg(feature = "small_alloc")]
    entries: SmallVec<[Entry<'var>; 16]>,
}

pub type Entry<'var> = super::any_var::AnyTVar<'var>;

impl<'var> ReadSet<'var> {
    pub fn new() -> Self {
        ReadSet {
            #[cfg(not(feature = "small_alloc"))]
            entries: Vec::with_capacity(16),

            #[cfg(feature = "small_alloc")]
            entries: SmallVec::new()
        }
    }

    pub fn iter_vars(&self) -> impl Iterator<Item = Entry<'var>> + '_ {
        self.entries.iter().copied()
    }

    fn get_entry<T: Copy, Var: Into<AnyTVar<'var>>>(&self, var: Var) -> Option<Entry<'var>> {
        let var = var.into();
        self.entries
            .iter()
            .find(|entry| *entry == &var)
            .map(|entry| *entry)
    }

    /// Log an read entry
    pub fn log<T: Copy>(&mut self, var: &'var TVar<T>) {
        if let None = self.get_entry::<T, _>(var) {
            // create entry
            self.entries.push(Entry {
                ptr: var.value_ptr() as *const _,
                lock: var.get_lock(),
            });
        }
    }

    pub fn clear(&mut self) {
        self.entries.clear();
    }
}