lib/CodeGen/MachineSink.cpp

   1 //===-- MachineSink.cpp - Sinking for machine 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 moves instructions into successor blocks when possible, so that
  11 // they aren't executed on paths where their results aren't needed.
  12 //
  13 // This pass is not intended to be a replacement or a complete alternative
  14 // for an LLVM-IR-level sinking pass. It is only designed to sink simple
  15 // constructs that are not exposed before lowering and instruction selection.
  16 //
  17 //===----------------------------------------------------------------------===//
  18
  19 #include "llvm/CodeGen/Passes.h"
  20 #include "llvm/ADT/SmallSet.h"
  21 #include "llvm/ADT/Statistic.h"
  22 #include "llvm/Analysis/AliasAnalysis.h"
  23 #include "llvm/CodeGen/MachineDominators.h"
  24 #include "llvm/CodeGen/MachineLoopInfo.h"
  25 #include "llvm/CodeGen/MachineRegisterInfo.h"
  26 #include "llvm/Support/CommandLine.h"
  27 #include "llvm/Support/Debug.h"
  28 #include "llvm/Support/raw_ostream.h"
  29 #include "llvm/Target/TargetInstrInfo.h"
  30 #include "llvm/Target/TargetMachine.h"
  31 #include "llvm/Target/TargetRegisterInfo.h"
  32 #include "llvm/Target/TargetSubtargetInfo.h"
  33 using namespace llvm;
  34
  35 #define DEBUG_TYPE "machine-sink"
  36
  37 static cl::opt<bool>
  38 SplitEdges("machine-sink-split",
  39            cl::desc("Split critical edges during machine sinking"),
  40            cl::init(true), cl::Hidden);
  41
  42 STATISTIC(NumSunk,      "Number of machine instructions sunk");
  43 STATISTIC(NumSplit,     "Number of critical edges split");
  44 STATISTIC(NumCoalesces, "Number of copies coalesced");
  45
  46 namespace {
  47   class MachineSinking : public MachineFunctionPass {
  48     const TargetInstrInfo *TII;
  49     const TargetRegisterInfo *TRI;
  50     MachineRegisterInfo  *MRI;  // Machine register information
  51     MachineDominatorTree *DT;   // Machine dominator tree
  52     MachineLoopInfo *LI;
  53     AliasAnalysis *AA;
  54
  55     // Remember which edges have been considered for breaking.
  56     SmallSet<std::pair<MachineBasicBlock*,MachineBasicBlock*>, 8>
  57     CEBCandidates;
  58
  59   public:
  60     static char ID; // Pass identification
  61     MachineSinking() : MachineFunctionPass(ID) {
  62       initializeMachineSinkingPass(*PassRegistry::getPassRegistry());
  63     }
  64
  65     bool runOnMachineFunction(MachineFunction &MF) override;
  66
  67     void getAnalysisUsage(AnalysisUsage &AU) const override {
  68       AU.setPreservesCFG();
  69       MachineFunctionPass::getAnalysisUsage(AU);
  70       AU.addRequired<AliasAnalysis>();
  71       AU.addRequired<MachineDominatorTree>();
  72       AU.addRequired<MachineLoopInfo>();
  73       AU.addPreserved<MachineDominatorTree>();
  74       AU.addPreserved<MachineLoopInfo>();
  75     }
  76
  77     void releaseMemory() override {
  78       CEBCandidates.clear();
  79     }
  80
  81   private:
  82     bool ProcessBlock(MachineBasicBlock &MBB);
  83     bool isWorthBreakingCriticalEdge(MachineInstr *MI,
  84                                      MachineBasicBlock *From,
  85                                      MachineBasicBlock *To);
  86     MachineBasicBlock *SplitCriticalEdge(MachineInstr *MI,
  87                                          MachineBasicBlock *From,
  88                                          MachineBasicBlock *To,
  89                                          bool BreakPHIEdge);
  90     bool SinkInstruction(MachineInstr *MI, bool &SawStore);
  91     bool AllUsesDominatedByBlock(unsigned Reg, MachineBasicBlock *MBB,
  92                                  MachineBasicBlock *DefMBB,
  93                                  bool &BreakPHIEdge, bool &LocalUse) const;
  94     MachineBasicBlock *FindSuccToSinkTo(MachineInstr *MI, MachineBasicBlock *MBB,
  95                bool &BreakPHIEdge);
  96     bool isProfitableToSinkTo(unsigned Reg, MachineInstr *MI,
  97                               MachineBasicBlock *MBB,
  98                               MachineBasicBlock *SuccToSinkTo);
  99
 100     bool PerformTrivialForwardCoalescing(MachineInstr *MI,
 101                                          MachineBasicBlock *MBB);
 102   };
 103 } // end anonymous namespace
 104
 105 char MachineSinking::ID = 0;
 106 char &llvm::MachineSinkingID = MachineSinking::ID;
 107 INITIALIZE_PASS_BEGIN(MachineSinking, "machine-sink",
 108                 "Machine code sinking", false, false)
 109 INITIALIZE_PASS_DEPENDENCY(MachineDominatorTree)
 110 INITIALIZE_PASS_DEPENDENCY(MachineLoopInfo)
 111 INITIALIZE_AG_DEPENDENCY(AliasAnalysis)
 112 INITIALIZE_PASS_END(MachineSinking, "machine-sink",
 113                 "Machine code sinking", false, false)
 114
 115 bool MachineSinking::PerformTrivialForwardCoalescing(MachineInstr *MI,
 116                                                      MachineBasicBlock *MBB) {
 117   if (!MI->isCopy())
 118     return false;
 119
 120   unsigned SrcReg = MI->getOperand(1).getReg();
 121   unsigned DstReg = MI->getOperand(0).getReg();
 122   if (!TargetRegisterInfo::isVirtualRegister(SrcReg) ||
 123       !TargetRegisterInfo::isVirtualRegister(DstReg) ||
 124       !MRI->hasOneNonDBGUse(SrcReg))
 125     return false;
 126
 127   const TargetRegisterClass *SRC = MRI->getRegClass(SrcReg);
 128   const TargetRegisterClass *DRC = MRI->getRegClass(DstReg);
 129   if (SRC != DRC)
 130     return false;
 131
 132   MachineInstr *DefMI = MRI->getVRegDef(SrcReg);
 133   if (DefMI->isCopyLike())
 134     return false;
 135   DEBUG(dbgs() << "Coalescing: " << *DefMI);
 136   DEBUG(dbgs() << "*** to: " << *MI);
 137   MRI->replaceRegWith(DstReg, SrcReg);
 138   MI->eraseFromParent();
 139   ++NumCoalesces;
 140   return true;
 141 }
 142
 143 /// AllUsesDominatedByBlock - Return true if all uses of the specified register
 144 /// occur in blocks dominated by the specified block. If any use is in the
 145 /// definition block, then return false since it is never legal to move def
 146 /// after uses.
 147 bool
 148 MachineSinking::AllUsesDominatedByBlock(unsigned Reg,
 149                                         MachineBasicBlock *MBB,
 150                                         MachineBasicBlock *DefMBB,
 151                                         bool &BreakPHIEdge,
 152                                         bool &LocalUse) const {
 153   assert(TargetRegisterInfo::isVirtualRegister(Reg) &&
 154          "Only makes sense for vregs");
 155
 156   // Ignore debug uses because debug info doesn't affect the code.
 157   if (MRI->use_nodbg_empty(Reg))
 158     return true;
 159
 160   // BreakPHIEdge is true if all the uses are in the successor MBB being sunken
 161   // into and they are all PHI nodes. In this case, machine-sink must break
 162   // the critical edge first. e.g.
 163   //
 164   // BB#1: derived from LLVM BB %bb4.preheader
 165   //   Predecessors according to CFG: BB#0
 166   //     ...
 167   //     %reg16385<def> = DEC64_32r %reg16437, %EFLAGS<imp-def,dead>
 168   //     ...
 169   //     JE_4 <BB#37>, %EFLAGS<imp-use>
 170   //   Successors according to CFG: BB#37 BB#2
 171   //
 172   // BB#2: derived from LLVM BB %bb.nph
 173   //   Predecessors according to CFG: BB#0 BB#1
 174   //     %reg16386<def> = PHI %reg16434, <BB#0>, %reg16385, <BB#1>
 175   BreakPHIEdge = true;
 176   for (MachineOperand &MO : MRI->use_nodbg_operands(Reg)) {
 177     MachineInstr *UseInst = MO.getParent();
 178     unsigned OpNo = &MO - &UseInst->getOperand(0);
 179     MachineBasicBlock *UseBlock = UseInst->getParent();
 180     if (!(UseBlock == MBB && UseInst->isPHI() &&
 181           UseInst->getOperand(OpNo+1).getMBB() == DefMBB)) {
 182       BreakPHIEdge = false;
 183       break;
 184     }
 185   }
 186   if (BreakPHIEdge)
 187     return true;
 188
 189   for (MachineOperand &MO : MRI->use_nodbg_operands(Reg)) {
 190     // Determine the block of the use.
 191     MachineInstr *UseInst = MO.getParent();
 192     unsigned OpNo = &MO - &UseInst->getOperand(0);
 193     MachineBasicBlock *UseBlock = UseInst->getParent();
 194     if (UseInst->isPHI()) {
 195       // PHI nodes use the operand in the predecessor block, not the block with
 196       // the PHI.
 197       UseBlock = UseInst->getOperand(OpNo+1).getMBB();
 198     } else if (UseBlock == DefMBB) {
 199       LocalUse = true;
 200       return false;
 201     }
 202
 203     // Check that it dominates.
 204     if (!DT->dominates(MBB, UseBlock))
 205       return false;
 206   }
 207
 208   return true;
 209 }
 210
 211 bool MachineSinking::runOnMachineFunction(MachineFunction &MF) {
 212   if (skipOptnoneFunction(*MF.getFunction()))
 213     return false;
 214
 215   DEBUG(dbgs() << "******** Machine Sinking ********\n");
 216
 217   const TargetMachine &TM = MF.getTarget();
 218   TII = TM.getSubtargetImpl()->getInstrInfo();
 219   TRI = TM.getSubtargetImpl()->getRegisterInfo();
 220   MRI = &MF.getRegInfo();
 221   DT = &getAnalysis<MachineDominatorTree>();
 222   LI = &getAnalysis<MachineLoopInfo>();
 223   AA = &getAnalysis<AliasAnalysis>();
 224
 225   bool EverMadeChange = false;
 226
 227   while (1) {
 228     bool MadeChange = false;
 229
 230     // Process all basic blocks.
 231     CEBCandidates.clear();
 232     for (MachineFunction::iterator I = MF.begin(), E = MF.end();
 233          I != E; ++I)
 234       MadeChange |= ProcessBlock(*I);
 235
 236     // If this iteration over the code changed anything, keep iterating.
 237     if (!MadeChange) break;
 238     EverMadeChange = true;
 239   }
 240   return EverMadeChange;
 241 }
 242
 243 bool MachineSinking::ProcessBlock(MachineBasicBlock &MBB) {
 244   // Can't sink anything out of a block that has less than two successors.
 245   if (MBB.succ_size() <= 1 || MBB.empty()) return false;
 246
 247   // Don't bother sinking code out of unreachable blocks. In addition to being
 248   // unprofitable, it can also lead to infinite looping, because in an
 249   // unreachable loop there may be nowhere to stop.
 250   if (!DT->isReachableFromEntry(&MBB)) return false;
 251
 252   bool MadeChange = false;
 253
 254   // Walk the basic block bottom-up.  Remember if we saw a store.
 255   MachineBasicBlock::iterator I = MBB.end();
 256   --I;
 257   bool ProcessedBegin, SawStore = false;
 258   do {
 259     MachineInstr *MI = I;  // The instruction to sink.
 260
 261     // Predecrement I (if it's not begin) so that it isn't invalidated by
 262     // sinking.
 263     ProcessedBegin = I == MBB.begin();
 264     if (!ProcessedBegin)
 265       --I;
 266
 267     if (MI->isDebugValue())
 268       continue;
 269
 270     bool Joined = PerformTrivialForwardCoalescing(MI, &MBB);
 271     if (Joined) {
 272       MadeChange = true;
 273       continue;
 274     }
 275
 276     if (SinkInstruction(MI, SawStore))
 277       ++NumSunk, MadeChange = true;
 278
 279     // If we just processed the first instruction in the block, we're done.
 280   } while (!ProcessedBegin);
 281
 282   return MadeChange;
 283 }
 284
 285 bool MachineSinking::isWorthBreakingCriticalEdge(MachineInstr *MI,
 286                                                  MachineBasicBlock *From,
 287                                                  MachineBasicBlock *To) {
 288   // FIXME: Need much better heuristics.
 289
 290   // If the pass has already considered breaking this edge (during this pass
 291   // through the function), then let's go ahead and break it. This means
 292   // sinking multiple "cheap" instructions into the same block.
 293   if (!CEBCandidates.insert(std::make_pair(From, To)))
 294     return true;
 295
 296   if (!MI->isCopy() && !TII->isAsCheapAsAMove(MI))
 297     return true;
 298
 299   // MI is cheap, we probably don't want to break the critical edge for it.
 300   // However, if this would allow some definitions of its source operands
 301   // to be sunk then it's probably worth it.
 302   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 303     const MachineOperand &MO = MI->getOperand(i);
 304     if (!MO.isReg() || !MO.isUse())
 305       continue;
 306     unsigned Reg = MO.getReg();
 307     if (Reg == 0)
 308       continue;
 309
 310     // We don't move live definitions of physical registers,
 311     // so sinking their uses won't enable any opportunities.
 312     if (TargetRegisterInfo::isPhysicalRegister(Reg))
 313       continue;
 314
 315     // If this instruction is the only user of a virtual register,
 316     // check if breaking the edge will enable sinking
 317     // both this instruction and the defining instruction.
 318     if (MRI->hasOneNonDBGUse(Reg)) {
 319       // If the definition resides in same MBB,
 320       // claim it's likely we can sink these together.
 321       // If definition resides elsewhere, we aren't
 322       // blocking it from being sunk so don't break the edge.
 323       MachineInstr *DefMI = MRI->getVRegDef(Reg);
 324       if (DefMI->getParent() == MI->getParent())
 325         return true;
 326     }
 327   }
 328
 329   return false;
 330 }
 331
 332 MachineBasicBlock *MachineSinking::SplitCriticalEdge(MachineInstr *MI,
 333                                                      MachineBasicBlock *FromBB,
 334                                                      MachineBasicBlock *ToBB,
 335                                                      bool BreakPHIEdge) {
 336   if (!isWorthBreakingCriticalEdge(MI, FromBB, ToBB))
 337     return nullptr;
 338
 339   // Avoid breaking back edge. From == To means backedge for single BB loop.
 340   if (!SplitEdges || FromBB == ToBB)
 341     return nullptr;
 342
 343   // Check for backedges of more "complex" loops.
 344   if (LI->getLoopFor(FromBB) == LI->getLoopFor(ToBB) &&
 345       LI->isLoopHeader(ToBB))
 346     return nullptr;
 347
 348   // It's not always legal to break critical edges and sink the computation
 349   // to the edge.
 350   //
 351   // BB#1:
 352   // v1024
 353   // Beq BB#3
 354   // <fallthrough>
 355   // BB#2:
 356   // ... no uses of v1024
 357   // <fallthrough>
 358   // BB#3:
 359   // ...
 360   //       = v1024
 361   //
 362   // If BB#1 -> BB#3 edge is broken and computation of v1024 is inserted:
 363   //
 364   // BB#1:
 365   // ...
 366   // Bne BB#2
 367   // BB#4:
 368   // v1024 =
 369   // B BB#3
 370   // BB#2:
 371   // ... no uses of v1024
 372   // <fallthrough>
 373   // BB#3:
 374   // ...
 375   //       = v1024
 376   //
 377   // This is incorrect since v1024 is not computed along the BB#1->BB#2->BB#3
 378   // flow. We need to ensure the new basic block where the computation is
 379   // sunk to dominates all the uses.
 380   // It's only legal to break critical edge and sink the computation to the
 381   // new block if all the predecessors of "To", except for "From", are
 382   // not dominated by "From". Given SSA property, this means these
 383   // predecessors are dominated by "To".
 384   //
 385   // There is no need to do this check if all the uses are PHI nodes. PHI
 386   // sources are only defined on the specific predecessor edges.
 387   if (!BreakPHIEdge) {
 388     for (MachineBasicBlock::pred_iterator PI = ToBB->pred_begin(),
 389            E = ToBB->pred_end(); PI != E; ++PI) {
 390       if (*PI == FromBB)
 391         continue;
 392       if (!DT->dominates(ToBB, *PI))
 393         return nullptr;
 394     }
 395   }
 396
 397   return FromBB->SplitCriticalEdge(ToBB, this);
 398 }
 399
 400 static bool AvoidsSinking(MachineInstr *MI, MachineRegisterInfo *MRI) {
 401   return MI->isInsertSubreg() || MI->isSubregToReg() || MI->isRegSequence();
 402 }
 403
 404 /// collectDebgValues - Scan instructions following MI and collect any
 405 /// matching DBG_VALUEs.
 406 static void collectDebugValues(MachineInstr *MI,
 407                                SmallVectorImpl<MachineInstr *> &DbgValues) {
 408   DbgValues.clear();
 409   if (!MI->getOperand(0).isReg())
 410     return;
 411
 412   MachineBasicBlock::iterator DI = MI; ++DI;
 413   for (MachineBasicBlock::iterator DE = MI->getParent()->end();
 414        DI != DE; ++DI) {
 415     if (!DI->isDebugValue())
 416       return;
 417     if (DI->getOperand(0).isReg() &&
 418         DI->getOperand(0).getReg() == MI->getOperand(0).getReg())
 419       DbgValues.push_back(DI);
 420   }
 421 }
 422
 423 /// isPostDominatedBy - Return true if A is post dominated by B.
 424 static bool isPostDominatedBy(MachineBasicBlock *A, MachineBasicBlock *B) {
 425
 426   // FIXME - Use real post dominator.
 427   if (A->succ_size() != 2)
 428     return false;
 429   MachineBasicBlock::succ_iterator I = A->succ_begin();
 430   if (B == *I)
 431     ++I;
 432   MachineBasicBlock *OtherSuccBlock = *I;
 433   if (OtherSuccBlock->succ_size() != 1 ||
 434       *(OtherSuccBlock->succ_begin()) != B)
 435     return false;
 436
 437   return true;
 438 }
 439
 440 /// isProfitableToSinkTo - Return true if it is profitable to sink MI.
 441 bool MachineSinking::isProfitableToSinkTo(unsigned Reg, MachineInstr *MI,
 442                                           MachineBasicBlock *MBB,
 443                                           MachineBasicBlock *SuccToSinkTo) {
 444   assert (MI && "Invalid MachineInstr!");
 445   assert (SuccToSinkTo && "Invalid SinkTo Candidate BB");
 446
 447   if (MBB == SuccToSinkTo)
 448     return false;
 449
 450   // It is profitable if SuccToSinkTo does not post dominate current block.
 451   if (!isPostDominatedBy(MBB, SuccToSinkTo))
 452       return true;
 453
 454   // Check if only use in post dominated block is PHI instruction.
 455   bool NonPHIUse = false;
 456   for (MachineInstr &UseInst : MRI->use_nodbg_instructions(Reg)) {
 457     MachineBasicBlock *UseBlock = UseInst.getParent();
 458     if (UseBlock == SuccToSinkTo && !UseInst.isPHI())
 459       NonPHIUse = true;
 460   }
 461   if (!NonPHIUse)
 462     return true;
 463
 464   // If SuccToSinkTo post dominates then also it may be profitable if MI
 465   // can further profitably sinked into another block in next round.
 466   bool BreakPHIEdge = false;
 467   // FIXME - If finding successor is compile time expensive then catch results.
 468   if (MachineBasicBlock *MBB2 = FindSuccToSinkTo(MI, SuccToSinkTo, BreakPHIEdge))
 469     return isProfitableToSinkTo(Reg, MI, SuccToSinkTo, MBB2);
 470
 471   // If SuccToSinkTo is final destination and it is a post dominator of current
 472   // block then it is not profitable to sink MI into SuccToSinkTo block.
 473   return false;
 474 }
 475
 476 /// FindSuccToSinkTo - Find a successor to sink this instruction to.
 477 MachineBasicBlock *MachineSinking::FindSuccToSinkTo(MachineInstr *MI,
 478                                    MachineBasicBlock *MBB,
 479                                    bool &BreakPHIEdge) {
 480
 481   assert (MI && "Invalid MachineInstr!");
 482   assert (MBB && "Invalid MachineBasicBlock!");
 483
 484   // Loop over all the operands of the specified instruction.  If there is
 485   // anything we can't handle, bail out.
 486
 487   // SuccToSinkTo - This is the successor to sink this instruction to, once we
 488   // decide.
 489   MachineBasicBlock *SuccToSinkTo = nullptr;
 490   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 491     const MachineOperand &MO = MI->getOperand(i);
 492     if (!MO.isReg()) continue;  // Ignore non-register operands.
 493
 494     unsigned Reg = MO.getReg();
 495     if (Reg == 0) continue;
 496
 497     if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
 498       if (MO.isUse()) {
 499         // If the physreg has no defs anywhere, it's just an ambient register
 500         // and we can freely move its uses. Alternatively, if it's allocatable,
 501         // it could get allocated to something with a def during allocation.
 502         if (!MRI->isConstantPhysReg(Reg, *MBB->getParent()))
 503           return nullptr;
 504       } else if (!MO.isDead()) {
 505         // A def that isn't dead. We can't move it.
 506         return nullptr;
 507       }
 508     } else {
 509       // Virtual register uses are always safe to sink.
 510       if (MO.isUse()) continue;
 511
 512       // If it's not safe to move defs of the register class, then abort.
 513       if (!TII->isSafeToMoveRegClassDefs(MRI->getRegClass(Reg)))
 514         return nullptr;
 515
 516       // FIXME: This picks a successor to sink into based on having one
 517       // successor that dominates all the uses.  However, there are cases where
 518       // sinking can happen but where the sink point isn't a successor.  For
 519       // example:
 520       //
 521       //   x = computation
 522       //   if () {} else {}
 523       //   use x
 524       //
 525       // the instruction could be sunk over the whole diamond for the
 526       // if/then/else (or loop, etc), allowing it to be sunk into other blocks
 527       // after that.
 528
 529       // Virtual register defs can only be sunk if all their uses are in blocks
 530       // dominated by one of the successors.
 531       if (SuccToSinkTo) {
 532         // If a previous operand picked a block to sink to, then this operand
 533         // must be sinkable to the same block.
 534         bool LocalUse = false;
 535         if (!AllUsesDominatedByBlock(Reg, SuccToSinkTo, MBB,
 536                                      BreakPHIEdge, LocalUse))
 537           return nullptr;
 538
 539         continue;
 540       }
 541
 542       // Otherwise, we should look at all the successors and decide which one
 543       // we should sink to.
 544       // We give successors with smaller loop depth higher priority.
 545       SmallVector<MachineBasicBlock*, 4> Succs(MBB->succ_begin(), MBB->succ_end());
 546       // Sort Successors according to their loop depth.
 547       std::stable_sort(
 548           Succs.begin(), Succs.end(),
 549           [this](const MachineBasicBlock *LHS, const MachineBasicBlock *RHS) {
 550             return LI->getLoopDepth(LHS) < LI->getLoopDepth(RHS);
 551           });
 552       for (SmallVectorImpl<MachineBasicBlock *>::iterator SI = Succs.begin(),
 553              E = Succs.end(); SI != E; ++SI) {
 554         MachineBasicBlock *SuccBlock = *SI;
 555         bool LocalUse = false;
 556         if (AllUsesDominatedByBlock(Reg, SuccBlock, MBB,
 557                                     BreakPHIEdge, LocalUse)) {
 558           SuccToSinkTo = SuccBlock;
 559           break;
 560         }
 561         if (LocalUse)
 562           // Def is used locally, it's never safe to move this def.
 563           return nullptr;
 564       }
 565
 566       // If we couldn't find a block to sink to, ignore this instruction.
 567       if (!SuccToSinkTo)
 568         return nullptr;
 569       if (!isProfitableToSinkTo(Reg, MI, MBB, SuccToSinkTo))
 570         return nullptr;
 571     }
 572   }
 573
 574   // It is not possible to sink an instruction into its own block.  This can
 575   // happen with loops.
 576   if (MBB == SuccToSinkTo)
 577     return nullptr;
 578
 579   // It's not safe to sink instructions to EH landing pad. Control flow into
 580   // landing pad is implicitly defined.
 581   if (SuccToSinkTo && SuccToSinkTo->isLandingPad())
 582     return nullptr;
 583
 584   return SuccToSinkTo;
 585 }
 586
 587 /// SinkInstruction - Determine whether it is safe to sink the specified machine
 588 /// instruction out of its current block into a successor.
 589 bool MachineSinking::SinkInstruction(MachineInstr *MI, bool &SawStore) {
 590   // Don't sink insert_subreg, subreg_to_reg, reg_sequence. These are meant to
 591   // be close to the source to make it easier to coalesce.
 592   if (AvoidsSinking(MI, MRI))
 593     return false;
 594
 595   // Check if it's safe to move the instruction.
 596   if (!MI->isSafeToMove(TII, AA, SawStore))
 597     return false;
 598
 599   // FIXME: This should include support for sinking instructions within the
 600   // block they are currently in to shorten the live ranges.  We often get
 601   // instructions sunk into the top of a large block, but it would be better to
 602   // also sink them down before their first use in the block.  This xform has to
 603   // be careful not to *increase* register pressure though, e.g. sinking
 604   // "x = y + z" down if it kills y and z would increase the live ranges of y
 605   // and z and only shrink the live range of x.
 606
 607   bool BreakPHIEdge = false;
 608   MachineBasicBlock *ParentBlock = MI->getParent();
 609   MachineBasicBlock *SuccToSinkTo = FindSuccToSinkTo(MI, ParentBlock, BreakPHIEdge);
 610
 611   // If there are no outputs, it must have side-effects.
 612   if (!SuccToSinkTo)
 613     return false;
 614
 615
 616   // If the instruction to move defines a dead physical register which is live
 617   // when leaving the basic block, don't move it because it could turn into a
 618   // "zombie" define of that preg. E.g., EFLAGS. (<rdar://problem/8030636>)
 619   for (unsigned I = 0, E = MI->getNumOperands(); I != E; ++I) {
 620     const MachineOperand &MO = MI->getOperand(I);
 621     if (!MO.isReg()) continue;
 622     unsigned Reg = MO.getReg();
 623     if (Reg == 0 || !TargetRegisterInfo::isPhysicalRegister(Reg)) continue;
 624     if (SuccToSinkTo->isLiveIn(Reg))
 625       return false;
 626   }
 627
 628   DEBUG(dbgs() << "Sink instr " << *MI << "\tinto block " << *SuccToSinkTo);
 629
 630   // If the block has multiple predecessors, this is a critical edge.
 631   // Decide if we can sink along it or need to break the edge.
 632   if (SuccToSinkTo->pred_size() > 1) {
 633     // We cannot sink a load across a critical edge - there may be stores in
 634     // other code paths.
 635     bool TryBreak = false;
 636     bool store = true;
 637     if (!MI->isSafeToMove(TII, AA, store)) {
 638       DEBUG(dbgs() << " *** NOTE: Won't sink load along critical edge.\n");
 639       TryBreak = true;
 640     }
 641
 642     // We don't want to sink across a critical edge if we don't dominate the
 643     // successor. We could be introducing calculations to new code paths.
 644     if (!TryBreak && !DT->dominates(ParentBlock, SuccToSinkTo)) {
 645       DEBUG(dbgs() << " *** NOTE: Critical edge found\n");
 646       TryBreak = true;
 647     }
 648
 649     // Don't sink instructions into a loop.
 650     if (!TryBreak && LI->isLoopHeader(SuccToSinkTo)) {
 651       DEBUG(dbgs() << " *** NOTE: Loop header found\n");
 652       TryBreak = true;
 653     }
 654
 655     // Otherwise we are OK with sinking along a critical edge.
 656     if (!TryBreak)
 657       DEBUG(dbgs() << "Sinking along critical edge.\n");
 658     else {
 659       MachineBasicBlock *NewSucc =
 660         SplitCriticalEdge(MI, ParentBlock, SuccToSinkTo, BreakPHIEdge);
 661       if (!NewSucc) {
 662         DEBUG(dbgs() << " *** PUNTING: Not legal or profitable to "
 663                         "break critical edge\n");
 664         return false;
 665       } else {
 666         DEBUG(dbgs() << " *** Splitting critical edge:"
 667               " BB#" << ParentBlock->getNumber()
 668               << " -- BB#" << NewSucc->getNumber()
 669               << " -- BB#" << SuccToSinkTo->getNumber() << '\n');
 670         SuccToSinkTo = NewSucc;
 671         ++NumSplit;
 672         BreakPHIEdge = false;
 673       }
 674     }
 675   }
 676
 677   if (BreakPHIEdge) {
 678     // BreakPHIEdge is true if all the uses are in the successor MBB being
 679     // sunken into and they are all PHI nodes. In this case, machine-sink must
 680     // break the critical edge first.
 681     MachineBasicBlock *NewSucc = SplitCriticalEdge(MI, ParentBlock,
 682                                                    SuccToSinkTo, BreakPHIEdge);
 683     if (!NewSucc) {
 684       DEBUG(dbgs() << " *** PUNTING: Not legal or profitable to "
 685             "break critical edge\n");
 686       return false;
 687     }
 688
 689     DEBUG(dbgs() << " *** Splitting critical edge:"
 690           " BB#" << ParentBlock->getNumber()
 691           << " -- BB#" << NewSucc->getNumber()
 692           << " -- BB#" << SuccToSinkTo->getNumber() << '\n');
 693     SuccToSinkTo = NewSucc;
 694     ++NumSplit;
 695   }
 696
 697   // Determine where to insert into. Skip phi nodes.
 698   MachineBasicBlock::iterator InsertPos = SuccToSinkTo->begin();
 699   while (InsertPos != SuccToSinkTo->end() && InsertPos->isPHI())
 700     ++InsertPos;
 701
 702   // collect matching debug values.
 703   SmallVector<MachineInstr *, 2> DbgValuesToSink;
 704   collectDebugValues(MI, DbgValuesToSink);
 705
 706   // Move the instruction.
 707   SuccToSinkTo->splice(InsertPos, ParentBlock, MI,
 708                        ++MachineBasicBlock::iterator(MI));
 709
 710   // Move debug values.
 711   for (SmallVectorImpl<MachineInstr *>::iterator DBI = DbgValuesToSink.begin(),
 712          DBE = DbgValuesToSink.end(); DBI != DBE; ++DBI) {
 713     MachineInstr *DbgMI = *DBI;
 714     SuccToSinkTo->splice(InsertPos, ParentBlock,  DbgMI,
 715                          ++MachineBasicBlock::iterator(DbgMI));
 716   }
 717
 718   // Conservatively, clear any kill flags, since it's possible that they are no
 719   // longer correct.
 720   MI->clearKillInfo();
 721
 722   return true;
 723 }