3b7cb6ee64
* Enable jitdump profiling support by default This the result of some of the investigation I was doing for #1017. I've done a number of refactorings here which culminated in a number of changes that all amount to what I think should result in jitdump support being enabled by default: * Pass in a list of finished functions instead of just a range to ensure that we're emitting jit dump data for a specific module rather than a whole `CodeMemory` which may have other modules. * Define `ProfilingStrategy` in the `wasmtime` crate to have everything locally-defined * Add support to the C API to enable profiling * Documentation added for profiling with jitdump to the book * Split out supported/unsupported files in `jitdump.rs` to avoid having lots of `#[cfg]`. * Make dependencies optional that are only used for `jitdump`. * Move initialization up-front to `JitDumpAgent::new()` instead of deferring it to the first module. * Pass around `Arc<dyn ProfilingAgent>` instead of `Option<Arc<Mutex<Box<dyn ProfilingAgent>>>>` The `jitdump` Cargo feature is now enabled by default which means that our published binaries, C API artifacts, and crates will support profiling at runtime by default. The support I don't think is fully fleshed out and working but I think it's probably in a good enough spot we can get users playing around with it!
70 lines
1.9 KiB
Rust
70 lines
1.9 KiB
Rust
use std::error::Error;
|
|
use std::fmt;
|
|
use wasmtime_environ::entity::{EntityRef, PrimaryMap};
|
|
use wasmtime_environ::wasm::DefinedFuncIndex;
|
|
use wasmtime_environ::Module;
|
|
use wasmtime_runtime::VMFunctionBody;
|
|
|
|
cfg_if::cfg_if! {
|
|
if #[cfg(all(feature = "jitdump", target_os = "linux"))] {
|
|
#[path = "jitdump_linux.rs"]
|
|
mod jitdump;
|
|
} else {
|
|
#[path = "jitdump_disabled.rs"]
|
|
mod jitdump;
|
|
}
|
|
}
|
|
|
|
pub use crate::jitdump::JitDumpAgent;
|
|
|
|
/// Common interface for profiling tools.
|
|
pub trait ProfilingAgent: Send + Sync + 'static {
|
|
/// Notify the profiler of a new module loaded into memory
|
|
fn module_load(
|
|
&self,
|
|
module: &Module,
|
|
functions: &PrimaryMap<DefinedFuncIndex, *mut [VMFunctionBody]>,
|
|
dbg_image: Option<&[u8]>,
|
|
) -> ();
|
|
}
|
|
|
|
/// Default agent for unsupported profiling build.
|
|
#[derive(Debug, Default, Clone, Copy)]
|
|
pub struct NullProfilerAgent;
|
|
|
|
#[derive(Debug)]
|
|
struct NullProfilerAgentError;
|
|
|
|
impl fmt::Display for NullProfilerAgentError {
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
write!(f, "A profiler agent is not supported by this build")
|
|
}
|
|
}
|
|
|
|
// This is important for other errors to wrap this one.
|
|
impl Error for NullProfilerAgentError {
|
|
fn source(&self) -> Option<&(dyn Error + 'static)> {
|
|
// Generic error, underlying cause isn't tracked.
|
|
None
|
|
}
|
|
}
|
|
|
|
impl ProfilingAgent for NullProfilerAgent {
|
|
fn module_load(
|
|
&self,
|
|
_module: &Module,
|
|
_functions: &PrimaryMap<DefinedFuncIndex, *mut [VMFunctionBody]>,
|
|
_dbg_image: Option<&[u8]>,
|
|
) -> () {
|
|
}
|
|
}
|
|
|
|
#[allow(dead_code)]
|
|
fn debug_name(module: &Module, index: DefinedFuncIndex) -> String {
|
|
let index = module.local.func_index(index);
|
|
match module.func_names.get(&index) {
|
|
Some(s) => s.clone(),
|
|
None => format!("wasm::wasm-function[{}]", index.index()),
|
|
}
|
|
}
|