wasi_virt_layer 0.3.0

use crate::{__private::wasip1::*, memory::WasmAccessName};
#[cfg(target_os = "wasi")]
use const_for::const_for;
use const_struct::*;

use crate::memory::WasmAccess;

/// @embedded or @dynamic
/// Whether to import JavaScript runtime env from vfs,
/// env is automatically imported even if you are not using it,
/// so that you can block it
///
/// @embedded or @dynamic
/// Whether to use embedded or dynamic env.
/// @embedded if using embedded env.
/// @dynamic if using dynamic env.
/// @embedded is faster and small than @dynamic.
///
/// ```rust
/// // @embedded
/// import_wasm!(test_wasm);
///
/// use const_struct::*;
/// use wasi_virt_layer::prelude::*;
/// #[const_struct]
/// const VIRTUAL_ENV: VirtualEnvEmbeddedState = VirtualEnvEmbeddedState {
///     environ: &["RUST_MIN_STACK=16777216", "HOME=~/"],
/// };
/// plug_env!(@embedded, VirtualEnvTy, test_wasm);
/// ```
///
/// ```rust
/// // @dynamic
/// import_wasm!(test_wasm);
///
/// use std::sync::{LazyLock, Mutex};
/// use wasi_virt_layer::prelude::*;
///
/// struct VirtualEnvState {
///    environ: Vec<String>,
/// }
/// impl<'a> VirtualEnv<'a> for VirtualEnvState {
///    type Str = String;
///
///   fn get_environ(&mut self) -> &[Self::Str] {
///       &self.environ
///   }
/// }
/// static VIRTUAL_ENV: LazyLock<Mutex<VirtualEnvState>> = LazyLock::new(|| {
///    let mut environ = Vec::<String>::new();
///   environ.push("RUST_MIN_STACK=16777216".into());
///   environ.push("HOME=~/".into());
///   Mutex::new(VirtualEnvState { environ })
/// });
/// plug_env!(@dynamic, &mut VIRTUAL_ENV.lock().unwrap(), test_wasm);
/// ```
/// Plugs the environment variable ecosystem.
#[macro_export]
macro_rules! plug_env {
    (@embedded, $ty:ty, $($wasm:ident),* $(,)?) => {
        $crate::__as_t!(@through, $($wasm),* => $crate::plug_env, @inner, @embedded, $ty);
    };

    (@dynamic, $state:expr, $($wasm:ident),* $(,)?) => {
        $crate::__as_t!(@through, $($wasm),* => $crate::plug_env, @inner, @dynamic, $state);
    };

    (@inner, @embedded, $ty:ty, $($wasm:ident),*) => {
        const _: () = {
            type __TYPE = $ty;
        };

        $crate::__private::paste::paste! {
            $(
                #[unsafe(no_mangle)]
                #[cfg(target_os = "wasi")]
                pub unsafe extern "C" fn [<__wasip1_vfs_ $wasm _environ_sizes_get>](
                    environ_count: *mut $crate::__private::wasip1::Size,
                    environ_buf_size: *mut $crate::__private::wasip1::Size,
                ) -> $crate::__private::wasip1::Errno {
                    $crate::__as_t!(@as_t, $wasm);
                    $crate::__private::inner::env::environ_sizes_get_embedded_inner::<$ty, T>(environ_count, environ_buf_size)
                }

                #[cfg(target_os = "wasi")]
                #[unsafe(no_mangle)]
                pub unsafe extern "C" fn [<__wasip1_vfs_ $wasm _environ_get>](
                    environ: *mut *const u8,
                    environ_buf: *mut u8,
                ) -> $crate::__private::wasip1::Errno {
                    $crate::__as_t!(@as_t, $wasm);
                    $crate::__private::inner::env::environ_get_embedded_inner::<$ty, T>(environ, environ_buf)
                }
            )*
        }
    };

    (@inner, @dynamic, $state:expr, $($wasm:ident),*) => {
        const _: () = {
            let _ = || { let _ = $state; };
        };

        $crate::__private::paste::paste! {
            $(
                #[cfg(target_os = "wasi")]
                #[unsafe(no_mangle)]
                pub unsafe extern "C" fn [<__wasip1_vfs_ $wasm _environ_sizes_get>](
                    environ_count: *mut $crate::__private::wasip1::Size,
                    environ_buf_size: *mut $crate::__private::wasip1::Size,
                ) -> $crate::__private::wasip1::Errno {
                    $crate::__as_t!(@as_t, $wasm);
                    let state = $state;
                    $crate::__private::inner::env::environ_sizes_get_inner::<T>(state, environ_count, environ_buf_size)
                }

                #[cfg(target_os = "wasi")]
                #[unsafe(no_mangle)]
                pub unsafe extern "C" fn [<__wasip1_vfs_ $wasm _environ_get>](
                    environ: *mut *const u8,
                    environ_buf: *mut u8,
                ) -> $crate::__private::wasip1::Errno {
                    $crate::__as_t!(@as_t, $wasm);
                    let state = $state;
                    $crate::__private::inner::env::environ_get_inner::<T>(state, environ, environ_buf)
                }
            )*
        }
    };
}

