1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
use std::collections::BTreeMap;
use crate::*;
/// Plugin contains everything needed to execute a WASM function
pub struct Plugin {
/// All modules that were provided to the linker
pub modules: BTreeMap<String, Module>,
/// Used to define functions and create new instances
pub linker: Linker<Internal>,
/// Instance provides the ability to call functions in a module
pub instance: Instance,
/// 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`
pub instantiations: usize,
/// Handles interactions with WASM memory
pub memory: std::cell::UnsafeCell<PluginMemory>,
/// The ID used to identify this plugin with the `Timer`
pub timer_id: uuid::Uuid,
/// A handle used to cancel execution of a plugin
pub(crate) cancel_handle: sdk::ExtismCancelHandle,
/// Runtime determines any initialization and cleanup functions needed
/// to run a module
pub(crate) runtime: Option<Runtime>,
}
impl InternalExt for Plugin {
fn memory(&self) -> &PluginMemory {
unsafe { &*self.memory.get() }
}
fn memory_mut(&mut self) -> &mut PluginMemory {
self.memory.get_mut()
}
}
const EXPORT_MODULE_NAME: &str = "env";
fn profiling_strategy() -> ProfilingStrategy {
match std::env::var("EXTISM_PROFILE").as_deref() {
Ok("perf") => ProfilingStrategy::PerfMap,
Ok(x) => {
log::warn!("Invalid value for EXTISM_PROFILE: {x}");
ProfilingStrategy::None
}
Err(_) => ProfilingStrategy::None,
}
}
impl Plugin {
/// Create a new plugin from the given WASM code
pub fn new<'a>(
wasm: impl AsRef<[u8]>,
imports: impl IntoIterator<Item = &'a Function>,
with_wasi: bool,
) -> Result<Plugin, Error> {
// Create a new engine, if the `EXITSM_DEBUG` environment variable is set
// then we enable debug info
let engine = Engine::new(
Config::new()
.epoch_interruption(true)
.debug_info(std::env::var("EXTISM_DEBUG").is_ok())
.profiler(profiling_strategy()),
)?;
let mut imports = imports.into_iter();
let (manifest, modules) = Manifest::new(&engine, wasm.as_ref())?;
let mut store = Store::new(&engine, Internal::new(&manifest, with_wasi)?);
store.epoch_deadline_callback(|_internal| Err(Error::msg("timeout")));
// Create memory
let memory = Memory::new(
&mut store,
MemoryType::new(4, manifest.as_ref().memory.max_pages),
)?;
let mut memory = PluginMemory::new(store, memory, manifest);
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 Internal| {
&mut x.wasi.as_mut().unwrap().ctx
})?;
#[cfg(feature = "nn")]
wasmtime_wasi_nn::add_to_linker(&mut linker, |x: &mut Internal| {
&mut x.wasi.as_mut().unwrap().nn
})?;
}
// 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() {
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, {
alloc(I64) -> I64;
free(I64);
load_u8(I64) -> I32;
load_u64(I64) -> I64;
store_u8(I64, I32);
store_u64(I64, I64);
input_length() -> I64;
input_load_u8(I64) -> I32;
input_load_u64(I64) -> I64;
output_set(I64, I64);
error_set(I64);
config_get(I64) -> I64;
var_get(I64) -> I64;
var_set(I64, I64);
http_request(I64, I64) -> I64;
http_status_code() -> I32;
length(I64) -> I64;
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)
})?;
}
}
}
}
// Add modules to linker
for (name, module) in modules.iter() {
if name != main_name {
linker.module(&mut memory.store_mut(), name, module)?;
}
}
let instance = linker.instantiate(&mut memory.store_mut(), main)?;
let timer_id = uuid::Uuid::new_v4();
let mut plugin = Plugin {
modules,
linker,
memory: std::cell::UnsafeCell::new(memory),
instance,
instantiations: 1,
runtime: None,
timer_id,
cancel_handle: sdk::ExtismCancelHandle {
id: timer_id,
epoch_timer_tx: None,
},
};
// Make sure `Internal::memory` is initialized
plugin.internal_mut().memory = plugin.memory.get();
// Then detect runtime before returning the new plugin
plugin.detect_runtime();
Ok(plugin)
}
/// Get a function by name
pub fn get_func(&mut self, function: impl AsRef<str>) -> Option<Func> {
self.instance
.get_func(&mut self.memory.get_mut().store_mut(), function.as_ref())
}
// A convenience method to set the plugin error and return a value
pub fn error<E>(&self, e: impl std::fmt::Debug, x: E) -> E {
self.store().data().set_error(e);
x
}
/// Store input in memory and initialize `Internal` pointer
pub fn set_input(&mut self, input: *const u8, mut len: usize) {
if input.is_null() {
len = 0;
}
let ptr = self.memory.get();
let internal = self.internal_mut();
internal.input = input;
internal.input_length = len;
internal.memory = ptr
}
/// Dump memory using trace! logging
pub fn dump_memory(&self) {
self.memory().dump();
}
/// Create a new instance from the same modules
pub fn reinstantiate(&mut self) -> Result<(), Error> {
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)
});
// Avoid running into resource limits, after 5 instantiations reset the store. This will
// release any old `Instance` objects
if self.instantiations > 5 {
self.memory.get_mut().reinstantiate()?;
// Get the `main` module, or the last one if `main` doesn't exist
for (name, module) in self.modules.iter() {
if name != main_name {
self.linker
.module(&mut self.memory.get_mut().store_mut(), name, module)?;
}
}
self.instantiations = 0;
}
let instance = self
.linker
.instantiate(&mut self.memory.get_mut().store_mut(), &main)?;
self.instance = instance;
self.detect_runtime();
self.instantiations += 1;
Ok(())
}
/// Determine if wasi is enabled
pub fn has_wasi(&self) -> bool {
self.memory().store().data().wasi.is_some()
}
fn detect_runtime(&mut self) {
// Check for Haskell runtime initialization functions
// Initialize Haskell runtime if `hs_init` and `hs_exit` are present,
// by calling the `hs_init` export
if let Some(init) = self.get_func("hs_init") {
if let Some(cleanup) = self.get_func("hs_exit") {
if init
.typed::<(i32, i32), ()>(&self.memory().store())
.is_err()
{
trace!(
"hs_init function found with type {:?}",
init.ty(&self.memory().store())
);
}
self.runtime = Some(Runtime::Haskell { init, cleanup });
}
return;
}
// Check for `__wasm__call_ctors` and `__wasm_call_dtors`, this is used by WASI to
// initialize certain interfaces.
if self.has_wasi() {
if let Some(init) = self.get_func("__wasm_call_ctors") {
if init.typed::<(), ()>(&self.memory().store()).is_err() {
trace!(
"__wasm_call_ctors function found with type {:?}",
init.ty(&self.memory().store())
);
return;
}
trace!("WASI runtime detected");
if let Some(cleanup) = self.get_func("__wasm_call_dtors") {
if cleanup.typed::<(), ()>(&self.memory().store()).is_err() {
trace!(
"__wasm_call_dtors function found with type {:?}",
cleanup.ty(&self.memory().store())
);
return;
}
self.runtime = Some(Runtime::Wasi {
init,
cleanup: Some(cleanup),
});
return;
}
self.runtime = Some(Runtime::Wasi {
init,
cleanup: None,
});
}
return;
}
trace!("No runtime detected");
}
pub(crate) fn initialize_runtime(&mut self) -> Result<(), Error> {
if let Some(runtime) = &self.runtime {
trace!("Plugin::initialize_runtime");
match runtime {
Runtime::Haskell { init, cleanup: _ } => {
let mut results =
vec![Val::null(); init.ty(&self.memory().store()).results().len()];
init.call(
&mut self.memory.get_mut().store_mut(),
&[Val::I32(0), Val::I32(0)],
results.as_mut_slice(),
)?;
debug!("Initialized Haskell language runtime");
}
Runtime::Wasi { init, cleanup: _ } => {
debug!("Calling __wasm_call_ctors");
init.call(&mut self.memory.get_mut().store_mut(), &[], &mut [])?;
}
}
}
Ok(())
}
#[inline(always)]
pub(crate) fn cleanup_runtime(&mut self) -> Result<(), Error> {
if let Some(runtime) = self.runtime.clone() {
trace!("Plugin::cleanup_runtime");
match runtime {
Runtime::Wasi {
init: _,
cleanup: Some(cleanup),
} => {
debug!("Calling __wasm_call_dtors");
cleanup.call(&mut self.memory_mut().store_mut(), &[], &mut [])?;
}
Runtime::Wasi {
init: _,
cleanup: None,
} => (),
// Cleanup Haskell runtime if `hs_exit` and `hs_exit` are present,
// by calling the `hs_exit` export
Runtime::Haskell { init: _, cleanup } => {
let mut results =
vec![Val::null(); cleanup.ty(&self.memory().store()).results().len()];
cleanup.call(
&mut self.memory_mut().store_mut(),
&[],
results.as_mut_slice(),
)?;
debug!("Cleaned up Haskell language runtime");
}
}
}
Ok(())
}
/// Start the timer for a Plugin - this is used for both timeouts
/// and cancellation
pub(crate) fn start_timer(
&mut self,
tx: &std::sync::mpsc::SyncSender<TimerAction>,
) -> Result<(), Error> {
let duration = self
.memory()
.manifest
.as_ref()
.timeout_ms
.map(std::time::Duration::from_millis);
self.cancel_handle.epoch_timer_tx = Some(tx.clone());
self.memory_mut().store_mut().set_epoch_deadline(1);
let engine: Engine = self.memory().store().engine().clone();
tx.send(TimerAction::Start {
id: self.timer_id,
duration,
engine,
})?;
Ok(())
}
/// Send TimerAction::Stop
pub(crate) fn stop_timer(&mut self) -> Result<(), Error> {
if let Some(tx) = &self.cancel_handle.epoch_timer_tx {
tx.send(TimerAction::Stop { id: self.timer_id })?;
}
Ok(())
}
}
// Enumerates the supported PDK language runtimes
#[derive(Clone)]
pub(crate) enum Runtime {
Haskell { init: Func, cleanup: Func },
Wasi { init: Func, cleanup: Option<Func> },
}