Skip to content
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

Migrate cross-lang-lto-clang and cross-lang-lto-pgo-smoketest run-make tests to rmake #128356

Merged
merged 3 commits into from
Aug 3, 2024
Merged
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: 3 additions & 2 deletions src/tools/run-make-support/src/external_deps/clang.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use std::path::Path;

use crate::command::Command;
use crate::{bin_name, env_var};
use crate::{bin_name, cwd, env_var};

/// Construct a new `clang` invocation. `clang` is not always available for all targets.
#[track_caller]
Expand All @@ -23,7 +23,8 @@ impl Clang {
#[track_caller]
pub fn new() -> Self {
let clang = env_var("CLANG");
let cmd = Command::new(clang);
let mut cmd = Command::new(clang);
cmd.arg("-L").arg(cwd());
Self { cmd }
}

Expand Down
6 changes: 6 additions & 0 deletions src/tools/run-make-support/src/external_deps/llvm.rs
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,12 @@ impl LlvmObjdump {
self.cmd.arg(path.as_ref());
self
}

/// Disassemble all executable sections found in the input files.
pub fn disassemble(&mut self) -> &mut Self {
self.cmd.arg("-d");
self
}
}

impl LlvmAr {
Expand Down
2 changes: 0 additions & 2 deletions src/tools/tidy/src/allowed_run_make_makefiles.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
run-make/branch-protection-check-IBT/Makefile
run-make/cat-and-grep-sanity-check/Makefile
run-make/cdylib-dylib-linkage/Makefile
run-make/cross-lang-lto-clang/Makefile
run-make/cross-lang-lto-pgo-smoketest/Makefile
run-make/cross-lang-lto-upstream-rlibs/Makefile
run-make/dep-info-doesnt-run-much/Makefile
run-make/dep-info-spaces/Makefile
Expand Down
25 changes: 0 additions & 25 deletions tests/run-make/cross-lang-lto-clang/Makefile

This file was deleted.

62 changes: 62 additions & 0 deletions tests/run-make/cross-lang-lto-clang/rmake.rs
Oneirical marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
// This test checks that cross-language inlining actually works by checking
// the generated machine code.
// See https://github.com/rust-lang/rust/pull/57514

//@ needs-force-clang-based-tests
// NOTE(#126180): This test only runs on `x86_64-gnu-debug`, because that CI job sets
// RUSTBUILD_FORCE_CLANG_BASED_TESTS and only runs tests which contain "clang" in their
// name.

use run_make_support::{clang, env_var, llvm_ar, llvm_objdump, rustc, static_lib_name};

fn main() {
rustc()
.linker_plugin_lto("on")
.output(static_lib_name("rustlib-xlto"))
.opt_level("2")
.codegen_units(1)
.input("rustlib.rs")
.run();
clang()
.lto("thin")
.use_ld("lld")
.arg("-lrustlib-xlto")
.out_exe("cmain")
.input("cmain.c")
.arg("-O3")
.run();
// Make sure we don't find a call instruction to the function we expect to
// always be inlined.
llvm_objdump()
.disassemble()
.input("cmain")
.run()
.assert_stdout_not_contains_regex("call.*rust_always_inlined");
// As a sanity check, make sure we do find a call instruction to a
// non-inlined function
llvm_objdump()
.disassemble()
.input("cmain")
.run()
.assert_stdout_contains_regex("call.*rust_never_inlined");
clang().input("clib.c").lto("thin").arg("-c").out_exe("clib.o").arg("-O2").run();
llvm_ar().obj_to_ar().output_input(static_lib_name("xyz"), "clib.o").run();
rustc()
.linker_plugin_lto("on")
.opt_level("2")
.linker(&env_var("CLANG"))
.link_arg("-fuse-ld=lld")
.input("main.rs")
.output("rsmain")
.run();
llvm_objdump()
.disassemble()
.input("rsmain")
.run()
.assert_stdout_not_contains_regex("call.*c_always_inlined");
llvm_objdump()
.disassemble()
.input("rsmain")
.run()
.assert_stdout_contains_regex("call.*c_never_inlined");
}
120 changes: 120 additions & 0 deletions tests/run-make/cross-lang-lto-pgo-smoketest-clang/rmake.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
// This test makes sure that cross-language inlining can be used in conjunction
// with profile-guided optimization. The test only tests that the whole workflow
// can be executed without anything crashing. It does not test whether PGO or
// xLTO have any specific effect on the generated code.
// See https://github.com/rust-lang/rust/pull/61036

//@ needs-force-clang-based-tests
// NOTE(#126180): This test would only run on `x86_64-gnu-debug`, because that CI job sets
// RUSTBUILD_FORCE_CLANG_BASED_TESTS and only runs tests which contain "clang" in their
// name.

//@ needs-profiler-support
// FIXME(Oneirical): Except that due to the reliance on llvm-profdata, this test
// never runs, because `x86_64-gnu-debug` does not have the `profiler_builtins` crate.

//FIXME(Oneirical): There was a strange workaround for MSVC on this test
// which added -C panic=abort to every RUSTC call. It was justified as follows:

// "LLVM doesn't support instrumenting binaries that use SEH:
// https://bugs.llvm.org/show_bug.cgi?id=41279
// Things work fine with -Cpanic=abort though."

// This isn't very pertinent, however, as the test does not get run on any
// MSVC platforms.

use run_make_support::{
clang, env_var, has_extension, has_prefix, llvm_ar, llvm_profdata, rfs, run, rustc,
shallow_find_files, static_lib_name,
};

fn main() {
rustc()
.linker_plugin_lto("on")
.output(static_lib_name("rustlib-xlto"))
.opt_level("3")
.codegen_units(1)
.input("rustlib.rs")
.arg("-Cprofile-generate=cpp-profdata")
.run();
clang()
.lto("thin")
.arg("-fprofile-generate=cpp-profdata")
.use_ld("lld")
.arg("-lrustlib-xlto")
.out_exe("cmain")
.input("cmain.c")
.arg("-O3")
.run();
run("cmain");
// Postprocess the profiling data so it can be used by the compiler
let profraw_files = shallow_find_files("cpp-profdata", |path| {
has_prefix(path, "default") && has_extension(path, "profraw")
});
let profraw_file = profraw_files.get(0).unwrap();
llvm_profdata().merge().output("cpp-profdata/merged.profdata").input(profraw_file).run();
rustc()
.linker_plugin_lto("on")
.profile_use("cpp-profdata/merged.profdata")
.output(static_lib_name("rustlib-xlto"))
.opt_level("3")
.codegen_units(1)
.input("rustlib.rs")
.run();
clang()
.lto("thin")
.arg("-fprofile-use=cpp-profdata/merged.profdata")
.use_ld("lld")
.arg("-lrustlib-xlto")
.out_exe("cmain")
.input("cmain.c")
.arg("-O3")
.run();

clang()
.input("clib.c")
.arg("-fprofile-generate=rs-profdata")
.lto("thin")
.arg("-c")
.out_exe("clib.o")
.arg("-O3")
.run();
llvm_ar().obj_to_ar().output_input(static_lib_name("xyz"), "clib.o").run();
rustc()
.linker_plugin_lto("on")
.opt_level("3")
.codegen_units(1)
.arg("-Cprofile-generate=rs-profdata")
.linker(&env_var("CLANG"))
.link_arg("-fuse-ld=lld")
.input("main.rs")
.output("rsmain")
.run();
run("rsmain");
// Postprocess the profiling data so it can be used by the compiler
let profraw_files = shallow_find_files("rs-profdata", |path| {
has_prefix(path, "default") && has_extension(path, "profraw")
});
let profraw_file = profraw_files.get(0).unwrap();
llvm_profdata().merge().output("rs-profdata/merged.profdata").input(profraw_file).run();
clang()
.input("clib.c")
.arg("-fprofile-use=rs-profdata/merged.profdata")
.arg("-c")
.lto("thin")
.out_exe("clib.o")
.arg("-O3")
.run();
rfs::remove_file(static_lib_name("xyz"));
llvm_ar().obj_to_ar().output_input(static_lib_name("xyz"), "clib.o").run();
rustc()
.linker_plugin_lto("on")
.opt_level("3")
.codegen_units(1)
.arg("-Cprofile-use=rs-profdata/merged.profdata")
.linker(&env_var("CLANG"))
.link_arg("-fuse-ld=lld")
.input("main.rs")
.output("rsmain")
.run();
}
90 changes: 0 additions & 90 deletions tests/run-make/cross-lang-lto-pgo-smoketest/Makefile

This file was deleted.

7 changes: 5 additions & 2 deletions tests/run-make/cross-lang-lto-riscv-abi/rmake.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,11 @@
//@ needs-force-clang-based-tests
//@ needs-llvm-components riscv

// FIXME(#126180): This test doesn't actually run anywhere, because the only
// CI job that sets RUSTBUILD_FORCE_CLANG_BASED_TESTS runs very few tests.
//@ needs-force-clang-based-tests
// FIXME(#126180): This test can only run on `x86_64-gnu-debug`, because that CI job sets
// RUSTBUILD_FORCE_CLANG_BASED_TESTS and only runs tests which contain "clang" in their
// name.
// However, this test does not run at all as its name does not contain "clang".

use std::path::PathBuf;
use std::process::{Command, Output};
Expand Down
4 changes: 4 additions & 0 deletions tests/run-make/wasm-override-linker/rmake.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
// $ RUSTBUILD_FORCE_CLANG_BASED_TESTS=1 ./x.py test tests/run-make/wasm-override-linker/

//@ needs-force-clang-based-tests
// FIXME(#126180): This test can only run on `x86_64-gnu-debug`, because that CI job sets
// RUSTBUILD_FORCE_CLANG_BASED_TESTS and only runs tests which contain "clang" in their
// name.
// However, this test does not run at all as its name does not contain "clang".

use run_make_support::{env_var, rustc, target};

Expand Down
Loading