mirror of
https://github.com/extism/extism.git
synced 2026-01-09 13:57:55 -05:00
Fixes https://github.com/extism/extism/issues/537 - Requires wasmtime 14.0.0 or greater for coredump serialization - Adds `EXTISM_COREDUMP` environment variable to write wasmtime coredump to a file when an error occurs - This will create a coredump from the main wasm module, which means it doesn't give us too much insight into the kernel - Adds `EXTISM_MEMDUMP` environment variable to write extism linear memory to a file when an error occurs - This gives us access to the kernel memory - Adds some missing profiling options - Converts timeouts to a Trap instead of a plain error, this helps us get better information about where the timeout occured - Some small improvements to error handling after a plugin call - Adds a test for coredump and memdump generation - Adds the ability to configure debug options using `PluginBuilder` - Fixes memory layout and a wasted page of memory in the kernel, found while debugging a memory dump --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: zshipko <zshipko@users.noreply.github.com>
837 lines
28 KiB
Rust
837 lines
28 KiB
Rust
use std::collections::BTreeMap;
|
|
|
|
use crate::*;
|
|
|
|
#[derive(Default, Clone)]
|
|
pub(crate) struct Output {
|
|
pub(crate) offset: u64,
|
|
pub(crate) length: u64,
|
|
pub(crate) error_offset: u64,
|
|
pub(crate) error_length: u64,
|
|
}
|
|
|
|
/// A `CancelHandle` can be used to cancel a running plugin from another thread
|
|
#[derive(Clone)]
|
|
pub struct CancelHandle {
|
|
pub(crate) timer_tx: std::sync::mpsc::Sender<TimerAction>,
|
|
pub id: uuid::Uuid,
|
|
}
|
|
|
|
unsafe impl Sync for CancelHandle {}
|
|
unsafe impl Send for CancelHandle {}
|
|
|
|
impl CancelHandle {
|
|
pub fn cancel(&self) -> Result<(), Error> {
|
|
self.timer_tx.send(TimerAction::Cancel { id: self.id })?;
|
|
Ok(())
|
|
}
|
|
}
|
|
|
|
/// Plugin contains everything needed to execute a WASM function
|
|
pub struct Plugin {
|
|
/// A unique ID for each plugin
|
|
pub id: uuid::Uuid,
|
|
|
|
/// Wasmtime linker
|
|
pub(crate) linker: Linker<CurrentPlugin>,
|
|
|
|
/// Wasmtime store
|
|
pub(crate) store: Store<CurrentPlugin>,
|
|
|
|
/// A handle used to cancel execution of a plugin
|
|
pub(crate) cancel_handle: CancelHandle,
|
|
|
|
/// All modules that were provided to the linker
|
|
pub(crate) modules: BTreeMap<String, Module>,
|
|
|
|
/// Instance provides the ability to call functions in a module, a `Plugin` is initialized with
|
|
/// an `instance_pre` but no `instance`. The `instance` will be created during `Plugin::raw_call`
|
|
pub(crate) instance: std::sync::Arc<std::sync::Mutex<Option<Instance>>>,
|
|
pub(crate) instance_pre: InstancePre<CurrentPlugin>,
|
|
|
|
/// Keep track of the number of times we're instantiated, this exists
|
|
/// to avoid issues with memory piling up since `Instance`s are only
|
|
/// actually cleaned up along with a `Store`
|
|
instantiations: usize,
|
|
|
|
/// Runtime determines any initialization functions needed
|
|
/// to run a module
|
|
pub(crate) runtime: Option<GuestRuntime>,
|
|
|
|
/// Keep a reference to the host functions
|
|
_functions: Vec<Function>,
|
|
|
|
/// Communication with the timer thread
|
|
pub(crate) timer_tx: std::sync::mpsc::Sender<TimerAction>,
|
|
|
|
/// Information that gets populated after a call
|
|
pub(crate) output: Output,
|
|
|
|
/// Set to `true` when de-initializarion may have occured (i.e.a call to `_start`),
|
|
/// in this case we need to re-initialize the entire module.
|
|
pub(crate) needs_reset: bool,
|
|
|
|
pub(crate) debug_options: DebugOptions,
|
|
}
|
|
|
|
unsafe impl Send for Plugin {}
|
|
unsafe impl Sync for Plugin {}
|
|
|
|
impl std::fmt::Debug for Plugin {
|
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
|
write!(f, "Plugin({})", self.id)
|
|
}
|
|
}
|
|
|
|
impl Internal for Plugin {
|
|
fn store(&self) -> &Store<CurrentPlugin> {
|
|
&self.store
|
|
}
|
|
|
|
fn store_mut(&mut self) -> &mut Store<CurrentPlugin> {
|
|
&mut self.store
|
|
}
|
|
|
|
fn linker(&self) -> &Linker<CurrentPlugin> {
|
|
&self.linker
|
|
}
|
|
|
|
fn linker_mut(&mut self) -> &mut Linker<CurrentPlugin> {
|
|
&mut self.linker
|
|
}
|
|
|
|
fn linker_and_store(&mut self) -> (&mut Linker<CurrentPlugin>, &mut Store<CurrentPlugin>) {
|
|
(&mut self.linker, &mut self.store)
|
|
}
|
|
}
|
|
|
|
const EXPORT_MODULE_NAME: &str = "env";
|
|
|
|
fn profiling_strategy() -> ProfilingStrategy {
|
|
match std::env::var("EXTISM_PROFILE").as_deref() {
|
|
Ok("perf") => ProfilingStrategy::PerfMap,
|
|
Ok("jitdump") => ProfilingStrategy::JitDump,
|
|
Ok("vtune") => ProfilingStrategy::VTune,
|
|
Ok(x) => {
|
|
log::warn!("Invalid value for EXTISM_PROFILE: {x}");
|
|
ProfilingStrategy::None
|
|
}
|
|
Err(_) => ProfilingStrategy::None,
|
|
}
|
|
}
|
|
|
|
impl Plugin {
|
|
/// Create a new plugin from the given manifest, and host functions. The `with_wasi` parameter determines
|
|
/// whether or not the module should be executed with WASI enabled.
|
|
pub fn new_with_manifest(
|
|
manifest: &Manifest,
|
|
functions: impl IntoIterator<Item = Function>,
|
|
with_wasi: bool,
|
|
) -> Result<Plugin, Error> {
|
|
let data = serde_json::to_vec(manifest)?;
|
|
Self::new(data, functions, with_wasi)
|
|
}
|
|
|
|
/// Create a new plugin from the given WebAssembly module or JSON encoded manifest, and host functions. The `with_wasi`
|
|
/// parameter determines whether or not the module should be executed with WASI enabled.
|
|
pub fn new(
|
|
wasm: impl AsRef<[u8]>,
|
|
imports: impl IntoIterator<Item = Function>,
|
|
with_wasi: bool,
|
|
) -> Result<Plugin, Error> {
|
|
Self::build_new(wasm, imports, with_wasi, Default::default())
|
|
}
|
|
|
|
pub(crate) fn build_new(
|
|
wasm: impl AsRef<[u8]>,
|
|
imports: impl IntoIterator<Item = Function>,
|
|
with_wasi: bool,
|
|
mut debug_options: DebugOptions,
|
|
) -> Result<Plugin, Error> {
|
|
// Configure debug options
|
|
debug_options.debug_info =
|
|
debug_options.debug_info || std::env::var("EXTISM_DEBUG").is_ok();
|
|
if let Ok(x) = std::env::var("EXTISM_COREDUMP") {
|
|
debug_options.coredump = Some(std::path::PathBuf::from(x));
|
|
};
|
|
if let Ok(x) = std::env::var("EXTISM_MEMDUMP") {
|
|
debug_options.memdump = Some(std::path::PathBuf::from(x));
|
|
};
|
|
let profiling_strategy = debug_options
|
|
.profiling_strategy
|
|
.map_or(ProfilingStrategy::None, |_| profiling_strategy());
|
|
debug_options.profiling_strategy = Some(profiling_strategy.clone());
|
|
|
|
// Setup wasmtime types
|
|
let engine = Engine::new(
|
|
Config::new()
|
|
.epoch_interruption(true)
|
|
.debug_info(debug_options.debug_info)
|
|
.coredump_on_trap(debug_options.coredump.is_some())
|
|
.profiler(profiling_strategy),
|
|
)?;
|
|
let mut imports = imports.into_iter();
|
|
let (manifest, modules) = manifest::load(&engine, wasm.as_ref())?;
|
|
|
|
let available_pages = manifest.memory.max_pages;
|
|
log::trace!("Available pages: {available_pages:?}");
|
|
|
|
let mut store = Store::new(
|
|
&engine,
|
|
CurrentPlugin::new(manifest, with_wasi, available_pages)?,
|
|
);
|
|
|
|
store.set_epoch_deadline(1);
|
|
|
|
let mut linker = Linker::new(&engine);
|
|
linker.allow_shadowing(true);
|
|
|
|
// If wasi is enabled then add it to the linker
|
|
if with_wasi {
|
|
wasmtime_wasi::add_to_linker(&mut linker, |x: &mut CurrentPlugin| {
|
|
&mut x.wasi.as_mut().unwrap().ctx
|
|
})?;
|
|
}
|
|
|
|
// Get the `main` module, or the last one if `main` doesn't exist
|
|
let (main_name, main) = modules.get("main").map(|x| ("main", x)).unwrap_or_else(|| {
|
|
let entry = modules.iter().last().unwrap();
|
|
(entry.0.as_str(), entry.1)
|
|
});
|
|
|
|
// Define PDK functions
|
|
macro_rules! define_funcs {
|
|
($m:expr, { $($name:ident($($args:expr),*) $(-> $($r:expr),*)?);* $(;)?}) => {
|
|
match $m {
|
|
$(
|
|
concat!("extism_", stringify!($name)) => {
|
|
let t = FuncType::new([$($args),*], [$($($r),*)?]);
|
|
linker.func_new(EXPORT_MODULE_NAME, concat!("extism_", stringify!($name)), t, pdk::$name)?;
|
|
continue
|
|
}
|
|
)*
|
|
_ => ()
|
|
}
|
|
};
|
|
}
|
|
|
|
// Add builtins
|
|
for (name, module) in modules.iter() {
|
|
if name != main_name {
|
|
linker.module(&mut store, name, module)?;
|
|
}
|
|
for import in module.imports() {
|
|
let module_name = import.module();
|
|
let name = import.name();
|
|
use wasmtime::ValType::*;
|
|
|
|
if module_name == EXPORT_MODULE_NAME {
|
|
define_funcs!(name, {
|
|
config_get(I64) -> I64;
|
|
var_get(I64) -> I64;
|
|
var_set(I64, I64);
|
|
http_request(I64, I64) -> I64;
|
|
http_status_code() -> I32;
|
|
log_warn(I64);
|
|
log_info(I64);
|
|
log_debug(I64);
|
|
log_error(I64);
|
|
});
|
|
}
|
|
}
|
|
}
|
|
|
|
for f in &mut imports {
|
|
let name = f.name().to_string();
|
|
let ns = f.namespace().unwrap_or(EXPORT_MODULE_NAME);
|
|
linker.func_new(ns, &name, f.ty().clone(), unsafe {
|
|
&*std::sync::Arc::as_ptr(&f.f)
|
|
})?;
|
|
}
|
|
|
|
let instance_pre = linker.instantiate_pre(main)?;
|
|
let id = uuid::Uuid::new_v4();
|
|
let timer_tx = Timer::tx();
|
|
let mut plugin = Plugin {
|
|
modules,
|
|
linker,
|
|
instance: std::sync::Arc::new(std::sync::Mutex::new(None)),
|
|
instance_pre,
|
|
store,
|
|
runtime: None,
|
|
id,
|
|
timer_tx: timer_tx.clone(),
|
|
cancel_handle: CancelHandle { id, timer_tx },
|
|
instantiations: 0,
|
|
output: Output::default(),
|
|
_functions: imports.collect(),
|
|
needs_reset: false,
|
|
debug_options,
|
|
};
|
|
|
|
plugin.current_plugin_mut().store = &mut plugin.store;
|
|
plugin.current_plugin_mut().linker = &mut plugin.linker;
|
|
if available_pages.is_some() {
|
|
plugin
|
|
.store
|
|
.limiter(|internal| internal.memory_limiter.as_mut().unwrap());
|
|
}
|
|
Ok(plugin)
|
|
}
|
|
|
|
// Resets the store and linker to avoid running into Wasmtime memory limits
|
|
pub(crate) fn reset_store(
|
|
&mut self,
|
|
instance_lock: &mut std::sync::MutexGuard<Option<Instance>>,
|
|
) -> Result<(), Error> {
|
|
if self.instantiations > 100 {
|
|
let engine = self.store.engine().clone();
|
|
let internal = self.current_plugin_mut();
|
|
self.store = Store::new(
|
|
&engine,
|
|
CurrentPlugin::new(
|
|
internal.manifest.clone(),
|
|
internal.wasi.is_some(),
|
|
internal.available_pages,
|
|
)?,
|
|
);
|
|
|
|
self.store.set_epoch_deadline(1);
|
|
let store = &mut self.store as *mut _;
|
|
let linker = &mut self.linker as *mut _;
|
|
let current_plugin = self.current_plugin_mut();
|
|
current_plugin.store = store;
|
|
current_plugin.linker = linker;
|
|
if current_plugin.available_pages.is_some() {
|
|
self.store
|
|
.limiter(|internal| internal.memory_limiter.as_mut().unwrap());
|
|
}
|
|
|
|
let (main_name, main) = self
|
|
.modules
|
|
.get("main")
|
|
.map(|x| ("main", x))
|
|
.unwrap_or_else(|| {
|
|
let entry = self.modules.iter().last().unwrap();
|
|
(entry.0.as_str(), entry.1)
|
|
});
|
|
|
|
for (name, module) in self.modules.iter() {
|
|
if name != main_name {
|
|
self.linker.module(&mut self.store, name, module)?;
|
|
}
|
|
}
|
|
self.instantiations = 0;
|
|
self.instance_pre = self.linker.instantiate_pre(main)?;
|
|
}
|
|
|
|
**instance_lock = None;
|
|
Ok(())
|
|
}
|
|
|
|
// Instantiate the module. This is done lazily to avoid running any code outside of the `call` function,
|
|
// since wasmtime may execute a start function (if configured) at instantiation time,
|
|
pub(crate) fn instantiate(
|
|
&mut self,
|
|
instance_lock: &mut std::sync::MutexGuard<Option<Instance>>,
|
|
) -> Result<(), Error> {
|
|
if instance_lock.is_some() {
|
|
return Ok(());
|
|
}
|
|
|
|
let instance = self.instance_pre.instantiate(&mut self.store)?;
|
|
trace!("Plugin::instance is none, instantiating");
|
|
**instance_lock = Some(instance);
|
|
self.instantiations += 1;
|
|
if let Some(limiter) = &mut self.current_plugin_mut().memory_limiter {
|
|
limiter.reset();
|
|
}
|
|
self.detect_guest_runtime(instance_lock);
|
|
self.initialize_guest_runtime()?;
|
|
Ok(())
|
|
}
|
|
|
|
/// Get an exported function by name
|
|
pub(crate) fn get_func(
|
|
&mut self,
|
|
instance_lock: &mut std::sync::MutexGuard<Option<Instance>>,
|
|
function: impl AsRef<str>,
|
|
) -> Option<Func> {
|
|
if let Some(instance) = &mut **instance_lock {
|
|
instance.get_func(&mut self.store, function.as_ref())
|
|
} else {
|
|
None
|
|
}
|
|
}
|
|
|
|
/// Returns `true` if the given function exists, otherwise `false`
|
|
pub fn function_exists(&mut self, function: impl AsRef<str>) -> bool {
|
|
self.modules["main"]
|
|
.get_export(function.as_ref())
|
|
.map(|x| x.func().is_some())
|
|
.unwrap_or(false)
|
|
}
|
|
|
|
// Store input in memory and re-initialize `Internal` pointer
|
|
pub(crate) fn set_input(&mut self, input: *const u8, mut len: usize) -> Result<(), Error> {
|
|
self.output = Output::default();
|
|
self.clear_error();
|
|
|
|
if input.is_null() {
|
|
len = 0;
|
|
}
|
|
|
|
{
|
|
let store = &mut self.store as *mut _;
|
|
let linker = &mut self.linker as *mut _;
|
|
let current_plugin = self.current_plugin_mut();
|
|
current_plugin.store = store;
|
|
current_plugin.linker = linker;
|
|
}
|
|
|
|
let bytes = unsafe { std::slice::from_raw_parts(input, len) };
|
|
trace!("Input size: {}", bytes.len());
|
|
|
|
if let Some(f) = self.linker.get(&mut self.store, "env", "extism_reset") {
|
|
f.into_func().unwrap().call(&mut self.store, &[], &mut [])?;
|
|
} else {
|
|
error!("Call to extism_reset failed");
|
|
}
|
|
|
|
let handle = self.current_plugin_mut().memory_new(bytes)?;
|
|
|
|
if let Some(f) = self.linker.get(&mut self.store, "env", "extism_input_set") {
|
|
f.into_func().unwrap().call(
|
|
&mut self.store,
|
|
&[Val::I64(handle.offset() as i64), Val::I64(len as i64)],
|
|
&mut [],
|
|
)?;
|
|
}
|
|
|
|
Ok(())
|
|
}
|
|
|
|
/// Determine if wasi is enabled
|
|
pub fn has_wasi(&self) -> bool {
|
|
self.current_plugin().wasi.is_some()
|
|
}
|
|
|
|
// Do a best-effort attempt to detect any guest runtime.
|
|
fn detect_guest_runtime(
|
|
&mut self,
|
|
instance_lock: &mut std::sync::MutexGuard<Option<Instance>>,
|
|
) {
|
|
// Check for Haskell runtime initialization functions
|
|
// Initialize Haskell runtime if `hs_init` is present,
|
|
// by calling the `hs_init` export
|
|
if let Some(init) = self.get_func(instance_lock, "hs_init") {
|
|
let reactor_init = if let Some(init) = self.get_func(instance_lock, "_initialize") {
|
|
if init.typed::<(), ()>(&self.store()).is_err() {
|
|
trace!(
|
|
"_initialize function found with type {:?}",
|
|
init.ty(self.store())
|
|
);
|
|
None
|
|
} else {
|
|
trace!("WASI reactor module detected");
|
|
Some(init)
|
|
}
|
|
} else {
|
|
None
|
|
};
|
|
self.runtime = Some(GuestRuntime::Haskell { init, reactor_init });
|
|
return;
|
|
}
|
|
|
|
// Check for `__wasm_call_ctors` or `_initialize`, this is used by WASI to
|
|
// initialize certain interfaces.
|
|
let init = if let Some(init) = self.get_func(instance_lock, "__wasm_call_ctors") {
|
|
if init.typed::<(), ()>(&self.store()).is_err() {
|
|
trace!(
|
|
"__wasm_call_ctors function found with type {:?}",
|
|
init.ty(self.store())
|
|
);
|
|
return;
|
|
}
|
|
trace!("WASI runtime detected");
|
|
init
|
|
} else if let Some(init) = self.get_func(instance_lock, "_initialize") {
|
|
if init.typed::<(), ()>(&self.store()).is_err() {
|
|
trace!(
|
|
"_initialize function found with type {:?}",
|
|
init.ty(self.store())
|
|
);
|
|
return;
|
|
}
|
|
trace!("Reactor module detected");
|
|
init
|
|
} else {
|
|
return;
|
|
};
|
|
|
|
self.runtime = Some(GuestRuntime::Wasi { init });
|
|
|
|
trace!("No runtime detected");
|
|
}
|
|
|
|
// Initialize the guest runtime
|
|
pub(crate) fn initialize_guest_runtime(&mut self) -> Result<(), Error> {
|
|
let mut store = &mut self.store;
|
|
if let Some(runtime) = &self.runtime {
|
|
trace!("Plugin::initialize_runtime");
|
|
match runtime {
|
|
GuestRuntime::Haskell { init, reactor_init } => {
|
|
if let Some(reactor_init) = reactor_init {
|
|
reactor_init.call(&mut store, &[], &mut [])?;
|
|
}
|
|
let mut results = vec![Val::null(); init.ty(&store).results().len()];
|
|
init.call(
|
|
&mut store,
|
|
&[Val::I32(0), Val::I32(0)],
|
|
results.as_mut_slice(),
|
|
)?;
|
|
debug!("Initialized Haskell language runtime");
|
|
}
|
|
GuestRuntime::Wasi { init } => {
|
|
init.call(&mut store, &[], &mut [])?;
|
|
debug!("Initialied WASI runtime");
|
|
}
|
|
}
|
|
}
|
|
|
|
Ok(())
|
|
}
|
|
|
|
// Return the position of the output in memory
|
|
fn output_memory_position(&mut self) -> (u64, u64) {
|
|
let out = &mut [Val::I64(0)];
|
|
let out_len = &mut [Val::I64(0)];
|
|
let mut store = &mut self.store;
|
|
self.linker
|
|
.get(&mut store, "env", "extism_output_offset")
|
|
.unwrap()
|
|
.into_func()
|
|
.unwrap()
|
|
.call(&mut store, &[], out)
|
|
.unwrap();
|
|
self.linker
|
|
.get(&mut store, "env", "extism_output_length")
|
|
.unwrap()
|
|
.into_func()
|
|
.unwrap()
|
|
.call(&mut store, &[], out_len)
|
|
.unwrap();
|
|
|
|
let offs = out[0].unwrap_i64() as u64;
|
|
let len = out_len[0].unwrap_i64() as u64;
|
|
(offs, len)
|
|
}
|
|
|
|
// Get the output data after a call has returned
|
|
fn output<'a, T: FromBytes<'a>>(&'a mut self) -> Result<T, Error> {
|
|
trace!("Output offset: {}", self.output.offset);
|
|
let offs = self.output.offset;
|
|
let len = self.output.length;
|
|
T::from_bytes(
|
|
self.current_plugin_mut()
|
|
.memory_bytes(unsafe { MemoryHandle::new(offs, len) })?,
|
|
)
|
|
}
|
|
|
|
// Cache output memory and error information after call is complete
|
|
fn get_output_after_call(&mut self) {
|
|
let (offs, len) = self.output_memory_position();
|
|
self.output.offset = offs;
|
|
self.output.length = len;
|
|
|
|
let err = self.current_plugin_mut().get_error_position();
|
|
self.output.error_offset = err.0;
|
|
self.output.error_length = err.1;
|
|
}
|
|
|
|
// Implements the build of the `call` function, `raw_call` is also used in the SDK
|
|
// code
|
|
pub(crate) fn raw_call(
|
|
&mut self,
|
|
lock: &mut std::sync::MutexGuard<Option<Instance>>,
|
|
name: impl AsRef<str>,
|
|
input: impl AsRef<[u8]>,
|
|
) -> Result<i32, (Error, i32)> {
|
|
let name = name.as_ref();
|
|
let input = input.as_ref();
|
|
|
|
if self.needs_reset {
|
|
if let Err(e) = self.reset_store(lock) {
|
|
error!("Call to Plugin::reset_store failed: {e:?}");
|
|
}
|
|
self.needs_reset = false;
|
|
}
|
|
|
|
self.instantiate(lock).map_err(|e| (e, -1))?;
|
|
|
|
self.set_input(input.as_ptr(), input.len())
|
|
.map_err(|x| (x, -1))?;
|
|
|
|
let func = match self.get_func(lock, name) {
|
|
Some(x) => x,
|
|
None => return Err((anyhow::anyhow!("Function not found: {name}"), -1)),
|
|
};
|
|
|
|
// Check the number of results, reject functions with more than 1 result
|
|
let n_results = func.ty(self.store()).results().len();
|
|
if n_results > 1 {
|
|
return Err((
|
|
anyhow::anyhow!("Function {name} has {n_results} results, expected 0 or 1"),
|
|
-1,
|
|
));
|
|
}
|
|
|
|
// Start timer
|
|
self.timer_tx
|
|
.send(TimerAction::Start {
|
|
id: self.id,
|
|
engine: self.store.engine().clone(),
|
|
duration: self
|
|
.current_plugin()
|
|
.manifest
|
|
.timeout_ms
|
|
.map(std::time::Duration::from_millis),
|
|
})
|
|
.unwrap();
|
|
|
|
// Call the function
|
|
let mut results = vec![wasmtime::Val::null(); n_results];
|
|
let mut res = func.call(self.store_mut(), &[], results.as_mut_slice());
|
|
|
|
// Stop timer
|
|
self.timer_tx
|
|
.send(TimerAction::Stop { id: self.id })
|
|
.unwrap();
|
|
self.store
|
|
.epoch_deadline_callback(|_| Ok(UpdateDeadline::Continue(1)));
|
|
|
|
self.get_output_after_call();
|
|
self.needs_reset = name == "_start";
|
|
|
|
let mut msg = None;
|
|
|
|
if self.output.error_offset != 0 && self.output.error_length != 0 {
|
|
let handle = MemoryHandle {
|
|
offset: self.output.error_offset,
|
|
length: self.output.error_length,
|
|
};
|
|
if let Ok(e) = self.current_plugin_mut().memory_str(handle) {
|
|
let x = e.to_string();
|
|
error!("Call to {name} returned with error message: {}", x);
|
|
|
|
// If `res` is `Ok` and there is an error message set, then convert the response
|
|
// to an `Error`
|
|
if res.is_ok() {
|
|
res = Err(Error::msg(x));
|
|
} else {
|
|
msg = Some(x);
|
|
}
|
|
}
|
|
}
|
|
|
|
match res {
|
|
Ok(()) => {
|
|
// If `results` is empty and the return value wasn't a WASI exit code then
|
|
// the call succeeded
|
|
if results.is_empty() {
|
|
return Ok(0);
|
|
}
|
|
|
|
// Return result to caller
|
|
Ok(0)
|
|
}
|
|
Err(e) => {
|
|
if let Some(coredump) = e.downcast_ref::<wasmtime::WasmCoreDump>() {
|
|
if let Some(file) = self.debug_options.coredump.clone() {
|
|
debug!("Saving coredump to {}", file.display());
|
|
|
|
if let Err(e) =
|
|
std::fs::write(file, coredump.serialize(self.store_mut(), "extism"))
|
|
{
|
|
error!("Unable to write coredump: {:?}", e);
|
|
}
|
|
}
|
|
}
|
|
|
|
if let Some(file) = &self.debug_options.memdump.clone() {
|
|
trace!("Memory dump enabled");
|
|
if let Some(memory) = self.current_plugin_mut().memory() {
|
|
debug!("Dumping memory to {}", file.display());
|
|
let data = memory.data(&mut self.store);
|
|
if let Err(e) = std::fs::write(file, &data) {
|
|
error!("Unable to write memory dump: {:?}", e);
|
|
}
|
|
} else {
|
|
error!("Unable to get extism memory for writing to disk");
|
|
}
|
|
}
|
|
|
|
let wasi_exit_code = e
|
|
.downcast_ref::<wasmtime_wasi::I32Exit>()
|
|
.map(|e| e.0)
|
|
.or_else(|| {
|
|
e.downcast_ref::<wasmtime_wasi::preview2::I32Exit>()
|
|
.map(|e| e.0)
|
|
});
|
|
if let Some(exit_code) = wasi_exit_code {
|
|
trace!("WASI exit code: {}", exit_code);
|
|
if exit_code == 0 && msg.is_none() {
|
|
return Ok(0);
|
|
}
|
|
|
|
return Err((
|
|
Error::msg(msg.unwrap_or_else(|| "WASI exit code".to_string())),
|
|
exit_code,
|
|
));
|
|
}
|
|
|
|
// Handle timeout interrupts
|
|
if let Some(wasmtime::Trap::Interrupt) = e.downcast_ref::<wasmtime::Trap>() {
|
|
trace!("Call to {name} timed out");
|
|
return Err((Error::msg("timeout"), -1));
|
|
}
|
|
|
|
// Handle out-of-memory error from `MemoryLimiter`
|
|
let cause = e.root_cause().to_string();
|
|
if cause == "oom" {
|
|
return Err((Error::msg(cause), -1));
|
|
}
|
|
|
|
error!("Call to {name} encountered an error: {e:?}");
|
|
return Err((
|
|
e.context(msg.unwrap_or_else(|| "Error in Extism plugin call".to_string())),
|
|
-1,
|
|
));
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Call a function by name with the given input, the return value is the output data returned by the plugin.
|
|
/// This data will be invalidated next time the plugin is called.
|
|
pub fn call<'a, 'b, T: ToBytes<'a>, U: FromBytes<'b>>(
|
|
&'b mut self,
|
|
name: impl AsRef<str>,
|
|
input: T,
|
|
) -> Result<U, Error> {
|
|
let lock = self.instance.clone();
|
|
let mut lock = lock.lock().unwrap();
|
|
let data = input.to_bytes()?;
|
|
self.raw_call(&mut lock, name, data)
|
|
.map_err(|e| e.0)
|
|
.and_then(move |_| self.output())
|
|
}
|
|
|
|
/// Get a `CancelHandle`, which can be used from another thread to cancel a running plugin
|
|
pub fn cancel_handle(&self) -> CancelHandle {
|
|
self.cancel_handle.clone()
|
|
}
|
|
|
|
pub(crate) fn clear_error(&mut self) {
|
|
trace!("Clearing error on plugin {}", self.id);
|
|
let (linker, mut store) = self.linker_and_store();
|
|
if let Some(f) = linker.get(&mut store, "env", "extism_error_set") {
|
|
f.into_func()
|
|
.unwrap()
|
|
.call(&mut store, &[Val::I64(0)], &mut [])
|
|
.unwrap();
|
|
} else {
|
|
error!("Plugin::clear_error failed, extism_error_set not found")
|
|
}
|
|
}
|
|
|
|
// A convenience method to set the plugin error and return a value
|
|
pub(crate) fn return_error<E>(
|
|
&mut self,
|
|
instance_lock: &mut std::sync::MutexGuard<Option<Instance>>,
|
|
e: impl std::fmt::Display,
|
|
x: E,
|
|
) -> E {
|
|
if instance_lock.is_none() {
|
|
error!("No instance, unable to set error: {}", e);
|
|
return x;
|
|
}
|
|
match self.current_plugin_mut().set_error(e.to_string()) {
|
|
Ok((a, b)) => {
|
|
self.output.error_offset = a;
|
|
self.output.error_length = b;
|
|
}
|
|
Err(e) => {
|
|
error!("Unable to set error: {e:?}")
|
|
}
|
|
}
|
|
x
|
|
}
|
|
}
|
|
|
|
// Enumerates the PDK languages that need some additional initialization
|
|
#[derive(Clone)]
|
|
pub(crate) enum GuestRuntime {
|
|
Haskell {
|
|
init: Func,
|
|
reactor_init: Option<Func>,
|
|
},
|
|
Wasi {
|
|
init: Func,
|
|
},
|
|
}
|
|
|
|
/// The `typed_plugin` macro is used to create a newtype wrapper around `Plugin` with methods defined for the specified functions.
|
|
///
|
|
/// For example, we can define a new type `MyPlugin` that automatically implements `From`/`Into` for `Plugin`
|
|
/// ```rust
|
|
/// #[derive(serde::Deserialize)]
|
|
/// struct Count {
|
|
/// count: usize,
|
|
/// }
|
|
///
|
|
/// extism::typed_plugin!(MyPlugin {
|
|
/// count_vowels(&str) -> extism::convert::Json<Count>;
|
|
/// });
|
|
///
|
|
/// # const WASM: &[u8] = include_bytes!("../../wasm/code.wasm");
|
|
/// // Convert from `Plugin` to `MyPlugin`
|
|
/// let mut plugin: MyPlugin = extism::Plugin::new(WASM, [], true).unwrap().try_into().unwrap();
|
|
/// // and call the `count_vowels` function
|
|
/// let count = plugin.count_vowels("this is a test").unwrap();
|
|
/// ```
|
|
#[macro_export]
|
|
macro_rules! typed_plugin {
|
|
($name:ident {$($f:ident $(< $( $lt:tt $( : $clt:path )? ),+ >)? ($input:ty) -> $output:ty);*$(;)?}) => {
|
|
pub struct $name(pub $crate::Plugin);
|
|
|
|
unsafe impl Send for $name {}
|
|
unsafe impl Sync for $name {}
|
|
|
|
impl TryFrom<$crate::Plugin> for $name {
|
|
type Error = $crate::Error;
|
|
fn try_from(mut x: $crate::Plugin) -> Result<Self, Self::Error> {
|
|
$(
|
|
if !x.function_exists(stringify!($f)) {
|
|
return Err($crate::Error::msg(format!("Invalid function: {}", stringify!($f))));
|
|
}
|
|
)*
|
|
Ok($name(x))
|
|
}
|
|
}
|
|
|
|
impl From<$name> for $crate::Plugin {
|
|
fn from(x: $name) -> Self {
|
|
x.0
|
|
}
|
|
}
|
|
|
|
impl $name {
|
|
$(
|
|
pub fn $f<'a, $( $( $lt $( : $clt )? ),+ )? >(&'a mut self, input: $input) -> Result<$output, $crate::Error> {
|
|
self.0.call(stringify!($f), input)
|
|
}
|
|
)*
|
|
}
|
|
};
|
|
}
|