sdd 4.8.3

Scalable lock-free delayed memory reclaimer
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

use std::alloc::{Layout, dealloc};
use std::mem::{ManuallyDrop, offset_of};
use std::ptr;
use std::sync::atomic::AtomicPtr;
use std::sync::atomic::Ordering;

/// [`Link`] defines basic linked list operations.
pub(super) struct Link {
    /// Next [`Link`] pointer or reference counter.
    next_or_ref: AtomicPtr<()>,
    /// Function to drop and deallocate the owner.
    dealloc_fn: fn(*mut Link),
}

/// [`DeferredClosure`] invokes the supplied closure at its drop method.
pub(super) struct DeferredClosure<F: 'static + FnOnce()> {
    /// Function to invoke at `fn drop`.
    f: ManuallyDrop<F>,
    /// Enables it to be enqueued in a garbage queue.
    link: Link,
}

impl Link {
    /// Creates a new shared [`Link`].
    #[inline]
    pub(super) const fn new_shared(dealloc_fn: fn(*mut Link)) -> Self {
        Link {
            next_or_ref: AtomicPtr::new(ptr::without_provenance_mut(1)),
            dealloc_fn,
        }
    }

    /// Creates a new unique [`Link`].
    #[inline]
    pub(super) const fn new_unique(dealloc_fn: fn(*mut Link)) -> Self {
        Link {
            next_or_ref: AtomicPtr::new(ptr::without_provenance_mut(0)),
            dealloc_fn,
        }
    }

    /// Returns a reference to the reference counter.
    #[inline]
    pub(super) const fn ref_cnt(&self) -> &AtomicPtr<()> {
        &self.next_or_ref
    }

    /// Returns the drop function.
    #[inline]
    pub(super) const fn dealloc_fn(&self) -> fn(*mut Link) {
        self.dealloc_fn
    }

    /// Returns the next pointer.
    #[inline]
    pub(super) fn next_ptr(&self, mo: Ordering) -> *mut Link {
        self.next_or_ref.load(mo).cast::<Link>()
    }

    /// Sets the next pointer.
    #[inline]
    pub(super) fn set_next_ptr(&self, next_ptr: *mut Link, mo: Ordering) {
        self.next_or_ref.store(next_ptr.cast::<()>(), mo);
    }

    /// Casts the pointer to a different type.
    #[inline]
    pub(super) fn cast<T>(ptr: *mut Link, offset: usize) -> *mut T {
        #[allow(clippy::cast_ptr_alignment)]
        ptr.map_addr(|addr| addr - offset).cast::<T>()
    }
}

impl<F: 'static + FnOnce()> DeferredClosure<F> {
    /// Allocates a new [`DeferredClosure`].
    #[inline]
    pub fn alloc(f: F) -> *mut Link {
        unsafe {
            let ptr = std::alloc::alloc(Layout::new::<Self>()).cast::<Self>();
            ptr.write(DeferredClosure {
                f: ManuallyDrop::new(f),
                link: Link::new_unique(|ptr: *mut Link| {
                    let this_ptr = ptr
                        .map_addr(|addr| addr - offset_of!(Self, link))
                        .cast::<Self>();
                    this_ptr.drop_in_place();
                    dealloc(this_ptr.cast::<u8>(), Layout::new::<Self>());
                }),
            });
            ptr.map_addr(|addr| addr + offset_of!(Self, link))
                .cast::<Link>()
        }
    }
}

impl<F: 'static + FnOnce()> Drop for DeferredClosure<F> {
    #[inline]
    fn drop(&mut self) {
        unsafe {
            ManuallyDrop::take(&mut self.f)();
        }
    }
}