Implement -Z location-detail flag by hudson-ayers · Pull Request #89920 · rust-lang/rust

hudson-ayers · 2021-10-15T17:19:40Z

This PR implements the -Z location-detail flag as described in rust-lang/rfcs#2091 .

-Z location-detail=val controls what location details are tracked when using caller_location. This allows users to control what location details are printed as part of panic messages, by allowing them to exclude any combination of filenames, line numbers, and column numbers. This option is intended to provide users with a way to mitigate the size impact of #[track_caller].

Some measurements of the savings of this approach on an embedded binary can be found here: #70579 (comment) .

Closes#70580 (unless people want to leave that open as a place for discussion of further improvements).

This is my first real PR to rust, so any help correcting mistakes / understanding side effects / improving my tests is appreciated :)

I have one question: RFC 2091 specified this as a debugging option (I think that is what -Z implies?). Does that mean this can never be stabilized without a separate MCP? If so, do I need to submit an MCP now, or is the initial RFC specifying this option sufficient for this to be merged as is, and then an MCP would be needed for eventual stabilization?

rust-highfive · 2021-10-15T17:19:42Z

Some changes occured to the CTFE / Miri engine

cc @rust-lang/miri

rust-highfive · 2021-10-15T17:19:44Z

r? @davidtwco

(rust-highfive has picked a reviewer for you, use r? to override)

davidtwco

LGTM, r=me once these comments are resolved.

hudson-ayers · 2021-10-21T17:49:08Z

I added a FIXME and implemented your other suggestion. Thanks for the review :)

davidtwco · 2021-10-21T20:04:42Z

@bors r+

bors · 2021-10-21T20:04:44Z

📌 Commit b802629 has been approved by davidtwco

…l, r=davidtwco Implement -Z location-detail flag This PR implements the `-Z location-detail` flag as described in rust-lang/rfcs#2091 . `-Z location-detail=val` controls what location details are tracked when using `caller_location`. This allows users to control what location details are printed as part of panic messages, by allowing them to exclude any combination of filenames, line numbers, and column numbers. This option is intended to provide users with a way to mitigate the size impact of `#[track_caller]`. Some measurements of the savings of this approach on an embedded binary can be found here: rust-lang#70579 (comment) . Closesrust-lang#70580 (unless people want to leave that open as a place for discussion of further improvements). This is my first real PR to rust, so any help correcting mistakes / understanding side effects / improving my tests is appreciated :) I have one question: RFC 2091 specified this as a debugging option (I think that is what -Z implies?). Does that mean this can never be stabilized without a separate MCP? If so, do I need to submit an MCP now, or is the initial RFC specifying this option sufficient for this to be merged as is, and then an MCP would be needed for eventual stabilization?

…askrgr Rollup of 11 pull requests Successful merges: - rust-lang#83233 (Implement split_array and split_array_mut) - rust-lang#88300 (Stabilise unix_process_wait_more, extra ExitStatusExt methods) - rust-lang#89416 (nice_region_error: Include lifetime placeholders in error output) - rust-lang#89468 (Report fatal lexer errors in `--cfg` command line arguments) - rust-lang#89730 (add feature flag for `type_changing_struct_update`) - rust-lang#89920 (Implement -Z location-detail flag) - rust-lang#90070 (Add edition configuration to compiletest) - rust-lang#90087 (Sync rustfmt subtree) - rust-lang#90117 (Make RSplit<T, P>: Clone not require T: Clone) - rust-lang#90122 (CI: make docker cache download and `docker load` time out after 10 minutes) - rust-lang#90166 (Add comment documenting why we can't use a simpler solution) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

korran · 2022-07-20T18:12:23Z

How do you use this flag to disable ALL the location details?

When I set -Z location-detail= (an empty comma-separated list), the compiler complains:

incorrect value `` for unstable option `location-detail` - comma separated list of location details to track: `file`, `line`, or `column` was expected

hudson-ayers · 2022-07-21T18:38:46Z

I think I misunderstood how CLI option parsing works when implementing this, I thought passing an empty string to the option would pass Some("") to the parser, but that does not seem to be the case, so it is not possible to disable all the location details. I will followup with a fix and an additional test for this case soon

hudson-ayers · 2022-07-22T19:30:10Z

#99620 contains the fix

