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 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
use core::{
mem::{self, ManuallyDrop},
ops::{Deref, DerefMut},
};
use std::sync::{Mutex, PoisonError};
use allocator_api2::alloc::AllocError;
use crate::{BaseAllocator, Bump, BumpScope, MinimumAlignment, SupportedMinimumAlignment};
macro_rules! bump_pool_declaration {
($($allocator_parameter:tt)*) => {
/// A pool of bump allocators.
///
/// This type allows bump allocations in parallel, with the allocations' lifetimes tied to the pool.
///
/// # Examples
///
/// Using `BumpPool` with parallel iterators from [`rayon`](https://docs.rs/rayon):
/// ```
/// # #![cfg_attr(feature = "nightly-allocator-api", feature(allocator_api))]
/// # use bump_scope::BumpPool;
/// # use rayon::prelude::{ ParallelIterator, IntoParallelIterator };
/// # if cfg!(miri) { return } // rayon violates strict-provenance :(
/// #
/// let mut pool: BumpPool = BumpPool::new();
///
/// let ints: Vec<&mut usize> = (0..1000)
/// .into_par_iter()
/// .map_init(|| pool.get(), |bump, i| {
/// // do some expensive work
/// bump.alloc(i).into_mut()
/// })
/// .collect();
///
/// dbg!(&ints);
///
/// pool.reset();
///
/// // memory of the int references is freed, trying to access ints will result in a lifetime error
/// // dbg!(&ints);
/// ```
///
/// Using `BumpPool` with [`std::thread::scope`]:
/// ```
/// # #![cfg_attr(feature = "nightly-allocator-api", feature(allocator_api))]
/// # use bump_scope::BumpPool;
/// let pool: BumpPool = BumpPool::new();
/// let (sender, receiver) = std::sync::mpsc::sync_channel(10);
///
/// std::thread::scope(|s| {
/// s.spawn(|| {
/// let bump = pool.get();
/// let string = bump.alloc_str("Hello");
/// sender.send(string).unwrap();
/// drop(sender);
/// });
///
/// s.spawn(|| {
/// for string in receiver {
/// assert_eq!(string, "Hello");
/// }
/// });
/// });
/// ```
///
#[doc(alias = "Herd")]
#[derive(Debug)]
pub struct BumpPool<
$($allocator_parameter)*,
const MIN_ALIGN: usize = 1,
const UP: bool = true,
> where
A: BaseAllocator,
MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
{
bumps: Mutex<Vec<Bump<A, MIN_ALIGN, UP>>>,
allocator: A,
}
};
}
crate::maybe_default_allocator!(bump_pool_declaration);
impl<A, const MIN_ALIGN: usize, const UP: bool> Default for BumpPool<A, MIN_ALIGN, UP>
where
A: BaseAllocator + Default,
MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
{
fn default() -> Self {
Self {
bumps: Mutex::default(),
allocator: Default::default(),
}
}
}
impl<A, const MIN_ALIGN: usize, const UP: bool> BumpPool<A, MIN_ALIGN, UP>
where
MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
A: BaseAllocator + Default,
{
/// Constructs a new `BumpPool`.
#[inline]
#[must_use]
pub fn new() -> Self {
Self::default()
}
}
impl<A, const MIN_ALIGN: usize, const UP: bool> BumpPool<A, MIN_ALIGN, UP>
where
A: BaseAllocator,
MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
{
/// Constructs a new `BumpPool` with the provided allocator.
#[inline]
#[must_use]
pub const fn new_in(allocator: A) -> Self {
Self {
bumps: Mutex::new(Vec::new()),
allocator,
}
}
/// [Resets](Bump::reset) all `Bump`s in this pool.
pub fn reset(&mut self) {
for bump in self.bumps().iter_mut() {
bump.reset();
}
}
/// Returns the vector of `Bump`s.
pub fn bumps(&mut self) -> &mut Vec<Bump<A, MIN_ALIGN, UP>> {
self.bumps.get_mut().unwrap_or_else(PoisonError::into_inner)
}
/// Borrows a bump allocator from the pool.
/// With this `BumpPoolGuard` you can make allocations that live for as long as the pool lives.
///
/// # Panics
/// Panics if the allocation fails.
#[must_use]
#[cfg(not(no_global_oom_handling))]
pub fn get(&self) -> BumpPoolGuard<A, MIN_ALIGN, UP> {
let bump = self.bumps.lock().unwrap_or_else(PoisonError::into_inner).pop();
let bump = bump.unwrap_or_else(|| Bump::new_in(self.allocator.clone()));
BumpPoolGuard {
pool: self,
bump: ManuallyDrop::new(bump),
}
}
/// Borrows a bump allocator from the pool.
/// With this `BumpPoolGuard` you can make allocations that live for as long as the pool lives.
///
/// # Errors
/// Errors if the allocation fails.
pub fn try_get(&self) -> Result<BumpPoolGuard<A, MIN_ALIGN, UP>, AllocError> {
let bump = self.bumps.lock().unwrap_or_else(PoisonError::into_inner).pop();
let bump = match bump {
Some(bump) => bump,
None => Bump::try_new_in(self.allocator.clone())?,
};
Ok(BumpPoolGuard {
pool: self,
bump: ManuallyDrop::new(bump),
})
}
}
/// This is a wrapper around [`Bump`] that mutably derefs to a [`BumpScope`] and returns its [`Bump`] back to the [`BumpPool`] on drop.
#[derive(Debug)]
pub struct BumpPoolGuard<'a, A, const MIN_ALIGN: usize, const UP: bool>
where
A: BaseAllocator,
MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
{
bump: ManuallyDrop<Bump<A, MIN_ALIGN, UP>>,
pool: &'a BumpPool<A, MIN_ALIGN, UP>,
}
impl<'a, A, const MIN_ALIGN: usize, const UP: bool> Deref for BumpPoolGuard<'a, A, MIN_ALIGN, UP>
where
A: BaseAllocator,
MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
{
type Target = BumpScope<'a, A, MIN_ALIGN, UP>;
#[inline(always)]
fn deref(&self) -> &Self::Target {
unsafe { transmute_lifetime(self.bump.as_scope()) }
}
}
impl<'a, A, const MIN_ALIGN: usize, const UP: bool> DerefMut for BumpPoolGuard<'a, A, MIN_ALIGN, UP>
where
A: BaseAllocator,
MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
{
#[inline(always)]
fn deref_mut(&mut self) -> &mut Self::Target {
unsafe { transmute_lifetime_mut(self.bump.as_mut_scope()) }
}
}
impl<'a, A, const MIN_ALIGN: usize, const UP: bool> Drop for BumpPoolGuard<'a, A, MIN_ALIGN, UP>
where
A: BaseAllocator,
MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
{
fn drop(&mut self) {
let mut bumps = self.pool.bumps.lock().unwrap();
let bump = unsafe { ManuallyDrop::take(&mut self.bump) };
bumps.push(bump);
}
}
// This exists as a "safer" transmute that only transmutes the `'a` lifetime parameter.
#[allow(clippy::needless_lifetimes)]
unsafe fn transmute_lifetime<'from, 'to, 'b, A, const MIN_ALIGN: usize, const UP: bool>(
scope: &'b BumpScope<'from, A, MIN_ALIGN, UP>,
) -> &'b BumpScope<'to, A, MIN_ALIGN, UP> {
mem::transmute(scope)
}
// This exists as a "safer" transmute that only transmutes the `'a` lifetime parameter.
#[allow(clippy::needless_lifetimes)]
unsafe fn transmute_lifetime_mut<'from, 'to, 'b, A, const MIN_ALIGN: usize, const UP: bool>(
scope: &'b mut BumpScope<'from, A, MIN_ALIGN, UP>,
) -> &'b mut BumpScope<'to, A, MIN_ALIGN, UP> {
mem::transmute(scope)
}