wasmer 7.1.0

//! Data types, functions and traits for `sys` runtime's `Module` implementation.
use std::path::Path;
use std::sync::Arc;

use bytes::Bytes;
use wasmer_compiler::{Artifact, ArtifactCreate, Engine};
use wasmer_types::{
    CompilationProgressCallback, CompileError, DeserializeError, ExportType, ExportsIterator,
    ImportType, ImportsIterator, ModuleInfo, SerializeError,
};

use crate::{
    AsStoreMut, AsStoreRef, BackendModule, IntoBytes, StoreContext,
    backend::sys::entities::engine::NativeEngineExt, engine::AsEngineRef,
    error::InstantiationError, vm::VMInstance,
};
use wasmer_vm::StoreHandle;

#[derive(Clone, PartialEq, Eq)]
#[cfg_attr(feature = "artifact-size", derive(loupe::MemoryUsage))]
/// A WebAssembly `module` in the `sys` runtime.
pub struct Module {
    // The field ordering here is actually significant because of the drop
    // order: we want to drop the artifact before dropping the engine.
    //
    // The reason for this is that dropping the Artifact will de-register the
    // trap handling metadata from the global registry. This must be done before
    // the code memory for the artifact is freed (which happens when the store
    // is dropped) since there is a chance that this memory could be reused by
    // another module which will try to register its own trap information.
    //
    // Note that in Rust, the drop order for struct fields is from top to
    // bottom: the opposite of C++.
    //
    // In the future, this code should be refactored to properly describe the
    // ownership of the code and its metadata.
    artifact: Arc<Artifact>,
}

impl Module {
    pub(crate) fn from_binary(
        engine: &impl AsEngineRef,
        binary: &[u8],
    ) -> Result<Self, CompileError> {
        Self::validate(engine, binary)?;
        unsafe { Self::from_binary_unchecked(engine, binary) }
    }

    pub(crate) fn from_binary_with_progress(
        engine: &impl AsEngineRef,
        binary: &[u8],
        callback: CompilationProgressCallback,
    ) -> Result<Self, CompileError> {
        Self::validate(engine, binary)?;

        let artifact = engine
            .as_engine_ref()
            .engine()
            .as_sys()
            .compile_with_progress(binary, Some(callback))?;
        Ok(Self::from_artifact(artifact))
    }

    pub(crate) unsafe fn from_binary_unchecked(
        engine: &impl AsEngineRef,
        binary: &[u8],
    ) -> Result<Self, CompileError> {
        Self::compile(engine, binary)
    }

    #[cfg(feature = "compiler")]
    #[tracing::instrument(level = "debug", skip_all)]
    pub(crate) fn validate(engine: &impl AsEngineRef, binary: &[u8]) -> Result<(), CompileError> {
        engine.as_engine_ref().engine().as_sys().validate(binary)
    }

    #[cfg(not(feature = "compiler"))]
    pub(crate) fn validate(_engine: &impl AsEngineRef, _binary: &[u8]) -> Result<(), CompileError> {
        Err(CompileError::UnsupportedTarget(
            "The compiler feature is not enabled, but is required to validate a Module".to_string(),
        ))
    }

    #[cfg(feature = "compiler")]
    fn compile(engine: &impl AsEngineRef, binary: &[u8]) -> Result<Self, CompileError> {
        let artifact = engine.as_engine_ref().engine().as_sys().compile(binary)?;
        Ok(Self::from_artifact(artifact))
    }

    #[cfg(not(feature = "compiler"))]
    fn compile(_engine: &impl AsEngineRef, _binary: &[u8]) -> Result<Self, CompileError> {
        Err(CompileError::UnsupportedTarget(
            "The compiler feature is not enabled, but is required to compile a Module".to_string(),
        ))
    }

    pub(crate) fn serialize(&self) -> Result<Bytes, SerializeError> {
        self.artifact.serialize().map(|bytes| bytes.into())
    }

    #[tracing::instrument(level = "debug", skip_all)]
    pub(crate) unsafe fn deserialize_unchecked(
        engine: &impl AsEngineRef,
        bytes: impl IntoBytes,
    ) -> Result<Self, DeserializeError> {
        let bytes = bytes.into_bytes();

        let artifact = unsafe {
            engine
                .as_engine_ref()
                .engine()
                .as_sys()
                .deserialize_unchecked(bytes.into())?
        };
        Ok(Self::from_artifact(artifact))
    }

    #[tracing::instrument(level = "debug", skip_all)]
    pub(crate) unsafe fn deserialize(
        engine: &impl AsEngineRef,
        bytes: impl IntoBytes,
    ) -> Result<Self, DeserializeError> {
        let bytes = bytes.into_bytes();
        let artifact = unsafe {
            engine
                .as_engine_ref()
                .engine()
                .as_sys()
                .deserialize(bytes.into())?
        };
        Ok(Self::from_artifact(artifact))
    }

