Add x perf command for profiling the compiler using rustc-perf

Author: Kobzol

src/bootstrap/src/core/build_steps/mod.rs

@@ -7,6 +7,7 @@ pub(crate) mod doc;
 pub(crate)mod format;
 pub(crate)mod install;
 pub(crate)mod llvm;
+pub(crate)mod perf;
 pub(crate)mod run;
 pub(crate)mod setup;
 pub(crate)mod suggest;

src/bootstrap/src/core/build_steps/perf.rs

@@ -0,0 +1,45 @@
+use std::process::Command;
+
+usecrate::core::build_steps::compile::{Std,Sysroot};
+usecrate::core::build_steps::tool::RustcPerf;
+usecrate::core::builder::Builder;
+usecrate::core::config::DebuginfoLevel;
+
+/// Performs profiling using `rustc-perf` on a built version of the compiler.
+pubfnperf(builder:&Builder<'_>){
+let collector = builder.ensure(RustcPerf{
+compiler: builder.compiler(0, builder.config.build),
+target: builder.config.build,
+});
+
+if builder.build.config.rust_debuginfo_level_rustc == DebuginfoLevel::None{
+ builder.info(r#"WARNING: You are compiling rustc without debuginfo, this will make profiling less useful.
+Consider setting `rust.debuginfo-level = 1` in `config.toml`."#);
+}
+
+let compiler = builder.compiler(builder.top_stage, builder.config.build);
+ builder.ensure(Std::new(compiler, builder.config.build));
+let sysroot = builder.ensure(Sysroot::new(compiler));
+let rustc = sysroot.join("bin/rustc");
+
+let results_dir = builder.build.out.join("rustc-perf");
+
+letmut cmd = Command::new(collector);
+let cmd = cmd
+.arg("profile_local")
+.arg("eprintln")
+.arg("--out-dir")
+.arg(&results_dir)
+.arg("--include")
+.arg("helloworld")
+.arg(&rustc);
+
+ builder.info(&format!("Running `rustc-perf` using `{}`", rustc.display()));
+
+// We need to set the working directory to `src/tools/perf`, so that it can find the directory
+// with compile-time benchmarks.
+let cmd = cmd.current_dir(builder.src.join("src/tools/rustc-perf"));
+ builder.build.run(cmd);
+
+ builder.info(&format!("You can find the results at `{}`", results_dir.display()));
+}

src/bootstrap/src/core/builder.rs

@@ -666,6 +666,7 @@ pub enum Kind {
 Setup,
 Suggest,
 Vendor,
+Perf,
 }
 
 implKind{
@@ -687,6 +688,7 @@ impl Kind {
 Kind::Setup => "setup",
 Kind::Suggest => "suggest",
 Kind::Vendor => "vendor",
+Kind::Perf => "perf",
 }
 }
 
@@ -698,6 +700,7 @@ impl Kind {
 Kind::Run => "Running",
 Kind::Suggest => "Suggesting",
 Kind::Clippy => "Linting",
+Kind::Perf => "Profiling & benchmarking",
  _ => {
 let title_letter = self.as_str()[0..1].to_ascii_uppercase();
 returnformat!("{title_letter}{}ing",&self.as_str()[1..]);
@@ -951,7 +954,7 @@ impl<'a> Builder<'a> {
 Kind::Clean => describe!(clean::CleanAll, clean::Rustc, clean::Std),
 Kind::Vendor => describe!(vendor::Vendor),
 // special-cased in Build::build()
-Kind::Format | Kind::Suggest => vec![],
+Kind::Format | Kind::Suggest| Kind::Perf=> vec![],
 }
 }
 
@@ -1023,6 +1026,7 @@ impl<'a> Builder<'a> {
  path.as_ref().map_or([].as_slice(), |path| std::slice::from_ref(path)),
 ),
 Subcommand::Vendor{ .. } => (Kind::Vendor,&paths[..]),
+Subcommand::Perf{ .. } => (Kind::Perf,&paths[..]),
 };
 
 Self::new_internal(build, kind, paths.to_owned())

src/bootstrap/src/core/config/config.rs

@@ -2027,6 +2027,7 @@ impl Config {
 Subcommand::Bench{ .. } => flags.stage.or(bench_stage).unwrap_or(2),
 Subcommand::Dist{ .. } => flags.stage.or(dist_stage).unwrap_or(2),
 Subcommand::Install{ .. } => flags.stage.or(install_stage).unwrap_or(2),
+Subcommand::Perf{ .. } => flags.stage.unwrap_or(1),
 // These are all bootstrap tools, which don't depend on the compiler.
 // The stage we pass shouldn't matter, but use 0 just in case.
 Subcommand::Clean{ .. }
@@ -2064,7 +2065,8 @@ impl Config {
  | Subcommand::Setup{ .. }
  | Subcommand::Format{ .. }
  | Subcommand::Suggest{ .. }
- | Subcommand::Vendor{ .. } => {}
+ | Subcommand::Vendor{ .. }
+ | Subcommand::Perf{ .. } => {}
 }
 }
 

src/bootstrap/src/core/config/flags.rs

@@ -469,6 +469,9 @@ Arguments:
 #[arg(long)]
 versioned_dirs:bool,
 },
