rustdoc: avoid allocating strings primitive link printing #117007

notriddle · 2023-10-21T01:42:21Z

This is aimed at hitting the allocator less in a function that gets called a lot.

rustbot · 2023-10-21T01:42:29Z

r? @jsha

(rustbot has picked a reviewer for you, use r? to override)

notriddle · 2023-10-21T02:20:34Z

@bors try @rust-timer queue

bors · 2023-10-21T02:21:43Z

⌛ Trying commit 7af1b2f with merge 4d4d8fd...

…h-display, r=<try> [perf run] rustdoc: avoid allocating strings primitive link printing This is aimed at hitting the allocator less in a function that gets called a lot.

bors · 2023-10-21T03:43:51Z

☀️ Try build successful - checks-actions
Build commit: 4d4d8fd (4d4d8fd42aa29dafbf0f9738cc35dd152d19f6bd)

rust-timer · 2023-10-21T05:04:47Z

Finished benchmarking commit (4d4d8fd): 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-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
Improvements ✅ (secondary)	-1.1%	[-1.1%, -1.1%]	1
All ❌✅ (primary)	-	-	0

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)	-	-	0
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-2.0%	[-2.0%, -2.0%]	1
All ❌✅ (primary)	-	-	0

Cycles

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

Binary size

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

Bootstrap: 631.871s -> 630.45s (-0.22%)
Artifact size: 304.05 MiB -> 304.04 MiB (-0.01%)

bugadani · 2023-10-21T06:59:34Z

src/librustdoc/html/format.rs

+                        primitive_link(
+                            f,
+                            PrimitiveType::Tuple,
+                            &display_fn(|f| write!(f, "({name},)")),


Wouldn't this pattern (single write inside a display_fn) be better as a format_args!() instead? I wonder what implications that would have.

Very good point.

This is aimed at hitting the allocator less in a function that gets called a lot.

notriddle · 2023-10-21T16:28:01Z

Try it with @bugadani's suggestion of format_args

@bors try @rust-timer queue

bors · 2023-10-21T16:29:10Z

⌛ Trying commit 4851cc9 with merge 7eb211f...

…h-display, r=<try> rustdoc: avoid allocating strings primitive link printing This is aimed at hitting the allocator less in a function that gets called a lot.

bors · 2023-10-21T17:51:09Z

☀️ Try build successful - checks-actions
Build commit: 7eb211f (7eb211f30a7b293ef7a409ae337c3ba6507d579c)

rust-timer · 2023-10-21T19:28:24Z

Finished benchmarking commit (7eb211f): comparison URL.

Overall result: ❌✅ regressions and improvements - 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.

Next Steps: If you can justify the regressions found in this try perf run, please indicate this with @rustbot label: +perf-regression-triaged along with sufficient written justification. If you cannot justify the regressions please fix the regressions and do another perf run. If the next run shows neutral or positive results, the label will be automatically removed.

@bors rollup=never
@rustbot label: -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)	2.8%	[2.8%, 2.8%]	1
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-1.0%	[-1.0%, -1.0%]	1
All ❌✅ (primary)	2.8%	[2.8%, 2.8%]	1

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)	3.8%	[3.8%, 3.8%]	1
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	3.8%	[3.8%, 3.8%]	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.9%	[2.9%, 2.9%]	1
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	2.9%	[2.9%, 2.9%]	1

Binary size

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

Bootstrap: 631.62s -> 631.227s (-0.06%)
Artifact size: 301.95 MiB -> 301.96 MiB (0.00%)

notriddle · 2023-10-21T19:32:21Z

The “regression” isn’t a doc build.

fmease · 2023-10-22T12:36:45Z

Hmm, that's odd. I didn't expect to see perf regressions in LLVM codegen, that doesn't make much sense to me for this rustdoc PR. This has to be spurious, right?

#116885 had similar regressions in LLVM_{module_codegen_emit_obj,{module,lto}_optimize,passes}, finish_ongoing_codegen (perf result sample). They might be real but they could also hint at faulty perf metrics of some sorts? I mean if rustdoc itself was harder to optimize with format_args, I would understand. However, this is an alleged regression in codegen'ing syn.

Thanks for improving the doc times!
r? fmease @bors r+

bors · 2023-10-22T12:36:47Z

📌 Commit 4851cc9 has been approved by fmease

It is now in the queue for this repository.

bors · 2023-10-22T18:06:20Z

⌛ Testing commit 4851cc9 with merge 6aeac60...

bors · 2023-10-22T20:01:26Z

☀️ Test successful - checks-actions
Approved by: fmease
Pushing 6aeac60 to master...

rust-timer · 2023-10-22T21:22:28Z

Finished benchmarking commit (6aeac60): comparison URL.

