timetrace 0.2.2

Lightweight Rust profiling library with RAII and Chrome/Perfetto trace support
Documentation 
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

use crate::profile_result::ProfileResult;

use once_cell::sync::Lazy;
use parking_lot::Mutex;

use crate::backends::base::TracingBackend;

#[cfg(feature = "json")]
use crate::backends::json_profiler::JsonProfiler;

#[cfg(feature = "tracy")]
use crate::backends::tracy_profiler::TracyProfiler;

static PROFILER: Lazy<Mutex<Profiler>> = Lazy::new(|| Mutex::new(Profiler::new()));

pub struct Profiler {
    #[cfg(feature = "json")]
    backend: JsonProfiler,

    #[cfg(feature = "tracy")]
    backend: TracyProfiler,
}

impl Profiler {
    fn new() -> Self {
        Self {
            #[cfg(feature = "json")]
            backend: JsonProfiler::new(),

            #[cfg(feature = "tracy")]
            backend: TracyProfiler::new(),
        }
    }

    pub fn get() -> &'static Mutex<Profiler> {
        &PROFILER
    }

    pub fn write_profile(&mut self, result: &ProfileResult) {
        #[cfg(feature = "json")]
        self.backend.record_event(result);

        #[cfg(feature = "tracy")]
        self.backend.record_event(result);
    }

    pub fn frame_count(&self) -> usize {
        #[cfg(any(feature = "json", feature = "tracy"))]
        return self.backend.frame_count;
        #[cfg(not(any(feature = "json", feature = "tracy")))]
        return 0;
    }
}

impl TracingBackend for Profiler {
    fn begin_session(&mut self, name: &str, filepath: &str) {
        #[cfg(feature = "json")]
        self.backend.begin_session(name, filepath);

        #[cfg(feature = "tracy")]
        self.backend.begin_session(name, filepath);
    }

    fn begin_session_limited(
        &mut self,
        name: &str,
        filepath: &str,
        max_frames: Option<usize>,
        max_duration_ms: Option<u64>,
    ) {
        #[cfg(feature = "json")]
        self.backend
            .begin_session_limited(name, filepath, max_frames, max_duration_ms);

        #[cfg(feature = "tracy")]
        self.backend
            .begin_session_limited(name, filepath, max_frames, max_duration_ms);
    }

    fn end_session(&mut self) -> Result<(), String> {
        #[cfg(feature = "json")]
        self.backend.end_session()?;
        Ok(())
    }

    fn new_frame(&mut self) {
        #[cfg(feature = "json")]
        self.backend.new_frame();
        #[cfg(feature = "tracy")]
        self.backend.new_frame();
    }

    fn record_event(&mut self, event: &ProfileResult) {
        #[cfg(feature = "json")]
        self.backend.record_event(event);

        #[cfg(feature = "tracy")]
        self.backend.record_event(event);
    }

    fn record_span(&mut self, name: &str) {
        #[cfg(feature = "json")]
        self.backend.record_span(name);

        #[cfg(feature = "tracy")]
        self.backend.record_span(name);
    }
}