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 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
use core::{
alloc::Layout,
cell::Cell,
fmt::{self, Debug},
mem::{self, ManuallyDrop},
panic::{RefUnwindSafe, UnwindSafe},
ptr::NonNull,
};
use allocator_api2::alloc::AllocError;
use crate::{
bump_common_methods, bump_scope_methods,
chunk_size::ChunkSize,
doc_align_cant_decrease, error_behavior_generic_methods_allocation_failure,
polyfill::{cfg_const, pointer},
unallocated_chunk_header, BaseAllocator, BumpScope, BumpScopeGuardRoot, Checkpoint, ErrorBehavior,
GuaranteedAllocatedStats, MinimumAlignment, RawChunk, Stats, SupportedMinimumAlignment, WithoutDealloc, WithoutShrink,
DEFAULT_START_CHUNK_SIZE,
};
#[cfg(not(no_global_oom_handling))]
use crate::infallible;
#[cfg(test)]
use crate::WithDrop;
macro_rules! bump_declaration {
($($allocator_parameter:tt)*) => {
/// A bump allocator.
///
/// Most of `Bump`'s constructors allocate memory.
/// The exception is [`Bump::unallocated`]. A bump allocator created by this function has its [`GUARANTEED_ALLOCATED` parameter set to `false`](crate#guaranteed_allocated-parameter).
/// Such a `Bump` is unable to create a scope with `scoped` or `scope_guard`.
/// It can be converted into a guaranteed allocated `Bump` with [`into_guaranteed_allocated`](Bump::into_guaranteed_allocated) or [`as_guaranteed_allocated_mut`](Bump::as_guaranteed_allocated_mut).
///
/// # Gotchas
///
/// Allocating directly on a `Bump` is not compatible with entering bump scopes at the same time:
///
/// ```compile_fail,E0502
/// # use bump_scope::Bump;
/// let mut bump: Bump = Bump::new();
///
/// let one = bump.alloc(1);
///
/// bump.scoped(|bump| {
/// // whatever
/// });
/// ```
/// Instead convert it to a [`BumpScope`] first:
/// ```
/// # use bump_scope::Bump;
/// let mut bump: Bump = Bump::new();
/// let bump = bump.as_mut_scope();
///
/// let one = bump.alloc(1);
///
/// bump.scoped(|bump| {
/// // whatever
/// });
/// ```
#[repr(transparent)]
pub struct Bump<
$($allocator_parameter)*,
const MIN_ALIGN: usize = 1,
const UP: bool = true,
const GUARANTEED_ALLOCATED: bool = true,
> where
MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
A: BaseAllocator<GUARANTEED_ALLOCATED>,
{
pub(crate) chunk: Cell<RawChunk<UP, A>>,
}
};
}
crate::maybe_default_allocator!(bump_declaration);
// Sending Bumps when nothing is allocated is fine.
// When something is allocated Bump is borrowed and sending is not possible.
unsafe impl<A, const MIN_ALIGN: usize, const UP: bool, const GUARANTEED_ALLOCATED: bool> Send
for Bump<A, MIN_ALIGN, UP, GUARANTEED_ALLOCATED>
where
MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
A: BaseAllocator<GUARANTEED_ALLOCATED>,
{
}
impl<const MIN_ALIGN: usize, const UP: bool, const GUARANTEED_ALLOCATED: bool, A> UnwindSafe
for Bump<A, MIN_ALIGN, UP, GUARANTEED_ALLOCATED>
where
MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
A: BaseAllocator<GUARANTEED_ALLOCATED> + UnwindSafe,
{
}
impl<const MIN_ALIGN: usize, const UP: bool, const GUARANTEED_ALLOCATED: bool, A> RefUnwindSafe
for Bump<A, MIN_ALIGN, UP, GUARANTEED_ALLOCATED>
where
MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
A: BaseAllocator<GUARANTEED_ALLOCATED> + UnwindSafe,
{
}
impl<A, const MIN_ALIGN: usize, const UP: bool, const GUARANTEED_ALLOCATED: bool> Drop
for Bump<A, MIN_ALIGN, UP, GUARANTEED_ALLOCATED>
where
MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
A: BaseAllocator<GUARANTEED_ALLOCATED>,
{
fn drop(&mut self) {
if self.is_unallocated() {
return;
}
unsafe {
let chunk = self.chunk.get();
chunk.for_each_prev(|chunk| chunk.deallocate());
chunk.for_each_next(|chunk| chunk.deallocate());
chunk.deallocate();
}
}
}
impl<A, const MIN_ALIGN: usize, const UP: bool, const GUARANTEED_ALLOCATED: bool> Debug
for Bump<A, MIN_ALIGN, UP, GUARANTEED_ALLOCATED>
where
MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
A: BaseAllocator<GUARANTEED_ALLOCATED>,
{
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
self.stats().debug_format("Bump", f)
}
}
#[cfg(not(no_global_oom_handling))]
impl<A, const MIN_ALIGN: usize, const UP: bool, const GUARANTEED_ALLOCATED: bool> Default
for Bump<A, MIN_ALIGN, UP, GUARANTEED_ALLOCATED>
where
MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
A: BaseAllocator<GUARANTEED_ALLOCATED> + Default,
{
#[inline(always)]
fn default() -> Self {
Self::new_in(Default::default())
}
}
impl<A, const MIN_ALIGN: usize, const UP: bool> Bump<A, MIN_ALIGN, UP, false>
where
MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
A: BaseAllocator<false>,
{
cfg_const! {
#[cfg_const(feature = "nightly-const-refs-to-static")]
/// Constructs a new `Bump` without doing any allocations.
///
/// **This is `const` when the `nightly-const-refs-to-static` feature is enabled.**
#[must_use]
pub fn unallocated() -> Self {
Self { chunk: Cell::new(unsafe { RawChunk::from_header(unallocated_chunk_header().cast()) }) }
}
}
}
impl<A, const MIN_ALIGN: usize, const UP: bool, const GUARANTEED_ALLOCATED: bool>
Bump<A, MIN_ALIGN, UP, GUARANTEED_ALLOCATED>
where
MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
A: BaseAllocator<GUARANTEED_ALLOCATED> + Default,
{
error_behavior_generic_methods_allocation_failure! {
impl
/// This is equivalent to <code>[with_size](Bump::with_size)(512)</code>.
#[must_use]
for pub fn new
/// This is equivalent to <code>[try_with_size](Bump::try_with_size)(512)</code>.
for pub fn try_new
fn generic_new() -> Self {
Self::generic_new_in(Default::default())
}
impl
#[must_use]
/// Constructs a new `Bump` with a size hint for the first chunk.
///
/// If you want to ensure a specific capacity use <code>[with_capacity](Bump::with_capacity)</code> instead.
///
/// The actual size that will be requested from the base allocator may be bigger or smaller.
/// (The size of `[usize;2]` will be subtracted to make it friendlier towards its base allocator that may store its own header information along with it.)
for pub fn with_size
/// Constructs a new `Bump` with a size hint for the first chunk.
///
/// If you want to ensure a specific capacity use <code>[try_with_capacity](Bump::try_with_capacity)</code> instead.
///
/// The actual size that will be requested from the base allocator may be bigger or smaller.
/// (The size of `[usize;2]` will be subtracted to make it friendlier towards its base allocator that may store its own header information along with it.)
for pub fn try_with_size
fn generic_with_size(size: usize) -> Self {
Self::generic_with_size_in(size, Default::default())
}
impl
#[must_use]
/// Constructs a new `Bump` with at least enough space for `layout`.
///
/// To construct a `Bump` with some rough size estimate like `1 << 16` use <code>[with_size](Bump::with_size)</code> instead.
for pub fn with_capacity
/// Constructs a new `Bump` with at least enough space for `layout`.
///
/// To construct a `Bump` with some rough size estimate like `1 << 16` use <code>[try_with_size](Bump::try_with_size)</code> instead.
for pub fn try_with_capacity
fn generic_with_capacity(layout: Layout) -> Self {
Self::generic_with_capacity_in(layout, Default::default())
}
}
}
/// These functions are only available if the `Bump` is [guaranteed allocated](crate#guaranteed_allocated-parameter).
impl<A, const MIN_ALIGN: usize, const UP: bool> Bump<A, MIN_ALIGN, UP>
where
MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
A: BaseAllocator,
{
bump_scope_methods!(BumpScopeGuardRoot, false);
}
impl<A, const MIN_ALIGN: usize, const UP: bool, const GUARANTEED_ALLOCATED: bool>
Bump<A, MIN_ALIGN, UP, GUARANTEED_ALLOCATED>
where
MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
A: BaseAllocator<GUARANTEED_ALLOCATED>,
{
error_behavior_generic_methods_allocation_failure! {
impl
/// This is equivalent to <code>[with_size_in](Bump::with_size_in)(512, allocator)</code>.
for pub fn new_in
/// This is equivalent to <code>[try_with_size_in](Bump::try_with_size_in)(512, allocator)</code>.
for pub fn try_new_in
fn generic_new_in(allocator: A) -> Self {
Self::generic_with_size_in(DEFAULT_START_CHUNK_SIZE, allocator)
}
impl
/// Constructs a new `Bump` with a size hint for the first chunk.
///
/// If you want to ensure a specific capacity use <code>[with_capacity_in](Bump::with_capacity_in)</code> instead.
///
/// The actual size that will be requested from the base allocator may be bigger or smaller.
/// (The size of `[usize;2]` will be subtracted to make it friendlier towards its base allocator that may store its own header information along with it.)
for pub fn with_size_in
/// Constructs a new `Bump` with a size hint for the first chunk.
///
/// If you want to ensure a specific capacity use <code>[try_with_capacity_in](Bump::try_with_capacity_in)</code> instead.
///
/// The actual size that will be requested from the base allocator may be bigger or smaller.
/// (The size of `[usize;2]` will be subtracted to make it friendlier towards its base allocator that may store its own header information along with it.)
for pub fn try_with_size_in
fn generic_with_size_in(size: usize, allocator: A) -> Self {
Ok(Self {
chunk: Cell::new(RawChunk::new_in(
ChunkSize::new(size).ok_or_else(B::capacity_overflow)?,
None,
allocator,
)?),
})
}
impl
/// Constructs a new `Bump` with at least enough space for `layout`.
///
/// To construct a `Bump` with some rough size estimate like `1 << 16` use <code>[with_size_in](Bump::with_size_in)</code> instead.
for pub fn with_capacity_in
/// Constructs a new `Bump` with at least enough space for `layout`.
///
/// To construct a `Bump` with some rough size estimate like `1 << 16` use <code>[try_with_size_in](Bump::try_with_size_in)</code> instead.
for pub fn try_with_capacity_in
fn generic_with_capacity_in(layout: Layout, allocator: A) -> Self {
Ok(Self {
chunk: Cell::new(RawChunk::new_in(
ChunkSize::for_capacity(layout).ok_or_else(B::capacity_overflow)?,
None,
allocator,
)?),
})
}
}
// This needs `&mut self` to make sure that no allocations are alive.
#[doc = include_str!("docs/bump/reset.md")]
#[inline(always)]
pub fn reset(&mut self) {
let mut chunk = self.chunk.get();
unsafe {
chunk.for_each_prev(|chunk| chunk.deallocate());
while let Some(next) = chunk.next() {
chunk.deallocate();
chunk = next;
}
}
chunk.set_prev(None);
chunk.reset();
self.chunk.set(chunk);
}
bump_common_methods!(false);
/// Returns this `&Bump` as a `&BumpScope`.
#[inline(always)]
pub fn as_scope(&self) -> &BumpScope<A, MIN_ALIGN, UP, GUARANTEED_ALLOCATED> {
// SAFETY: `Bump` and `BumpScope` both have the layout of `Cell<RawChunk>`
// `BumpScope`'s api is a subset of `Bump`'s
unsafe { &*pointer::from_ref(self).cast() }
}
/// Returns this `&mut Bump` as a `&mut BumpScope`.
#[inline(always)]
pub fn as_mut_scope(&mut self) -> &mut BumpScope<A, MIN_ALIGN, UP, GUARANTEED_ALLOCATED> {
// SAFETY: `Bump` and `BumpScope` both have the layout of `Cell<RawChunk>`
// `BumpScope`'s api is a subset of `Bump`'s
unsafe { &mut *pointer::from_mut(self).cast() }
}
/// Converts this `Bump` into a `Bump` with a new minimum alignment.
#[inline(always)]
pub fn into_aligned<const NEW_MIN_ALIGN: usize>(self) -> Bump<A, NEW_MIN_ALIGN, UP, GUARANTEED_ALLOCATED>
where
MinimumAlignment<NEW_MIN_ALIGN>: SupportedMinimumAlignment,
{
self.as_scope().align::<NEW_MIN_ALIGN>();
unsafe { self.cast_align() }
}
/// Mutably borrows `Bump` with a new minimum alignment.
///
#[doc = doc_align_cant_decrease!()]
#[inline(always)]
pub fn as_aligned_mut<const NEW_MIN_ALIGN: usize>(&mut self) -> &mut Bump<A, NEW_MIN_ALIGN, UP, GUARANTEED_ALLOCATED>
where
MinimumAlignment<NEW_MIN_ALIGN>: SupportedMinimumAlignment,
{
self.as_scope().must_align_more::<NEW_MIN_ALIGN>();
unsafe { self.cast_align_mut() }
}
#[inline(always)]
pub(crate) unsafe fn cast_align<const NEW_MIN_ALIGN: usize>(self) -> Bump<A, NEW_MIN_ALIGN, UP, GUARANTEED_ALLOCATED>
where
MinimumAlignment<NEW_MIN_ALIGN>: SupportedMinimumAlignment,
{
let chunk = self.chunk.get();
mem::forget(self);
Bump { chunk: Cell::new(chunk) }
}
#[inline(always)]
pub(crate) unsafe fn cast_align_mut<const NEW_MIN_ALIGN: usize>(
&mut self,
) -> &mut Bump<A, NEW_MIN_ALIGN, UP, GUARANTEED_ALLOCATED>
where
MinimumAlignment<NEW_MIN_ALIGN>: SupportedMinimumAlignment,
{
&mut *pointer::from_mut(self).cast::<Bump<A, NEW_MIN_ALIGN, UP, GUARANTEED_ALLOCATED>>()
}
/// Converts this `Bump` into a [guaranteed allocated](crate#guaranteed_allocated-parameter) `Bump`.
///
/// # Panics
/// Panics if the allocation fails.
#[cfg(not(no_global_oom_handling))]
pub fn into_guaranteed_allocated(self) -> Bump<A, MIN_ALIGN, UP> {
infallible(self.generic_into_guaranteed_allocated())
}
/// Converts this `Bump` into a [guaranteed allocated](crate#guaranteed_allocated-parameter) `Bump`.
///
/// # Errors
/// Errors if the allocation fails.
pub fn try_into_guaranteed_allocated(self) -> Result<Bump<A, MIN_ALIGN, UP>, AllocError> {
self.generic_into_guaranteed_allocated()
}
fn generic_into_guaranteed_allocated<E: ErrorBehavior>(self) -> Result<Bump<A, MIN_ALIGN, UP>, E> {
self.as_scope().ensure_allocated()?;
Ok(unsafe { self.cast_allocated() })
}
/// Mutably borrows `Bump` in a [guaranteed allocated](crate#guaranteed_allocated-parameter) state.
///
/// # Panics
/// Panics if the allocation fails.
#[cfg(not(no_global_oom_handling))]
pub fn as_guaranteed_allocated_mut(&mut self) -> &mut Bump<A, MIN_ALIGN, UP> {
infallible(self.generic_as_guaranteed_allocated_mut())
}
/// Mutably borrows `Bump` in an [guaranteed allocated](crate#guaranteed_allocated-parameter) state.
///
/// # Errors
/// Errors if the allocation fails.
pub fn try_as_guaranteed_allocated_mut(&mut self) -> Result<&mut Bump<A, MIN_ALIGN, UP>, AllocError> {
self.generic_as_guaranteed_allocated_mut()
}
fn generic_as_guaranteed_allocated_mut<E: ErrorBehavior>(&mut self) -> Result<&mut Bump<A, MIN_ALIGN, UP>, E> {
self.as_scope().ensure_allocated()?;
Ok(unsafe { self.cast_allocated_mut() })
}
#[inline(always)]
pub(crate) unsafe fn cast_allocated(self) -> Bump<A, MIN_ALIGN, UP> {
let chunk = self.chunk.get();
mem::forget(self);
Bump { chunk: Cell::new(chunk) }
}
#[inline(always)]
pub(crate) unsafe fn cast_allocated_mut(&mut self) -> &mut Bump<A, MIN_ALIGN, UP> {
&mut *pointer::from_mut(self).cast::<Bump<A, MIN_ALIGN, UP>>()
}
/// Converts this `Bump` into a raw pointer.
///
/// ```
/// use bump_scope::Bump;
///
/// let bump: Bump = Bump::new();
/// let ptr = bump.into_raw();
/// let bump: Bump = unsafe { Bump::from_raw(ptr) };
///
/// bump.alloc_str("Why did i do this?");
/// ```
#[inline]
#[must_use]
pub fn into_raw(self) -> NonNull<()> {
let this = ManuallyDrop::new(self);
this.chunk.get().header_ptr().cast()
}
/// Converts the raw pointer that was created with [`into_raw`](Bump::into_raw) back into a `Bump`.
///
/// # Safety
/// - `ptr` must have been created with `Self::into_raw`.
/// - This function must only be called once with this `ptr`.
#[inline]
#[must_use]
pub unsafe fn from_raw(ptr: NonNull<()>) -> Self {
let chunk = Cell::new(RawChunk::from_header(ptr.cast()));
Self { chunk }
}
}
impl<'b, A, const MIN_ALIGN: usize, const UP: bool, const GUARANTEED_ALLOCATED: bool>
From<&'b Bump<A, MIN_ALIGN, UP, GUARANTEED_ALLOCATED>> for &'b BumpScope<'b, A, MIN_ALIGN, UP, GUARANTEED_ALLOCATED>
where
MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
A: BaseAllocator<GUARANTEED_ALLOCATED>,
{
#[inline(always)]
fn from(value: &'b Bump<A, MIN_ALIGN, UP, GUARANTEED_ALLOCATED>) -> Self {
value.as_scope()
}
}
impl<'b, A, const MIN_ALIGN: usize, const UP: bool, const GUARANTEED_ALLOCATED: bool>
From<&'b mut Bump<A, MIN_ALIGN, UP, GUARANTEED_ALLOCATED>>
for &'b mut BumpScope<'b, A, MIN_ALIGN, UP, GUARANTEED_ALLOCATED>
where
MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,
A: BaseAllocator<GUARANTEED_ALLOCATED>,
{
#[inline(always)]
fn from(value: &'b mut Bump<A, MIN_ALIGN, UP, GUARANTEED_ALLOCATED>) -> Self {
value.as_mut_scope()
}
}