Overall result: ✅ improvements - no action needed

@rustbot label: -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
Improvements ✅ (secondary)	-1.1%	[-1.1%, -1.1%]	1
All ❌✅ (primary)	-	-	0

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)	3.9%	[3.9%, 3.9%]	1
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-4.1%	[-4.1%, -4.1%]	1
All ❌✅ (primary)	3.9%	[3.9%, 3.9%]	1

Cycles

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

Binary size

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

Bootstrap: 631.74s -> 629.056s (-0.42%)
Artifact size: 304.08 MiB -> 304.13 MiB (0.02%)

rustbot assigned jsha Oct 21, 2023

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Oct 21, 2023

This comment has been minimized.

Sign in to view

rustbot added the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Oct 21, 2023

This comment has been minimized.

Sign in to view

rustbot removed the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Oct 21, 2023

bugadani reviewed Oct 21, 2023

View reviewed changes

rustdoc: avoid allocating strings primitive link printing

4851cc9

This is aimed at hitting the allocator less in a function that gets called a lot.

notriddle force-pushed the notriddle/format-links-with-display branch from 7af1b2f to 4851cc9 Compare October 21, 2023 14:49

notriddle changed the title ~~[perf run] rustdoc: avoid allocating strings primitive link printing~~ rustdoc: avoid allocating strings primitive link printing Oct 21, 2023

notriddle marked this pull request as ready for review October 21, 2023 14:49

This comment has been minimized.

Sign in to view

rustbot added the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Oct 21, 2023

This comment has been minimized.

Sign in to view

rustbot added perf-regression Performance regression. and removed S-waiting-on-perf Status: Waiting on a perf run to be completed. labels Oct 21, 2023

notriddle added the perf-regression-triaged The performance regression has been triaged. label Oct 22, 2023

rustbot assigned fmease and unassigned jsha Oct 22, 2023

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-review Status: Awaiting review from the assignee but also interested parties. labels Oct 22, 2023

bors added the merged-by-bors This PR was explicitly merged by bors. label Oct 22, 2023

bors merged commit 6aeac60 into rust-lang:master Oct 22, 2023
12 checks passed

rustbot added this to the 1.75.0 milestone Oct 22, 2023

notriddle deleted the notriddle/format-links-with-display branch October 22, 2023 20:20

rustbot removed the perf-regression Performance regression. label Oct 22, 2023

fmease removed the perf-regression-triaged The performance regression has been triaged. label Oct 23, 2023

fmease mentioned this pull request Oct 26, 2023

Add a default flag for enum documentation #115575

Closed

github-actions bot mentioned this pull request Oct 31, 2023

Automated pull from upstream master ferrocene/ferrocene#74

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rustdoc: avoid allocating strings primitive link printing #117007

rustdoc: avoid allocating strings primitive link printing #117007

notriddle commented Oct 21, 2023

rustbot commented Oct 21, 2023

notriddle commented Oct 21, 2023

This comment has been minimized.

bors commented Oct 21, 2023

bors commented Oct 21, 2023

This comment has been minimized.

rust-timer commented Oct 21, 2023

bugadani Oct 21, 2023 •

edited

notriddle Oct 21, 2023

notriddle commented Oct 21, 2023

This comment has been minimized.

bors commented Oct 21, 2023

bors commented Oct 21, 2023

This comment has been minimized.

rust-timer commented Oct 21, 2023

notriddle commented Oct 21, 2023

fmease commented Oct 22, 2023 •

edited

bors commented Oct 22, 2023

bors commented Oct 22, 2023

bors commented Oct 22, 2023

rust-timer commented Oct 22, 2023

rustdoc: avoid allocating strings primitive link printing #117007

rustdoc: avoid allocating strings primitive link printing #117007

Conversation

notriddle commented Oct 21, 2023

rustbot commented Oct 21, 2023

notriddle commented Oct 21, 2023

This comment has been minimized.

bors commented Oct 21, 2023

bors commented Oct 21, 2023

This comment has been minimized.

rust-timer commented Oct 21, 2023

Overall result: ✅ improvements - no action needed

bugadani Oct 21, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

notriddle commented Oct 21, 2023

This comment has been minimized.

bors commented Oct 21, 2023

bors commented Oct 21, 2023

This comment has been minimized.

rust-timer commented Oct 21, 2023

Overall result: ❌✅ regressions and improvements - ACTION NEEDED

notriddle commented Oct 21, 2023

fmease commented Oct 22, 2023 • edited

bors commented Oct 22, 2023

bors commented Oct 22, 2023

bors commented Oct 22, 2023

rust-timer commented Oct 22, 2023

Overall result: ✅ improvements - no action needed

bugadani Oct 21, 2023 •

edited

fmease commented Oct 22, 2023 •

edited