mirror of
https://github.com/extism/extism.git
synced 2026-01-10 06:18:00 -05:00
87be73570d
- Adds `ExtismContext` instead of global `PLUGINS` registry - Adds `extism_context_new`, `extism_context_free` and `extism_context_reset` - Requires updating nearly every SDK function to add context parameter - Renames some SDK functions to follow better naming conventions - `extism_plugin_register` -> `extism_plugin_new` - `extism_output_get` -> `extism_plugin_output_data` - `extism_output_length` -> `extism_plugin_output_length` - `extism_call` -> `extism_plugin_call` - Updates `extism_error` to return the context error when -1 issued for the plug-in ID - Adds `extism_plugin_free` to remove an existing plugin - Updates SDKs to include these functions - Updates SDK examples and comments Co-authored-by: Steve Manuel <steve@dylib.so>
75 lines
2.3 KiB
Rust
75 lines
2.3 KiB
Rust
use std::collections::BTreeMap;
|
|
|
|
use crate::*;
|
|
|
|
/// A `Context` is used to store and manage plugins
|
|
#[derive(Default)]
|
|
pub struct Context {
|
|
/// Plugin registry
|
|
pub plugins: BTreeMap<PluginIndex, Plugin>,
|
|
|
|
/// Error message
|
|
pub error: Option<std::ffi::CString>,
|
|
next_id: std::sync::atomic::AtomicI32,
|
|
reclaimed_ids: Vec<PluginIndex>,
|
|
}
|
|
|
|
impl Context {
|
|
/// Create a new context
|
|
pub fn new() -> Context {
|
|
Context {
|
|
plugins: BTreeMap::new(),
|
|
error: None,
|
|
next_id: std::sync::atomic::AtomicI32::new(0),
|
|
reclaimed_ids: Vec::new(),
|
|
}
|
|
}
|
|
|
|
/// Get the next valid plugin ID
|
|
pub fn next_id(&mut self) -> Result<PluginIndex, Error> {
|
|
// Make sure we haven't exhausted all plugin IDs, it reach this it would require the machine
|
|
// running this code to have a lot of memory - no computer I tested on was able to allocate
|
|
// this many plugins.
|
|
if self.next_id.load(std::sync::atomic::Ordering::SeqCst) == PluginIndex::MAX {
|
|
// Since `Context::remove` collects IDs that have been removed we will
|
|
// try to use one of those before returning an error
|
|
match self.reclaimed_ids.pop() {
|
|
None => {
|
|
return Err(anyhow::format_err!(
|
|
"All plugin descriptors are in use, unable to allocate a new plugin"
|
|
))
|
|
}
|
|
Some(x) => return Ok(x),
|
|
}
|
|
}
|
|
|
|
Ok(self
|
|
.next_id
|
|
.fetch_add(1, std::sync::atomic::Ordering::SeqCst))
|
|
}
|
|
|
|
/// Set the context error
|
|
pub fn set_error(&mut self, e: impl std::fmt::Debug) {
|
|
self.error = Some(error_string(e));
|
|
}
|
|
|
|
/// Convenience function to set error and return the value passed as the final parameter
|
|
pub fn error<T>(&mut self, e: impl std::fmt::Debug, x: T) -> T {
|
|
self.set_error(e);
|
|
x
|
|
}
|
|
|
|
/// Get a plugin from the context
|
|
pub fn plugin(&mut self, id: PluginIndex) -> Option<&mut Plugin> {
|
|
self.plugins.get_mut(&id)
|
|
}
|
|
|
|
/// Remove a plugin from the context
|
|
pub fn remove(&mut self, id: PluginIndex) {
|
|
self.plugins.remove(&id);
|
|
|
|
// Collect old IDs in case we need to re-use them
|
|
self.reclaimed_ids.push(id);
|
|
}
|
|
}
|