Skip to content

[WIP] feat(manifest): add a force-frame-pointers profile option #15451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions crates/cargo-util-schemas/src/manifest/mod.rs
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of the solution details are still being discussed in #15451

Original file line number Diff line number Diff line change
Expand Up @@ -899,6 +899,7 @@ pub struct TomlProfile {
pub dir_name: Option<String>,
pub inherits: Option<String>,
pub strip: Option<StringOrBool>,
pub force_frame_pointers: Option<bool>,
// Note that `rustflags` is used for the cargo-feature `profile_rustflags`
pub rustflags: Option<Vec<String>>,
// These two fields must be last because they are sub-tables, and TOML
Expand Down Expand Up @@ -995,6 +996,10 @@ impl TomlProfile {
self.strip = Some(v.clone());
}

if let Some(v) = &profile.force_frame_pointers {
self.force_frame_pointers = Some(v.clone());
}

if let Some(v) = &profile.trim_paths {
self.trim_paths = Some(v.clone())
}
Expand Down
5 changes: 5 additions & 0 deletions src/cargo/core/compiler/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1106,6 +1106,7 @@ fn build_base_args(
ref panic,
incremental,
strip,
force_frame_pointers,
rustflags: profile_rustflags,
trim_paths,
..
Expand Down Expand Up @@ -1285,6 +1286,10 @@ fn build_base_args(
cmd.arg("-C").arg(format!("strip={}", strip));
}

if force_frame_pointers {
cmd.arg("-C").arg("force-frame-pointers=on");
}

if unit.is_std {
// -Zforce-unstable-if-unmarked prevents the accidental use of
// unstable crates within the sysroot (such as "extern crate libc" or
Expand Down
14 changes: 13 additions & 1 deletion src/cargo/core/profiles.rs
Original file line number Diff line number Diff line change
Expand Up @@ -331,6 +331,7 @@ impl Profiles {
result.debuginfo = for_unit_profile.debuginfo;
result.opt_level = for_unit_profile.opt_level;
result.trim_paths = for_unit_profile.trim_paths.clone();
result.force_frame_pointers = for_unit_profile.force_frame_pointers;
result
}

Expand Down Expand Up @@ -574,6 +575,9 @@ fn merge_profile(profile: &mut Profile, toml: &TomlProfile) {
if let Some(flags) = &toml.rustflags {
profile.rustflags = flags.iter().map(InternedString::from).collect();
}
if let Some(force_frame_pointers) = toml.force_frame_pointers {
profile.force_frame_pointers = force_frame_pointers;
}
if let Some(trim_paths) = &toml.trim_paths {
profile.trim_paths = Some(trim_paths.clone());
}
Expand Down Expand Up @@ -624,6 +628,7 @@ pub struct Profile {
pub incremental: bool,
pub panic: PanicStrategy,
pub strip: Strip,
pub force_frame_pointers: bool,
#[serde(skip_serializing_if = "Vec::is_empty")] // remove when `rustflags` is stablized
// Note that `rustflags` is used for the cargo-feature `profile_rustflags`
pub rustflags: Vec<InternedString>,
Expand All @@ -649,6 +654,7 @@ impl Default for Profile {
incremental: false,
panic: PanicStrategy::Unwind,
strip: Strip::Deferred(StripInner::None),
force_frame_pointers: false,
rustflags: vec![],
trim_paths: None,
}
Expand Down Expand Up @@ -678,6 +684,7 @@ compact_debug! {
incremental
panic
strip
force_frame_pointers
rustflags
trim_paths
)]
Expand Down Expand Up @@ -746,7 +753,12 @@ impl Profile {
self.debug_assertions,
self.overflow_checks,
self.rpath,
(self.incremental, self.panic, self.strip),
(
self.incremental,
self.panic,
self.strip,
self.force_frame_pointers,
),
&self.rustflags,
&self.trim_paths,
)
Expand Down
1 change: 1 addition & 0 deletions tests/testsuite/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1662,6 +1662,7 @@ fn all_profile_options() {
dir_name: Some(String::from("dir_name")),
inherits: Some(String::from("debug")),
strip: Some(cargo_toml::StringOrBool::String("symbols".to_string())),
force_frame_pointers: Some(true),
package: None,
build_override: None,
rustflags: None,
Expand Down
73 changes: 73 additions & 0 deletions tests/testsuite/profiles.rs
Original file line number Diff line number Diff line change
Expand Up @@ -704,6 +704,79 @@ fn do_not_strip_debuginfo_with_requested_debug() {
.run();
}

#[cargo_test]
fn force_frame_pointers_on_works() {
Comment on lines +707 to +708
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you be up for putting the tests in a previous commit without force-frame-pointers, having them pass, showing the existing behavior? Then in this commit, the diff highlights the new feature and what it changes

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No problem, I can do that

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

EDIT : I suppose I should first wait for a conclusion to the conversation in the related issue ?

let p = project()
.file(
"Cargo.toml",
r#"
[profile.dev]
force-frame-pointers = true

[package]
name = "foo"
version = "0.0.1"
edition = "2015"
"#,
)
.file("src/main.rs", "fn main() {}")
.build();

p.cargo("build -v")
.with_stderr_data(str![[r#"
[COMPILING] foo v0.0.1 ([ROOT]/foo)
[RUNNING] `rustc --crate-name foo [..] -C force-frame-pointers=on [..]`
[FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s

"#]])
.run();
}

#[cargo_test]
fn force_frame_pointers_off_works() {
let p = project()
.file(
"Cargo.toml",
r#"
[profile.dev]
force-frame-pointers = false

[package]
name = "foo"
version = "0.0.1"
edition = "2015"
"#,
)
.file("src/main.rs", "fn main() {}")
.build();

p.cargo("build -v")
.with_stdout_does_not_contain(str!["force-frame-pointers"])
.with_stderr_does_not_contain(str!["force-frame-pointers"])
.run();
}

#[cargo_test]
fn force_frame_pointers_unspecified_works() {
let p = project()
.file(
"Cargo.toml",
r#"
[package]
name = "foo"
version = "0.0.1"
edition = "2015"
"#,
)
.file("src/main.rs", "fn main() {}")
.build();

p.cargo("build -v")
.with_stdout_does_not_contain(str!["force-frame-pointers"])
.with_stderr_does_not_contain(str!["force-frame-pointers"])
.run();
}

#[cargo_test]
fn rustflags_works() {
let p = project()
Expand Down
4 changes: 4 additions & 0 deletions tests/testsuite/unit_graph.rs
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ fn simple() {
"codegen_units": null,
"debug_assertions": true,
"debuginfo": 2,
"force_frame_pointers": false,
"incremental": false,
"lto": "false",
"name": "dev",
Expand Down Expand Up @@ -120,6 +121,7 @@ fn simple() {
"codegen_units": null,
"debug_assertions": true,
"debuginfo": 2,
"force_frame_pointers": false,
"incremental": false,
"lto": "false",
"name": "dev",
Expand Down Expand Up @@ -158,6 +160,7 @@ fn simple() {
"codegen_units": null,
"debug_assertions": true,
"debuginfo": 2,
"force_frame_pointers": false,
"incremental": false,
"lto": "false",
"name": "dev",
Expand Down Expand Up @@ -201,6 +204,7 @@ fn simple() {
"codegen_units": null,
"debug_assertions": true,
"debuginfo": 2,
"force_frame_pointers": false,
"incremental": false,
"lto": "false",
"name": "dev",
Expand Down
Loading