Files
wasmtime/crates/wiggle/generate/src/module_trait.rs
Andrew Brown 3ce896f69d wiggle: choose between &mut self and &self (#5428)
Previously, all Wiggle-generated traits were generated with `&mut self`
signatures. With the addition of the `mutable` configuration option to
`from_witx!` and `wasmtime_integration!`, one can disable this, emitting
instead traits that use `&self` (i.e., `mutable: false`). This change is
helpful for implementing wasi-threads: WASI implementations with
interior mutability will now be able to communitcate this to their
Wiggle-generated code.

The other side of this change is the `get_cx` closure passed to Wiggle's
generated `add_to_linker` function. When `mutability` is set to `true`
(default), the `get_cx` function takes a `&mut` data structure from the
store and returns a corresponding `&mut` reference, usually to a field
of the passed-in structure. When `mutability: false`, the `get_cx`
closure will still take a `&mut` data structure but now will return a
`&` reference.
2022-12-13 14:38:47 -08:00

103 lines
3.5 KiB
Rust

use proc_macro2::TokenStream;
use quote::quote;
use crate::codegen_settings::{CodegenSettings, ErrorType};
use crate::lifetimes::{anon_lifetime, LifetimeExt};
use crate::names;
use witx::Module;
pub fn passed_by_reference(ty: &witx::Type) -> bool {
match ty {
witx::Type::Pointer(_) | witx::Type::ConstPointer(_) | witx::Type::List(_) => true,
witx::Type::Record(r) => r.bitflags_repr().is_none(),
witx::Type::Variant(v) => !v.is_enum(),
_ => false,
}
}
pub fn define_module_trait(m: &Module, settings: &CodegenSettings) -> TokenStream {
let traitname = names::trait_name(&m.name);
let traitmethods = m.funcs().map(|f| {
// Check if we're returning an entity anotated with a lifetime,
// in which case, we'll need to annotate the function itself, and
// hence will need an explicit lifetime (rather than anonymous)
let (lifetime, is_anonymous) = if f
.params
.iter()
.chain(&f.results)
.any(|ret| ret.tref.needs_lifetime())
{
(quote!('a), false)
} else {
(anon_lifetime(), true)
};
let funcname = names::func(&f.name);
let args = f.params.iter().map(|arg| {
let arg_name = names::func_param(&arg.name);
let arg_typename = names::type_ref(&arg.tref, lifetime.clone());
let arg_type = if passed_by_reference(&*arg.tref.type_()) {
quote!(&#arg_typename)
} else {
quote!(#arg_typename)
};
quote!(#arg_name: #arg_type)
});
let result = match f.results.len() {
0 if f.noreturn => quote!(wiggle::anyhow::Error),
0 => quote!(()),
1 => {
let (ok, err) = match &**f.results[0].tref.type_() {
witx::Type::Variant(v) => match v.as_expected() {
Some(p) => p,
None => unimplemented!("anonymous variant ref {:?}", v),
},
_ => unimplemented!(),
};
let ok = match ok {
Some(ty) => names::type_ref(ty, lifetime.clone()),
None => quote!(()),
};
let err = match err {
Some(ty) => match settings.errors.for_abi_error(ty) {
Some(ErrorType::User(custom)) => {
let tn = custom.typename();
quote!(super::#tn)
}
Some(ErrorType::Generated(g)) => g.typename(),
None => names::type_ref(ty, lifetime.clone()),
},
None => quote!(()),
};
quote!(Result<#ok, #err>)
}
_ => unimplemented!(),
};
let asyncness = if settings.get_async(&m, &f).is_sync() {
quote!()
} else {
quote!(async)
};
let self_ = if settings.mutable {
quote!(&mut self)
} else {
quote!(&self)
};
if is_anonymous {
quote!(#asyncness fn #funcname(#self_, #(#args),*) -> #result; )
} else {
quote!(#asyncness fn #funcname<#lifetime>(#self_, #(#args),*) -> #result;)
}
});
quote! {
#[wiggle::async_trait]
pub trait #traitname {
#(#traitmethods)*
}
}
}