1 //! Support for capturing a stack backtrace of an OS thread
3 //! This module contains the support necessary to capture a stack backtrace of a
4 //! running OS thread from the OS thread itself. The `Backtrace` type supports
5 //! capturing a stack trace via the `Backtrace::capture` and
6 //! `Backtrace::force_capture` functions.
8 //! A backtrace is typically quite handy to attach to errors (e.g. types
9 //! implementing `std::error::Error`) to get a causal chain of where an error
12 //! > **Note**: this module is unstable and is designed in [RFC 2504], and you
13 //! > can learn more about its status in the [tracking issue].
15 //! [RFC 2504]: https://github.com/rust-lang/rfcs/blob/master/text/2504-fix-error.md
16 //! [tracking issue]: https://github.com/rust-lang/rust/issues/53487
20 //! Backtraces are attempted to be as accurate as possible, but no guarantees
21 //! are provided about the exact accuracy of a backtrace. Instruction pointers,
22 //! symbol names, filenames, line numbers, etc, may all be incorrect when
23 //! reported. Accuracy is attempted on a best-effort basis, however, and bugs
24 //! are always welcome to indicate areas of improvement!
26 //! For most platforms a backtrace with a filename/line number requires that
27 //! programs be compiled with debug information. Without debug information
28 //! filenames/line numbers will not be reported.
30 //! ## Platform support
32 //! Not all platforms that libstd compiles for support capturing backtraces.
33 //! Some platforms simply do nothing when capturing a backtrace. To check
34 //! whether the platform supports capturing backtraces you can consult the
35 //! `BacktraceStatus` enum as a result of `Backtrace::status`.
37 //! Like above with accuracy platform support is done on a best effort basis.
38 //! Sometimes libraries may not be available at runtime or something may go
39 //! wrong which would cause a backtrace to not be captured. Please feel free to
40 //! report issues with platforms where a backtrace cannot be captured though!
42 //! ## Environment Variables
44 //! The `Backtrace::capture` function may not actually capture a backtrace by
45 //! default. Its behavior is governed by two environment variables:
47 //! * `RUST_LIB_BACKTRACE` - if this is set to `0` then `Backtrace::capture`
48 //! will never capture a backtrace. Any other value this is set to will enable
49 //! `Backtrace::capture`.
51 //! * `RUST_BACKTRACE` - if `RUST_LIB_BACKTRACE` is not set, then this variable
52 //! is consulted with the same rules of `RUST_LIB_BACKTRACE`.
54 //! * If neither of the above env vars are set, then `Backtrace::capture` will
57 //! Capturing a backtrace can be a quite expensive runtime operation, so the
58 //! environment variables allow either forcibly disabling this runtime
59 //! performance hit or allow selectively enabling it in some programs.
61 //! Note that the `Backtrace::force_capture` function can be used to ignore
62 //! these environment variables. Also note that the state of environment
63 //! variables is cached once the first backtrace is created, so altering
64 //! `RUST_LIB_BACKTRACE` or `RUST_BACKTRACE` at runtime may not actually change
65 //! how backtraces are captured.
67 #![unstable(feature = "backtrace", issue = "53487")]
69 // NB: A note on resolution of a backtrace:
71 // Backtraces primarily happen in two steps, one is where we actually capture
72 // the stack backtrace, giving us a list of instruction pointers corresponding
73 // to stack frames. Next we take these instruction pointers and, one-by-one,
74 // turn them into a human readable name (like `main`).
76 // The first phase can be somewhat expensive (walking the stack), especially
77 // on MSVC where debug information is consulted to return inline frames each as
78 // their own frame. The second phase, however, is almost always extremely
79 // expensive (on the order of milliseconds sometimes) when it's consulting debug
82 // We attempt to amortize this cost as much as possible by delaying resolution
83 // of an address to a human readable name for as long as possible. When
84 // `Backtrace::create` is called to capture a backtrace it doesn't actually
85 // perform any symbol resolution, but rather we lazily resolve symbols only just
86 // before they're needed for printing. This way we can make capturing a
87 // backtrace and throwing it away much cheaper, but actually printing a
88 // backtrace is still basically the same cost.
90 // This strategy comes at the cost of some synchronization required inside of a
91 // `Backtrace`, but that's a relatively small price to pay relative to capturing
92 // a backtrace or actually symbolizing it.
96 use crate::sync::atomic::{AtomicUsize, Ordering::SeqCst};
97 use crate::sync::Mutex;
98 use crate::sys_common::backtrace::{lock, output_filename};
100 use backtrace::BytesOrWideString;
101 use backtrace_rs as backtrace;
103 /// A captured OS thread stack backtrace.
105 /// This type represents a stack backtrace for an OS thread captured at a
106 /// previous point in time. In some instances the `Backtrace` type may
107 /// internally be empty due to configuration. For more information see
108 /// `Backtrace::capture`.
110 pub struct Backtrace {
114 /// The current status of a backtrace, indicating whether it was captured or
115 /// whether it is empty for some other reason.
117 #[derive(Debug, PartialEq, Eq)]
118 pub enum BacktraceStatus {
119 /// Capturing a backtrace is not supported, likely because it's not
120 /// implemented for the current platform.
122 /// Capturing a backtrace has been disabled through either the
123 /// `RUST_LIB_BACKTRACE` or `RUST_BACKTRACE` environment variables.
125 /// A backtrace has been captured and the `Backtrace` should print
126 /// reasonable information when rendered.
134 Captured(Mutex<Capture>),
141 frames: Vec<BacktraceFrame>,
144 fn _assert_send_sync() {
145 fn _assert<T: Send + Sync>() {}
146 _assert::<Backtrace>();
150 struct BacktraceFrame {
151 frame: backtrace::Frame,
152 symbols: Vec<BacktraceSymbol>,
156 struct BacktraceSymbol {
157 name: Option<Vec<u8>>,
158 filename: Option<BytesOrWide>,
167 impl fmt::Debug for BytesOrWide {
168 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
172 BytesOrWide::Bytes(w) => BytesOrWideString::Bytes(w),
173 BytesOrWide::Wide(w) => BytesOrWideString::Wide(w),
175 backtrace::PrintFmt::Full,
176 crate::env::current_dir().as_ref().ok(),
182 /// Returns whether backtrace captures are enabled through environment
184 fn enabled() -> bool {
185 // Cache the result of reading the environment variables to make
186 // backtrace captures speedy, because otherwise reading environment
187 // variables every time can be somewhat slow.
188 static ENABLED: AtomicUsize = AtomicUsize::new(0);
189 match ENABLED.load(SeqCst) {
194 let enabled = match env::var("RUST_LIB_BACKTRACE") {
196 Err(_) => match env::var("RUST_BACKTRACE") {
201 ENABLED.store(enabled as usize + 1, SeqCst);
205 /// Capture a stack backtrace of the current thread.
207 /// This function will capture a stack backtrace of the current OS thread of
208 /// execution, returning a `Backtrace` type which can be later used to print
209 /// the entire stack trace or render it to a string.
211 /// This function will be a noop if the `RUST_BACKTRACE` or
212 /// `RUST_LIB_BACKTRACE` backtrace variables are both not set. If either
213 /// environment variable is set and enabled then this function will actually
214 /// capture a backtrace. Capturing a backtrace can be both memory intensive
215 /// and slow, so these environment variables allow liberally using
216 /// `Backtrace::capture` and only incurring a slowdown when the environment
217 /// variables are set.
219 /// To forcibly capture a backtrace regardless of environment variables, use
220 /// the `Backtrace::force_capture` function.
221 #[inline(never)] // want to make sure there's a frame here to remove
222 pub fn capture() -> Backtrace {
223 if !Backtrace::enabled() {
224 return Backtrace { inner: Inner::Disabled };
226 Backtrace::create(Backtrace::capture as usize)
229 /// Forcibly captures a full backtrace, regardless of environment variable
232 /// This function behaves the same as `capture` except that it ignores the
233 /// values of the `RUST_BACKTRACE` and `RUST_LIB_BACKTRACE` environment
234 /// variables, always capturing a backtrace.
236 /// Note that capturing a backtrace can be an expensive operation on some
237 /// platforms, so this should be used with caution in performance-sensitive
239 #[inline(never)] // want to make sure there's a frame here to remove
240 pub fn force_capture() -> Backtrace {
241 Backtrace::create(Backtrace::force_capture as usize)
244 // Capture a backtrace which start just before the function addressed by
246 fn create(ip: usize) -> Backtrace {
248 let mut frames = Vec::new();
249 let mut actual_start = None;
251 backtrace::trace_unsynchronized(|frame| {
252 frames.push(BacktraceFrame { frame: frame.clone(), symbols: Vec::new() });
253 if frame.symbol_address() as usize == ip && actual_start.is_none() {
254 actual_start = Some(frames.len());
260 // If no frames came out assume that this is an unsupported platform
261 // since `backtrace` doesn't provide a way of learning this right now,
262 // and this should be a good enough approximation.
263 let inner = if frames.len() == 0 {
266 Inner::Captured(Mutex::new(Capture {
267 actual_start: actual_start.unwrap_or(0),
276 /// Returns the status of this backtrace, indicating whether this backtrace
277 /// request was unsupported, disabled, or a stack trace was actually
279 pub fn status(&self) -> BacktraceStatus {
281 Inner::Unsupported => BacktraceStatus::Unsupported,
282 Inner::Disabled => BacktraceStatus::Disabled,
283 Inner::Captured(_) => BacktraceStatus::Captured,
288 impl fmt::Display for Backtrace {
289 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
290 let mut capture = match &self.inner {
291 Inner::Unsupported => return fmt.write_str("unsupported backtrace"),
292 Inner::Disabled => return fmt.write_str("disabled backtrace"),
293 Inner::Captured(c) => c.lock().unwrap(),
297 let full = fmt.alternate();
298 let (frames, style) = if full {
299 (&capture.frames[..], backtrace::PrintFmt::Full)
301 (&capture.frames[capture.actual_start..], backtrace::PrintFmt::Short)
304 // When printing paths we try to strip the cwd if it exists, otherwise
305 // we just print the path as-is. Note that we also only do this for the
306 // short format, because if it's full we presumably want to print
308 let cwd = crate::env::current_dir();
309 let mut print_path = move |fmt: &mut fmt::Formatter<'_>, path: BytesOrWideString<'_>| {
310 output_filename(fmt, path, style, cwd.as_ref().ok())
313 let mut f = backtrace::BacktraceFmt::new(fmt, style, &mut print_path);
315 for frame in frames {
316 let mut f = f.frame();
317 if frame.symbols.is_empty() {
318 f.print_raw(frame.frame.ip(), None, None, None)?;
320 for symbol in frame.symbols.iter() {
323 symbol.name.as_ref().map(|b| backtrace::SymbolName::new(b)),
324 symbol.filename.as_ref().map(|b| match b {
325 BytesOrWide::Bytes(w) => BytesOrWideString::Bytes(w),
326 BytesOrWide::Wide(w) => BytesOrWideString::Wide(w),
339 fn resolve(&mut self) {
340 // If we're already resolved, nothing to do!
344 self.resolved = true;
346 // Use the global backtrace lock to synchronize this as it's a
347 // requirement of the `backtrace` crate, and then actually resolve
350 for frame in self.frames.iter_mut() {
351 let symbols = &mut frame.symbols;
353 backtrace::resolve_frame_unsynchronized(&frame.frame, |symbol| {
354 symbols.push(BacktraceSymbol {
355 name: symbol.name().map(|m| m.as_bytes().to_vec()),
356 filename: symbol.filename_raw().map(|b| match b {
357 BytesOrWideString::Bytes(b) => BytesOrWide::Bytes(b.to_owned()),
358 BytesOrWideString::Wide(b) => BytesOrWide::Wide(b.to_owned()),
360 lineno: symbol.lineno(),