boltffi_core 0.22.1

Core runtime types for BoltFFI - high-performance FFI bindings generator
Documentation
pub const WASM_ABI_VERSION: u32 = 1;

#[cfg(any(test, target_arch = "wasm32"))]
use std::alloc::{Layout, alloc, dealloc};

#[cfg(target_arch = "wasm32")]
#[repr(C)]
pub struct WasmCallbackOutBuf {
    ptr: u32,
    len: u32,
    cap: u32,
}

#[cfg(target_arch = "wasm32")]
impl WasmCallbackOutBuf {
    pub const fn empty() -> Self {
        Self {
            ptr: 0,
            len: 0,
            cap: 0,
        }
    }

    pub unsafe fn as_slice(&self) -> &[u8] {
        if self.ptr == 0 || self.len == 0 {
            &[]
        } else {
            unsafe { core::slice::from_raw_parts(self.ptr as *const u8, self.len as usize) }
        }
    }
}

#[cfg(target_arch = "wasm32")]
impl Drop for WasmCallbackOutBuf {
    fn drop(&mut self) {
        if self.ptr != 0 && self.cap > 0 {
            boltffi_wasm_free_impl(self.ptr as usize, self.cap as usize);
        }
    }
}

#[cfg(any(test, target_arch = "wasm32"))]
fn boltffi_wasm_alloc_impl(size: usize) -> usize {
    if size == 0 {
        return 0;
    }

    let layout = match Layout::from_size_align(size, 8) {
        Ok(layout) => layout,
        Err(_) => return 0,
    };

    let pointer = unsafe { alloc(layout) };
    if pointer.is_null() {
        0
    } else {
        pointer as usize
    }
}

#[cfg(any(test, target_arch = "wasm32"))]
pub(crate) fn boltffi_wasm_free_impl(ptr: usize, size: usize) {
    if ptr == 0 || size == 0 {
        return;
    }

    let layout = match Layout::from_size_align(size, 8) {
        Ok(layout) => layout,
        Err(_) => return,
    };

    unsafe { dealloc(ptr as *mut u8, layout) };
}

#[cfg(any(test, target_arch = "wasm32"))]
pub(crate) fn boltffi_wasm_free_buf_impl(ptr: usize, size: usize, align: usize) {
    if ptr == 0 || size == 0 || align == 0 {
        return;
    }
    let layout = match Layout::from_size_align(size, align) {
        Ok(layout) => layout,
        Err(_) => return,
    };
    unsafe { dealloc(ptr as *mut u8, layout) };
}

#[cfg(any(test, target_arch = "wasm32"))]
pub(crate) unsafe fn boltffi_wasm_free_string_return_impl(ptr: usize, len: usize) {
    if ptr == 0 || len == 0 {
        return;
    }
    unsafe { drop(Vec::from_raw_parts(ptr as *mut u8, len, len)) };
}

#[cfg(any(test, target_arch = "wasm32"))]
fn boltffi_wasm_realloc_impl(ptr: usize, old_size: usize, new_size: usize) -> usize {
    if new_size == 0 {
        boltffi_wasm_free_impl(ptr, old_size);
        return 0;
    }

    if ptr == 0 {
        return boltffi_wasm_alloc_impl(new_size);
    }

    let old_layout = match Layout::from_size_align(old_size, 8) {
        Ok(layout) => layout,
        Err(_) => return 0,
    };

    let new_pointer = unsafe { std::alloc::realloc(ptr as *mut u8, old_layout, new_size) };
    if new_pointer.is_null() {
        0
    } else {
        new_pointer as usize
    }
}

#[cfg(target_arch = "wasm32")]
static mut RETURN_SLOT: [u32; 4] = [0, 0, 0, 0];

#[cfg(target_arch = "wasm32")]
#[inline(always)]
pub fn write_return_slot(ptr: u32, len: u32, cap: u32, align: u32) {
    unsafe {
        core::ptr::write_volatile(&raw mut RETURN_SLOT[0], ptr);
        core::ptr::write_volatile(&raw mut RETURN_SLOT[1], len);
        core::ptr::write_volatile(&raw mut RETURN_SLOT[2], cap);
        core::ptr::write_volatile(&raw mut RETURN_SLOT[3], align);
    }
}

#[cfg(target_arch = "wasm32")]
#[inline(always)]
pub fn return_slot_addr() -> u32 {
    (&raw const RETURN_SLOT) as u32
}

#[cfg(target_arch = "wasm32")]
mod exports {
    #[unsafe(no_mangle)]
    pub extern "C" fn boltffi_wasm_abi_version() -> u32 {
        super::WASM_ABI_VERSION
    }

