Skip to content

Commit

Permalink
std: use LazyLock to lazily resolve backtraces
Browse files Browse the repository at this point in the history
  • Loading branch information
joboet committed Apr 27, 2023
1 parent 8b8110e commit 6776af5
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 54 deletions.
63 changes: 13 additions & 50 deletions library/std/src/backtrace.rs
Original file line number Diff line number Diff line change
Expand Up @@ -89,12 +89,11 @@ mod tests;
// a backtrace or actually symbolizing it.

use crate::backtrace_rs::{self, BytesOrWideString};
use crate::cell::UnsafeCell;
use crate::env;
use crate::ffi::c_void;
use crate::fmt;
use crate::sync::atomic::{AtomicUsize, Ordering::Relaxed};
use crate::sync::Once;
use crate::sync::LazyLock;
use crate::sys_common::backtrace::{lock, output_filename};
use crate::vec::Vec;

Expand Down Expand Up @@ -133,20 +132,14 @@ pub enum BacktraceStatus {
enum Inner {
Unsupported,
Disabled,
Captured(LazilyResolvedCapture),
Captured(LazyLock<Capture, LazyResolve>),
}

struct Capture {
actual_start: usize,
resolved: bool,
frames: Vec<BacktraceFrame>,
}

fn _assert_send_sync() {
fn _assert<T: Send + Sync>() {}
_assert::<Backtrace>();
}

/// A single frame of a backtrace.
#[unstable(feature = "backtrace_frames", issue = "79676")]
pub struct BacktraceFrame {
Expand Down Expand Up @@ -179,7 +172,7 @@ impl fmt::Debug for Backtrace {
let capture = match &self.inner {
Inner::Unsupported => return fmt.write_str("<unsupported>"),
Inner::Disabled => return fmt.write_str("<disabled>"),
Inner::Captured(c) => c.force(),
Inner::Captured(c) => &**c,
};

let frames = &capture.frames[capture.actual_start..];
Expand Down Expand Up @@ -347,11 +340,10 @@ impl Backtrace {
let inner = if frames.is_empty() {
Inner::Unsupported
} else {
Inner::Captured(LazilyResolvedCapture::new(Capture {
Inner::Captured(LazyLock::new(lazy_resolve(Capture {
actual_start: actual_start.unwrap_or(0),
frames,
resolved: false,
}))
})))
};

Backtrace { inner }
Expand All @@ -376,7 +368,7 @@ impl<'a> Backtrace {
#[must_use]
#[unstable(feature = "backtrace_frames", issue = "79676")]
pub fn frames(&'a self) -> &'a [BacktraceFrame] {
if let Inner::Captured(c) = &self.inner { &c.force().frames } else { &[] }
if let Inner::Captured(c) = &self.inner { &c.frames } else { &[] }
}
}

Expand All @@ -386,7 +378,7 @@ impl fmt::Display for Backtrace {
let capture = match &self.inner {
Inner::Unsupported => return fmt.write_str("unsupported backtrace"),
Inner::Disabled => return fmt.write_str("disabled backtrace"),
Inner::Captured(c) => c.force(),
Inner::Captured(c) => &**c,
};

let full = fmt.alternate();
Expand Down Expand Up @@ -430,46 +422,15 @@ impl fmt::Display for Backtrace {
}
}

struct LazilyResolvedCapture {
sync: Once,
capture: UnsafeCell<Capture>,
}

impl LazilyResolvedCapture {
fn new(capture: Capture) -> Self {
LazilyResolvedCapture { sync: Once::new(), capture: UnsafeCell::new(capture) }
}

fn force(&self) -> &Capture {
self.sync.call_once(|| {
// SAFETY: This exclusive reference can't overlap with any others
// `Once` guarantees callers will block until this closure returns
// `Once` also guarantees only a single caller will enter this closure
unsafe { &mut *self.capture.get() }.resolve();
});

// SAFETY: This shared reference can't overlap with the exclusive reference above
unsafe { &*self.capture.get() }
}
}

// SAFETY: Access to the inner value is synchronized using a thread-safe `Once`
// So long as `Capture` is `Sync`, `LazilyResolvedCapture` is too
unsafe impl Sync for LazilyResolvedCapture where Capture: Sync {}

impl Capture {
fn resolve(&mut self) {
// If we're already resolved, nothing to do!
if self.resolved {
return;
}
self.resolved = true;
type LazyResolve = impl FnOnce() -> Capture;

fn lazy_resolve(mut capture: Capture) -> LazyResolve {
move || {
// Use the global backtrace lock to synchronize this as it's a
// requirement of the `backtrace` crate, and then actually resolve
// everything.
let _lock = lock();
for frame in self.frames.iter_mut() {
for frame in capture.frames.iter_mut() {
let symbols = &mut frame.symbols;
let frame = match &frame.frame {
RawFrame::Actual(frame) => frame,
Expand All @@ -490,6 +451,8 @@ impl Capture {
});
}
}

capture
}
}

Expand Down
6 changes: 2 additions & 4 deletions library/std/src/backtrace/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,8 @@ fn generate_fake_frames() -> Vec<BacktraceFrame> {
#[test]
fn test_debug() {
let backtrace = Backtrace {
inner: Inner::Captured(LazilyResolvedCapture::new(Capture {
inner: Inner::Captured(LazyLock::preinit(Capture {
actual_start: 1,
resolved: true,
frames: generate_fake_frames(),
})),
};
Expand All @@ -66,9 +65,8 @@ fn test_debug() {
#[test]
fn test_frames() {
let backtrace = Backtrace {
inner: Inner::Captured(LazilyResolvedCapture::new(Capture {
inner: Inner::Captured(LazyLock::preinit(Capture {
actual_start: 1,
resolved: true,
frames: generate_fake_frames(),
})),
};
Expand Down
1 change: 1 addition & 0 deletions library/std/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,7 @@
#![feature(staged_api)]
#![feature(thread_local)]
#![feature(try_blocks)]
#![feature(type_alias_impl_trait)]
#![feature(utf8_chunks)]
// tidy-alphabetical-end
//
Expand Down
9 changes: 9 additions & 0 deletions library/std/src/sync/lazy_lock.rs
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,15 @@ impl<T, F: FnOnce() -> T> LazyLock<T, F> {
LazyLock { once: Once::new(), data: UnsafeCell::new(Data { f: ManuallyDrop::new(f) }) }
}

/// Creates a new lazy value that is already initialized.
#[inline]
#[cfg(test)]
pub(crate) fn preinit(value: T) -> LazyLock<T, F> {
let once = Once::new();
once.call_once(|| {});
LazyLock { once, data: UnsafeCell::new(Data { value: ManuallyDrop::new(value) }) }
}

/// Consumes this `LazyLock` returning the stored value.
///
/// Returns `Ok(value)` if `Lazy` is initialized and `Err(f)` otherwise.
Expand Down
10 changes: 10 additions & 0 deletions library/std/tests/backtrace.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
use std::backtrace::Backtrace;

// Unfortunately, this cannot be a unit test because that causes problems
// with type-alias-impl-trait (the assert counts as a defining use).
#[test]
fn assert_send_sync() {
fn assert<T: Send + Sync>() {}

assert::<Backtrace>();
}

0 comments on commit 6776af5

Please sign in to comment.