sqlite-wasm-rs 0.5.5

//! This module fills in the external functions needed to link to `sqlite.o`

use core::ffi::{c_char, c_int, c_long, c_longlong, c_void};
use core::ptr;
use core::time::Duration;

use js_sys::{Date, Math, Number};
use rsqlite_vfs::OsCallback;
use wasm_bindgen::prelude::wasm_bindgen;
use wasm_bindgen::JsValue;

pub struct WasmOsCallback;

impl OsCallback for WasmOsCallback {
    /// thread::sleep is available when atomics is enabled
    #[cfg(target_feature = "atomics")]
    fn sleep(dur: Duration) {
        let mut nanos = dur.as_nanos();
        while nanos > 0 {
            let amt = core::cmp::min(i64::MAX as u128, nanos);
            let mut x = 0;
            // memory_atomic_wait32 returns 2 on timeout; loop until elapsed.
            let val = unsafe { core::arch::wasm32::memory_atomic_wait32(&mut x, 0, amt as i64) };
            debug_assert_eq!(val, 2);
            nanos -= amt;
        }
    }

    #[cfg(not(target_feature = "atomics"))]
    fn sleep(_dur: Duration) {}

    fn random(buf: &mut [u8]) {
        fn fallback(buf: &mut [u8]) {
            // Non-cryptographic fallback when crypto.getRandomValues is unavailable.
            for b in buf {
                *b = (Math::random() * 255000.0) as u32 as u8;
            }
        }

        #[cfg(not(target_feature = "atomics"))]
        get_random_values(buf).unwrap_or_else(|_| fallback(buf));

        #[cfg(target_feature = "atomics")]
        {
            let array = js_sys::Uint8Array::new_with_length(buf.len() as _);
            if get_random_values(&array).is_ok() {
                array.copy_to(buf);
            } else {
                fallback(buf);
            }
        }
    }

    fn epoch_timestamp_in_ms() -> i64 {
        Date::new_0().get_time() as i64
    }
}

#[allow(non_camel_case_types)]
type c_size_t = usize;

#[allow(non_camel_case_types)]
type c_time_t = c_longlong;

#[wasm_bindgen]
extern "C" {
    // crypto.getRandomValues()
    #[cfg(not(target_feature = "atomics"))]
    #[wasm_bindgen(js_namespace = ["globalThis", "crypto"], js_name = getRandomValues, catch)]
    fn get_random_values(buf: &mut [u8]) -> Result<(), JsValue>;
    #[cfg(target_feature = "atomics")]
    #[wasm_bindgen(js_namespace = ["globalThis", "crypto"], js_name = getRandomValues, catch)]
    fn get_random_values(buf: &js_sys::Uint8Array) -> Result<(), JsValue>;
}

fn yday_from_date(date: &Date) -> u32 {
    const MONTH_DAYS_LEAP_CUMULATIVE: [u32; 12] =
        [0, 31, 60, 91, 121, 152, 182, 213, 244, 274, 305, 335];

    const MONTH_DAYS_REGULAR_CUMULATIVE: [u32; 12] =
        [0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334];

    let year = date.get_full_year();
    let leap = year % 4 == 0 && (year % 100 != 0 || year % 400 == 0);

    let month_days_cumulative = if leap {
        MONTH_DAYS_LEAP_CUMULATIVE
    } else {
        MONTH_DAYS_REGULAR_CUMULATIVE
    };
    month_days_cumulative[date.get_month() as usize] + date.get_date() - 1
}

