feat: expose building a CompiledPlugin with a fuel limit (#883)

Expose a new method `extism_compiled_plugin_new_with_fuel_limit` to
build a CompiledPlugin with a fuel limit.

Fixes #882

convert/Cargo.toml

@@ -13,7 +13,7 @@ description = "Traits to make Rust types usable with Extism"
 anyhow = "1.0.75"
 base64 = "~0.22"
 bytemuck = {version = "1.14.0", optional = true }
-prost = { version = "0.13.1", optional = true }
+prost = { version = "0.14.1", optional = true }
 protobuf = { version = "3.2.0", optional = true }
 rmp-serde = { version = "1.1.2", optional = true }
 serde = "1.0.186"

runtime/Cargo.toml

@@ -9,35 +9,54 @@ repository.workspace = true
 version.workspace = true
 
 [dependencies]
-wasmtime = {version = ">= 27.0.0, < 31.0.0"}
-wasi-common = {version = ">= 27.0.0, < 31.0.0"}
-wiggle = {version = ">= 27.0.0, < 31.0.0"}
+wasmtime = { version="37", default-features = false, features = [
+  'cache',
+  'gc',
+  'gc-drc',
+  'cranelift',
+  'coredump',
+  'wat',
+  'parallel-compilation',
+  'pooling-allocator',
+  'demangle',
+] }
+wasi-common = "37"
+wiggle = "37"
 anyhow = "1"
-serde = {version = "1", features = ["derive"]}
+serde = { version = "1", features = ["derive"] }
 serde_json = "1"
-toml = "0.8"
+toml = "0.9"
 sha2 = "0.10"
 tracing = "0.1"
-tracing-subscriber = {version = "0.3.18", features = ["std", "env-filter", "fmt"]}
+tracing-subscriber = { version = "0.3.18", features = [
+  "std",
+  "env-filter",
+  "fmt",
+] }
 url = "2"
 glob = "0.3"
-ureq = {version = "3.0", optional=true}
+ureq = { version = "3.0", optional = true }
 extism-manifest = { workspace = true }
 extism-convert = { workspace = true, features = ["extism-path"] }
 uuid = { version = "1", features = ["v4"] }
 libc = "0.2"
 
 [features]
-default = ["http", "register-http", "register-filesystem"]
-register-http = ["ureq"] # enables wasm to be downloaded using http
-register-filesystem = [] # enables wasm to be loaded from disk
-http = ["ureq"]          # enables extism_http_request
+default = ["http", "register-http", "register-filesystem", "wasmtime-default-features"]
+register-http = ["ureq"]           # enables wasm to be downloaded using http
+register-filesystem = []           # enables wasm to be loaded from disk
+http = ["ureq"]                    # enables extism_http_request
+wasmtime-exceptions = []           # enables exception-handling proposal in wasmtime (requires wasmtime gc feature)
+wasmtime-default-features = [
+  'wasmtime/default',
+]
+
 
 [build-dependencies]
 cbindgen = { version = "0.29", default-features = false }
 
 [dev-dependencies]
-criterion = "0.6.0"
+criterion = "0.7.0"
 quickcheck = "1"
 rand = "0.9.0"
 

runtime/README.md

@@ -112,7 +112,8 @@ let mut plugin = Plugin::new(&manifest, [], true);
 let res = plugin.call::<&str, &str>("count_vowels", "Yellow, world!").unwrap();
 println!("{}", res);
 # => {"count": 3, "total": 3, "vowels": "aeiouAEIOU"}
-let mut plugin = Plugin::new(&manifest, [], true).with_config_key("vowels", "aeiouyAEIOUY");
+let manifest = Manifest::new([url]).with_config_key("vowels", "aeiouyAEIOUY");
+let mut plugin = Plugin::new(&manifest, [], true).unwrap();
 let res = plugin.call::<&str, &str>("count_vowels", "Yellow, world!").unwrap();
 println!("{}", res);
 # => {"count": 4, "total": 4, "vowels": "aeiouyAEIOUY"}

runtime/extism.h

@@ -191,6 +191,17 @@ ExtismCompiledPlugin *extism_compiled_plugin_new(const uint8_t *wasm,
                                                  bool with_wasi,
                                                  char **errmsg);
 
+/**
+ * Pre-compile an Extism plugin and set the number of instructions a plugin is allowed to execute
+ */
+ExtismCompiledPlugin *extism_compiled_plugin_new_with_fuel_limit(const uint8_t *wasm,
+                                                                 ExtismSize wasm_size,
+                                                                 const ExtismFunction **functions,
+                                                                 ExtismSize n_functions,
+                                                                 bool with_wasi,
+                                                                 uint64_t fuel_limit,
+                                                                 char **errmsg);
+
 /**
  * Free `ExtismCompiledPlugin`
  */

runtime/src/pdk.rs

@@ -258,12 +258,16 @@ pub(crate) fn http_request(
             };
             let buf: &[u8] = data.memory_bytes(handle)?;
             let agent = ureq::agent();
-            let config = agent.configure_request(r.body(buf)?);
+            let config = agent
+                .configure_request(r.body(buf)?)
+                .http_status_as_error(false);
             let req = config.timeout_global(timeout).build();
             ureq::run(req)
         } else {
             let agent = ureq::agent();
-            let config = agent.configure_request(r.body(())?);
+            let config = agent
+                .configure_request(r.body(())?)
+                .http_status_as_error(false);
             let req = config.timeout_global(timeout).build();
             ureq::run(req)
         };

