Skip to content

Commit 811d4de

Browse files
RalfJungRalfJung
committed
deadlock: show backtrace for all threads
1 parent 88d1a1c commit 811d4de

15 files changed

+175
-25
lines changed

‎src/tools/miri/src/borrow_tracker/stacked_borrows/diagnostics.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -438,7 +438,7 @@ impl<'history, 'ecx, 'mir, 'tcx> DiagnosticCx<'history, 'ecx, 'mir, 'tcx> {
438438
.machine
439439
.threads
440440
.all_stacks()
441-
.flatten()
441+
.flat_map(|(_id, stack)| stack)
442442
.map(|frame| {
443443
frame.extra.borrow_tracker.as_ref().expect("we should have borrow tracking data")
444444
})

‎src/tools/miri/src/concurrency/thread.rs

+2-3
Original file line numberDiff line numberDiff line change
@@ -430,11 +430,10 @@ impl<'mir, 'tcx: 'mir> ThreadManager<'mir, 'tcx> {
430430
) -> &mut Vec<Frame<'mir, 'tcx, Provenance, FrameExtra<'tcx>>> {
431431
&mut self.threads[self.active_thread].stack
432432
}
433-
434433
pub fn all_stacks(
435434
&self,
436-
) -> impl Iterator<Item = &[Frame<'mir, 'tcx, Provenance, FrameExtra<'tcx>>]> {
437-
self.threads.iter().map(|t| &t.stack[..])
435+
) -> impl Iterator<Item = (ThreadId, &[Frame<'mir, 'tcx, Provenance, FrameExtra<'tcx>>])> {
436+
self.threads.iter_enumerated().map(|(id, t)| (id, &t.stack[..]))
438437
}
439438

440439
/// Create a new thread and returns its id.

‎src/tools/miri/src/diagnostics.rs

+58-12
Original file line numberDiff line numberDiff line change
@@ -361,9 +361,12 @@ pub fn report_error<'tcx, 'mir>(
361361
};
362362

363363
let stacktrace = ecx.generate_stacktrace();
364-
let (stacktrace, was_pruned) = prune_stacktrace(stacktrace, &ecx.machine);
364+
let (stacktrace, mut any_pruned) = prune_stacktrace(stacktrace, &ecx.machine);
365365

366-
// We want to dump the allocation if this is `InvalidUninitBytes`. Since `format_error` consumes `e`, we compute the outut early.
366+
let mut show_all_threads = false;
367+
368+
// We want to dump the allocation if this is `InvalidUninitBytes`.
369+
// Since `format_interp_error` consumes `e`, we compute the outut early.
367370
let mut extra = String::new();
368371
match e.kind() {
369372
UndefinedBehavior(InvalidUninitBytes(Some((alloc_id, access)))) => {
@@ -375,6 +378,15 @@ pub fn report_error<'tcx, 'mir>(
375378
.unwrap();
376379
writeln!(extra, "{:?}", ecx.dump_alloc(*alloc_id)).unwrap();
377380
}
381+
MachineStop(info) => {
382+
let info = info.downcast_ref::<TerminationInfo>().expect("invalid MachineStop payload");
383+
match info {
384+
TerminationInfo::Deadlock => {
385+
show_all_threads = true;
386+
}
387+
_ => {}
388+
}
389+
}
378390
_ => {}
379391
}
380392

@@ -387,18 +399,39 @@ pub fn report_error<'tcx, 'mir>(
387399
vec![],
388400
helps,
389401
&stacktrace,
402+
Some(ecx.get_active_thread()),
390403
&ecx.machine,
391404
);
392405

406+
eprint!("{extra}"); // newlines are already in the string
407+
408+
if show_all_threads {
409+
for (thread, stack) in ecx.machine.threads.all_stacks() {
410+
if thread != ecx.get_active_thread() {
411+
let stacktrace = Frame::generate_stacktrace_from_stack(stack);
412+
let (stacktrace, was_pruned) = prune_stacktrace(stacktrace, &ecx.machine);
413+
any_pruned |= was_pruned;
414+
report_msg(
415+
DiagLevel::Error,
416+
format!("deadlock: the evaluated program deadlocked"),
417+
vec![format!("the evaluated program deadlocked")],
418+
vec![],
419+
vec![],
420+
&stacktrace,
421+
Some(thread),
422+
&ecx.machine,
423+
)
424+
}
425+
}
426+
}
427+
393428
// Include a note like `std` does when we omit frames from a backtrace
394-
if was_pruned {
429+
if any_pruned {
395430
ecx.tcx.dcx().note(
396431
"some details are omitted, run with `MIRIFLAGS=-Zmiri-backtrace=full` for a verbose backtrace",
397432
);
398433
}
399434

400-
eprint!("{extra}"); // newlines are already in the string
401-
402435
// Debug-dump all locals.
403436
for (i, frame) in ecx.active_thread_stack().iter().enumerate() {
404437
trace!("-------------------");
@@ -435,6 +468,7 @@ pub fn report_leaks<'mir, 'tcx>(
435468
vec![],
436469
vec![],
437470
&backtrace,
471+
None, // we don't know the thread this is from
438472
&ecx.machine,
439473
);
440474
}
@@ -457,6 +491,7 @@ pub fn report_msg<'tcx>(
457491
notes: Vec<(Option<SpanData>, String)>,
458492
helps: Vec<(Option<SpanData>, String)>,
459493
stacktrace: &[FrameInfo<'tcx>],
494+
thread: Option<ThreadId>,
460495
machine: &MiriMachine<'_, 'tcx>,
461496
) {
462497
let span = stacktrace.first().map_or(DUMMY_SP, |fi| fi.span);
@@ -506,12 +541,13 @@ pub fn report_msg<'tcx>(
506541
if extra_span {
507542
write!(backtrace_title, " (of the first span)").unwrap();
508543
}
509-
let thread_name =
510-
machine.threads.get_thread_display_name(machine.threads.get_active_thread_id());
511-
if thread_name != "main" {
512-
// Only print thread name if it is not `main`.
513-
write!(backtrace_title, " on thread `{thread_name}`").unwrap();
514-
};
544+
if let Some(thread) = thread {
545+
let thread_name = machine.threads.get_thread_display_name(thread);
546+
if thread_name != "main" {
547+
// Only print thread name if it is not `main`.
548+
write!(backtrace_title, " on thread `{thread_name}`").unwrap();
549+
};
550+
}
515551
write!(backtrace_title, ":").unwrap();
516552
err.note(backtrace_title);
517553
for (idx, frame_info) in stacktrace.iter().enumerate() {
@@ -628,7 +664,16 @@ impl<'mir, 'tcx> MiriMachine<'mir, 'tcx> {
628664
_ => vec![],
629665
};
630666

631-
report_msg(diag_level, title, vec![msg], notes, helps, &stacktrace, self);
667+
report_msg(
668+
diag_level,
669+
title,
670+
vec![msg],
671+
notes,
672+
helps,
673+
&stacktrace,
674+
Some(self.threads.get_active_thread_id()),
675+
self,
676+
);
632677
}
633678
}
634679

@@ -654,6 +699,7 @@ pub trait EvalContextExt<'mir, 'tcx: 'mir>: crate::MiriInterpCxExt<'mir, 'tcx> {
654699
vec![],
655700
vec![],
656701
&stacktrace,
702+
Some(this.get_active_thread()),
657703
&this.machine,
658704
);
659705
}

‎src/tools/miri/tests/fail-dep/concurrency/windows_join_main.rs

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
//@only-target-windows: Uses win32 api functions
22
// We are making scheduler assumptions here.
33
//@compile-flags: -Zmiri-preemption-rate=0
4+
//@error-in-other-file: deadlock
45

56
// On windows, joining main is not UB, but it will block a thread forever.
67

‎src/tools/miri/tests/fail-dep/concurrency/windows_join_main.stderr

+22-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,28 @@ LL | assert_eq!(WaitForSingleObject(MAIN_THREAD, INFINITE), WAIT_OBJ
88
= note: inside closure at RUSTLIB/core/src/macros/mod.rs:LL:CC
99
= note: this error originates in the macro `assert_eq` (in Nightly builds, run with -Z macro-backtrace for more info)
1010

11+
error: deadlock: the evaluated program deadlocked
12+
--> RUSTLIB/std/src/sys/pal/PLATFORM/thread.rs:LL:CC
13+
|
14+
LL | let rc = unsafe { c::WaitForSingleObject(self.handle.as_raw_handle(), c::INFINITE) };
15+
| ^ the evaluated program deadlocked
16+
|
17+
= note: BACKTRACE:
18+
= note: inside `std::sys::pal::PLATFORM::thread::Thread::join` at RUSTLIB/std/src/sys/pal/PLATFORM/thread.rs:LL:CC
19+
= note: inside `std::thread::JoinInner::<'_, ()>::join` at RUSTLIB/std/src/thread/mod.rs:LL:CC
20+
= note: inside `std::thread::JoinHandle::<()>::join` at RUSTLIB/std/src/thread/mod.rs:LL:CC
21+
note: inside `main`
22+
--> $DIR/windows_join_main.rs:LL:CC
23+
|
24+
LL | / thread::spawn(|| {
25+
LL | | unsafe {
26+
LL | | assert_eq!(WaitForSingleObject(MAIN_THREAD, INFINITE), WAIT_OBJECT_0);
27+
LL | | }
28+
LL | | })
29+
LL | | .join()
30+
| |___________^
31+
1132
note: some details are omitted, run with `MIRIFLAGS=-Zmiri-backtrace=full` for a verbose backtrace
1233

13-
error: aborting due to 1 previous error
34+
error: aborting due to 2 previous errors
1435

‎src/tools/miri/tests/fail-dep/concurrency/windows_join_self.rs

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
//@only-target-windows: Uses win32 api functions
22
// We are making scheduler assumptions here.
33
//@compile-flags: -Zmiri-preemption-rate=0
4+
//@error-in-other-file: deadlock
45

56
// On windows, a thread joining itself is not UB, but it will deadlock.
67

‎src/tools/miri/tests/fail-dep/concurrency/windows_join_self.stderr

+23-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,29 @@ LL | assert_eq!(WaitForSingleObject(native, INFINITE), WAIT_OBJECT_0
77
= note: BACKTRACE on thread `unnamed-ID`:
88
= note: inside closure at $DIR/windows_join_self.rs:LL:CC
99

10+
error: deadlock: the evaluated program deadlocked
11+
--> RUSTLIB/std/src/sys/pal/PLATFORM/thread.rs:LL:CC
12+
|
13+
LL | let rc = unsafe { c::WaitForSingleObject(self.handle.as_raw_handle(), c::INFINITE) };
14+
| ^ the evaluated program deadlocked
15+
|
16+
= note: BACKTRACE:
17+
= note: inside `std::sys::pal::PLATFORM::thread::Thread::join` at RUSTLIB/std/src/sys/pal/PLATFORM/thread.rs:LL:CC
18+
= note: inside `std::thread::JoinInner::<'_, ()>::join` at RUSTLIB/std/src/thread/mod.rs:LL:CC
19+
= note: inside `std::thread::JoinHandle::<()>::join` at RUSTLIB/std/src/thread/mod.rs:LL:CC
20+
note: inside `main`
21+
--> $DIR/windows_join_self.rs:LL:CC
22+
|
23+
LL | / thread::spawn(|| {
24+
LL | | unsafe {
25+
LL | | let native = GetCurrentThread();
26+
LL | | assert_eq!(WaitForSingleObject(native, INFINITE), WAIT_OBJECT_0);
27+
LL | | }
28+
LL | | })
29+
LL | | .join()
30+
| |___________^
31+
1032
note: some details are omitted, run with `MIRIFLAGS=-Zmiri-backtrace=full` for a verbose backtrace
1133

12-
error: aborting due to 1 previous error
34+
error: aborting due to 2 previous errors
1335

‎src/tools/miri/tests/fail-dep/shims/sync/libc_pthread_mutex_deadlock.rs

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
//@ignore-target-windows: No libc on Windows
2+
//@error-in-other-file: deadlock
23

34
use std::cell::UnsafeCell;
45
use std::sync::Arc;

‎src/tools/miri/tests/fail-dep/shims/sync/libc_pthread_mutex_deadlock.stderr

+20-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,26 @@ LL | assert_eq!(libc::pthread_mutex_lock(lock_copy.0.get() as *mut _
77
= note: BACKTRACE on thread `unnamed-ID`:
88
= note: inside closure at $DIR/libc_pthread_mutex_deadlock.rs:LL:CC
99

10+
error: deadlock: the evaluated program deadlocked
11+
--> RUSTLIB/std/src/sys/pal/PLATFORM/thread.rs:LL:CC
12+
|
13+
LL | let ret = libc::pthread_join(self.id, ptr::null_mut());
14+
| ^ the evaluated program deadlocked
15+
|
16+
= note: BACKTRACE:
17+
= note: inside `std::sys::pal::PLATFORM::thread::Thread::join` at RUSTLIB/std/src/sys/pal/PLATFORM/thread.rs:LL:CC
18+
= note: inside `std::thread::JoinInner::<'_, ()>::join` at RUSTLIB/std/src/thread/mod.rs:LL:CC
19+
= note: inside `std::thread::JoinHandle::<()>::join` at RUSTLIB/std/src/thread/mod.rs:LL:CC
20+
note: inside `main`
21+
--> $DIR/libc_pthread_mutex_deadlock.rs:LL:CC
22+
|
23+
LL | / thread::spawn(move || {
24+
LL | | assert_eq!(libc::pthread_mutex_lock(lock_copy.0.get() as *mut _), 0);
25+
LL | | })
26+
LL | | .join()
27+
| |_______________^
28+
1029
note: some details are omitted, run with `MIRIFLAGS=-Zmiri-backtrace=full` for a verbose backtrace
1130

12-
error: aborting due to 1 previous error
31+
error: aborting due to 2 previous errors
1332

‎src/tools/miri/tests/fail-dep/shims/sync/libc_pthread_rwlock_write_read_deadlock.rs

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
//@ignore-target-windows: No libc on Windows
2+
//@error-in-other-file: deadlock
23

34
use std::cell::UnsafeCell;
45
use std::sync::Arc;

‎src/tools/miri/tests/fail-dep/shims/sync/libc_pthread_rwlock_write_read_deadlock.stderr

+20-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,26 @@ LL | assert_eq!(libc::pthread_rwlock_wrlock(lock_copy.0.get() as *mu
77
= note: BACKTRACE on thread `unnamed-ID`:
88
= note: inside closure at $DIR/libc_pthread_rwlock_write_read_deadlock.rs:LL:CC
99

10+
error: deadlock: the evaluated program deadlocked
11+
--> RUSTLIB/std/src/sys/pal/PLATFORM/thread.rs:LL:CC
12+
|
13+
LL | let ret = libc::pthread_join(self.id, ptr::null_mut());
14+
| ^ the evaluated program deadlocked
15+
|
16+
= note: BACKTRACE:
17+
= note: inside `std::sys::pal::PLATFORM::thread::Thread::join` at RUSTLIB/std/src/sys/pal/PLATFORM/thread.rs:LL:CC
18+
= note: inside `std::thread::JoinInner::<'_, ()>::join` at RUSTLIB/std/src/thread/mod.rs:LL:CC
19+
= note: inside `std::thread::JoinHandle::<()>::join` at RUSTLIB/std/src/thread/mod.rs:LL:CC
20+
note: inside `main`
21+
--> $DIR/libc_pthread_rwlock_write_read_deadlock.rs:LL:CC
22+
|
23+
LL | / thread::spawn(move || {
24+
LL | | assert_eq!(libc::pthread_rwlock_wrlock(lock_copy.0.get() as *mut _), 0);
25+
LL | | })
26+
LL | | .join()
27+
| |_______________^
28+
1029
note: some details are omitted, run with `MIRIFLAGS=-Zmiri-backtrace=full` for a verbose backtrace
1130

12-
error: aborting due to 1 previous error
31+
error: aborting due to 2 previous errors
1332

‎src/tools/miri/tests/fail-dep/shims/sync/libc_pthread_rwlock_write_write_deadlock.rs

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
//@ignore-target-windows: No libc on Windows
2+
//@error-in-other-file: deadlock
23

34
use std::cell::UnsafeCell;
45
use std::sync::Arc;

‎src/tools/miri/tests/fail-dep/shims/sync/libc_pthread_rwlock_write_write_deadlock.stderr

+20-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,26 @@ LL | assert_eq!(libc::pthread_rwlock_wrlock(lock_copy.0.get() as *mu
77
= note: BACKTRACE on thread `unnamed-ID`:
88
= note: inside closure at $DIR/libc_pthread_rwlock_write_write_deadlock.rs:LL:CC
99

10+
error: deadlock: the evaluated program deadlocked
11+
--> RUSTLIB/std/src/sys/pal/PLATFORM/thread.rs:LL:CC
12+
|
13+
LL | let ret = libc::pthread_join(self.id, ptr::null_mut());
14+
| ^ the evaluated program deadlocked
15+
|
16+
= note: BACKTRACE:
17+
= note: inside `std::sys::pal::PLATFORM::thread::Thread::join` at RUSTLIB/std/src/sys/pal/PLATFORM/thread.rs:LL:CC
18+
= note: inside `std::thread::JoinInner::<'_, ()>::join` at RUSTLIB/std/src/thread/mod.rs:LL:CC
19+
= note: inside `std::thread::JoinHandle::<()>::join` at RUSTLIB/std/src/thread/mod.rs:LL:CC
20+
note: inside `main`
21+
--> $DIR/libc_pthread_rwlock_write_write_deadlock.rs:LL:CC
22+
|
23+
LL | / thread::spawn(move || {
24+
LL | | assert_eq!(libc::pthread_rwlock_wrlock(lock_copy.0.get() as *mut _), 0);
25+
LL | | })
26+
LL | | .join()
27+
| |_______________^
28+
1029
note: some details are omitted, run with `MIRIFLAGS=-Zmiri-backtrace=full` for a verbose backtrace
1130

12-
error: aborting due to 1 previous error
31+
error: aborting due to 2 previous errors
1332

‎src/tools/miri/tests/fail/uninit/uninit_alloc_diagnostic.stderr

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ note: inside `main`
1515
LL | drop(slice1.cmp(slice2));
1616
| ^^^^^^^^^^^^^^^^^^
1717

18-
note: some details are omitted, run with `MIRIFLAGS=-Zmiri-backtrace=full` for a verbose backtrace
19-
2018
Uninitialized memory occurred at ALLOC[0x4..0x10], in this allocation:
2119
ALLOC (Rust heap, size: 32, align: 8) {
2220
0x00 │ 41 42 43 44 __ __ __ __ __ __ __ __ __ __ __ __ │ ABCD░░░░░░░░░░░░
2321
0x10 │ 00 __ __ __ __ __ __ __ __ __ __ __ __ __ __ __ │ .░░░░░░░░░░░░░░░
2422
}
2523

24+
note: some details are omitted, run with `MIRIFLAGS=-Zmiri-backtrace=full` for a verbose backtrace
25+
2626
error: aborting due to 1 previous error
2727

‎src/tools/miri/tests/fail/uninit/uninit_alloc_diagnostic_with_provenance.stderr

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ note: inside `main`
1515
LL | drop(slice1.cmp(slice2));
1616
| ^^^^^^^^^^^^^^^^^^
1717

18-
note: some details are omitted, run with `MIRIFLAGS=-Zmiri-backtrace=full` for a verbose backtrace
19-
2018
Uninitialized memory occurred at ALLOC[0x4..0x8], in this allocation:
2119
ALLOC (Rust heap, size: 16, align: 8) {
2220
╾42[ALLOC]<TAG> (1 ptr byte)╼ 12 13 ╾43[ALLOC]<TAG> (1 ptr byte)╼ __ __ __ __ __ __ __ __ __ __ __ __ │ ━..━░░░░░░░░░░░░
@@ -28,5 +26,7 @@ ALLOC (global (static or const), size: 1, align: 1) {
2826
00 │ .
2927
}
3028

29+
note: some details are omitted, run with `MIRIFLAGS=-Zmiri-backtrace=full` for a verbose backtrace
30+
3131
error: aborting due to 1 previous error
3232

0 commit comments

Comments
 (0)