pprof/backtrace/
mod.rs

1// Copyright 2022 TiKV Project Authors. Licensed under Apache-2.0.
2
3use libc::c_void;
4use std::path::PathBuf;
5
6pub trait Symbol: Sized {
7    fn name(&self) -> Option<Vec<u8>>;
8    fn addr(&self) -> Option<*mut c_void>;
9    fn lineno(&self) -> Option<u32>;
10    fn filename(&self) -> Option<PathBuf>;
11}
12
13impl Symbol for backtrace::Symbol {
14    fn name(&self) -> Option<Vec<u8>> {
15        self.name().map(|name| name.as_bytes().to_vec())
16    }
17
18    fn addr(&self) -> Option<*mut libc::c_void> {
19        self.addr()
20    }
21
22    fn lineno(&self) -> Option<u32> {
23        self.lineno()
24    }
25
26    fn filename(&self) -> Option<std::path::PathBuf> {
27        self.filename().map(|filename| filename.to_owned())
28    }
29}
30
31pub trait Frame: Sized + Clone {
32    type S: Symbol;
33
34    fn resolve_symbol<F: FnMut(&Self::S)>(&self, cb: F);
35    fn symbol_address(&self) -> *mut c_void;
36    fn ip(&self) -> usize;
37}
38
39pub trait Trace {
40    type Frame;
41
42    fn trace<F: FnMut(&Self::Frame) -> bool>(_: *mut libc::c_void, cb: F)
43    where
44        Self: Sized;
45}
46
47#[cfg(not(all(
48    any(
49        target_arch = "x86_64",
50        target_arch = "aarch64",
51        target_arch = "riscv64",
52        target_arch = "loongarch64"
53    ),
54    feature = "frame-pointer"
55)))]
56mod backtrace_rs;
57#[cfg(not(all(
58    any(
59        target_arch = "x86_64",
60        target_arch = "aarch64",
61        target_arch = "riscv64",
62        target_arch = "loongarch64"
63    ),
64    feature = "frame-pointer"
65)))]
66pub use backtrace_rs::Trace as TraceImpl;
67
68#[cfg(all(
69    any(
70        target_arch = "x86_64",
71        target_arch = "aarch64",
72        target_arch = "riscv64",
73        target_arch = "loongarch64"
74    ),
75    feature = "frame-pointer"
76))]
77pub mod frame_pointer;
78#[cfg(all(
79    any(
80        target_arch = "x86_64",
81        target_arch = "aarch64",
82        target_arch = "riscv64",
83        target_arch = "loongarch64"
84    ),
85    feature = "frame-pointer"
86))]
87pub use frame_pointer::Trace as TraceImpl;