lib/CodeGen/MachineBasicBlock.cpp

   1 //===-- llvm/CodeGen/MachineBasicBlock.cpp ----------------------*- C++ -*-===//
   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 // Collect the sequence of machine instructions for a basic block.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/CodeGen/MachineBasicBlock.h"
  15 #include "llvm/ADT/SmallPtrSet.h"
  16 #include "llvm/ADT/SmallString.h"
  17 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
  18 #include "llvm/CodeGen/LiveVariables.h"
  19 #include "llvm/CodeGen/MachineDominators.h"
  20 #include "llvm/CodeGen/MachineFunction.h"
  21 #include "llvm/CodeGen/MachineInstrBuilder.h"
  22 #include "llvm/CodeGen/MachineLoopInfo.h"
  23 #include "llvm/CodeGen/MachineRegisterInfo.h"
  24 #include "llvm/CodeGen/SlotIndexes.h"
  25 #include "llvm/IR/BasicBlock.h"
  26 #include "llvm/IR/DataLayout.h"
  27 #include "llvm/IR/ModuleSlotTracker.h"
  28 #include "llvm/MC/MCAsmInfo.h"
  29 #include "llvm/MC/MCContext.h"
  30 #include "llvm/Support/Debug.h"
  31 #include "llvm/Support/raw_ostream.h"
  32 #include "llvm/Target/TargetInstrInfo.h"
  33 #include "llvm/Target/TargetMachine.h"
  34 #include "llvm/Target/TargetRegisterInfo.h"
  35 #include "llvm/Target/TargetSubtargetInfo.h"
  36 #include <algorithm>
  37 using namespace llvm;
  38
  39 #define DEBUG_TYPE "codegen"
  40
  41 MachineBasicBlock::MachineBasicBlock(MachineFunction &MF, const BasicBlock *B)
  42     : BB(B), Number(-1), xParent(&MF) {
  43   Insts.Parent = this;
  44 }
  45
  46 MachineBasicBlock::~MachineBasicBlock() {
  47 }
  48
  49 /// Return the MCSymbol for this basic block.
  50 MCSymbol *MachineBasicBlock::getSymbol() const {
  51   if (!CachedMCSymbol) {
  52     const MachineFunction *MF = getParent();
  53     MCContext &Ctx = MF->getContext();
  54     const char *Prefix = Ctx.getAsmInfo()->getPrivateLabelPrefix();
  55     assert(getNumber() >= 0 && "cannot get label for unreachable MBB");
  56     CachedMCSymbol = Ctx.getOrCreateSymbol(Twine(Prefix) + "BB" +
  57                                            Twine(MF->getFunctionNumber()) +
  58                                            "_" + Twine(getNumber()));
  59   }
  60
  61   return CachedMCSymbol;
  62 }
  63
  64
  65 raw_ostream &llvm::operator<<(raw_ostream &OS, const MachineBasicBlock &MBB) {
  66   MBB.print(OS);
  67   return OS;
  68 }
  69
  70 /// When an MBB is added to an MF, we need to update the parent pointer of the
  71 /// MBB, the MBB numbering, and any instructions in the MBB to be on the right
  72 /// operand list for registers.
  73 ///
  74 /// MBBs start out as #-1. When a MBB is added to a MachineFunction, it
  75 /// gets the next available unique MBB number. If it is removed from a
  76 /// MachineFunction, it goes back to being #-1.
  77 void ilist_traits<MachineBasicBlock>::addNodeToList(MachineBasicBlock *N) {
  78   MachineFunction &MF = *N->getParent();
  79   N->Number = MF.addToMBBNumbering(N);
  80
  81   // Make sure the instructions have their operands in the reginfo lists.
  82   MachineRegisterInfo &RegInfo = MF.getRegInfo();
  83   for (MachineBasicBlock::instr_iterator
  84          I = N->instr_begin(), E = N->instr_end(); I != E; ++I)
  85     I->AddRegOperandsToUseLists(RegInfo);
  86 }
  87
  88 void ilist_traits<MachineBasicBlock>::removeNodeFromList(MachineBasicBlock *N) {
  89   N->getParent()->removeFromMBBNumbering(N->Number);
  90   N->Number = -1;
  91 }
  92
  93 /// When we add an instruction to a basic block list, we update its parent
  94 /// pointer and add its operands from reg use/def lists if appropriate.
  95 void ilist_traits<MachineInstr>::addNodeToList(MachineInstr *N) {
  96   assert(!N->getParent() && "machine instruction already in a basic block");
  97   N->setParent(Parent);
  98
  99   // Add the instruction's register operands to their corresponding
 100   // use/def lists.
 101   MachineFunction *MF = Parent->getParent();
 102   N->AddRegOperandsToUseLists(MF->getRegInfo());
 103 }
 104
 105 /// When we remove an instruction from a basic block list, we update its parent
 106 /// pointer and remove its operands from reg use/def lists if appropriate.
 107 void ilist_traits<MachineInstr>::removeNodeFromList(MachineInstr *N) {
 108   assert(N->getParent() && "machine instruction not in a basic block");
 109
 110   // Remove from the use/def lists.
 111   if (MachineFunction *MF = N->getParent()->getParent())
 112     N->RemoveRegOperandsFromUseLists(MF->getRegInfo());
 113
 114   N->setParent(nullptr);
 115 }
 116
 117 /// When moving a range of instructions from one MBB list to another, we need to
 118 /// update the parent pointers and the use/def lists.
 119 void ilist_traits<MachineInstr>::
 120 transferNodesFromList(ilist_traits<MachineInstr> &FromList,
 121                       ilist_iterator<MachineInstr> First,
 122                       ilist_iterator<MachineInstr> Last) {
 123   assert(Parent->getParent() == FromList.Parent->getParent() &&
 124         "MachineInstr parent mismatch!");
 125
 126   // Splice within the same MBB -> no change.
 127   if (Parent == FromList.Parent) return;
 128
 129   // If splicing between two blocks within the same function, just update the
 130   // parent pointers.
 131   for (; First != Last; ++First)
 132     First->setParent(Parent);
 133 }
 134
 135 void ilist_traits<MachineInstr>::deleteNode(MachineInstr* MI) {
 136   assert(!MI->getParent() && "MI is still in a block!");
 137   Parent->getParent()->DeleteMachineInstr(MI);
 138 }
 139
 140 MachineBasicBlock::iterator MachineBasicBlock::getFirstNonPHI() {
 141   instr_iterator I = instr_begin(), E = instr_end();
 142   while (I != E && I->isPHI())
 143     ++I;
 144   assert((I == E || !I->isInsideBundle()) &&
 145          "First non-phi MI cannot be inside a bundle!");
 146   return I;
 147 }
 148
 149 MachineBasicBlock::iterator
 150 MachineBasicBlock::SkipPHIsAndLabels(MachineBasicBlock::iterator I) {
 151   iterator E = end();
 152   while (I != E && (I->isPHI() || I->isPosition() || I->isDebugValue()))
 153     ++I;
 154   // FIXME: This needs to change if we wish to bundle labels / dbg_values
 155   // inside the bundle.
 156   assert((I == E || !I->isInsideBundle()) &&
 157          "First non-phi / non-label instruction is inside a bundle!");
 158   return I;
 159 }
 160
 161 MachineBasicBlock::iterator MachineBasicBlock::getFirstTerminator() {
 162   iterator B = begin(), E = end(), I = E;
 163   while (I != B && ((--I)->isTerminator() || I->isDebugValue()))
 164     ; /*noop */
 165   while (I != E && !I->isTerminator())
 166     ++I;
 167   return I;
 168 }
 169
 170 MachineBasicBlock::instr_iterator MachineBasicBlock::getFirstInstrTerminator() {
 171   instr_iterator B = instr_begin(), E = instr_end(), I = E;
 172   while (I != B && ((--I)->isTerminator() || I->isDebugValue()))
 173     ; /*noop */
 174   while (I != E && !I->isTerminator())
 175     ++I;
 176   return I;
 177 }
 178
 179 MachineBasicBlock::iterator MachineBasicBlock::getFirstNonDebugInstr() {
 180   // Skip over begin-of-block dbg_value instructions.
 181   iterator I = begin(), E = end();
 182   while (I != E && I->isDebugValue())
 183     ++I;
 184   return I;
 185 }
 186
 187 MachineBasicBlock::iterator MachineBasicBlock::getLastNonDebugInstr() {
 188   // Skip over end-of-block dbg_value instructions.
 189   instr_iterator B = instr_begin(), I = instr_end();
 190   while (I != B) {
 191     --I;
 192     // Return instruction that starts a bundle.
 193     if (I->isDebugValue() || I->isInsideBundle())
 194       continue;
 195     return I;
 196   }
 197   // The block is all debug values.
 198   return end();
 199 }
 200
 201 const MachineBasicBlock *MachineBasicBlock::getLandingPadSuccessor() const {
 202   // A block with a landing pad successor only has one other successor.
 203   if (succ_size() > 2)
 204     return nullptr;
 205   for (const_succ_iterator I = succ_begin(), E = succ_end(); I != E; ++I)
 206     if ((*I)->isEHPad())
 207       return *I;
 208   return nullptr;
 209 }
 210
 211 bool MachineBasicBlock::hasEHPadSuccessor() const {
 212   for (const_succ_iterator I = succ_begin(), E = succ_end(); I != E; ++I)
 213     if ((*I)->isEHPad())
 214       return true;
 215   return false;
 216 }
 217
 218 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
 219 void MachineBasicBlock::dump() const {
 220   print(dbgs());
 221 }
 222 #endif
 223
 224 StringRef MachineBasicBlock::getName() const {
 225   if (const BasicBlock *LBB = getBasicBlock())
 226     return LBB->getName();
 227   else
 228     return "(null)";
 229 }
 230
 231 /// Return a hopefully unique identifier for this block.
 232 std::string MachineBasicBlock::getFullName() const {
 233   std::string Name;
 234   if (getParent())
 235     Name = (getParent()->getName() + ":").str();
 236   if (getBasicBlock())
 237     Name += getBasicBlock()->getName();
 238   else
 239     Name += ("BB" + Twine(getNumber())).str();
 240   return Name;
 241 }
 242
 243 void MachineBasicBlock::print(raw_ostream &OS, SlotIndexes *Indexes) const {
 244   const MachineFunction *MF = getParent();
 245   if (!MF) {
 246     OS << "Can't print out MachineBasicBlock because parent MachineFunction"
 247        << " is null\n";
 248     return;
 249   }
 250   const Function *F = MF->getFunction();
 251   const Module *M = F ? F->getParent() : nullptr;
 252   ModuleSlotTracker MST(M);
 253   print(OS, MST, Indexes);
 254 }
 255
 256 void MachineBasicBlock::print(raw_ostream &OS, ModuleSlotTracker &MST,
 257                               SlotIndexes *Indexes) const {
 258   const MachineFunction *MF = getParent();
 259   if (!MF) {
 260     OS << "Can't print out MachineBasicBlock because parent MachineFunction"
 261        << " is null\n";
 262     return;
 263   }
 264
 265   if (Indexes)
 266     OS << Indexes->getMBBStartIdx(this) << '\t';
 267
 268   OS << "BB#" << getNumber() << ": ";
 269
 270   const char *Comma = "";
 271   if (const BasicBlock *LBB = getBasicBlock()) {
 272     OS << Comma << "derived from LLVM BB ";
 273     LBB->printAsOperand(OS, /*PrintType=*/false, MST);
 274     Comma = ", ";
 275   }
 276   if (isEHPad()) { OS << Comma << "EH LANDING PAD"; Comma = ", "; }
 277   if (hasAddressTaken()) { OS << Comma << "ADDRESS TAKEN"; Comma = ", "; }
 278   if (Alignment)
 279     OS << Comma << "Align " << Alignment << " (" << (1u << Alignment)
 280        << " bytes)";
 281
 282   OS << '\n';
 283
 284   const TargetRegisterInfo *TRI = MF->getSubtarget().getRegisterInfo();
 285   if (!livein_empty()) {
 286     if (Indexes) OS << '\t';
 287     OS << "    Live Ins:";
 288     for (const auto &LI : make_range(livein_begin(), livein_end())) {
 289       OS << ' ' << PrintReg(LI.PhysReg, TRI);
 290       if (LI.LaneMask != ~0u)
 291         OS << ':' << PrintLaneMask(LI.LaneMask);
 292     }
 293     OS << '\n';
 294   }
 295   // Print the preds of this block according to the CFG.
 296   if (!pred_empty()) {
 297     if (Indexes) OS << '\t';
 298     OS << "    Predecessors according to CFG:";
 299     for (const_pred_iterator PI = pred_begin(), E = pred_end(); PI != E; ++PI)
 300       OS << " BB#" << (*PI)->getNumber();
 301     OS << '\n';
 302   }
 303
 304   for (const_instr_iterator I = instr_begin(); I != instr_end(); ++I) {
 305     if (Indexes) {
 306       if (Indexes->hasIndex(&*I))
 307         OS << Indexes->getInstructionIndex(&*I);
 308       OS << '\t';
 309     }
 310     OS << '\t';
 311     if (I->isInsideBundle())
 312       OS << "  * ";
 313     I->print(OS, MST);
 314   }
 315
 316   // Print the successors of this block according to the CFG.
 317   if (!succ_empty()) {
 318     if (Indexes) OS << '\t';
 319     OS << "    Successors according to CFG:";
 320     for (const_succ_iterator SI = succ_begin(), E = succ_end(); SI != E; ++SI) {
 321       OS << " BB#" << (*SI)->getNumber();
 322       if (!Weights.empty())
 323         OS << '(' << *getWeightIterator(SI) << ')';
 324     }
 325     OS << '\n';
 326   }
 327 }
 328
 329 void MachineBasicBlock::printAsOperand(raw_ostream &OS,
 330                                        bool /*PrintType*/) const {
 331   OS << "BB#" << getNumber();
 332 }
 333
 334 void MachineBasicBlock::removeLiveIn(MCPhysReg Reg, LaneBitmask LaneMask) {
 335   LiveInVector::iterator I = std::find_if(
 336       LiveIns.begin(), LiveIns.end(),
 337       [Reg] (const RegisterMaskPair &LI) { return LI.PhysReg == Reg; });
 338   if (I == LiveIns.end())
 339     return;
 340
 341   I->LaneMask &= ~LaneMask;
 342   if (I->LaneMask == 0)
 343     LiveIns.erase(I);
 344 }
 345
 346 bool MachineBasicBlock::isLiveIn(MCPhysReg Reg, LaneBitmask LaneMask) const {
 347   livein_iterator I = std::find_if(
 348       LiveIns.begin(), LiveIns.end(),
 349       [Reg] (const RegisterMaskPair &LI) { return LI.PhysReg == Reg; });
 350   return I != livein_end() && (I->LaneMask & LaneMask) != 0;
 351 }
 352
 353 void MachineBasicBlock::sortUniqueLiveIns() {
 354   std::sort(LiveIns.begin(), LiveIns.end(),
 355             [](const RegisterMaskPair &LI0, const RegisterMaskPair &LI1) {
 356               return LI0.PhysReg < LI1.PhysReg;
 357             });
 358   // Liveins are sorted by physreg now we can merge their lanemasks.
 359   LiveInVector::const_iterator I = LiveIns.begin();
 360   LiveInVector::const_iterator J;
 361   LiveInVector::iterator Out = LiveIns.begin();
 362   for (; I != LiveIns.end(); ++Out, I = J) {
 363     unsigned PhysReg = I->PhysReg;
 364     LaneBitmask LaneMask = I->LaneMask;
 365     for (J = std::next(I); J != LiveIns.end() && J->PhysReg == PhysReg; ++J)
 366       LaneMask |= J->LaneMask;
 367     Out->PhysReg = PhysReg;
 368     Out->LaneMask = LaneMask;
 369   }
 370   LiveIns.erase(Out, LiveIns.end());
 371 }
 372
 373 unsigned
 374 MachineBasicBlock::addLiveIn(MCPhysReg PhysReg, const TargetRegisterClass *RC) {
 375   assert(getParent() && "MBB must be inserted in function");
 376   assert(TargetRegisterInfo::isPhysicalRegister(PhysReg) && "Expected physreg");
 377   assert(RC && "Register class is required");
 378   assert((isEHPad() || this == &getParent()->front()) &&
 379          "Only the entry block and landing pads can have physreg live ins");
 380
 381   bool LiveIn = isLiveIn(PhysReg);
 382   iterator I = SkipPHIsAndLabels(begin()), E = end();
 383   MachineRegisterInfo &MRI = getParent()->getRegInfo();
 384   const TargetInstrInfo &TII = *getParent()->getSubtarget().getInstrInfo();
 385
 386   // Look for an existing copy.
 387   if (LiveIn)
 388     for (;I != E && I->isCopy(); ++I)
 389       if (I->getOperand(1).getReg() == PhysReg) {
 390         unsigned VirtReg = I->getOperand(0).getReg();
 391         if (!MRI.constrainRegClass(VirtReg, RC))
 392           llvm_unreachable("Incompatible live-in register class.");
 393         return VirtReg;
 394       }
 395
 396   // No luck, create a virtual register.
 397   unsigned VirtReg = MRI.createVirtualRegister(RC);
 398   BuildMI(*this, I, DebugLoc(), TII.get(TargetOpcode::COPY), VirtReg)
 399     .addReg(PhysReg, RegState::Kill);
 400   if (!LiveIn)
 401     addLiveIn(PhysReg);
 402   return VirtReg;
 403 }
 404
 405 void MachineBasicBlock::moveBefore(MachineBasicBlock *NewAfter) {
 406   getParent()->splice(NewAfter->getIterator(), getIterator());
 407 }
 408
 409 void MachineBasicBlock::moveAfter(MachineBasicBlock *NewBefore) {
 410   getParent()->splice(++NewBefore->getIterator(), getIterator());
 411 }
 412
 413 void MachineBasicBlock::updateTerminator() {
 414   const TargetInstrInfo *TII = getParent()->getSubtarget().getInstrInfo();
 415   // A block with no successors has no concerns with fall-through edges.
 416   if (this->succ_empty()) return;
 417
 418   MachineBasicBlock *TBB = nullptr, *FBB = nullptr;
 419   SmallVector<MachineOperand, 4> Cond;
 420   DebugLoc DL;  // FIXME: this is nowhere
 421   bool B = TII->AnalyzeBranch(*this, TBB, FBB, Cond);
 422   (void) B;
 423   assert(!B && "UpdateTerminators requires analyzable predecessors!");
 424   if (Cond.empty()) {
 425     if (TBB) {
 426       // The block has an unconditional branch. If its successor is now
 427       // its layout successor, delete the branch.
 428       if (isLayoutSuccessor(TBB))
 429         TII->RemoveBranch(*this);
 430     } else {
 431       // The block has an unconditional fallthrough. If its successor is not
 432       // its layout successor, insert a branch. First we have to locate the
 433       // only non-landing-pad successor, as that is the fallthrough block.
 434       for (succ_iterator SI = succ_begin(), SE = succ_end(); SI != SE; ++SI) {
 435         if ((*SI)->isEHPad())
 436           continue;
 437         assert(!TBB && "Found more than one non-landing-pad successor!");
 438         TBB = *SI;
 439       }
 440
 441       // If there is no non-landing-pad successor, the block has no
 442       // fall-through edges to be concerned with.
 443       if (!TBB)
 444         return;
 445
 446       // Finally update the unconditional successor to be reached via a branch
 447       // if it would not be reached by fallthrough.
 448       if (!isLayoutSuccessor(TBB))
 449         TII->InsertBranch(*this, TBB, nullptr, Cond, DL);
 450     }
 451   } else {
 452     if (FBB) {
 453       // The block has a non-fallthrough conditional branch. If one of its
 454       // successors is its layout successor, rewrite it to a fallthrough
 455       // conditional branch.
 456       if (isLayoutSuccessor(TBB)) {
 457         if (TII->ReverseBranchCondition(Cond))
 458           return;
 459         TII->RemoveBranch(*this);
 460         TII->InsertBranch(*this, FBB, nullptr, Cond, DL);
 461       } else if (isLayoutSuccessor(FBB)) {
 462         TII->RemoveBranch(*this);
 463         TII->InsertBranch(*this, TBB, nullptr, Cond, DL);
 464       }
 465     } else {
 466       // Walk through the successors and find the successor which is not
 467       // a landing pad and is not the conditional branch destination (in TBB)
 468       // as the fallthrough successor.
 469       MachineBasicBlock *FallthroughBB = nullptr;
 470       for (succ_iterator SI = succ_begin(), SE = succ_end(); SI != SE; ++SI) {
 471         if ((*SI)->isEHPad() || *SI == TBB)
 472           continue;
 473         assert(!FallthroughBB && "Found more than one fallthrough successor.");
 474         FallthroughBB = *SI;
 475       }
 476       if (!FallthroughBB && canFallThrough()) {
 477         // We fallthrough to the same basic block as the conditional jump
 478         // targets. Remove the conditional jump, leaving unconditional
 479         // fallthrough.
 480         // FIXME: This does not seem like a reasonable pattern to support, but
 481         // it has been seen in the wild coming out of degenerate ARM test cases.
 482         TII->RemoveBranch(*this);
 483
 484         // Finally update the unconditional successor to be reached via a branch
 485         // if it would not be reached by fallthrough.
 486         if (!isLayoutSuccessor(TBB))
 487           TII->InsertBranch(*this, TBB, nullptr, Cond, DL);
 488         return;
 489       }
 490
 491       // The block has a fallthrough conditional branch.
 492       if (isLayoutSuccessor(TBB)) {
 493         if (TII->ReverseBranchCondition(Cond)) {
 494           // We can't reverse the condition, add an unconditional branch.
 495           Cond.clear();
 496           TII->InsertBranch(*this, FallthroughBB, nullptr, Cond, DL);
 497           return;
 498         }
 499         TII->RemoveBranch(*this);
 500         TII->InsertBranch(*this, FallthroughBB, nullptr, Cond, DL);
 501       } else if (!isLayoutSuccessor(FallthroughBB)) {
 502         TII->RemoveBranch(*this);
 503         TII->InsertBranch(*this, TBB, FallthroughBB, Cond, DL);
 504       }
 505     }
 506   }
 507 }
 508
 509 void MachineBasicBlock::addSuccessor(MachineBasicBlock *Succ, uint32_t Weight) {
 510   // Weight list is either empty (if successor list isn't empty, this means
 511   // disabled optimization) or has the same size as successor list.
 512   if (!(Weights.empty() && !Successors.empty()))
 513     Weights.push_back(Weight);
 514   Successors.push_back(Succ);
 515   Succ->addPredecessor(this);
 516 }
 517
 518 void MachineBasicBlock::addSuccessorWithoutWeight(MachineBasicBlock *Succ) {
 519   // We need to make sure weight list is either empty or has the same size of
 520   // successor list. When this function is called, we can safely delete all
 521   // weight in the list.
 522   Weights.clear();
 523   Successors.push_back(Succ);
 524   Succ->addPredecessor(this);
 525 }
 526
 527 void MachineBasicBlock::addSuccessor(MachineBasicBlock *Succ,
 528                                      BranchProbability Prob) {
 529   // Probability list is either empty (if successor list isn't empty, this means
 530   // disabled optimization) or has the same size as successor list.
 531   if (!(Probs.empty() && !Successors.empty())) {
 532     Probs.push_back(Prob);
 533     // FIXME: Temporarily use the numerator of the probability to represent edge
 534     // weight. This will be removed once all weight-version interfaces in MBB
 535     // are replaced with probability-version interfaces.
 536     Weights.push_back(Prob.getNumerator());
 537   }
 538   Successors.push_back(Succ);
 539   Succ->addPredecessor(this);
 540 }
 541
 542 void MachineBasicBlock::addSuccessorWithoutProb(MachineBasicBlock *Succ) {
 543   // We need to make sure probability list is either empty or has the same size
 544   // of successor list. When this function is called, we can safely delete all
 545   // probability in the list.
 546   Probs.clear();
 547   Weights.clear();
 548   Successors.push_back(Succ);
 549   Succ->addPredecessor(this);
 550 }
 551
 552 void MachineBasicBlock::removeSuccessor(MachineBasicBlock *Succ) {
 553   succ_iterator I = std::find(Successors.begin(), Successors.end(), Succ);
 554   removeSuccessor(I);
 555 }
 556
 557 MachineBasicBlock::succ_iterator
 558 MachineBasicBlock::removeSuccessor(succ_iterator I) {
 559   assert(I != Successors.end() && "Not a current successor!");
 560
 561   // If Weight list is empty it means we don't use it (disabled optimization).
 562   if (!Weights.empty()) {
 563     weight_iterator WI = getWeightIterator(I);
 564     Weights.erase(WI);
 565   }
 566
 567   // FIXME: Temporarily comment the following code as probabilities are now only
 568   // used during instruction lowering, but this interface is called in later
 569   // passes. Uncomment it once all edge weights are replaced with probabilities.
 570 #if 0
 571   // If probability list is empty it means we don't use it (disabled
 572   // optimization).
 573   if (!Probs.empty()) {
 574     probability_iterator WI = getProbabilityIterator(I);
 575     Probs.erase(WI);
 576   }
 577 #endif
 578
 579   (*I)->removePredecessor(this);
 580   return Successors.erase(I);
 581 }
 582
 583 void MachineBasicBlock::replaceSuccessor(MachineBasicBlock *Old,
 584                                          MachineBasicBlock *New) {
 585   if (Old == New)
 586     return;
 587
 588   succ_iterator E = succ_end();
 589   succ_iterator NewI = E;
 590   succ_iterator OldI = E;
 591   for (succ_iterator I = succ_begin(); I != E; ++I) {
 592     if (*I == Old) {
 593       OldI = I;
 594       if (NewI != E)
 595         break;
 596     }
 597     if (*I == New) {
 598       NewI = I;
 599       if (OldI != E)
 600         break;
 601     }
 602   }
 603   assert(OldI != E && "Old is not a successor of this block");
 604
 605   // If New isn't already a successor, let it take Old's place.
 606   if (NewI == E) {
 607     Old->removePredecessor(this);
 608     New->addPredecessor(this);
 609     *OldI = New;
 610     return;
 611   }
 612
 613   // New is already a successor.
 614   // Update its weight instead of adding a duplicate edge.
 615   if (!Weights.empty())
 616     *getWeightIterator(NewI) += *getWeightIterator(OldI);
 617   // FIXME: Temporarily comment the following code as probabilities are now only
 618   // used during instruction lowering, but this interface is called in later
 619   // passes. Uncomment it once all edge weights are replaced with probabilities.
 620 #if 0
 621   // Update its probability instead of adding a duplicate edge.
 622   if (!Probs.empty())
 623     *getProbabilityIterator(NewI) += *getProbabilityIterator(OldI);
 624 #endif
 625   removeSuccessor(OldI);
 626 }
 627
 628 void MachineBasicBlock::addPredecessor(MachineBasicBlock *Pred) {
 629   Predecessors.push_back(Pred);
 630 }
 631
 632 void MachineBasicBlock::removePredecessor(MachineBasicBlock *Pred) {
 633   pred_iterator I = std::find(Predecessors.begin(), Predecessors.end(), Pred);
 634   assert(I != Predecessors.end() && "Pred is not a predecessor of this block!");
 635   Predecessors.erase(I);
 636 }
 637
 638 void MachineBasicBlock::transferSuccessors(MachineBasicBlock *FromMBB) {
 639   if (this == FromMBB)
 640     return;
 641
 642   while (!FromMBB->succ_empty()) {
 643     MachineBasicBlock *Succ = *FromMBB->succ_begin();
 644     uint32_t Weight = 0;
 645
 646     // If Weight list is empty it means we don't use it (disabled optimization).
 647     if (!FromMBB->Weights.empty())
 648       Weight = *FromMBB->Weights.begin();
 649
 650     addSuccessor(Succ, Weight);
 651     FromMBB->removeSuccessor(Succ);
 652   }
 653 }
 654
 655 void
 656 MachineBasicBlock::transferSuccessorsAndUpdatePHIs(MachineBasicBlock *FromMBB) {
 657   if (this == FromMBB)
 658     return;
 659
 660   while (!FromMBB->succ_empty()) {
 661     MachineBasicBlock *Succ = *FromMBB->succ_begin();
 662     uint32_t Weight = 0;
 663     if (!FromMBB->Weights.empty())
 664       Weight = *FromMBB->Weights.begin();
 665     addSuccessor(Succ, Weight);
 666     FromMBB->removeSuccessor(Succ);
 667
 668     // Fix up any PHI nodes in the successor.
 669     for (MachineBasicBlock::instr_iterator MI = Succ->instr_begin(),
 670            ME = Succ->instr_end(); MI != ME && MI->isPHI(); ++MI)
 671       for (unsigned i = 2, e = MI->getNumOperands()+1; i != e; i += 2) {
 672         MachineOperand &MO = MI->getOperand(i);
 673         if (MO.getMBB() == FromMBB)
 674           MO.setMBB(this);
 675       }
 676   }
 677 }
 678
 679 bool MachineBasicBlock::isPredecessor(const MachineBasicBlock *MBB) const {
 680   return std::find(pred_begin(), pred_end(), MBB) != pred_end();
 681 }
 682
 683 bool MachineBasicBlock::isSuccessor(const MachineBasicBlock *MBB) const {
 684   return std::find(succ_begin(), succ_end(), MBB) != succ_end();
 685 }
 686
 687 bool MachineBasicBlock::isLayoutSuccessor(const MachineBasicBlock *MBB) const {
 688   MachineFunction::const_iterator I(this);
 689   return std::next(I) == MachineFunction::const_iterator(MBB);
 690 }
 691
 692 bool MachineBasicBlock::canFallThrough() {
 693   MachineFunction::iterator Fallthrough = getIterator();
 694   ++Fallthrough;
 695   // If FallthroughBlock is off the end of the function, it can't fall through.
 696   if (Fallthrough == getParent()->end())
 697     return false;
 698
 699   // If FallthroughBlock isn't a successor, no fallthrough is possible.
 700   if (!isSuccessor(&*Fallthrough))
 701     return false;
 702
 703   // Analyze the branches, if any, at the end of the block.
 704   MachineBasicBlock *TBB = nullptr, *FBB = nullptr;
 705   SmallVector<MachineOperand, 4> Cond;
 706   const TargetInstrInfo *TII = getParent()->getSubtarget().getInstrInfo();
 707   if (TII->AnalyzeBranch(*this, TBB, FBB, Cond)) {
 708     // If we couldn't analyze the branch, examine the last instruction.
 709     // If the block doesn't end in a known control barrier, assume fallthrough
 710     // is possible. The isPredicated check is needed because this code can be
 711     // called during IfConversion, where an instruction which is normally a
 712     // Barrier is predicated and thus no longer an actual control barrier.
 713     return empty() || !back().isBarrier() || TII->isPredicated(&back());
 714   }
 715
 716   // If there is no branch, control always falls through.
 717   if (!TBB) return true;
 718
 719   // If there is some explicit branch to the fallthrough block, it can obviously
 720   // reach, even though the branch should get folded to fall through implicitly.
 721   if (MachineFunction::iterator(TBB) == Fallthrough ||
 722       MachineFunction::iterator(FBB) == Fallthrough)
 723     return true;
 724
 725   // If it's an unconditional branch to some block not the fall through, it
 726   // doesn't fall through.
 727   if (Cond.empty()) return false;
 728
 729   // Otherwise, if it is conditional and has no explicit false block, it falls
 730   // through.
 731   return FBB == nullptr;
 732 }
 733
 734 MachineBasicBlock *
 735 MachineBasicBlock::SplitCriticalEdge(MachineBasicBlock *Succ, Pass *P) {
 736   // Splitting the critical edge to a landing pad block is non-trivial. Don't do
 737   // it in this generic function.
 738   if (Succ->isEHPad())
 739     return nullptr;
 740
 741   MachineFunction *MF = getParent();
 742   DebugLoc DL;  // FIXME: this is nowhere
 743
 744   // Performance might be harmed on HW that implements branching using exec mask
 745   // where both sides of the branches are always executed.
 746   if (MF->getTarget().requiresStructuredCFG())
 747     return nullptr;
 748
 749   // We may need to update this's terminator, but we can't do that if
 750   // AnalyzeBranch fails. If this uses a jump table, we won't touch it.
 751   const TargetInstrInfo *TII = MF->getSubtarget().getInstrInfo();
 752   MachineBasicBlock *TBB = nullptr, *FBB = nullptr;
 753   SmallVector<MachineOperand, 4> Cond;
 754   if (TII->AnalyzeBranch(*this, TBB, FBB, Cond))
 755     return nullptr;
 756
 757   // Avoid bugpoint weirdness: A block may end with a conditional branch but
 758   // jumps to the same MBB is either case. We have duplicate CFG edges in that
 759   // case that we can't handle. Since this never happens in properly optimized
 760   // code, just skip those edges.
 761   if (TBB && TBB == FBB) {
 762     DEBUG(dbgs() << "Won't split critical edge after degenerate BB#"
 763                  << getNumber() << '\n');
 764     return nullptr;
 765   }
 766
 767   MachineBasicBlock *NMBB = MF->CreateMachineBasicBlock();
 768   MF->insert(std::next(MachineFunction::iterator(this)), NMBB);
 769   DEBUG(dbgs() << "Splitting critical edge:"
 770         " BB#" << getNumber()
 771         << " -- BB#" << NMBB->getNumber()
 772         << " -- BB#" << Succ->getNumber() << '\n');
 773
 774   LiveIntervals *LIS = P->getAnalysisIfAvailable<LiveIntervals>();
 775   SlotIndexes *Indexes = P->getAnalysisIfAvailable<SlotIndexes>();
 776   if (LIS)
 777     LIS->insertMBBInMaps(NMBB);
 778   else if (Indexes)
 779     Indexes->insertMBBInMaps(NMBB);
 780
 781   // On some targets like Mips, branches may kill virtual registers. Make sure
 782   // that LiveVariables is properly updated after updateTerminator replaces the
 783   // terminators.
 784   LiveVariables *LV = P->getAnalysisIfAvailable<LiveVariables>();
 785
 786   // Collect a list of virtual registers killed by the terminators.
 787   SmallVector<unsigned, 4> KilledRegs;
 788   if (LV)
 789     for (instr_iterator I = getFirstInstrTerminator(), E = instr_end();
 790          I != E; ++I) {
 791       MachineInstr *MI = &*I;
 792       for (MachineInstr::mop_iterator OI = MI->operands_begin(),
 793            OE = MI->operands_end(); OI != OE; ++OI) {
 794         if (!OI->isReg() || OI->getReg() == 0 ||
 795             !OI->isUse() || !OI->isKill() || OI->isUndef())
 796           continue;
 797         unsigned Reg = OI->getReg();
 798         if (TargetRegisterInfo::isPhysicalRegister(Reg) ||
 799             LV->getVarInfo(Reg).removeKill(MI)) {
 800           KilledRegs.push_back(Reg);
 801           DEBUG(dbgs() << "Removing terminator kill: " << *MI);
 802           OI->setIsKill(false);
 803         }
 804       }
 805     }
 806
 807   SmallVector<unsigned, 4> UsedRegs;
 808   if (LIS) {
 809     for (instr_iterator I = getFirstInstrTerminator(), E = instr_end();
 810          I != E; ++I) {
 811       MachineInstr *MI = &*I;
 812
 813       for (MachineInstr::mop_iterator OI = MI->operands_begin(),
 814            OE = MI->operands_end(); OI != OE; ++OI) {
 815         if (!OI->isReg() || OI->getReg() == 0)
 816           continue;
 817
 818         unsigned Reg = OI->getReg();
 819         if (std::find(UsedRegs.begin(), UsedRegs.end(), Reg) == UsedRegs.end())
 820           UsedRegs.push_back(Reg);
 821       }
 822     }
 823   }
 824
 825   ReplaceUsesOfBlockWith(Succ, NMBB);
 826
 827   // If updateTerminator() removes instructions, we need to remove them from
 828   // SlotIndexes.
 829   SmallVector<MachineInstr*, 4> Terminators;
 830   if (Indexes) {
 831     for (instr_iterator I = getFirstInstrTerminator(), E = instr_end();
 832          I != E; ++I)
 833       Terminators.push_back(&*I);
 834   }
 835
 836   updateTerminator();
 837
 838   if (Indexes) {
 839     SmallVector<MachineInstr*, 4> NewTerminators;
 840     for (instr_iterator I = getFirstInstrTerminator(), E = instr_end();
 841          I != E; ++I)
 842       NewTerminators.push_back(&*I);
 843
 844     for (SmallVectorImpl<MachineInstr*>::iterator I = Terminators.begin(),
 845         E = Terminators.end(); I != E; ++I) {
 846       if (std::find(NewTerminators.begin(), NewTerminators.end(), *I) ==
 847           NewTerminators.end())
 848        Indexes->removeMachineInstrFromMaps(*I);
 849     }
 850   }
 851
 852   // Insert unconditional "jump Succ" instruction in NMBB if necessary.
 853   NMBB->addSuccessor(Succ);
 854   if (!NMBB->isLayoutSuccessor(Succ)) {
 855     Cond.clear();
 856     TII->InsertBranch(*NMBB, Succ, nullptr, Cond, DL);
 857
 858     if (Indexes) {
 859       for (instr_iterator I = NMBB->instr_begin(), E = NMBB->instr_end();
 860            I != E; ++I) {
 861         // Some instructions may have been moved to NMBB by updateTerminator(),
 862         // so we first remove any instruction that already has an index.
 863         if (Indexes->hasIndex(&*I))
 864           Indexes->removeMachineInstrFromMaps(&*I);
 865         Indexes->insertMachineInstrInMaps(&*I);
 866       }
 867     }
 868   }
 869
 870   // Fix PHI nodes in Succ so they refer to NMBB instead of this
 871   for (MachineBasicBlock::instr_iterator
 872          i = Succ->instr_begin(),e = Succ->instr_end();
 873        i != e && i->isPHI(); ++i)
 874     for (unsigned ni = 1, ne = i->getNumOperands(); ni != ne; ni += 2)
 875       if (i->getOperand(ni+1).getMBB() == this)
 876         i->getOperand(ni+1).setMBB(NMBB);
 877
 878   // Inherit live-ins from the successor
 879   for (const auto &LI : Succ->liveins())
 880     NMBB->addLiveIn(LI);
 881
 882   // Update LiveVariables.
 883   const TargetRegisterInfo *TRI = MF->getSubtarget().getRegisterInfo();
 884   if (LV) {
 885     // Restore kills of virtual registers that were killed by the terminators.
 886     while (!KilledRegs.empty()) {
 887       unsigned Reg = KilledRegs.pop_back_val();
 888       for (instr_iterator I = instr_end(), E = instr_begin(); I != E;) {
 889         if (!(--I)->addRegisterKilled(Reg, TRI, /* addIfNotFound= */ false))
 890           continue;
 891         if (TargetRegisterInfo::isVirtualRegister(Reg))
 892           LV->getVarInfo(Reg).Kills.push_back(&*I);
 893         DEBUG(dbgs() << "Restored terminator kill: " << *I);
 894         break;
 895       }
 896     }
 897     // Update relevant live-through information.
 898     LV->addNewBlock(NMBB, this, Succ);
 899   }
 900
 901   if (LIS) {
 902     // After splitting the edge and updating SlotIndexes, live intervals may be
 903     // in one of two situations, depending on whether this block was the last in
 904     // the function. If the original block was the last in the function, all
 905     // live intervals will end prior to the beginning of the new split block. If
 906     // the original block was not at the end of the function, all live intervals
 907     // will extend to the end of the new split block.
 908
 909     bool isLastMBB =
 910       std::next(MachineFunction::iterator(NMBB)) == getParent()->end();
 911
 912     SlotIndex StartIndex = Indexes->getMBBEndIdx(this);
 913     SlotIndex PrevIndex = StartIndex.getPrevSlot();
 914     SlotIndex EndIndex = Indexes->getMBBEndIdx(NMBB);
 915
 916     // Find the registers used from NMBB in PHIs in Succ.
 917     SmallSet<unsigned, 8> PHISrcRegs;
 918     for (MachineBasicBlock::instr_iterator
 919          I = Succ->instr_begin(), E = Succ->instr_end();
 920          I != E && I->isPHI(); ++I) {
 921       for (unsigned ni = 1, ne = I->getNumOperands(); ni != ne; ni += 2) {
 922         if (I->getOperand(ni+1).getMBB() == NMBB) {
 923           MachineOperand &MO = I->getOperand(ni);
 924           unsigned Reg = MO.getReg();
 925           PHISrcRegs.insert(Reg);
 926           if (MO.isUndef())
 927             continue;
 928
 929           LiveInterval &LI = LIS->getInterval(Reg);
 930           VNInfo *VNI = LI.getVNInfoAt(PrevIndex);
 931           assert(VNI &&
 932                  "PHI sources should be live out of their predecessors.");
 933           LI.addSegment(LiveInterval::Segment(StartIndex, EndIndex, VNI));
 934         }
 935       }
 936     }
 937
 938     MachineRegisterInfo *MRI = &getParent()->getRegInfo();
 939     for (unsigned i = 0, e = MRI->getNumVirtRegs(); i != e; ++i) {
 940       unsigned Reg = TargetRegisterInfo::index2VirtReg(i);
 941       if (PHISrcRegs.count(Reg) || !LIS->hasInterval(Reg))
 942         continue;
 943
 944       LiveInterval &LI = LIS->getInterval(Reg);
 945       if (!LI.liveAt(PrevIndex))
 946         continue;
 947
 948       bool isLiveOut = LI.liveAt(LIS->getMBBStartIdx(Succ));
 949       if (isLiveOut && isLastMBB) {
 950         VNInfo *VNI = LI.getVNInfoAt(PrevIndex);
 951         assert(VNI && "LiveInterval should have VNInfo where it is live.");
 952         LI.addSegment(LiveInterval::Segment(StartIndex, EndIndex, VNI));
 953       } else if (!isLiveOut && !isLastMBB) {
 954         LI.removeSegment(StartIndex, EndIndex);
 955       }
 956     }
 957
 958     // Update all intervals for registers whose uses may have been modified by
 959     // updateTerminator().
 960     LIS->repairIntervalsInRange(this, getFirstTerminator(), end(), UsedRegs);
 961   }
 962
 963   if (MachineDominatorTree *MDT =
 964       P->getAnalysisIfAvailable<MachineDominatorTree>())
 965     MDT->recordSplitCriticalEdge(this, Succ, NMBB);
 966
 967   if (MachineLoopInfo *MLI = P->getAnalysisIfAvailable<MachineLoopInfo>())
 968     if (MachineLoop *TIL = MLI->getLoopFor(this)) {
 969       // If one or the other blocks were not in a loop, the new block is not
 970       // either, and thus LI doesn't need to be updated.
 971       if (MachineLoop *DestLoop = MLI->getLoopFor(Succ)) {
 972         if (TIL == DestLoop) {
 973           // Both in the same loop, the NMBB joins loop.
 974           DestLoop->addBasicBlockToLoop(NMBB, MLI->getBase());
 975         } else if (TIL->contains(DestLoop)) {
 976           // Edge from an outer loop to an inner loop.  Add to the outer loop.
 977           TIL->addBasicBlockToLoop(NMBB, MLI->getBase());
 978         } else if (DestLoop->contains(TIL)) {
 979           // Edge from an inner loop to an outer loop.  Add to the outer loop.
 980           DestLoop->addBasicBlockToLoop(NMBB, MLI->getBase());
 981         } else {
 982           // Edge from two loops with no containment relation.  Because these
 983           // are natural loops, we know that the destination block must be the
 984           // header of its loop (adding a branch into a loop elsewhere would
 985           // create an irreducible loop).
 986           assert(DestLoop->getHeader() == Succ &&
 987                  "Should not create irreducible loops!");
 988           if (MachineLoop *P = DestLoop->getParentLoop())
 989             P->addBasicBlockToLoop(NMBB, MLI->getBase());
 990         }
 991       }
 992     }
 993
 994   return NMBB;
 995 }
 996
 997 /// Prepare MI to be removed from its bundle. This fixes bundle flags on MI's
 998 /// neighboring instructions so the bundle won't be broken by removing MI.
 999 static void unbundleSingleMI(MachineInstr *MI) {
1000   // Removing the first instruction in a bundle.
1001   if (MI->isBundledWithSucc() && !MI->isBundledWithPred())
1002     MI->unbundleFromSucc();
1003   // Removing the last instruction in a bundle.
1004   if (MI->isBundledWithPred() && !MI->isBundledWithSucc())
1005     MI->unbundleFromPred();
1006   // If MI is not bundled, or if it is internal to a bundle, the neighbor flags
1007   // are already fine.
1008 }
1009
1010 MachineBasicBlock::instr_iterator
1011 MachineBasicBlock::erase(MachineBasicBlock::instr_iterator I) {
1012   unbundleSingleMI(&*I);
1013   return Insts.erase(I);
1014 }
1015
1016 MachineInstr *MachineBasicBlock::remove_instr(MachineInstr *MI) {
1017   unbundleSingleMI(MI);
1018   MI->clearFlag(MachineInstr::BundledPred);
1019   MI->clearFlag(MachineInstr::BundledSucc);
1020   return Insts.remove(MI);
1021 }
1022
1023 MachineBasicBlock::instr_iterator
1024 MachineBasicBlock::insert(instr_iterator I, MachineInstr *MI) {
1025   assert(!MI->isBundledWithPred() && !MI->isBundledWithSucc() &&
1026          "Cannot insert instruction with bundle flags");
1027   // Set the bundle flags when inserting inside a bundle.
1028   if (I != instr_end() && I->isBundledWithPred()) {
1029     MI->setFlag(MachineInstr::BundledPred);
1030     MI->setFlag(MachineInstr::BundledSucc);
1031   }
1032   return Insts.insert(I, MI);
1033 }
1034
1035 /// This method unlinks 'this' from the containing function, and returns it, but
1036 /// does not delete it.
1037 MachineBasicBlock *MachineBasicBlock::removeFromParent() {
1038   assert(getParent() && "Not embedded in a function!");
1039   getParent()->remove(this);
1040   return this;
1041 }
1042
1043 /// This method unlinks 'this' from the containing function, and deletes it.
1044 void MachineBasicBlock::eraseFromParent() {
1045   assert(getParent() && "Not embedded in a function!");
1046   getParent()->erase(this);
1047 }
1048
1049 /// Given a machine basic block that branched to 'Old', change the code and CFG
1050 /// so that it branches to 'New' instead.
1051 void MachineBasicBlock::ReplaceUsesOfBlockWith(MachineBasicBlock *Old,
1052                                                MachineBasicBlock *New) {
1053   assert(Old != New && "Cannot replace self with self!");
1054
1055   MachineBasicBlock::instr_iterator I = instr_end();
1056   while (I != instr_begin()) {
1057     --I;
1058     if (!I->isTerminator()) break;
1059
1060     // Scan the operands of this machine instruction, replacing any uses of Old
1061     // with New.
1062     for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
1063       if (I->getOperand(i).isMBB() &&
1064           I->getOperand(i).getMBB() == Old)
1065         I->getOperand(i).setMBB(New);
1066   }
1067
1068   // Update the successor information.
1069   replaceSuccessor(Old, New);
1070 }
1071
1072 /// Various pieces of code can cause excess edges in the CFG to be inserted.  If
1073 /// we have proven that MBB can only branch to DestA and DestB, remove any other
1074 /// MBB successors from the CFG.  DestA and DestB can be null.
1075 ///
1076 /// Besides DestA and DestB, retain other edges leading to LandingPads
1077 /// (currently there can be only one; we don't check or require that here).
1078 /// Note it is possible that DestA and/or DestB are LandingPads.
1079 bool MachineBasicBlock::CorrectExtraCFGEdges(MachineBasicBlock *DestA,
1080                                              MachineBasicBlock *DestB,
1081                                              bool IsCond) {
1082   // The values of DestA and DestB frequently come from a call to the
1083   // 'TargetInstrInfo::AnalyzeBranch' method. We take our meaning of the initial
1084   // values from there.
1085   //
1086   // 1. If both DestA and DestB are null, then the block ends with no branches
1087   //    (it falls through to its successor).
1088   // 2. If DestA is set, DestB is null, and IsCond is false, then the block ends
1089   //    with only an unconditional branch.
1090   // 3. If DestA is set, DestB is null, and IsCond is true, then the block ends
1091   //    with a conditional branch that falls through to a successor (DestB).
1092   // 4. If DestA and DestB is set and IsCond is true, then the block ends with a
1093   //    conditional branch followed by an unconditional branch. DestA is the
1094   //    'true' destination and DestB is the 'false' destination.
1095
1096   bool Changed = false;
1097
1098   MachineFunction::iterator FallThru = std::next(getIterator());
1099
1100   if (!DestA && !DestB) {
1101     // Block falls through to successor.
1102     DestA = &*FallThru;
1103     DestB = &*FallThru;
1104   } else if (DestA && !DestB) {
1105     if (IsCond)
1106       // Block ends in conditional jump that falls through to successor.
1107       DestB = &*FallThru;
1108   } else {
1109     assert(DestA && DestB && IsCond &&
1110            "CFG in a bad state. Cannot correct CFG edges");
1111   }
1112
1113   // Remove superfluous edges. I.e., those which aren't destinations of this
1114   // basic block, duplicate edges, or landing pads.
1115   SmallPtrSet<const MachineBasicBlock*, 8> SeenMBBs;
1116   MachineBasicBlock::succ_iterator SI = succ_begin();
1117   while (SI != succ_end()) {
1118     const MachineBasicBlock *MBB = *SI;
1119     if (!SeenMBBs.insert(MBB).second ||
1120         (MBB != DestA && MBB != DestB && !MBB->isEHPad())) {
1121       // This is a superfluous edge, remove it.
1122       SI = removeSuccessor(SI);
1123       Changed = true;
1124     } else {
1125       ++SI;
1126     }
1127   }
1128
1129   return Changed;
1130 }
1131
1132 /// Find the next valid DebugLoc starting at MBBI, skipping any DBG_VALUE
1133 /// instructions.  Return UnknownLoc if there is none.
1134 DebugLoc
1135 MachineBasicBlock::findDebugLoc(instr_iterator MBBI) {
1136   DebugLoc DL;
1137   instr_iterator E = instr_end();
1138   if (MBBI == E)
1139     return DL;
1140
1141   // Skip debug declarations, we don't want a DebugLoc from them.
1142   while (MBBI != E && MBBI->isDebugValue())
1143     MBBI++;
1144   if (MBBI != E)
1145     DL = MBBI->getDebugLoc();
1146   return DL;
1147 }
1148
1149 /// Return weight of the edge from this block to MBB.
1150 uint32_t MachineBasicBlock::getSuccWeight(const_succ_iterator Succ) const {
1151   if (Weights.empty())
1152     return 0;
1153
1154   return *getWeightIterator(Succ);
1155 }
1156
1157 /// Return probability of the edge from this block to MBB. If probability list
1158 /// is empty, return a default probability which is 1/N, where N is the number
1159 /// of successors. If the probability of the given successor is unknown, then
1160 /// sum up all known probabilities and return the complement of the sum divided
1161 /// by the number of unknown probabilities.
1162 BranchProbability
1163 MachineBasicBlock::getSuccProbability(const_succ_iterator Succ) const {
1164   if (Probs.empty())
1165     return BranchProbability(1, succ_size());
1166
1167   auto Prob = *getProbabilityIterator(Succ);
1168   assert(!Prob.isUnknown());
1169   return Prob;
1170 }
1171
1172 /// Set successor weight of a given iterator.
1173 void MachineBasicBlock::setSuccWeight(succ_iterator I, uint32_t Weight) {
1174   if (Weights.empty())
1175     return;
1176   *getWeightIterator(I) = Weight;
1177 }
1178
1179 /// Set successor probability of a given iterator.
1180 void MachineBasicBlock::setSuccProbability(succ_iterator I,
1181                                            BranchProbability Prob) {
1182   assert(!Prob.isUnknown());
1183   if (Probs.empty() || Weights.empty())
1184     return;
1185   *getProbabilityIterator(I) = Prob;
1186   // FIXME: Temporarily use the numerator of the probability to represent edge
1187   // weight. This will be removed once all weight-version interfaces in MBB
1188   // are replaces with probability-version interfaces.
1189   *getWeightIterator(I) = Prob.getNumerator();
1190 }
1191
1192 /// Return wight iterator corresonding to the I successor iterator.
1193 MachineBasicBlock::weight_iterator MachineBasicBlock::
1194 getWeightIterator(MachineBasicBlock::succ_iterator I) {
1195   assert(Weights.size() == Successors.size() && "Async weight list!");
1196   size_t index = std::distance(Successors.begin(), I);
1197   assert(index < Weights.size() && "Not a current successor!");
1198   return Weights.begin() + index;
1199 }
1200
1201 /// Return wight iterator corresonding to the I successor iterator.
1202 MachineBasicBlock::const_weight_iterator MachineBasicBlock::
1203 getWeightIterator(MachineBasicBlock::const_succ_iterator I) const {
1204   assert(Weights.size() == Successors.size() && "Async weight list!");
1205   const size_t index = std::distance(Successors.begin(), I);
1206   assert(index < Weights.size() && "Not a current successor!");
1207   return Weights.begin() + index;
1208 }
1209
1210 /// Return probability iterator corresonding to the I successor iterator.
1211 MachineBasicBlock::probability_iterator
1212 MachineBasicBlock::getProbabilityIterator(MachineBasicBlock::succ_iterator I) {
1213   assert(Probs.size() == Successors.size() && "Async probability list!");
1214   const size_t index = std::distance(Successors.begin(), I);
1215   assert(index < Probs.size() && "Not a current successor!");
1216   return Probs.begin() + index;
1217 }
1218
1219 /// Return probability iterator corresonding to the I successor iterator
1220 MachineBasicBlock::const_probability_iterator
1221 MachineBasicBlock::getProbabilityIterator(
1222     MachineBasicBlock::const_succ_iterator I) const {
1223   assert(Probs.size() == Successors.size() && "Async probability list!");
1224   const size_t index = std::distance(Successors.begin(), I);
1225   assert(index < Probs.size() && "Not a current successor!");
1226   return Probs.begin() + index;
1227 }
1228
1229 /// Return whether (physical) register "Reg" has been <def>ined and not <kill>ed
1230 /// as of just before "MI".
1231 ///
1232 /// Search is localised to a neighborhood of
1233 /// Neighborhood instructions before (searching for defs or kills) and N
1234 /// instructions after (searching just for defs) MI.
1235 MachineBasicBlock::LivenessQueryResult
1236 MachineBasicBlock::computeRegisterLiveness(const TargetRegisterInfo *TRI,
1237                                            unsigned Reg, const_iterator Before,
1238                                            unsigned Neighborhood) const {
1239   unsigned N = Neighborhood;
1240
1241   // Start by searching backwards from Before, looking for kills, reads or defs.
1242   const_iterator I(Before);
1243   // If this is the first insn in the block, don't search backwards.
1244   if (I != begin()) {
1245     do {
1246       --I;
1247
1248       MachineOperandIteratorBase::PhysRegInfo Analysis =
1249         ConstMIOperands(I).analyzePhysReg(Reg, TRI);
1250
1251       if (Analysis.Defines)
1252         // Outputs happen after inputs so they take precedence if both are
1253         // present.
1254         return Analysis.DefinesDead ? LQR_Dead : LQR_Live;
1255
1256       if (Analysis.Kills || Analysis.Clobbers)
1257         // Register killed, so isn't live.
1258         return LQR_Dead;
1259
1260       else if (Analysis.ReadsOverlap)
1261         // Defined or read without a previous kill - live.
1262         return Analysis.Reads ? LQR_Live : LQR_OverlappingLive;
1263
1264     } while (I != begin() && --N > 0);
1265   }
1266
1267   // Did we get to the start of the block?
1268   if (I == begin()) {
1269     // If so, the register's state is definitely defined by the live-in state.
1270     for (MCRegAliasIterator RAI(Reg, TRI, /*IncludeSelf=*/true);
1271          RAI.isValid(); ++RAI) {
1272       if (isLiveIn(*RAI))
1273         return (*RAI == Reg) ? LQR_Live : LQR_OverlappingLive;
1274     }
1275
1276     return LQR_Dead;
1277   }
1278
1279   N = Neighborhood;
1280
1281   // Try searching forwards from Before, looking for reads or defs.
1282   I = const_iterator(Before);
1283   // If this is the last insn in the block, don't search forwards.
1284   if (I != end()) {
1285     for (++I; I != end() && N > 0; ++I, --N) {
1286       MachineOperandIteratorBase::PhysRegInfo Analysis =
1287         ConstMIOperands(I).analyzePhysReg(Reg, TRI);
1288
1289       if (Analysis.ReadsOverlap)
1290         // Used, therefore must have been live.
1291         return (Analysis.Reads) ?
1292           LQR_Live : LQR_OverlappingLive;
1293
1294       else if (Analysis.Clobbers || Analysis.Defines)
1295         // Defined (but not read) therefore cannot have been live.
1296         return LQR_Dead;
1297     }
1298   }
1299
1300   // At this point we have no idea of the liveness of the register.
1301   return LQR_Unknown;
1302 }
1303
1304 const uint32_t *
1305 MachineBasicBlock::getBeginClobberMask(const TargetRegisterInfo *TRI) const {
1306   // EH funclet entry does not preserve any registers.
1307   return isEHFuncletEntry() ? TRI->getNoPreservedMask() : nullptr;
1308 }
1309
1310 const uint32_t *
1311 MachineBasicBlock::getEndClobberMask(const TargetRegisterInfo *TRI) const {
1312   // If we see a return block with successors, this must be a funclet return,
1313   // which does not preserve any registers. If there are no successors, we don't
1314   // care what kind of return it is, putting a mask after it is a no-op.
1315   return isReturnBlock() && !succ_empty() ? TRI->getNoPreservedMask() : nullptr;
1316 }