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/BasicBlock.h"
  16 #include "llvm/CodeGen/LiveVariables.h"
  17 #include "llvm/CodeGen/MachineDominators.h"
  18 #include "llvm/CodeGen/MachineFunction.h"
  19 #include "llvm/CodeGen/MachineLoopInfo.h"
  20 #include "llvm/CodeGen/SlotIndexes.h"
  21 #include "llvm/MC/MCAsmInfo.h"
  22 #include "llvm/MC/MCContext.h"
  23 #include "llvm/Target/TargetRegisterInfo.h"
  24 #include "llvm/Target/TargetData.h"
  25 #include "llvm/Target/TargetInstrInfo.h"
  26 #include "llvm/Target/TargetMachine.h"
  27 #include "llvm/Assembly/Writer.h"
  28 #include "llvm/ADT/SmallString.h"
  29 #include "llvm/ADT/SmallPtrSet.h"
  30 #include "llvm/Support/Debug.h"
  31 #include "llvm/Support/LeakDetector.h"
  32 #include "llvm/Support/raw_ostream.h"
  33 #include <algorithm>
  34 using namespace llvm;
  35
  36 MachineBasicBlock::MachineBasicBlock(MachineFunction &mf, const BasicBlock *bb)
  37   : BB(bb), Number(-1), xParent(&mf), Alignment(0), IsLandingPad(false),
  38     AddressTaken(false) {
  39   Insts.Parent = this;
  40 }
  41
  42 MachineBasicBlock::~MachineBasicBlock() {
  43   LeakDetector::removeGarbageObject(this);
  44 }
  45
  46 /// getSymbol - Return the MCSymbol for this basic block.
  47 ///
  48 MCSymbol *MachineBasicBlock::getSymbol() const {
  49   const MachineFunction *MF = getParent();
  50   MCContext &Ctx = MF->getContext();
  51   const char *Prefix = Ctx.getAsmInfo().getPrivateGlobalPrefix();
  52   return Ctx.GetOrCreateSymbol(Twine(Prefix) + "BB" +
  53                                Twine(MF->getFunctionNumber()) + "_" +
  54                                Twine(getNumber()));
  55 }
  56
  57
  58 raw_ostream &llvm::operator<<(raw_ostream &OS, const MachineBasicBlock &MBB) {
  59   MBB.print(OS);
  60   return OS;
  61 }
  62
  63 /// addNodeToList (MBB) - When an MBB is added to an MF, we need to update the
  64 /// parent pointer of the MBB, the MBB numbering, and any instructions in the
  65 /// MBB to be on the right operand list for registers.
  66 ///
  67 /// MBBs start out as #-1. When a MBB is added to a MachineFunction, it
  68 /// gets the next available unique MBB number. If it is removed from a
  69 /// MachineFunction, it goes back to being #-1.
  70 void ilist_traits<MachineBasicBlock>::addNodeToList(MachineBasicBlock *N) {
  71   MachineFunction &MF = *N->getParent();
  72   N->Number = MF.addToMBBNumbering(N);
  73
  74   // Make sure the instructions have their operands in the reginfo lists.
  75   MachineRegisterInfo &RegInfo = MF.getRegInfo();
  76   for (MachineBasicBlock::instr_iterator
  77          I = N->instr_begin(), E = N->instr_end(); I != E; ++I)
  78     I->AddRegOperandsToUseLists(RegInfo);
  79
  80   LeakDetector::removeGarbageObject(N);
  81 }
  82
  83 void ilist_traits<MachineBasicBlock>::removeNodeFromList(MachineBasicBlock *N) {
  84   N->getParent()->removeFromMBBNumbering(N->Number);
  85   N->Number = -1;
  86   LeakDetector::addGarbageObject(N);
  87 }
  88
  89
  90 /// addNodeToList (MI) - When we add an instruction to a basic block
  91 /// list, we update its parent pointer and add its operands from reg use/def
  92 /// lists if appropriate.
  93 void ilist_traits<MachineInstr>::addNodeToList(MachineInstr *N) {
  94   assert(N->getParent() == 0 && "machine instruction already in a basic block");
  95   N->setParent(Parent);
  96
  97   // Add the instruction's register operands to their corresponding
  98   // use/def lists.
  99   MachineFunction *MF = Parent->getParent();
 100   N->AddRegOperandsToUseLists(MF->getRegInfo());
 101
 102   LeakDetector::removeGarbageObject(N);
 103 }
 104
 105 /// removeNodeFromList (MI) - When we remove an instruction from a basic block
 106 /// list, we update its parent pointer and remove its operands from reg use/def
 107 /// lists if appropriate.
 108 void ilist_traits<MachineInstr>::removeNodeFromList(MachineInstr *N) {
 109   assert(N->getParent() != 0 && "machine instruction not in a basic block");
 110
 111   // Remove from the use/def lists.
 112   N->RemoveRegOperandsFromUseLists();
 113
 114   N->setParent(0);
 115
 116   LeakDetector::addGarbageObject(N);
 117 }
 118
 119 /// transferNodesFromList (MI) - When moving a range of instructions from one
 120 /// MBB list to another, we need to update the parent pointers and the use/def
 121 /// lists.
 122 void ilist_traits<MachineInstr>::
 123 transferNodesFromList(ilist_traits<MachineInstr> &fromList,
 124                       ilist_iterator<MachineInstr> first,
 125                       ilist_iterator<MachineInstr> last) {
 126   assert(Parent->getParent() == fromList.Parent->getParent() &&
 127         "MachineInstr parent mismatch!");
 128
 129   // Splice within the same MBB -> no change.
 130   if (Parent == fromList.Parent) return;
 131
 132   // If splicing between two blocks within the same function, just update the
 133   // parent pointers.
 134   for (; first != last; ++first)
 135     first->setParent(Parent);
 136 }
 137
 138 void ilist_traits<MachineInstr>::deleteNode(MachineInstr* MI) {
 139   assert(!MI->getParent() && "MI is still in a block!");
 140   Parent->getParent()->DeleteMachineInstr(MI);
 141 }
 142
 143 MachineBasicBlock::iterator MachineBasicBlock::getFirstNonPHI() {
 144   instr_iterator I = instr_begin(), E = instr_end();
 145   while (I != E && I->isPHI())
 146     ++I;
 147   assert(!I->isInsideBundle() && "First non-phi MI cannot be inside a bundle!");
 148   return I;
 149 }
 150
 151 MachineBasicBlock::iterator
 152 MachineBasicBlock::SkipPHIsAndLabels(MachineBasicBlock::iterator I) {
 153   iterator E = end();
 154   while (I != E && (I->isPHI() || I->isLabel() || I->isDebugValue()))
 155     ++I;
 156   // FIXME: This needs to change if we wish to bundle labels / dbg_values
 157   // inside the bundle.
 158   assert(!I->isInsideBundle() &&
 159          "First non-phi / non-label instruction is inside a bundle!");
 160   return I;
 161 }
 162
 163 MachineBasicBlock::iterator MachineBasicBlock::getFirstTerminator() {
 164   iterator B = begin(), E = end(), I = E;
 165   while (I != B && ((--I)->isTerminator() || I->isDebugValue()))
 166     ; /*noop */
 167   while (I != E && !I->isTerminator())
 168     ++I;
 169   return I;
 170 }
 171
 172 MachineBasicBlock::const_iterator
 173 MachineBasicBlock::getFirstTerminator() const {
 174   const_iterator B = begin(), E = end(), I = E;
 175   while (I != B && ((--I)->isTerminator() || I->isDebugValue()))
 176     ; /*noop */
 177   while (I != E && !I->isTerminator())
 178     ++I;
 179   return I;
 180 }
 181
 182 MachineBasicBlock::instr_iterator MachineBasicBlock::getFirstInstrTerminator() {
 183   instr_iterator B = instr_begin(), E = instr_end(), I = E;
 184   while (I != B && ((--I)->isTerminator() || I->isDebugValue()))
 185     ; /*noop */
 186   while (I != E && !I->isTerminator())
 187     ++I;
 188   return I;
 189 }
 190
 191 MachineBasicBlock::iterator MachineBasicBlock::getLastNonDebugInstr() {
 192   // Skip over end-of-block dbg_value instructions.
 193   instr_iterator B = instr_begin(), I = instr_end();
 194   while (I != B) {
 195     --I;
 196     // Return instruction that starts a bundle.
 197     if (I->isDebugValue() || I->isInsideBundle())
 198       continue;
 199     return I;
 200   }
 201   // The block is all debug values.
 202   return end();
 203 }
 204
 205 MachineBasicBlock::const_iterator
 206 MachineBasicBlock::getLastNonDebugInstr() const {
 207   // Skip over end-of-block dbg_value instructions.
 208   const_instr_iterator B = instr_begin(), I = instr_end();
 209   while (I != B) {
 210     --I;
 211     // Return instruction that starts a bundle.
 212     if (I->isDebugValue() || I->isInsideBundle())
 213       continue;
 214     return I;
 215   }
 216   // The block is all debug values.
 217   return end();
 218 }
 219
 220 const MachineBasicBlock *MachineBasicBlock::getLandingPadSuccessor() const {
 221   // A block with a landing pad successor only has one other successor.
 222   if (succ_size() > 2)
 223     return 0;
 224   for (const_succ_iterator I = succ_begin(), E = succ_end(); I != E; ++I)
 225     if ((*I)->isLandingPad())
 226       return *I;
 227   return 0;
 228 }
 229
 230 void MachineBasicBlock::dump() const {
 231   print(dbgs());
 232 }
 233
 234 StringRef MachineBasicBlock::getName() const {
 235   if (const BasicBlock *LBB = getBasicBlock())
 236     return LBB->getName();
 237   else
 238     return "(null)";
 239 }
 240
 241 /// Return a hopefully unique identifier for this block.
 242 std::string MachineBasicBlock::getFullName() const {
 243   std::string Name;
 244   if (getParent())
 245     Name = (getParent()->getFunction()->getName() + ":").str();
 246   if (getBasicBlock())
 247     Name += getBasicBlock()->getName();
 248   else
 249     Name += (Twine("BB") + Twine(getNumber())).str();
 250   return Name;
 251 }
 252
 253 void MachineBasicBlock::print(raw_ostream &OS, SlotIndexes *Indexes) const {
 254   const MachineFunction *MF = getParent();
 255   if (!MF) {
 256     OS << "Can't print out MachineBasicBlock because parent MachineFunction"
 257        << " is null\n";
 258     return;
 259   }
 260
 261   if (Indexes)
 262     OS << Indexes->getMBBStartIdx(this) << '\t';
 263
 264   OS << "BB#" << getNumber() << ": ";
 265
 266   const char *Comma = "";
 267   if (const BasicBlock *LBB = getBasicBlock()) {
 268     OS << Comma << "derived from LLVM BB ";
 269     WriteAsOperand(OS, LBB, /*PrintType=*/false);
 270     Comma = ", ";
 271   }
 272   if (isLandingPad()) { OS << Comma << "EH LANDING PAD"; Comma = ", "; }
 273   if (hasAddressTaken()) { OS << Comma << "ADDRESS TAKEN"; Comma = ", "; }
 274   if (Alignment) {
 275     OS << Comma << "Align " << Alignment << " (" << (1u << Alignment)
 276        << " bytes)";
 277     Comma = ", ";
 278   }
 279
 280   OS << '\n';
 281
 282   const TargetRegisterInfo *TRI = MF->getTarget().getRegisterInfo();
 283   if (!livein_empty()) {
 284     if (Indexes) OS << '\t';
 285     OS << "    Live Ins:";
 286     for (livein_iterator I = livein_begin(),E = livein_end(); I != E; ++I)
 287       OS << ' ' << PrintReg(*I, TRI);
 288     OS << '\n';
 289   }
 290   // Print the preds of this block according to the CFG.
 291   if (!pred_empty()) {
 292     if (Indexes) OS << '\t';
 293     OS << "    Predecessors according to CFG:";
 294     for (const_pred_iterator PI = pred_begin(), E = pred_end(); PI != E; ++PI)
 295       OS << " BB#" << (*PI)->getNumber();
 296     OS << '\n';
 297   }
 298
 299   for (const_instr_iterator I = instr_begin(); I != instr_end(); ++I) {
 300     if (Indexes) {
 301       if (Indexes->hasIndex(I))
 302         OS << Indexes->getInstructionIndex(I);
 303       OS << '\t';
 304     }
 305     OS << '\t';
 306     if (I->isInsideBundle())
 307       OS << "  * ";
 308     I->print(OS, &getParent()->getTarget());
 309   }
 310
 311   // Print the successors of this block according to the CFG.
 312   if (!succ_empty()) {
 313     if (Indexes) OS << '\t';
 314     OS << "    Successors according to CFG:";
 315     for (const_succ_iterator SI = succ_begin(), E = succ_end(); SI != E; ++SI)
 316       OS << " BB#" << (*SI)->getNumber();
 317     OS << '\n';
 318   }
 319 }
 320
 321 void MachineBasicBlock::removeLiveIn(unsigned Reg) {
 322   std::vector<unsigned>::iterator I =
 323     std::find(LiveIns.begin(), LiveIns.end(), Reg);
 324   assert(I != LiveIns.end() && "Not a live in!");
 325   LiveIns.erase(I);
 326 }
 327
 328 bool MachineBasicBlock::isLiveIn(unsigned Reg) const {
 329   livein_iterator I = std::find(livein_begin(), livein_end(), Reg);
 330   return I != livein_end();
 331 }
 332
 333 void MachineBasicBlock::moveBefore(MachineBasicBlock *NewAfter) {
 334   getParent()->splice(NewAfter, this);
 335 }
 336
 337 void MachineBasicBlock::moveAfter(MachineBasicBlock *NewBefore) {
 338   MachineFunction::iterator BBI = NewBefore;
 339   getParent()->splice(++BBI, this);
 340 }
 341
 342 void MachineBasicBlock::updateTerminator() {
 343   const TargetInstrInfo *TII = getParent()->getTarget().getInstrInfo();
 344   // A block with no successors has no concerns with fall-through edges.
 345   if (this->succ_empty()) return;
 346
 347   MachineBasicBlock *TBB = 0, *FBB = 0;
 348   SmallVector<MachineOperand, 4> Cond;
 349   DebugLoc dl;  // FIXME: this is nowhere
 350   bool B = TII->AnalyzeBranch(*this, TBB, FBB, Cond);
 351   (void) B;
 352   assert(!B && "UpdateTerminators requires analyzable predecessors!");
 353   if (Cond.empty()) {
 354     if (TBB) {
 355       // The block has an unconditional branch. If its successor is now
 356       // its layout successor, delete the branch.
 357       if (isLayoutSuccessor(TBB))
 358         TII->RemoveBranch(*this);
 359     } else {
 360       // The block has an unconditional fallthrough. If its successor is not
 361       // its layout successor, insert a branch. First we have to locate the
 362       // only non-landing-pad successor, as that is the fallthrough block.
 363       for (succ_iterator SI = succ_begin(), SE = succ_end(); SI != SE; ++SI) {
 364         if ((*SI)->isLandingPad())
 365           continue;
 366         assert(!TBB && "Found more than one non-landing-pad successor!");
 367         TBB = *SI;
 368       }
 369
 370       // If there is no non-landing-pad successor, the block has no
 371       // fall-through edges to be concerned with.
 372       if (!TBB)
 373         return;
 374
 375       // Finally update the unconditional successor to be reached via a branch
 376       // if it would not be reached by fallthrough.
 377       if (!isLayoutSuccessor(TBB))
 378         TII->InsertBranch(*this, TBB, 0, Cond, dl);
 379     }
 380   } else {
 381     if (FBB) {
 382       // The block has a non-fallthrough conditional branch. If one of its
 383       // successors is its layout successor, rewrite it to a fallthrough
 384       // conditional branch.
 385       if (isLayoutSuccessor(TBB)) {
 386         if (TII->ReverseBranchCondition(Cond))
 387           return;
 388         TII->RemoveBranch(*this);
 389         TII->InsertBranch(*this, FBB, 0, Cond, dl);
 390       } else if (isLayoutSuccessor(FBB)) {
 391         TII->RemoveBranch(*this);
 392         TII->InsertBranch(*this, TBB, 0, Cond, dl);
 393       }
 394     } else {
 395       // The block has a fallthrough conditional branch.
 396       MachineBasicBlock *MBBA = *succ_begin();
 397       MachineBasicBlock *MBBB = *llvm::next(succ_begin());
 398       if (MBBA == TBB) std::swap(MBBB, MBBA);
 399       if (isLayoutSuccessor(TBB)) {
 400         if (TII->ReverseBranchCondition(Cond)) {
 401           // We can't reverse the condition, add an unconditional branch.
 402           Cond.clear();
 403           TII->InsertBranch(*this, MBBA, 0, Cond, dl);
 404           return;
 405         }
 406         TII->RemoveBranch(*this);
 407         TII->InsertBranch(*this, MBBA, 0, Cond, dl);
 408       } else if (!isLayoutSuccessor(MBBA)) {
 409         TII->RemoveBranch(*this);
 410         TII->InsertBranch(*this, TBB, MBBA, Cond, dl);
 411       }
 412     }
 413   }
 414 }
 415
 416 void MachineBasicBlock::addSuccessor(MachineBasicBlock *succ, uint32_t weight) {
 417
 418   // If we see non-zero value for the first time it means we actually use Weight
 419   // list, so we fill all Weights with 0's.
 420   if (weight != 0 && Weights.empty())
 421     Weights.resize(Successors.size());
 422
 423   if (weight != 0 || !Weights.empty())
 424     Weights.push_back(weight);
 425
 426    Successors.push_back(succ);
 427    succ->addPredecessor(this);
 428  }
 429
 430 void MachineBasicBlock::removeSuccessor(MachineBasicBlock *succ) {
 431   succ->removePredecessor(this);
 432   succ_iterator I = std::find(Successors.begin(), Successors.end(), succ);
 433   assert(I != Successors.end() && "Not a current successor!");
 434
 435   // If Weight list is empty it means we don't use it (disabled optimization).
 436   if (!Weights.empty()) {
 437     weight_iterator WI = getWeightIterator(I);
 438     Weights.erase(WI);
 439   }
 440
 441   Successors.erase(I);
 442 }
 443
 444 MachineBasicBlock::succ_iterator
 445 MachineBasicBlock::removeSuccessor(succ_iterator I) {
 446   assert(I != Successors.end() && "Not a current successor!");
 447
 448   // If Weight list is empty it means we don't use it (disabled optimization).
 449   if (!Weights.empty()) {
 450     weight_iterator WI = getWeightIterator(I);
 451     Weights.erase(WI);
 452   }
 453
 454   (*I)->removePredecessor(this);
 455   return Successors.erase(I);
 456 }
 457
 458 void MachineBasicBlock::replaceSuccessor(MachineBasicBlock *Old,
 459                                          MachineBasicBlock *New) {
 460   uint32_t weight = 0;
 461   succ_iterator SI = std::find(Successors.begin(), Successors.end(), Old);
 462
 463   // If Weight list is empty it means we don't use it (disabled optimization).
 464   if (!Weights.empty()) {
 465     weight_iterator WI = getWeightIterator(SI);
 466     weight = *WI;
 467   }
 468
 469   // Update the successor information.
 470   removeSuccessor(SI);
 471   addSuccessor(New, weight);
 472 }
 473
 474 void MachineBasicBlock::addPredecessor(MachineBasicBlock *pred) {
 475   Predecessors.push_back(pred);
 476 }
 477
 478 void MachineBasicBlock::removePredecessor(MachineBasicBlock *pred) {
 479   pred_iterator I = std::find(Predecessors.begin(), Predecessors.end(), pred);
 480   assert(I != Predecessors.end() && "Pred is not a predecessor of this block!");
 481   Predecessors.erase(I);
 482 }
 483
 484 void MachineBasicBlock::transferSuccessors(MachineBasicBlock *fromMBB) {
 485   if (this == fromMBB)
 486     return;
 487
 488   while (!fromMBB->succ_empty()) {
 489     MachineBasicBlock *Succ = *fromMBB->succ_begin();
 490     uint32_t weight = 0;
 491
 492
 493     // If Weight list is empty it means we don't use it (disabled optimization).
 494     if (!fromMBB->Weights.empty())
 495       weight = *fromMBB->Weights.begin();
 496
 497     addSuccessor(Succ, weight);
 498     fromMBB->removeSuccessor(Succ);
 499   }
 500 }
 501
 502 void
 503 MachineBasicBlock::transferSuccessorsAndUpdatePHIs(MachineBasicBlock *fromMBB) {
 504   if (this == fromMBB)
 505     return;
 506
 507   while (!fromMBB->succ_empty()) {
 508     MachineBasicBlock *Succ = *fromMBB->succ_begin();
 509     addSuccessor(Succ);
 510     fromMBB->removeSuccessor(Succ);
 511
 512     // Fix up any PHI nodes in the successor.
 513     for (MachineBasicBlock::instr_iterator MI = Succ->instr_begin(),
 514            ME = Succ->instr_end(); MI != ME && MI->isPHI(); ++MI)
 515       for (unsigned i = 2, e = MI->getNumOperands()+1; i != e; i += 2) {
 516         MachineOperand &MO = MI->getOperand(i);
 517         if (MO.getMBB() == fromMBB)
 518           MO.setMBB(this);
 519       }
 520   }
 521 }
 522
 523 bool MachineBasicBlock::isSuccessor(const MachineBasicBlock *MBB) const {
 524   const_succ_iterator I = std::find(Successors.begin(), Successors.end(), MBB);
 525   return I != Successors.end();
 526 }
 527
 528 bool MachineBasicBlock::isLayoutSuccessor(const MachineBasicBlock *MBB) const {
 529   MachineFunction::const_iterator I(this);
 530   return llvm::next(I) == MachineFunction::const_iterator(MBB);
 531 }
 532
 533 bool MachineBasicBlock::canFallThrough() {
 534   MachineFunction::iterator Fallthrough = this;
 535   ++Fallthrough;
 536   // If FallthroughBlock is off the end of the function, it can't fall through.
 537   if (Fallthrough == getParent()->end())
 538     return false;
 539
 540   // If FallthroughBlock isn't a successor, no fallthrough is possible.
 541   if (!isSuccessor(Fallthrough))
 542     return false;
 543
 544   // Analyze the branches, if any, at the end of the block.
 545   MachineBasicBlock *TBB = 0, *FBB = 0;
 546   SmallVector<MachineOperand, 4> Cond;
 547   const TargetInstrInfo *TII = getParent()->getTarget().getInstrInfo();
 548   if (TII->AnalyzeBranch(*this, TBB, FBB, Cond)) {
 549     // If we couldn't analyze the branch, examine the last instruction.
 550     // If the block doesn't end in a known control barrier, assume fallthrough
 551     // is possible. The isPredicated check is needed because this code can be
 552     // called during IfConversion, where an instruction which is normally a
 553     // Barrier is predicated and thus no longer an actual control barrier.
 554     return empty() || !back().isBarrier() || TII->isPredicated(&back());
 555   }
 556
 557   // If there is no branch, control always falls through.
 558   if (TBB == 0) return true;
 559
 560   // If there is some explicit branch to the fallthrough block, it can obviously
 561   // reach, even though the branch should get folded to fall through implicitly.
 562   if (MachineFunction::iterator(TBB) == Fallthrough ||
 563       MachineFunction::iterator(FBB) == Fallthrough)
 564     return true;
 565
 566   // If it's an unconditional branch to some block not the fall through, it
 567   // doesn't fall through.
 568   if (Cond.empty()) return false;
 569
 570   // Otherwise, if it is conditional and has no explicit false block, it falls
 571   // through.
 572   return FBB == 0;
 573 }
 574
 575 MachineBasicBlock *
 576 MachineBasicBlock::SplitCriticalEdge(MachineBasicBlock *Succ, Pass *P) {
 577   MachineFunction *MF = getParent();
 578   DebugLoc dl;  // FIXME: this is nowhere
 579
 580   // We may need to update this's terminator, but we can't do that if
 581   // AnalyzeBranch fails. If this uses a jump table, we won't touch it.
 582   const TargetInstrInfo *TII = MF->getTarget().getInstrInfo();
 583   MachineBasicBlock *TBB = 0, *FBB = 0;
 584   SmallVector<MachineOperand, 4> Cond;
 585   if (TII->AnalyzeBranch(*this, TBB, FBB, Cond))
 586     return NULL;
 587
 588   // Avoid bugpoint weirdness: A block may end with a conditional branch but
 589   // jumps to the same MBB is either case. We have duplicate CFG edges in that
 590   // case that we can't handle. Since this never happens in properly optimized
 591   // code, just skip those edges.
 592   if (TBB && TBB == FBB) {
 593     DEBUG(dbgs() << "Won't split critical edge after degenerate BB#"
 594                  << getNumber() << '\n');
 595     return NULL;
 596   }
 597
 598   MachineBasicBlock *NMBB = MF->CreateMachineBasicBlock();
 599   MF->insert(llvm::next(MachineFunction::iterator(this)), NMBB);
 600   DEBUG(dbgs() << "Splitting critical edge:"
 601         " BB#" << getNumber()
 602         << " -- BB#" << NMBB->getNumber()
 603         << " -- BB#" << Succ->getNumber() << '\n');
 604
 605   // On some targets like Mips, branches may kill virtual registers. Make sure
 606   // that LiveVariables is properly updated after updateTerminator replaces the
 607   // terminators.
 608   LiveVariables *LV = P->getAnalysisIfAvailable<LiveVariables>();
 609
 610   // Collect a list of virtual registers killed by the terminators.
 611   SmallVector<unsigned, 4> KilledRegs;
 612   if (LV)
 613     for (instr_iterator I = getFirstInstrTerminator(), E = instr_end();
 614          I != E; ++I) {
 615       MachineInstr *MI = I;
 616       for (MachineInstr::mop_iterator OI = MI->operands_begin(),
 617            OE = MI->operands_end(); OI != OE; ++OI) {
 618         if (!OI->isReg() || OI->getReg() == 0 ||
 619             !OI->isUse() || !OI->isKill() || OI->isUndef())
 620           continue;
 621         unsigned Reg = OI->getReg();
 622         if (TargetRegisterInfo::isPhysicalRegister(Reg) ||
 623             LV->getVarInfo(Reg).removeKill(MI)) {
 624           KilledRegs.push_back(Reg);
 625           DEBUG(dbgs() << "Removing terminator kill: " << *MI);
 626           OI->setIsKill(false);
 627         }
 628       }
 629     }
 630
 631   ReplaceUsesOfBlockWith(Succ, NMBB);
 632   updateTerminator();
 633
 634   // Insert unconditional "jump Succ" instruction in NMBB if necessary.
 635   NMBB->addSuccessor(Succ);
 636   if (!NMBB->isLayoutSuccessor(Succ)) {
 637     Cond.clear();
 638     MF->getTarget().getInstrInfo()->InsertBranch(*NMBB, Succ, NULL, Cond, dl);
 639   }
 640
 641   // Fix PHI nodes in Succ so they refer to NMBB instead of this
 642   for (MachineBasicBlock::instr_iterator
 643          i = Succ->instr_begin(),e = Succ->instr_end();
 644        i != e && i->isPHI(); ++i)
 645     for (unsigned ni = 1, ne = i->getNumOperands(); ni != ne; ni += 2)
 646       if (i->getOperand(ni+1).getMBB() == this)
 647         i->getOperand(ni+1).setMBB(NMBB);
 648
 649   // Inherit live-ins from the successor
 650   for (MachineBasicBlock::livein_iterator I = Succ->livein_begin(),
 651          E = Succ->livein_end(); I != E; ++I)
 652     NMBB->addLiveIn(*I);
 653
 654   // Update LiveVariables.
 655   const TargetRegisterInfo *TRI = MF->getTarget().getRegisterInfo();
 656   if (LV) {
 657     // Restore kills of virtual registers that were killed by the terminators.
 658     while (!KilledRegs.empty()) {
 659       unsigned Reg = KilledRegs.pop_back_val();
 660       for (instr_iterator I = instr_end(), E = instr_begin(); I != E;) {
 661         if (!(--I)->addRegisterKilled(Reg, TRI, /* addIfNotFound= */ false))
 662           continue;
 663         if (TargetRegisterInfo::isVirtualRegister(Reg))
 664           LV->getVarInfo(Reg).Kills.push_back(I);
 665         DEBUG(dbgs() << "Restored terminator kill: " << *I);
 666         break;
 667       }
 668     }
 669     // Update relevant live-through information.
 670     LV->addNewBlock(NMBB, this, Succ);
 671   }
 672
 673   if (MachineDominatorTree *MDT =
 674       P->getAnalysisIfAvailable<MachineDominatorTree>()) {
 675     // Update dominator information.
 676     MachineDomTreeNode *SucccDTNode = MDT->getNode(Succ);
 677
 678     bool IsNewIDom = true;
 679     for (const_pred_iterator PI = Succ->pred_begin(), E = Succ->pred_end();
 680          PI != E; ++PI) {
 681       MachineBasicBlock *PredBB = *PI;
 682       if (PredBB == NMBB)
 683         continue;
 684       if (!MDT->dominates(SucccDTNode, MDT->getNode(PredBB))) {
 685         IsNewIDom = false;
 686         break;
 687       }
 688     }
 689
 690     // We know "this" dominates the newly created basic block.
 691     MachineDomTreeNode *NewDTNode = MDT->addNewBlock(NMBB, this);
 692
 693     // If all the other predecessors of "Succ" are dominated by "Succ" itself
 694     // then the new block is the new immediate dominator of "Succ". Otherwise,
 695     // the new block doesn't dominate anything.
 696     if (IsNewIDom)
 697       MDT->changeImmediateDominator(SucccDTNode, NewDTNode);
 698   }
 699
 700   if (MachineLoopInfo *MLI = P->getAnalysisIfAvailable<MachineLoopInfo>())
 701     if (MachineLoop *TIL = MLI->getLoopFor(this)) {
 702       // If one or the other blocks were not in a loop, the new block is not
 703       // either, and thus LI doesn't need to be updated.
 704       if (MachineLoop *DestLoop = MLI->getLoopFor(Succ)) {
 705         if (TIL == DestLoop) {
 706           // Both in the same loop, the NMBB joins loop.
 707           DestLoop->addBasicBlockToLoop(NMBB, MLI->getBase());
 708         } else if (TIL->contains(DestLoop)) {
 709           // Edge from an outer loop to an inner loop.  Add to the outer loop.
 710           TIL->addBasicBlockToLoop(NMBB, MLI->getBase());
 711         } else if (DestLoop->contains(TIL)) {
 712           // Edge from an inner loop to an outer loop.  Add to the outer loop.
 713           DestLoop->addBasicBlockToLoop(NMBB, MLI->getBase());
 714         } else {
 715           // Edge from two loops with no containment relation.  Because these
 716           // are natural loops, we know that the destination block must be the
 717           // header of its loop (adding a branch into a loop elsewhere would
 718           // create an irreducible loop).
 719           assert(DestLoop->getHeader() == Succ &&
 720                  "Should not create irreducible loops!");
 721           if (MachineLoop *P = DestLoop->getParentLoop())
 722             P->addBasicBlockToLoop(NMBB, MLI->getBase());
 723         }
 724       }
 725     }
 726
 727   return NMBB;
 728 }
 729
 730 MachineBasicBlock::iterator
 731 MachineBasicBlock::erase(MachineBasicBlock::iterator I) {
 732   if (I->isBundle()) {
 733     MachineBasicBlock::iterator E = llvm::next(I);
 734     return Insts.erase(I.getInstrIterator(), E.getInstrIterator());
 735   }
 736
 737   return Insts.erase(I.getInstrIterator());
 738 }
 739
 740 MachineInstr *MachineBasicBlock::remove(MachineInstr *I) {
 741   if (I->isBundle()) {
 742     instr_iterator MII = llvm::next(I);
 743     iterator E = end();
 744     while (MII != E && MII->isInsideBundle()) {
 745       MachineInstr *MI = &*MII++;
 746       Insts.remove(MI);
 747     }
 748   }
 749
 750   return Insts.remove(I);
 751 }
 752
 753 void MachineBasicBlock::splice(MachineBasicBlock::iterator where,
 754                                MachineBasicBlock *Other,
 755                                MachineBasicBlock::iterator From) {
 756   if (From->isBundle()) {
 757     MachineBasicBlock::iterator To = llvm::next(From);
 758     Insts.splice(where.getInstrIterator(), Other->Insts,
 759                  From.getInstrIterator(), To.getInstrIterator());
 760     return;
 761   }
 762
 763   Insts.splice(where.getInstrIterator(), Other->Insts, From.getInstrIterator());
 764 }
 765
 766 /// removeFromParent - This method unlinks 'this' from the containing function,
 767 /// and returns it, but does not delete it.
 768 MachineBasicBlock *MachineBasicBlock::removeFromParent() {
 769   assert(getParent() && "Not embedded in a function!");
 770   getParent()->remove(this);
 771   return this;
 772 }
 773
 774
 775 /// eraseFromParent - This method unlinks 'this' from the containing function,
 776 /// and deletes it.
 777 void MachineBasicBlock::eraseFromParent() {
 778   assert(getParent() && "Not embedded in a function!");
 779   getParent()->erase(this);
 780 }
 781
 782
 783 /// ReplaceUsesOfBlockWith - Given a machine basic block that branched to
 784 /// 'Old', change the code and CFG so that it branches to 'New' instead.
 785 void MachineBasicBlock::ReplaceUsesOfBlockWith(MachineBasicBlock *Old,
 786                                                MachineBasicBlock *New) {
 787   assert(Old != New && "Cannot replace self with self!");
 788
 789   MachineBasicBlock::instr_iterator I = instr_end();
 790   while (I != instr_begin()) {
 791     --I;
 792     if (!I->isTerminator()) break;
 793
 794     // Scan the operands of this machine instruction, replacing any uses of Old
 795     // with New.
 796     for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
 797       if (I->getOperand(i).isMBB() &&
 798           I->getOperand(i).getMBB() == Old)
 799         I->getOperand(i).setMBB(New);
 800   }
 801
 802   // Update the successor information.
 803   replaceSuccessor(Old, New);
 804 }
 805
 806 /// CorrectExtraCFGEdges - Various pieces of code can cause excess edges in the
 807 /// CFG to be inserted.  If we have proven that MBB can only branch to DestA and
 808 /// DestB, remove any other MBB successors from the CFG.  DestA and DestB can be
 809 /// null.
 810 ///
 811 /// Besides DestA and DestB, retain other edges leading to LandingPads
 812 /// (currently there can be only one; we don't check or require that here).
 813 /// Note it is possible that DestA and/or DestB are LandingPads.
 814 bool MachineBasicBlock::CorrectExtraCFGEdges(MachineBasicBlock *DestA,
 815                                              MachineBasicBlock *DestB,
 816                                              bool isCond) {
 817   // The values of DestA and DestB frequently come from a call to the
 818   // 'TargetInstrInfo::AnalyzeBranch' method. We take our meaning of the initial
 819   // values from there.
 820   //
 821   // 1. If both DestA and DestB are null, then the block ends with no branches
 822   //    (it falls through to its successor).
 823   // 2. If DestA is set, DestB is null, and isCond is false, then the block ends
 824   //    with only an unconditional branch.
 825   // 3. If DestA is set, DestB is null, and isCond is true, then the block ends
 826   //    with a conditional branch that falls through to a successor (DestB).
 827   // 4. If DestA and DestB is set and isCond is true, then the block ends with a
 828   //    conditional branch followed by an unconditional branch. DestA is the
 829   //    'true' destination and DestB is the 'false' destination.
 830
 831   bool Changed = false;
 832
 833   MachineFunction::iterator FallThru =
 834     llvm::next(MachineFunction::iterator(this));
 835
 836   if (DestA == 0 && DestB == 0) {
 837     // Block falls through to successor.
 838     DestA = FallThru;
 839     DestB = FallThru;
 840   } else if (DestA != 0 && DestB == 0) {
 841     if (isCond)
 842       // Block ends in conditional jump that falls through to successor.
 843       DestB = FallThru;
 844   } else {
 845     assert(DestA && DestB && isCond &&
 846            "CFG in a bad state. Cannot correct CFG edges");
 847   }
 848
 849   // Remove superfluous edges. I.e., those which aren't destinations of this
 850   // basic block, duplicate edges, or landing pads.
 851   SmallPtrSet<const MachineBasicBlock*, 8> SeenMBBs;
 852   MachineBasicBlock::succ_iterator SI = succ_begin();
 853   while (SI != succ_end()) {
 854     const MachineBasicBlock *MBB = *SI;
 855     if (!SeenMBBs.insert(MBB) ||
 856         (MBB != DestA && MBB != DestB && !MBB->isLandingPad())) {
 857       // This is a superfluous edge, remove it.
 858       SI = removeSuccessor(SI);
 859       Changed = true;
 860     } else {
 861       ++SI;
 862     }
 863   }
 864
 865   return Changed;
 866 }
 867
 868 /// findDebugLoc - find the next valid DebugLoc starting at MBBI, skipping
 869 /// any DBG_VALUE instructions.  Return UnknownLoc if there is none.
 870 DebugLoc
 871 MachineBasicBlock::findDebugLoc(instr_iterator MBBI) {
 872   DebugLoc DL;
 873   instr_iterator E = instr_end();
 874   if (MBBI == E)
 875     return DL;
 876
 877   // Skip debug declarations, we don't want a DebugLoc from them.
 878   while (MBBI != E && MBBI->isDebugValue())
 879     MBBI++;
 880   if (MBBI != E)
 881     DL = MBBI->getDebugLoc();
 882   return DL;
 883 }
 884
 885 /// getSuccWeight - Return weight of the edge from this block to MBB.
 886 ///
 887 uint32_t MachineBasicBlock::getSuccWeight(const MachineBasicBlock *succ) const {
 888   if (Weights.empty())
 889     return 0;
 890
 891   const_succ_iterator I = std::find(Successors.begin(), Successors.end(), succ);
 892   return *getWeightIterator(I);
 893 }
 894
 895 /// getWeightIterator - Return wight iterator corresonding to the I successor
 896 /// iterator
 897 MachineBasicBlock::weight_iterator MachineBasicBlock::
 898 getWeightIterator(MachineBasicBlock::succ_iterator I) {
 899   assert(Weights.size() == Successors.size() && "Async weight list!");
 900   size_t index = std::distance(Successors.begin(), I);
 901   assert(index < Weights.size() && "Not a current successor!");
 902   return Weights.begin() + index;
 903 }
 904
 905 /// getWeightIterator - Return wight iterator corresonding to the I successor
 906 /// iterator
 907 MachineBasicBlock::const_weight_iterator MachineBasicBlock::
 908 getWeightIterator(MachineBasicBlock::const_succ_iterator I) const {
 909   assert(Weights.size() == Successors.size() && "Async weight list!");
 910   const size_t index = std::distance(Successors.begin(), I);
 911   assert(index < Weights.size() && "Not a current successor!");
 912   return Weights.begin() + index;
 913 }
 914
 915 void llvm::WriteAsOperand(raw_ostream &OS, const MachineBasicBlock *MBB,
 916                           bool t) {
 917   OS << "BB#" << MBB->getNumber();
 918 }
 919