[PartialInl] Enhance partial inliner to handle more complex conditions

[davidxl]

Summary

This handles case :

if (a || b)

return;

// Large_body of slow path code
do_something here.

[eraman]

I've a couple of trivial comments so far. Could you please generate a diff with a larger context?

lib/Transforms/IPO/PartialInlining.cpp

40

The comments doesn't convey what the function is doing.

47

nit: change -> chain

50

Why is this named Entries_ and not Entries?

[davidxl]

Addressed review comments .

[davidxl]

lib/Transforms/IPO/PartialInlining.cpp

40

Fixed.

50

Fixed.

[wmi]

lib/Transforms/IPO/PartialInlining.cpp

40

nit: ghain --> chain

110–119

Here we add a limitation that the function only has one return BB to be a partial inline candidate. Is it required? Can we walk forward from entry instead of backward from the return block so as to avoid the requirement of finding single return BB?

159–167

Here we allows a node on the chain with more than two successors. Will such case bring us problem later during extracting?

test/Transforms/CodeExtractor/MultiConditions.ll

6

we can use opt -instnamer to rename the temporaries.

[davidxl]

lib/Transforms/IPO/PartialInlining.cpp

110–119

the restriction no it is not required. Changed as suggested.

(Note if the extracted region has other return instruction, extra code will be generated (to handle the return status in caller), so the call to the outlined function is slightly higher).

159–167

Changed the code to limit 2 successors. More than one successors can cause problems or lead to very inefficient outline call (to handle 'multiple entries').

[davidxl]

Addressed review comments. Added more test including multi return case.

[wmi]

I am thinking of another two issues:

1. Is it possible that some of the BBs on the chain may be very big and we don't want to partial inline them?
2. The existing pattern handles if (a || b || c ...) case, but it may not be easy to extend for cases like (a && b && c) and ((a && b) || c). Basically, we want to find a collection of bbs with small sizes starting from entry. The bb collection only have two exits. one of them is ReturnBlock and the other is NonReturnBlock. The edges inside of the collection can be of any pattern.

Sorry I didn't come up with them at the first beginning and dive into details.

[davidxl]

Is it possible that some of the BBs on the chain may be very big and we don't want to partial inline them?

Yes, i was thinking adding a limit on the chain length as an option. Probably do this a a follow up -- which also needs to look at profile data. (Note that Partialinlininer is currently not enabled in any optimization pipeline yet).

The existing pattern handles if (a || b || c ...) case, but it may not be easy to extend for cases like (a && b && c) and ((a && b) || c). Basically, we want to find a collection of bbs with small sizes starting from entry. The bb collection only have two exits. one of them is ReturnBlock and the other is NonReturnBlock. The edges inside of the collection can be of any pattern.

a&b&c case is already partially handled -- the partial inliner can partially peel the first iteration which may be good enough. However I do like your suggestion of computing the entry predicate region idea.

[eraman]

Yes, i was thinking adding a limit on the chain length as an option. Probably do this a a follow up -- which also needs to look at profile data. (Note that Partialinlininer is currently not enabled in any optimization pipeline yet).

I think instruction count will be better limit than chain length.

lib/Transforms/IPO/PartialInlining.cpp

193

This will look cleaner if this is made to while (CommonSucc) and peel the else part outside of the while loop (since you always break from there). Perhaps you can even peel the first iteration out of the loop: first find the candidate non-return block, then walk the chain in a loop as long as one successor equals non-return block and the other succesor has a single predecessor. Some more comments will also increase readability.

[davidxl]

Address review feedback. The new version now can handle more general conditions (see test cases).

[davide]

lib/Transforms/IPO/PartialInlining.cpp

36

typo, partially inlined. BTW, do you have numbers for different values of MaxNumInlineBlocks ?

49–51

SmallVector<> maybe

86–97

These could probably live in BasicBlockUtils.

100–105

Also this one. Please remove else after return

108–110

braces unneeded.

128–132