/// https://github.com/emscripten-core/emscripten/blob/df69e2ccc287beab6f580f33b33e6b5692f5d20b/system/lib/libc/emscripten_internal.h#L42
///
/// https://github.com/sqlite/sqlite-wasm/blob/7c1b309c3bd07d8e6d92f82344108cebbd14f161/sqlite-wasm/jswasm/sqlite3-bundler-friendly.mjs#L3404
// Mirrors emscripten/sqlite-wasm localtime handling, including DST logic.
unsafe fn localtime_js(t: c_time_t, tm: *mut tm) {
    let date = Date::new(&Number::from((t * 1000) as f64).into());

    (*tm).tm_sec = date.get_seconds() as _;
    (*tm).tm_min = date.get_minutes() as _;
    (*tm).tm_hour = date.get_hours() as _;
    (*tm).tm_mday = date.get_date() as _;
    (*tm).tm_mon = date.get_month() as _;
    (*tm).tm_year = (date.get_full_year() - 1900) as _;
    (*tm).tm_wday = date.get_day() as _;
    (*tm).tm_yday = yday_from_date(&date) as _;

    let start = Date::new_with_year_month_day(date.get_full_year(), 0, 1);
    let tz_offset = date.get_timezone_offset();
    let summer_offset =
        Date::new_with_year_month_day(date.get_full_year(), 6, 1).get_timezone_offset();
    let winter_offset = start.get_timezone_offset();
    (*tm).tm_isdst =
        i32::from(summer_offset != winter_offset && tz_offset == winter_offset.min(summer_offset));

    (*tm).tm_gmtoff = -(tz_offset * 60.0) as _;
}

/// https://github.com/emscripten-core/emscripten/blob/df69e2ccc287beab6f580f33b33e6b5692f5d20b/system/lib/libc/musl/include/time.h#L40
#[repr(C)]
pub struct tm {
    pub tm_sec: c_int,
    pub tm_min: c_int,
    pub tm_hour: c_int,
    pub tm_mday: c_int,
    pub tm_mon: c_int,
    pub tm_year: c_int,
    pub tm_wday: c_int,
    pub tm_yday: c_int,
    pub tm_isdst: c_int,
    pub tm_gmtoff: c_long,
    pub tm_zone: *mut c_char,
}

/// https://github.com/emscripten-core/emscripten/blob/df69e2ccc287beab6f580f33b33e6b5692f5d20b/system/include/wasi/api.h#L2652
#[no_mangle]
pub unsafe extern "C" fn rust_sqlite_wasm_getentropy(
    buf: *mut u8,
    buf_len: c_size_t,
) -> core::ffi::c_ushort {
    // https://github.com/WebAssembly/wasi-libc/blob/e9524a0980b9bb6bb92e87a41ed1055bdda5bb86/libc-bottom-half/headers/public/wasi/api.h#L373
    const FUNCTION_NOT_SUPPORT: core::ffi::c_ushort = 52;

    #[cfg(target_feature = "atomics")]
    {
        let array = js_sys::Uint8Array::new_with_length(buf_len as u32);
        if get_random_values(&array).is_err() {
            return FUNCTION_NOT_SUPPORT;
        }
        array.copy_to(core::slice::from_raw_parts_mut(buf, buf_len));
    }

    #[cfg(not(target_feature = "atomics"))]
    if get_random_values(core::slice::from_raw_parts_mut(buf, buf_len)).is_err() {
        return FUNCTION_NOT_SUPPORT;
    }

    0
}

#[no_mangle]
pub unsafe extern "C" fn rust_sqlite_wasm_assert_fail(
    expr: *const c_char,
    file: *const c_char,
    line: c_int,
    func: *const c_char,
) {
    let expr = core::ffi::CStr::from_ptr(expr).to_string_lossy();
    let file = core::ffi::CStr::from_ptr(file).to_string_lossy();
    let func = core::ffi::CStr::from_ptr(func).to_string_lossy();
    panic!("Assertion failed: {expr} ({file}: {func}: {line})");
}

#[no_mangle]
pub unsafe extern "C" fn rust_sqlite_wasm_abort() {
    core::unreachable!();
}

