summaryrefslogtreecommitdiffstats
path: root/tests/run-make/pgo-use/Makefile
diff options
context:
space:
mode:
Diffstat (limited to 'tests/run-make/pgo-use/Makefile')
-rw-r--r--tests/run-make/pgo-use/Makefile46
1 files changed, 46 insertions, 0 deletions
diff --git a/tests/run-make/pgo-use/Makefile b/tests/run-make/pgo-use/Makefile
new file mode 100644
index 000000000..3bac9b77a
--- /dev/null
+++ b/tests/run-make/pgo-use/Makefile
@@ -0,0 +1,46 @@
+# needs-profiler-support
+# ignore-windows-gnu
+
+# FIXME(mati865): MinGW GCC miscompiles compiler-rt profiling library but with Clang it works
+# properly. Since we only have GCC on the CI ignore the test for now.
+
+include ../tools.mk
+
+# This test makes sure that PGO profiling data leads to cold functions being
+# marked as `cold` and hot functions with `inlinehint`.
+# The test program contains an `if` were actual execution only ever takes the
+# `else` branch. Accordingly, we expect the function that is never called to
+# be marked as cold.
+#
+# Disable the pre-inlining pass (i.e. a pass that does some inlining before
+# it adds the profiling instrumentation). Disabling this pass leads to
+# rather predictable IR which we need for this test to be stable.
+
+COMMON_FLAGS=-Copt-level=2 -Ccodegen-units=1 -Cllvm-args=-disable-preinline
+
+ifeq ($(UNAME),Darwin)
+# macOS does not have the `tac` command, but `tail -r` does the same thing
+TAC := tail -r
+else
+# some other platforms don't support the `-r` flag for `tail`, so use `tac`
+TAC := tac
+endif
+
+all:
+ # Compile the test program with instrumentation
+ $(RUSTC) $(COMMON_FLAGS) -Cprofile-generate="$(TMPDIR)" main.rs
+ # Run it in order to generate some profiling data
+ $(call RUN,main some-argument) || exit 1
+ # Postprocess the profiling data so it can be used by the compiler
+ "$(LLVM_BIN_DIR)"/llvm-profdata merge \
+ -o "$(TMPDIR)"/merged.profdata \
+ "$(TMPDIR)"/default_*.profraw
+ # Compile the test program again, making use of the profiling data
+ $(RUSTC) $(COMMON_FLAGS) -Cprofile-use="$(TMPDIR)"/merged.profdata --emit=llvm-ir main.rs
+ # Check that the generate IR contains some things that we expect
+ #
+ # We feed the file into LLVM FileCheck tool *in reverse* so that we see the
+ # line with the function name before the line with the function attributes.
+ # FileCheck only supports checking that something matches on the next line,
+ # but not if something matches on the previous line.
+ $(TAC) "$(TMPDIR)"/main.ll | "$(LLVM_FILECHECK)" filecheck-patterns.txt