link.exe: Don't embed full path to PDB file in binary. #121297

michaelwoerister · 2024-02-19T13:18:10Z

This PR makes rustc unconditionally pass /PDBALTPATH:%_PDB% to MSVC-style linkers, causing the linker to only embed the filename of the PDB in the binary instead of the full path. This will help implement the trim-paths RFC for *-msvc targets.

Passing /PDBALTPATH:%_PDB% to the linker is already done by many projects that need reproducible builds and debugger's should still be able to find the PDB if it is in the same directory as the binary.

r? @ghost

Fixes #87825

michaelwoerister · 2024-03-12T13:08:36Z

#122306 updated backtrace-rs to a version that includes rust-lang/backtrace-rs#584, so this is unblocked now.

@rustbot ping windows

r? compiler

rustbot · 2024-03-12T13:08:40Z

Hey Windows Group! This bug has been identified as a good "Windows candidate".
In case it's useful, here are some instructions for tackling these sorts of
bugs. Maybe take a look?
Thanks! <3

cc @albertlarsan68 @arlosi @ChrisDenton @danielframpton @gdr-at-ms @kennykerr @luqmana @lzybkr @nico-abram @retep998 @sivadeilra @wesleywiser

michaelwoerister · 2024-03-12T13:11:49Z

@bors rollup=never since this touching an *-msvc-only run-make test.

kennykerr · 2024-03-12T13:17:27Z

Looks good!

lcnr · 2024-03-12T13:21:38Z

r? compiler

wesleywiser · 2024-03-12T18:26:20Z

Thanks @michaelwoerister for fixing this and landing that fix to backtrace-rs to unblock it!

@bors r+

bors · 2024-03-12T18:26:24Z

📌 Commit c37a824 has been approved by wesleywiser

It is now in the queue for this repository.

workingjubilee · 2024-03-12T19:49:23Z

However, backtrace-rs currently does not find the PDB. Consequently, this PR is blocked until rust-lang/backtrace-rs#584 is merged.

Merged and backtrace has been updated, so this can land, yep.

bors · 2024-03-12T21:49:37Z

⌛ Testing commit c37a824 with merge 4026a87...

…=wesleywiser link.exe: Don't embed full path to PDB file in binary. This PR makes `rustc` unconditionally pass `/PDBALTPATH:%_PDB%` to MSVC-style linkers, causing the linker to only embed the filename of the PDB in the binary instead of the full path. This will help implement the [trim-paths RFC](rust-lang#111540) for `*-msvc` targets. Passing `/PDBALTPATH:%_PDB%` to the linker is already done by many projects that need reproducible builds and [debugger's should still be able to find the PDB](https://learn.microsoft.com/cpp/build/reference/pdbpath) if it is in the same directory as the binary. r? `@ghost` Fixes rust-lang#87825

bors · 2024-03-12T23:20:21Z

💔 Test failed - checks-actions

michaelwoerister · 2024-03-13T10:47:51Z

r? @wesleywiser

Let's see if this is the same i686 backtracing issue already encountered in rust-lang/backtrace-rs#584, where backtracing was pretty flaky without frame pointers enabled.

michaelwoerister · 2024-03-13T10:51:09Z

@bors r=wesleywiser

bors · 2024-03-13T10:51:11Z

📌 Commit d3af77c has been approved by wesleywiser

It is now in the queue for this repository.

…=wesleywiser link.exe: Don't embed full path to PDB file in binary. This PR makes `rustc` unconditionally pass `/PDBALTPATH:%_PDB%` to MSVC-style linkers, causing the linker to only embed the filename of the PDB in the binary instead of the full path. This will help implement the [trim-paths RFC](rust-lang#111540) for `*-msvc` targets. Passing `/PDBALTPATH:%_PDB%` to the linker is already done by many projects that need reproducible builds and [debugger's should still be able to find the PDB](https://learn.microsoft.com/cpp/build/reference/pdbpath) if it is in the same directory as the binary. r? `@ghost` Fixes rust-lang#87825

bors · 2024-03-13T11:29:16Z

⌛ Testing commit d3af77c with merge 3f79023...

bors · 2024-03-13T13:19:36Z

💔 Test failed - checks-actions

michaelwoerister · 2024-03-14T12:54:21Z

I modified the test code in 0a094ba, so that unwinding will more reliably produce a stack trace that actually contains frames from the test. Unwinding not always working is a pre-existing issue on i686-pc-windows-msvc and unrelated to the change in this PR.

wesleywiser · 2024-03-14T16:33:05Z

@bors r+

bors · 2024-03-14T16:33:08Z

📌 Commit 0a094ba has been approved by wesleywiser

It is now in the queue for this repository.

bors · 2024-03-15T14:14:37Z

⌛ Testing commit 0a094ba with merge c5b5713...

bors · 2024-03-15T16:38:32Z

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

rust-timer · 2024-03-15T17:53:39Z

Finished benchmarking commit (c5b5713): 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)	2.2%	[2.2%, 2.2%]	1
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-2.8%	[-4.8%, -1.0%]	14
Improvements ✅ (secondary)	-2.5%	[-5.7%, -0.5%]	52
All ❌✅ (primary)	-2.5%	[-4.8%, 2.2%]	15

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: 671.321s -> 670.605s (-0.11%)
Artifact size: 311.51 MiB -> 311.47 MiB (-0.01%)

