1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
//! Usage:
//!
//! ``` no_run
//! fn main() {
//! puffin::set_scopes_on(true); // you may want to control this with a flag
//!
//! // game loop
//! loop {
//! puffin::GlobalProfiler::lock().new_frame();
//!
//! {
//! puffin::profile_scope!("slow_code");
//! slow_code();
//! }
//!
//! }
//! }
//!
//! # fn slow_code(){}
//! ```
// BEGIN - Embark standard lints v5 for Rust 1.55+
// do not change or add/remove here, but one can add exceptions after this section
// for more info see: <https://github.com/EmbarkStudios/rust-ecosystem/issues/59>
#![deny(unsafe_code)]
#![warn(
clippy::all,
clippy::await_holding_lock,
clippy::char_lit_as_u8,
clippy::checked_conversions,
clippy::dbg_macro,
clippy::debug_assert_with_mut_call,
clippy::disallowed_methods,
clippy::disallowed_types,
clippy::doc_markdown,
clippy::empty_enum,
clippy::enum_glob_use,
clippy::exit,
clippy::expl_impl_clone_on_copy,
clippy::explicit_deref_methods,
clippy::explicit_into_iter_loop,
clippy::fallible_impl_from,
clippy::filter_map_next,
clippy::flat_map_option,
clippy::float_cmp_const,
clippy::fn_params_excessive_bools,
clippy::from_iter_instead_of_collect,
clippy::if_let_mutex,
clippy::implicit_clone,
clippy::imprecise_flops,
clippy::inefficient_to_string,
clippy::invalid_upcast_comparisons,
clippy::large_digit_groups,
clippy::large_stack_arrays,
clippy::large_types_passed_by_value,
clippy::let_unit_value,
clippy::linkedlist,
clippy::lossy_float_literal,
clippy::macro_use_imports,
clippy::manual_ok_or,
clippy::map_err_ignore,
clippy::map_flatten,
clippy::map_unwrap_or,
clippy::match_on_vec_items,
clippy::match_same_arms,
clippy::match_wild_err_arm,
clippy::match_wildcard_for_single_variants,
clippy::mem_forget,
clippy::mismatched_target_os,
clippy::missing_enforced_import_renames,
clippy::mut_mut,
clippy::mutex_integer,
clippy::needless_borrow,
clippy::needless_continue,
clippy::needless_for_each,
clippy::option_option,
clippy::path_buf_push_overwrite,
clippy::ptr_as_ptr,
clippy::rc_mutex,
clippy::ref_option_ref,
clippy::rest_pat_in_fully_bound_structs,
clippy::same_functions_in_if_condition,
clippy::semicolon_if_nothing_returned,
clippy::single_match_else,
clippy::string_add_assign,
clippy::string_add,
clippy::string_lit_as_bytes,
clippy::string_to_string,
clippy::todo,
clippy::trait_duplication_in_bounds,
clippy::unimplemented,
clippy::unnested_or_patterns,
clippy::unused_self,
clippy::useless_transmute,
clippy::verbose_file_reads,
clippy::zero_sized_map_values,
future_incompatible,
nonstandard_style,
rust_2018_idioms
)]
// END - Embark standard lints v0.5 for Rust 1.55+
// crate-specific exceptions:
mod data;
mod frame_data;
mod merge;
mod profile_view;
pub use data::*;
pub use frame_data::{FrameData, FrameMeta, UnpackedFrameData};
pub use merge::*;
pub use profile_view::{select_slowest, FrameView, GlobalFrameView};
use std::collections::BTreeMap;
use std::sync::{
atomic::{AtomicBool, Ordering},
Arc,
};
static MACROS_ON: AtomicBool = AtomicBool::new(false);
/// Turn on/off the profiler macros ([`profile_function`], [`profile_scope`] etc).
/// When off, these calls take only 1-2 ns to call (100x faster).
/// This is [`false`] by default.
pub fn set_scopes_on(on: bool) {
MACROS_ON.store(on, Ordering::Relaxed);
}
/// Are the profiler scope macros turned on?
/// This is [`false`] by default.
pub fn are_scopes_on() -> bool {
MACROS_ON.load(Ordering::Relaxed)
}
/// All times are expressed as integer nanoseconds since some event.
pub type NanoSecond = i64;
// ----------------------------------------------------------------------------
/// Stream of profiling events from one thread.
#[derive(Clone, Default)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
pub struct Stream(Vec<u8>);
impl Stream {
pub fn is_empty(&self) -> bool {
self.0.is_empty()
}
pub fn len(&self) -> usize {
self.0.len()
}
pub fn bytes(&self) -> &[u8] {
&self.0
}
pub fn clear(&mut self) {
self.0.clear();
}
fn extend(&mut self, bytes: &[u8]) {
self.0.extend(bytes);
}
}
impl From<Vec<u8>> for Stream {
fn from(v: Vec<u8>) -> Self {
Self(v)
}
}
// ----------------------------------------------------------------------------
/// Used when parsing a Stream.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct Record<'s> {
pub start_ns: NanoSecond,
pub duration_ns: NanoSecond,
/// e.g. function name. Mandatory. Used to identify records.
/// Does not need to be globally unique, just unique in the parent scope.
/// Example: "load_image"
pub id: &'s str,
/// e.g. file name. Optional. Used for finding the location of the profiler scope.
/// Example: "my_library/image_loader.rs:52"
pub location: &'s str,
/// e.g. function argument, like a mesh name. Optional.
/// Example: "image.png".
pub data: &'s str,
}
impl<'s> Record<'s> {
#[inline]
pub fn stop_ns(&self) -> NanoSecond {
self.start_ns + self.duration_ns
}
}
/// Used when parsing a Stream.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct Scope<'s> {
pub record: Record<'s>,
/// Stream offset for first child.
pub child_begin_position: u64,
/// Stream offset after last child.
pub child_end_position: u64,
/// Stream offset for next sibling (if any).
pub next_sibling_position: u64,
}
/// Used to identify one source of profiling data.
#[derive(Clone, Debug, Hash, Eq, PartialEq, Ord, PartialOrd)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
pub struct ThreadInfo {
/// Useful for ordering threads.
pub start_time_ns: Option<NanoSecond>,
/// Name of the thread
pub name: String,
}
// ----------------------------------------------------------------------------
pub type FrameIndex = u64;
/// A [`Stream`] plus some info about it.
#[derive(Clone)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
pub struct StreamInfo {
/// The raw profile data.
pub stream: Stream,
/// Total number of scopes in the stream.
pub num_scopes: usize,
/// The depth of the deepest scope.
/// `0` mean no scopes, `1` some scopes without children, etc.
pub depth: usize,
/// The smallest and largest nanosecond value in the stream.
///
/// The default value is ([`NanoSecond::MAX`], [`NanoSecond::MIN`]) which indicates an empty stream.
pub range_ns: (NanoSecond, NanoSecond),
}
impl Default for StreamInfo {
fn default() -> Self {
Self {
stream: Default::default(),
num_scopes: 0,
depth: 0,
range_ns: (NanoSecond::MAX, NanoSecond::MIN),
}
}
}
impl StreamInfo {
/// Parse a stream to count the depth, number of scopes in it etc.
///
/// Try to avoid calling this, and instead keep score while collecting a [`StreamInfo`].
pub fn parse(stream: Stream) -> Result<StreamInfo> {
let top_scopes = Reader::from_start(&stream).read_top_scopes()?;
if top_scopes.is_empty() {
Ok(StreamInfo {
stream,
num_scopes: 0,
depth: 0,
range_ns: (NanoSecond::MAX, NanoSecond::MIN),
})
} else {
let (num_scopes, depth) = Reader::count_scope_and_depth(&stream)?;
let min_ns = top_scopes.first().unwrap().record.start_ns;
let max_ns = top_scopes.last().unwrap().record.stop_ns();
Ok(StreamInfo {
stream,
num_scopes,
depth,
range_ns: (min_ns, max_ns),
})
}
}
pub fn extend(&mut self, other: &StreamInfoRef<'_>) {
self.stream.extend(other.stream);
self.num_scopes += other.num_scopes;
self.depth = self.depth.max(other.depth);
self.range_ns.0 = self.range_ns.0.min(other.range_ns.0);
self.range_ns.1 = self.range_ns.1.max(other.range_ns.1);
}
pub fn clear(&mut self) {
let Self {
stream,
num_scopes,
depth,
range_ns,
} = self;
stream.clear();
*num_scopes = 0;
*depth = 0;
*range_ns = (NanoSecond::MAX, NanoSecond::MIN);
}
pub fn as_stream_into_ref(&self) -> StreamInfoRef<'_> {
StreamInfoRef {
stream: self.stream.bytes(),
num_scopes: self.num_scopes,
depth: self.depth,
range_ns: self.range_ns,
}
}
}
/// A reference to the contents of a [`StreamInfo`].
#[derive(Clone, Copy)]
pub struct StreamInfoRef<'a> {
/// The raw profile data.
pub stream: &'a [u8],
/// Total number of scopes in the stream.
pub num_scopes: usize,
/// The depth of the deepest scope.
/// `0` mean no scopes, `1` some scopes without children, etc.
pub depth: usize,
/// The smallest and largest nanosecond value in the stream.
///
/// The default value is ([`NanoSecond::MAX`], [`NanoSecond::MIN`]) which indicates an empty stream.
pub range_ns: (NanoSecond, NanoSecond),
}
// ----------------------------------------------------------------------------
type NsSource = fn() -> NanoSecond;
type ThreadReporter = fn(ThreadInfo, &StreamInfoRef<'_>);
/// Report a stream of profile data from a thread to the [`GlobalProfiler`] singleton.
pub fn global_reporter(info: ThreadInfo, stream_info: &StreamInfoRef<'_>) {
GlobalProfiler::lock().report(info, stream_info);
}
/// Collects profiling data for one thread
pub struct ThreadProfiler {
stream_info: StreamInfo,
/// Current depth.
depth: usize,
now_ns: NsSource,
reporter: ThreadReporter,
start_time_ns: Option<NanoSecond>,
}
impl Default for ThreadProfiler {
fn default() -> Self {
Self {
stream_info: Default::default(),
depth: 0,
now_ns: crate::now_ns,
reporter: global_reporter,
start_time_ns: None,
}
}
}
impl ThreadProfiler {
/// Explicit initialize with custom callbacks.
///
/// If not called, each thread will use the default nanosecond source ([`now_ns()`])
/// and report scopes to the global profiler ([`global_reporter()`]).
///
/// For instance, when compiling for WASM the default timing function ([`now_ns()`]) won't work,
/// so you'll want to call `puffin::ThreadProfiler::initialize(my_timing_function, puffin::global_reporter);`.
pub fn initialize(now_ns: NsSource, reporter: ThreadReporter) {
ThreadProfiler::call(|tp| {
tp.now_ns = now_ns;
tp.reporter = reporter;
});
}
/// Returns position where to write scope size once the scope is closed.
#[must_use]
pub fn begin_scope(&mut self, id: &str, location: &str, data: &str) -> usize {
let now_ns = (self.now_ns)();
self.start_time_ns = Some(self.start_time_ns.unwrap_or(now_ns));
self.depth += 1;
self.stream_info.range_ns.0 = self.stream_info.range_ns.0.min(now_ns);
self.stream_info
.stream
.begin_scope(now_ns, id, location, data)
}
pub fn end_scope(&mut self, start_offset: usize) {
let now_ns = (self.now_ns)();
self.stream_info.depth = self.stream_info.depth.max(self.depth);
self.stream_info.num_scopes += 1;
self.stream_info.range_ns.1 = self.stream_info.range_ns.1.max(now_ns);
if self.depth > 0 {
self.depth -= 1;
} else {
eprintln!("puffin ERROR: Mismatched scope begin/end calls");
}
self.stream_info.stream.end_scope(start_offset, now_ns);
if self.depth == 0 {
// We have no open scopes.
// This is a good time to report our profiling stream to the global profiler:
let info = ThreadInfo {
start_time_ns: self.start_time_ns,
name: std::thread::current().name().unwrap_or_default().to_owned(),
};
(self.reporter)(info, &self.stream_info.as_stream_into_ref());
self.stream_info.clear();
}
}
/// Do something with the thread local [`ThreadProfiler`]
#[inline]
pub fn call<R>(f: impl Fn(&mut Self) -> R) -> R {
thread_local! {
pub static THREAD_PROFILER: std::cell::RefCell<ThreadProfiler> = Default::default();
}
THREAD_PROFILER.with(|p| f(&mut p.borrow_mut()))
}
}
// ----------------------------------------------------------------------------
/// Add these to [`GlobalProfiler`] with [`GlobalProfiler::add_sink()`].
pub type FrameSink = Box<dyn Fn(Arc<FrameData>) + Send>;
/// Identifies a specific [`FrameSink`] when added to [`GlobalProfiler`].
#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
pub struct FrameSinkId(u64);
/// Singleton. Collects profiling data from multiple threads
/// and passes them on to different [`FrameSink`]s.
pub struct GlobalProfiler {
current_frame_index: FrameIndex,
current_frame: BTreeMap<ThreadInfo, StreamInfo>,
next_sink_id: FrameSinkId,
sinks: std::collections::HashMap<FrameSinkId, FrameSink>,
}
impl Default for GlobalProfiler {
fn default() -> Self {
Self {
current_frame_index: 0,
current_frame: Default::default(),
next_sink_id: FrameSinkId(1),
sinks: Default::default(),
}
}
}
impl GlobalProfiler {
/// Access to the global profiler singleton.
#[cfg(feature = "parking_lot")]
pub fn lock() -> parking_lot::MutexGuard<'static, Self> {
use once_cell::sync::Lazy;
static GLOBAL_PROFILER: Lazy<parking_lot::Mutex<GlobalProfiler>> =
Lazy::new(Default::default);
GLOBAL_PROFILER.lock()
}
/// Access to the global profiler singleton.
#[cfg(not(feature = "parking_lot"))]
pub fn lock() -> std::sync::MutexGuard<'static, Self> {
use once_cell::sync::Lazy;
static GLOBAL_PROFILER: Lazy<std::sync::Mutex<GlobalProfiler>> =
Lazy::new(Default::default);
GLOBAL_PROFILER.lock().expect("poisoned mutex")
}
/// You need to call this once at the start of every frame.
///
/// It is fine to call this from within a profile scope.
pub fn new_frame(&mut self) {
let current_frame_index = self.current_frame_index;
self.current_frame_index += 1;
let new_frame =
match FrameData::new(current_frame_index, std::mem::take(&mut self.current_frame)) {
Ok(new_frame) => Arc::new(new_frame),
Err(Error::Empty) => {
return; // don't warn about empty frames, just ignore them
}
Err(err) => {
eprintln!("puffin ERROR: Bad frame: {err:?}");
return;
}
};
self.add_frame(new_frame);
}
/// Manually add frame data.
pub fn add_frame(&mut self, new_frame: Arc<FrameData>) {
for sink in self.sinks.values() {
sink(new_frame.clone());
}
}
/// Report some profiling data. Called from [`ThreadProfiler`].
pub fn report(&mut self, info: ThreadInfo, stream_info: &StreamInfoRef<'_>) {
self.current_frame
.entry(info)
.or_default()
.extend(stream_info);
}
/// Tells [`GlobalProfiler`] to call this function with each new finished frame.
///
/// The returned [`FrameSinkId`] can be used to remove the sink with [`Self::remove_sink()`].
pub fn add_sink(&mut self, sink: FrameSink) -> FrameSinkId {
let id = self.next_sink_id;
self.next_sink_id.0 += 1;
self.sinks.insert(id, sink);
id
}
pub fn remove_sink(&mut self, id: FrameSinkId) -> Option<FrameSink> {
self.sinks.remove(&id)
}
}
// ----------------------------------------------------------------------------
/// Returns a high-precision, monotonically increasing nanosecond count since unix epoch.
#[inline]
#[cfg(any(not(target_arch = "wasm32"), feature = "web"))]
pub fn now_ns() -> NanoSecond {
#[cfg(target_arch = "wasm32")]
fn nanos_since_epoch() -> NanoSecond {
(js_sys::Date::new_0().get_time() * 1e6) as _
}
#[cfg(not(target_arch = "wasm32"))]
fn nanos_since_epoch() -> NanoSecond {
if let Ok(duration_since_epoch) = std::time::UNIX_EPOCH.elapsed() {
duration_since_epoch.as_nanos() as NanoSecond
} else {
0 // system time is set before 1970. this should be quite rare.
}
}
// This can maybe be optimized
use instant::Instant;
use once_cell::sync::Lazy;
static START_TIME: Lazy<(NanoSecond, Instant)> =
Lazy::new(|| (nanos_since_epoch(), Instant::now()));
START_TIME.0 + START_TIME.1.elapsed().as_nanos() as NanoSecond
}
#[inline]
#[cfg(all(target_arch = "wasm32", not(feature = "web")))]
pub fn now_ns() -> NanoSecond {
// This should be unused.
panic!("Wasm without the `web` feature requires passing a custom source of time via `ThreadProfiler::initialize`");
}
// ----------------------------------------------------------------------------
// We currently store an Option<ProfilerScope> on the stack (None when profiling is off).
// This currently takes up 16 bytes of stack space. TODO: get this down to 4 bytes.
/// Created by the `puffin::profile*!(...)` macros.
pub struct ProfilerScope {
start_stream_offset: usize,
/// Prevent the scope from being sent between threads.
/// The scope must start/stop on the same thread.
/// In particular, we do NOT want this to migrate threads in some async code.
/// Workaround until `impl !Send for ProfilerScope {}` is stable.
_dont_send_me: std::marker::PhantomData<*const ()>,
}
impl ProfilerScope {
/// The `id` doesn't need to be static, but it should be unchanging,
/// and this is a good way to enforce it.
/// `data` can be changing, i.e. a name of a mesh or a texture.
#[inline]
pub fn new(id: &'static str, location: &str, data: impl AsRef<str>) -> Self {
Self {
start_stream_offset: ThreadProfiler::call(|tp| {
tp.begin_scope(id, location, data.as_ref())
}),
_dont_send_me: Default::default(),
}
}
}
impl Drop for ProfilerScope {
#[inline]
fn drop(&mut self) {
ThreadProfiler::call(|tp| tp.end_scope(self.start_stream_offset));
}
}
#[doc(hidden)]
#[inline(always)]
pub fn type_name_of<T>(_: T) -> &'static str {
std::any::type_name::<T>()
}
/// Returns the name of the calling function without a long module path prefix.
#[macro_export]
macro_rules! current_function_name {
() => {{
fn f() {}
let name = $crate::type_name_of(f);
// Remove "::f" from the name:
let name = &name.get(..name.len() - 3).unwrap();
$crate::clean_function_name(name)
}};
}
#[doc(hidden)]
#[inline]
pub fn clean_function_name(name: &str) -> &str {
if let Some(colon) = name.rfind("::") {
if let Some(colon) = name[..colon].rfind("::") {
// "foo::bar::baz::function_name" -> "baz::function_name"
&name[colon + 2..]
} else {
// "foo::function_name" -> "foo::function_name"
name
}
} else {
name
}
}
#[test]
fn test_clean_function_name() {
assert_eq!(clean_function_name(""), "");
assert_eq!(clean_function_name("foo"), "foo");
assert_eq!(clean_function_name("foo::bar"), "foo::bar");
assert_eq!(clean_function_name("foo::bar::baz"), "bar::baz");
}
/// Returns a shortened path to the current file.
#[macro_export]
macro_rules! current_file_name {
() => {
$crate::short_file_name(file!())
};
}
/// Removes long path prefix to focus on the last parts of the path (and the file name).
#[doc(hidden)]
#[inline]
pub fn short_file_name(name: &str) -> &str {
// TODO: "foo/bar/src/lib.rs" -> "bar/src/lib.rs"
if let Some(separator) = name.rfind(&['/', '\\'][..]) {
// "foo/bar/baz.rs" -> "baz.rs"
&name[separator + 1..]
} else {
name
}
}
#[test]
fn test_short_file_name() {
assert_eq!(short_file_name(""), "");
assert_eq!(short_file_name("foo.rs"), "foo.rs");
assert_eq!(short_file_name("foo/bar.rs"), "bar.rs");
assert_eq!(short_file_name("foo/bar/baz.rs"), "baz.rs");
assert_eq!(short_file_name(r"C:\\windows\is\weird\src.rs"), "src.rs");
}
#[allow(clippy::doc_markdown)] // clippy wants to put "MacBook" in ticks 🙄
/// Automatically name the profiling scope based on function name.
///
/// Names should be descriptive, ASCII and without spaces.
///
/// Example:
/// ```
/// # struct Image {};
/// fn load_image(path: &str) -> Image {
/// puffin::profile_function!();
/// /* … */
/// # let image = Image {};
/// image
/// }
/// ```
///
/// An optional argument can be a string describing e.g. an argument, to help diagnose what was slow.
///
/// ```
/// # struct Image {};
/// fn load_image(path: &str) -> Image {
/// puffin::profile_function!(path);
/// /* … */
/// # let image = Image {};
/// image
/// }
/// ```
///
/// Overhead: around 210 ns on 2020 Intel MacBook Pro.
#[macro_export]
macro_rules! profile_function {
() => {
$crate::profile_function!("");
};
($data:expr) => {
let _profiler_scope = if $crate::are_scopes_on() {
Some($crate::ProfilerScope::new(
$crate::current_function_name!(),
$crate::current_file_name!(),
$data,
))
} else {
None
};
};
}
#[allow(clippy::doc_markdown)] // clippy wants to put "MacBook" in ticks 🙄
/// Profile the current scope with the given name (unique in the parent scope).
///
/// Names should be descriptive, ASCII and without spaces.
///
/// Example: `profile_scope!("load_mesh");`.
///
/// An optional second argument can be a string (e.g. a mesh name) to help diagnose what was slow.
/// Example: `profile_scope!("load_mesh", mesh_name);`
///
/// Overhead: around 140 ns on 2020 Intel MacBook Pro.
#[macro_export]
macro_rules! profile_scope {
($id:expr) => {
$crate::profile_scope!($id, "");
};
($id:expr, $data:expr) => {
let _profiler_scope = if $crate::are_scopes_on() {
Some($crate::ProfilerScope::new(
$id,
$crate::current_file_name!(),
$data,
))
} else {
None
};
};
}