linalloc 1.1.0

//! Platform‑specific memory management for incremental commitment.
//!
//! This module provides a thin, safe‑to‑use abstraction over the operating
//! system’s virtual memory primitives. It is **not** part of the public API
//! of `linalloc` -- it exists solely to support the arena allocator’s lazy
//! commit strategy.

use core::ptr::NonNull;

/// Reserve `size` bytes of address space without committing physical memory.
///
/// The returned pointer is guaranteed to be page‑aligned and non‑null.
///
/// # Errors
///
/// Returns the OS error code if the system call fails (e.g. out of virtual address space).
pub fn reserve(size: usize) -> Result<NonNull<u8>, i32> {
    platform::reserve(size)
}

/// Commit `size` bytes starting at `addr`, making the memory readable and
/// writable.
///
/// # Requirements
///
/// - `addr` must be page‑aligned and must point to memory previously reserved
///   but not yet committed.
/// - `size` must be non-zero and fit within the reservation. The platform
///   commits every page containing at least one byte in `[addr, addr + size)`.
/// - The range `[addr, addr + size)` must not contain any already‑committed
///   memory (the operating system may allow overlapping commits, but the
///   allocator never does so).
///
/// # Errors
///
/// Returns the OS error code if the system call fails (e.g. out of physical memory).
pub fn commit(addr: NonNull<u8>, size: usize) -> Result<(), i32> {
    platform::commit(addr, size)
}

/// Release the entire reservation, including all committed pages.
///
/// # Safety
///
/// - `addr` must be the exact pointer returned by a previous call to
///   [`reserve`], and `size` must be the exact reservation size.
/// - This function must be called at most once for a given reservation.
/// - No pointers into the released region may be used afterwards.
pub unsafe fn release(addr: NonNull<u8>, size: usize) {
    unsafe { platform::release(addr, size) }
}

/// Returns the system’s page size in bytes.
///
/// The value is cached after the first call -- subsequent calls are
/// extremely cheap (a relaxed atomic load).
///
/// On Unix targets, if the page size query fails, this falls back to 4KiB.
pub fn page_size() -> usize {
    platform::page_size()
}

#[cfg(unix)]
mod platform {
    use core::ffi::c_void;
    use core::ptr::NonNull;
    use core::sync::atomic::{AtomicUsize, Ordering};

    unsafe extern "C" {
        fn mmap(
            addr: *mut c_void,
            length: usize,
            prot: i32,
            flags: i32,
            fd: i32,
            offset: i64,
        ) -> *mut c_void;

        fn mprotect(addr: *mut c_void, len: usize, prot: i32) -> i32;

        fn munmap(addr: *mut c_void, length: usize) -> i32;

        fn sysconf(name: i32) -> i64;

        // yanked from https://github.com/rust-lang/rust/blob/main/library/std/src/sys/io/error/unix.rs
        #[cfg(not(any(target_os = "dragonfly", target_os = "vxworks", target_os = "rtems")))]
        #[cfg_attr(
            any(
                target_os = "linux",
                target_os = "emscripten",
                target_os = "fuchsia",
                target_os = "l4re",
                target_os = "hurd",
            ),
            link_name = "__errno_location"
        )]
        #[cfg_attr(
            any(
                target_os = "netbsd",
                target_os = "openbsd",
                target_os = "cygwin",
                target_os = "android",
                target_os = "redox",
                target_os = "nuttx",
                target_env = "newlib"
            ),
            link_name = "__errno"
        )]
        #[cfg_attr(any(target_os = "solaris", target_os = "illumos"), link_name = "___errno")]
        #[cfg_attr(target_os = "nto", link_name = "__get_errno_ptr")]
        #[cfg_attr(any(target_os = "freebsd", target_vendor = "apple"), link_name = "__error")]
        #[cfg_attr(target_os = "haiku", link_name = "_errnop")]
        #[cfg_attr(target_os = "aix", link_name = "_Errno")]
        fn errno_location() -> *mut i32;
    }

    const PROT_NONE: i32 = 0;
    const PROT_READ: i32 = 1;
    const PROT_WRITE: i32 = 2;

    const MAP_PRIVATE: i32 = 0x02;
    #[cfg(target_os = "linux")]
    const MAP_ANONYMOUS: i32 = 0x20;
    #[cfg(not(target_os = "linux"))]
    const MAP_ANONYMOUS: i32 = 0x1000; // MAP_ANON on macOS/BSD

    const MAP_FAILED: *mut c_void = -1isize as *mut c_void;

    const _SC_PAGESIZE: i32 = 29;

    pub fn reserve(size: usize) -> Result<NonNull<u8>, i32> {
        #[cfg(target_os = "netbsd")]
        // NetBSD allows an mmap(2) caller to specify what protection flags they
        // will use later via mprotect. It does not allow a caller to move from
        // PROT_NONE to PROT_READ | PROT_WRITE.
        //
        // see PROT_MPROTECT in man 2 mmap
        const DESIRED_PROT: i32 = (PROT_READ | PROT_WRITE) << 3;

        #[cfg(not(target_os = "netbsd"))]
        const DESIRED_PROT: i32 = PROT_NONE;

        let ptr = unsafe {
            mmap(core::ptr::null_mut(), size, DESIRED_PROT, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0)
        };
        if ptr.is_null() || ptr == MAP_FAILED {
            Err(last_os_error())
        } else {
            // SAFETY: The pointer is already checked and is not null
            Ok(unsafe { NonNull::new_unchecked(ptr.cast()) })
        }
    }

    pub fn commit(addr: NonNull<u8>, size: usize) -> Result<(), i32> {
        let ret = unsafe { mprotect(addr.as_ptr().cast(), size, PROT_READ | PROT_WRITE) };
        if ret == 0 { Ok(()) } else { Err(last_os_error()) }
    }

    pub unsafe fn release(addr: NonNull<u8>, size: usize) {
        unsafe { munmap(addr.as_ptr().cast(), size) };
    }

    pub fn last_os_error() -> i32 {
        unsafe { *errno_location() }
    }

    static PAGE_SIZE: AtomicUsize = AtomicUsize::new(0);

    #[inline]
    pub fn page_size() -> usize {
        let sz = PAGE_SIZE.load(Ordering::Relaxed);
        if sz != 0 {
            return sz;
        }
        page_size_store()
    }

    #[allow(
        clippy::cast_possible_truncation,
        clippy::cast_sign_loss,
        reason = "sysconf returns a long, but page sizes are never that large"
    )]
    #[cold]
    fn page_size_store() -> usize {
        let raw = unsafe { sysconf(_SC_PAGESIZE) };
        let sz = if raw < 0 { 4 * 1024 } else { raw as usize };
        PAGE_SIZE.store(sz, Ordering::Relaxed);
        sz
    }
}

