[PartialInlining] Add Optimization Remark Support

[davidxl]

Summary

Add includes a small NFC change (to use hasAddressTaken).

[davide]

lib/Transforms/IPO/PartialInlining.cpp

32 ↗

(On Diff #96271)

Any reason to change the DEBUG_TYPE ?

70–72 ↗

(On Diff #96271)

Feel free to commit this separately now (before the review)

[davidxl]

lib/Transforms/IPO/PartialInlining.cpp

32 ↗

(On Diff #96271)

This is used in -Rpass=<pass_name> for consistency. 'partialinlining' does not look like a friendly name to use.

[davidxl]

Rebase.

[davide]

It looks like you're missing the PM glue for requiring the analysis.
AU.addRequired<OptimizationRemarkEmitterWrapperPass>();, et similia (slightly annoying as we have to do that twice for the current and the future pass manager).

[hfinkel]

lib/Transforms/IPO/PartialInlining.cpp

32 ↗

(On Diff #96290)

Please use partial-inlining (we almost always use dashes, not underscores, in these names).

[davidxl]

The way it is used, it does not require any analysis pass (on demand ).

[davidxl]

Use dash instead of underscore.

[davide]

LGTM

llvm/trunk/lib/Transforms/IPO/PartialInlining.cpp

 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm/Transforms/IPO/PartialInlining.h"
 #include "llvm/ADT/Statistic.h"
 #include "llvm/Analysis/BlockFrequencyInfo.h"
 #include "llvm/Analysis/BranchProbabilityInfo.h"
 #include "llvm/Analysis/LoopInfo.h"
+#include "llvm/Analysis/OptimizationDiagnosticInfo.h"
 #include "llvm/IR/CFG.h"
+#include "llvm/IR/DiagnosticInfo.h"
 #include "llvm/IR/Dominators.h"
 #include "llvm/IR/Instructions.h"
 #include "llvm/IR/Module.h"
 #include "llvm/Pass.h"
 #include "llvm/Transforms/IPO.h"
 #include "llvm/Transforms/Utils/Cloning.h"
 #include "llvm/Transforms/Utils/CodeExtractor.h"
 using namespace llvm;
 
-#define DEBUG_TYPE "partialinlining"
+#define DEBUG_TYPE "partial-inlining"
 
 STATISTIC(NumPartialInlined, "Number of functions partially inlined");
 
 namespace {
 struct PartialInlinerImpl {
   PartialInlinerImpl(InlineFunctionInfo IFI) : IFI(std::move(IFI)) {}
   bool run(Module &M);
   Function *unswitchFunction(Function *F);
Function *PartialInlinerImpl::unswitchFunction(Function *F) {
   // Extract the body of the if.
   Function *ExtractedFunction =
       CodeExtractor(ToExtract, &DT, /*AggregateArgs*/ false, &BFI, &BPI)
           .extractCodeRegion();
 
   // Inline the top-level if test into all callers.
   std::vector<User *> Users(DuplicateFunction->user_begin(),
                             DuplicateFunction->user_end());
-  for (User *User : Users)
+
+  for (User *User : Users) {
+    CallSite CS;
     if (CallInst *CI = dyn_cast<CallInst>(User))
-      InlineFunction(CI, IFI);
+      CS = CallSite(CI);
     else if (InvokeInst *II = dyn_cast<InvokeInst>(User))
-      InlineFunction(II, IFI);
+      CS = CallSite(II);
+    else
+      llvm_unreachable("All uses must be calls");
+
+    OptimizationRemarkEmitter ORE(CS.getCaller());
+    DebugLoc DLoc = CS.getInstruction()->getDebugLoc();
+    BasicBlock *Block = CS.getParent();
+    ORE.emit(OptimizationRemark(DEBUG_TYPE, "PartiallyInlined", DLoc, Block)
+             << ore::NV("Callee", F) << " partially inlined into "
+             << ore::NV("Caller", CS.getCaller()));
+
+    InlineFunction(CS, IFI);
+  }
 
   // Ditch the duplicate, since we're done with it, and rewrite all remaining
   // users (function pointers, etc.) back to the original function.
   DuplicateFunction->replaceAllUsesWith(F);
   DuplicateFunction->eraseFromParent();
 
   ++NumPartialInlined;