T0b1/wasmtime
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

wiggle: allow disable tracing in Wiggle-generated code (#5146)

Browse Source 
Wiggle generates code that instruments APIs with tracing code. This is
handy for diagnosing issues at runtime, but when inspecting the output
of Wiggle, it can make the generated code difficult for a human to
decipher. This change makes tracing a default but optional feature,
allowing users to avoid tracing code with commands like `cargo expand
--no-default-features`. This should be no change for current crates
depending on `wiggle`, `wiggle-macro`, and `wiggle-generate`.

review: add 'tracing' feature to wasi-common

review: switch to using macro configuration parsing

Co-authored-by: Andrew Brown <andrew.brown@intel.com>
This commit is contained in:
Pat Hickey
2022-10-27 11:26:54 -07:00
committed by GitHub
parent 3cbd490d52
commit 2702619427
5 changed files with 63 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
crates/wiggle/generate/src/funcs.rs
View File

@@ -84,6 +84,16 @@ fn _define_func(
);
);
if settings.get_async(&module, &func).is_sync() {
let traced_body = if settings.tracing {
quote!(
#mk_span
_span.in_scope(|| {
#body
})
)
} else {
quote!(#body)
};
(
quote!(
#[allow(unreachable_code)] // deals with warnings in noreturn functions
@@ -93,15 +103,23 @@ fn _define_func(
#(#abi_params),*
) -> Result<#abi_ret, #rt::wasmtime_crate::Trap> {
use std::convert::TryFrom as _;
#mk_span
_span.in_scope(|| {
#body
})
#traced_body
}
),
bounds,
)
} else {
let traced_body = if settings.tracing {
quote!(
use #rt::tracing::Instrument as _;
#mk_span
async move {
#body
}.instrument(_span)
)
} else {
quote!(#body)
};
(
quote!(
#[allow(unreachable_code)] // deals with warnings in noreturn functions
@@ -111,11 +129,7 @@ fn _define_func(
#(#abi_params),*
) -> impl std::future::Future<Output = Result<#abi_ret, #rt::wasmtime_crate::Trap>> + 'a {
use std::convert::TryFrom as _;
use #rt::tracing::Instrument as _;
#mk_span
async move {
#body
}.instrument(_span)
#traced_body
}
),
bounds,
@@ -243,7 +257,7 @@ impl witx::Bindgen for Rust<'_> {
args.push(quote!(#name));
}
}
if func.params.len() > 0 {
if self.settings.tracing && func.params.len() > 0 {
let args = func
.params
.iter()
@@ -272,12 +286,14 @@ impl witx::Bindgen for Rust<'_> {
let ret = #trait_name::#ident(ctx, #(#args),*).await;
})
};
self.src.extend(quote! {
#rt::tracing::event!(
#rt::tracing::Level::TRACE,
result = #rt::tracing::field::debug(&ret),
);
});
if self.settings.tracing {
self.src.extend(quote! {
#rt::tracing::event!(
#rt::tracing::Level::TRACE,
result = #rt::tracing::field::debug(&ret),
);
});
}
if func.results.len() > 0 {
results.push(quote!(ret));