oxc_allocator 0.128.0

//! Utility functions for `Arena`.

use std::{alloc::Layout, hint::unreachable_unchecked, ptr::NonNull};

pub use super::bumpalo_alloc::AllocErr;

/// Types that expose a pointer address.
///
/// Implemented for `*const T`, `*mut T`, and `NonNull<T>` so `is_pointer_aligned_to`
/// can take any of them without forcing callers to pre-convert.
pub trait Pointer {
    fn addr(self) -> usize;
}

impl<T: ?Sized> Pointer for *const T {
    #[inline]
    fn addr(self) -> usize {
        self.addr()
    }
}

impl<T: ?Sized> Pointer for *mut T {
    #[inline]
    fn addr(self) -> usize {
        self.addr()
    }
}

impl<T: ?Sized> Pointer for NonNull<T> {
    #[inline]
    fn addr(self) -> usize {
        self.addr().get()
    }
}

/// Check if a pointer is aligned to a given alignment.
///
/// `align` must be a power of 2.
//
// `#[inline(always)]` because it's only 1 instruction when `align` is statically known, or 2 instructions otherwise.
// When `align` is statically known, we want this inlined so that knowledge can be capitalized on.
#[inline(always)]
pub fn is_pointer_aligned_to<P: Pointer>(ptr: P, align: usize) -> bool {
    debug_assert!(align.is_power_of_two());

    (ptr.addr() & (align - 1)) == 0
}

#[inline]
pub const fn round_up_to(n: usize, divisor: usize) -> Option<usize> {
    debug_assert!(divisor.is_power_of_two());
    match n.checked_add(divisor - 1) {
        Some(x) => Some(x & !(divisor - 1)),
        None => None,
    }
}

/// Like `round_up_to` but turns overflow into undefined behavior rather than
/// returning `None`.
#[inline]
pub unsafe fn round_up_to_unchecked(n: usize, divisor: usize) -> usize {
    if let Some(x) = round_up_to(n, divisor) {
        x
    } else {
        debug_assert!(false, "round_up_to_unchecked failed");
        unsafe { unreachable_unchecked() }
    }
}

#[inline]
pub fn round_down_to(n: usize, divisor: usize) -> usize {
    debug_assert!(divisor.is_power_of_two());
    n & !(divisor - 1)
}

/// Same as `round_down_to` but preserves pointer provenance.
///
/// # Implementation note
///
/// The exact implementation here is important.
///
/// `Arena::try_alloc_layout_fast` relies on it using `wrapping_sub`.
/// `ptr.map_addr(|addr| addr & !(divisor - 1))` would be semantically equivalent,
/// but would prevent LLVM from folding 2 subtractions into 1 in `try_alloc_layout_fast`.
/// See comment in that method for more details.
#[inline]
pub fn round_mut_ptr_down_to(ptr: *mut u8, divisor: usize) -> *mut u8 {
    debug_assert!(divisor.is_power_of_two());
    ptr.wrapping_sub(ptr.addr() & (divisor - 1))
}

#[inline]
pub unsafe fn round_nonnull_ptr_up_to_unchecked(ptr: NonNull<u8>, divisor: usize) -> NonNull<u8> {
    debug_assert!(divisor.is_power_of_two());
    unsafe {
        let addr = ptr.addr().get();
        let aligned = round_up_to_unchecked(addr, divisor);
        let delta = aligned - addr;
        ptr.add(delta)
    }
}

/// Wrapper around `Layout::from_size_align` that adds debug assertions.
#[inline]
pub fn layout_from_size_align(size: usize, align: usize) -> Result<Layout, AllocErr> {
    Layout::from_size_align(size, align).map_err(|_| AllocErr)
}

#[inline(never)]
#[cold]
pub fn oom() -> ! {
    panic!("out of memory")
}