    #[unsafe(no_mangle)]
    pub extern "C" fn boltffi_wasm_return_slot_addr() -> u32 {
        super::return_slot_addr()
    }

    #[unsafe(no_mangle)]
    pub extern "C" fn boltffi_wasm_alloc(size: u32) -> u32 {
        super::boltffi_wasm_alloc_impl(size as usize) as u32
    }

    #[unsafe(no_mangle)]
    pub extern "C" fn boltffi_wasm_free(ptr: u32, size: u32) {
        super::boltffi_wasm_free_impl(ptr as usize, size as usize);
    }

    #[unsafe(no_mangle)]
    pub extern "C" fn boltffi_wasm_realloc(ptr: u32, old_size: u32, new_size: u32) -> u32 {
        super::boltffi_wasm_realloc_impl(ptr as usize, old_size as usize, new_size as usize) as u32
    }

    #[unsafe(no_mangle)]
    pub unsafe extern "C" fn boltffi_wasm_free_string_return(ptr: u32, len: u32) {
        unsafe { super::boltffi_wasm_free_string_return_impl(ptr as usize, len as usize) };
    }

    #[unsafe(no_mangle)]
    pub extern "C" fn boltffi_wasm_free_buf(ptr: u32, size: u32, align: u32) {
        super::boltffi_wasm_free_buf_impl(ptr as usize, size as usize, align as usize);
    }
}

#[cfg(test)]
mod tests {
    use super::{
        WASM_ABI_VERSION, boltffi_wasm_alloc_impl, boltffi_wasm_free_buf_impl,
        boltffi_wasm_free_impl, boltffi_wasm_free_string_return_impl, boltffi_wasm_realloc_impl,
    };

    #[test]
    fn wasm_abi_version_is_stable() {
        assert_eq!(WASM_ABI_VERSION, 1);
    }

    #[test]
    fn alloc_zero_returns_zero_pointer() {
        assert_eq!(boltffi_wasm_alloc_impl(0), 0);
    }

    #[test]
    fn alloc_non_zero_returns_pointer_and_free_accepts_it() {
        let pointer = boltffi_wasm_alloc_impl(16);
        assert_ne!(pointer, 0);
        boltffi_wasm_free_impl(pointer, 16);
    }

    #[test]
    fn realloc_from_null_matches_alloc_behavior() {
        let pointer = boltffi_wasm_realloc_impl(0, 0, 24);
        assert_ne!(pointer, 0);
        boltffi_wasm_free_impl(pointer, 24);
    }

    #[test]
    fn realloc_growth_preserves_prefix_bytes() {
        let old_size = 32usize;
        let new_size = 96usize;
        let old_pointer = boltffi_wasm_alloc_impl(old_size);
        assert_ne!(old_pointer, 0);

        let expected_prefix = (0..old_size)
            .map(|index| ((index * 7 + 3) % 256) as u8)
            .collect::<Vec<_>>();

        unsafe {
            std::slice::from_raw_parts_mut(old_pointer as *mut u8, old_size)
                .copy_from_slice(&expected_prefix);
        }

        let new_pointer = boltffi_wasm_realloc_impl(old_pointer, old_size, new_size);
        assert_ne!(new_pointer, 0);

        let actual_prefix =
            unsafe { std::slice::from_raw_parts(new_pointer as *const u8, old_size) }.to_vec();
        assert_eq!(actual_prefix, expected_prefix);

        boltffi_wasm_free_impl(new_pointer, new_size);
    }

    #[test]
    fn realloc_to_zero_returns_null_pointer() {
        let pointer = boltffi_wasm_alloc_impl(64);
        assert_ne!(pointer, 0);

        let reallocated = boltffi_wasm_realloc_impl(pointer, 64, 0);
        assert_eq!(reallocated, 0);
    }

    #[test]
    fn free_ignores_zero_inputs() {
        boltffi_wasm_free_impl(0, 32);
        boltffi_wasm_free_impl(1024, 0);
    }

    #[test]
    fn free_buf_releases_with_explicit_alignment() {
        let pointer = boltffi_wasm_alloc_impl(64);
        assert_ne!(pointer, 0);
        boltffi_wasm_free_buf_impl(pointer, 64, 8);
    }

    #[test]
    fn free_string_return_releases_owned_buffer() {
        let text = "boltffi";
        let mut boxed = text.as_bytes().to_vec().into_boxed_slice();
        let ptr = boxed.as_mut_ptr() as usize;
        let len = boxed.len();
        std::mem::forget(boxed);
        unsafe { boltffi_wasm_free_string_return_impl(ptr, len) };
    }
}