Skip to content

Write down where all the unwind/backtrace code is #130257

Open
@workingjubilee

Description

@workingjubilee

Location

It's in at least three different locations, depending on how you count! That's the problem!

Summary

Internal-facing documentation, mostly?

The problem is this, essentially: we have our internal unwinding/backtrace-related code in

  • library/backtrace
  • library/panic_abort
  • library/panic_unwind
  • library/std/src/sys/personality
  • library/unwind

And the interrelationships are not so clean and obvious that you can simply follow imports, because sometimes the bridge is performed by raw compiler magic! Because, in fact, you do generally need compiler support to get a decent backtrace or to unwind correctly! So arguably I could also mention files like:

  • rustc_codegen_ssa/src/mir/block.rs

Understanding all of these should not be the exclusive province of a few wizened sages of the dark arts. They should all backref to an index that tracks them. And if any can be eliminated and merged into others without causing horrid problems, they should be.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-backtraceArea: BacktracesA-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsA-runtimeArea: std's runtime and "pre-main" init for handling backtraces, unwinds, stack overflowsC-enhancementCategory: An issue proposing an enhancement or a PR with one.E-tediousCall for participation: An issue involves lots of work and is better handled as many small tasks.T-compilerRelevant to the compiler team, which will review and decide on the PR/issue.T-libsRelevant to the library team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions