wasmer 7.1.0

//! Data types, functions and traits for `sys` runtime's `Engine` implementation.

use std::{path::Path, sync::Arc};

use shared_buffer::OwnedBuffer;
pub use wasmer_compiler::{Artifact, BaseTunables, Engine, EngineBuilder, Tunables};
use wasmer_types::{CompilationProgressCallback, DeserializeError, Features, target::Target};

use crate::{BackendEngine, BackendModule};

/// Get the default config for the sys Engine
#[allow(unreachable_code)]
#[cfg(feature = "compiler")]
pub fn get_default_compiler_config() -> Option<Box<dyn wasmer_compiler::CompilerConfig>> {
    cfg_if::cfg_if! {
        if #[cfg(feature = "cranelift")] {
            Some(Box::<wasmer_compiler_cranelift::Cranelift>::default())
        } else if #[cfg(feature = "llvm")] {
            Some(Box::<wasmer_compiler_llvm::LLVM>::default())
        } else if #[cfg(feature = "singlepass")] {
            Some(Box::<wasmer_compiler_singlepass::Singlepass>::default())
        }
        else {
            None
        }
    }
}

/// Returns the default engine for the Sys engine
pub fn default_engine() -> Engine {
    #[cfg(feature = "compiler")]
    fn get_engine() -> Engine {
        if let Some(config) = get_default_compiler_config() {
            EngineBuilder::new(config).engine()
        } else {
            EngineBuilder::headless().engine()
        }
    }

    #[cfg(not(feature = "compiler"))]
    fn get_engine() -> Engine {
        EngineBuilder::headless().engine()
    }

    let mut engine = get_engine();
    let tunables = BaseTunables::for_target(engine.target());
    engine.set_tunables(tunables);
    engine
}

/// The custom trait to access to all the `sys` function in the common
/// engine.
pub trait NativeEngineExt {
    /// Create a new `Engine` with the given config
    #[cfg(feature = "compiler")]
    fn new(
        compiler_config: Box<dyn wasmer_compiler::CompilerConfig>,
        target: Target,
        features: Features,
    ) -> Self;

    /// Create a headless `Engine`
    ///
    /// A headless engine is an engine without any compiler attached.
    /// This is useful for assuring a minimal runtime for running
    /// WebAssembly modules.
    ///
    /// For example, for running in IoT devices where compilers are very
    /// expensive, or also to optimize startup speed.
    ///
    /// # Important
    ///
    /// Headless engines can't compile or validate any modules,
    /// they just take already processed Modules (via `Module::serialize`).
    fn headless() -> Self;

    /// Gets the target
    fn target(&self) -> &Target;

    /// Attach a Tunable to this engine
    fn set_tunables(&mut self, tunables: impl Tunables + Send + Sync + 'static);

    /// Get a reference to attached Tunable of this engine
    fn tunables(&self) -> &dyn Tunables;

    /// Compile a module from bytes with a progress callback.
    ///
    /// The callback is invoked with progress updates during the compilation process.
    /// The callback also may return an error to abort the compilation.
    ///
    /// Signature of the callback function: `Fn(CompilationProgress) -> Result<(), UserAbort> + Send + Sync + 'static`
    ///
    /// # Aborting compilation
    ///
    /// The callback has to return a `Result<(), UserAbort>`.
    ///
    /// If the callback returns an error, the compilation will fail with a `CompileError::Aborted`.
    fn new_module_with_progress(
        &self,
        bytes: &[u8],
        on_progress: CompilationProgressCallback,
    ) -> Result<crate::Module, wasmer_types::CompileError>;

    /// Load a serialized WebAssembly module from a memory mapped file and deserialize it.
    ///
    /// NOTE: you should almost always prefer [`Self::deserialize_from_mmapped_file`].
    ///
    /// # Safety
    /// See [`Artifact::deserialize_unchecked`].
    unsafe fn deserialize_from_mmapped_file_unchecked(
        &self,
        file_ref: &Path,
    ) -> Result<crate::Module, DeserializeError>;

    /// Load a serialized WebAssembly module from a memory mapped file and deserialize it.
    ///
    /// # Safety
    /// See [`Artifact::deserialize`].
    unsafe fn deserialize_from_mmapped_file(
        &self,
        file_ref: &Path,
    ) -> Result<crate::Module, DeserializeError>;
}

impl NativeEngineExt for crate::engine::Engine {
    #[cfg(feature = "compiler")]
    fn new(
        compiler_config: Box<dyn wasmer_compiler::CompilerConfig>,
        target: Target,
        features: Features,
    ) -> Self {
        Self {
            be: BackendEngine::Sys(Engine::new(compiler_config, target, features)),
            id: Self::atomic_next_engine_id(),
        }
    }

