Skip to content

Commit b7fe2ca

Browse files
michaelwoeristermichaelwoerister
committed
Stabilize profile-guided optimization.
1 parent 314194e commit b7fe2ca

File tree

14 files changed

+35
-36
lines changed

14 files changed

+35
-36
lines changed

‎src/librustc/session/config.rs

+12-13
Original file line numberDiff line numberDiff line change
@@ -1221,7 +1221,11 @@ options! {CodegenOptions, CodegenSetter, basic_codegen_options,
12211221
linker_plugin_lto: LinkerPluginLto = (LinkerPluginLto::Disabled,
12221222
parse_linker_plugin_lto, [TRACKED],
12231223
"generate build artifacts that are compatible with linker-based LTO."),
1224-
1224+
profile_generate: SwitchWithOptPath = (SwitchWithOptPath::Disabled,
1225+
parse_switch_with_opt_path, [TRACKED],
1226+
"compile the program with profiling instrumentation"),
1227+
profile_use: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1228+
"use the given `.profdata` file for profile-guided optimization"),
12251229
}
12261230

12271231
options! {DebuggingOptions, DebuggingSetter, basic_debugging_options,
@@ -1395,11 +1399,6 @@ options! {DebuggingOptions, DebuggingSetter, basic_debugging_options,
13951399
"extra arguments to prepend to the linker invocation (space separated)"),
13961400
profile: bool = (false, parse_bool, [TRACKED],
13971401
"insert profiling code"),
1398-
pgo_gen: SwitchWithOptPath = (SwitchWithOptPath::Disabled,
1399-
parse_switch_with_opt_path, [TRACKED],
1400-
"Generate PGO profile data, to a given file, or to the default location if it's empty."),
1401-
pgo_use: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED],
1402-
"Use PGO profile data from the given profile file."),
14031402
disable_instrumentation_preinliner: bool = (false, parse_bool, [TRACKED],
14041403
"Disable the instrumentation pre-inliner, useful for profiling / PGO."),
14051404
relro_level: Option<RelroLevel> = (None, parse_relro_level, [TRACKED],
@@ -2052,13 +2051,6 @@ pub fn build_session_options_and_crate_config(
20522051
}
20532052
}
20542053