#[cfg(target_os = "windows")]
mod platform {
    use core::ffi::c_void;
    use core::ptr::NonNull;
    use core::sync::atomic::{AtomicUsize, Ordering};

    unsafe extern "system" {
        fn VirtualAlloc(
            lpAddress: *mut c_void,
            dwSize: usize,
            flAllocationType: u32,
            flProtect: u32,
        ) -> *mut c_void;

        fn VirtualFree(lpAddress: *mut c_void, dwSize: usize, dwFreeType: u32) -> i32;

        fn GetSystemInfo(lpSystemInfo: *mut SYSTEM_INFO);

        fn GetLastError() -> u32;
    }

    const MEM_RESERVE: u32 = 0x0000_2000;
    const MEM_COMMIT: u32 = 0x0000_1000;
    const MEM_RELEASE: u32 = 0x0000_8000;

    const PAGE_NOACCESS: u32 = 0x01;
    const PAGE_READWRITE: u32 = 0x04;

    #[allow(non_snake_case, reason = "matches Windows API naming")]
    #[repr(C)]
    struct SYSTEM_INFO {
        _u: u32,
        dwPageSize: u32,
        lpMinimumApplicationAddress: *mut c_void,
        lpMaximumApplicationAddress: *mut c_void,
        dwActiveProcessorMask: usize,
        dwNumberOfProcessors: u32,
        dwProcessorType: u32,
        dwAllocationGranularity: u32,
        wProcessorLevel: u16,
        wProcessorRevision: u16,
    }

    pub fn reserve(size: usize) -> Result<NonNull<u8>, i32> {
        let ptr = unsafe { VirtualAlloc(core::ptr::null_mut(), size, MEM_RESERVE, PAGE_NOACCESS) };
        NonNull::new(ptr.cast()).ok_or_else(last_os_error)
    }

    pub fn commit(addr: NonNull<u8>, size: usize) -> Result<(), i32> {
        let ptr = unsafe { VirtualAlloc(addr.as_ptr().cast(), size, MEM_COMMIT, PAGE_READWRITE) };
        if ptr.is_null() { Err(last_os_error()) } else { Ok(()) }
    }

    pub unsafe fn release(addr: NonNull<u8>, _size: usize) {
        unsafe { VirtualFree(addr.as_ptr().cast(), 0, MEM_RELEASE) };
    }

    pub fn last_os_error() -> i32 {
        unsafe { GetLastError() }.cast_signed()
    }

    static PAGE_SIZE: AtomicUsize = AtomicUsize::new(0);

    #[inline]
    pub fn page_size() -> usize {
        let sz = PAGE_SIZE.load(Ordering::Relaxed);
        if sz != 0 {
            return sz;
        }
        page_size_store()
    }

    #[cold]
    fn page_size_store() -> usize {
        let mut info: SYSTEM_INFO = unsafe { core::mem::zeroed() };
        unsafe { GetSystemInfo(&raw mut info) };
        let sz = info.dwPageSize as usize;
        PAGE_SIZE.store(sz, Ordering::Relaxed);
        sz
    }
}