mod-alloc 0.9.1

Allocation profiling for Rust. Counters, peak resident, and call-site grouping with inline backtrace capture. Zero external dependencies in the hot path. Lean dhat replacement targeting MSRV 1.75.
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

//! Inline frame-pointer register capture.
//!
//! Reads the current frame pointer register via `core::arch::asm!`.
//! Supported on `x86_64` (reads `rbp`) and `aarch64` (reads `x29`).
//! On any other target the function returns `0`, which causes the
//! walker to terminate immediately with zero frames captured.
//!
//! Frame-pointer-based capture only works when the calling code
//! was compiled with frame pointers enabled. See `build.rs` for
//! the warning emitted at compile time when the toolchain is
//! likely missing them.

/// Read the calling frame's saved frame pointer.
///
/// Marked `#[inline(always)]` so the FP captured corresponds to
/// the caller's frame, not this helper's. Callers can pass the
/// result into `walk::walk` to obtain return addresses.
#[inline(always)]
pub(crate) fn current_fp() -> u64 {
    #[cfg(target_arch = "x86_64")]
    unsafe {
        let fp: u64;
        core::arch::asm!(
            "mov {fp}, rbp",
            fp = out(reg) fp,
            options(nomem, nostack, preserves_flags)
        );
        fp
    }

    #[cfg(target_arch = "aarch64")]
    unsafe {
        let fp: u64;
        core::arch::asm!(
            "mov {fp}, x29",
            fp = out(reg) fp,
            options(nomem, nostack, preserves_flags)
        );
        fp
    }

    #[cfg(not(any(target_arch = "x86_64", target_arch = "aarch64")))]
    {
        0
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn current_fp_is_nonzero_on_supported_archs() {
        #[cfg(any(target_arch = "x86_64", target_arch = "aarch64"))]
        assert_ne!(current_fp(), 0, "FP register must be live in test fn");
    }

    #[test]
    #[cfg(any(target_arch = "x86_64", target_arch = "aarch64"))]
    fn current_fp_changes_across_calls() {
        #[inline(never)]
        fn deeper() -> u64 {
            // Force a stack-frame allocation so the captured FP
            // differs from the caller's. Without
            // `-C force-frame-pointers=yes` the FP register may
            // be reused, so we use the address of a local as a
            // proxy for the frame.
            let sentinel: u64 = 0;
            let probe = &sentinel as *const u64 as u64;
            core::hint::black_box(probe);
            current_fp()
        }
        let a = current_fp();
        let b = deeper();
        // Either the FP register itself moved (with frame
        // pointers) or, if it did not, the test still verifies
        // both calls produced a non-zero result. Soft assertion:
        // any failure here points to a build without FPs, which
        // build.rs already warned about.
        if a == b {
            assert_ne!(a, 0);
            assert_ne!(b, 0);
        } else {
            assert_ne!(a, b);
        }
    }
}