/// A structure holding constant environment variables.
#[const_struct]
pub struct VirtualEnvEmbeddedState {
    /// The environment variables as a slice of name-value pairs (e.g., "KEY=VALUE").
    pub environ: &'static [&'static str],
}

/// Inner function for retrieving constant environment variable sizes.
#[inline]
#[cfg(target_os = "wasi")]
pub fn environ_sizes_get_embedded_inner<
    T: PrimitiveTraits<DATATYPE = VirtualEnvEmbeddedState>,
    Wasm: WasmAccess,
>(
    environ_count: *mut Size,
    environ_buf_size: *mut Size,
) -> Errno {
    const fn inner<T: PrimitiveTraits<DATATYPE = VirtualEnvEmbeddedState>>() -> (Size, Size) {
        let mut size = 0;
        let mut count = 0;
        const_for!(i in 0..T::__DATA.environ.len() => {
            let len = T::__DATA.environ[i].len() + 1; // +1 for null terminator
            size += len;
            count += 1;
        });

        (size, count)
    }

    Wasm::store_le(environ_buf_size, inner::<T>().0);
    Wasm::store_le(environ_count, inner::<T>().1);
    ERRNO_SUCCESS
}

/// Inner function for retrieving constant environment variables.
#[inline]
#[cfg(target_os = "wasi")]
pub fn environ_get_embedded_inner<
    T: PrimitiveTraits<DATATYPE = VirtualEnvEmbeddedState>,
    Wasm: WasmAccess,
>(
    environ: *mut *const u8,
    environ_buf: *mut u8,
) -> Errno {
    let mut environ = environ;
    let mut environ_buf = environ_buf;

    const_for!(i in 0..T::__DATA.environ.len() => {
        Wasm::store_le(environ, environ_buf as *const u8);

        Wasm::memcpy(environ_buf, T::__DATA.environ[i].as_bytes());
        Wasm::store_le(unsafe { environ_buf.add(T::__DATA.environ[i].len()) }, 0u8);

        environ = unsafe { environ.add(1) };
        environ_buf = unsafe { environ_buf.add(T::__DATA.environ[i].len() + 1) };
    });

    ERRNO_SUCCESS
}

/// Inner function for retrieving constant environment variable sizes.
#[inline]
#[cfg(target_os = "wasi")]
pub fn environ_sizes_get_const_inner<
    T: PrimitiveTraits<DATATYPE = VirtualEnvEmbeddedState>,
    Wasm: WasmAccess,
>(
    environ_count: *mut Size,
    environ_buf_size: *mut Size,
) -> Errno {
    const fn inner<T: PrimitiveTraits<DATATYPE = VirtualEnvEmbeddedState>>() -> (Size, Size) {
        let mut size = 0;
        let mut count = 0;
        const_for!(i in 0..T::__DATA.environ.len() => {
            let len = T::__DATA.environ[i].len() + 1; // +1 for null terminator
            size += len;
            count += 1;
        });

        (size, count)
    }

    Wasm::store_le(environ_buf_size, inner::<T>().0);
    Wasm::store_le(environ_count, inner::<T>().1);
    ERRNO_SUCCESS
}

/// Inner function for retrieving constant environment variables.
#[inline]
#[cfg(target_os = "wasi")]
pub fn environ_get_const_inner<
    T: PrimitiveTraits<DATATYPE = VirtualEnvEmbeddedState>,
    Wasm: WasmAccess,
>(
    environ: *mut *const u8,
    environ_buf: *mut u8,
) -> Errno {
    let mut environ = environ;
    let mut environ_buf = environ_buf;

    const_for!(i in 0..T::__DATA.environ.len() => {
        Wasm::store_le(environ, environ_buf as *const u8);

        Wasm::memcpy(environ_buf, T::__DATA.environ[i].as_bytes());
        Wasm::store_le(unsafe { environ_buf.add(T::__DATA.environ[i].len()) }, 0u8);

        environ = unsafe { environ.add(1) };
        environ_buf = unsafe { environ_buf.add(T::__DATA.environ[i].len() + 1) };
    });

    ERRNO_SUCCESS
}

/// Trait for a virtual environment implementation.
pub trait VirtualEnv<'a> {
    /// The type used for environment variable strings.
    type Str: AsRef<str>;

    /// Returns the environment variables.
    fn get_environ(&'a mut self) -> &'a [Self::Str];

    /// Returns the sizes of the environment variables.
    fn environ_sizes_get(&'a mut self) -> (Size, Size) {
        let environ = self.get_environ();
        let mut size = 0;
        let mut count = 0;
        for env in environ {
            let len = env.as_ref().len() + 1; // +1 for null terminator
            size += len;
            count += 1;
        }

        (size, count)
    }

    /// Copies the environment variables into the provided buffers.
    fn environ_get<Wasm: WasmAccess + WasmAccessName + 'static>(
        &'a mut self,
        environ: *mut *const u8,
        environ_buf: *mut u8,
    ) -> Errno {
        let mut environ = environ;
        let mut environ_buf = environ_buf;

        for env in self.get_environ() {
            Wasm::store_le(environ, environ_buf as *const u8);

            Wasm::memcpy(environ_buf, env.as_ref().as_bytes());
            Wasm::store_le(
                unsafe { environ_buf.add(env.as_ref().len()) as *mut u8 },
                0u8,
            );

            environ = unsafe { environ.add(1) };
            environ_buf = unsafe { environ_buf.add(env.as_ref().len() + 1) };
        }

        ERRNO_SUCCESS
    }
}

impl<'a, T: core::ops::DerefMut<Target = U>, U: VirtualEnv<'a> + 'a> VirtualEnv<'a> for T {
    type Str = U::Str;

    fn get_environ(&'a mut self) -> &'a [Self::Str] {
        self.deref_mut().get_environ()
    }

    fn environ_sizes_get(&'a mut self) -> (Size, Size) {
        self.deref_mut().environ_sizes_get()
    }
}

/// Inner function for retrieving dynamic environment variable sizes.
#[cfg(target_os = "wasi")]
pub fn environ_sizes_get_inner<'a, Wasm: WasmAccess + WasmAccessName + 'static>(
    state: &'a mut impl VirtualEnv<'a>,
    environ_count: *mut Size,
    environ_buf_size: *mut Size,
) -> Errno {
    let (size, count) = state.environ_sizes_get();

    Wasm::store_le(environ_buf_size, size);
    Wasm::store_le(environ_count, count);

    ERRNO_SUCCESS
}

/// Inner function for retrieving dynamic environment variables.
#[inline]
#[cfg(target_os = "wasi")]
pub fn environ_get_inner<'a, Wasm: WasmAccess + WasmAccessName + 'static>(
    state: &'a mut impl VirtualEnv<'a>,
    environ: *mut *const u8,
    environ_buf: *mut u8,
) -> Errno {
    state.environ_get::<Wasm>(environ, environ_buf)
}