2055-
if debugging_opts.pgo_gen.enabled() && debugging_opts.pgo_use.is_some() {
2056-
early_error(
2057-
error_format,
2058-
"options `-Z pgo-gen` and `-Z pgo-use` are exclusive",
2059-
);
2060-
}
2061-
20622054
let mut output_types = BTreeMap::new();
20632055
if !debugging_opts.parse_only {
20642056
for list in matches.opt_strs("emit") {
@@ -2170,6 +2162,13 @@ pub fn build_session_options_and_crate_config(
21702162
);
21712163
}
21722164

2165+
if cg.profile_generate.enabled() && cg.profile_use.is_some() {
2166+
early_error(
2167+
error_format,
2168+
"options `-C profile-generate` and `-C profile-use` are exclusive",
2169+
);
2170+
}
2171+
21732172
let mut prints = Vec::<PrintRequest>::new();
21742173
if cg.target_cpu.as_ref().map_or(false, |s| s == "help") {
21752174
prints.push(PrintRequest::TargetCPUs);

‎src/librustc/session/config/tests.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -519,11 +519,11 @@ fn test_codegen_options_tracking_hash() {
519519
assert!(reference.dep_tracking_hash() != opts.dep_tracking_hash());
520520

521521
opts = reference.clone();
522-
opts.debugging_opts.pgo_gen = SwitchWithOptPath::Enabled(None);
522+
opts.cg.profile_generate = SwitchWithOptPath::Enabled(None);
523523
assert_ne!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
524524

525525
opts = reference.clone();
526-
opts.debugging_opts.pgo_use = Some(PathBuf::from("abc"));
526+
opts.cg.profile_use = Some(PathBuf::from("abc"));
527527
assert_ne!(reference.dep_tracking_hash(), opts.dep_tracking_hash());
528528

529529
opts = reference.clone();

‎src/librustc/session/mod.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -1290,9 +1290,9 @@ fn validate_commandline_args_with_session_available(sess: &Session) {
12901290

12911291
// Make sure that any given profiling data actually exists so LLVM can't
12921292
// decide to silently skip PGO.
1293-
if let Some(ref path) = sess.opts.debugging_opts.pgo_use {
1293+
if let Some(ref path) = sess.opts.cg.profile_use {
12941294
if !path.exists() {
1295-
sess.err(&format!("File `{}` passed to `-Zpgo-use` does not exist.",
1295+
sess.err(&format!("File `{}` passed to `-C profile-use` does not exist.",
12961296
path.display()));
12971297
}
12981298
}
@@ -1301,7 +1301,7 @@ fn validate_commandline_args_with_session_available(sess: &Session) {
13011301
// an error to combine the two for now. It always runs into an assertions
13021302
// if LLVM is built with assertions, but without assertions it sometimes
13031303
// does not crash and will probably generate a corrupted binary.
1304-
if sess.opts.debugging_opts.pgo_gen.enabled() &&
1304+
if sess.opts.cg.profile_generate.enabled() &&
13051305
sess.target.target.options.is_like_msvc &&
13061306
sess.panic_strategy() == PanicStrategy::Unwind {
13071307
sess.err("Profile-guided optimization does not yet work in conjunction \

‎src/librustc_codegen_llvm/attributes.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ pub fn set_probestack(cx: &CodegenCx<'ll, '_>, llfn: &'ll Value) {
102102
return
103103
}
104104

105-
// probestack doesn't play nice either with pgo-gen.
106-
if cx.sess().opts.debugging_opts.pgo_gen.enabled() {
105+
// probestack doesn't play nice either with `-C profile-generate`.
106+
if cx.sess().opts.cg.profile_generate.enabled() {
107107
return;
108108
}
109109

‎src/librustc_codegen_ssa/back/link.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1156,7 +1156,7 @@ fn link_args<'a, B: ArchiveBuilder<'a>>(cmd: &mut dyn Linker,
11561156
cmd.build_static_executable();
11571157
}
11581158

1159-
if sess.opts.debugging_opts.pgo_gen.enabled() {
1159+
if sess.opts.cg.profile_generate.enabled() {
11601160
cmd.pgo_gen();
11611161
}
11621162

‎src/librustc_codegen_ssa/back/symbol_export.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ fn exported_symbols_provider_local<'tcx>(
203203
}
204204
}
205205

206-
if tcx.sess.opts.debugging_opts.pgo_gen.enabled() {
206+
if tcx.sess.opts.cg.profile_generate.enabled() {
207207
// These are weak symbols that point to the profile version and the
208208
// profile name, which need to be treated as exported so LTO doesn't nix
209209
// them.

‎src/librustc_codegen_ssa/back/write.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -423,8 +423,8 @@ pub fn start_async_codegen<B: ExtraBackendMethods>(
423423
modules_config.passes.push("insert-gcov-profiling".to_owned())
424424
}
425425

426-
modules_config.pgo_gen = sess.opts.debugging_opts.pgo_gen.clone();
427-
modules_config.pgo_use = sess.opts.debugging_opts.pgo_use.clone();
426+
modules_config.pgo_gen = sess.opts.cg.profile_generate.clone();
427+
modules_config.pgo_use = sess.opts.cg.profile_use.clone();
428428

429429
modules_config.opt_level = Some(sess.opts.optimize);
430430
modules_config.opt_size = Some(sess.opts.optimize);

‎src/librustc_metadata/creader.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -868,7 +868,7 @@ impl<'a> CrateLoader<'a> {
868868

869869
fn inject_profiler_runtime(&mut self) {
870870
if self.sess.opts.debugging_opts.profile ||
871-
self.sess.opts.debugging_opts.pgo_gen.enabled()
871+
self.sess.opts.cg.profile_generate.enabled()
872872
{
873873
info!("loading profiler");
874874

‎src/test/codegen/pgo-instrumentation.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
// Test that `-Zpgo-gen` creates expected instrumentation artifacts in LLVM IR.
1+
// Test that `-Cprofile-generate` creates expected instrumentation artifacts in LLVM IR.
22
// Compiling with `-Cpanic=abort` because PGO+unwinding isn't supported on all platforms.
33

44
// needs-profiler-support
5-
// compile-flags: -Z pgo-gen -Ccodegen-units=1 -Cpanic=abort
5+
// compile-flags: -Cprofile-generate -Ccodegen-units=1 -Cpanic=abort
66

77
// CHECK: @__llvm_profile_raw_version =
88
// CHECK: @__profc_{{.*}}pgo_instrumentation{{.*}}some_function{{.*}} = private global

‎src/test/run-make-fulldeps/cross-lang-lto-pgo-smoketest/Makefile

+4-4
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ all: cpp-executable rust-executable
2121

2222
cpp-executable:
2323
$(RUSTC) -Clinker-plugin-lto=on \
24-
-Zpgo-gen="$(TMPDIR)"/cpp-profdata \
24+
-Cprofile-generate="$(TMPDIR)"/cpp-profdata \
2525
-o "$(TMPDIR)"/librustlib-xlto.a \
2626
$(COMMON_FLAGS) \
2727
./rustlib.rs
@@ -39,7 +39,7 @@ cpp-executable:
3939
-o "$(TMPDIR)"/cpp-profdata/merged.profdata \
4040
"$(TMPDIR)"/cpp-profdata/default_*.profraw
4141
$(RUSTC) -Clinker-plugin-lto=on \
42-
-Zpgo-use="$(TMPDIR)"/cpp-profdata/merged.profdata \
42+
-Cprofile-use="$(TMPDIR)"/cpp-profdata/merged.profdata \
4343
-o "$(TMPDIR)"/librustlib-xlto.a \
4444
$(COMMON_FLAGS) \
4545
./rustlib.rs
@@ -57,7 +57,7 @@ rust-executable:
5757
$(CLANG) ./clib.c -fprofile-generate="$(TMPDIR)"/rs-profdata -flto=thin -c -o $(TMPDIR)/clib.o -O3
5858
(cd $(TMPDIR); $(AR) crus ./libxyz.a ./clib.o)
5959
$(RUSTC) -Clinker-plugin-lto=on \
60-
-Zpgo-gen="$(TMPDIR)"/rs-profdata \
60+
-Cprofile-generate="$(TMPDIR)"/rs-profdata \
6161
-L$(TMPDIR) \
6262
$(COMMON_FLAGS) \
6363
-Clinker=$(CLANG) \
@@ -78,7 +78,7 @@ rust-executable:
7878
rm "$(TMPDIR)"/libxyz.a
7979
(cd $(TMPDIR); $(AR) crus ./libxyz.a ./clib.o)
8080
$(RUSTC) -Clinker-plugin-lto=on \
81-
-Zpgo-use="$(TMPDIR)"/rs-profdata/merged.profdata \
81+
-Cprofile-use="$(TMPDIR)"/rs-profdata/merged.profdata \
8282
-L$(TMPDIR) \
8383
$(COMMON_FLAGS) \
8484
-Clinker=$(CLANG) \

‎src/test/run-make-fulldeps/pgo-gen-lto/Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
-include ../tools.mk
44

5-
COMPILE_FLAGS=-Copt-level=3 -Clto=fat -Z pgo-gen="$(TMPDIR)"
5+
COMPILE_FLAGS=-Copt-level=3 -Clto=fat -Cprofile-generate="$(TMPDIR)"
66

77
# LLVM doesn't yet support instrumenting binaries that use unwinding on MSVC:
88
# https://github.com/rust-lang/rust/issues/61002

‎src/test/run-make-fulldeps/pgo-gen-no-imp-symbols/Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
-include ../tools.mk
44

5-
COMPILE_FLAGS=-O -Ccodegen-units=1 -Z pgo-gen="$(TMPDIR)"
5+
COMPILE_FLAGS=-O -Ccodegen-units=1 -Cprofile-generate="$(TMPDIR)"
66

77
# LLVM doesn't yet support instrumenting binaries that use unwinding on MSVC:
88
# https://github.com/rust-lang/rust/issues/61002

‎src/test/run-make-fulldeps/pgo-gen/Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
-include ../tools.mk
44

5-
COMPILE_FLAGS=-g -Z pgo-gen="$(TMPDIR)"
5+
COMPILE_FLAGS=-g -Cprofile-generate="$(TMPDIR)"
66

77
# LLVM doesn't yet support instrumenting binaries that use unwinding on MSVC:
88
# https://github.com/rust-lang/rust/issues/61002

‎src/test/run-make-fulldeps/pgo-use/Makefile

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ endif
3333

3434
all:
3535
# Compile the test program with instrumentation
36-
$(RUSTC) $(COMMON_FLAGS) -Z pgo-gen="$(TMPDIR)" main.rs
36+
$(RUSTC) $(COMMON_FLAGS) -Cprofile-generate="$(TMPDIR)" main.rs
3737
# Run it in order to generate some profiling data
3838
$(call RUN,main some-argument) || exit 1
3939
# Postprocess the profiling data so it can be used by the compiler
4040
"$(LLVM_BIN_DIR)"/llvm-profdata merge \
4141
-o "$(TMPDIR)"/merged.profdata \
4242
"$(TMPDIR)"/default_*.profraw
4343
# Compile the test program again, making use of the profiling data
44-
$(RUSTC) $(COMMON_FLAGS) -Z pgo-use="$(TMPDIR)"/merged.profdata --emit=llvm-ir main.rs
44+
$(RUSTC) $(COMMON_FLAGS) -Cprofile-use="$(TMPDIR)"/merged.profdata --emit=llvm-ir main.rs
4545
# Check that the generate IR contains some things that we expect
4646
#
4747
# We feed the file into LLVM FileCheck tool *in reverse* so that we see the

0 commit comments

Comments
 (0)