croaring 2.7.0

Rust wrapper for CRoaring
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

use super::{AlignedLayout, layout};
use allocator_api2::alloc::Allocator;
use core::cell::UnsafeCell;
use core::mem::MaybeUninit;
use core::ptr::NonNull;

unsafe extern "C" fn malloc(size: usize) -> *mut core::ffi::c_void {
    unsafe {
        let Some(layout) = layout(size) else {
            return core::ptr::null_mut();
        };
        let allocator = ALLOCATOR.get();
        let Ok(ptr) = allocator.allocate(layout) else {
            return core::ptr::null_mut();
        };
        let size_ptr = ptr.cast::<usize>();
        size_ptr.write(size);
        size_ptr.add(1).cast().as_ptr()
    }
}

unsafe extern "C" fn calloc(nmemb: usize, size: usize) -> *mut core::ffi::c_void {
    unsafe {
        let Some(total_size) = nmemb.checked_mul(size) else {
            return core::ptr::null_mut();
        };
        let Some(layout) = layout(total_size) else {
            return core::ptr::null_mut();
        };
        let allocator = ALLOCATOR.get();
        let Ok(ptr) = allocator.allocate_zeroed(layout) else {
            return core::ptr::null_mut();
        };
        let size_ptr = ptr.cast::<usize>();
        size_ptr.write(total_size);
        size_ptr.add(1).cast().as_ptr()
    }
}

unsafe extern "C" fn realloc(ptr: *mut core::ffi::c_void, size: usize) -> *mut core::ffi::c_void {
    unsafe {
        let Some(ptr) = NonNull::new(ptr) else {
            return malloc(size);
        };
        let ptr = ptr.cast::<u8>();
        let size_ptr = ptr.cast::<usize>().sub(1);
        let old_size = size_ptr.read();
        let old_layout = layout(old_size).unwrap();
        let allocator = ALLOCATOR.get();
        if size == 0 {
            allocator.deallocate(ptr, old_layout);
            return core::ptr::null_mut();
        }
        let Some(new_layout) = layout(size) else {
            return core::ptr::null_mut();
        };
        let Ok(new_ptr) = allocator.grow(ptr, old_layout, new_layout) else {
            return core::ptr::null_mut();
        };
        let new_size_ptr = new_ptr.cast::<usize>();
        new_size_ptr.write(size);
        new_size_ptr.add(1).cast().as_ptr()
    }
}

unsafe extern "C" fn free(ptr: *mut core::ffi::c_void) {
    unsafe {
        let Some(ptr) = NonNull::new(ptr) else {
            return;
        };
        let size_ptr = ptr.cast::<usize>().sub(1);
        let size = size_ptr.read();
        // If the size would overflow, it would have failed to be allocated in the first place.
        let layout = layout(size).unwrap();
        let allocator = ALLOCATOR.get();
        allocator.deallocate(size_ptr.cast(), layout);
    }
}

unsafe extern "C" fn aligned_malloc(align: usize, size: usize) -> *mut core::ffi::c_void {
    unsafe {
        let Some(layout) = AlignedLayout::new(size, align) else {
            return core::ptr::null_mut();
        };
        let allocator = ALLOCATOR.get();
        let Ok(allocated_ptr) = allocator.allocate(layout.0) else {
            return core::ptr::null_mut();
        };
        layout
            .store_and_return(allocated_ptr.cast().as_ptr())
            .cast()
    }
}

unsafe extern "C" fn aligned_free(ptr: *mut core::ffi::c_void) {
    unsafe {
        let Some(ptr) = NonNull::new(ptr) else {
            return;
        };
        let (allocated_ptr, layout) = AlignedLayout::from_raw(ptr.cast().as_ptr());
        let allocated_ptr = NonNull::new_unchecked(allocated_ptr);
        let allocator = ALLOCATOR.get();
        allocator.deallocate(allocated_ptr.cast(), layout.0);
    }
}

const MEMORY_HOOKS: ffi::roaring_memory_t = ffi::roaring_memory_t {
    malloc: Some(malloc),
    realloc: Some(realloc),
    calloc: Some(calloc),
    free: Some(free),
    aligned_malloc: Some(aligned_malloc),
    aligned_free: Some(aligned_free),
};

struct AllocatorSlot(UnsafeCell<MaybeUninit<&'static dyn Allocator>>);

impl AllocatorSlot {
    pub const fn new() -> Self {
        Self(UnsafeCell::new(MaybeUninit::uninit()))
    }

    pub unsafe fn get(&self) -> &'static dyn Allocator {
        unsafe { (*self.0.get()).assume_init() }
    }

    pub unsafe fn set(&self, allocator: &'static dyn Allocator) {
        unsafe {
            (*self.0.get()).write(allocator);
        }
    }
}

// All access to the inner value is unsafe, so we implement Sync unsafely
unsafe impl Sync for AllocatorSlot {}

static ALLOCATOR: AllocatorSlot = AllocatorSlot::new();

/// Install custom memory allocation hooks for `CRoaring` which will use the passed allocator.
///
/// # Safety
///
/// The caller must ensure there are not any objects allocated by `CRoaring` at the time this
/// function is called.
///
/// Ideally, this function should be called early in the program's execution, before any other
/// `CRoaring` functions are called.
pub unsafe fn configure_custom_alloc(allocator: &'static dyn Allocator) {
    unsafe {
        ALLOCATOR.set(allocator);
        ffi::roaring_init_memory_hook(MEMORY_HOOKS);
    }
}