runtime/src/plugin.rs

@@ -1,6 +1,7 @@
 use std::{
     any::Any,
     collections::{BTreeMap, BTreeSet},
+    path::PathBuf,
     sync::TryLockError,
 };
 
@@ -60,26 +61,16 @@ impl CompiledPlugin {
             .wasm_tail_call(true)
             .wasm_function_references(true)
             .wasm_gc(true);
+        #[cfg(feature = "wasmtime-exceptions")]
+        {
+            config.wasm_exceptions(true);
+        }
 
         if builder.options.fuel.is_some() {
             config.consume_fuel(true);
         }
 
-        match &builder.options.cache_config {
-            Some(None) => (),
-            Some(Some(path)) => {
-                config.cache_config_load(path)?;
-            }
-            None => {
-                if let Ok(env) = std::env::var("EXTISM_CACHE_CONFIG") {
-                    if !env.is_empty() {
-                        config.cache_config_load(&env)?;
-                    }
-                } else {
-                    config.cache_config_load_default()?;
-                }
-            }
-        }
+        config.cache(Self::configure_cache(&builder.options.cache_config)?);
 
         let engine = Engine::new(&config)?;
 
@@ -97,6 +88,43 @@ impl CompiledPlugin {
             engine,
         })
     }
+
+    /// Return optional cache according to builder options.
+    fn configure_cache(
+        cache_opt: &Option<Option<std::path::PathBuf>>,
+    ) -> Result<Option<wasmtime::Cache>, Error> {
+        match cache_opt {
+            // Explicitly disabled
+            Some(None) => Ok(None),
+
+            // Explicit path
+            Some(Some(p)) => {
+                let cache = wasmtime::Cache::from_file(Some(p.as_path()))?;
+                Ok(Some(cache))
+            }
+
+            // Unspecified, try environment, then system fallback
+            None => {
+                match std::env::var_os("EXTISM_CACHE_CONFIG") {
+                    Some(val) => {
+                        if val.is_empty() {
+                            // Disable cache if env var exists but is empty
+                            Ok(None)
+                        } else {
+                            let p = PathBuf::from(val);
+                            let cache = wasmtime::Cache::from_file(Some(p.as_path()))?;
+                            Ok(Some(cache))
+                        }
+                    }
+                    None => {
+                        // load cache configuration from the system default path
+                        let cache = wasmtime::Cache::from_file(None)?;
+                        Ok(Some(cache))
+                    }
+                }
+            }
+        }
+    }
 }
 
 /// Plugin contains everything needed to execute a WASM function
