Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expose get_module_export from Caller #9525

Merged
merged 1 commit into from
Nov 2, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 74 additions & 2 deletions crates/wasmtime/src/runtime/func.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ use crate::runtime::Uninhabited;
use crate::store::{AutoAssertNoGc, StoreData, StoreOpaque, Stored};
use crate::type_registry::RegisteredType;
use crate::{
AsContext, AsContextMut, CallHook, Engine, Extern, FuncType, Instance, Module, Ref,
StoreContext, StoreContextMut, Val, ValRaw, ValType,
AsContext, AsContextMut, CallHook, Engine, Extern, FuncType, Instance, Module, ModuleExport,
Ref, StoreContext, StoreContextMut, Val, ValRaw, ValType,
};
use alloc::sync::Arc;
use core::ffi::c_void;
Expand Down Expand Up @@ -2109,6 +2109,78 @@ impl<T> Caller<'_, T> {
.get_export(&mut self.store, name)
}

/// Looks up an exported [`Extern`] value by a [`ModuleExport`] value.
///
/// This is similar to [`Self::get_export`] but uses a [`ModuleExport`] value to avoid
/// string lookups where possible. [`ModuleExport`]s can be obtained by calling
/// [`Module::get_export_index`] on the [`Module`] that an instance was instantiated with.
///
/// This method will search the module for an export with a matching entity index and return
/// the value, if found.
///
/// Returns `None` if there was no export with a matching entity index.
/// # Panics
///
/// Panics if `store` does not own this instance.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs are effectively a copy/paste of Instance::get_module_export. Happy to take recommendations or if you want to make a suggestion, I will definitely accept it. I think see [Instance::get_module_export] for details would probably also be fine so long as it's clear that the caller has access to the instance (wasn't clear to me without looking at the code).

///
/// # Usage
/// ```
/// use std::str;
///
/// # use wasmtime::*;
/// # fn main() -> anyhow::Result<()> {
/// # let mut store = Store::default();
///
/// let module = Module::new(
/// store.engine(),
/// r#"
/// (module
/// (import "" "" (func $log_str (param i32 i32)))
/// (func (export "foo")
/// i32.const 4 ;; ptr
/// i32.const 13 ;; len
/// call $log_str)
/// (memory (export "memory") 1)
/// (data (i32.const 4) "Hello, world!"))
/// "#,
/// )?;
///
/// let Some(module_export) = module.get_export_index("memory") else {
/// anyhow::bail!("failed to find `memory` export in module");
/// };
///
/// let log_str = Func::wrap(&mut store, move |mut caller: Caller<'_, ()>, ptr: i32, len: i32| {
/// let mem = match caller.get_module_export(&module_export) {
/// Some(Extern::Memory(mem)) => mem,
/// _ => anyhow::bail!("failed to find host memory"),
/// };
/// let data = mem.data(&caller)
/// .get(ptr as u32 as usize..)
/// .and_then(|arr| arr.get(..len as u32 as usize));
/// let string = match data {
/// Some(data) => match str::from_utf8(data) {
/// Ok(s) => s,
/// Err(_) => anyhow::bail!("invalid utf-8"),
/// },
/// None => anyhow::bail!("pointer/length out of bounds"),
/// };
/// assert_eq!(string, "Hello, world!");
/// println!("{}", string);
/// Ok(())
/// });
/// let instance = Instance::new(&mut store, &module, &[log_str.into()])?;
/// let foo = instance.get_typed_func::<(), ()>(&mut store, "foo")?;
/// foo.call(&mut store, ())?;
/// # Ok(())
/// # }
/// ```
pub fn get_module_export(&mut self, export: &ModuleExport) -> Option<Extern> {
self.caller
.host_state()
.downcast_ref::<Instance>()?
.get_module_export(&mut self.store, export)
}

/// Access the underlying data owned by this `Store`.
///
/// Same as [`Store::data`](crate::Store::data)
Expand Down