+/// Perform profiling and benchmarking of the compiler using the
+/// `rustc-perf` benchmark suite.
+Perf{},
 }
 
 implSubcommand{
@@ -490,6 +493,7 @@ impl Subcommand {
 Subcommand::Setup{ .. } => Kind::Setup,
 Subcommand::Suggest{ .. } => Kind::Suggest,
 Subcommand::Vendor{ .. } => Kind::Vendor,
+Subcommand::Perf{ .. } => Kind::Perf,
 }
 }
 

src/bootstrap/src/lib.rs

@@ -672,6 +672,9 @@ impl Build {
 Subcommand::Suggest{ run } => {
 return core::build_steps::suggest::suggest(&builder::Builder::new(self),*run);
 }
+Subcommand::Perf{ .. } => {
+return core::build_steps::perf::perf(&builder::Builder::new(self));
+}
  _ => (),
 }
 

src/etc/completions/x.py.fish

@@ -48,6 +48,7 @@ complete -c x.py -n "__fish_use_subcommand" -f -a "run" -d 'Run tools contained
 complete-c x.py -n"__fish_use_subcommand"-f-a"setup"-d'Set up the environment for development'
 complete-c x.py -n"__fish_use_subcommand"-f-a"suggest"-d'Suggest a subset of tests to run, based on modified files'
 complete-c x.py -n"__fish_use_subcommand"-f-a"vendor"-d'Vendor dependencies'
+complete-c x.py -n"__fish_use_subcommand"-f-a"perf"-d'Perform profiling and benchmarking of the compiler using the `rustc-perf` benchmark suite'
 complete-c x.py -n"__fish_seen_subcommand_from build"-l config -d'TOML configuration file for build'-r-F
 complete-c x.py -n"__fish_seen_subcommand_from build"-l build-dir -d'Build directory, overrides `build.build-dir` in `config.toml`'-r-f-a"(__fish_complete_directories)"
 complete-c x.py -n"__fish_seen_subcommand_from build"-l build -d'build target of the stage0 compiler'-r-f