@@ -344,6 +372,7 @@ fn relink(
                 let (kind, ty) = match import.ty() {
                     ExternType::Func(t) => ("function", t.to_string()),
                     ExternType::Global(t) => ("global", t.content().to_string()),
+                    ExternType::Tag(t) => ("tag", t.ty().to_string()),
                     ExternType::Table(t) => ("table", t.element().to_string()),
                     ExternType::Memory(_) => ("memory", String::new()),
                 };

runtime/src/pool.rs

@@ -1,4 +1,7 @@
 use crate::{Error, FromBytesOwned, Plugin, ToBytes};
+use std::collections::HashMap;
+use std::sync::Arc;
+use std::sync::RwLock;
 
 // `PoolBuilder` is used to configure and create `Pool`s
 #[derive(Debug, Clone)]
@@ -46,7 +49,7 @@ impl PoolPlugin {
     }
 
     /// Access the underlying plugin
-    pub fn plugin(&self) -> std::cell::RefMut<Plugin> {
+    pub fn plugin(&self) -> std::cell::RefMut<'_, Plugin> {
         self.0.borrow_mut()
     }
 
@@ -79,7 +82,8 @@ unsafe impl Sync for PoolInner {}
 #[derive(Clone)]
 pub struct Pool {
     config: PoolBuilder,
-    inner: std::sync::Arc<std::sync::Mutex<PoolInner>>,
+    inner: Arc<std::sync::Mutex<PoolInner>>,
+    existing_functions: Arc<RwLock<HashMap<String, bool>>>,
 }
 
 unsafe impl Send for Pool {}
@@ -88,13 +92,7 @@ unsafe impl Sync for Pool {}
 impl Pool {
     /// Create a new pool with the default configuration
     pub fn new<F: 'static + Fn() -> Result<Plugin, Error>>(source: F) -> Self {
-        Pool {
-            config: Default::default(),
-            inner: std::sync::Arc::new(std::sync::Mutex::new(PoolInner {
-                plugin_source: Box::new(source),
-                instances: Default::default(),
-            })),
-        }
+        Self::new_from_builder(Box::new(source), PoolBuilder::default())
     }
 
     /// Create a new pool configured using a `PoolBuilder`
@@ -104,10 +102,11 @@ impl Pool {
     ) -> Self {
         Pool {
             config: builder,
-            inner: std::sync::Arc::new(std::sync::Mutex::new(PoolInner {
+            inner: Arc::new(std::sync::Mutex::new(PoolInner {
                 plugin_source: Box::new(source),
                 instances: Default::default(),
             })),
+            existing_functions: RwLock::new(HashMap::default()).into(),
         }
     }
 
@@ -171,4 +170,26 @@ impl Pool {
         }
         Ok(None)
     }
+
+    /// Returns `true` if the given function exists, otherwise `false`. Results are cached
+    /// after the first call.
+    pub fn function_exists(&self, name: &str, timeout: std::time::Duration) -> Result<bool, Error> {
+        // read current value if any
+        let read = self.existing_functions.read().unwrap();
+        let exists_opt = read.get(name).cloned();
+        drop(read);
+        if let Some(exists) = exists_opt {
+            Ok(exists)
+        } else {
+            // load plugin and call function_exists
+            let plugin = self.get(timeout)?;
+            let exists = plugin.unwrap().0.borrow().function_exists(name);
+
+            // write result to hashmap
+            let mut write = self.existing_functions.write().unwrap();
+            write.insert(name.to_string(), exists);
+
+            Ok(exists)
+        }
+    }
 }

runtime/src/sdk.rs

@@ -363,6 +363,70 @@ pub unsafe extern "C" fn extism_compiled_plugin_new(
         })
 }
 
