Auto merge of #115746 - tgross35:unnamed-threads-panic-message, r=cuviper

Print thread ID in panic message `panic!` does not print any identifying information for threads that are unnamed. However, in many cases, the thread ID can be determined. This changes the panic message from something like this: thread '<unnamed>' panicked at src/main.rs:3:5: explicit panic To something like this: thread '<unnamed>' (12345) panicked at src/main.rs:3:5: explicit panic Stack overflow messages are updated as well. This change applies to both named and unnamed threads. The ID printed is the OS integer thread ID rather than the Rust thread ID, which should also be what debuggers print. try-job: aarch64-apple try-job: aarch64-gnu try-job: dist-apple-various try-job: dist-various-* try-job: dist-x86_64-freebsd try-job: dist-x86_64-illumos try-job: dist-x86_64-netbsd try-job: dist-x86_64-solaris try-job: test-various try-job: x86_64-gnu try-job: x86_64-mingw-1 try-job: x86_64-msvc-1

Author: bors

library/std/src/panicking.rs

@@ -269,6 +269,7 @@ fn default_hook(info: &PanicHookInfo<'_>) {
 
  thread::with_current_name(|name| {
  let name = name.unwrap_or("<unnamed>");
+ let tid = thread::current_os_id();
 
  // Try to write the panic message to a buffer first to prevent other concurrent outputs
  // interleaving with it.
@@ -277,7 +278,7 @@ fn default_hook(info: &PanicHookInfo<'_>) {
 
  let write_msg = |dst: &mut dyn crate::io::Write| {
  // We add a newline to ensure the panic message appears at the start of a line.
- writeln!(dst, "\nthread '{name}' panicked at {location}:\n{msg}")
+ writeln!(dst, "\nthread '{name}' ({tid}) panicked at {location}:\n{msg}")
  };
 
  if write_msg(&mut cursor).is_ok() {

library/std/src/sys/pal/hermit/thread.rs

@@ -115,6 +115,10 @@ impl Thread {
  }
 }
 
+pub(crate) fn current_os_id() -> Option<u64> {
+ None
+}
+
 pub fn available_parallelism() -> io::Result<NonZero<usize>> {
  unsafe { Ok(NonZero::new_unchecked(hermit_abi::available_parallelism())) }
 }

library/std/src/sys/pal/itron/thread.rs

@@ -361,6 +361,10 @@ unsafe fn terminate_and_delete_current_task() -> ! {
  unsafe { crate::hint::unreachable_unchecked() };
 }
 
+pub(crate) fn current_os_id() -> Option<u64> {
+ None
+}
+
 pub fn available_parallelism() -> io::Result<NonZero<usize>> {
  super::unsupported()
 }

library/std/src/sys/pal/sgx/thread.rs

@@ -1,6 +1,6 @@
 #![cfg_attr(test, allow(dead_code))] // why is this necessary?
 
-use super::abi::usercalls;
+use super::abi::{thread, usercalls};
 use super::unsupported;
 use crate::ffi::CStr;
 use crate::io;
@@ -149,6 +149,10 @@ impl Thread {
  }
 }
 
+pub(crate) fn current_os_id() -> Option<u64> {
+ Some(thread::current().addr().get() as u64)
+}
+
 pub fn available_parallelism() -> io::Result<NonZero<usize>> {
  unsupported()
 }

library/std/src/sys/pal/teeos/thread.rs

@@ -144,6 +144,10 @@ impl Drop for Thread {
  }
 }
 
+pub(crate) fn current_os_id() -> Option<u64> {
+ None
+}
+
 // Note: Both `sched_getaffinity` and `sysconf` are available but not functional on
 // teeos, so this function always returns an Error!
 pub fn available_parallelism() -> io::Result<NonZero<usize>> {

library/std/src/sys/pal/uefi/thread.rs

@@ -56,6 +56,10 @@ impl Thread {
  }
 }
 
+pub(crate) fn current_os_id() -> Option<u64> {
+ None
+}
+
 pub fn available_parallelism() -> io::Result<NonZero<usize>> {
  // UEFI is single threaded
  Ok(NonZero::new(1).unwrap())

library/std/src/sys/pal/unix/stack_overflow.rs

@@ -119,7 +119,8 @@ mod imp {
  && thread_info.guard_page_range.contains(&fault_addr)
  {
  let name = thread_info.thread_name.as_deref().unwrap_or("<unknown>");
- rtprintpanic!("\nthread '{name}' has overflowed its stack\n");
+ let tid = crate::thread::current_os_id();
+ rtprintpanic!("\nthread '{name}' ({tid}) has overflowed its stack\n");
  rtabort!("stack overflow");
  }
  })
@@ -696,7 +697,8 @@ mod imp {
  if code == c::EXCEPTION_STACK_OVERFLOW {
  crate::thread::with_current_name(|name| {
  let name = name.unwrap_or("<unknown>");
- rtprintpanic!("\nthread '{name}' has overflowed its stack\n");
+ let tid = crate::thread::current_os_id();
+ rtprintpanic!("\nthread '{name}' ({tid}) has overflowed its stack\n");
  });
  }
  c::EXCEPTION_CONTINUE_SEARCH

library/std/src/sys/pal/unix/thread.rs

@@ -398,6 +398,62 @@ impl Drop for Thread {
  }
 }
 
+pub(crate) fn current_os_id() -> Option<u64> {
+ // Most Unix platforms have a way to query an integer ID of the current thread, all with
+ // slightly different spellings.
+ //
+ // The OS thread ID is used rather than `pthread_self` so as to match what will be displayed
+ // for process inspection (debuggers, trace, `top`, etc.).
+ cfg_if::cfg_if! {
+ // Most platforms have a function returning a `pid_t` or int, which is an `i32`.
+ if #[cfg(any(target_os = "android", target_os = "linux"))] {
+ use crate::sys::weak::syscall;
+
+ // `libc::gettid` is only available on glibc 2.30+, but the syscall is available
+ // since Linux 2.4.11.
+ syscall!(fn gettid() -> libc::pid_t;);
+
+ // SAFETY: FFI call with no preconditions.
+ let id: libc::pid_t = unsafe { gettid() };
+ Some(id as u64)
+ } else if #[cfg(target_os = "nto")] {
+ // SAFETY: FFI call with no preconditions.
+ let id: libc::pid_t = unsafe { libc::gettid() };
+ Some(id as u64)
+ } else if #[cfg(target_os = "openbsd")] {
+ // SAFETY: FFI call with no preconditions.
+ let id: libc::pid_t = unsafe { libc::getthrid() };
+ Some(id as u64)
+ } else if #[cfg(target_os = "freebsd")] {
+ // SAFETY: FFI call with no preconditions.
+ let id: libc::c_int = unsafe { libc::pthread_getthreadid_np() };
+ Some(id as u64)
+ } else if #[cfg(target_os = "netbsd")] {
+ // SAFETY: FFI call with no preconditions.
+ let id: libc::lwpid_t = unsafe { libc::_lwp_self() };
+ Some(id as u64)
+ } else if #[cfg(any(target_os = "illumos", target_os = "solaris"))] {
+ // On Illumos and Solaris, the `pthread_t` is the same as the OS thread ID.
+ // SAFETY: FFI call with no preconditions.
+ let id: libc::pthread_t = unsafe { libc::pthread_self() };
+ Some(id as u64)
+ } else if #[cfg(target_vendor = "apple")] {
+ // Apple allows querying arbitrary thread IDs, `thread=NULL` queries the current thread.
+ let mut id = 0u64;
+ // SAFETY: `thread_id` is a valid pointer, no other preconditions.
+ let status: libc::c_int = unsafe { libc::pthread_threadid_np(0, &mut id) };
+ if status == 0 {
+ Some(id)
+ } else {
+ None
+ }
+ } else {
+ // Other platforms don't have an OS thread ID or don't have a way to access it.
+ None
+ }
+ }
+}
+
 #[cfg(any(
  target_os = "linux",
  target_os = "nto",

library/std/src/sys/pal/unsupported/thread.rs

@@ -39,6 +39,10 @@ impl Thread {
  }
 }
 
+pub(crate) fn current_os_id() -> Option<u64> {
+ None
+}
+
 pub fn available_parallelism() -> io::Result<NonZero<usize>> {
  unsupported()
 }

library/std/src/sys/pal/wasi/thread.rs

@@ -194,6 +194,10 @@ impl Thread {
  }
 }
 
+pub(crate) fn current_os_id() -> Option<u64> {
+ None
+}
+
 pub fn available_parallelism() -> io::Result<NonZero<usize>> {
  cfg_if::cfg_if! {
  if #[cfg(target_feature = "atomics")] {