Skip to content

Commit

Permalink
Auto merge of #13630 - Kobzol:msvc-disable-release-strip, r=weihanglo
Browse files Browse the repository at this point in the history
Do not strip debuginfo by default for MSVC

This PR disables the logic which enables debuginfo stripping by default in release mode (#13257) for MSVC, since it causes problems there (rust-lang/rust#122857).

I'm not sure if this is the correct way to gate the logic on a specific target triple.

The root of the issue is that `-Cstrip=debuginfo` currently behaves like `-Cstrip=symbols` on MSVC, which causes the original optimization to break backtraces on Windows. Ultimately, this should probably be fixed in `rustc`, but that might take some further design work, therefore a faster solution would be to just special case this in Cargo for now, and remove the special case later, once it gets fixed on the `rustc` side.

Related issue: rust-lang/rust#122857
  • Loading branch information
bors committed Mar 26, 2024
2 parents 1f6857d + 53a0dc4 commit fa619a9
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 1 deletion.
13 changes: 12 additions & 1 deletion src/cargo/ops/cargo_compile/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
//! [`drain_the_queue`]: crate::core::compiler::job_queue
//! ["Cargo Target"]: https://doc.rust-lang.org/nightly/cargo/reference/cargo-targets.html
use cargo_platform::Cfg;
use std::collections::{HashMap, HashSet};
use std::hash::{Hash, Hasher};
use std::sync::Arc;
Expand Down Expand Up @@ -436,6 +437,7 @@ pub fn create_bcx<'a, 'gctx>(
&units,
&scrape_units,
host_kind_requested.then_some(explicit_host_kind),
&target_data,
);

let mut extra_compiler_args = HashMap::new();
Expand Down Expand Up @@ -575,6 +577,7 @@ fn rebuild_unit_graph_shared(
roots: &[Unit],
scrape_units: &[Unit],
to_host: Option<CompileKind>,
target_data: &RustcTargetData<'_>,
) -> (Vec<Unit>, Vec<Unit>, UnitGraph) {
let mut result = UnitGraph::new();
// Map of the old unit to the new unit, used to avoid recursing into units
Expand All @@ -591,6 +594,7 @@ fn rebuild_unit_graph_shared(
root,
false,
to_host,
target_data,
)
})
.collect();
Expand All @@ -617,6 +621,7 @@ fn traverse_and_share(
unit: &Unit,
unit_is_for_host: bool,
to_host: Option<CompileKind>,
target_data: &RustcTargetData<'_>,
) -> Unit {
if let Some(new_unit) = memo.get(unit) {
// Already computed, no need to recompute.
Expand All @@ -634,6 +639,7 @@ fn traverse_and_share(
&dep.unit,
dep.unit_for.is_for_host(),
to_host,
target_data,
);
new_dep_unit.hash(&mut dep_hash);
UnitDep {
Expand All @@ -657,8 +663,13 @@ fn traverse_and_share(
_ => unit.kind,
};

let cfg = target_data.cfg(unit.kind);
let is_target_windows_msvc = cfg.contains(&Cfg::Name("windows".to_string()))
&& cfg.contains(&Cfg::KeyPair("target_env".to_string(), "msvc".to_string()));
let mut profile = unit.profile.clone();
if profile.strip.is_deferred() {
// For MSVC, rustc currently treats -Cstrip=debuginfo same as -Cstrip=symbols, which causes
// this optimization to also remove symbols and thus break backtraces.
if profile.strip.is_deferred() && !is_target_windows_msvc {
// If strip was not manually set, and all dependencies of this unit together
// with this unit have debuginfo turned off, we enable debuginfo stripping.
// This will remove pre-existing debug symbols coming from the standard library.
Expand Down
27 changes: 27 additions & 0 deletions tests/testsuite/profiles.rs
Original file line number Diff line number Diff line change
Expand Up @@ -632,7 +632,9 @@ fn strip_accepts_false_to_disable_strip() {
.run();
}

// Temporarily disabled on Windows due to https://github.com/rust-lang/rust/issues/122857
#[cargo_test]
#[cfg(not(windows))]
fn strip_debuginfo_in_release() {
let p = project()
.file(
Expand All @@ -656,7 +658,32 @@ fn strip_debuginfo_in_release() {
.run();
}

// Using -Cstrip=debuginfo in release mode by default is temporarily disabled on Windows due to
// https://github.com/rust-lang/rust/issues/122857
#[cargo_test]
#[cfg(all(target_os = "windows", target_env = "msvc"))]
fn do_not_strip_debuginfo_in_release_on_windows() {
let p = project()
.file(
"Cargo.toml",
r#"
[package]
name = "foo"
version = "0.1.0"
edition = "2015"
"#,
)
.file("src/main.rs", "fn main() {}")
.build();

p.cargo("build --release -v")
.with_stderr_does_not_contain("[..]strip=debuginfo[..]")
.run();
}

// Temporarily disabled on Windows due to https://github.com/rust-lang/rust/issues/122857
#[cargo_test]
#[cfg(not(windows))]
fn strip_debuginfo_without_debug() {
let p = project()
.file(
Expand Down
2 changes: 2 additions & 0 deletions tests/testsuite/run.rs
Original file line number Diff line number Diff line change
Expand Up @@ -740,7 +740,9 @@ fn one_bin_multiple_examples() {
.run();
}

// Temporarily disabled on Windows due to https://github.com/rust-lang/rust/issues/122857
#[cargo_test]
#[cfg(not(windows))]
fn example_with_release_flag() {
let p = project()
.file(
Expand Down

0 comments on commit fa619a9

Please sign in to comment.