+/// Pre-compile an Extism plugin and set the number of instructions a plugin is allowed to execute
+#[no_mangle]
+pub unsafe extern "C" fn extism_compiled_plugin_new_with_fuel_limit(
+    wasm: *const u8,
+    wasm_size: Size,
+    functions: *mut *const ExtismFunction,
+    n_functions: Size,
+    with_wasi: bool,
+    fuel_limit: u64,
+    errmsg: *mut *mut std::ffi::c_char,
+) -> *mut CompiledPlugin {
+    trace!("Call to extism_plugin_new with wasm pointer {:?}", wasm);
+    let data = std::slice::from_raw_parts(wasm, wasm_size as usize);
+
+    let mut builder = PluginBuilder::new(data)
+        .with_wasi(with_wasi)
+        .with_fuel_limit(fuel_limit);
+
+    if !functions.is_null() {
+        let funcs = (0..n_functions)
+            .map(|i| unsafe { *functions.add(i as usize) })
+            .map(|ptr| {
+                if ptr.is_null() {
+                    return Err("Cannot pass null pointer");
+                }
+
+                let ExtismFunction(func) = &*ptr;
+                let Some(func) = func.take() else {
+                    return Err("Function cannot be registered with multiple different Plugins");
+                };
+
+                Ok(func)
+            })
+            .collect::<Result<Vec<_>, _>>()
+            .unwrap_or_else(|e| {
+                if !errmsg.is_null() {
+                    let e = std::ffi::CString::new(e.to_string()).unwrap();
+                    *errmsg = e.into_raw();
+                }
+                Vec::new()
+            });
+
+        if funcs.len() != n_functions as usize {
+            return std::ptr::null_mut();
+        }
+
+        builder = builder.with_functions(funcs);
+    }
+
+    CompiledPlugin::new(builder)
+        .map(|v| Box::into_raw(Box::new(v)))
+        .unwrap_or_else(|e| {
+            if !errmsg.is_null() {
+                let e = std::ffi::CString::new(format!(
+                    "Unable to compile Extism plugin: {}",
+                    e.root_cause(),
+                ))
+                .unwrap();
+                *errmsg = e.into_raw();
+            }
+            std::ptr::null_mut()
+        })
+}
+
 /// Free `ExtismCompiledPlugin`
 #[no_mangle]
 pub unsafe extern "C" fn extism_compiled_plugin_free(plugin: *mut CompiledPlugin) {

runtime/src/tests/kernel.rs

@@ -225,26 +225,6 @@ fn test_kernel_allocations() {
     extism_free(&mut store, instance, q);
 }
 
-#[test]
-fn test_kernel_page_allocations() {
-    let (mut store, mut instance) = init_kernel_test();
-    let instance = &mut instance;
-
-    let a = extism_alloc(&mut store, instance, 65500 * 4);
-    let a_size = extism_length(&mut store, instance, a);
-    let b = extism_alloc(&mut store, instance, 65539);
-
-    extism_free(&mut store, instance, a);
-    let c = extism_alloc(&mut store, instance, 65500 * 2);
-    let c_size = extism_length(&mut store, instance, c);
-
-    let d = extism_alloc(&mut store, instance, 65536);
-
-    assert_eq!(a + (a_size - c_size), c);
-    assert!(c < b);
-    assert!(d < b);
-}
-
 #[test]
 fn test_kernel_error() {
     let (mut store, mut instance) = init_kernel_test();
@@ -456,32 +436,3 @@ quickcheck! {
         true
     }
 }
-
-quickcheck! {
-    fn check_block_reuse(allocs: Vec<u16>) -> bool {
-        let (mut store, mut instance) = init_kernel_test();
-        let instance = &mut instance;
-        let init = extism_alloc(&mut store, instance, allocs.iter().map(|x| *x as u64).sum::<u64>() + (allocs.len() as u64 * (65535 + 128)));
-        let bounds = init + extism_length(&mut store, instance, init);
-        extism_free(&mut store, instance, init);
-        for a in allocs {
-            let ptr = extism_alloc(&mut store, instance, a as u64 + 65535);
-            if ptr == 0 {
-                continue
-            }
-            if extism_length(&mut store, instance, ptr) != a as u64 + 65535  {
-                println!("FAILED ALLOC");
-                return false
-            }
-
-            extism_free(&mut store, instance, ptr);
-
-            if ptr > bounds {
-                println!("ptr={ptr}, bounds={bounds}");
-                return false
-            }
-        }
-
-        true
-    }
-}

runtime/src/tests/pool.rs

@@ -1,10 +1,11 @@
 use crate::*;
+use std::time::Duration;
 
 fn run_thread(p: Pool, i: u64) -> std::thread::JoinHandle<()> {
     std::thread::spawn(move || {
-        std::thread::sleep(std::time::Duration::from_millis(i));
+        std::thread::sleep(Duration::from_millis(i));
         let s: String = p
-            .get(std::time::Duration::from_secs(1))
+            .get(Duration::from_secs(1))
             .unwrap()
             .unwrap()
             .call("count_vowels", "abc")
@@ -13,17 +14,20 @@ fn run_thread(p: Pool, i: u64) -> std::thread::JoinHandle<()> {
     })
 }
 
+fn init(max_instances: usize) -> Pool {
+    let data = include_bytes!("../../../wasm/code.wasm");
+    let plugin_builder =
+        extism::PluginBuilder::new(extism::Manifest::new([extism::Wasm::data(data)]))
+            .with_wasi(true);
+    PoolBuilder::new()
+        .with_max_instances(max_instances)
+        .build(move || plugin_builder.clone().build())
+}
+
 #[test]
 fn test_threads() {
     for i in 1..=3 {
-        let data = include_bytes!("../../../wasm/code.wasm");
-        let plugin_builder =
-            extism::PluginBuilder::new(extism::Manifest::new([extism::Wasm::data(data)]))
-                .with_wasi(true);
-        let pool: Pool = PoolBuilder::new()
-            .with_max_instances(i)
-            .build(move || plugin_builder.clone().build());
-
+        let pool = init(i);
         let threads = vec![
             run_thread(pool.clone(), 1000),
             run_thread(pool.clone(), 1000),
@@ -46,3 +50,14 @@ fn test_threads() {
         assert!(pool.count() <= i);
     }
 }
+
+#[test]
+fn test_exists() -> Result<(), Error> {
+    let pool = init(1);
+    let timeout = Duration::from_secs(1);
+    assert!(pool.function_exists("count_vowels", timeout)?);
+    assert!(pool.function_exists("count_vowels", timeout)?);
+    assert!(!pool.function_exists("not_existing", timeout)?);
+    assert!(!pool.function_exists("not_existing", timeout)?);
+    Ok(())
+}