/// See <https://github.com/emscripten-core/emscripten/blob/089590d17eeb705424bf32f8a1afe34a034b4682/system/lib/libc/mktime.c#L28>.
#[no_mangle]
pub unsafe extern "C" fn rust_sqlite_wasm_localtime(t: *const c_time_t) -> *mut tm {
    // Single shared buffer, matches libc behavior; assumes no concurrent callers.
    static mut TM: tm = tm {
        tm_sec: 0,
        tm_min: 0,
        tm_hour: 0,
        tm_mday: 0,
        tm_mon: 0,
        tm_year: 0,
        tm_wday: 0,
        tm_yday: 0,
        tm_isdst: 0,
        tm_gmtoff: 0,
        tm_zone: ptr::null_mut(),
    };
    localtime_js(*t, ptr::addr_of_mut!(TM));
    ptr::addr_of_mut!(TM)
}

// https://github.com/alexcrichton/dlmalloc-rs/blob/fb116603713825b43b113cc734bb7d663cb64be9/src/dlmalloc.rs#L141
const ALIGN: usize = core::mem::size_of::<usize>() * 2;

#[no_mangle]
pub unsafe extern "C" fn rust_sqlite_wasm_malloc(size: c_size_t) -> *mut c_void {
    let layout = core::alloc::Layout::from_size_align_unchecked(size + ALIGN, ALIGN);
    let ptr = alloc::alloc::alloc(layout);

    if ptr.is_null() {
        return ptr::null_mut();
    }
    // Store size for free/realloc; pointer returned is offset by ALIGN.
    *ptr.cast::<usize>() = size;

    ptr.add(ALIGN).cast()
}

#[no_mangle]
pub unsafe extern "C" fn rust_sqlite_wasm_free(ptr: *mut c_void) {
    // Only accepts pointers allocated by rust_sqlite_wasm_malloc/realloc.
    let ptr: *mut u8 = ptr.sub(ALIGN).cast();
    let size = *(ptr.cast::<usize>());

    let layout = core::alloc::Layout::from_size_align_unchecked(size + ALIGN, ALIGN);
    alloc::alloc::dealloc(ptr, layout);
}

#[no_mangle]
pub unsafe extern "C" fn rust_sqlite_wasm_realloc(
    ptr: *mut c_void,
    new_size: c_size_t,
) -> *mut c_void {
    // Only accepts pointers allocated by rust_sqlite_wasm_malloc/realloc.
    let ptr: *mut u8 = ptr.sub(ALIGN).cast();
    let size = *(ptr.cast::<usize>());

    let layout = core::alloc::Layout::from_size_align_unchecked(size + ALIGN, ALIGN);
    let ptr = alloc::alloc::realloc(ptr, layout, new_size + ALIGN);

    if ptr.is_null() {
        return ptr::null_mut();
    }
    *ptr.cast::<usize>() = new_size;

    ptr.add(ALIGN).cast()
}

#[no_mangle]
pub unsafe extern "C" fn rust_sqlite_wasm_calloc(num: c_size_t, size: c_size_t) -> *mut c_void {
    let total = num * size;
    let ptr: *mut u8 = rust_sqlite_wasm_malloc(total).cast();
    if !ptr.is_null() {
        ptr::write_bytes(ptr, 0, total);
    }
    ptr.cast()
}

/// SQLite OS initialization entry point.
///
/// This function is called by SQLite when it is initialized. It sets up the
/// default VFS for the environment, which in this case is the in-memory VFS.
#[no_mangle]
pub unsafe extern "C" fn sqlite3_os_init() -> core::ffi::c_int {
    rsqlite_vfs::memvfs::install::<WasmOsCallback>();
    crate::bindings::SQLITE_OK
}

/// SQLite OS shutdown entry point.
///
/// This function is called by SQLite when it is shut down. It cleans up
/// any resources allocated by `sqlite3_os_init`.
#[no_mangle]
pub unsafe extern "C" fn sqlite3_os_end() -> core::ffi::c_int {
    rsqlite_vfs::memvfs::uninstall();
    crate::bindings::SQLITE_OK
}

