LCOV - code coverage report
Current view: top level - lib/CodeGen - BranchFolding.cpp (source / functions) Hit Total Coverage
Test: llvm-toolchain.info Lines: 717 759 94.5 %
Date: 2018-06-17 00:07:59 Functions: 42 49 85.7 %
Legend: Lines: hit not hit

          Line data    Source code
       1             : //===- BranchFolding.cpp - Fold machine code branch instructions ----------===//
       2             : //
       3             : //                     The LLVM Compiler Infrastructure
       4             : //
       5             : // This file is distributed under the University of Illinois Open Source
       6             : // License. See LICENSE.TXT for details.
       7             : //
       8             : //===----------------------------------------------------------------------===//
       9             : //
      10             : // This pass forwards branches to unconditional branches to make them branch
      11             : // directly to the target block.  This pass often results in dead MBB's, which
      12             : // it then removes.
      13             : //
      14             : // Note that this pass must be run after register allocation, it cannot handle
      15             : // SSA form. It also must handle virtual registers for targets that emit virtual
      16             : // ISA (e.g. NVPTX).
      17             : //
      18             : //===----------------------------------------------------------------------===//
      19             : 
      20             : #include "BranchFolding.h"
      21             : #include "llvm/ADT/BitVector.h"
      22             : #include "llvm/ADT/DenseMap.h"
      23             : #include "llvm/ADT/STLExtras.h"
      24             : #include "llvm/ADT/SmallPtrSet.h"
      25             : #include "llvm/ADT/SmallSet.h"
      26             : #include "llvm/ADT/SmallVector.h"
      27             : #include "llvm/ADT/Statistic.h"
      28             : #include "llvm/CodeGen/Analysis.h"
      29             : #include "llvm/CodeGen/LivePhysRegs.h"
      30             : #include "llvm/CodeGen/MachineBasicBlock.h"
      31             : #include "llvm/CodeGen/MachineBlockFrequencyInfo.h"
      32             : #include "llvm/CodeGen/MachineBranchProbabilityInfo.h"
      33             : #include "llvm/CodeGen/MachineFunction.h"
      34             : #include "llvm/CodeGen/MachineFunctionPass.h"
      35             : #include "llvm/CodeGen/MachineInstr.h"
      36             : #include "llvm/CodeGen/MachineInstrBuilder.h"
      37             : #include "llvm/CodeGen/MachineJumpTableInfo.h"
      38             : #include "llvm/CodeGen/MachineLoopInfo.h"
      39             : #include "llvm/CodeGen/MachineModuleInfo.h"
      40             : #include "llvm/CodeGen/MachineOperand.h"
      41             : #include "llvm/CodeGen/MachineRegisterInfo.h"
      42             : #include "llvm/CodeGen/TargetInstrInfo.h"
      43             : #include "llvm/CodeGen/TargetOpcodes.h"
      44             : #include "llvm/CodeGen/TargetPassConfig.h"
      45             : #include "llvm/CodeGen/TargetRegisterInfo.h"
      46             : #include "llvm/CodeGen/TargetSubtargetInfo.h"
      47             : #include "llvm/IR/DebugInfoMetadata.h"
      48             : #include "llvm/IR/DebugLoc.h"
      49             : #include "llvm/IR/Function.h"
      50             : #include "llvm/MC/LaneBitmask.h"
      51             : #include "llvm/MC/MCRegisterInfo.h"
      52             : #include "llvm/Pass.h"
      53             : #include "llvm/Support/BlockFrequency.h"
      54             : #include "llvm/Support/BranchProbability.h"
      55             : #include "llvm/Support/CommandLine.h"
      56             : #include "llvm/Support/Debug.h"
      57             : #include "llvm/Support/ErrorHandling.h"
      58             : #include "llvm/Support/raw_ostream.h"
      59             : #include "llvm/Target/TargetMachine.h"
      60             : #include <cassert>
      61             : #include <cstddef>
      62             : #include <iterator>
      63             : #include <numeric>
      64             : #include <vector>
      65             : 
      66             : using namespace llvm;
      67             : 
      68             : #define DEBUG_TYPE "branch-folder"
      69             : 
      70             : STATISTIC(NumDeadBlocks, "Number of dead blocks removed");
      71             : STATISTIC(NumBranchOpts, "Number of branches optimized");
      72             : STATISTIC(NumTailMerge , "Number of block tails merged");
      73             : STATISTIC(NumHoist     , "Number of times common instructions are hoisted");
      74             : STATISTIC(NumTailCalls,  "Number of tail calls optimized");
      75             : 
      76      101169 : static cl::opt<cl::boolOrDefault> FlagEnableTailMerge("enable-tail-merge",
      77      101169 :                               cl::init(cl::BOU_UNSET), cl::Hidden);
      78             : 
      79             : // Throttle for huge numbers of predecessors (compile speed problems)
      80             : static cl::opt<unsigned>
      81      101169 : TailMergeThreshold("tail-merge-threshold",
      82      101169 :           cl::desc("Max number of predecessors to consider tail merging"),
      83      303507 :           cl::init(150), cl::Hidden);
      84             : 
      85             : // Heuristic for tail merging (and, inversely, tail duplication).
      86             : // TODO: This should be replaced with a target query.
      87             : static cl::opt<unsigned>
      88      101169 : TailMergeSize("tail-merge-size",
      89      101169 :               cl::desc("Min number of instructions to consider tail merging"),
      90      303507 :               cl::init(3), cl::Hidden);
      91             : 
      92             : namespace {
      93             : 
      94             :   /// BranchFolderPass - Wrap branch folder in a machine function pass.
      95       19024 :   class BranchFolderPass : public MachineFunctionPass {
      96             :   public:
      97             :     static char ID;
      98             : 
      99       19127 :     explicit BranchFolderPass(): MachineFunctionPass(ID) {}
     100             : 
     101             :     bool runOnMachineFunction(MachineFunction &MF) override;
     102             : 
     103       18984 :     void getAnalysisUsage(AnalysisUsage &AU) const override {
     104             :       AU.addRequired<MachineBlockFrequencyInfo>();
     105             :       AU.addRequired<MachineBranchProbabilityInfo>();
     106             :       AU.addRequired<TargetPassConfig>();
     107       18984 :       MachineFunctionPass::getAnalysisUsage(AU);
     108       18984 :     }
     109             :   };
     110             : 
     111             : } // end anonymous namespace
     112             : 
     113             : char BranchFolderPass::ID = 0;
     114             : 
     115             : char &llvm::BranchFolderPassID = BranchFolderPass::ID;
     116             : 
     117      148112 : INITIALIZE_PASS(BranchFolderPass, DEBUG_TYPE,
     118             :                 "Control Flow Optimizer", false, false)
     119             : 
     120      181446 : bool BranchFolderPass::runOnMachineFunction(MachineFunction &MF) {
     121      181446 :   if (skipFunction(MF.getFunction()))
     122             :     return false;
     123             : 
     124      181290 :   TargetPassConfig *PassConfig = &getAnalysis<TargetPassConfig>();
     125             :   // TailMerge can create jump into if branches that make CFG irreducible for
     126             :   // HW that requires structurized CFG.
     127      540609 :   bool EnableTailMerge = !MF.getTarget().requiresStructuredCFG() &&
     128      178029 :                          PassConfig->getEnableTailMerge();
     129             :   BranchFolder::MBFIWrapper MBBFreqInfo(
     130      181290 :       getAnalysis<MachineBlockFrequencyInfo>());
     131             :   BranchFolder Folder(EnableTailMerge, /*CommonHoist=*/true, MBBFreqInfo,
     132      362580 :                       getAnalysis<MachineBranchProbabilityInfo>());
     133      362580 :   return Folder.OptimizeFunction(MF, MF.getSubtarget().getInstrInfo(),
     134      181290 :                                  MF.getSubtarget().getRegisterInfo(),
     135      181290 :                                  getAnalysisIfAvailable<MachineModuleInfo>());
     136             : }
     137             : 
     138      221931 : BranchFolder::BranchFolder(bool defaultEnableTailMerge, bool CommonHoist,
     139             :                            MBFIWrapper &FreqInfo,
     140             :                            const MachineBranchProbabilityInfo &ProbInfo,
     141      221931 :                            unsigned MinTailLength)
     142             :     : EnableHoistCommonCode(CommonHoist), MinCommonTailLength(MinTailLength),
     143      665793 :       MBBFreqInfo(FreqInfo), MBPI(ProbInfo) {
     144      221931 :   if (MinCommonTailLength == 0)
     145      215157 :     MinCommonTailLength = TailMergeSize;
     146      221931 :   switch (FlagEnableTailMerge) {
     147      221879 :   case cl::BOU_UNSET: EnableTailMerge = defaultEnableTailMerge; break;
     148           3 :   case cl::BOU_TRUE: EnableTailMerge = true; break;
     149          49 :   case cl::BOU_FALSE: EnableTailMerge = false; break;
     150             :   }
     151      221931 : }
     152             : 
     153       11576 : void BranchFolder::RemoveDeadBlock(MachineBasicBlock *MBB) {
     154             :   assert(MBB->pred_empty() && "MBB must be dead!");
     155             :   LLVM_DEBUG(dbgs() << "\nRemoving MBB: " << *MBB);
     156             : 
     157       11576 :   MachineFunction *MF = MBB->getParent();
     158             :   // drop all successors.
     159       25684 :   while (!MBB->succ_empty())
     160        7054 :     MBB->removeSuccessor(MBB->succ_end()-1);
     161             : 
     162             :   // Avoid matching if this pointer gets reused.
     163             :   TriedMerging.erase(MBB);
     164             : 
     165             :   // Remove the block.
     166             :   MF->erase(MBB);
     167       11576 :   EHScopeMembership.erase(MBB);
     168       11576 :   if (MLI)
     169             :     MLI->removeBlock(MBB);
     170       11576 : }
     171             : 
     172      221931 : bool BranchFolder::OptimizeFunction(MachineFunction &MF,
     173             :                                     const TargetInstrInfo *tii,
     174             :                                     const TargetRegisterInfo *tri,
     175             :                                     MachineModuleInfo *mmi,
     176             :                                     MachineLoopInfo *mli, bool AfterPlacement) {
     177      221931 :   if (!tii) return false;
     178             : 
     179      221931 :   TriedMerging.clear();
     180             : 
     181      221931 :   MachineRegisterInfo &MRI = MF.getRegInfo();
     182      221931 :   AfterBlockPlacement = AfterPlacement;
     183      221931 :   TII = tii;
     184      221931 :   TRI = tri;
     185      221931 :   MMI = mmi;
     186      221931 :   MLI = mli;
     187      221931 :   this->MRI = &MRI;
     188             : 
     189      443862 :   UpdateLiveIns = MRI.tracksLiveness() && TRI->trackLivenessAfterRegAlloc(MF);
     190      221931 :   if (!UpdateLiveIns)
     191        7768 :     MRI.invalidateLiveness();
     192             : 
     193             :   // Fix CFG.  The later algorithms expect it to be right.
     194             :   bool MadeChange = false;
     195      760506 :   for (MachineBasicBlock &MBB : MF) {
     196      538575 :     MachineBasicBlock *TBB = nullptr, *FBB = nullptr;
     197             :     SmallVector<MachineOperand, 4> Cond;
     198      538575 :     if (!TII->analyzeBranch(MBB, TBB, FBB, Cond, true))
     199      313849 :       MadeChange |= MBB.CorrectExtraCFGEdges(TBB, FBB, !Cond.empty());
     200             :   }
     201             : 
     202             :   // Recalculate EH scope membership.
     203      443862 :   EHScopeMembership = getEHScopeMembership(MF);
     204             : 
     205             :   bool MadeChangeThisIteration = true;
     206      686383 :   while (MadeChangeThisIteration) {
     207      232226 :     MadeChangeThisIteration    = TailMergeBlocks(MF);
     208             :     // No need to clean up if tail merging does not change anything after the
     209             :     // block placement.
     210      232226 :     if (!AfterBlockPlacement || MadeChangeThisIteration)
     211      225452 :       MadeChangeThisIteration |= OptimizeBranches(MF);
     212      232226 :     if (EnableHoistCommonCode)
     213      189686 :       MadeChangeThisIteration |= HoistCommonCode(MF);
     214      232226 :     MadeChange |= MadeChangeThisIteration;
     215             :   }
     216             : 
     217             :   // See if any jump tables have become dead as the code generator
     218             :   // did its thing.
     219      221931 :   MachineJumpTableInfo *JTI = MF.getJumpTableInfo();
     220      221931 :   if (!JTI)
     221             :     return MadeChange;
     222             : 
     223             :   // Walk the function to find jump tables that are live.
     224         982 :   BitVector JTIsLive(JTI->getJumpTables().size());
     225        7213 :   for (const MachineBasicBlock &BB : MF) {
     226       72469 :     for (const MachineInstr &I : BB)
     227      591805 :       for (const MachineOperand &Op : I.operands()) {
     228      266390 :         if (!Op.isJTI()) continue;
     229             : 
     230             :         // Remember that this JT is live.
     231         818 :         JTIsLive.set(Op.getIndex());
     232             :       }
     233             :   }
     234             : 
     235             :   // Finally, remove dead jump tables.  This happens when the
     236             :   // indirect jump was unreachable (and thus deleted).
     237        1006 :   for (unsigned i = 0, e = JTIsLive.size(); i != e; ++i)
     238         515 :     if (!JTIsLive.test(i)) {
     239             :       JTI->RemoveJumpTable(i);
     240             :       MadeChange = true;
     241             :     }
     242             : 
     243             :   return MadeChange;
     244             : }
     245             : 
     246             : //===----------------------------------------------------------------------===//
     247             : //  Tail Merging of Blocks
     248             : //===----------------------------------------------------------------------===//
     249             : 
     250             : /// HashMachineInstr - Compute a hash value for MI and its operands.
     251      625621 : static unsigned HashMachineInstr(const MachineInstr &MI) {
     252      625621 :   unsigned Hash = MI.getOpcode();
     253     2932287 :   for (unsigned i = 0, e = MI.getNumOperands(); i != e; ++i) {
     254     2306666 :     const MachineOperand &Op = MI.getOperand(i);
     255             : 
     256             :     // Merge in bits from the operand if easy. We can't use MachineOperand's
     257             :     // hash_code here because it's not deterministic and we sort by hash value
     258             :     // later.
     259             :     unsigned OperandHash = 0;
     260     2306666 :     switch (Op.getType()) {
     261     1482643 :     case MachineOperand::MO_Register:
     262     1482643 :       OperandHash = Op.getReg();
     263     1482643 :       break;
     264      418448 :     case MachineOperand::MO_Immediate:
     265      418448 :       OperandHash = Op.getImm();
     266      418448 :       break;
     267      116764 :     case MachineOperand::MO_MachineBasicBlock:
     268      116764 :       OperandHash = Op.getMBB()->getNumber();
     269      116764 :       break;
     270         399 :     case MachineOperand::MO_FrameIndex:
     271             :     case MachineOperand::MO_ConstantPoolIndex:
     272             :     case MachineOperand::MO_JumpTableIndex:
     273         399 :       OperandHash = Op.getIndex();
     274         399 :       break;
     275      173423 :     case MachineOperand::MO_GlobalAddress:
     276             :     case MachineOperand::MO_ExternalSymbol:
     277             :       // Global address / external symbol are too hard, don't bother, but do
     278             :       // pull in the offset.
     279      346846 :       OperandHash = Op.getOffset();
     280      173423 :       break;
     281             :     default:
     282             :       break;
     283             :     }
     284             : 
     285     2306666 :     Hash += ((OperandHash << 3) | Op.getType()) << (i & 31);
     286             :   }
     287      625621 :   return Hash;
     288             : }
     289             : 
     290             : /// HashEndOfMBB - Hash the last instruction in the MBB.
     291      631456 : static unsigned HashEndOfMBB(const MachineBasicBlock &MBB) {
     292             :   MachineBasicBlock::const_iterator I = MBB.getLastNonDebugInstr();
     293      631456 :   if (I == MBB.end())
     294             :     return 0;
     295             : 
     296      625621 :   return HashMachineInstr(*I);
     297             : }
     298             : 
     299             : ///  Whether MI should be counted as an instruction when calculating common tail.
     300             : static bool countsAsInstruction(const MachineInstr &MI) {
     301     3397427 :   return !(MI.isDebugValue() || MI.isCFIInstruction());
     302             : }
     303             : 
     304             : /// ComputeCommonTailLength - Given two machine basic blocks, compute the number
     305             : /// of instructions they actually have in common together at their end.  Return
     306             : /// iterators for the first shared instruction in each block.
     307      672763 : static unsigned ComputeCommonTailLength(MachineBasicBlock *MBB1,
     308             :                                         MachineBasicBlock *MBB2,
     309             :                                         MachineBasicBlock::iterator &I1,
     310             :                                         MachineBasicBlock::iterator &I2) {
     311      672763 :   I1 = MBB1->end();
     312      672763 :   I2 = MBB2->end();
     313             : 
     314             :   unsigned TailLen = 0;
     315     4077754 :   while (I1 != MBB1->begin() && I2 != MBB2->begin()) {
     316             :     --I1; --I2;
     317             :     // Skip debugging pseudos; necessary to avoid changing the code.
     318             :     while (!countsAsInstruction(*I1)) {
     319      158723 :       if (I1==MBB1->begin()) {
     320             :         while (!countsAsInstruction(*I2)) {
     321         201 :           if (I2==MBB2->begin()) {
     322             :             // I1==DBG at begin; I2==DBG at begin
     323             :             goto SkipTopCFIAndReturn;
     324             :           }
     325             :           --I2;
     326             :         }
     327             :         ++I2;
     328             :         // I1==DBG at begin; I2==non-DBG, or first of DBGs not at begin
     329             :         goto SkipTopCFIAndReturn;
     330             :       }
     331             :       --I1;
     332             :     }
     333             :     // I1==first (untested) non-DBG preceding known match
     334             :     while (!countsAsInstruction(*I2)) {
     335      158525 :       if (I2==MBB2->begin()) {
     336             :         ++I1;
     337             :         // I1==non-DBG, or first of DBGs not at begin; I2==DBG at begin
     338             :         goto SkipTopCFIAndReturn;
     339             :       }
     340             :       --I2;
     341             :     }
     342             :     // I1, I2==first (untested) non-DBGs preceding known match
     343     2397530 :     if (!I1->isIdenticalTo(*I2) ||
     344             :         // FIXME: This check is dubious. It's used to get around a problem where
     345             :         // people incorrectly expect inline asm directives to remain in the same
     346             :         // relative order. This is untenable because normal compiler
     347             :         // optimizations (like this one) may reorder and/or merge these
     348             :         // directives.
     349             :         I1->isInlineAsm()) {
     350             :       ++I1; ++I2;
     351             :       break;
     352             :     }
     353      974940 :     ++TailLen;
     354             :   }
     355             :   // Back past possible debugging pseudos at beginning of block.  This matters
     356             :   // when one block differs from the other only by whether debugging pseudos
     357             :   // are present at the beginning. (This way, the various checks later for
     358             :   // I1==MBB1->begin() work as expected.)
     359      865207 :   if (I1 == MBB1->begin() && I2 != MBB2->begin()) {
     360             :     --I2;
     361             :     while (I2->isDebugInstr()) {
     362          12 :       if (I2 == MBB2->begin())
     363             :         return TailLen;
     364             :       --I2;
     365             :     }
     366             :     ++I2;
     367             :   }
     368      833493 :   if (I2 == MBB2->begin() && I1 != MBB1->begin()) {
     369             :     --I1;
     370             :     while (I1->isDebugInstr()) {
     371           3 :       if (I1 == MBB1->begin())
     372             :         return TailLen;
     373             :       --I1;
     374             :     }
     375             :     ++I1;
     376             :   }
     377             : 
     378          98 : SkipTopCFIAndReturn:
     379             :   // Ensure that I1 and I2 do not point to a CFI_INSTRUCTION. This can happen if
     380             :   // I1 and I2 are non-identical when compared and then one or both of them ends
     381             :   // up pointing to a CFI instruction after being incremented. For example:
     382             :   /*
     383             :     BB1:
     384             :     ...
     385             :     INSTRUCTION_A
     386             :     ADD32ri8  <- last common instruction
     387             :     ...
     388             :     BB2:
     389             :     ...
     390             :     INSTRUCTION_B
     391             :     CFI_INSTRUCTION
     392             :     ADD32ri8  <- last common instruction
     393             :     ...
     394             :   */
     395             :   // When INSTRUCTION_A and INSTRUCTION_B are compared as not equal, after
     396             :   // incrementing the iterators, I1 will point to ADD, however I2 will point to
     397             :   // the CFI instruction. Later on, this leads to BB2 being 'hacked off' at the
     398             :   // wrong place (in ReplaceTailWithBranchTo()) which results in losing this CFI
     399             :   // instruction.
     400     1199535 :   while (I1 != MBB1->end() && I1->isCFIInstruction()) {
     401             :     ++I1;
     402             :   }
     403             : 
     404     1199529 :   while (I2 != MBB2->end() && I2->isCFIInstruction()) {
     405             :     ++I2;
     406             :   }
     407             : 
     408             :   return TailLen;
     409             : }
     410             : 
     411       13394 : void BranchFolder::replaceTailWithBranchTo(MachineBasicBlock::iterator OldInst,
     412             :                                            MachineBasicBlock &NewDest) {
     413       13394 :   if (UpdateLiveIns) {
     414             :     // OldInst should always point to an instruction.
     415       13372 :     MachineBasicBlock &OldMBB = *OldInst->getParent();
     416       13372 :     LiveRegs.clear();
     417       13372 :     LiveRegs.addLiveOuts(OldMBB);
     418             :     // Move backward to the place where will insert the jump.
     419       13372 :     MachineBasicBlock::iterator I = OldMBB.end();
     420             :     do {
     421             :       --I;
     422       63739 :       LiveRegs.stepBackward(*I);
     423       63739 :     } while (I != OldInst);
     424             : 
     425             :     // Merging the tails may have switched some undef operand to non-undef ones.
     426             :     // Add IMPLICIT_DEFS into OldMBB as necessary to have a definition of the
     427             :     // register.
     428       36666 :     for (MachineBasicBlock::RegisterMaskPair P : NewDest.liveins()) {
     429             :       // We computed the liveins with computeLiveIn earlier and should only see
     430             :       // full registers:
     431             :       assert(P.LaneMask == LaneBitmask::getAll() &&
     432             :              "Can only handle full register.");
     433             :       MCPhysReg Reg = P.PhysReg;
     434       23294 :       if (!LiveRegs.available(*MRI, Reg))
     435       23293 :         continue;
     436           1 :       DebugLoc DL;
     437           2 :       BuildMI(OldMBB, OldInst, DL, TII->get(TargetOpcode::IMPLICIT_DEF), Reg);
     438             :     }
     439             :   }
     440             : 
     441       13394 :   TII->ReplaceTailWithBranchTo(OldInst, &NewDest);
     442             :   ++NumTailMerge;
     443       13394 : }
     444             : 
     445        3474 : MachineBasicBlock *BranchFolder::SplitMBBAt(MachineBasicBlock &CurMBB,
     446             :                                             MachineBasicBlock::iterator BBI1,
     447             :                                             const BasicBlock *BB) {
     448        3474 :   if (!TII->isLegalToSplitMBBAt(CurMBB, BBI1))
     449             :     return nullptr;
     450             : 
     451        3474 :   MachineFunction &MF = *CurMBB.getParent();
     452             : 
     453             :   // Create the fall-through block.
     454        3474 :   MachineFunction::iterator MBBI = CurMBB.getIterator();
     455        3474 :   MachineBasicBlock *NewMBB = MF.CreateMachineBasicBlock(BB);
     456        3474 :   CurMBB.getParent()->insert(++MBBI, NewMBB);
     457             : 
     458             :   // Move all the successors of this block to the specified block.
     459        3474 :   NewMBB->transferSuccessors(&CurMBB);
     460             : 
     461             :   // Add an edge from CurMBB to NewMBB for the fall-through.
     462        3474 :   CurMBB.addSuccessor(NewMBB);
     463             : 
     464             :   // Splice the code over.
     465             :   NewMBB->splice(NewMBB->end(), &CurMBB, BBI1, CurMBB.end());
     466             : 
     467             :   // NewMBB belongs to the same loop as CurMBB.
     468        3474 :   if (MLI)
     469          16 :     if (MachineLoop *ML = MLI->getLoopFor(&CurMBB))
     470          32 :       ML->addBasicBlockToLoop(NewMBB, MLI->getBase());
     471             : 
     472             :   // NewMBB inherits CurMBB's block frequency.
     473        3474 :   MBBFreqInfo.setBlockFreq(NewMBB, MBBFreqInfo.getBlockFreq(&CurMBB));
     474             : 
     475        3474 :   if (UpdateLiveIns)
     476        3465 :     computeAndAddLiveIns(LiveRegs, *NewMBB);
     477             : 
     478             :   // Add the new block to the EH scope.
     479        3474 :   const auto &EHScopeI = EHScopeMembership.find(&CurMBB);
     480        3474 :   if (EHScopeI != EHScopeMembership.end()) {
     481           0 :     auto n = EHScopeI->second;
     482           0 :     EHScopeMembership[NewMBB] = n;
     483             :   }
     484             : 
     485             :   return NewMBB;
     486             : }
     487             : 
     488             : /// EstimateRuntime - Make a rough estimate for how long it will take to run
     489             : /// the specified code.
     490        8946 : static unsigned EstimateRuntime(MachineBasicBlock::iterator I,
     491             :                                 MachineBasicBlock::iterator E) {
     492             :   unsigned Time = 0;
     493       33482 :   for (; I != E; ++I) {
     494        3833 :     if (!countsAsInstruction(*I))
     495        3833 :       continue;
     496       20703 :     if (I->isCall())
     497         746 :       Time += 10;
     498       36229 :     else if (I->mayLoad() || I->mayStore())
     499        7052 :       Time += 2;
     500             :     else
     501       12905 :       ++Time;
     502             :   }
     503        8946 :   return Time;
     504             : }
     505             : 
     506             : // CurMBB needs to add an unconditional branch to SuccMBB (we removed these
     507             : // branches temporarily for tail merging).  In the case where CurMBB ends
     508             : // with a conditional branch to the next block, optimize by reversing the
     509             : // test and conditionally branching to SuccMBB instead.
     510      234075 : static void FixTail(MachineBasicBlock *CurMBB, MachineBasicBlock *SuccBB,
     511             :                     const TargetInstrInfo *TII) {
     512      234075 :   MachineFunction *MF = CurMBB->getParent();
     513             :   MachineFunction::iterator I = std::next(MachineFunction::iterator(CurMBB));
     514      234075 :   MachineBasicBlock *TBB = nullptr, *FBB = nullptr;
     515             :   SmallVector<MachineOperand, 4> Cond;
     516      234075 :   DebugLoc dl = CurMBB->findBranchDebugLoc();
     517      234075 :   if (I != MF->end() && !TII->analyzeBranch(*CurMBB, TBB, FBB, Cond, true)) {
     518             :     MachineBasicBlock *NextBB = &*I;
     519      231246 :     if (TBB == NextBB && !Cond.empty() && !FBB) {
     520      101275 :       if (!TII->reverseBranchCondition(Cond)) {
     521      101275 :         TII->removeBranch(*CurMBB);
     522      202550 :         TII->insertBranch(*CurMBB, SuccBB, nullptr, Cond, dl);
     523             :         return;
     524             :       }
     525             :     }
     526             :   }
     527      132800 :   TII->insertBranch(*CurMBB, SuccBB, nullptr,
     528      265600 :                     SmallVector<MachineOperand, 0>(), dl);
     529             : }
     530             : 
     531             : bool
     532           0 : BranchFolder::MergePotentialsElt::operator<(const MergePotentialsElt &o) const {
     533      498930 :   if (getHash() < o.getHash())
     534             :     return true;
     535      212935 :   if (getHash() > o.getHash())
     536             :     return false;
     537      160432 :   if (getBlock()->getNumber() < o.getBlock()->getNumber())
     538             :     return true;
     539       53074 :   if (getBlock()->getNumber() > o.getBlock()->getNumber())
     540             :     return false;
     541             :   // _GLIBCXX_DEBUG checks strict weak ordering, which involves comparing
     542             :   // an object with itself.
     543             : #ifndef _GLIBCXX_DEBUG
     544           0 :   llvm_unreachable("Predecessor appears twice");
     545             : #else
     546             :   return false;
     547             : #endif
     548             : }
     549             : 
     550             : BlockFrequency
     551     1403505 : BranchFolder::MBFIWrapper::getBlockFreq(const MachineBasicBlock *MBB) const {
     552     1403505 :   auto I = MergedBBFreq.find(MBB);
     553             : 
     554     1403505 :   if (I != MergedBBFreq.end())
     555        4874 :     return I->second;
     556             : 
     557     1398631 :   return MBFI.getBlockFreq(MBB);
     558             : }
     559             : 
     560           0 : void BranchFolder::MBFIWrapper::setBlockFreq(const MachineBasicBlock *MBB,
     561             :                                              BlockFrequency F) {
     562       18258 :   MergedBBFreq[MBB] = F;
     563           0 : }
     564             : 
     565             : raw_ostream &
     566           0 : BranchFolder::MBFIWrapper::printBlockFreq(raw_ostream &OS,
     567             :                                           const MachineBasicBlock *MBB) const {
     568           0 :   return MBFI.printBlockFreq(OS, getBlockFreq(MBB));
     569             : }
     570             : 
     571             : raw_ostream &
     572           0 : BranchFolder::MBFIWrapper::printBlockFreq(raw_ostream &OS,
     573             :                                           const BlockFrequency Freq) const {
     574           0 :   return MBFI.printBlockFreq(OS, Freq);
     575             : }
     576             : 
     577           0 : void BranchFolder::MBFIWrapper::view(const Twine &Name, bool isSimple) {
     578           0 :   MBFI.view(Name, isSimple);
     579           0 : }
     580             : 
     581             : uint64_t
     582        1745 : BranchFolder::MBFIWrapper::getEntryFreq() const {
     583        1745 :   return MBFI.getEntryFreq();
     584             : }
     585             : 
     586             : /// CountTerminators - Count the number of terminators in the given
     587             : /// block and set I to the position of the first non-terminator, if there
     588             : /// is one, or MBB->end() otherwise.
     589        4857 : static unsigned CountTerminators(MachineBasicBlock *MBB,
     590             :                                  MachineBasicBlock::iterator &I) {
     591        4857 :   I = MBB->end();
     592             :   unsigned NumTerms = 0;
     593             :   while (true) {
     594        7433 :     if (I == MBB->begin()) {
     595           1 :       I = MBB->end();
     596           1 :       break;
     597             :     }
     598             :     --I;
     599        6144 :     if (!I->isTerminator()) break;
     600        1288 :     ++NumTerms;
     601             :   }
     602        4857 :   return NumTerms;
     603             : }
     604             : 
     605             : /// A no successor, non-return block probably ends in unreachable and is cold.
     606             : /// Also consider a block that ends in an indirect branch to be a return block,
     607             : /// since many targets use plain indirect branches to return.
     608      122590 : static bool blockEndsInUnreachable(const MachineBasicBlock *MBB) {
     609      122590 :   if (!MBB->succ_empty())
     610             :     return false;
     611      108806 :   if (MBB->empty())
     612             :     return true;
     613      111280 :   return !(MBB->back().isReturn() || MBB->back().isIndirectBranch());
     614             : }
     615             : 
     616             : /// ProfitableToMerge - Check if two machine basic blocks have a common tail
     617             : /// and decide if it would be profitable to merge those tails.  Return the
     618             : /// length of the common tail and iterators to the first common instruction
     619             : /// in each block.
     620             : /// MBB1, MBB2      The blocks to check
     621             : /// MinCommonTailLength  Minimum size of tail block to be merged.
     622             : /// CommonTailLen   Out parameter to record the size of the shared tail between
     623             : ///                 MBB1 and MBB2
     624             : /// I1, I2          Iterator references that will be changed to point to the first
     625             : ///                 instruction in the common tail shared by MBB1,MBB2
     626             : /// SuccBB          A common successor of MBB1, MBB2 which are in a canonical form
     627             : ///                 relative to SuccBB
     628             : /// PredBB          The layout predecessor of SuccBB, if any.
     629             : /// EHScopeMembership  map from block to EH scope #.
     630             : /// AfterPlacement  True if we are merging blocks after layout. Stricter
     631             : ///                 thresholds apply to prevent undoing tail-duplication.
     632             : static bool
     633      672827 : ProfitableToMerge(MachineBasicBlock *MBB1, MachineBasicBlock *MBB2,
     634             :                   unsigned MinCommonTailLength, unsigned &CommonTailLen,
     635             :                   MachineBasicBlock::iterator &I1,
     636             :                   MachineBasicBlock::iterator &I2, MachineBasicBlock *SuccBB,
     637             :                   MachineBasicBlock *PredBB,
     638             :                   DenseMap<const MachineBasicBlock *, int> &EHScopeMembership,
     639             :                   bool AfterPlacement) {
     640             :   // It is never profitable to tail-merge blocks from two different EH scopes.
     641      672827 :   if (!EHScopeMembership.empty()) {
     642          87 :     auto EHScope1 = EHScopeMembership.find(MBB1);
     643             :     assert(EHScope1 != EHScopeMembership.end());
     644          87 :     auto EHScope2 = EHScopeMembership.find(MBB2);
     645             :     assert(EHScope2 != EHScopeMembership.end());
     646          87 :     if (EHScope1->second != EHScope2->second)
     647          64 :       return false;
     648             :   }
     649             : 
     650      672763 :   CommonTailLen = ComputeCommonTailLength(MBB1, MBB2, I1, I2);
     651      672763 :   if (CommonTailLen == 0)
     652             :     return false;
     653             :   LLVM_DEBUG(dbgs() << "Common tail length of " << printMBBReference(*MBB1)
     654             :                     << " and " << printMBBReference(*MBB2) << " is "
     655             :                     << CommonTailLen << '\n');
     656             : 
     657             :   // It's almost always profitable to merge any number of non-terminator
     658             :   // instructions with the block that falls through into the common successor.
     659             :   // This is true only for a single successor. For multiple successors, we are
     660             :   // trading a conditional branch for an unconditional one.
     661             :   // TODO: Re-visit successor size for non-layout tail merging.
     662      403153 :   if ((MBB1 == PredBB || MBB2 == PredBB) &&
     663        1298 :       (!AfterPlacement || MBB1->succ_size() == 1)) {
     664             :     MachineBasicBlock::iterator I;
     665        4857 :     unsigned NumTerms = CountTerminators(MBB1 == PredBB ? MBB2 : MBB1, I);
     666        4857 :     if (CommonTailLen > NumTerms)
     667        4485 :       return true;
     668             :   }
     669             : 
     670             :   // If these are identical non-return blocks with no successors, merge them.
     671             :   // Such blocks are typically cold calls to noreturn functions like abort, and
     672             :   // are unlikely to become a fallthrough target after machine block placement.
     673             :   // Tail merging these blocks is unlikely to create additional unconditional
     674             :   // branches, and will reduce the size of this cold code.
     675      306764 :   if (I1 == MBB1->begin() && I2 == MBB2->begin() &&
     676      521258 :       blockEndsInUnreachable(MBB1) && blockEndsInUnreachable(MBB2))
     677             :     return true;
     678             : 
     679             :   // If one of the blocks can be completely merged and happens to be in
     680             :   // a position where the other could fall through into it, merge any number
     681             :   // of instructions, because it can be done without a branch.
     682             :   // TODO: If the blocks are not adjacent, move one of them so that they are?
     683      397697 :   if (MBB1->isLayoutSuccessor(MBB2) && I2 == MBB2->begin())
     684             :     return true;
     685      404902 :   if (MBB2->isLayoutSuccessor(MBB1) && I1 == MBB1->begin())
     686             :     return true;
     687             : 
     688             :   // If both blocks are identical and end in a branch, merge them unless they
     689             :   // both have a fallthrough predecessor and successor.
     690             :   // We can only do this after block placement because it depends on whether
     691             :   // there are fallthroughs, and we don't know until after layout.
     692      397787 :   if (AfterPlacement && I1 == MBB1->begin() && I2 == MBB2->begin()) {
     693         146 :     auto BothFallThrough = [](MachineBasicBlock *MBB) {
     694         146 :       if (MBB->succ_size() != 0 && !MBB->canFallThrough())
     695             :         return false;
     696             :       MachineFunction::iterator I(MBB);
     697           0 :       MachineFunction *MF = MBB->getParent();
     698           0 :       return (MBB != &*MF->begin()) && std::prev(I)->canFallThrough();
     699             :     };
     700         146 :     if (!BothFallThrough(MBB1) || !BothFallThrough(MBB2))
     701             :       return true;
     702             :   }
     703             : 
     704             :   // If both blocks have an unconditional branch temporarily stripped out,
     705             :   // count that as an additional common instruction for the following
     706             :   // heuristics. This heuristic is only accurate for single-succ blocks, so to
     707             :   // make sure that during layout merging and duplicating don't crash, we check
     708             :   // for that when merging during layout.
     709      394362 :   unsigned EffectiveTailLen = CommonTailLen;
     710      445871 :   if (SuccBB && MBB1 != PredBB && MBB2 != PredBB &&
     711       28345 :       (MBB1->succ_size() == 1 || !AfterPlacement) &&
     712      419547 :       !MBB1->back().isBarrier() &&
     713             :       !MBB2->back().isBarrier())
     714       25185 :     ++EffectiveTailLen;
     715             : 
     716             :   // Check if the common tail is long enough to be worthwhile.
     717      394362 :   if (EffectiveTailLen >= MinCommonTailLength)
     718             :     return true;
     719             : 
     720             :   // If we are optimizing for code size, 2 instructions in common is enough if
     721             :   // we don't have to split a block.  At worst we will be introducing 1 new
     722             :   // branch instruction, which is likely to be smaller than the 2
     723             :   // instructions that would be deleted in the merge.
     724      249110 :   MachineFunction *MF = MBB1->getParent();
     725      249176 :   return EffectiveTailLen >= 2 && MF->getFunction().optForSize() &&
     726          50 :          (I1 == MBB1->begin() || I2 == MBB2->begin());
     727             : }
     728             : 
     729      213983 : unsigned BranchFolder::ComputeSameTails(unsigned CurHash,
     730             :                                         unsigned MinCommonTailLength,
     731             :                                         MachineBasicBlock *SuccBB,
     732             :                                         MachineBasicBlock *PredBB) {
     733             :   unsigned maxCommonTailLength = 0U;
     734      213983 :   SameTails.clear();
     735             :   MachineBasicBlock::iterator TrialBBI1, TrialBBI2;
     736             :   MPIterator HighestMPIter = std::prev(MergePotentials.end());
     737             :   for (MPIterator CurMPIter = std::prev(MergePotentials.end()),
     738             :                   B = MergePotentials.begin();
     739      477435 :        CurMPIter != B && CurMPIter->getHash() == CurHash; --CurMPIter) {
     740      889231 :     for (MPIterator I = std::prev(CurMPIter); I->getHash() == CurHash; --I) {
     741             :       unsigned CommonTailLen;
     742      672827 :       if (ProfitableToMerge(CurMPIter->getBlock(), I->getBlock(),
     743             :                             MinCommonTailLength,
     744             :                             CommonTailLen, TrialBBI1, TrialBBI2,
     745             :                             SuccBB, PredBB,
     746             :                             EHScopeMembership,
     747      672827 :                             AfterBlockPlacement)) {
     748      154069 :         if (CommonTailLen > maxCommonTailLength) {
     749             :           SameTails.clear();
     750             :           maxCommonTailLength = CommonTailLen;
     751             :           HighestMPIter = CurMPIter;
     752        6121 :           SameTails.push_back(SameTailElt(CurMPIter, TrialBBI1));
     753             :         }
     754      170573 :         if (HighestMPIter == CurMPIter &&
     755       16504 :             CommonTailLen == maxCommonTailLength)
     756       14923 :           SameTails.push_back(SameTailElt(I, TrialBBI2));
     757             :       }
     758      672827 :       if (I == B)
     759             :         break;
     760             :     }
     761             :   }
     762      213983 :   return maxCommonTailLength;
     763             : }
     764             : 
     765      208328 : void BranchFolder::RemoveBlocksWithHash(unsigned CurHash,
     766             :                                         MachineBasicBlock *SuccBB,
     767             :                                         MachineBasicBlock *PredBB) {
     768             :   MPIterator CurMPIter, B;
     769             :   for (CurMPIter = std::prev(MergePotentials.end()),
     770             :       B = MergePotentials.begin();
     771      445547 :        CurMPIter->getHash() == CurHash; --CurMPIter) {
     772             :     // Put the unconditional branch back, if we need one.
     773      250008 :     MachineBasicBlock *CurMBB = CurMPIter->getBlock();
     774      250008 :     if (SuccBB && CurMBB != PredBB)
     775      128513 :       FixTail(CurMBB, SuccBB, TII);
     776      250008 :     if (CurMPIter == B)
     777             :       break;
     778             :   }
     779      208328 :   if (CurMPIter->getHash() != CurHash)
     780             :     CurMPIter++;
     781             :   MergePotentials.erase(CurMPIter, MergePotentials.end());
     782      208328 : }
     783             : 
     784        3474 : bool BranchFolder::CreateCommonTailOnlyBlock(MachineBasicBlock *&PredBB,
     785             :                                              MachineBasicBlock *SuccBB,
     786             :                                              unsigned maxCommonTailLength,
     787             :                                              unsigned &commonTailIndex) {
     788        3474 :   commonTailIndex = 0;
     789             :   unsigned TimeEstimate = ~0U;
     790       15894 :   for (unsigned i = 0, e = SameTails.size(); i != e; ++i) {
     791             :     // Use PredBB if possible; that doesn't require a new branch.
     792       21312 :     if (SameTails[i].getBlock() == PredBB) {
     793        1710 :       commonTailIndex = i;
     794        1710 :       break;
     795             :     }
     796             :     // Otherwise, make a (fairly bogus) choice based on estimate of
     797             :     // how long it will take the various blocks to execute.
     798             :     unsigned t = EstimateRuntime(SameTails[i].getBlock()->begin(),
     799        8946 :                                  SameTails[i].getTailStartPos());
     800        8946 :     if (t <= TimeEstimate) {
     801             :       TimeEstimate = t;
     802        8637 :       commonTailIndex = i;
     803             :     }
     804             :   }
     805             : 
     806             :   MachineBasicBlock::iterator BBI =
     807        6948 :     SameTails[commonTailIndex].getTailStartPos();
     808             :   MachineBasicBlock *MBB = SameTails[commonTailIndex].getBlock();
     809             : 
     810             :   LLVM_DEBUG(dbgs() << "\nSplitting " << printMBBReference(*MBB) << ", size "
     811             :                     << maxCommonTailLength);
     812             : 
     813             :   // If the split block unconditionally falls-thru to SuccBB, it will be
     814             :   // merged. In control flow terms it should then take SuccBB's name. e.g. If
     815             :   // SuccBB is an inner loop, the common tail is still part of the inner loop.
     816        5610 :   const BasicBlock *BB = (SuccBB && MBB->succ_size() == 1) ?
     817             :     SuccBB->getBasicBlock() : MBB->getBasicBlock();
     818        3474 :   MachineBasicBlock *newMBB = SplitMBBAt(*MBB, BBI, BB);
     819        3474 :   if (!newMBB) {
     820             :     LLVM_DEBUG(dbgs() << "... failed!");
     821             :     return false;
     822             :   }
     823             : 
     824        3474 :   SameTails[commonTailIndex].setBlock(newMBB);
     825             :   SameTails[commonTailIndex].setTailStartPos(newMBB->begin());
     826             : 
     827             :   // If we split PredBB, newMBB is the new predecessor.
     828        3474 :   if (PredBB == MBB)
     829        1710 :     PredBB = newMBB;
     830             : 
     831             :   return true;
     832             : }
     833             : 
     834             : static void
     835       13394 : mergeOperations(MachineBasicBlock::iterator MBBIStartPos,
     836             :                 MachineBasicBlock &MBBCommon) {
     837       13394 :   MachineBasicBlock *MBB = MBBIStartPos->getParent();
     838             :   // Note CommonTailLen does not necessarily matches the size of
     839             :   // the common BB nor all its instructions because of debug
     840             :   // instructions differences.
     841             :   unsigned CommonTailLen = 0;
     842       77169 :   for (auto E = MBB->end(); MBBIStartPos != E; ++MBBIStartPos)
     843       63775 :     ++CommonTailLen;
     844             : 
     845       13394 :   MachineBasicBlock::reverse_iterator MBBI = MBB->rbegin();
     846             :   MachineBasicBlock::reverse_iterator MBBIE = MBB->rend();
     847       13394 :   MachineBasicBlock::reverse_iterator MBBICommon = MBBCommon.rbegin();
     848             :   MachineBasicBlock::reverse_iterator MBBIECommon = MBBCommon.rend();
     849             : 
     850       77169 :   while (CommonTailLen--) {
     851             :     assert(MBBI != MBBIE && "Reached BB end within common tail length!");
     852             :     (void)MBBIE;
     853             : 
     854        3116 :     if (!countsAsInstruction(*MBBI)) {
     855             :       ++MBBI;
     856        3116 :       continue;
     857             :     }
     858             : 
     859       63725 :     while ((MBBICommon != MBBIECommon) && !countsAsInstruction(*MBBICommon))
     860             :       ++MBBICommon;
     861             : 
     862             :     assert(MBBICommon != MBBIECommon &&
     863             :            "Reached BB end within common tail length!");
     864             :     assert(MBBICommon->isIdenticalTo(*MBBI) && "Expected matching MIIs!");
     865             : 
     866             :     // Merge MMOs from memory operations in the common block.
     867      110377 :     if (MBBICommon->mayLoad() || MBBICommon->mayStore())
     868       16344 :       MBBICommon->setMemRefs(MBBICommon->mergeMemRefsWith(*MBBI));
     869             :     // Drop undef flags if they aren't present in all merged instructions.
     870      382551 :     for (unsigned I = 0, E = MBBICommon->getNumOperands(); I != E; ++I) {
     871      321892 :       MachineOperand &MO = MBBICommon->getOperand(I);
     872      553819 :       if (MO.isReg() && MO.isUndef()) {
     873         220 :         const MachineOperand &OtherMO = MBBI->getOperand(I);
     874         220 :         if (!OtherMO.isUndef())
     875             :           MO.setIsUndef(false);
     876             :       }
     877             :     }
     878             : 
     879             :     ++MBBI;
     880             :     ++MBBICommon;
     881             :   }
     882       13394 : }
     883             : 
     884        5655 : void BranchFolder::mergeCommonTails(unsigned commonTailIndex) {
     885        5655 :   MachineBasicBlock *MBB = SameTails[commonTailIndex].getBlock();
     886             : 
     887       11310 :   std::vector<MachineBasicBlock::iterator> NextCommonInsts(SameTails.size());
     888       68457 :   for (unsigned int i = 0 ; i != SameTails.size() ; ++i) {
     889       19049 :     if (i != commonTailIndex) {
     890       26788 :       NextCommonInsts[i] = SameTails[i].getTailStartPos();
     891       13394 :       mergeOperations(SameTails[i].getTailStartPos(), *MBB);
     892             :     } else {
     893             :       assert(SameTails[i].getTailStartPos() == MBB->begin() &&
     894             :           "MBB is not a common tail only block");
     895             :     }
     896             :   }
     897             : 
     898       31280 :   for (auto &MI : *MBB) {
     899        1034 :     if (!countsAsInstruction(MI))
     900        1034 :       continue;
     901             :     DebugLoc DL = MI.getDebugLoc();
     902      276657 :     for (unsigned int i = 0 ; i < NextCommonInsts.size() ; i++) {
     903       79595 :       if (i == commonTailIndex)
     904       18936 :         continue;
     905             : 
     906             :       auto &Pos = NextCommonInsts[i];
     907             :       assert(Pos != SameTails[i].getBlock()->end() &&
     908             :           "Reached BB end within common tail");
     909             :       while (!countsAsInstruction(*Pos)) {
     910             :         ++Pos;
     911             :         assert(Pos != SameTails[i].getBlock()->end() &&
     912             :             "Reached BB end within common tail");
     913             :       }
     914             :       assert(MI.isIdenticalTo(*Pos) && "Expected matching MIIs!");
     915      121318 :       DL = DILocation::getMergedLocation(DL, Pos->getDebugLoc());
     916      121318 :       NextCommonInsts[i] = ++Pos;
     917             :     }
     918       18936 :     MI.setDebugLoc(DL);
     919             :   }
     920             : 
     921        5655 :   if (UpdateLiveIns) {
     922        5633 :     LivePhysRegs NewLiveIns(*TRI);
     923        5633 :     computeLiveIns(NewLiveIns, *MBB);
     924             : 
     925             :     // The flag merging may lead to some register uses no longer using the
     926             :     // <undef> flag, add IMPLICIT_DEFs in the predecessors as necessary.
     927       12454 :     for (MachineBasicBlock *Pred : MBB->predecessors()) {
     928        6821 :       LiveRegs.init(*TRI);
     929        6821 :       LiveRegs.addLiveOuts(*Pred);
     930        6821 :       MachineBasicBlock::iterator InsertBefore = Pred->getFirstTerminator();
     931      173635 :       for (unsigned Reg : NewLiveIns) {
     932       83407 :         if (!LiveRegs.available(*MRI, Reg))
     933       83371 :           continue;
     934          36 :         DebugLoc DL;
     935          72 :         BuildMI(*Pred, InsertBefore, DL, TII->get(TargetOpcode::IMPLICIT_DEF),
     936          36 :                 Reg);
     937             :       }
     938             :     }
     939             : 
     940        5633 :     MBB->clearLiveIns();
     941        5633 :     addLiveIns(*MBB, NewLiveIns);
     942             :   }
     943        5655 : }
     944             : 
     945             : // See if any of the blocks in MergePotentials (which all have SuccBB as a
     946             : // successor, or all have no successor if it is null) can be tail-merged.
     947             : // If there is a successor, any blocks in MergePotentials that are not
     948             : // tail-merged and are not immediately before Succ must have an unconditional
     949             : // branch to Succ added (but the predecessor/successor lists need no
     950             : // adjustment). The lone predecessor of Succ that falls through into Succ,
     951             : // if any, is given in PredBB.
     952             : // MinCommonTailLength - Except for the special cases below, tail-merge if
     953             : // there are at least this many instructions in common.
     954      173601 : bool BranchFolder::TryTailMergeBlocks(MachineBasicBlock *SuccBB,
     955             :                                       MachineBasicBlock *PredBB,
     956             :                                       unsigned MinCommonTailLength) {
     957             :   bool MadeChange = false;
     958             : 
     959             :   LLVM_DEBUG(
     960             :       dbgs() << "\nTryTailMergeBlocks: ";
     961             :       for (unsigned i = 0, e = MergePotentials.size(); i != e; ++i) dbgs()
     962             :       << printMBBReference(*MergePotentials[i].getBlock())
     963             :       << (i == e - 1 ? "" : ", ");
     964             :       dbgs() << "\n"; if (SuccBB) {
     965             :         dbgs() << "  with successor " << printMBBReference(*SuccBB) << '\n';
     966             :         if (PredBB)
     967             :           dbgs() << "  which has fall-through from "
     968             :                  << printMBBReference(*PredBB) << "\n";
     969             :       } dbgs() << "Looking for common tails of at least "
     970             :                << MinCommonTailLength << " instruction"
     971             :                << (MinCommonTailLength == 1 ? "" : "s") << '\n';);
     972             : 
     973             :   // Sort by hash value so that blocks with identical end sequences sort
     974             :   // together.
     975             :   array_pod_sort(MergePotentials.begin(), MergePotentials.end());
     976             : 
     977             :   // Walk through equivalence sets looking for actual exact matches.
     978      775168 :   while (MergePotentials.size() > 1) {
     979      213983 :     unsigned CurHash = MergePotentials.back().getHash();
     980             : 
     981             :     // Build SameTails, identifying the set of blocks with this hash code
     982             :     // and with the maximum number of instructions in common.
     983      213983 :     unsigned maxCommonTailLength = ComputeSameTails(CurHash,
     984             :                                                     MinCommonTailLength,
     985      213983 :                                                     SuccBB, PredBB);
     986             : 
     987             :     // If we didn't find any pair that has at least MinCommonTailLength
     988             :     // instructions in common, remove all blocks with this hash code and retry.
     989      422311 :     if (SameTails.empty()) {
     990      208328 :       RemoveBlocksWithHash(CurHash, SuccBB, PredBB);
     991      416656 :       continue;
     992             :     }
     993             : 
     994             :     // If one of the blocks is the entire common tail (and not the entry
     995             :     // block, which we can't jump to), we can treat all blocks with this same
     996             :     // tail at once.  Use PredBB if that is one of the possibilities, as that
     997             :     // will not introduce any extra branches.
     998             :     MachineBasicBlock *EntryBB =
     999        5655 :         &MergePotentials.front().getBlock()->getParent()->front();
    1000        5655 :     unsigned commonTailIndex = SameTails.size();
    1001             :     // If there are two blocks, check to see if one can be made to fall through
    1002             :     // into the other.
    1003        4432 :     if (SameTails.size() == 2 &&
    1004       10142 :         SameTails[0].getBlock()->isLayoutSuccessor(SameTails[1].getBlock()) &&
    1005          55 :         SameTails[1].tailIsWholeBlock())
    1006          21 :       commonTailIndex = 1;
    1007       10045 :     else if (SameTails.size() == 2 &&
    1008        4411 :              SameTails[1].getBlock()->isLayoutSuccessor(
    1009        7337 :                                                      SameTails[0].getBlock()) &&
    1010        1703 :              SameTails[0].tailIsWholeBlock())
    1011         687 :       commonTailIndex = 0;
    1012             :     else {
    1013             :       // Otherwise just pick one, favoring the fall-through predecessor if
    1014             :       // there is one.
    1015       41601 :       for (unsigned i = 0, e = SameTails.size(); i != e; ++i) {
    1016       15876 :         MachineBasicBlock *MBB = SameTails[i].getBlock();
    1017       15895 :         if (MBB == EntryBB && SameTails[i].tailIsWholeBlock())
    1018           2 :           continue;
    1019       15874 :         if (MBB == PredBB) {
    1020        2496 :           commonTailIndex = i;
    1021        2496 :           break;
    1022             :         }
    1023       13378 :         if (SameTails[i].tailIsWholeBlock())
    1024        3996 :           commonTailIndex = i;
    1025             :       }
    1026             :     }
    1027             : 
    1028       15200 :     if (commonTailIndex == SameTails.size() ||
    1029        6420 :         (SameTails[commonTailIndex].getBlock() == PredBB &&
    1030             :          !SameTails[commonTailIndex].tailIsWholeBlock())) {
    1031             :       // None of the blocks consist entirely of the common tail.
    1032             :       // Split a block so that one does.
    1033        3474 :       if (!CreateCommonTailOnlyBlock(PredBB, SuccBB,
    1034             :                                      maxCommonTailLength, commonTailIndex)) {
    1035           0 :         RemoveBlocksWithHash(CurHash, SuccBB, PredBB);
    1036           0 :         continue;
    1037             :       }
    1038             :     }
    1039             : 
    1040        5655 :     MachineBasicBlock *MBB = SameTails[commonTailIndex].getBlock();
    1041             : 
    1042             :     // Recompute common tail MBB's edge weights and block frequency.
    1043        5655 :     setCommonTailEdgeWeights(*MBB);
    1044             : 
    1045             :     // Merge debug locations, MMOs and undef flags across identical instructions
    1046             :     // for common tail.
    1047        5655 :     mergeCommonTails(commonTailIndex);
    1048             : 
    1049             :     // MBB is common tail.  Adjust all other BB's to jump to this one.
    1050             :     // Traversal must be forwards so erases work.
    1051             :     LLVM_DEBUG(dbgs() << "\nUsing common tail in " << printMBBReference(*MBB)
    1052             :                       << " for ");
    1053       30359 :     for (unsigned int i=0, e = SameTails.size(); i != e; ++i) {
    1054       19049 :       if (commonTailIndex == i)
    1055        5655 :         continue;
    1056             :       LLVM_DEBUG(dbgs() << printMBBReference(*SameTails[i].getBlock())
    1057             :                         << (i == e - 1 ? "" : ", "));
    1058             :       // Hack the end off BB i, making it jump to BB commonTailIndex instead.
    1059       26788 :       replaceTailWithBranchTo(SameTails[i].getTailStartPos(), *MBB);
    1060             :       // BB i is no longer a predecessor of SuccBB; remove it from the worklist.
    1061       13394 :       MergePotentials.erase(SameTails[i].getMPIter());
    1062             :     }
    1063             :     LLVM_DEBUG(dbgs() << "\n");
    1064             :     // We leave commonTailIndex in the worklist in case there are other blocks
    1065             :     // that match it with a smaller number of instructions.
    1066             :     MadeChange = true;
    1067             :   }
    1068      173601 :   return MadeChange;
    1069             : }
    1070             : 
    1071      232226 : bool BranchFolder::TailMergeBlocks(MachineFunction &MF) {
    1072             :   bool MadeChange = false;
    1073      232226 :   if (!EnableTailMerge) return MadeChange;
    1074             : 
    1075             :   // First find blocks with no successors.
    1076             :   // Block placement does not create new tail merging opportunities for these
    1077             :   // blocks.
    1078      213299 :   if (!AfterBlockPlacement) {
    1079      206136 :     MergePotentials.clear();
    1080      839297 :     for (MachineBasicBlock &MBB : MF) {
    1081     1266332 :       if (MergePotentials.size() == TailMergeThreshold)
    1082             :         break;
    1083     1264419 :       if (!TriedMerging.count(&MBB) && MBB.succ_empty())
    1084      460658 :         MergePotentials.push_back(MergePotentialsElt(HashEndOfMBB(MBB), &MBB));
    1085             :     }
    1086             : 
    1087             :     // If this is a large problem, avoid visiting the same basic blocks
    1088             :     // multiple times.
    1089      412272 :     if (MergePotentials.size() == TailMergeThreshold)
    1090         755 :       for (unsigned i = 0, e = MergePotentials.size(); i != e; ++i)
    1091        1500 :         TriedMerging.insert(MergePotentials[i].getBlock());
    1092             : 
    1093             :     // See if we can do any tail merging on those.
    1094      412272 :     if (MergePotentials.size() >= 2)
    1095       10895 :       MadeChange |= TryTailMergeBlocks(nullptr, nullptr, MinCommonTailLength);
    1096             :   }
    1097             : 
    1098             :   // Look at blocks (IBB) with multiple predecessors (PBB).
    1099             :   // We change each predecessor to a canonical form, by
    1100             :   // (1) temporarily removing any unconditional branch from the predecessor
    1101             :   // to IBB, and
    1102             :   // (2) alter conditional branches so they branch to the other block
    1103             :   // not IBB; this may require adding back an unconditional branch to IBB
    1104             :   // later, where there wasn't one coming in.  E.g.
    1105             :   //   Bcc IBB
    1106             :   //   fallthrough to QBB
    1107             :   // here becomes
    1108             :   //   Bncc QBB
    1109             :   // with a conceptual B to IBB after that, which never actually exists.
    1110             :   // With those changes, we see whether the predecessors' tails match,
    1111             :   // and merge them if so.  We change things out of canonical form and
    1112             :   // back to the way they were later in the process.  (OptimizeBranches
    1113             :   // would undo some of this, but we can't use it, because we'd get into
    1114             :   // a compile-time infinite loop repeatedly doing and undoing the same
    1115             :   // transformations.)
    1116             : 
    1117             :   for (MachineFunction::iterator I = std::next(MF.begin()), E = MF.end();
    1118      830785 :        I != E; ++I) {
    1119     1046154 :     if (I->pred_size() < 2) continue;
    1120             :     SmallPtrSet<MachineBasicBlock *, 8> UniquePreds;
    1121             :     MachineBasicBlock *IBB = &*I;
    1122             :     MachineBasicBlock *PredBB = &*std::prev(I);
    1123      194408 :     MergePotentials.clear();
    1124             :     MachineLoop *ML;
    1125             : 
    1126             :     // Bail if merging after placement and IBB is the loop header because
    1127             :     // -- If merging predecessors that belong to the same loop as IBB, the
    1128             :     // common tail of merged predecessors may become the loop top if block
    1129             :     // placement is called again and the predecessors may branch to this common
    1130             :     // tail and require more branches. This can be relaxed if
    1131             :     // MachineBlockPlacement::findBestLoopTop is more flexible.
    1132             :     // --If merging predecessors that do not belong to the same loop as IBB, the
    1133             :     // loop info of IBB's loop and the other loops may be affected. Calling the
    1134             :     // block placement again may make big change to the layout and eliminate the
    1135             :     // reason to do tail merging here.
    1136      194408 :     if (AfterBlockPlacement && MLI) {
    1137             :       ML = MLI->getLoopFor(IBB);
    1138       24574 :       if (ML && IBB == ML->getHeader())
    1139             :         continue;
    1140             :     }
    1141             : 
    1142      645469 :     for (MachineBasicBlock *PBB : I->predecessors()) {
    1143      913310 :       if (MergePotentials.size() == TailMergeThreshold)
    1144             :         break;
    1145             : 
    1146      456651 :       if (TriedMerging.count(PBB))
    1147       54740 :         continue;
    1148             : 
    1149             :       // Skip blocks that loop to themselves, can't tail merge these.
    1150      454430 :       if (PBB == IBB)
    1151        8581 :         continue;
    1152             : 
    1153             :       // Visit each predecessor only once.
    1154      445849 :       if (!UniquePreds.insert(PBB).second)
    1155           0 :         continue;
    1156             : 
    1157             :       // Skip blocks which may jump to a landing pad. Can't tail merge these.
    1158      445849 :       if (PBB->hasEHPadSuccessor())
    1159       38977 :         continue;
    1160             : 
    1161             :       // After block placement, only consider predecessors that belong to the
    1162             :       // same loop as IBB.  The reason is the same as above when skipping loop
    1163             :       // header.
    1164      406872 :       if (AfterBlockPlacement && MLI)
    1165      117789 :         if (ML != MLI->getLoopFor(PBB))
    1166        2672 :           continue;
    1167             : 
    1168      404200 :       MachineBasicBlock *TBB = nullptr, *FBB = nullptr;
    1169             :       SmallVector<MachineOperand, 4> Cond;
    1170      404200 :       if (!TII->analyzeBranch(*PBB, TBB, FBB, Cond, true)) {
    1171             :         // Failing case: IBB is the target of a cbr, and we cannot reverse the
    1172             :         // branch.
    1173             :         SmallVector<MachineOperand, 4> NewCond(Cond);
    1174      401195 :         if (!Cond.empty() && TBB == IBB) {
    1175      105620 :           if (TII->reverseBranchCondition(NewCond))
    1176          68 :             continue;
    1177             :           // This is the QBB case described above
    1178      105552 :           if (!FBB) {
    1179      100365 :             auto Next = ++PBB->getIterator();
    1180      100365 :             if (Next != MF.end())
    1181      100365 :               FBB = &*Next;
    1182             :           }
    1183             :         }
    1184             : 
    1185             :         // Failing case: the only way IBB can be reached from PBB is via
    1186             :         // exception handling.  Happens for landing pads.  Would be nice to have
    1187             :         // a bit in the edge so we didn't have to do all this.
    1188      401127 :         if (IBB->isEHPad()) {
    1189           0 :           MachineFunction::iterator IP = ++PBB->getIterator();
    1190             :           MachineBasicBlock *PredNextBB = nullptr;
    1191           0 :           if (IP != MF.end())
    1192             :             PredNextBB = &*IP;
    1193           0 :           if (!TBB) {
    1194           0 :             if (IBB != PredNextBB)      // fallthrough
    1195           0 :               continue;
    1196           0 :           } else if (FBB) {
    1197           0 :             if (TBB != IBB && FBB != IBB)   // cbr then ubr
    1198           0 :               continue;
    1199           0 :           } else if (Cond.empty()) {
    1200           0 :             if (TBB != IBB)               // ubr
    1201           0 :               continue;
    1202             :           } else {
    1203           0 :             if (TBB != IBB && IBB != PredNextBB)  // cbr
    1204           0 :               continue;
    1205             :           }
    1206             :         }
    1207             : 
    1208             :         // Remove the unconditional branch at the end, if any.
    1209      401127 :         if (TBB && (Cond.empty() || FBB)) {
    1210      240483 :           DebugLoc dl = PBB->findBranchDebugLoc();
    1211      240483 :           TII->removeBranch(*PBB);
    1212      240483 :           if (!Cond.empty())
    1213             :             // reinsert conditional branch only, for now
    1214      216456 :             TII->insertBranch(*PBB, (TBB == IBB) ? FBB : TBB, nullptr,
    1215      108228 :                               NewCond, dl);
    1216             :         }
    1217             : 
    1218      802254 :         MergePotentials.push_back(MergePotentialsElt(HashEndOfMBB(*PBB), PBB));
    1219             :       }
    1220             :     }
    1221             : 
    1222             :     // If this is a large problem, avoid visiting the same basic blocks multiple
    1223             :     // times.
    1224      377636 :     if (MergePotentials.size() == TailMergeThreshold)
    1225         308 :       for (unsigned i = 0, e = MergePotentials.size(); i != e; ++i)
    1226         608 :         TriedMerging.insert(MergePotentials[i].getBlock());
    1227             : 
    1228      377636 :     if (MergePotentials.size() >= 2)
    1229      162706 :       MadeChange |= TryTailMergeBlocks(IBB, PredBB, MinCommonTailLength);
    1230             : 
    1231             :     // Reinsert an unconditional branch if needed. The 1 below can occur as a
    1232             :     // result of removing blocks in TryTailMergeBlocks.
    1233             :     PredBB = &*std::prev(I); // this may have been changed in TryTailMergeBlocks
    1234      541891 :     if (MergePotentials.size() == 1 &&
    1235      164255 :         MergePotentials.begin()->getBlock() != PredBB)
    1236      105562 :       FixTail(MergePotentials.begin()->getBlock(), IBB, TII);
    1237             :   }
    1238             : 
    1239             :   return MadeChange;
    1240             : }
    1241             : 
    1242        5655 : void BranchFolder::setCommonTailEdgeWeights(MachineBasicBlock &TailMBB) {
    1243       11310 :   SmallVector<BlockFrequency, 2> EdgeFreqLs(TailMBB.succ_size());
    1244             :   BlockFrequency AccumulatedMBBFreq;
    1245             : 
    1246             :   // Aggregate edge frequency of successor edge j:
    1247             :   //  edgeFreq(j) = sum (freq(bb) * edgeProb(bb, j)),
    1248             :   //  where bb is a basic block that is in SameTails.
    1249       24704 :   for (const auto &Src : SameTails) {
    1250             :     const MachineBasicBlock *SrcMBB = Src.getBlock();
    1251       19049 :     BlockFrequency BlockFreq = MBBFreqInfo.getBlockFreq(SrcMBB);
    1252       19049 :     AccumulatedMBBFreq += BlockFreq;
    1253             : 
    1254             :     // It is not necessary to recompute edge weights if TailBB has less than two
    1255             :     // successors.
    1256       19049 :     if (TailMBB.succ_size() <= 1)
    1257       17693 :       continue;
    1258             : 
    1259             :     auto EdgeFreq = EdgeFreqLs.begin();
    1260             : 
    1261        2712 :     for (auto SuccI = TailMBB.succ_begin(), SuccE = TailMBB.succ_end();
    1262        4068 :          SuccI != SuccE; ++SuccI, ++EdgeFreq)
    1263        2712 :       *EdgeFreq += BlockFreq * MBPI.getEdgeProbability(SrcMBB, *SuccI);
    1264             :   }
    1265             : 
    1266        5655 :   MBBFreqInfo.setBlockFreq(&TailMBB, AccumulatedMBBFreq);
    1267             : 
    1268        5655 :   if (TailMBB.succ_size() <= 1)
    1269             :     return;
    1270             : 
    1271             :   auto SumEdgeFreq =
    1272             :       std::accumulate(EdgeFreqLs.begin(), EdgeFreqLs.end(), BlockFrequency(0))
    1273             :           .getFrequency();
    1274             :   auto EdgeFreq = EdgeFreqLs.begin();
    1275             : 
    1276         414 :   if (SumEdgeFreq > 0) {
    1277         828 :     for (auto SuccI = TailMBB.succ_begin(), SuccE = TailMBB.succ_end();
    1278        1242 :          SuccI != SuccE; ++SuccI, ++EdgeFreq) {
    1279             :       auto Prob = BranchProbability::getBranchProbability(
    1280         828 :           EdgeFreq->getFrequency(), SumEdgeFreq);
    1281         828 :       TailMBB.setSuccProbability(SuccI, Prob);
    1282             :     }
    1283             :   }
    1284             : }
    1285             : 
    1286             : //===----------------------------------------------------------------------===//
    1287             : //  Branch Optimization
    1288             : //===----------------------------------------------------------------------===//
    1289             : 
    1290      225452 : bool BranchFolder::OptimizeBranches(MachineFunction &MF) {
    1291             :   bool MadeChange = false;
    1292             : 
    1293             :   // Make sure blocks are numbered in order
    1294      225452 :   MF.RenumberBlocks();
    1295             :   // Renumbering blocks alters EH scope membership, recalculate it.
    1296      450904 :   EHScopeMembership = getEHScopeMembership(MF);
    1297             : 
    1298             :   for (MachineFunction::iterator I = std::next(MF.begin()), E = MF.end();
    1299      729154 :        I != E; ) {
    1300             :     MachineBasicBlock *MBB = &*I++;
    1301      503702 :     MadeChange |= OptimizeBlock(MBB);
    1302             : 
    1303             :     // If it is dead, remove it.
    1304      503702 :     if (MBB->pred_empty()) {
    1305       11576 :       RemoveDeadBlock(MBB);
    1306             :       MadeChange = true;
    1307             :       ++NumDeadBlocks;
    1308             :     }
    1309             :   }
    1310             : 
    1311      225452 :   return MadeChange;
    1312             : }
    1313             : 
    1314             : // Blocks should be considered empty if they contain only debug info;
    1315             : // else the debug info would affect codegen.
    1316             : static bool IsEmptyBlock(MachineBasicBlock *MBB) {
    1317     2131692 :   return MBB->getFirstNonDebugInstr() == MBB->end();
    1318             : }
    1319             : 
    1320             : // Blocks with only debug info and branches should be considered the same
    1321             : // as blocks with only branches.
    1322      139153 : static bool IsBranchOnlyBlock(MachineBasicBlock *MBB) {
    1323      139153 :   MachineBasicBlock::iterator I = MBB->getFirstNonDebugInstr();
    1324             :   assert(I != MBB->end() && "empty block!");
    1325      139153 :   return I->isBranch();
    1326             : }
    1327             : 
    1328             : /// IsBetterFallthrough - Return true if it would be clearly better to
    1329             : /// fall-through to MBB1 than to fall through into MBB2.  This has to return
    1330             : /// a strict ordering, returning true for both (MBB1,MBB2) and (MBB2,MBB1) will
    1331             : /// result in infinite loops.
    1332        4183 : static bool IsBetterFallthrough(MachineBasicBlock *MBB1,
    1333             :                                 MachineBasicBlock *MBB2) {
    1334             :   // Right now, we use a simple heuristic.  If MBB2 ends with a call, and
    1335             :   // MBB1 doesn't, we prefer to fall through into MBB1.  This allows us to
    1336             :   // optimize branches that branch to either a return block or an assert block
    1337             :   // into a fallthrough to the return.
    1338        4183 :   MachineBasicBlock::iterator MBB1I = MBB1->getLastNonDebugInstr();
    1339        4183 :   MachineBasicBlock::iterator MBB2I = MBB2->getLastNonDebugInstr();
    1340        8355 :   if (MBB1I == MBB1->end() || MBB2I == MBB2->end())
    1341             :     return false;
    1342             : 
    1343             :   // If there is a clear successor ordering we make sure that one block
    1344             :   // will fall through to the next
    1345        4172 :   if (MBB1->isSuccessor(MBB2)) return true;
    1346        4137 :   if (MBB2->isSuccessor(MBB1)) return false;
    1347             : 
    1348        4915 :   return MBB2I->isCall() && !MBB1I->isCall();
    1349             : }
    1350             : 
    1351             : /// getBranchDebugLoc - Find and return, if any, the DebugLoc of the branch
    1352             : /// instructions on the block.
    1353       15766 : static DebugLoc getBranchDebugLoc(MachineBasicBlock &MBB) {
    1354       15766 :   MachineBasicBlock::iterator I = MBB.getLastNonDebugInstr();
    1355       31532 :   if (I != MBB.end() && I->isBranch())
    1356             :     return I->getDebugLoc();
    1357        2177 :   return DebugLoc();
    1358             : }
    1359             : 
    1360         355 : static void copyDebugInfoToPredecessor(const TargetInstrInfo *TII,
    1361             :                                        MachineBasicBlock &MBB,
    1362             :                                        MachineBasicBlock &PredMBB) {
    1363         355 :   auto InsertBefore = PredMBB.getFirstTerminator();
    1364         359 :   for (MachineInstr &MI : MBB.instrs())
    1365           4 :     if (MI.isDebugValue()) {
    1366           4 :       TII->duplicate(PredMBB, InsertBefore, MI);
    1367             :       LLVM_DEBUG(dbgs() << "Copied debug value from empty block to pred: "
    1368             :                         << MI);
    1369             :     }
    1370         355 : }
    1371             : 
    1372         118 : static void copyDebugInfoToSuccessor(const TargetInstrInfo *TII,
    1373             :                                      MachineBasicBlock &MBB,
    1374             :                                      MachineBasicBlock &SuccMBB) {
    1375         118 :   auto InsertBefore = SuccMBB.SkipPHIsAndLabels(SuccMBB.begin());
    1376         118 :   for (MachineInstr &MI : MBB.instrs())
    1377           0 :     if (MI.isDebugValue()) {
    1378           0 :       TII->duplicate(SuccMBB, InsertBefore, MI);
    1379             :       LLVM_DEBUG(dbgs() << "Copied debug value from empty block to succ: "
    1380             :                         << MI);
    1381             :     }
    1382         118 : }
    1383             : 
    1384             : // Try to salvage DBG_VALUE instructions from an otherwise empty block. If such
    1385             : // a basic block is removed we would lose the debug information unless we have
    1386             : // copied the information to a predecessor/successor.
    1387             : //
    1388             : // TODO: This function only handles some simple cases. An alternative would be
    1389             : // to run a heavier analysis, such as the LiveDebugValues pass, before we do
    1390             : // branch folding.
    1391        4493 : static void salvageDebugInfoFromEmptyBlock(const TargetInstrInfo *TII,
    1392             :                                            MachineBasicBlock &MBB) {
    1393             :   assert(IsEmptyBlock(&MBB) && "Expected an empty block (except debug info).");
    1394             :   // If this MBB is the only predecessor of a successor it is legal to copy
    1395             :   // DBG_VALUE instructions to the beginning of the successor.
    1396        6229 :   for (MachineBasicBlock *SuccBB : MBB.successors())
    1397        1736 :     if (SuccBB->pred_size() == 1)
    1398         118 :       copyDebugInfoToSuccessor(TII, MBB, *SuccBB);
    1399             :   // If this MBB is the only successor of a predecessor it is legal to copy the
    1400             :   // DBG_VALUE instructions to the end of the predecessor (just before the
    1401             :   // terminators, assuming that the terminator isn't affecting the DBG_VALUE).
    1402        8765 :   for (MachineBasicBlock *PredBB : MBB.predecessors())
    1403        4272 :     if (PredBB->succ_size() == 1)
    1404         355 :       copyDebugInfoToPredecessor(TII, MBB, *PredBB);
    1405        4493 : }
    1406             : 
    1407      503702 : bool BranchFolder::OptimizeBlock(MachineBasicBlock *MBB) {
    1408             :   bool MadeChange = false;
    1409      503702 :   MachineFunction &MF = *MBB->getParent();
    1410      537395 : ReoptimizeBlock:
    1411             : 
    1412      537395 :   MachineFunction::iterator FallThrough = MBB->getIterator();
    1413             :   ++FallThrough;
    1414             : 
    1415             :   // Make sure MBB and FallThrough belong to the same EH scope.
    1416             :   bool SameEHScope = true;
    1417      538030 :   if (!EHScopeMembership.empty() && FallThrough != MF.end()) {
    1418         515 :     auto MBBEHScope = EHScopeMembership.find(MBB);
    1419             :     assert(MBBEHScope != EHScopeMembership.end());
    1420         515 :     auto FallThroughEHScope = EHScopeMembership.find(&*FallThrough);
    1421             :     assert(FallThroughEHScope != EHScopeMembership.end());
    1422         515 :     SameEHScope = MBBEHScope->second == FallThroughEHScope->second;
    1423             :   }
    1424             : 
    1425             :   // If this block is empty, make everyone use its fall-through, not the block
    1426             :   // explicitly.  Landing pads should not do this since the landing-pad table
    1427             :   // points to this block.  Blocks with their addresses taken shouldn't be
    1428             :   // optimized away.
    1429      537395 :   if (IsEmptyBlock(MBB) && !MBB->isEHPad() && !MBB->hasAddressTaken() &&
    1430             :       SameEHScope) {
    1431        4493 :     salvageDebugInfoFromEmptyBlock(TII, *MBB);
    1432             :     // Dead block?  Leave for cleanup later.
    1433        4493 :     if (MBB->pred_empty()) return MadeChange;
    1434             : 
    1435        3736 :     if (FallThrough == MF.end()) {
    1436             :       // TODO: Simplify preds to not branch here if possible!
    1437        3528 :     } else if (FallThrough->isEHPad()) {
    1438             :       // Don't rewrite to a landing pad fallthough.  That could lead to the case
    1439             :       // where a BB jumps to more than one landing pad.
    1440             :       // TODO: Is it ever worth rewriting predecessors which don't already
    1441             :       // jump to a landing pad, and so can safely jump to the fallthrough?
    1442        3424 :     } else if (MBB->isSuccessor(&*FallThrough)) {
    1443             :       // Rewrite all predecessors of the old block to go to the fallthrough
    1444             :       // instead.
    1445        5914 :       while (!MBB->pred_empty()) {
    1446        2089 :         MachineBasicBlock *Pred = *(MBB->pred_end()-1);
    1447        2089 :         Pred->ReplaceUsesOfBlockWith(MBB, &*FallThrough);
    1448             :       }
    1449             :       // If MBB was the target of a jump table, update jump tables to go to the
    1450             :       // fallthrough instead.
    1451        1736 :       if (MachineJumpTableInfo *MJTI = MF.getJumpTableInfo())
    1452         231 :         MJTI->ReplaceMBBInJumpTables(MBB, &*FallThrough);
    1453             :       MadeChange = true;
    1454             :     }
    1455             :     return MadeChange;
    1456             :   }
    1457             : 
    1458             :   // Check to see if we can simplify the terminator of the block before this
    1459             :   // one.
    1460             :   MachineBasicBlock &PrevBB = *std::prev(MachineFunction::iterator(MBB));
    1461             : 
    1462      532902 :   MachineBasicBlock *PriorTBB = nullptr, *PriorFBB = nullptr;
    1463             :   SmallVector<MachineOperand, 4> PriorCond;
    1464             :   bool PriorUnAnalyzable =
    1465      532902 :       TII->analyzeBranch(PrevBB, PriorTBB, PriorFBB, PriorCond, true);
    1466      532902 :   if (!PriorUnAnalyzable) {
    1467             :     // If the CFG for the prior block has extra edges, remove them.
    1468      515776 :     MadeChange |= PrevBB.CorrectExtraCFGEdges(PriorTBB, PriorFBB,
    1469      515776 :                                               !PriorCond.empty());
    1470             : 
    1471             :     // If the previous branch is conditional and both conditions go to the same
    1472             :     // destination, remove the branch, replacing it with an unconditional one or
    1473             :     // a fall-through.
    1474      515776 :     if (PriorTBB && PriorTBB == PriorFBB) {
    1475          13 :       DebugLoc dl = getBranchDebugLoc(PrevBB);
    1476          13 :       TII->removeBranch(PrevBB);
    1477             :       PriorCond.clear();
    1478          13 :       if (PriorTBB != MBB)
    1479           6 :         TII->insertBranch(PrevBB, PriorTBB, nullptr, PriorCond, dl);
    1480             :       MadeChange = true;
    1481             :       ++NumBranchOpts;
    1482             :       goto ReoptimizeBlock;
    1483             :     }
    1484             : 
    1485             :     // If the previous block unconditionally falls through to this block and
    1486             :     // this block has no other predecessors, move the contents of this block
    1487             :     // into the prior block. This doesn't usually happen when SimplifyCFG
    1488             :     // has been used, but it can happen if tail merging splits a fall-through
    1489             :     // predecessor of a block.
    1490             :     // This has to check PrevBB->succ_size() because EH edges are ignored by
    1491             :     // AnalyzeBranch.
    1492     1211681 :     if (PriorCond.empty() && !PriorTBB && MBB->pred_size() == 1 &&
    1493        3807 :         PrevBB.succ_size() == 1 &&
    1494      523309 :         !MBB->hasAddressTaken() && !MBB->isEHPad()) {
    1495             :       LLVM_DEBUG(dbgs() << "\nMerging into block: " << PrevBB
    1496             :                         << "From MBB: " << *MBB);
    1497             :       // Remove redundant DBG_VALUEs first.
    1498        3739 :       if (PrevBB.begin() != PrevBB.end()) {
    1499        3586 :         MachineBasicBlock::iterator PrevBBIter = PrevBB.end();
    1500             :         --PrevBBIter;
    1501        3586 :         MachineBasicBlock::iterator MBBIter = MBB->begin();
    1502             :         // Check if DBG_VALUE at the end of PrevBB is identical to the
    1503             :         // DBG_VALUE at the beginning of MBB.
    1504        1859 :         while (PrevBBIter != PrevBB.begin() && MBBIter != MBB->end()
    1505        3587 :                && PrevBBIter->isDebugInstr() && MBBIter->isDebugInstr()) {
    1506           1 :           if (!MBBIter->isIdenticalTo(*PrevBBIter))
    1507             :             break;
    1508             :           MachineInstr &DuplicateDbg = *MBBIter;
    1509             :           ++MBBIter; -- PrevBBIter;
    1510           1 :           DuplicateDbg.eraseFromParent();
    1511             :         }
    1512             :       }
    1513             :       PrevBB.splice(PrevBB.end(), MBB, MBB->begin(), MBB->end());
    1514        3739 :       PrevBB.removeSuccessor(PrevBB.succ_begin());
    1515             :       assert(PrevBB.succ_empty());
    1516        3739 :       PrevBB.transferSuccessors(MBB);
    1517             :       MadeChange = true;
    1518        3739 :       return MadeChange;
    1519             :     }
    1520             : 
    1521             :     // If the previous branch *only* branches to *this* block (conditional or
    1522             :     // not) remove the branch.
    1523      513367 :     if (PriorTBB == MBB && !PriorFBB) {
    1524         661 :       TII->removeBranch(PrevBB);
    1525             :       MadeChange = true;
    1526             :       ++NumBranchOpts;
    1527             :       goto ReoptimizeBlock;
    1528             :     }
    1529             : 
    1530             :     // If the prior block branches somewhere else on the condition and here if
    1531             :     // the condition is false, remove the uncond second branch.
    1532      511363 :     if (PriorFBB == MBB) {
    1533        2375 :       DebugLoc dl = getBranchDebugLoc(PrevBB);
    1534        2375 :       TII->removeBranch(PrevBB);
    1535        4750 :       TII->insertBranch(PrevBB, PriorTBB, nullptr, PriorCond, dl);
    1536             :       MadeChange = true;
    1537             :       ++NumBranchOpts;
    1538             :       goto ReoptimizeBlock;
    1539             :     }
    1540             : 
    1541             :     // If the prior block branches here on true and somewhere else on false, and
    1542             :     // if the branch condition is reversible, reverse the branch to create a
    1543             :     // fall-through.
    1544      508988 :     if (PriorTBB == MBB) {
    1545             :       SmallVector<MachineOperand, 4> NewPriorCond(PriorCond);
    1546         682 :       if (!TII->reverseBranchCondition(NewPriorCond)) {
    1547         678 :         DebugLoc dl = getBranchDebugLoc(PrevBB);
    1548         678 :         TII->removeBranch(PrevBB);
    1549        1356 :         TII->insertBranch(PrevBB, PriorFBB, nullptr, NewPriorCond, dl);
    1550             :         MadeChange = true;
    1551             :         ++NumBranchOpts;
    1552             :         goto ReoptimizeBlock;
    1553             :       }
    1554             :     }
    1555             : 
    1556             :     // If this block has no successors (e.g. it is a return block or ends with
    1557             :     // a call to a no-return function like abort or __cxa_throw) and if the pred
    1558             :     // falls through into this block, and if it would otherwise fall through
    1559             :     // into the block after this, move this block to the end of the function.
    1560             :     //
    1561             :     // We consider it more likely that execution will stay in the function (e.g.
    1562             :     // due to loops) than it is to exit it.  This asserts in loops etc, moving
    1563             :     // the assert condition out of the loop body.
    1564       56729 :     if (MBB->succ_empty() && !PriorCond.empty() && !PriorFBB &&
    1565      528879 :         MachineFunction::iterator(PriorTBB) == FallThrough &&
    1566        5856 :         !MBB->canFallThrough()) {
    1567             :       bool DoTransform = true;
    1568             : 
    1569             :       // We have to be careful that the succs of PredBB aren't both no-successor
    1570             :       // blocks.  If neither have successors and if PredBB is the second from
    1571             :       // last block in the function, we'd just keep swapping the two blocks for
    1572             :       // last.  Only do the swap if one is clearly better to fall through than
    1573             :       // the other.
    1574       10039 :       if (FallThrough == --MF.end() &&
    1575        4183 :           !IsBetterFallthrough(PriorTBB, MBB))
    1576             :         DoTransform = false;
    1577             : 
    1578             :       if (DoTransform) {
    1579             :         // Reverse the branch so we will fall through on the previous true cond.
    1580             :         SmallVector<MachineOperand, 4> NewPriorCond(PriorCond);
    1581        2305 :         if (!TII->reverseBranchCondition(NewPriorCond)) {
    1582             :           LLVM_DEBUG(dbgs() << "\nMoving MBB: " << *MBB
    1583             :                             << "To make fallthrough to: " << *PriorTBB << "\n");
    1584             : 
    1585        2305 :           DebugLoc dl = getBranchDebugLoc(PrevBB);
    1586        2305 :           TII->removeBranch(PrevBB);
    1587        4610 :           TII->insertBranch(PrevBB, MBB, nullptr, NewPriorCond, dl);
    1588             : 
    1589             :           // Move this block to the end of the function.
    1590        2305 :           MBB->moveAfter(&MF.back());
    1591             :           MadeChange = true;
    1592             :           ++NumBranchOpts;
    1593             :           return MadeChange;
    1594             :         }
    1595             :       }
    1596             :     }
    1597             :   }
    1598             : 
    1599     1404538 :   if (!IsEmptyBlock(MBB) && MBB->pred_size() == 1 &&
    1600      358294 :       MF.getFunction().optForSize()) {
    1601             :     // Changing "Jcc foo; foo: jmp bar;" into "Jcc bar;" might change the branch
    1602             :     // direction, thereby defeating careful block placement and regressing
    1603             :     // performance. Therefore, only consider this for optsize functions.
    1604        2850 :     MachineInstr &TailCall = *MBB->getFirstNonDebugInstr();
    1605        1425 :     if (TII->isUnconditionalTailCall(TailCall)) {
    1606          41 :       MachineBasicBlock *Pred = *MBB->pred_begin();
    1607          41 :       MachineBasicBlock *PredTBB = nullptr, *PredFBB = nullptr;
    1608             :       SmallVector<MachineOperand, 4> PredCond;
    1609             :       bool PredAnalyzable =
    1610          41 :           !TII->analyzeBranch(*Pred, PredTBB, PredFBB, PredCond, true);
    1611             : 
    1612          68 :       if (PredAnalyzable && !PredCond.empty() && PredTBB == MBB &&
    1613          27 :           PredTBB != PredFBB) {
    1614             :         // The predecessor has a conditional branch to this block which consists
    1615             :         // of only a tail call. Try to fold the tail call into the conditional
    1616             :         // branch.
    1617          26 :         if (TII->canMakeTailCallConditional(PredCond, TailCall)) {
    1618             :           // TODO: It would be nice if analyzeBranch() could provide a pointer
    1619             :           // to the branch instruction so replaceBranchWithTailCall() doesn't
    1620             :           // have to search for it.
    1621          26 :           TII->replaceBranchWithTailCall(*Pred, PredCond, TailCall);
    1622             :           ++NumTailCalls;
    1623          26 :           Pred->removeSuccessor(MBB);
    1624             :           MadeChange = true;
    1625             :           return MadeChange;
    1626             :         }
    1627             :       }
    1628             :       // If the predecessor is falling through to this block, we could reverse
    1629             :       // the branch condition and fold the tail call into that. However, after
    1630             :       // that we might have to re-arrange the CFG to fall through to the other
    1631             :       // block and there is a high risk of regressing code size rather than
    1632             :       // improving it.
    1633             :     }
    1634             :   }
    1635             : 
    1636             :   // Analyze the branch in the current block.
    1637      523105 :   MachineBasicBlock *CurTBB = nullptr, *CurFBB = nullptr;
    1638             :   SmallVector<MachineOperand, 4> CurCond;
    1639             :   bool CurUnAnalyzable =
    1640      523105 :       TII->analyzeBranch(*MBB, CurTBB, CurFBB, CurCond, true);
    1641      523105 :   if (!CurUnAnalyzable) {
    1642             :     // If the CFG for the prior block has extra edges, remove them.
    1643      486155 :     MadeChange |= MBB->CorrectExtraCFGEdges(CurTBB, CurFBB, !CurCond.empty());
    1644             : 
    1645             :     // If this is a two-way branch, and the FBB branches to this block, reverse
    1646             :     // the condition so the single-basic-block loop is faster.  Instead of:
    1647             :     //    Loop: xxx; jcc Out; jmp Loop
    1648             :     // we want:
    1649             :     //    Loop: xxx; jncc Loop; jmp Out
    1650      486155 :     if (CurTBB && CurFBB && CurFBB == MBB && CurTBB != MBB) {
    1651             :       SmallVector<MachineOperand, 4> NewCond(CurCond);
    1652          35 :       if (!TII->reverseBranchCondition(NewCond)) {
    1653          35 :         DebugLoc dl = getBranchDebugLoc(*MBB);
    1654          35 :         TII->removeBranch(*MBB);
    1655          70 :         TII->insertBranch(*MBB, CurFBB, CurTBB, NewCond, dl);
    1656             :         MadeChange = true;
    1657             :         ++NumBranchOpts;
    1658             :         goto ReoptimizeBlock;
    1659             :       }
    1660             :     }
    1661             : 
    1662             :     // If this branch is the only thing in its block, see if we can forward
    1663             :     // other blocks across it.
    1664      895464 :     if (CurTBB && CurCond.empty() && !CurFBB &&
    1665      150202 :         IsBranchOnlyBlock(MBB) && CurTBB != MBB &&
    1666      496793 :         !MBB->hasAddressTaken() && !MBB->isEHPad()) {
    1667        5320 :       DebugLoc dl = getBranchDebugLoc(*MBB);
    1668             :       // This block may contain just an unconditional branch.  Because there can
    1669             :       // be 'non-branch terminators' in the block, try removing the branch and
    1670             :       // then seeing if the block is empty.
    1671        5320 :       TII->removeBranch(*MBB);
    1672             :       // If the only things remaining in the block are debug info, remove these
    1673             :       // as well, so this will behave the same as an empty block in non-debug
    1674             :       // mode.
    1675        5320 :       if (IsEmptyBlock(MBB)) {
    1676             :         // Make the block empty, losing the debug info (we could probably
    1677             :         // improve this in some cases.)
    1678             :         MBB->erase(MBB->begin(), MBB->end());
    1679             :       }
    1680             :       // If this block is just an unconditional branch to CurTBB, we can
    1681             :       // usually completely eliminate the block.  The only case we cannot
    1682             :       // completely eliminate the block is when the block before this one
    1683             :       // falls through into MBB and we can't understand the prior block's branch
    1684             :       // condition.
    1685        5320 :       if (MBB->empty()) {
    1686        5320 :         bool PredHasNoFallThrough = !PrevBB.canFallThrough();
    1687        5322 :         if (PredHasNoFallThrough || !PriorUnAnalyzable ||
    1688           2 :             !PrevBB.isSuccessor(MBB)) {
    1689             :           // If the prior block falls through into us, turn it into an
    1690             :           // explicit branch to us to make updates simpler.
    1691       10010 :           if (!PredHasNoFallThrough && PrevBB.isSuccessor(MBB) &&
    1692       15328 :               PriorTBB != MBB && PriorFBB != MBB) {
    1693        5005 :             if (!PriorTBB) {
    1694             :               assert(PriorCond.empty() && !PriorFBB &&
    1695             :                      "Bad branch analysis");
    1696        2177 :               PriorTBB = MBB;
    1697             :             } else {
    1698             :               assert(!PriorFBB && "Machine CFG out of date!");
    1699        2828 :               PriorFBB = MBB;
    1700             :             }
    1701        5005 :             DebugLoc pdl = getBranchDebugLoc(PrevBB);
    1702        5005 :             TII->removeBranch(PrevBB);
    1703       10010 :             TII->insertBranch(PrevBB, PriorTBB, PriorFBB, PriorCond, pdl);
    1704             :           }
    1705             : 
    1706             :           // Iterate through all the predecessors, revectoring each in-turn.
    1707             :           size_t PI = 0;
    1708             :           bool DidChange = false;
    1709             :           bool HasBranchToSelf = false;
    1710       12348 :           while(PI != MBB->pred_size()) {
    1711        7030 :             MachineBasicBlock *PMBB = *(MBB->pred_begin() + PI);
    1712        7030 :             if (PMBB == MBB) {
    1713             :               // If this block has an uncond branch to itself, leave it.
    1714           0 :               ++PI;
    1715             :               HasBranchToSelf = true;
    1716             :             } else {
    1717             :               DidChange = true;
    1718        7030 :               PMBB->ReplaceUsesOfBlockWith(MBB, CurTBB);
    1719             :               // If this change resulted in PMBB ending in a conditional
    1720             :               // branch where both conditions go to the same destination,
    1721             :               // change this to an unconditional branch (and fix the CFG).
    1722        7030 :               MachineBasicBlock *NewCurTBB = nullptr, *NewCurFBB = nullptr;
    1723             :               SmallVector<MachineOperand, 4> NewCurCond;
    1724        7030 :               bool NewCurUnAnalyzable = TII->analyzeBranch(
    1725        7030 :                   *PMBB, NewCurTBB, NewCurFBB, NewCurCond, true);
    1726        7030 :               if (!NewCurUnAnalyzable && NewCurTBB && NewCurTBB == NewCurFBB) {
    1727          35 :                 DebugLoc pdl = getBranchDebugLoc(*PMBB);
    1728          35 :                 TII->removeBranch(*PMBB);
    1729             :                 NewCurCond.clear();
    1730          70 :                 TII->insertBranch(*PMBB, NewCurTBB, nullptr, NewCurCond, pdl);
    1731             :                 MadeChange = true;
    1732             :                 ++NumBranchOpts;
    1733          35 :                 PMBB->CorrectExtraCFGEdges(NewCurTBB, nullptr, false);
    1734             :               }
    1735             :             }
    1736             :           }
    1737             : 
    1738             :           // Change any jumptables to go to the new MBB.
    1739        5318 :           if (MachineJumpTableInfo *MJTI = MF.getJumpTableInfo())
    1740         160 :             MJTI->ReplaceMBBInJumpTables(MBB, CurTBB);
    1741        5318 :           if (DidChange) {
    1742             :             ++NumBranchOpts;
    1743             :             MadeChange = true;
    1744        5318 :             if (!HasBranchToSelf) return MadeChange;
    1745             :           }
    1746             :         }
    1747             :       }
    1748             : 
    1749             :       // Add the branch back if the block is more than just an uncond branch.
    1750           4 :       TII->insertBranch(*MBB, CurTBB, nullptr, CurCond, dl);
    1751             :     }
    1752             :   }
    1753             : 
    1754             :   // If the prior block doesn't fall through into this block, and if this
    1755             :   // block doesn't fall through into some other block, see if we can find a
    1756             :   // place to move this block where a fall-through will happen.
    1757      517752 :   if (!PrevBB.canFallThrough()) {
    1758             :     // Now we know that there was no fall-through into this block, check to
    1759             :     // see if it has a fall-through into its successor.
    1760      160328 :     bool CurFallsThru = MBB->canFallThrough();
    1761             : 
    1762      160328 :     if (!MBB->isEHPad()) {
    1763             :       // Check all the predecessors of this block.  If one of them has no fall
    1764             :       // throughs, move this block right after it.
    1765      138492 :       for (MachineBasicBlock *PredBB : MBB->predecessors()) {
    1766             :         // Analyze the branch at the end of the pred.
    1767       88687 :         MachineBasicBlock *PredTBB = nullptr, *PredFBB = nullptr;
    1768             :         SmallVector<MachineOperand, 4> PredCond;
    1769      123010 :         if (PredBB != MBB && !PredBB->canFallThrough() &&
    1770       64017 :             !TII->analyzeBranch(*PredBB, PredTBB, PredFBB, PredCond, true) &&
    1771      108417 :             (!CurFallsThru || !CurTBB || !CurFBB) &&
    1772       19716 :             (!CurFallsThru || MBB->getNumber() >= PredBB->getNumber())) {
    1773             :           // If the current block doesn't fall through, just move it.
    1774             :           // If the current block can fall through and does not end with a
    1775             :           // conditional branch, we need to append an unconditional jump to
    1776             :           // the (current) next block.  To avoid a possible compile-time
    1777             :           // infinite loop, move blocks only backward in this case.
    1778             :           // Also, if there are already 2 branches here, we cannot add a third;
    1779             :           // this means we have the case
    1780             :           // Bcc next
    1781             :           // B elsewhere
    1782             :           // next:
    1783       28399 :           if (CurFallsThru) {
    1784             :             MachineBasicBlock *NextBB = &*std::next(MBB->getIterator());
    1785             :             CurCond.clear();
    1786       56013 :             TII->insertBranch(*MBB, NextBB, nullptr, CurCond, DebugLoc());
    1787             :           }
    1788       28399 :           MBB->moveAfter(PredBB);
    1789             :           MadeChange = true;
    1790             :           goto ReoptimizeBlock;
    1791             :         }
    1792             :       }
    1793             :     }
    1794             : 
    1795      131929 :     if (!CurFallsThru) {
    1796             :       // Check all successors to see if we can move this block before it.
    1797      133150 :       for (MachineBasicBlock *SuccBB : MBB->successors()) {
    1798             :         // Analyze the branch at the end of the block before the succ.
    1799       61798 :         MachineFunction::iterator SuccPrev = --SuccBB->getIterator();
    1800             : 
    1801             :         // If this block doesn't already fall-through to that successor, and if
    1802             :         // the succ doesn't already have a block that can fall through into it,
    1803             :         // and if the successor isn't an EH destination, we can arrange for the
    1804             :         // fallthrough to happen.
    1805      123099 :         if (SuccBB != MBB && &*SuccPrev != MBB &&
    1806      127585 :             !SuccPrev->canFallThrough() && !CurUnAnalyzable &&
    1807        1702 :             !SuccBB->isEHPad()) {
    1808        1532 :           MBB->moveBefore(SuccBB);
    1809             :           MadeChange = true;
    1810             :           goto ReoptimizeBlock;
    1811             :         }
    1812             :       }
    1813             : 
    1814             :       // Okay, there is no really great place to put this block.  If, however,
    1815             :       // the block before this one would be a fall-through if this block were
    1816             :       // removed, move this block to the end of the function. There is no real
    1817             :       // advantage in "falling through" to an EH block, so we don't want to
    1818             :       // perform this transformation for that case.
    1819             :       //
    1820             :       // Also, Windows EH introduced the possibility of an arbitrary number of
    1821             :       // successors to a given block.  The analyzeBranch call does not consider
    1822             :       // exception handling and so we can get in a state where a block
    1823             :       // containing a call is followed by multiple EH blocks that would be
    1824             :       // rotated infinitely at the end of the function if the transformation
    1825             :       // below were performed for EH "FallThrough" blocks.  Therefore, even if
    1826             :       // that appears not to be happening anymore, we should assume that it is
    1827             :       // possible and not remove the "!FallThrough()->isEHPad" condition below.
    1828       71352 :       MachineBasicBlock *PrevTBB = nullptr, *PrevFBB = nullptr;
    1829             :       SmallVector<MachineOperand, 4> PrevCond;
    1830       60628 :       if (FallThrough != MF.end() &&
    1831       77889 :           !FallThrough->isEHPad() &&
    1832      103394 :           !TII->analyzeBranch(PrevBB, PrevTBB, PrevFBB, PrevCond, true) &&
    1833       14781 :           PrevBB.isSuccessor(&*FallThrough)) {
    1834        3331 :         MBB->moveAfter(&MF.back());
    1835             :         MadeChange = true;
    1836             :         return MadeChange;
    1837             :       }
    1838             :     }
    1839             :   }
    1840             : 
    1841             :   return MadeChange;
    1842             : }
    1843             : 
    1844             : //===----------------------------------------------------------------------===//
    1845             : //  Hoist Common Code
    1846             : //===----------------------------------------------------------------------===//
    1847             : 
    1848           0 : bool BranchFolder::HoistCommonCode(MachineFunction &MF) {
    1849             :   bool MadeChange = false;
    1850      792494 :   for (MachineFunction::iterator I = MF.begin(), E = MF.end(); I != E; ) {
    1851             :     MachineBasicBlock *MBB = &*I++;
    1852      602808 :     MadeChange |= HoistCommonCodeInSuccs(MBB);
    1853             :   }
    1854             : 
    1855           0 :   return MadeChange;
    1856             : }
    1857             : 
    1858             : /// findFalseBlock - BB has a fallthrough. Find its 'false' successor given
    1859             : /// its 'true' successor.
    1860             : static MachineBasicBlock *findFalseBlock(MachineBasicBlock *BB,
    1861             :                                          MachineBasicBlock *TrueBB) {
    1862      168220 :   for (MachineBasicBlock *SuccBB : BB->successors())
    1863      168192 :     if (SuccBB != TrueBB)
    1864             :       return SuccBB;
    1865             :   return nullptr;
    1866             : }
    1867             : 
    1868             : template <class Container>
    1869      113916 : static void addRegAndItsAliases(unsigned Reg, const TargetRegisterInfo *TRI,
    1870             :                                 Container &Set) {
    1871      227832 :   if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
    1872     1207696 :     for (MCRegAliasIterator AI(Reg, TRI, true); AI.isValid(); ++AI)
    1873      490180 :       Set.insert(*AI);
    1874             :   } else {
    1875         248 :     Set.insert(Reg);
    1876             :   }
    1877      113916 : }
    1878             : 
    1879             : /// findHoistingInsertPosAndDeps - Find the location to move common instructions
    1880             : /// in successors to. The location is usually just before the terminator,
    1881             : /// however if the terminator is a conditional branch and its previous
    1882             : /// instruction is the flag setting instruction, the previous instruction is
    1883             : /// the preferred location. This function also gathers uses and defs of the
    1884             : /// instructions from the insertion point to the end of the block. The data is
    1885             : /// used by HoistCommonCodeInSuccs to ensure safety.
    1886             : static
    1887       35696 : MachineBasicBlock::iterator findHoistingInsertPosAndDeps(MachineBasicBlock *MBB,
    1888             :                                                   const TargetInstrInfo *TII,
    1889             :                                                   const TargetRegisterInfo *TRI,
    1890             :                                                   SmallSet<unsigned,4> &Uses,
    1891             :                                                   SmallSet<unsigned,4> &Defs) {
    1892       35696 :   MachineBasicBlock::iterator Loc = MBB->getFirstTerminator();
    1893       35696 :   if (!TII->isUnpredicatedTerminator(*Loc))
    1894             :     return MBB->end();
    1895             : 
    1896      185534 :   for (const MachineOperand &MO : Loc->operands()) {
    1897       75474 :     if (!MO.isReg())
    1898       38811 :       continue;
    1899       36663 :     unsigned Reg = MO.getReg();
    1900       36663 :     if (!Reg)
    1901           0 :       continue;
    1902       36663 :     if (MO.isUse()) {
    1903       35898 :       addRegAndItsAliases(Reg, TRI, Uses);
    1904             :     } else {
    1905         765 :       if (!MO.isDead())
    1906             :         // Don't try to hoist code in the rare case the terminator defines a
    1907             :         // register that is later used.
    1908             :         return MBB->end();
    1909             : 
    1910             :       // If the terminator defines a register, make sure we don't hoist
    1911             :       // the instruction whose def might be clobbered by the terminator.
    1912         210 :       addRegAndItsAliases(Reg, TRI, Defs);
    1913             :     }
    1914             :   }
    1915             : 
    1916             :   if (Uses.empty())
    1917           0 :     return Loc;
    1918             :   // If the terminator is the only instruction in the block and Uses is not
    1919             :   // empty (or we would have returned above), we can still safely hoist
    1920             :   // instructions just before the terminator as long as the Defs/Uses are not
    1921             :   // violated (which is checked in HoistCommonCodeInSuccs).
    1922       35141 :   if (Loc == MBB->begin())
    1923         485 :     return Loc;
    1924             : 
    1925             :   // The terminator is probably a conditional branch, try not to separate the
    1926             :   // branch from condition setting instruction.
    1927             :   MachineBasicBlock::iterator PI =
    1928       34656 :     skipDebugInstructionsBackward(std::prev(Loc), MBB->begin());
    1929             : 
    1930             :   bool IsDef = false;
    1931      222612 :   for (const MachineOperand &MO : PI->operands()) {
    1932             :     // If PI has a regmask operand, it is probably a call. Separate away.
    1933      124343 :     if (MO.isRegMask())
    1934           2 :       return Loc;
    1935      316603 :     if (!MO.isReg() || MO.isUse())
    1936      184222 :       continue;
    1937       32230 :     unsigned Reg = MO.getReg();
    1938       32230 :     if (!Reg)
    1939           0 :       continue;
    1940       32230 :     if (Uses.count(Reg)) {
    1941             :       IsDef = true;
    1942       30363 :       break;
    1943             :     }
    1944             :   }
    1945             :   if (!IsDef)
    1946             :     // The condition setting instruction is not just before the conditional
    1947             :     // branch.
    1948        4291 :     return Loc;
    1949             : 
    1950             :   // Be conservative, don't insert instruction above something that may have
    1951             :   // side-effects. And since it's potentially bad to separate flag setting
    1952             :   // instruction from the conditional branch, just abort the optimization
    1953             :   // completely.
    1954             :   // Also avoid moving code above predicated instruction since it's hard to
    1955             :   // reason about register liveness with predicated instruction.
    1956       30363 :   bool DontMoveAcrossStore = true;
    1957       58765 :   if (!PI->isSafeToMove(nullptr, DontMoveAcrossStore) || TII->isPredicated(*PI))
    1958             :     return MBB->end();
    1959             : 
    1960             :   // Find out what registers are live. Note this routine is ignoring other live
    1961             :   // registers which are only used by instructions in successor blocks.
    1962      209170 :   for (const MachineOperand &MO : PI->operands()) {
    1963       90385 :     if (!MO.isReg())
    1964       24224 :       continue;
    1965       79012 :     unsigned Reg = MO.getReg();
    1966       79012 :     if (!Reg)
    1967        1478 :       continue;
    1968       77534 :     if (MO.isUse()) {
    1969       48210 :       addRegAndItsAliases(Reg, TRI, Uses);
    1970             :     } else {
    1971       29324 :       if (Uses.erase(Reg)) {
    1972       56804 :         if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
    1973       58785 :           for (MCSubRegIterator SubRegs(Reg, TRI); SubRegs.isValid(); ++SubRegs)
    1974        2049 :             Uses.erase(*SubRegs); // Use sub-registers to be conservative
    1975             :         }
    1976             :       }
    1977       29324 :       addRegAndItsAliases(Reg, TRI, Defs);
    1978             :     }
    1979             :   }
    1980             : 
    1981       28400 :   return PI;
    1982             : }
    1983             : 
    1984      602808 : bool BranchFolder::HoistCommonCodeInSuccs(MachineBasicBlock *MBB) {
    1985      602808 :   MachineBasicBlock *TBB = nullptr, *FBB = nullptr;
    1986             :   SmallVector<MachineOperand, 4> Cond;
    1987      602808 :   if (TII->analyzeBranch(*MBB, TBB, FBB, Cond, true) || !TBB || Cond.empty())
    1988             :     return false;
    1989             : 
    1990      234430 :   if (!FBB) FBB = findFalseBlock(MBB, TBB);
    1991      118376 :   if (!FBB)
    1992             :     // Malformed bcc? True and false blocks are the same?
    1993             :     return false;
    1994             : 
    1995             :   // Restrict the optimization to cases where MBB is the only predecessor,
    1996             :   // it is an obvious win.
    1997      155724 :   if (TBB->pred_size() > 1 || FBB->pred_size() > 1)
    1998             :     return false;
    1999             : 
    2000             :   // Find a suitable position to hoist the common instructions to. Also figure
    2001             :   // out which registers are used or defined by instructions from the insertion
    2002             :   // point to the end of the block.
    2003       35696 :   SmallSet<unsigned, 4> Uses, Defs;
    2004             :   MachineBasicBlock::iterator Loc =
    2005       35696 :     findHoistingInsertPosAndDeps(MBB, TII, TRI, Uses, Defs);
    2006       35696 :   if (Loc == MBB->end())
    2007             :     return false;
    2008             : 
    2009             :   bool HasDups = false;
    2010       33178 :   SmallSet<unsigned, 4> ActiveDefsSet, AllDefsSet;
    2011       66356 :   MachineBasicBlock::iterator TIB = TBB->begin();
    2012       66356 :   MachineBasicBlock::iterator FIB = FBB->begin();
    2013             :   MachineBasicBlock::iterator TIE = TBB->end();
    2014             :   MachineBasicBlock::iterator FIE = FBB->end();
    2015       66569 :   while (TIB != TIE && FIB != FIE) {
    2016             :     // Skip dbg_value instructions. These do not count.
    2017       32899 :     TIB = skipDebugInstructionsForward(TIB, TIE);
    2018       32899 :     FIB = skipDebugInstructionsForward(FIB, FIE);
    2019       65798 :     if (TIB == TIE || FIB == FIE)
    2020             :       break;
    2021             : 
    2022       32899 :     if (!TIB->isIdenticalTo(*FIB, MachineInstr::CheckKillDead))
    2023             :       break;
    2024             : 
    2025         892 :     if (TII->isPredicated(*TIB))
    2026             :       // Hard to reason about register liveness with predicated instruction.
    2027             :       break;
    2028             : 
    2029             :     bool IsSafe = true;
    2030        4037 :     for (MachineOperand &MO : TIB->operands()) {
    2031             :       // Don't attempt to hoist instructions with register masks.
    2032        1875 :       if (MO.isRegMask()) {
    2033             :         IsSafe = false;
    2034          79 :         break;
    2035             :       }
    2036        1861 :       if (!MO.isReg())
    2037        1623 :         continue;
    2038        1266 :       unsigned Reg = MO.getReg();
    2039        1266 :       if (!Reg)
    2040         433 :         continue;
    2041         833 :       if (MO.isDef()) {
    2042         459 :         if (Uses.count(Reg)) {
    2043             :           // Avoid clobbering a register that's used by the instruction at
    2044             :           // the point of insertion.
    2045             :           IsSafe = false;
    2046             :           break;
    2047             :         }
    2048             : 
    2049         438 :         if (Defs.count(Reg) && !MO.isDead()) {
    2050             :           // Don't hoist the instruction if the def would be clobber by the
    2051             :           // instruction at the point insertion. FIXME: This is overly
    2052             :           // conservative. It should be possible to hoist the instructions
    2053             :           // in BB2 in the following example:
    2054             :           // BB1:
    2055             :           // r1, eflag = op1 r2, r3
    2056             :           // brcc eflag
    2057             :           //
    2058             :           // BB2:
    2059             :           // r1 = op2, ...
    2060             :           //    = op3, killed r1
    2061             :           IsSafe = false;
    2062             :           break;
    2063             :         }
    2064         374 :       } else if (!ActiveDefsSet.count(Reg)) {
    2065         364 :         if (Defs.count(Reg)) {
    2066             :           // Use is defined by the instruction at the point of insertion.
    2067             :           IsSafe = false;
    2068             :           break;
    2069             :         }
    2070             : 
    2071         364 :         if (MO.isKill() && Uses.count(Reg))
    2072             :           // Kills a register that's read by the instruction at the point of
    2073             :           // insertion. Remove the kill marker.
    2074             :           MO.setIsKill(false);
    2075             :       }
    2076             :     }
    2077             :     if (!IsSafe)
    2078             :       break;
    2079             : 
    2080         366 :     bool DontMoveAcrossStore = true;
    2081         366 :     if (!TIB->isSafeToMove(nullptr, DontMoveAcrossStore))
    2082             :       break;
    2083             : 
    2084             :     // Remove kills from ActiveDefsSet, these registers had short live ranges.
    2085         822 :     for (const MachineOperand &MO : TIB->operands()) {
    2086        1050 :       if (!MO.isReg() || !MO.isUse() || !MO.isKill())
    2087         681 :         continue;
    2088          15 :       unsigned Reg = MO.getReg();
    2089          15 :       if (!Reg)
    2090           0 :         continue;
    2091          15 :       if (!AllDefsSet.count(Reg)) {
    2092          13 :         continue;
    2093             :       }
    2094           2 :       if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
    2095          28 :         for (MCRegAliasIterator AI(Reg, TRI, true); AI.isValid(); ++AI)
    2096          12 :           ActiveDefsSet.erase(*AI);
    2097             :       } else {
    2098           0 :         ActiveDefsSet.erase(Reg);
    2099             :       }
    2100             :     }
    2101             : 
    2102             :     // Track local defs so we can update liveins.
    2103         822 :     for (const MachineOperand &MO : TIB->operands()) {
    2104         986 :       if (!MO.isReg() || !MO.isDef() || MO.isDead())
    2105         212 :         continue;
    2106         137 :       unsigned Reg = MO.getReg();
    2107         274 :       if (!Reg || TargetRegisterInfo::isVirtualRegister(Reg))
    2108           0 :         continue;
    2109         137 :       addRegAndItsAliases(Reg, TRI, ActiveDefsSet);
    2110         137 :       addRegAndItsAliases(Reg, TRI, AllDefsSet);
    2111             :     }
    2112             : 
    2113             :     HasDups = true;
    2114             :     ++TIB;
    2115             :     ++FIB;
    2116             :   }
    2117             : 
    2118       33178 :   if (!HasDups)
    2119             :     return false;
    2120             : 
    2121          98 :   MBB->splice(Loc, TBB, TBB->begin(), TIB);
    2122          98 :   FBB->erase(FBB->begin(), FIB);
    2123             : 
    2124          98 :   if (UpdateLiveIns) {
    2125          92 :     recomputeLiveIns(*TBB);
    2126          92 :     recomputeLiveIns(*FBB);
    2127             :   }
    2128             : 
    2129             :   ++NumHoist;
    2130             :   return true;
    2131      303507 : }

Generated by: LCOV version 1.13