rust-lang / rust-lang/rust

Tracking Issue for short backtraces in the default panic hook

Open
#136,129 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-backtrace A-debuginfo A-runtime C-tracking-issue T-compiler T-libs
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

This is a tracking issue for short backtraces in the default panic hook (https://github.com/rust-lang/rust/issues/124586, https://github.com/rust-lang/compiler-team/issues/818). See previous Zulip discussion.

About tracking issues

Tracking issues are used to record the overall progress of implementation.
They are also used as hubs connecting to other relevant issues, e.g., bugs or open design questions.
A tracking issue is however not meant for large scale discussion, questions, or bug reports about a feature.
Instead, open a dedicated issue for the specific matter and add the relevant feature gate label.
Discussion comments will get marked as off-topic or deleted.
Repeated discussions on the tracking issue may lead to the tracking issue getting locked.

Steps
Compile-time
Runtime
Unresolved Questions
  • How should we represent the debuginfo at runtime? The current three-state enum doesn't allow both marking a frame as the end of a push/pop pair while also omitting it in the backtrace. NOTE: please leave comments about this on LLVM discourse, not on this issue.
  • How can we extend this to PDB? Right now it only works for DWARF. Possibly we can use llvm.codeview.annotation?
Implementation history

See above.

@rustbot label T-compiler T-libs A-runtime A-backtrace A-debuginfo

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the unchecked compile-time and runtime items, especially rust-lang/rust PR 134831, the LLVM pre-RFC, and the linked gimli and backtrace-rs PRs. Done requires resolving the listed compiler, debuginfo, runtime, and panic-hook dependencies, but the issue shows that several remain blocked or under discussion.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers, devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.