[go: up one dir, main page]

dhat 0.3.3

A library for heap profiling and ad hoc profiling with DHAT.
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
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

#[global_allocator]
static ALLOC: dhat::Alloc = dhat::Alloc;

fn f2() {
    dhat::ad_hoc_event(1);
    dhat::ad_hoc_event(2);
}

fn f1() {
    f2();
    dhat::ad_hoc_event(3);
}

#[test]
fn main() {
    use serde_json::Value::{self, *};

    // Ignored because profiling hasn't started yet.
    dhat::ad_hoc_event(3);

    let mem = {
        let mut profiler = std::mem::ManuallyDrop::new(
            dhat::Profiler::builder()
                .ad_hoc()
                .trim_backtraces(Some(usize::MAX))
                .eprint_json()
                .build(),
        );

        let stats = dhat::AdHocStats::get();
        assert_eq!(stats.total_events, 0);
        assert_eq!(stats.total_units, 0);

        dhat::ad_hoc_event(100);
        f1();

        // This should have no effect, because we're ad hoc profiling.
        let _v: Vec<u8> = Vec::with_capacity(100);

        let stats = dhat::AdHocStats::get();
        assert_eq!(stats.total_events, 4);
        assert_eq!(stats.total_units, 106);

        profiler.drop_and_get_memory_output()
    };

    // Ignored because profiling has finished.
    dhat::ad_hoc_event(5);

    // Check basics.
    let mut v: Value = serde_json::from_str(&mem).unwrap();
    assert_eq!(v["dhatFileVersion"].as_i64().unwrap(), 2);
    assert_eq!(v["mode"], "rust-ad-hoc");
    assert_eq!(v["verb"], "Allocated");
    assert_eq!(v["bklt"], Bool(false));
    assert_eq!(v["bkacc"], Bool(false));
    assert!(matches!(&v["bu"], String(s) if s == "unit"));
    assert!(matches!(&v["bsu"], String(s) if s == "units"));
    assert!(matches!(&v["bksu"], String(s) if s == "events"));
    assert_eq!(v["tu"], "µs");
    assert_eq!(v["Mtu"], "s");
    assert!(matches!(&v["cmd"], String(s) if s.contains("ad_hoc")));
    assert!(matches!(v["pid"], Number(_)));
    assert_ne!(v["te"].as_i64().unwrap(), 0);
    assert_eq!(v["tg"], Null);

    // Order PPs by "tb" field.
    let pps = v["pps"].as_array_mut().unwrap();
    pps.sort_unstable_by_key(|pp| pp["tb"].as_i64().unwrap());
    pps.reverse();

    // main
    let pp0 = &pps[0];
    assert_eq!(pp0["tb"].as_i64().unwrap(), 100);
    assert_eq!(pp0["tbk"].as_i64().unwrap(), 1);
    assert_eq!(pp0["tl"], Null);
    assert_eq!(pp0["mb"], Null);
    assert_eq!(pp0["mbk"], Null);
    assert_eq!(pp0["gb"], Null);
    assert_eq!(pp0["gbk"], Null);
    assert_eq!(pp0["eb"], Null);
    assert_eq!(pp0["ebk"], Null);
    assert!(matches!(pp0["fs"], Array(_)));

    // f1 (second)
    let pp1 = &pps[1];
    assert_eq!(pp1["tb"].as_i64().unwrap(), 3);
    assert_eq!(pp1["tbk"].as_i64().unwrap(), 1);
    assert_eq!(pp1["tl"], Null);
    assert_eq!(pp1["mb"], Null);
    assert_eq!(pp1["mbk"], Null);
    assert_eq!(pp1["gb"], Null);
    assert_eq!(pp1["gbk"], Null);
    assert_eq!(pp1["eb"], Null);
    assert_eq!(pp1["ebk"], Null);
    assert!(matches!(pp1["fs"], Array(_)));

    // f2 (second)
    let pp2 = &pps[2];
    assert_eq!(pp2["tb"].as_i64().unwrap(), 2);
    assert_eq!(pp2["tbk"].as_i64().unwrap(), 1);
    assert_eq!(pp2["tl"], Null);
    assert_eq!(pp2["mb"], Null);
    assert_eq!(pp2["mbk"], Null);
    assert_eq!(pp2["gb"], Null);
    assert_eq!(pp2["gbk"], Null);
    assert_eq!(pp2["eb"], Null);
    assert_eq!(pp2["ebk"], Null);
    assert!(matches!(pp2["fs"], Array(_)));

    // f2 (first)
    let pp3 = &pps[3];
    assert_eq!(pp3["tb"].as_i64().unwrap(), 1);
    assert_eq!(pp3["tbk"].as_i64().unwrap(), 1);
    assert_eq!(pp3["tl"], Null);
    assert_eq!(pp3["mb"], Null);
    assert_eq!(pp3["mbk"], Null);
    assert_eq!(pp3["gb"], Null);
    assert_eq!(pp3["gbk"], Null);
    assert_eq!(pp3["eb"], Null);
    assert_eq!(pp3["ebk"], Null);
    assert!(matches!(pp3["fs"], Array(_)));

    let ftbl = &v["ftbl"].as_array().unwrap();
    let y = |s| {
        ftbl.iter()
            .find(|&f| f.as_str().unwrap().contains(s))
            .is_some()
    };
    let n = |s| {
        ftbl.iter()
            .find(|&f| f.as_str().unwrap().contains(s))
            .is_none()
    };
    assert!(y("[root]"));
    assert!(y("dhat::ad_hoc_event"));

    // These tests will fail if the repo directory isn't called `dhat-rs`.
    if cfg!(windows) {
        // Some frames are missing on Windows, not sure why.
        assert!(y("ad_hoc::f2 (dhat-rs\\tests\\ad-hoc.rs:5:0)"));
        assert!(y("ad_hoc::f2 (dhat-rs\\tests\\ad-hoc.rs:6:0)"));
        //assert!(y("ad_hoc::f1 (dhat-rs\\tests\\ad-hoc.rs:10:0)"));
        assert!(y("ad_hoc::f1 (dhat-rs\\tests\\ad-hoc.rs:11:0)"));
        assert!(y("ad_hoc::main (dhat-rs\\tests\\ad-hoc.rs:34:0)"));
        //assert!(y("ad_hoc::main (dhat-rs\\tests\\ad-hoc.rs:35:0)"));
    } else {
        assert!(y("ad_hoc::f2 (dhat-rs/tests/ad-hoc.rs:5:5)"));
        assert!(y("ad_hoc::f2 (dhat-rs/tests/ad-hoc.rs:6:5)"));
        assert!(y("ad_hoc::f1 (dhat-rs/tests/ad-hoc.rs:10:5)"));
        assert!(y("ad_hoc::f1 (dhat-rs/tests/ad-hoc.rs:11:5)"));
        assert!(y("ad_hoc::main (dhat-rs/tests/ad-hoc.rs:34:9)"));
        assert!(y("ad_hoc::main (dhat-rs/tests/ad-hoc.rs:35:9)"));
    }

    // This stuff should be removed by backtrace trimming.
    assert!(n("backtrace::"));
    assert!(n("lang_start::"));
    assert!(n("call_once::"));
    assert!(n("catch_unwind::"));
    assert!(n("panic"));

    // A trivial second profiler in the same run, albeit a heap profiler.
    let _profiler = dhat::Profiler::new_heap();
}