#[cfg(test)]
mod tests {
    use super::*;
    use core::ffi::CStr;

    use crate::{
        sqlite3_column_count, sqlite3_column_name, sqlite3_column_text, sqlite3_column_type,
        sqlite3_initialize, sqlite3_open, sqlite3_prepare_v3, sqlite3_shutdown, sqlite3_step,
        SQLITE_OK, SQLITE_ROW, SQLITE_TEXT,
    };

    use wasm_bindgen_test::{console_log, wasm_bindgen_test};

    #[wasm_bindgen_test]
    fn test_initialize_shutdown() {
        unsafe {
            assert_eq!(sqlite3_initialize(), SQLITE_OK, "failed to initialize");
            assert_eq!(sqlite3_shutdown(), SQLITE_OK, "failed to shutdown");
        }
    }

    #[wasm_bindgen_test]
    fn test_random_get() {
        let mut buf = [0u8; 10];
        unsafe { rust_sqlite_wasm_getentropy(buf.as_mut_ptr(), buf.len()) };
        console_log!("test_random_get: {buf:?}");
    }

    #[wasm_bindgen_test]
    fn test_memory() {
        unsafe {
            let ptr1 = rust_sqlite_wasm_malloc(10);
            let ptr2 = rust_sqlite_wasm_realloc(ptr1, 100);
            rust_sqlite_wasm_free(ptr2);
            console_log!("test_memory: {ptr1:?} {ptr2:?}");

            let ptr: *mut u8 = rust_sqlite_wasm_calloc(2, 8).cast();
            let buf = core::slice::from_raw_parts(ptr, 2 * 8);

            assert!(buf.iter().all(|&x| x == 0));
        }
    }

    #[wasm_bindgen_test]
    fn test_localtime_sqlite() {
        unsafe {
            let mut db = core::ptr::null_mut();
            let ret = sqlite3_open(c":memory:".as_ptr().cast(), &mut db as *mut _);
            assert_eq!(ret, SQLITE_OK);
            let mut stmt = core::ptr::null_mut();
            let ret = sqlite3_prepare_v3(
                db,
                c"SELECT datetime('now', 'localtime');".as_ptr().cast(),
                -1,
                0,
                &mut stmt as *mut _,
                core::ptr::null_mut(),
            );
            assert_eq!(ret, SQLITE_OK);
            while sqlite3_step(stmt) == SQLITE_ROW {
                let count = sqlite3_column_count(stmt);
                for col in 0..count {
                    let name = sqlite3_column_name(stmt, col);
                    let ty = sqlite3_column_type(stmt, col);
                    assert_eq!(ty, SQLITE_TEXT);
                    console_log!(
                        "col {:?}, time: {:?}",
                        CStr::from_ptr(name),
                        CStr::from_ptr(sqlite3_column_text(stmt, col).cast())
                    );
                }
            }
        }
    }

    #[wasm_bindgen_test]
    fn test_localtime() {
        let mut tm = tm {
            tm_sec: 0,
            tm_min: 0,
            tm_hour: 0,
            tm_mday: 0,
            tm_mon: 0,
            tm_year: 0,
            tm_wday: 0,
            tm_yday: 0,
            tm_isdst: 0,
            tm_gmtoff: 0,
            tm_zone: core::ptr::null_mut(),
        };
        unsafe {
            localtime_js(1733976732, &mut tm as *mut tm);
        };
        let gmtoff = tm.tm_gmtoff / 3600;

        assert_eq!(tm.tm_year, 2024 - 1900);
        assert_eq!(tm.tm_mon, 12 - 1);
        assert_eq!(tm.tm_mday, 12);
        assert_eq!(tm.tm_hour as core::ffi::c_long, 12 - 8 + gmtoff);
        assert_eq!(tm.tm_min, 12);
        assert_eq!(tm.tm_sec, 12);
        assert_eq!(tm.tm_wday, 4);
        assert_eq!(tm.tm_yday, 346);
    }
}