Can you add comments about why we break in this case? (i.e. we don't outline blocks without exactly two successors, etc...)

265–267

return BB == NewReturnBlock || NewEntries.count(BB) , maybe?

277

explicit type maybe?

284

explicit type maybe?

297–298

unrelated change, also braces are unneeded.

311

unrelated?

[davidxl]

lib/Transforms/IPO/PartialInlining.cpp

36

Currently it is set to a high number for stress testing purpose. When partial inliner is enabled in the pipeline, the default value needs to be tuned depending on opt level.

86–97

will leave it here for now.

100–105

removed else.

[davidxl]

addressed review comments.

[wmi]

Some minor comments.

lib/Transforms/IPO/PartialInlining.cpp

51

I find NonReturnBlockPreds has been set but not used.

102

we can change the else if to if.

129–130

should we use an assertion here instead of an early exit, so we can catch mistake instead of giving up silently.

272–275

ToBeInlined(NewNonReturnBlock) is also false, so can we just do:

for (BasicBlock &BB : *DuplicateFunction)
  if (!ToBeInlined(&BB))
    ToExtract.push_back(&BB);

[davidxl]

lib/Transforms/IPO/PartialInlining.cpp

51

Removed

129–130

No. This is designed in way such that the candidate found may be illegal (to simplify the code), so a check here is necessary.

272–275

NewNonReturnBlock needs to be the head of the blocks to be cloned. It is already pushed in, so the filter is needed.

[davidxl]

Address Wei's review feedback. Also fixed a bug found in clang self build test.

[wmi]

LGTM.

[eraman]

lib/Transforms/IPO/PartialInlining.cpp

35

Expressing this as instructions will make this somewhat similar to inlining cost.

113

Cleaner to do return std::make_tuple(Succ1, Succ2) here and the following if

149

No need to initialize it here since GetCommonSucc would return a (nullptr, nullptr) tuple if there is no triangle shape.

[davidxl]

lib/Transforms/IPO/PartialInlining.cpp

35

This will be done in a follow up patch before the final patch that turn it on.

[davidxl]

Address review comments.

[eraman]

lib/Transforms/IPO/PartialInlining.cpp

128

Some comment here will be useful. You want to keep space for 1 return block and the CurrEntry and that's why you've the above. I initially thought the condition was wrong.

147

The HasNonEntryPred lambda checks for the presence of preds in Entries (the DenseSet above), but you're not updating the Entries in this loop when you insert Cand into OutliningInfo->Entries. So this loop will return after 1 iteration right?

[davidxl]

lib/Transforms/IPO/PartialInlining.cpp

128

Fixed. Added a member function.

147

good catch.Fixed.

[davidxl]

Addressed review feedback by eraman.

[eraman]

LGTM.

Please add a comment to explain the condition for exiting the loop for exceeding MaxNumInlineBlocks.

lib/Transforms/IPO/PartialInlining.cpp

128

You should still add a comment in the member function about the +1 (the return block) and here (we still have a pending CurrEntry block).

[gyiu]

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

299 ↗

(On Diff #96932)

@davidxl Please correct me if I'm wrong, but in this loop, if the first instruction in the BB is not a PHINode we give up? If that's the case, then wouldn't 'Phi' be the first and only Phi we'll find?

[davidxl]

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

299 ↗

(On Diff #96932)

The method returns the first phi of the block if it exists. It should add this:

if (isa<DbgInfoIntrinsic>(I))

continue;

lib/Transforms/IPO/PartialInlining.cpp

 #include "llvm/Transforms/Utils/CodeExtractor.h"
 using namespace llvm;
 
 #define DEBUG_TYPE "partialinlining"
 
 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);
 
+  // Finds a chain of blocks (starting from function entry)
+  // that guards a return block. Returns the ReturnBlock and NonReturnBlock.
+  std::tuple<BasicBlock *, BasicBlock *> findEntryBlocks(Function *F);
+
 private:
+  // A chain of basic blocks starting from the function entry point.
+  // Except for the function entry block, each block in the chain
+  // has the previous block in the vector as its single predecessor and
+  // all the blocks in the chain have a common non return block
+  // as their successor. The last block in the chain also has the return
+  // block as its successor.
+  std::vector<BasicBlock *> Entries;
   InlineFunctionInfo IFI;
 };
 struct PartialInlinerLegacyPass : public ModulePass {
   static char ID; // Pass identification, replacement for typeid
   PartialInlinerLegacyPass() : ModulePass(ID) {
     initializePartialInlinerLegacyPassPass(*PassRegistry::getPassRegistry());
   }
 
std::function<AssumptionCache &(Function &)> GetAssumptionCache =
       return ACT->getAssumptionCache(F);
     };
     InlineFunctionInfo IFI(nullptr, &GetAssumptionCache);
     return PartialInlinerImpl(IFI).run(M);
   }
 };
 }
 
