[llvm] d6aed77 - [InstrProfiling] No runtime hook for unused funcs

[Gulfem Savrun Yeniceri via llvm-commits]

Author: Gulfem Savrun Yeniceri
Date: 2022-09-16T02:05:09Z
New Revision: d6aed77f0d19664be48d531552692520ae2a6f1a

URL: https://github.com/llvm/llvm-project/commit/d6aed77f0d19664be48d531552692520ae2a6f1a
DIFF: https://github.com/llvm/llvm-project/commit/d6aed77f0d19664be48d531552692520ae2a6f1a.diff

LOG: [InstrProfiling] No runtime hook for unused funcs

This is a reland of https://reviews.llvm.org/D122336.
Original patch caused a problem in collecting coverage in
Fuchsia because it was returning early without putting unused
function names into __llvm_prf_names section. This patch
fixes that issue.

The original commit message is as the following:
CoverageMappingModuleGen generates a coverage mapping record
even for unused functions with internal linkage, e.g.
static int foo() { return 100; }
Clang frontend eliminates such functions, but InstrProfiling pass
still emits runtime hook since there is a coverage record.
Fuchsia uses runtime counter relocation, and pulling in profile
runtime for unused functions causes a linker error:
undefined hidden symbol: __llvm_profile_counter_bias.
Since https://reviews.llvm.org/D98061, we do not hook profile
runtime for the binaries that none of its translation units
have been instrumented in Fuchsia. This patch extends that for
the instrumented binaries that consist of only unused functions.

Reviewed By: phosek

Differential Revision: https://reviews.llvm.org/D122336

Added: 
    clang/test/CoverageMapping/unused_function_no_runtime_hook.cpp

Modified: 
    llvm/lib/Transforms/Instrumentation/InstrProfiling.cpp

Removed: 
    


################################################################################
diff  --git a/clang/test/CoverageMapping/unused_function_no_runtime_hook.cpp b/clang/test/CoverageMapping/unused_function_no_runtime_hook.cpp
new file mode 100644
index 000000000000..5a835ae31169
--- /dev/null
+++ b/clang/test/CoverageMapping/unused_function_no_runtime_hook.cpp
@@ -0,0 +1,6 @@
+// RUN: %clang -target x86_64-unknown-fuchsia -fprofile-instr-generate -fcoverage-mapping -emit-llvm -S %s -o - | FileCheck %s
+
+// CHECK-NOT: @__llvm_profile_runtime
+static int f0() {
+  return 100;
+}

diff  --git a/llvm/lib/Transforms/Instrumentation/InstrProfiling.cpp b/llvm/lib/Transforms/Instrumentation/InstrProfiling.cpp
index 64043151a830..ce9972888e89 100644
--- a/llvm/lib/Transforms/Instrumentation/InstrProfiling.cpp
+++ b/llvm/lib/Transforms/Instrumentation/InstrProfiling.cpp
@@ -525,9 +525,8 @@ bool InstrProfiling::run(
   TT = Triple(M.getTargetTriple());
 
   bool MadeChange = false;
-
-  // Emit the runtime hook even if no counters are present.
-  if (needsRuntimeHookUnconditionally(TT))
+  bool NeedsRuntimeHook = needsRuntimeHookUnconditionally(TT);
+  if (NeedsRuntimeHook)
     MadeChange = emitRuntimeHook();
 
   // Improve compile time by avoiding linear scans when there is no work.
@@ -567,7 +566,14 @@ bool InstrProfiling::run(
 
   emitVNodes();
   emitNameData();
-  emitRuntimeHook();
+
+  // Emit runtime hook except for the cases where coverage is enabled on
+  // code that is eliminated by the front-end, e.g. unused functions with
+  // internal linkage, and the target does not require pulling in profile
+  // runtime.
+  if (containsProfilingIntrinsics(M) || !CoverageNamesVar || NeedsRuntimeHook)
+    emitRuntimeHook();
+
   emitRegistration();
   emitUses();
   emitInitialization();