aboutsummaryrefslogtreecommitdiffhomepage
path: root/src
diff options
context:
space:
mode:
authorJohannes Stoelp <johannes.stoelp@gmail.com>2024-02-28 19:40:58 +0100
committerJohannes Stoelp <johannes.stoelp@gmail.com>2024-02-28 19:40:58 +0100
commitaee91960846cc5786b1ce0f87b107534440a8450 (patch)
tree38537653b3005c9d5a6c99f2f5ad439ccd322506 /src
parent7cc72737a0140f5f71e9d83d4f87503eb4c7604f (diff)
downloadjuicebox-asm-aee91960846cc5786b1ce0f87b107534440a8450.tar.gz
juicebox-asm-aee91960846cc5786b1ce0f87b107534440a8450.zip
rt: add missing doc for with_profile
Diffstat (limited to 'src')
-rw-r--r--src/rt.rs9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/rt.rs b/src/rt.rs
index f468033..3a77db1 100644
--- a/src/rt.rs
+++ b/src/rt.rs
@@ -90,6 +90,15 @@ impl Runtime {
}
}
+ /// Create a new [Runtime] which also generates static perf metat data.
+ ///
+ /// For each function added to the [Runtime], an entry will be generated in the
+ /// `/tmp/perf-<PID>.map` file, which `perf report` uses to symbolicate unknown addresses.
+ /// This is applicable for static runtimes only.
+ ///
+ /// # Panics
+ ///
+ /// Panics if the `mmap` call fails.
pub fn with_profile() -> Runtime {
let mut rt = Runtime::new();
rt.perf = Some(perf::PerfMap::new());