Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add -Z embed-source (DWARFv5 source code embedding extension) #764

Closed
3 tasks done
Mrmaxmeier opened this issue Jun 26, 2024 · 3 comments
Closed
3 tasks done

Add -Z embed-source (DWARFv5 source code embedding extension) #764

Mrmaxmeier opened this issue Jun 26, 2024 · 3 comments
Labels
major-change A proposal to make a major change to rustc major-change-accepted A major change proposal that was accepted T-compiler Add this label so rfcbot knows to poll the compiler team to-announce Announce this issue on triage meeting

Comments

@Mrmaxmeier
Copy link

Mrmaxmeier commented Jun 26, 2024

Proposal

DWARFv5 has an extension for embedding program source code directly into the debug info sections: https://dwarfstd.org/issues/180201.1.html

LLVM implements this extension, though it currently uses a custom pre-standardization attribute opcode.

Clang supports it through a -gembed-source flag but Rust does not expose this feature at the moment.

Implementing this seems straight-forward (rust-lang/rust#126985) but I'm not entirely sure how to deal with unsupported platforms.

  • Should -Z embed-source=yes fail the build on non-DWARF or non-LLVM platforms?
  • Should -Z embed-source=yes automatically bump the DWARF version to v5 or should it require an explicit -Z dwarf-version=5? Clang currently defaults to v4 and requires setting the DWARF version explicitly.
  • Should -Z embed-source=yes fail the build if -g was not provided?

Process

The main points of the Major Change Process are as follows:

  • File an issue describing the proposal.
  • A compiler team member or contributor who is knowledgeable in the area can second by writing @rustbot second.
    • Finding a "second" suffices for internal changes. If however, you are proposing a new public-facing feature, such as a -C flag, then full team check-off is required.
    • Compiler team members can initiate a check-off via @rfcbot fcp merge on either the MCP or the PR.
  • Once an MCP is seconded, the Final Comment Period begins. If no objections are raised after 10 days, the MCP is considered approved.

You can read more about Major Change Proposals on forge.

@Mrmaxmeier Mrmaxmeier added major-change A proposal to make a major change to rustc T-compiler Add this label so rfcbot knows to poll the compiler team labels Jun 26, 2024
@rustbot
Copy link
Collaborator

rustbot commented Jun 26, 2024

This issue is not meant to be used for technical discussion. There is a Zulip stream for that. Use this issue to leave procedural comments, such as volunteering to review, indicating that you second the proposal (or third, etc), or raising a concern that you would like to be addressed.

Concerns or objections to the proposal should be discussed on Zulip and formally registered here by adding a comment with the following syntax:

@rustbot concern reason-for-concern 
<description of the concern> 

Concerns can be lifted with:

@rustbot resolve reason-for-concern 

See documentation at https://forge.rust-lang.org

cc @rust-lang/compiler @rust-lang/compiler-contributors

@rustbot rustbot added the to-announce Announce this issue on triage meeting label Jun 26, 2024
@Mrmaxmeier Mrmaxmeier changed the title Add -C embed-source (DWARFv5 source code embedding extension) Add -Z embed-source (DWARFv5 source code embedding extension) Jun 26, 2024
@davidtwco
Copy link
Member

@rustbot second

@rustbot rustbot added the final-comment-period The FCP has started, most (if not all) team members are in agreement label Jul 4, 2024
@apiraino apiraino removed the to-announce Announce this issue on triage meeting label Jul 4, 2024
@apiraino
Copy link
Contributor

@rustbot label -final-comment-period +major-change-accepted

@rustbot rustbot added major-change-accepted A major change proposal that was accepted to-announce Announce this issue on triage meeting and removed final-comment-period The FCP has started, most (if not all) team members are in agreement labels Jul 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
major-change A proposal to make a major change to rustc major-change-accepted A major change proposal that was accepted T-compiler Add this label so rfcbot knows to poll the compiler team to-announce Announce this issue on triage meeting
Projects
None yet
Development

No branches or pull requests

4 participants