[ObjC][ARC] Share bundle handling code between steps of the ObjCARCOpts pass and cleanup (NFC)

[sgraenitz]

Summary

Generalize and share code for operand bundle handling. Drop the anonymous namespace (all other helper functions are local static). Rename the existing funclet test for cleanup-pads.

[compnerd]

The way that this renders in phabricator is terrible. It took a while to figure out the actual code sharing and how this works. This actually makes sense to do though at the end of that. Thanks!

[sgraenitz]

Rebase for changes in D137944

llvm/lib/Transforms/ObjCARC/ObjCARCOpts.cpp

bool PerformCodePlacement(DenseMap<const BasicBlock *, BBState> &BBStates,
                             DenseMap<Value *, RRInfo> &Releases, Module *M);
 
   void OptimizeWeakCalls(Function &F);
 
   bool OptimizeSequences(Function &F);
 
   void OptimizeReturns(Function &F);
 
-  Instruction *cloneCallInstForBB(CallInst &CI, BasicBlock &BB) {
-    SmallVector<OperandBundleDef, 1> OpBundles;
-    for (unsigned I = 0, E = CI.getNumOperandBundles(); I != E; ++I) {
-      auto Bundle = CI.getOperandBundleAt(I);
-      // Funclets will be reassociated in the future.
-      if (Bundle.getTagID() == LLVMContext::OB_funclet)
-        continue;
-      OpBundles.emplace_back(Bundle);
-    }
-
-    if (!BlockEHColors.empty()) {
-      const ColorVector &CV = BlockEHColors.find(&BB)->second;
-      assert(CV.size() > 0 && "non-unique color for block!");
-      Instruction *EHPad = CV.front()->getFirstNonPHI();
-      if (EHPad->isEHPad())
-        OpBundles.emplace_back("funclet", EHPad);
+  template <typename PredicateT>
+  static void cloneOpBundlesIf(CallBase *CI,
+                               SmallVectorImpl<OperandBundleDef> &OpBundles,
+                               PredicateT Predicate) {
+    for (unsigned I = 0, E = CI->getNumOperandBundles(); I != E; ++I) {
+      OperandBundleUse B = CI->getOperandBundleAt(I);
+      if (Predicate(B))
+        OpBundles.emplace_back(B);
     }
-
-    return CallInst::Create(&CI, OpBundles);
   }
 
   void addOpBundleForFunclet(BasicBlock *BB,
                              SmallVectorImpl<OperandBundleDef> &OpBundles) {
     if (!BlockEHColors.empty()) {
       const ColorVector &CV = BlockEHColors.find(BB)->second;
       assert(CV.size() > 0 && "Uncolored block");
       for (BasicBlock *EHPadBB : CV)
do {
     CallInst *CInst = cast<CallInst>(Inst);
     Type *ParamTy = CInst->getArgOperand(0)->getType();
     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
       Value *Incoming = GetRCIdentityRoot(PN->getIncomingValue(i));
       if (IsNullOrUndef(Incoming))
         continue;
       Value *Op = PN->getIncomingValue(i);
       Instruction *InsertPos = &PN->getIncomingBlock(i)->back();
-      CallInst *Clone =
-          cast<CallInst>(cloneCallInstForBB(*CInst, *InsertPos->getParent()));
+      SmallVector<OperandBundleDef, 1> OpBundles;
+      cloneOpBundlesIf(CInst, OpBundles, [](const OperandBundleUse &B) {
+        return B.getTagID() != LLVMContext::OB_funclet;
+      });
+      addOpBundleForFunclet(InsertPos->getParent(), OpBundles);
+      CallInst *Clone = CallInst::Create(CInst, OpBundles);
       if (Op->getType() != ParamTy)
         Op = new BitCastInst(Op, ParamTy, "", InsertPos);
       Clone->setArgOperand(0, Op);
       Clone->insertBefore(InsertPos);
 
       LLVM_DEBUG(dbgs() << "Cloning " << *CInst << "\n"
                                                    "And inserting clone at "
                         << *InsertPos << "\n");

llvm/test/Transforms/ObjCARC/funclet-cleanuppad.ll

 ; RUN: opt -mtriple x86_64-unknown-windows-msvc -passes=objc-arc -S -o - %s | FileCheck %s
 
 ; bool g();
 ; id h();
 ;
 ; void f() {
 ;   id a = nullptr;
 ;   if (g())
 ;     a = h();
 ;   id b = nullptr;
 ;   g();
 ; }
 
 declare zeroext i1 @"\01?g@@YA_NXZ"() local_unnamed_addr
 declare i8* @"\01?h@@YAPEAUobjc_object@@XZ"() local_unnamed_addr
 
 declare dllimport void @llvm.objc.release(i8*) local_unnamed_addr
 declare dllimport i8* @llvm.objc.retainAutoreleasedReturnValue(i8* returned) local_unnamed_addr
 
 declare i32 @__CxxFrameHandler3(...)
 
 define void @"\01?f@@YAXXZ"() local_unnamed_addr personality i8* bitcast (i32 (...)* @__CxxFrameHandler3 to i8*) {
 entry:
   %call = invoke zeroext i1 @"\01?g@@YA_NXZ"()
           to label %invoke.cont unwind label %ehcleanup6
 
 invoke.cont:                                      ; preds = %entry
   br i1 %call, label %if.then, label %if.end
 
 if.then:                                          ; preds = %invoke.cont
   %call2 = invoke i8* @"\01?h@@YAPEAUobjc_object@@XZ"()
           to label %invoke.cont1 unwind label %ehcleanup6
 
 invoke.cont1:                                     ; preds = %if.then
   %0 = tail call i8* @llvm.objc.retainAutoreleasedReturnValue(i8* %call2)
   tail call void @llvm.objc.release(i8* null), !clang.imprecise_release !1
   br label %if.end
 
 if.end:                                           ; preds = %invoke.cont1, %invoke.cont
   %a.0 = phi i8* [ %call2, %invoke.cont1 ], [ null, %invoke.cont ]
   %call4 = invoke zeroext i1 @"\01?g@@YA_NXZ"()
           to label %invoke.cont3 unwind label %ehcleanup
 
 invoke.cont3:                                     ; preds = %if.end
   tail call void @llvm.objc.release(i8* null), !clang.imprecise_release !1
   tail call void @llvm.objc.release(i8* %a.0), !clang.imprecise_release !1
   ret void
 
 ehcleanup:                                        ; preds = %if.end
   %1 = cleanuppad within none []
   call void @llvm.objc.release(i8* null) [ "funclet"(token %1) ], !clang.imprecise_release !1
   cleanupret from %1 unwind label %ehcleanup6
 
 ehcleanup6:                                       ; preds = %ehcleanup, %if.then, %entry
   %a.1 = phi i8* [ %a.0, %ehcleanup ], [ null, %if.then ], [ null, %entry ]
   %2 = cleanuppad within none []
   call void @llvm.objc.release(i8* %a.1) [ "funclet"(token %2) ], !clang.imprecise_release !1
   cleanupret from %2 unwind to caller
 }
 
 ; CHECK-LABEL: ?f@@YAXXZ
 ; CHECK: call void @llvm.objc.release(i8* {{.*}}) {{.*}}[ "funclet"(token %1) ]
 ; CHECK-NOT: call void @llvm.objc.release(i8* {{.*}}) {{.*}}[ "funclet"(token %2) ]
 
 define void @"\01?i@@YAXXZ"() local_unnamed_addr personality i8* bitcast (i32 (...)* @__CxxFrameHandler3 to i8*) {
 entry:
   %call = invoke zeroext i1 @"\01?g@@YA_NXZ"()
           to label %invoke.cont unwind label %ehcleanup6
 
 invoke.cont:                                      ; preds = %entry
   br i1 %call, label %if.then, label %if.end
 
 if.then:                                          ; preds = %invoke.cont
   %call2 = invoke i8* @"\01?h@@YAPEAUobjc_object@@XZ"()
           to label %invoke.cont1 unwind label %ehcleanup6
 
 invoke.cont1:                                     ; preds = %if.then
   %0 = tail call i8* @llvm.objc.retainAutoreleasedReturnValue(i8* %call2)
   tail call void @llvm.objc.release(i8* null), !clang.imprecise_release !1
   br label %if.end
 
 if.end:                                           ; preds = %invoke.cont1, %invoke.cont
   %a.0 = phi i8* [ %call2, %invoke.cont1 ], [ null, %invoke.cont ]
   %call4 = invoke zeroext i1 @"\01?g@@YA_NXZ"()
           to label %invoke.cont3 unwind label %ehcleanup
 
 invoke.cont3:                                     ; preds = %if.end
   tail call void @llvm.objc.release(i8* null), !clang.imprecise_release !1
   tail call void @llvm.objc.release(i8* %a.0), !clang.imprecise_release !1
   ret void
 
 ehcleanup:                                        ; preds = %if.end
   %1 = cleanuppad within none []
   call void @llvm.objc.release(i8* null) [ "funclet"(token %1) ], !clang.imprecise_release !1
   br label %ehcleanup.1
 
 ehcleanup.1:
   cleanupret from %1 unwind label %ehcleanup6
 
 ehcleanup6:                                       ; preds = %ehcleanup, %if.then, %entry
   %a.1 = phi i8* [ %a.0, %ehcleanup.1 ], [ null, %if.then ], [ null, %entry ]
   %2 = cleanuppad within none []
   call void @llvm.objc.release(i8* %a.1) [ "funclet"(token %2) ], !clang.imprecise_release !1
   cleanupret from %2 unwind to caller
 }
 
 ; CHECK-LABEL: ?i@@YAXXZ
 ; CHECK: call void @llvm.objc.release(i8* {{.*}}) {{.*}}[ "funclet"(token %1) ]
 ; CHECK-NOT: call void @llvm.objc.release(i8* {{.*}}) {{.*}}[ "funclet"(token %2) ]
 
 !1 = !{}