      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

    // Data structures for storing garbage to be freed later (once the
    // epochs have sufficiently advanced).
    //
    // In general, we try to manage the garbage thread locally whenever
    // possible. Each thread keep track of three bags of garbage. But if a
    // thread is exiting, these bags must be moved into the global garbage
    // bags.

    use std::ptr;
    use std::mem;
    use std::sync::atomic::AtomicPtr;
    use std::sync::atomic::Ordering::{Relaxed, Release, Acquire};

    use ZerosValid;

    /// One item of garbage.
    ///
    /// Stores enough information to do a deallocation.
    #[derive(Debug)]
    struct Item {
        ptr: *mut u8,
        free: unsafe fn(*mut u8),
    }

    /// A single, thread-local bag of garbage.
    #[derive(Debug)]
    pub struct Bag(Vec<Item>);

    impl Bag {
        fn new() -> Bag {
            Bag(vec![])
        }

        fn insert<T>(&mut self, elem: *mut T) {
            let size = mem::size_of::<T>();
            if size > 0 {
                self.0.push(Item {
                    ptr: elem as *mut u8,
                    free: free::<T>,
                })
            }
            unsafe fn free<T>(t: *mut u8) {
                drop(Vec::from_raw_parts(t as *mut T, 0, 1));
            }
        }

        fn len(&self) -> usize {
            self.0.len()
        }

        /// Deallocate all garbage in the bag
        pub unsafe fn collect(&mut self) {
            let mut data = mem::replace(&mut self.0, Vec::new());
            for item in data.iter() {
                (item.free)(item.ptr);
            }
            data.truncate(0);
            self.0 = data;
        }
    }

    // needed because the bags store raw pointers.
    unsafe impl Send for Bag {}
    unsafe impl Sync for Bag {}

    /// A thread-local set of garbage bags.
    #[derive(Debug)]
    pub struct Local {
        /// Garbage added at least one epoch behind the current local epoch
        pub old: Bag,
        /// Garbage added in the current local epoch or earlier
        pub cur: Bag,
        /// Garbage added in the current *global* epoch
        pub new: Bag,
    }

    impl Local {
        pub fn new() -> Local {
            Local {
                old: Bag::new(),
                cur: Bag::new(),
                new: Bag::new(),
            }
        }

        pub fn insert<T>(&mut self, elem: *mut T) {
            self.new.insert(elem)
        }

        /// Collect one epoch of garbage, rotating the local garbage bags.
        pub unsafe fn collect(&mut self) {
            let ret = self.old.collect();
            mem::swap(&mut self.old, &mut self.cur);
            mem::swap(&mut self.cur, &mut self.new);
            ret
        }

        pub fn size(&self) -> usize {
            self.old.len() + self.cur.len() + self.new.len()
        }
    }

    /// A concurrent garbage bag, currently based on Treiber's stack.
    ///
    /// The elements are themselves owned `Bag`s.
    #[derive(Debug)]
    pub struct ConcBag {
        head: AtomicPtr<Node>,
    }

    unsafe impl ZerosValid for ConcBag {}

    #[derive(Debug)]
    struct Node {
        data: Bag,
        next: AtomicPtr<Node>,
    }

    impl ConcBag {
        pub fn insert(&self, t: Bag){
            let n = Box::into_raw(Box::new(
                Node { data: t, next: AtomicPtr::new(ptr::null_mut()) }));
            loop {
                let head = self.head.load(Acquire);
                unsafe { (*n).next.store(head, Relaxed) };
                if self.head.compare_and_swap(head, n, Release) == head { break }
            }
        }

        pub unsafe fn collect(&self) {
            // check to avoid xchg instruction
            // when no garbage exists
            let mut head = self.head.load(Relaxed);
            if head != ptr::null_mut() {
                head = self.head.swap(ptr::null_mut(), Acquire);

                while head != ptr::null_mut() {
                    let mut n = Box::from_raw(head);
                    n.data.collect();
                    head = n.next.load(Relaxed);
                }
            }
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)