Rollup merge of #156887 - zamazan4ik:rename-debuginfo-for-profiling-switch, r=folkertdev

Rename `-Zdebuginfo-for-profiling` switch

The PR was raised from this [comment](#155942 (comment)) from another stabilization PR: #155942

I renamed `-Zdebug-info-for-profiling` into `-Zdebuginfo-for-profiling` before stabilization to be consistent with other `debuginfo`-related Rustc flags like `-C split-debuginfo` and `-C debuginfo`.

One important note is that Clang has the [flag](https://clang.llvm.org/docs/ClangCommandLineReference.html#cmdoption-clang-fdebug-info-for-profiling) under `-fdebug-info-for-profiling`. I decided that consistency with other Rustc flags is more important here than to be consistent with Clang.

r? folkertdev (as was proposed [here](#155942 (comment)))

Author: JonathanBrouwer

compiler/rustc_codegen_ssa/src/back/write.rs

@@ -180,7 +180,7 @@ impl ModuleConfig {
             ),
             pgo_use: if_regular!(sess.opts.cg.profile_use.clone(), None),
             pgo_sample_use: if_regular!(sess.opts.unstable_opts.profile_sample_use.clone(), None),
-            debug_info_for_profiling: sess.opts.unstable_opts.debug_info_for_profiling,
+            debug_info_for_profiling: sess.opts.unstable_opts.debuginfo_for_profiling,
             instrument_coverage: if_regular!(sess.instrument_coverage(), false),
 
             sanitizer: if_regular!(sess.sanitizers(), SanitizerSet::empty()),

compiler/rustc_interface/src/tests.rs

@@ -782,8 +782,8 @@ fn test_unstable_options_tracking_hash() {
     );
     tracked!(crate_attr, vec!["abc".to_string()]);
     tracked!(cross_crate_inline_threshold, InliningThreshold::Always);
-    tracked!(debug_info_for_profiling, true);
     tracked!(debug_info_type_line_numbers, true);
+    tracked!(debuginfo_for_profiling, true);
     tracked!(default_visibility, Some(rustc_target::spec::SymbolVisibility::Hidden));
     tracked!(dep_info_omit_d_target, true);
     tracked!(direct_access_external_data, Some(true));

compiler/rustc_session/src/options.rs

@@ -2252,12 +2252,12 @@ options! {
         "inject the given attribute in the crate"),
     cross_crate_inline_threshold: InliningThreshold = (InliningThreshold::Sometimes(100), parse_inlining_threshold, [TRACKED],
         "threshold to allow cross crate inlining of functions"),
-    debug_info_for_profiling: bool = (false, parse_bool, [TRACKED],
-        "emit discriminators and other data necessary for AutoFDO"),
     debug_info_type_line_numbers: bool = (false, parse_bool, [TRACKED],
         "emit type and line information for additional data types (default: no)"),
     debuginfo_compression: DebugInfoCompression = (DebugInfoCompression::None, parse_debuginfo_compression, [TRACKED],
         "compress debug info sections (none, zlib, zstd, default: none)"),
+    debuginfo_for_profiling: bool = (false, parse_bool, [TRACKED],
+        "emit discriminators and other data necessary for AutoFDO"),
     deduplicate_diagnostics: bool = (true, parse_bool, [UNTRACKED],
         "deduplicate identical diagnostics (default: yes)"),
     default_visibility: Option<SymbolVisibility> = (None, parse_opt_symbol_visibility, [TRACKED],

…mpiler-flags/debug_info_for_profiling.md …ompiler-flags/debuginfo_for_profiling.mdsrc/doc/unstable-book/src/compiler-flags/debug_info_for_profiling.md renamed to src/doc/unstable-book/src/compiler-flags/debuginfo_for_profiling.md src/doc/unstable-book/src/compiler-flags/debug_info_for_profiling.md renamed to src/doc/unstable-book/src/compiler-flags/debuginfo_for_profiling.md

@@ -1,4 +1,4 @@
-# `debug-info-for-profiling`
+# `debuginfo-for-profiling`
 
 ---
 
@@ -22,7 +22,7 @@ external tool `create_llvm_prof` from [this repository] must be used.
 Given a Rust file `main.rs`, we can produce an optimized binary as follows:
 
 ```shell
-rustc -O -Zdebug-info-for-profiling main.rs -o main
+rustc -O -Zdebuginfo-for-profiling main.rs -o main
 perf record -b ./main
 create_llvm_prof --binary=main --out=code.prof
 rustc -O -Zprofile-sample-use=code.prof main.rs -o main2

src/doc/unstable-book/src/compiler-flags/profile_sample_use.md

@@ -4,7 +4,7 @@
 
 `-Zprofile-sample-use=code.prof` directs `rustc` to use the profile
 `code.prof` as a source for Automatic Feedback Directed Optimization (AFDO).
-See the documentation of [`-Zdebug-info-for-profiling`] for more information
+See the documentation of [`-Zdebuginfo-for-profiling`] for more information
 on using AFDO.
 
-[`-Zdebug-info-for-profiling`]: debug_info_for_profiling.html
+[`-Zdebuginfo-for-profiling`]: debuginfo_for_profiling.html

tests/assembly-llvm/debuginfo-for-profiling.rs

@@ -0,0 +1,56 @@
+// Verify that additional discriminators are emitted for profiling with `-Zdebuginfo-for-profiling`:
+//  - 0 discriminators are emitted without the flag in the test below
+//  - at least 1 discriminator is emitted with the flag in the test below.
+//    Actual count depends on the target
+//
+//
+//@ add-minicore
+//@ revisions: DEFAULT-X86 DEFAULT-AARCH64 DEBUGINFO-X86 DEBUGINFO-AARCH64
+//@ assembly-output: emit-asm
+//@ compile-flags: -Copt-level=2 -Cdebuginfo=line-tables-only
+//@ [DEFAULT-X86] compile-flags: --target=x86_64-unknown-linux-gnu
+//@ [DEFAULT-X86] needs-llvm-components: x86
+//@ [DEFAULT-AARCH64] compile-flags: --target=aarch64-unknown-linux-gnu
+//@ [DEFAULT-AARCH64] needs-llvm-components: aarch64
+//@ [DEBUGINFO-X86] compile-flags: -Zdebuginfo-for-profiling --target=x86_64-unknown-linux-gnu
+//@ [DEBUGINFO-X86] needs-llvm-components: x86
+//@ [DEBUGINFO-AARCH64] compile-flags: -Zdebuginfo-for-profiling --target=aarch64-unknown-linux-gnu
+//@ [DEBUGINFO-AARCH64] needs-llvm-components: aarch64
+// DEFAULT-X86-NOT: discriminator
+// DEFAULT-AARCH64-NOT: discriminator
+// DEBUGINFO-X86-COUNT-1: discriminator
+// DEBUGINFO-AARCH64-COUNT-1: discriminator
+
+#![feature(no_core)]
+#![no_std]
+#![no_core]
+#![crate_type = "lib"]
+
+extern crate minicore;
+use minicore::*;
+
+extern "C" {
+    fn add(_x: i32, _y: i32) -> i32;
+    fn mul(_x: i32, _y: i32) -> i32;
+    fn compute(_x: i32) -> i32;
+    fn cond() -> bool;
+}
+
+#[no_mangle]
+pub fn f(limit: i32) -> i32 {
+    unsafe {
+        let mut sum = 0;
+        let mut i = 1;
+
+        while cond() {
+            if cond() {
+                sum = add(sum, compute(i));
+            } else {
+                sum = add(sum, mul(compute(i), 2));
+            }
+            i = add(i, 1);
+        }
+
+        sum
+    }
+}

tests/codegen-llvm/debuginfo-for-profiling.rs

@@ -0,0 +1,45 @@
+// Verify that additional discriminators are emitted for profiling with `-Zdebuginfo-for-profiling`:
+//  - 0 discriminators are emitted without the flag in the test below
+//  - at least 1 discriminator is emitted with the flag in the test below
+//
+//
+//@ add-minicore
+//@ revisions: DEFAULT DEBUGINFO
+//@ compile-flags: -Copt-level=2 -Cdebuginfo=line-tables-only
+//@ [DEBUGINFO] compile-flags: -Zdebuginfo-for-profiling
+// DEFAULT-NOT: discriminator
+// DEBUGINFO-COUNT-1: discriminator
+
+#![feature(no_core)]
+#![no_std]
+#![no_core]
+#![crate_type = "lib"]
+
+extern crate minicore;
+use minicore::*;
+
+extern "C" {
+    fn add(_x: i32, _y: i32) -> i32;
+    fn mul(_x: i32, _y: i32) -> i32;
+    fn compute(_x: i32) -> i32;
+    fn cond() -> bool;
+}
+
+#[no_mangle]
+pub fn f(limit: i32) -> i32 {
+    unsafe {
+        let mut sum = 0;
+        let mut i = 1;
+
+        while cond() {
+            if cond() {
+                sum = add(sum, compute(i));
+            } else {
+                sum = add(sum, mul(compute(i), 2));
+            }
+            i = add(i, 1);
+        }
+
+        sum
+    }
+}