Combine -Zinstrument-function-*-opts into -Zinstrument-function

Try to reduce to number of command line options. Each framework
has the option of parsing a string following a colon delimiter.

Author: pmur

compiler/rustc_codegen_llvm/src/attributes.rs

@@ -243,11 +243,10 @@ fn instrument_function_attr<'ll>(
                 ));
             }
         }
-        InstrumentFunction::XRay => {
+        InstrumentFunction::XRay(options) => {
             // XRay instrumentation is similar to __cyg_profile_func_{enter,exit}.
             // Function prologue and epilogue are instrumented with NOP sleds,
             // a runtime library later replaces them with detours into tracing code.
-            let options = &sess.opts.unstable_opts.instrument_xray_opts;
 
             let mut never = options.never;
             let mut always = options.always;

compiler/rustc_session/src/config.rs

@@ -160,7 +160,7 @@ pub enum InstrumentFunction {
     /// `-Z instrument-function=mcount`
     Mcount,
     /// `-Z instrument-function=xray`
-    XRay,
+    XRay(InstrumentXRayOpts),
 }
 
 /// Individual flag values controlled by `-Zcoverage-options`.
@@ -261,19 +261,19 @@ pub enum AnnotateMoves {
 
 #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
 pub struct InstrumentXRayOpts {
-    /// `-Z instrument-xray-opts=always`, force instrumentation
+    /// `-Z instrument-function=xray:always`, force instrumentation
     pub always: bool,
-    /// `-Z instrument-xray-opts=never`, disable instrumentation
+    /// `-Z instrument-function=xray:never`, disable instrumentation
     pub never: bool,
-    /// `-Z instrument-xray-opts=ignore-loops`, ignore presence of loops,
+    /// `-Z instrument-function=xray:ignore-loops`, ignore presence of loops,
     /// instrument functions based only on instruction count
     pub ignore_loops: bool,
-    /// `-Z instrument-xray-opts=instruction-threshold=N`, explicitly set instruction threshold
+    /// `-Z instrument-function=xray:instruction-threshold=N`, explicitly set instruction threshold
     /// for instrumentation, or `None` to use compiler's default
     pub instruction_threshold: Option<usize>,
-    /// `-Z instrument-xray-opts=skip-entry`, do not instrument function entry
+    /// `-Z instrument-function=xray:skip-entry`, do not instrument function entry
     pub skip_entry: bool,
-    /// `-Z instrument-xray-opts=skip-exit`, do not instrument function exit
+    /// `-Z instrument-function=xray:skip-exit`, do not instrument function exit
     pub skip_exit: bool,
 }
 

compiler/rustc_session/src/options.rs

@@ -783,8 +783,7 @@ mod desc {
     pub(crate) const parse_dump_mono_stats: &str = "`markdown` (default) or `json`";
     pub(crate) const parse_instrument_coverage: &str = parse_bool;
     pub(crate) const parse_coverage_options: &str = "`block` | `branch` | `condition`";
-    pub(crate) const parse_instrument_function: &str = "`fentry` | `mcount` | `xray`";
-    pub(crate) const parse_instrument_xray_opts: &str = "a comma separated list of settings: `always` or `never` (mutually exclusive), `ignore-loops`, `instruction-threshold=N`, `skip-entry`, `skip-exit`";
+    pub(crate) const parse_instrument_function: &str = "`fentry` | `mcount` | `xray`, and an optional colon with a list of comma separated options.";
     pub(crate) const parse_unpretty: &str = "`string` or `string=string`";
     pub(crate) const parse_treat_err_as_bug: &str = "either no value or a non-negative number";
     pub(crate) const parse_next_solver_config: &str =
@@ -1543,15 +1542,42 @@ pub mod parse {
         slot: &mut InstrumentFunction,
         v: Option<&str>,
     ) -> bool {
+        // Argument looks like the regex: type(:sub_opt(,sub_opt)*)?
         let Some(v) = v else { return false };
-        match v {
-            "fentry" => *slot = InstrumentFunction::Fentry,
-            "mcount" => *slot = InstrumentFunction::Mcount,
-            "xray" => *slot = InstrumentFunction::XRay,
-            "none" => *slot = InstrumentFunction::No,
-            _ => return false,
+        let opts: Vec<_> = v.split(':').collect();
+        if opts.len() > 2 {
+            println!("too many opts");
+            return false;
         }
-        true
+        let sub_opts = opts.get(1).copied();
+        let mut parsed = false;
+
+        match opts[0] {
+            "fentry" => {
+                parsed = sub_opts.is_none();
+                *slot = InstrumentFunction::Fentry;
+            }
+            "mcount" => {
+                parsed = sub_opts.is_none();
+                *slot = InstrumentFunction::Mcount;
+            }
+            "xray" => {
+                // Accept this option multiple times, this allows replacing or
+                // specifying additional options.
+                let mut xray_opts = match slot {
+                    InstrumentFunction::XRay(opts) => opts,
+                    _ => &mut InstrumentXRayOpts::default(),
+                };
+                parsed = parse_instrument_xray_opts(&mut xray_opts, sub_opts);
+                *slot = InstrumentFunction::XRay(*xray_opts);
+            }
+            "none" => {
+                parsed = sub_opts.is_none();
+                *slot = InstrumentFunction::No;
+            }
+            _ => {}
+        }
+        parsed
     }
 
     pub(crate) fn parse_instrument_xray_opts(
@@ -2400,17 +2426,12 @@ options! {
     input_stats: bool = (false, parse_bool, [UNTRACKED],
         "print some statistics about AST and HIR (default: no)"),
     instrument_function: InstrumentFunction = (InstrumentFunction::No, parse_instrument_function, [TRACKED],
-        "insert function entry/exit instrument code. Options are none, xray, mcount, fentry. The default is none."),
-    instrument_xray_opts: InstrumentXRayOpts = (InstrumentXRayOpts::default(), parse_instrument_xray_opts, [TRACKED],
-        "configuration options for XRay-based tracing (default is ``).
-         Optional extra settings:
-         `=always`
-         `=never`
-         `=ignore-loops`
-         `=instruction-threshold=N`
-         `=skip-entry`
-         `=skip-exit`
-         Multiple options can be combined with commas."),
+        "insert function instrument code for tracing (default: none).
+         Instrumentation options are:
+         `xray`, `mcount`, or `fentry`
+         Additional configuration options can be set with a colon followed
+         by a comma separated list (e.g `xray:ignore-loops`).
+         `xray`: always,never,ignore-loops,instruction-threshold=N,skip-entry,skip-exit"),
     large_data_threshold: Option<u64> = (None, parse_opt_number, [TRACKED],
         "set the threshold for objects to be stored in a \"large data\" section \
          (only effective with -Ccode-model=medium, default: 65536)"),

compiler/rustc_session/src/session.rs

@@ -1338,7 +1338,7 @@ fn validate_commandline_args_with_session_available(sess: &Session) {
                     .emit_err(errors::InstrumentationNotSupported { us: "fentry".to_string() });
             }
         }
-        InstrumentFunction::XRay => {
+        InstrumentFunction::XRay(_) => {
             if !sess.target.options.supports_xray {
                 sess.dcx().emit_err(errors::InstrumentationNotSupported { us: "XRay".to_string() });
             }

src/doc/unstable-book/src/compiler-flags/instrument-function.md

@@ -81,8 +81,8 @@ and/or the [XRay whitepaper](http://research.google.com/pubs/pub45287.html).
 Set the `-Z instrument-function=xray` compiler flag in order to enable XRay instrumentation.
 
   - `-Z instrument-function=xray` – use the default settings
-  - `-Z instrument-function=xray -Z instrument-xray-opts=skip-exit` – configure a custom setting
-  - `-Z instrument-function=xray -Z instrument-xray-opts=ignore-loops,instruction-threshold=300` –
+  - `-Z instrument-function=xray:skip-exit` – configure a custom setting
+  - `-Z instrument-function=xray:ignore-loops,instruction-threshold=300` –
     multiple settings separated by commas
 
 Supported options:

tests/assembly-llvm/aarch64-xray.rs

@@ -1,5 +1,5 @@
 //@ assembly-output: emit-asm
-//@ compile-flags: -Zinstrument-function=xray -Zinstrument-xray-opts=always
+//@ compile-flags: -Zinstrument-function=xray:always
 
 //@ revisions: aarch64-linux
 //@[aarch64-linux] compile-flags: --target=aarch64-unknown-linux-gnu

tests/assembly-llvm/x86_64-xray.rs

@@ -1,5 +1,5 @@
 //@ assembly-output: emit-asm
-//@ compile-flags: -Zinstrument-function=xray -Zinstrument-xray-opts=always -Cllvm-args=-x86-asm-syntax=intel
+//@ compile-flags: -Zinstrument-function=xray:always -Cllvm-args=-x86-asm-syntax=intel
 
 //@ revisions: x86_64-linux
 //@[x86_64-linux] compile-flags: --target=x86_64-unknown-linux-gnu

tests/codegen-llvm/instrument-xray/basic.rs

@@ -1,8 +1,8 @@
-// Checks that `-Z instrument-function=xray -Z instrument-xray-opts`
+// Checks that `-Z instrument-function=xray:always`
 // produces expected instrumentation.
 //
 //@ needs-xray
-//@ compile-flags: -Z instrument-function=xray -Z instrument-xray-opts=always -Copt-level=0
+//@ compile-flags: -Z instrument-function=xray:always -Copt-level=0
 
 #![crate_type = "lib"]
 

tests/codegen-llvm/instrument-xray/options-combine.rs

@@ -1,9 +1,9 @@
-// Checks that `-Z instrument-xray-opts` options can be specified multiple times.
+// Checks that `-Z instrument-function=xray:<opt>` options can be specified multiple times.
 //
 //@ needs-xray
-//@ compile-flags: -Z instrument-function=xray -Z instrument-xray-opts=skip-exit -Copt-level=0
-//@ compile-flags: -Z instrument-function=xray -Z instrument-xray-opts=instruction-threshold=123 -Copt-level=0
-//@ compile-flags: -Z instrument-function=xray -Z instrument-xray-opts=instruction-threshold=456 -Copt-level=0
+//@ compile-flags: -Z instrument-function=xray:skip-exit -Copt-level=0
+//@ compile-flags: -Z instrument-function=xray:instruction-threshold=123 -Copt-level=0
+//@ compile-flags: -Z instrument-function=xray:instruction-threshold=456 -Copt-level=0
 
 #![crate_type = "lib"]
 

tests/codegen-llvm/instrument-xray/options-override.rs

@@ -1,8 +1,8 @@
-// Checks that the last `-Z instrument-xray-opts` option wins.
+// Checks that the last `-Z instrument-function=xray:opt` option wins.
 //
 //@ needs-xray
-//@ compile-flags: -Z instrument-function=xray -Z instrument-xray-opts=always -Copt-level=0
-//@ compile-flags: -Z instrument-function=xray -Z instrument-xray-opts=never -Copt-level=0
+//@ compile-flags: -Z instrument-function=xray:always -Copt-level=0
+//@ compile-flags: -Z instrument-function=xray:never -Copt-level=0
 
 #![crate_type = "lib"]