…inaries Rust Bins: Bake the full PDB path into the Rust binaries Starting with rustc 1.78 and later, the compiler (rustc) will automatically pass the flag /PDBALTPATH:%_PDB% to the linker (rust-lld). Note that %_PDB% is not read from the environment; instead, The linker will replace %_PDB% with the base name of the module being linked. This is not the desired behavior for us as it will break WinDBG in multiple ways, as we need the full path to the PDB file. Fortunately, if the flag exists but is empty, LLD will populate it with the full path of the PDB file! Ref: rust-lang/rust#121297 https://github.com/rust-lang/rust/blob/75530e9f72a1990ed2305e16fd51d02f47048f12/compiler/rustc_codegen_ssa/src/back/linker.rs#L1049-L1056 https://github.com/llvm/llvm-project/blob/9ed772cecc23f5f5b060720399b010275bbb7457/lld/COFF/Driver.cpp#L2433-L2446 Signed-off-by: Vineel Kovvuri[MSFT] <[email protected]> ---- #### AI description (iteration 1) #### PR Classification New feature #### PR Summary This pull request ensures that the full PDB path is baked into Rust binaries to avoid issues with WinDBG. - Updated `/.cargo/config.toml` to include the `-C link-arg=/PDBALTPATH:` flag for various targets, ensuring the full path to the PDB file is used.

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Feb 19, 2024

michaelwoerister mentioned this pull request Feb 19, 2024

--remap-path-prefix doesn't map paths to .pdb files, even in release mode #87825

Closed

rustbot added the O-windows Operating system: Windows label Mar 12, 2024

rustbot assigned lcnr Mar 12, 2024

michaelwoerister removed the S-blocked Status: Blocked on something else such as an RFC or other implementation work. label Mar 12, 2024

rustbot assigned nnethercote and unassigned lcnr Mar 12, 2024

wesleywiser approved these changes Mar 12, 2024

View reviewed changes

bors added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Mar 12, 2024

bors added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Mar 12, 2024

rustbot assigned wesleywiser Mar 13, 2024

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

bors added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Mar 13, 2024

michaelwoerister added 3 commits March 14, 2024 09:54

link.exe: don't embed full path to PDB file in binary.

3c49fe0

Force frame pointers in pdb-alt-path test case

e1c3a5a

Make pdb-alt-path test more unwind-friendly for i686-pc-windows-msvc

0a094ba

michaelwoerister force-pushed the set-pdb-alt-path branch from d3af77c to 0a094ba Compare March 14, 2024 10:04

wesleywiser approved these changes Mar 14, 2024

View reviewed changes

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 Mar 14, 2024

bors added the merged-by-bors This PR was explicitly merged by bors. label Mar 15, 2024

bors merged commit c5b5713 into rust-lang:master Mar 15, 2024

rustbot added this to the 1.78.0 milestone Mar 15, 2024

ChrisDenton mentioned this pull request Mar 22, 2024

No backtrace on windows with current rustc stable #122857

Closed

jieyouxu mentioned this pull request Aug 14, 2024

Tracking Issue for Reproducible Build bugs and challenges #129080

Open

81 tasks

Timbals mentioned this pull request Sep 24, 2024

Fix stacktrace issues on Windows nagisa/rust_tracy_client#122

Merged

DmitriySalnikov mentioned this pull request Jan 31, 2025

.pdb rename error for rust godot crate in version 4.3 godotengine/godot#102206

Open

link.exe: Don't embed full path to PDB file in binary. #121297

link.exe: Don't embed full path to PDB file in binary. #121297

Uh oh!

Conversation

michaelwoerister commented Feb 19, 2024 • edited by workingjubilee Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

michaelwoerister commented Mar 12, 2024

Uh oh!

rustbot commented Mar 12, 2024

Uh oh!

michaelwoerister commented Mar 12, 2024

Uh oh!

kennykerr commented Mar 12, 2024

Uh oh!

lcnr commented Mar 12, 2024

Uh oh!

wesleywiser commented Mar 12, 2024

Uh oh!

bors commented Mar 12, 2024

Uh oh!

workingjubilee commented Mar 12, 2024

Uh oh!

bors commented Mar 12, 2024

Uh oh!

bors commented Mar 12, 2024

Uh oh!

michaelwoerister commented Mar 13, 2024

Uh oh!

michaelwoerister commented Mar 13, 2024

Uh oh!

bors commented Mar 13, 2024

Uh oh!

bors commented Mar 13, 2024

Uh oh!

bors commented Mar 13, 2024

Uh oh!

michaelwoerister commented Mar 14, 2024

Uh oh!

wesleywiser commented Mar 14, 2024

Uh oh!

bors commented Mar 14, 2024

Uh oh!

bors commented Mar 15, 2024

Uh oh!

bors commented Mar 15, 2024

Uh oh!

rust-timer commented Mar 15, 2024

Overall result: no relevant changes - no action needed

Instruction count

Max RSS (memory usage)

Cycles

Binary size

Uh oh!

Uh oh!

michaelwoerister commented Feb 19, 2024 •

edited by workingjubilee

Loading