-Function *PartialInlinerImpl::unswitchFunction(Function *F) {
-  // First, verify that this function is an unswitching candidate...
+std::tuple<BasicBlock *, BasicBlock *>
+PartialInlinerImpl::findEntryBlocks(Function *F) {
   BasicBlock *EntryBlock = &F->front();
   BranchInst *BR = dyn_cast<BranchInst>(EntryBlock->getTerminator());
   if (!BR || BR->isUnconditional())
-    return nullptr;
+    return std::make_tuple<BasicBlock *, BasicBlock *>(nullptr, nullptr);
 
   BasicBlock *ReturnBlock = nullptr;
   BasicBlock *NonReturnBlock = nullptr;
   unsigned ReturnCount = 0;
+
   for (BasicBlock *BB : successors(EntryBlock)) {
     if (isa<ReturnInst>(BB->getTerminator())) {
       ReturnBlock = BB;
       ReturnCount++;
-    } else
+    } else {
       NonReturnBlock = BB;
     }
+  }
+
+  if (ReturnCount == 1) {
+    Entries.push_back(EntryBlock);
+    return std::make_tuple(ReturnBlock, NonReturnBlock);
+  } else if (ReturnCount != 0) {
+    return std::make_tuple<BasicBlock *, BasicBlock *>(nullptr, nullptr);
+  }
+
+  // Handle more complicated case where the ReturnBlock is guarded by
+  // a chain of predicates:
+  // First find the return block:
+  NonReturnBlock = nullptr;
+
+#if 0
+  for (auto &BB : *F) {
+    TerminatorInst *TI = BB.getTerminator();
+    if (isa<ReturnInst>(TI)) {
+      ReturnBlock = &BB;
+      ReturnCount++;
+    }
+  }
 
   if (ReturnCount != 1)
+    return std::make_tuple<BasicBlock *, BasicBlock *>(nullptr, nullptr);
+
+#endif
+  // Returns true if Succ is BB's successor
+  auto IsSuccessor = [](BasicBlock *Succ, BasicBlock *BB) {
+    return is_contained(successors(BB), Succ);
+  };
+
+  auto SuccSize = [](BasicBlock *BB) { return succ_end(BB) - succ_begin(BB); };
+
+  auto IsReturnBlock = [](BasicBlock *BB) {
+    TerminatorInst *TI = BB->getTerminator();
+    return isa<ReturnInst>(TI);
+  };
+
+  BasicBlock *CurrEntryInChain = EntryBlock;
+  auto IsCurrEntryBlockLastInChain = [&](BasicBlock *RetBlockCand,
+                                         BasicBlock *NonReturnCand) {
+    if (!IsReturnBlock(RetBlockCand))
+      return false;
+
+    if (NonReturnCand == NonReturnBlock) {
+      ReturnBlock = RetBlockCand;
+      Entries.push_back(CurrEntryInChain);
+    } else {
+      NonReturnBlock = nullptr;
+    }
+    return true;
+  };
+
+  do {
+    if (SuccSize(CurrEntryInChain) != 2) {
+      NonReturnBlock = nullptr;
+      break;
+    }
+    BasicBlock *Succ1 = *succ_begin(CurrEntryInChain);
+    BasicBlock *Succ2 = *(succ_begin(CurrEntryInChain) + 1);
+    BasicBlock *CommSucc = nullptr;
+    BasicBlock *OtherSucc = nullptr;
+    if (IsSuccessor(Succ1, Succ2)) {
+      CommSucc = Succ1;
+      OtherSucc = Succ2;
+    } else if (IsSuccessor(Succ2, Succ1)) {
+      CommSucc = Succ2;
+      OtherSucc = Succ1;
+    }
+
+    if (CommSucc) {
+      if (IsCurrEntryBlockLastInChain(CommSucc, OtherSucc)) {
+        break;
+      } else {
+        if ((!NonReturnBlock || NonReturnBlock == CommSucc) &&
+            OtherSucc->getSinglePredecessor() == CurrEntryInChain) {
+          NonReturnBlock = CommSucc;
+          Entries.push_back(CurrEntryInChain);
+          CurrEntryInChain = OtherSucc;
+        } else {
+          // No common NonReturnBlock can be found:
+          NonReturnBlock = nullptr;
+          break;
+        }
+      }
+    } else {
+      if (IsCurrEntryBlockLastInChain(Succ1, Succ2))
+        break;
+      if (IsCurrEntryBlockLastInChain(Succ2, Succ1))
+        break;
+
+      // Fail to find the entry chain as we expect to see
+      // a return block as successor here:
+      NonReturnBlock = nullptr;
+      break;
+    }
+  } while (true);
+
+  if (!NonReturnBlock)
+    return std::make_tuple<BasicBlock *, BasicBlock *>(nullptr, nullptr);
+
+  return std::make_tuple(ReturnBlock, NonReturnBlock);
+}
+
+Function *PartialInlinerImpl::unswitchFunction(Function *F) {
+
+  BasicBlock *ReturnBlock = nullptr;
+  BasicBlock *NonReturnBlock = nullptr;
+
+  std::tie(ReturnBlock, NonReturnBlock) = findEntryBlocks(F);
+
+  if (!ReturnBlock)
     return nullptr;
 
+#ifndef NDEBUG
+  BasicBlock *EntryBlock = Entries[0];
+  assert(EntryBlock && EntryBlock == &F->front());
+  assert(NonReturnBlock);
+#endif
+
   // Clone the function, so that we can hack away on it.
   ValueToValueMapTy VMap;
   Function *DuplicateFunction = CloneFunction(F, VMap);
   DuplicateFunction->setLinkage(GlobalValue::InternalLinkage);
-  BasicBlock *NewEntryBlock = cast<BasicBlock>(VMap[EntryBlock]);
+  // Last block in the entry chain:
+  BasicBlock *NewLastEntryBlock = cast<BasicBlock>(VMap[&*Entries.back()]);
   BasicBlock *NewReturnBlock = cast<BasicBlock>(VMap[ReturnBlock]);
   BasicBlock *NewNonReturnBlock = cast<BasicBlock>(VMap[NonReturnBlock]);
+  DenseSet<BasicBlock *> NewEntryChains;
+  for (BasicBlock *BB : Entries) {
+    NewEntryChains.insert(cast<BasicBlock>(VMap[BB]));
+  }
 
   // Go ahead and update all uses to the duplicate, so that we can just
   // use the inliner functionality when we're done hacking.
   F->replaceAllUsesWith(DuplicateFunction);
 
   // Special hackery is needed with PHI nodes that have inputs from more than
   // one extracted block.  For simplicity, just split the PHIs into a two-level
   // sequence of PHIs, some of which will go in the extracted region, and some
   // of which will go outside.
   BasicBlock *PreReturn = NewReturnBlock;
   NewReturnBlock = NewReturnBlock->splitBasicBlock(
       NewReturnBlock->getFirstNonPHI()->getIterator());
   BasicBlock::iterator I = PreReturn->begin();
   Instruction *Ins = &NewReturnBlock->front();
   while (I != PreReturn->end()) {
     PHINode *OldPhi = dyn_cast<PHINode>(I);
     if (!OldPhi)
       break;
 
     PHINode *RetPhi = PHINode::Create(OldPhi->getType(), 2, "", Ins);
     OldPhi->replaceAllUsesWith(RetPhi);
     Ins = NewReturnBlock->getFirstNonPHI();
 
     RetPhi->addIncoming(&*I, PreReturn);
-    RetPhi->addIncoming(OldPhi->getIncomingValueForBlock(NewEntryBlock),
-                        NewEntryBlock);
-    OldPhi->removeIncomingValue(NewEntryBlock);
+    RetPhi->addIncoming(OldPhi->getIncomingValueForBlock(NewLastEntryBlock),
+                        NewLastEntryBlock);
+    OldPhi->removeIncomingValue(NewLastEntryBlock);
 
     ++I;
   }
-  NewEntryBlock->getTerminator()->replaceUsesOfWith(PreReturn, NewReturnBlock);
+  NewLastEntryBlock->getTerminator()->replaceUsesOfWith(PreReturn,
+                                                        NewReturnBlock);
 
+  // Returns true if the block is to be partial inlined into the caller
+  // (i.e. not to be extracted to the out of line function)
+  auto ToBeInlined = [=](BasicBlock *BB) {
+    if (BB == NewReturnBlock || NewEntryChains.count(BB))
+      return true;
+    return false;
+
+  };
   // Gather up the blocks that we're going to extract.
   std::vector<BasicBlock *> ToExtract;
   ToExtract.push_back(NewNonReturnBlock);
   for (BasicBlock &BB : *DuplicateFunction)
-    if (&BB != NewEntryBlock && &BB != NewReturnBlock &&
-        &BB != NewNonReturnBlock)
+    if (!ToBeInlined(&BB) && &BB != NewNonReturnBlock)
       ToExtract.push_back(&BB);
 
   // The CodeExtractor needs a dominator tree.
   DominatorTree DT;
   DT.recalculate(*DuplicateFunction);
 
   // Manually calculate a BlockFrequencyInfo and BranchProbabilityInfo.
   LoopInfo LI(DT);
   BranchProbabilityInfo BPI(*DuplicateFunction, LI);
   BlockFrequencyInfo BFI(*DuplicateFunction, BPI, LI);
 
   // 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)
     if (CallInst *CI = dyn_cast<CallInst>(User))
       InlineFunction(CI, IFI);
     else if (InvokeInst *II = dyn_cast<InvokeInst>(User))
       InlineFunction(II, 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;
 
   return ExtractedFunction;
 }
 
 bool PartialInlinerImpl::run(Module &M) {
   std::vector<Function *> Worklist;
   Worklist.reserve(M.size());
   for (Function &F : M)
     if (!F.use_empty() && !F.isDeclaration())
       Worklist.push_back(&F);
 
   bool Changed = false;
   while (!Worklist.empty()) {
     Function *CurrFunc = Worklist.back();

test/Transforms/CodeExtractor/MultiConditions.ll

+; RUN: opt < %s -partial-inliner -S | FileCheck %s
+; RUN: opt < %s -passes=partial-inliner -S | FileCheck %s
+
+; Function Attrs: noinline nounwind uwtable
+define i32 @bar(i32 %arg) local_unnamed_addr #0 {
+bb:
+  %tmp = icmp slt i32 %arg, 0
+  br i1 %tmp, label %bb4, label %bb1
+
+bb1:                                              ; preds = %bb
+  %tmp2 = tail call i32 (...) @channels() #1
+  %tmp3 = icmp slt i32 %tmp2, %arg
+  br i1 %tmp3, label %bb4, label %bb5
+
+bb4:                                              ; preds = %bb1, %bb
+  tail call void (...) @foo() #1
+  tail call void (...) @foo() #1
+  tail call void (...) @foo() #1
+  tail call void (...) @foo() #1
+  tail call void (...) @foo() #1
+  tail call void (...) @foo() #1
+  tail call void (...) @foo() #1
+  tail call void (...) @foo() #1
+  tail call void (...) @foo() #1
+  br label %bb5
+
+bb5:                                              ; preds = %bb4, %bb1
+  %.0 = phi i32 [ 0, %bb4 ], [ 1, %bb1 ]
+  ret i32 %.0
+}
+
+declare i32 @channels(...) local_unnamed_addr
+
+declare void @foo(...) local_unnamed_addr
+
+; Function Attrs: noinline nounwind uwtable
+define i32 @dummy_caller(i32 %arg) local_unnamed_addr #0 {
+bb:
+; CHECK-LABEL: @dummy_caller
+; CHECK: br i1
+; CHECK: br i1
+; CHECK: call void @bar.2_
+  %tmp = tail call i32 @bar(i32 %arg)
+  ret i32 %tmp
+}
+
+define i32 @bar_multi_ret(i32 %arg) local_unnamed_addr #0 {
+bb:
+  %tmp = icmp slt i32 %arg, 0
+  br i1 %tmp, label %bb4, label %bb1
+
+bb1:                                              ; preds = %bb
+  %tmp2 = tail call i32 (...) @channels() #1
+  %tmp3 = icmp slt i32 %tmp2, %arg
+  br i1 %tmp3, label %bb4, label %bb5
+
+bb4:                                              ; preds = %bb1, %bb
+  tail call void (...) @foo() #1
+  tail call void (...) @foo() #1
+  tail call void (...) @foo() #1
+  tail call void (...) @foo() #1
+  %tmp4 = icmp slt i32 %arg, 10
+  br i1 %tmp4, label %bb6, label %bb5
+bb6:
+  tail call void (...) @foo() #1
+  %tmp5 = icmp slt i32 %arg, 3
+  br i1 %tmp5, label %bb7, label %bb5
+bb7:
+  tail call void (...) @foo() #1
+  br label %bb8
+bb8:
+  ret i32 0 
+
+bb5:                                              ; preds = %bb4, %bb1
+  %.0 = phi i32 [ 0, %bb4 ], [ 1, %bb1 ], [0, %bb6]
+  ret i32 %.0
+}
+
+define i32 @dummy_caller2(i32 %arg) local_unnamed_addr #0 {
+; CHECK: br i1
+; CHECK: br i1
+; CHECK: call i1 @bar_multi_ret.1_
+  %tmp = tail call i32 @bar_multi_ret(i32 %arg)
+  ret i32 %tmp
+}
+
+attributes #0 = { noinline nounwind uwtable }
+attributes #1 = { nounwind }
+
+!llvm.ident = !{!0}
+
+!0 = !{!"clang version 5.0.0 (trunk 300576)"}

test/Transforms/CodeExtractor/SingleCondition.ll

+; RUN: opt < %s -partial-inliner -S  | FileCheck %s
+; RUN: opt < %s -passes=partial-inliner -S  | FileCheck %s
+
+define internal i32 @inlinedFunc(i1 %cond, i32* align 4 %align.val) {
+entry:
+  br i1 %cond, label %if.then, label %return
+if.then:
+  ; Dummy store to have more than 0 uses
+  store i32 10, i32* %align.val, align 4
+  br label %return
+return:             ; preds = %entry
+  ret i32 0
+}
+
+define internal i32 @dummyCaller(i1 %cond, i32* align 2 %align.val) {
+entry:
+; CHECK-LABEL: @dummyCaller
+; CHECK: br
+; CHECK: call void @inlinedFunc.1_ 
+  %val = call i32 @inlinedFunc(i1 %cond, i32* %align.val)
+  ret i32 %val
+}
+