…=davidtwco `-Z location-detail`: provide option to disable all location details As reported [here](rust-lang#89920 (comment)), when I first implemented the `-Z location-detail` flag there was a bug, where passing an empty list was not correctly supported, and instead rejected by the compiler. This PR fixes that such that passing an empty list results in no location details being tracked, as originally specified in rust-lang/rfcs#2091 . This PR also adds a test case to verify that this option continues to work as intended.

rust-highfive assigned davidtwco Oct 15, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 15, 2021

Aaron1011 reviewed Oct 15, 2021
View reviewed changes

Comment threadcompiler/rustc_const_eval/src/interpret/intrinsics/caller_location.rs Outdated

This comment has been minimized.
Sign in to view

fbstj reviewed Oct 15, 2021
View reviewed changes

Comment threadcompiler/rustc_session/src/config.rs Outdated

Add -Z location-detail flag
a9a1393

hudson-ayers force-pushed the location-detail-control branch from 2d5b22d to 017d4d9Compare October 15, 2021 20:10

This comment has been minimized.
Sign in to view

hudson-ayers force-pushed the location-detail-control branch from 017d4d9 to 0f91d0dCompare October 15, 2021 21:44

davidtwco approved these changes Oct 21, 2021
View reviewed changes

Comment threadsrc/doc/unstable-book/src/compiler-flags/location-detail.md Outdated
Comment threadcompiler/rustc_const_eval/src/interpret/intrinsics/caller_location.rs Outdated

davidtwco added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 21, 2021

hudson-ayers added 3 commits October 21, 2021 10:41

Configure saved panic locations based on location-detail flag
e1d94b8

document the unstable location-detail flag
8090f67

add tests for -Zlocation-detail
b802629

hudson-ayers force-pushed the location-detail-control branch from 0f91d0d to b802629Compare October 21, 2021 17:44

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 21, 2021

matthiaskrgr mentioned this pull request Oct 22, 2021
Rollup of 10 pull requests #90176
Closed

matthiaskrgr mentioned this pull request Oct 22, 2021
Rollup of 9 pull requests #90178
Closed

matthiaskrgr mentioned this pull request Oct 23, 2021
Rollup of 11 pull requests #90188
Merged

bors merged commit 8fb194c into rust-lang:masterOct 23, 2021

rustbot added this to the 1.58.0 milestone Oct 23, 2021

hudson-ayers mentioned this pull request Jul 22, 2022
-Z location-detail: provide option to disable all location details #99620
Merged

estebank mentioned this pull request Jul 28, 2023
Macro runtime error not helpful 🐛 #114055
Open

kornelski mentioned this pull request Sep 11, 2023
-Zlocation-detail=none johnthagen/min-sized-rust#53
Closed

johnthagen mentioned this pull request Sep 13, 2023
Document rustc -Zlocation-detailrustc flag johnthagen/min-sized-rust#54
Merged

hudson-ayers mentioned this pull request Nov 19, 2023
Location is missing the function name #95529
Open

Cgettys mentioned this pull request Jun 22, 2024
Add global string de-duplication cache rust-lang/miri#3470
Closed

kornelski mentioned this pull request Aug 28, 2024
Tracking Issue: Exposing RUSTFLAGS in cargo rust-lang/cargo#12739
Open
6 tasks

kornelski mentioned this pull request May 10, 2025
Specify the behavior of file!#134442
Merged

Navigation Menu

Uh oh!

Uh oh!

Implement -Z location-detail flag - #89920

Implement -Z location-detail flag#89920
bors merged 4 commits into
rust-lang:masterfrom
hudson-ayers:location-detail-control

hudson-ayers commented Oct 15, 2021

Uh oh!

rust-highfive commented Oct 15, 2021

Uh oh!

rust-highfive commented Oct 15, 2021

Uh oh!

Uh oh!

This comment has been minimized.

Uh oh!

This comment has been minimized.

davidtwco left a comment

Uh oh!

Uh oh!

Uh oh!

hudson-ayers commented Oct 21, 2021

Uh oh!

davidtwco commented Oct 21, 2021

Uh oh!

bors commented Oct 21, 2021

Uh oh!

korran commented Jul 20, 2022

Uh oh!

hudson-ayers commented Jul 21, 2022

Uh oh!

hudson-ayers commented Jul 22, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

Uh oh!

Uh oh!

Conversation

hudson-ayers commented Oct 15, 2021

Uh oh!

rust-highfive commented Oct 15, 2021

Uh oh!

rust-highfive commented Oct 15, 2021

Uh oh!

Uh oh!

This comment has been minimized.

Uh oh!

This comment has been minimized.

davidtwco left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

hudson-ayers commented Oct 21, 2021

Uh oh!

davidtwco commented Oct 21, 2021

Uh oh!

bors commented Oct 21, 2021

Uh oh!

korran commented Jul 20, 2022

Uh oh!

hudson-ayers commented Jul 21, 2022

Uh oh!

hudson-ayers commented Jul 22, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants