Use protected visibility when building rustc with LLD #131634

davidlattimore · 2024-10-13T01:16:26Z

I wasn't sure about having two commits in a PR, but I figured, at least initially it might make sense to discuss these commits together. Happy to squash, or move the second commit to a separate PR.

I contemplated trying to enable protected visibility for more cases when LLD will be used other than just -Zlinker-features=+lld, but that would be more a complex change that probably still wouldn't cover all cases when LLD is used, so went with the simplest option of just checking if the linker-feature is enabled.

r? lqd

tgross35 · 2024-10-13T02:59:26Z

I wasn't sure about having two commits in a PR, but I figured, at least initially it might make sense to discuss these commits together. Happy to squash, or move the second commit to a separate PR.

Multiple atomic commits in a single PR are totally fine, that's easier to review and better for history anyway (the way you have this PR is ideal imo). We definitely don't want a bunch of back and forth WIP-style commits that make changes just to undo them or fix things up, but there is no 1PR=1commit rule like LLVM.

nikic · 2024-10-13T14:22:21Z

@bors try @rust-timer queue

bors · 2024-10-13T14:23:31Z

⌛ Trying commit 1e1bf2b with merge 6ad0952...

Use protected visibility when LLD feature is enabled and enable it when building rustc rust-lang/compiler-team#782 I wasn't sure about having two commits in a PR, but I figured, at least initially it might make sense to discuss these commits together. Happy to squash, or move the second commit to a separate PR. I contemplated trying to enable protected visibility for more cases when LLD will be used other than just `-Zlinker-features=+lld`, but that would be more a complex change that probably still wouldn't cover all cases when LLD is used, so went with the simplest option of just checking if the linker-feature is enabled. r? lqd

bors · 2024-10-13T17:13:06Z

☀️ Try build successful - checks-actions
Build commit: 6ad0952 (6ad095273a92c251fb0c1697fd745ab6caf21d2c)

rust-timer · 2024-10-13T19:08:37Z

Finished benchmarking commit (6ad0952): 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 the most reliable metric that we have; it was used to determine the overall result at the top of this comment. However, even this metric can sometimes exhibit noise.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-1.6%	[-34.2%, -0.2%]	212
Improvements ✅ (secondary)	-4.6%	[-29.9%, -0.2%]	225
All ❌✅ (primary)	-1.6%	[-34.2%, -0.2%]	212

Max RSS (memory usage)

Results (primary -2.2%, secondary -3.2%)

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)	-2.2%	[-6.5%, -0.5%]	146
Improvements ✅ (secondary)	-3.2%	[-7.0%, -0.6%]	151
All ❌✅ (primary)	-2.2%	[-6.5%, -0.5%]	146

Cycles

Results (primary -3.3%, secondary -7.4%)

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)	-3.3%	[-24.2%, -0.6%]	53
Improvements ✅ (secondary)	-7.4%	[-22.6%, -1.9%]	94
All ❌✅ (primary)	-3.3%	[-24.2%, -0.6%]	53

Binary size

Results (primary -0.3%, secondary -0.7%)

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.3%	[-0.8%, -0.1%]	11
Improvements ✅ (secondary)	-0.7%	[-0.8%, -0.5%]	37
All ❌✅ (primary)	-0.3%	[-0.8%, -0.1%]	11

Bootstrap: 783.66s -> 778.727s (-0.63%)
Artifact size: 332.16 MiB -> 331.51 MiB (-0.20%)

lqd · 2024-10-14T19:40:32Z

I was expecting we'd only do this when using lld by default on stable. Just using a different default linker on nightly has bitten us at least once in the recent past, and I didn't think we'd want the 2 configs to drift even more. But if others are fine with it, so am I.

Cool, as expected these results match bjorn's old prototype I mentioned in the MCP.

However, could you explain a bit about the intent? Did you want to change visibility when using lld in general, or when using rust-lld? Because just checking -Zlinker-features=+lld flag is not sufficient to know whether either of these will be true. The linker flavor can be inferred from other arguments or the target, rust-lld needs self-contained linking enabled by the target/CLI (and to use cg_llvm and not other backends).

I wasn't sure about having two commits in a PR

It's very much welcomed in general, however in this case I think we may need to extract the second commit in another PR: the exact handling of use-lld in bootstrap is being reworked by t-bootstrap. Until this clean-up and tests are done, depending on which stage we pass this flag, I'm not personally sure that we couldn't be unknowingly switching from system lld to beta/stage 1 rust-lld, so I'll let @Kobzol comment on this change. If you did this specifically to get protected visibility on our dist artifacts, setting the default visibility explicitly in the CI config seems better to me, but again I'm not on t-infra/t-bootstrap and they will know better.

Kobzol · 2024-10-14T19:55:57Z

Perf. results look great! 🎉 The bootstrap change is a bit drive-by, though. We should finally refactor the way we handle LLD in bootstrap, I'll try to priotize it soon-ish. That's partially orthogonal to this PR, though.

I wonder if we should first enable this only for the compiler itself? Both to separate the perf. effect on the compiler from the perf. effect on the binaries, and also to test it for a while on nightly on the compiler before we enable it by default for all binaries compiled by a nightly compiler.

davidlattimore · 2024-10-15T05:36:34Z

My intent was primarily, at least initially to use protected visibility for rustc-driver. Not tying it to LLD and flagging it on for just rustc initially sounds sensible to me. One thing I'm not sure about though is whether that means I'll need to wait until -Zdefault-visibility hits stable, which, I think would be November 28th. Unless there's a way to only add the flag for later stages - although I can imagine that might not be desirable.

Kobzol · 2024-10-15T06:07:17Z

I would only do it for stage 2, we already do a bunch of optimizations on stage 2 only anyway, e.g. PGO and BOLT.

So when building stage 2 rustc, I'd just forcefully set the -Zdefault-visibility flag.

lqd · 2024-10-15T09:17:52Z

One thing I'm not sure about though is whether that means I'll need to wait until -Zdefault-visibility hits stable, which, I think would be November 28th

bootstrap uses beta and RUSTC_BOOTSTRAP so the stable cycle is less important. If you wanted to enable this at stage 1, then it'd only need #130005 to land on beta, which should be in the next couple days. If you want to only enable it at stage 2, you can do it now.

IIRC for stage-dependent flags, it should be done in bootstrap, e.g. around here (similarly to -Zdylib-lto, which is not set at stage 1). Then temporarily comment setting this CI environment variable and we can do a try build with smoke tests enabled.

@rustbot author

bjorn3 · 2024-10-27T09:50:47Z

src/bootstrap/src/utils/helpers.rs

@@ -428,7 +428,7 @@ pub fn linker_flags(
 ) -> Vec<String> {
    let mut args = vec![];
    if !builder.is_lld_direct_linker(target) && builder.config.lld_mode.is_used() {
-        args.push(String::from("-Clink-arg=-fuse-ld=lld"));
+        args.push(String::from("-Zlinker-features=+lld"));


I think we should keep building the standard library with default visibility as CI will build with lld, but the end user may then use this version of the standard library with ld.bfd. For librustc_driver.so it is completely fine though. Same for tools and codegen backends.

That's a very good point. I suspect that means that parts of the standard library that make it into the dylib, will unfortunately still have default visibility, but there might not be much we can do about that in the short term - unless we were to build a copy of the standard library specifically for use in rustc_driver that used protected visibility, then distribute a copy of the standard library that used default visibility. I guess that'd be like building the compiler with -Zbuild-std and -Zdefault-visibility=protected.

rustbot · 2024-10-31T00:24:22Z

This PR modifies src/bootstrap/src/core/config.

If appropriate, please update CONFIG_CHANGE_HISTORY in src/bootstrap/src/utils/change_tracker.rs.

davidlattimore · 2024-10-31T00:54:53Z

As suggested, I've updated this PR so that LLD is no longer involved. I now just set -Zdefault-visibility=protected when building rustc. This means that libstd isn't built with protected symbols, which means we do have a few more relocations than before, so the performance gain might not be as good as in the original check. However, it still should give some benefit. My stage2 rustc now has 1438 GLOB_DAT relocations, whereas the stage0 without this change has 7078. I think the previous way of enabling protected visibility got down to around 700 GLOB_DAT relocations - but that relied on compiling libstd with the flag, which likely would have broken anyone trying to use that libstd with GNU ld < 2.40.

I added a flag --protected-symbol-definitions that defaults to true. This was done in case someone wants to turn off protected symbols when building rustc for some reason. Is this OK having this flag default to true, or perhaps I should instead have a flag that has the opposite meaning and defaults to false? e.g. --default-visibility-definitions.

mati865 · 2024-10-31T01:13:31Z

Please update PR name.

onur-ozkan · 2024-10-31T08:55:44Z

Currently it's tied to the usage of LLD, so it will be used exactly on the builders that currently use LLD to link rustc.

Yeah, I’m aware of that. I was just pointing out if we are ever going to override this with =false in the config. Also, using =true may not enable it either since it depends on LLD. I think it makes more sense to remove this option and handle it automatically in the bootstrap.

Kobzol · 2024-10-31T08:58:44Z

Ah, yeah, I don't think that we would ever disable it, the config option would mostly be useful to people that build rustc and 1) use new LD and want to get the optimization or 2) use LLD and want to disable the optimization (for some reason). Both sounds kind of niche, so until someone tells us that they need it, I'd also just remove the option.

davidlattimore · 2024-10-31T09:32:37Z

Simpler change is good. I've removed the config option and now just use protected symbols when building rustc with LLD.

lqd · 2024-10-31T10:26:14Z

Since this is something important we don't want to change accidentally, we could/should set the interposable visibility we expect for std explicitly.

davidlattimore · 2024-10-31T10:54:02Z

Since this is something important we don't want to change accidentally, we could/should set the interposable visibility we expect for std explicitly.

I added a commit for this.

Kobzol · 2024-10-31T11:05:53Z

@rust-timer build 3639412

rust-timer · 2024-10-31T12:23:44Z

Finished benchmarking commit (3639412): 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 the most reliable metric that we have; it was used to determine the overall result at the top of this comment. However, even this metric can sometimes exhibit noise.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-1.7%	[-31.2%, -0.1%]	183
Improvements ✅ (secondary)	-4.2%	[-27.5%, -0.1%]	223
All ❌✅ (primary)	-1.7%	[-31.2%, -0.1%]	183

Max RSS (memory usage)

Results (primary -1.9%, secondary -2.7%)

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)	-1.9%	[-2.9%, -0.6%]	57
Improvements ✅ (secondary)	-2.7%	[-5.1%, -0.5%]	67
All ❌✅ (primary)	-1.9%	[-2.9%, -0.6%]	57

Cycles

Results (primary -6.5%, secondary -7.5%)

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)	-6.5%	[-22.6%, -0.9%]	17
Improvements ✅ (secondary)	-7.5%	[-20.9%, -1.8%]	77
All ❌✅ (primary)	-6.5%	[-22.6%, -0.9%]	17

Binary size

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

Bootstrap: 783.744s -> 781.748s (-0.25%)
Artifact size: 333.54 MiB -> 334.99 MiB (0.44%)

Kobzol · 2024-10-31T23:38:45Z

@bors r+

bors · 2024-10-31T23:38:48Z

📌 Commit 00da974 has been approved by Kobzol

It is now in the queue for this repository.

davidlattimore · 2024-10-31T23:44:22Z

There was a test failure on mingw after I added the commit to set interposable visibility when building std.

error: found crates (`core` and `core`) with colliding StableCrateId values

Not sure if it was a flake or an actual failure. Either way, I removed that commit from this PR and put it in a separate PR - #132432

Kobzol · 2024-10-31T23:51:20Z

Looked like a genuine failure to me. Anyway, I agree that it's better to separate these two.

bors · 2024-11-01T05:25:30Z

⌛ Testing commit 00da974 with merge 9fa9ef3...

bors · 2024-11-01T08:00:17Z

☀️ Test successful - checks-actions
Approved by: Kobzol
Pushing 9fa9ef3 to master...

rust-timer · 2024-11-01T09:46:07Z

Finished benchmarking commit (9fa9ef3): comparison URL.

Overall result: ✅ improvements - no action needed

@rustbot label: -perf-regression

Instruction count

This is the most reliable metric that we have; it was used to determine the overall result at the top of this comment. However, even this metric can sometimes exhibit noise.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-1.8%	[-31.3%, -0.1%]	174
Improvements ✅ (secondary)	-4.2%	[-27.5%, -0.2%]	224
All ❌✅ (primary)	-1.8%	[-31.3%, -0.1%]	174

Max RSS (memory usage)

Results (primary -2.1%, secondary -3.3%)

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)	-2.1%	[-6.4%, -0.5%]	112
Improvements ✅ (secondary)	-3.3%	[-7.5%, -0.6%]	129
All ❌✅ (primary)	-2.1%	[-6.4%, -0.5%]	112

Cycles

Results (primary -8.2%, secondary -7.4%)

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)	-8.2%	[-22.6%, -0.7%]	16
Improvements ✅ (secondary)	-7.4%	[-20.7%, -1.6%]	77
All ❌✅ (primary)	-8.2%	[-22.6%, -0.7%]	16

Binary size

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

Bootstrap: 782.66s -> 779.567s (-0.40%)
Artifact size: 333.48 MiB -> 334.97 MiB (0.45%)

Kobzol · 2024-11-01T09:52:46Z

Great job David!

klensy · 2024-11-01T11:56:27Z

Not related but noticed, that dep_graph https://perf.rust-lang.org/compare.html?start=a8e1186e3c14a54f7a38cc1183117dc7e77f4f82&end=9fa9ef385c0aad8f5d4c8f7d92dca474367943a3&stat=size%3Adep_graph&tab=compile&nonRelevant=true&showRawData=true values slightly unstable: 1-2 byte jumps around is weird (can be seen in history graph better).

rustbot assigned lqd Oct 13, 2024

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 13, 2024

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 13, 2024

rustbot 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 15, 2024

bjorn3 mentioned this pull request Oct 27, 2024

Use protected visibility for librustc_driver.so when possible #132219

Closed

bjorn3 reviewed Oct 27, 2024

View reviewed changes

davidlattimore force-pushed the lld-protected branch from 1e1bf2b to 977730b Compare October 31, 2024 00:24

This comment has been minimized.

Sign in to view

davidlattimore force-pushed the lld-protected branch from 977730b to 1441a82 Compare October 31, 2024 00:36

davidlattimore changed the title ~~Use protected visibility when LLD feature is enabled and enable it when building rustc~~ Use protected visibility when building rustc Oct 31, 2024

Use protected symbols when building rustc_driver

00da974

davidlattimore force-pushed the lld-protected branch from d1f7f68 to 00da974 Compare October 31, 2024 09:30

davidlattimore changed the title ~~Use protected visibility when building rustc~~ Use protected visibility when building rustc with LLD Oct 31, 2024

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 31, 2024

davidlattimore force-pushed the lld-protected branch from f572470 to 00da974 Compare October 31, 2024 23:30

davidlattimore mentioned this pull request Oct 31, 2024

Add a test to verify that libstd doesn't use protected symbols #132432

Open

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 31, 2024

bors added the merged-by-bors This PR was explicitly merged by bors. label Nov 1, 2024

bors merged commit 9fa9ef3 into rust-lang:master Nov 1, 2024
13 checks passed

rustbot added this to the 1.84.0 milestone Nov 1, 2024

klensy mentioned this pull request Nov 1, 2024

dep_graph values are unstable rust-lang/rustc-perf#2003

Open

Use protected visibility when building rustc with LLD #131634

Use protected visibility when building rustc with LLD #131634

Conversation

davidlattimore commented Oct 13, 2024

tgross35 commented Oct 13, 2024

nikic commented Oct 13, 2024

This comment has been minimized.

bors commented Oct 13, 2024

bors commented Oct 13, 2024

This comment has been minimized.

rust-timer commented Oct 13, 2024

Overall result: ✅ improvements - no action needed

lqd commented Oct 14, 2024

Kobzol commented Oct 14, 2024

davidlattimore commented Oct 15, 2024

Kobzol commented Oct 15, 2024

lqd commented Oct 15, 2024 • edited Loading

bjorn3 Oct 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rustbot commented Oct 31, 2024

This comment has been minimized.

davidlattimore commented Oct 31, 2024

mati865 commented Oct 31, 2024

onur-ozkan commented Oct 31, 2024

Kobzol commented Oct 31, 2024 • edited Loading

davidlattimore commented Oct 31, 2024

lqd commented Oct 31, 2024

davidlattimore commented Oct 31, 2024

Kobzol commented Oct 31, 2024

This comment has been minimized.

This comment has been minimized.

rust-timer commented Oct 31, 2024

Overall result: ✅ improvements - no action needed

Kobzol commented Oct 31, 2024

bors commented Oct 31, 2024

davidlattimore commented Oct 31, 2024

Kobzol commented Oct 31, 2024

bors commented Nov 1, 2024

bors commented Nov 1, 2024

rust-timer commented Nov 1, 2024

Overall result: ✅ improvements - no action needed

Kobzol commented Nov 1, 2024

klensy commented Nov 1, 2024 • edited Loading

lqd commented Oct 15, 2024 •

edited

Loading

bjorn3 Oct 27, 2024 •

edited

Loading

Kobzol commented Oct 31, 2024 •

edited

Loading

klensy commented Nov 1, 2024 •

edited

Loading