@@ -628,3 +629,37 @@ complete -c x.py -n "__fish_seen_subcommand_from vendor" -l llvm-profile-generat
 complete-c x.py -n"__fish_seen_subcommand_from vendor"-l enable-bolt-settings -d'Enable BOLT link flags'
 complete-c x.py -n"__fish_seen_subcommand_from vendor"-l skip-stage0-validation -d'Skip stage0 compiler validation'
 complete-c x.py -n"__fish_seen_subcommand_from vendor"-s h -lhelp-d'Print help (see more with \'--help\')'
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l config -d'TOML configuration file for build'-r-F
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l build-dir -d'Build directory, overrides `build.build-dir` in `config.toml`'-r-f-a"(__fish_complete_directories)"
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l build -d'build target of the stage0 compiler'-r-f
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l host -d'host targets to build'-r-f
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l target -d'target targets to build'-r-f
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l exclude -d'build paths to exclude'-r-F
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l skip -d'build paths to skip'-r-F
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l rustc-error-format -r-f
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l on-fail -d'command to run on failure'-r-f-a"(__fish_complete_command)"
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l stage -d'stage to build (indicates compiler to use/test, e.g., stage 0 uses the bootstrap compiler, stage 1 the stage 0 rustc artifacts, etc.)'-r-f
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l keep-stage -d'stage(s) to keep without recompiling (pass multiple times to keep e.g., both stages 0 and 1)'-r-f
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l keep-stage-std -d'stage(s) of the standard library to keep without recompiling (pass multiple times to keep e.g., both stages 0 and 1)'-r-f
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l src -d'path to the root of the rust checkout'-r-f-a"(__fish_complete_directories)"
+complete-c x.py -n"__fish_seen_subcommand_from perf"-s j -ljobs-d'number of jobs to run in parallel'-r-f
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l warnings -d'if value is deny, will deny warnings if value is warn, will emit warnings otherwise, use the default configured behaviour'-r-f-a"{deny	'',warn	'',default	''}"
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l error-format -d'rustc error format'-r-f
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l color -d'whether to use color in cargo and rustc output'-r-f-a"{always	'',never	'',auto	''}"
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l llvm-skip-rebuild -d'whether rebuilding llvm should be skipped, overriding `skip-rebuld` in config.toml'-r-f-a"{true	'',false	''}"
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l rust-profile-generate -d'generate PGO profile with rustc build'-r-F
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l rust-profile-use -d'use PGO profile for rustc build'-r-F
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l llvm-profile-use -d'use PGO profile for LLVM build'-r-F
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l reproducible-artifact -d'Additional reproducible artifacts that should be added to the reproducible artifacts archive'-r
+complete-c x.py -n"__fish_seen_subcommand_from perf"-lset-d'override options in config.toml'-r-f
+complete-c x.py -n"__fish_seen_subcommand_from perf"-s v -l verbose -d'use verbose output (-vv for very verbose)'
+complete-c x.py -n"__fish_seen_subcommand_from perf"-s i -l incremental -d'use incremental compilation'
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l include-default-paths -d'include default paths in addition to the provided ones'
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l dry-run -d'dry run; don\'t build anything'
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l dump-bootstrap-shims -d'Indicates whether to dump the work done from bootstrap shims'
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l json-output -d'use message-format=json'
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l bypass-bootstrap-lock -d'Bootstrap uses this value to decide whether it should bypass locking the build process. This is rarely needed (e.g., compiling the std library for different targets in parallel)'
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l llvm-profile-generate -d'generate PGO profile with llvm built for rustc'
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l enable-bolt-settings -d'Enable BOLT link flags'
+complete-c x.py -n"__fish_seen_subcommand_from perf"-l skip-stage0-validation -d'Skip stage0 compiler validation'
+complete-c x.py -n"__fish_seen_subcommand_from perf"-s h -lhelp-d'Print help (see more with \'--help\')'

src/etc/completions/x.py.ps1