    fn headless() -> Self {
        Self {
            be: BackendEngine::Sys(Engine::headless()),
            id: Self::atomic_next_engine_id(),
        }
    }

    fn target(&self) -> &Target {
        match self.be {
            BackendEngine::Sys(ref s) => s.target(),
            _ => panic!("Not a `sys` engine!"),
        }
    }

    fn set_tunables(&mut self, tunables: impl Tunables + Send + Sync + 'static) {
        match self.be {
            BackendEngine::Sys(ref mut s) => s.set_tunables(tunables),
            _ => panic!("Not a `sys` engine!"),
        }
    }

    fn tunables(&self) -> &dyn Tunables {
        match self.be {
            BackendEngine::Sys(ref s) => s.tunables(),
            _ => panic!("Not a `sys` engine!"),
        }
    }

    fn new_module_with_progress(
        &self,
        bytes: &[u8],
        on_progress: CompilationProgressCallback,
    ) -> Result<crate::Module, wasmer_types::CompileError> {
        crate::BackendModule::new_with_progress(self, bytes, on_progress).map(crate::Module)
    }

    unsafe fn deserialize_from_mmapped_file_unchecked(
        &self,
        file_ref: &Path,
    ) -> Result<crate::Module, DeserializeError> {
        let file = std::fs::File::open(file_ref)?;
        let buffer = OwnedBuffer::from_file(&file)
            .map_err(|e| DeserializeError::Generic(format!("{e:?}")))?;
        let artifact = unsafe { Arc::new(Artifact::deserialize_unchecked(self.as_sys(), buffer)?) };
        Ok(crate::Module(BackendModule::Sys(
            super::module::Module::from_artifact(artifact),
        )))
    }

    unsafe fn deserialize_from_mmapped_file(
        &self,
        file_ref: &Path,
    ) -> Result<crate::Module, DeserializeError> {
        let file = std::fs::File::open(file_ref)?;
        let buffer = OwnedBuffer::from_file(&file)
            .map_err(|e| DeserializeError::Generic(format!("{e:?}")))?;
        let artifact = unsafe { Arc::new(Artifact::deserialize(self.as_sys(), buffer)?) };
        Ok(crate::Module(BackendModule::Sys(
            super::module::Module::from_artifact(artifact),
        )))
    }
}

impl crate::Engine {
    /// Consume [`self`] into a [`crate::backend::sys::engine::Engine`].
    pub fn into_sys(self) -> crate::backend::sys::engine::Engine {
        match self.be {
            BackendEngine::Sys(s) => s,
            _ => panic!("Not a `sys` engine!"),
        }
    }

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

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

    /// Return true if [`self`] is an engine from the `sys` runtime.
    pub fn is_sys(&self) -> bool {
        matches!(self.be, BackendEngine::Sys(_))
    }
}

impl From<Engine> for crate::Engine {
    fn from(value: Engine) -> Self {
        Self {
            be: BackendEngine::Sys(value),
            id: Self::atomic_next_engine_id(),
        }
    }
}

impl From<&Engine> for crate::Engine {
    fn from(value: &Engine) -> Self {
        Self {
            be: BackendEngine::Sys(value.cloned()),
            id: Self::atomic_next_engine_id(),
        }
    }
}

impl From<EngineBuilder> for crate::Engine {
    fn from(value: EngineBuilder) -> Self {
        Self {
            be: BackendEngine::Sys(value.engine()),
            id: Self::atomic_next_engine_id(),
        }
    }
}

#[cfg(feature = "cranelift")]
impl From<wasmer_compiler_cranelift::Cranelift> for crate::Engine {
    fn from(value: wasmer_compiler_cranelift::Cranelift) -> Self {
        Self {
            be: BackendEngine::Sys(value.into()),
            id: Self::atomic_next_engine_id(),
        }
    }
}

#[cfg(feature = "singlepass")]
impl From<wasmer_compiler_singlepass::Singlepass> for crate::Engine {
    fn from(value: wasmer_compiler_singlepass::Singlepass) -> Self {
        Self {
            be: BackendEngine::Sys(value.into()),
            id: Self::atomic_next_engine_id(),
        }
    }
}

#[cfg(feature = "llvm")]
impl From<wasmer_compiler_llvm::LLVM> for crate::Engine {
    fn from(value: wasmer_compiler_llvm::LLVM) -> Self {
        Self {
            be: BackendEngine::Sys(value.into()),
            id: Self::atomic_next_engine_id(),
        }
    }
}