[InstrProf] Mark counters as used in debug correlation mode

[ellis]

Summary

In debug info correlation mode we do not emit the data globals so we
need to explicitly mark the counter globals as used so they don't get
stripped.

[kyulee]

My understanding is that the counter symbol is referenced by a text/code. So it's naturally retained as long as the function is kept.
Is there any specific case this needs to be explicitly used?

[ellis]

In D115981#3201096, @kyulee wrote:

My understanding is that the counter symbol is referenced by a text/code. So it's naturally retained as long as the function is kept.
Is there any specific case this needs to be explicitly used?

Ah thank you. I've since ran some experiments and found that after https://reviews.llvm.org/D116051 the number of profiled functions is about what we expect without this patch. However, I'm working on another patch that only profiles function entry coverage and this code change is needed in that case. I'll do more investigation and follow up here.

[ellis]

This patch was absorbed into https://reviews.llvm.org/D116180

[ellis]

After further investigation we realized this patch is needed even for the normal block count case. Currently, it seems the optimizer does not remove globals when they are incremented because it requires a read and a write. In theory this optimization is safe so we should explicitly mark these globals as used.

[ellis]

Rebase.

[kyulee]

LGTM

llvm/lib/Transforms/Instrumentation/InstrProfiling.cpp

if (NS > 0 && ValueProfileStaticAlloc &&
     ValuesVar->setSection(
         getInstrProfSectionName(IPSK_vals, TT.getObjectFormat()));
     ValuesVar->setAlignment(Align(8));
     MaybeSetComdat(ValuesVar);
     ValuesPtrExpr =
         ConstantExpr::getBitCast(ValuesVar, Type::getInt8PtrTy(Ctx));
   }
 
-  if (DebugInfoCorrelate)
+  if (DebugInfoCorrelate) {
+    // Mark the counter variable as used so that it isn't stripped out.
+    CompilerUsedVars.push_back(PD.RegionCounters);
     return PD.RegionCounters;
+  }
 
   // Create data variable.
   auto *IntPtrTy = M->getDataLayout().getIntPtrType(M->getContext());
   auto *Int16Ty = Type::getInt16Ty(Ctx);
   auto *Int16ArrayTy = ArrayType::get(Int16Ty, IPVK_Last + 1);
   Type *DataTypes[] = {
 #define INSTR_PROF_DATA(Type, LLVMType, Name, Init) LLVMType,
 #include "llvm/ProfileData/InstrProfData.inc"