ssa: implement `#[collapse_debuginfo]` #99556

davidtwco · 2022-07-21T13:27:55Z

Debuginfo line information for macro invocations are collapsed by default - line information are replaced by the line of the outermost expansion site. Using -Zdebug-macros disables this behaviour.

When the collapse_debuginfo feature is enabled, the default behaviour is reversed so that debuginfo is not collapsed by default. In addition, the #[collapse_debuginfo] attribute is available and can be applied to macro definitions which will then have their line information collapsed.

r? rust-lang/wg-debugging

rustbot · 2022-07-21T13:27:59Z

Some changes occurred in compiler/rustc_codegen_cranelift

cc @bjorn3

Some changes occurred in src/tools/clippy

cc @rust-lang/clippy

Some changes occurred to MIR optimizations

cc @rust-lang/wg-mir-opt

rust-highfive · 2022-07-21T13:27:59Z

r? @michaelwoerister

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

davidtwco · 2022-07-21T13:31:47Z

Relevant Zulip discussions are here and here.

davidtwco · 2022-07-21T13:39:49Z

It might make sense to add the #[collapse_debuginfo] attributes to std macros in this pull request, happy to do that if people agree.

compiler/rustc_codegen_ssa/src/mir/debuginfo.rs

compiler/rustc_expand/src/base.rs

compiler/rustc_middle/src/ty/mod.rs

michaelwoerister · 2022-07-22T15:52:22Z

Thanks for the PR, @davidtwco! I've set aside some time to read up on the discussion early next week. I guess, technically, we'll need to wait for the MCP to be accepted anyway :)

michaelwoerister · 2022-08-19T09:38:14Z

Alright, I'll finally have some time to take a look at this topic! Sorry for the wait, @davidtwco.

michaelwoerister

This looks excellent! Great tests. Thanks for the PR, @davidtwco!

I left a few comments below. Looks like a tracking issue is needed for CI to pass.

compiler/rustc_feature/src/active.rs

compiler/rustc_passes/src/check_attr.rs

src/test/debuginfo/collapse-debuginfo-no-attr-flag.rs

src/test/debuginfo/collapse-debuginfo-with-attr-flag.rs

bors · 2022-09-07T12:17:21Z

☀️ Try build successful - checks-actions
Build commit: 83669ee9a36dfe33adff2c816a6c19fc2b31f751 (83669ee9a36dfe33adff2c816a6c19fc2b31f751)

rust-timer · 2022-09-07T12:17:23Z

Queued 83669ee9a36dfe33adff2c816a6c19fc2b31f751 with parent 0568b0a, future comparison URL.

Debuginfo line information for macro invocations are collapsed by default - line information are replaced by the line of the outermost expansion site. Using `-Zdebug-macros` disables this behaviour. When the `collapse_debuginfo` feature is enabled, the default behaviour is reversed so that debuginfo is not collapsed by default. In addition, the `#[collapse_debuginfo]` attribute is available and can be applied to macro definitions which will then have their line information collapsed. Signed-off-by: David Wood <david.wood@huawei.com>

rust-timer · 2022-09-07T13:38:02Z

Finished benchmarking commit (83669ee9a36dfe33adff2c816a6c19fc2b31f751): comparison URL.

Overall result: ✅ improvements - no action needed

Benchmarking this pull request likely means that it is perf-sensitive, so we're automatically marking it as not fit for rolling up. While you can manually mark this PR as fit for rollup, we strongly recommend not doing so since this PR may lead to changes in compiler perf.

@bors rollup=never
@rustbot label: +S-waiting-on-review -S-waiting-on-perf -perf-regression

Instruction count

This is a highly reliable metric that was used to determine the overall result at the top of this comment.

	mean¹	range	count²
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-0.8%	[-1.3%, -0.4%]	12
Improvements ✅ (secondary)	-1.4%	[-2.0%, -0.5%]	9
All ❌✅ (primary)	-0.8%	[-1.3%, -0.4%]	12

Max RSS (memory usage)

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean¹	range	count²
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	2.0%	[2.0%, 2.0%]	1
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-2.0%	[-2.0%, -2.0%]	1
All ❌✅ (primary)	-	-	0

Cycles

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean¹	range	count²
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-3.8%	[-4.1%, -3.5%]	2
All ❌✅ (primary)	-	-	0

the arithmetic mean of the percent change ↩ ↩² ↩³
number of relevant changes ↩ ↩² ↩³

davidtwco · 2022-09-07T13:43:42Z

r? @wesleywiser

wesleywiser · 2022-09-12T17:54:54Z

Thanks @davidtwco! 👍

@bors r+

bors · 2022-09-12T17:54:56Z

📌 Commit 38958aa has been approved by wesleywiser

It is now in the queue for this repository.

bors · 2022-09-13T01:19:08Z

⌛ Testing commit 38958aa with merge 0df1ddc...

bors · 2022-09-13T04:00:17Z

☀️ Test successful - checks-actions
Approved by: wesleywiser
Pushing 0df1ddc to master...

rust-timer · 2022-09-13T05:17:18Z

Finished benchmarking commit (0df1ddc): comparison URL.

Overall result: no relevant changes - no action needed

@rustbot label: -perf-regression

Instruction count

This benchmark run did not return any relevant results for this metric.

Max RSS (memory usage)

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean¹	range	count²
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	3.8%	[3.8%, 3.8%]	1
Improvements ✅ (primary)	-3.3%	[-3.3%, -3.3%]	1
Improvements ✅ (secondary)	-1.8%	[-3.4%, -0.5%]	4
All ❌✅ (primary)	-3.3%	[-3.3%, -3.3%]	1

Cycles

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean¹	range	count²
Regressions ❌ (primary)	2.6%	[2.6%, 2.6%]	1
Regressions ❌ (secondary)	0.6%	[0.6%, 0.6%]	1
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	2.6%	[2.6%, 2.6%]	1

the arithmetic mean of the percent change ↩ ↩²
number of relevant changes ↩ ↩²

…ywiser ssa: implement `#[collapse_debuginfo]` cc rust-lang#39153 rust-lang/compiler-team#386 Debuginfo line information for macro invocations are collapsed by default - line information are replaced by the line of the outermost expansion site. Using `-Zdebug-macros` disables this behaviour. When the `collapse_debuginfo` feature is enabled, the default behaviour is reversed so that debuginfo is not collapsed by default. In addition, the `#[collapse_debuginfo]` attribute is available and can be applied to macro definitions which will then have their line information collapsed. r? rust-lang/wg-debugging

rust-highfive assigned michaelwoerister Jul 21, 2022

rustbot added T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jul 21, 2022

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 21, 2022

davidtwco mentioned this pull request Jul 21, 2022

Code in block passed to macro has line number of macro invocation #39153

Closed

bjorn3 reviewed Jul 21, 2022

View reviewed changes

compiler/rustc_codegen_ssa/src/mir/debuginfo.rs Outdated Show resolved Hide resolved

bjorn3 reviewed Jul 21, 2022

View reviewed changes

compiler/rustc_expand/src/base.rs Outdated Show resolved Hide resolved

davidtwco force-pushed the collapse-debuginfo branch from 8719132 to 85282ea Compare July 21, 2022 14:11

bjorn3 reviewed Jul 21, 2022

View reviewed changes

compiler/rustc_middle/src/ty/mod.rs Outdated Show resolved Hide resolved

davidtwco force-pushed the collapse-debuginfo branch from 85282ea to b40a375 Compare July 21, 2022 16:01

This comment has been minimized.

Sign in to view