    pub(crate) unsafe fn deserialize_from_file_unchecked(
        engine: &impl AsEngineRef,
        path: impl AsRef<Path>,
    ) -> Result<Self, DeserializeError> {
        let artifact = unsafe {
            engine
                .as_engine_ref()
                .engine()
                .as_sys()
                .deserialize_from_file_unchecked(path.as_ref())?
        };
        Ok(Self::from_artifact(artifact))
    }

    pub(crate) unsafe fn deserialize_from_file(
        engine: &impl AsEngineRef,
        path: impl AsRef<Path>,
    ) -> Result<Self, DeserializeError> {
        let artifact = unsafe {
            engine
                .as_engine_ref()
                .engine()
                .as_sys()
                .deserialize_from_file(path.as_ref())?
        };
        Ok(Self::from_artifact(artifact))
    }

    pub(super) fn from_artifact(artifact: Arc<Artifact>) -> Self {
        Self { artifact }
    }

    #[allow(clippy::result_large_err)]
    pub(crate) fn instantiate(
        &self,
        store: &mut impl AsStoreMut,
        imports: &[crate::Extern],
    ) -> Result<VMInstance, InstantiationError> {
        if !self.artifact.allocated() {
            // Return an error mentioning that the artifact is compiled for a different
            // platform.
            return Err(InstantiationError::DifferentArchOS);
        }
        // Ensure all imports come from the same context.
        for import in imports {
            if !import.is_from_store(store) {
                return Err(InstantiationError::DifferentStores);
            }
        }
        let signal_handler = store.as_store_ref().signal_handler();
        let mut store_mut = store.as_store_mut();
        let store_ptr = store_mut.inner as *mut _;
        let (engine, objects) = store_mut.engine_and_objects_mut();
        let config = engine.tunables().vmconfig();
        unsafe {
            let mut instance_handle = self.artifact.instantiate(
                engine.tunables(),
                &imports
                    .iter()
                    .map(|e| crate::Extern::to_vm_extern(e).into_sys())
                    .collect::<Vec<_>>(),
                objects.as_sys_mut(),
            )?;

            let store_id = objects.id();
            let store_install_guard = StoreContext::ensure_installed(store_ptr);

            // After the instance handle is created, we need to initialize
            // the data, call the start function and so. However, if any
            // of this steps traps, we still need to keep the instance alive
            // as some of the Instance elements may have placed in other
            // instance tables.
            if let Err(err) =
                self.artifact
                    .finish_instantiation(config, signal_handler, &mut instance_handle)
            {
                // Keep the partially initialized instance alive: its funcrefs may already
                // have been written into imported tables.
                let _ = StoreHandle::new(objects.as_sys_mut(), instance_handle);
                return Err(err.into());
            }

            drop(store_install_guard);

            Ok(VMInstance::Sys(instance_handle))
        }
    }

    pub(crate) fn name(&self) -> Option<&str> {
        self.info().name.as_deref()
    }

    pub(crate) fn set_name(&mut self, name: &str) -> bool {
        Arc::get_mut(&mut self.artifact)
            .is_some_and(|artifact| artifact.set_module_info_name(name.to_string()))
    }

    pub(crate) fn imports(&self) -> ImportsIterator<Box<dyn Iterator<Item = ImportType> + '_>> {
        self.info().imports()
    }

    pub(crate) fn exports(&self) -> ExportsIterator<Box<dyn Iterator<Item = ExportType> + '_>> {
        self.info().exports()
    }

    pub(crate) fn custom_sections<'a>(
        &'a self,
        name: &'a str,
    ) -> Box<dyn Iterator<Item = Box<[u8]>> + 'a> {
        self.info().custom_sections(name)
    }

    pub(crate) fn info(&self) -> &ModuleInfo {
        self.artifact.module_info()
    }
}

impl crate::Module {
    /// Consume [`self`] into a reference [`crate::backend::sys::module::Module`].
    pub fn into_sys(self) -> crate::backend::sys::module::Module {
        match self.0 {
            BackendModule::Sys(s) => s,
            _ => panic!("Not a `sys` module!"),
        }
    }

    /// Convert a reference to [`self`] into a reference [`crate::backend::sys::module::Module`].
    pub fn as_sys(&self) -> &crate::backend::sys::module::Module {
        match self.0 {
            BackendModule::Sys(ref s) => s,
            _ => panic!("Not a `sys` module!"),
        }
    }

    /// Convert a mutable reference to [`self`] into a mutable reference [`crate::backend::sys::module::Module`].
    pub fn as_sys_mut(&mut self) -> &mut crate::backend::sys::module::Module {
        match self.0 {
            BackendModule::Sys(ref mut s) => s,
            _ => panic!("Not a `sys` module!"),
        }
    }
}