@@ -75,6 +75,7 @@ Register-ArgumentCompleter -Native -CommandName 'x.py' -ScriptBlock {
  [CompletionResult]::new('setup','setup', [CompletionResultType]::ParameterValue,'Set up the environment for development')
  [CompletionResult]::new('suggest','suggest', [CompletionResultType]::ParameterValue,'Suggest a subset of tests to run, based on modified files')
  [CompletionResult]::new('vendor','vendor', [CompletionResultType]::ParameterValue,'Vendor dependencies')
+ [CompletionResult]::new('perf','perf', [CompletionResultType]::ParameterValue,'Perform profiling and benchmarking of the compiler using the `rustc-perf` benchmark suite')
 break
  }
 'x.py;build' {
@@ -769,6 +770,47 @@ Register-ArgumentCompleter -Native -CommandName 'x.py' -ScriptBlock {
  [CompletionResult]::new('--help','help', [CompletionResultType]::ParameterName,'Print help (see more with ''--help'')')
 break
  }
+'x.py;perf' {
+ [CompletionResult]::new('--config','config', [CompletionResultType]::ParameterName,'TOML configuration file for build')
+ [CompletionResult]::new('--build-dir','build-dir', [CompletionResultType]::ParameterName,'Build directory, overrides `build.build-dir` in `config.toml`')
+ [CompletionResult]::new('--build','build', [CompletionResultType]::ParameterName,'build target of the stage0 compiler')
+ [CompletionResult]::new('--host','host', [CompletionResultType]::ParameterName,'host targets to build')
+ [CompletionResult]::new('--target','target', [CompletionResultType]::ParameterName,'target targets to build')
+ [CompletionResult]::new('--exclude','exclude', [CompletionResultType]::ParameterName,'build paths to exclude')
+ [CompletionResult]::new('--skip','skip', [CompletionResultType]::ParameterName,'build paths to skip')
+ [CompletionResult]::new('--rustc-error-format','rustc-error-format', [CompletionResultType]::ParameterName,'rustc-error-format')
+ [CompletionResult]::new('--on-fail','on-fail', [CompletionResultType]::ParameterName,'command to run on failure')
+ [CompletionResult]::new('--stage','stage', [CompletionResultType]::ParameterName,'stage to build (indicates compiler to use/test, e.g., stage 0 uses the bootstrap compiler, stage 1 the stage 0 rustc artifacts, etc.)')
+ [CompletionResult]::new('--keep-stage','keep-stage', [CompletionResultType]::ParameterName,'stage(s) to keep without recompiling (pass multiple times to keep e.g., both stages 0 and 1)')
+ [CompletionResult]::new('--keep-stage-std','keep-stage-std', [CompletionResultType]::ParameterName,'stage(s) of the standard library to keep without recompiling (pass multiple times to keep e.g., both stages 0 and 1)')
+ [CompletionResult]::new('--src','src', [CompletionResultType]::ParameterName,'path to the root of the rust checkout')
+ [CompletionResult]::new('-j','j', [CompletionResultType]::ParameterName,'number of jobs to run in parallel')
+ [CompletionResult]::new('--jobs','jobs', [CompletionResultType]::ParameterName,'number of jobs to run in parallel')
+ [CompletionResult]::new('--warnings','warnings', [CompletionResultType]::ParameterName,'if value is deny, will deny warnings if value is warn, will emit warnings otherwise, use the default configured behaviour')
+ [CompletionResult]::new('--error-format','error-format', [CompletionResultType]::ParameterName,'rustc error format')
+ [CompletionResult]::new('--color','color', [CompletionResultType]::ParameterName,'whether to use color in cargo and rustc output')
+ [CompletionResult]::new('--llvm-skip-rebuild','llvm-skip-rebuild', [CompletionResultType]::ParameterName,'whether rebuilding llvm should be skipped, overriding `skip-rebuld` in config.toml')
+ [CompletionResult]::new('--rust-profile-generate','rust-profile-generate', [CompletionResultType]::ParameterName,'generate PGO profile with rustc build')
+ [CompletionResult]::new('--rust-profile-use','rust-profile-use', [CompletionResultType]::ParameterName,'use PGO profile for rustc build')
+ [CompletionResult]::new('--llvm-profile-use','llvm-profile-use', [CompletionResultType]::ParameterName,'use PGO profile for LLVM build')
+ [CompletionResult]::new('--reproducible-artifact','reproducible-artifact', [CompletionResultType]::ParameterName,'Additional reproducible artifacts that should be added to the reproducible artifacts archive')
+ [CompletionResult]::new('--set','set', [CompletionResultType]::ParameterName,'override options in config.toml')
+ [CompletionResult]::new('-v','v', [CompletionResultType]::ParameterName,'use verbose output (-vv for very verbose)')
+ [CompletionResult]::new('--verbose','verbose', [CompletionResultType]::ParameterName,'use verbose output (-vv for very verbose)')
+ [CompletionResult]::new('-i','i', [CompletionResultType]::ParameterName,'use incremental compilation')
+ [CompletionResult]::new('--incremental','incremental', [CompletionResultType]::ParameterName,'use incremental compilation')
+ [CompletionResult]::new('--include-default-paths','include-default-paths', [CompletionResultType]::ParameterName,'include default paths in addition to the provided ones')
+ [CompletionResult]::new('--dry-run','dry-run', [CompletionResultType]::ParameterName,'dry run; don''t build anything')
+ [CompletionResult]::new('--dump-bootstrap-shims','dump-bootstrap-shims', [CompletionResultType]::ParameterName,'Indicates whether to dump the work done from bootstrap shims')
+ [CompletionResult]::new('--json-output','json-output', [CompletionResultType]::ParameterName,'use message-format=json')
+ [CompletionResult]::new('--bypass-bootstrap-lock','bypass-bootstrap-lock', [CompletionResultType]::ParameterName,'Bootstrap uses this value to decide whether it should bypass locking the build process. This is rarely needed (e.g., compiling the std library for different targets in parallel)')
+ [CompletionResult]::new('--llvm-profile-generate','llvm-profile-generate', [CompletionResultType]::ParameterName,'generate PGO profile with llvm built for rustc')
+ [CompletionResult]::new('--enable-bolt-settings','enable-bolt-settings', [CompletionResultType]::ParameterName,'Enable BOLT link flags')
+ [CompletionResult]::new('--skip-stage0-validation','skip-stage0-validation', [CompletionResultType]::ParameterName,'Skip stage0 compiler validation')
+ [CompletionResult]::new('-h','h', [CompletionResultType]::ParameterName,'Print help (see more with ''--help'')')
+ [CompletionResult]::new('--help','help', [CompletionResultType]::ParameterName,'Print help (see more with ''--help'')')
+break
+ }
  })
 
 $completions.Where{ $_.CompletionText-like"$wordToComplete*" } |