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/MachineFunction.h"
  17 #include "llvm/MC/MCAsmInfo.h"
  18 #include "llvm/MC/MCContext.h"
  19 #include "llvm/Target/TargetRegisterInfo.h"
  20 #include "llvm/Target/TargetData.h"
  21 #include "llvm/Target/TargetInstrDesc.h"
  22 #include "llvm/Target/TargetInstrInfo.h"
  23 #include "llvm/Target/TargetMachine.h"
  24 #include "llvm/Assembly/Writer.h"
  25 #include "llvm/ADT/SmallString.h"
  26 #include "llvm/ADT/SmallPtrSet.h"
  27 #include "llvm/Support/Debug.h"
  28 #include "llvm/Support/LeakDetector.h"
  29 #include "llvm/Support/raw_ostream.h"
  30 #include <algorithm>
  31 using namespace llvm;
  32
  33 MachineBasicBlock::MachineBasicBlock(MachineFunction &mf, const BasicBlock *bb)
  34   : BB(bb), Number(-1), xParent(&mf), Alignment(0), IsLandingPad(false),
  35     AddressTaken(false) {
  36   Insts.Parent = this;
  37 }
  38
  39 MachineBasicBlock::~MachineBasicBlock() {
  40   LeakDetector::removeGarbageObject(this);
  41 }
  42
  43 /// getSymbol - Return the MCSymbol for this basic block.
  44 ///
  45 MCSymbol *MachineBasicBlock::getSymbol() const {
  46   const MachineFunction *MF = getParent();
  47   MCContext &Ctx = MF->getContext();
  48   const char *Prefix = Ctx.getAsmInfo().getPrivateGlobalPrefix();
  49   return Ctx.GetOrCreateSymbol(Twine(Prefix) + "BB" +
  50                                Twine(MF->getFunctionNumber()) + "_" +
  51                                Twine(getNumber()));
  52 }
  53
  54
  55 raw_ostream &llvm::operator<<(raw_ostream &OS, const MachineBasicBlock &MBB) {
  56   MBB.print(OS);
  57   return OS;
  58 }
  59
  60 /// addNodeToList (MBB) - When an MBB is added to an MF, we need to update the
  61 /// parent pointer of the MBB, the MBB numbering, and any instructions in the
  62 /// MBB to be on the right operand list for registers.
  63 ///
  64 /// MBBs start out as #-1. When a MBB is added to a MachineFunction, it
  65 /// gets the next available unique MBB number. If it is removed from a
  66 /// MachineFunction, it goes back to being #-1.
  67 void ilist_traits<MachineBasicBlock>::addNodeToList(MachineBasicBlock *N) {
  68   MachineFunction &MF = *N->getParent();
  69   N->Number = MF.addToMBBNumbering(N);
  70
  71   // Make sure the instructions have their operands in the reginfo lists.
  72   MachineRegisterInfo &RegInfo = MF.getRegInfo();
  73   for (MachineBasicBlock::iterator I = N->begin(), E = N->end(); I != E; ++I)
  74     I->AddRegOperandsToUseLists(RegInfo);
  75
  76   LeakDetector::removeGarbageObject(N);
  77 }
  78
  79 void ilist_traits<MachineBasicBlock>::removeNodeFromList(MachineBasicBlock *N) {
  80   N->getParent()->removeFromMBBNumbering(N->Number);
  81   N->Number = -1;
  82   LeakDetector::addGarbageObject(N);
  83 }
  84
  85
  86 /// addNodeToList (MI) - When we add an instruction to a basic block
  87 /// list, we update its parent pointer and add its operands from reg use/def
  88 /// lists if appropriate.
  89 void ilist_traits<MachineInstr>::addNodeToList(MachineInstr *N) {
  90   assert(N->getParent() == 0 && "machine instruction already in a basic block");
  91   N->setParent(Parent);
  92
  93   // Add the instruction's register operands to their corresponding
  94   // use/def lists.
  95   MachineFunction *MF = Parent->getParent();
  96   N->AddRegOperandsToUseLists(MF->getRegInfo());
  97
  98   LeakDetector::removeGarbageObject(N);
  99 }
 100
 101 /// removeNodeFromList (MI) - When we remove an instruction from a basic block
 102 /// list, we update its parent pointer and remove its operands from reg use/def
 103 /// lists if appropriate.
 104 void ilist_traits<MachineInstr>::removeNodeFromList(MachineInstr *N) {
 105   assert(N->getParent() != 0 && "machine instruction not in a basic block");
 106
 107   // Remove from the use/def lists.
 108   N->RemoveRegOperandsFromUseLists();
 109
 110   N->setParent(0);
 111
 112   LeakDetector::addGarbageObject(N);
 113 }
 114
 115 /// transferNodesFromList (MI) - When moving a range of instructions from one
 116 /// MBB list to another, we need to update the parent pointers and the use/def
 117 /// lists.
 118 void ilist_traits<MachineInstr>::
 119 transferNodesFromList(ilist_traits<MachineInstr> &fromList,
 120                       MachineBasicBlock::iterator first,
 121                       MachineBasicBlock::iterator last) {
 122   assert(Parent->getParent() == fromList.Parent->getParent() &&
 123         "MachineInstr parent mismatch!");
 124
 125   // Splice within the same MBB -> no change.
 126   if (Parent == fromList.Parent) return;
 127
 128   // If splicing between two blocks within the same function, just update the
 129   // parent pointers.
 130   for (; first != last; ++first)
 131     first->setParent(Parent);
 132 }
 133
 134 void ilist_traits<MachineInstr>::deleteNode(MachineInstr* MI) {
 135   assert(!MI->getParent() && "MI is still in a block!");
 136   Parent->getParent()->DeleteMachineInstr(MI);
 137 }
 138
 139 MachineBasicBlock::iterator MachineBasicBlock::getFirstTerminator() {
 140   iterator I = end();
 141   while (I != begin() && (--I)->getDesc().isTerminator())
 142     ; /*noop */
 143   if (I != end() && !I->getDesc().isTerminator()) ++I;
 144   return I;
 145 }
 146
 147 void MachineBasicBlock::dump() const {
 148   print(dbgs());
 149 }
 150
 151 static inline void OutputReg(raw_ostream &os, unsigned RegNo,
 152                              const TargetRegisterInfo *TRI = 0) {
 153   if (RegNo != 0 && TargetRegisterInfo::isPhysicalRegister(RegNo)) {
 154     if (TRI)
 155       os << " %" << TRI->get(RegNo).Name;
 156     else
 157       os << " %physreg" << RegNo;
 158   } else
 159     os << " %reg" << RegNo;
 160 }
 161
 162 StringRef MachineBasicBlock::getName() const {
 163   if (const BasicBlock *LBB = getBasicBlock())
 164     return LBB->getName();
 165   else
 166     return "(null)";
 167 }
 168
 169 void MachineBasicBlock::print(raw_ostream &OS) const {
 170   const MachineFunction *MF = getParent();
 171   if (!MF) {
 172     OS << "Can't print out MachineBasicBlock because parent MachineFunction"
 173        << " is null\n";
 174     return;
 175   }
 176
 177   if (Alignment) { OS << "Alignment " << Alignment << "\n"; }
 178
 179   OS << "BB#" << getNumber() << ": ";
 180
 181   const char *Comma = "";
 182   if (const BasicBlock *LBB = getBasicBlock()) {
 183     OS << Comma << "derived from LLVM BB ";
 184     WriteAsOperand(OS, LBB, /*PrintType=*/false);
 185     Comma = ", ";
 186   }
 187   if (isLandingPad()) { OS << Comma << "EH LANDING PAD"; Comma = ", "; }
 188   if (hasAddressTaken()) { OS << Comma << "ADDRESS TAKEN"; Comma = ", "; }
 189   OS << '\n';
 190
 191   const TargetRegisterInfo *TRI = MF->getTarget().getRegisterInfo();
 192   if (!livein_empty()) {
 193     OS << "    Live Ins:";
 194     for (livein_iterator I = livein_begin(),E = livein_end(); I != E; ++I)
 195       OutputReg(OS, *I, TRI);
 196     OS << '\n';
 197   }
 198   // Print the preds of this block according to the CFG.
 199   if (!pred_empty()) {
 200     OS << "    Predecessors according to CFG:";
 201     for (const_pred_iterator PI = pred_begin(), E = pred_end(); PI != E; ++PI)
 202       OS << " BB#" << (*PI)->getNumber();
 203     OS << '\n';
 204   }
 205
 206   for (const_iterator I = begin(); I != end(); ++I) {
 207     OS << '\t';
 208     I->print(OS, &getParent()->getTarget());
 209   }
 210
 211   // Print the successors of this block according to the CFG.
 212   if (!succ_empty()) {
 213     OS << "    Successors according to CFG:";
 214     for (const_succ_iterator SI = succ_begin(), E = succ_end(); SI != E; ++SI)
 215       OS << " BB#" << (*SI)->getNumber();
 216     OS << '\n';
 217   }
 218 }
 219
 220 void MachineBasicBlock::removeLiveIn(unsigned Reg) {
 221   std::vector<unsigned>::iterator I =
 222     std::find(LiveIns.begin(), LiveIns.end(), Reg);
 223   assert(I != LiveIns.end() && "Not a live in!");
 224   LiveIns.erase(I);
 225 }
 226
 227 bool MachineBasicBlock::isLiveIn(unsigned Reg) const {
 228   livein_iterator I = std::find(livein_begin(), livein_end(), Reg);
 229   return I != livein_end();
 230 }
 231
 232 void MachineBasicBlock::moveBefore(MachineBasicBlock *NewAfter) {
 233   getParent()->splice(NewAfter, this);
 234 }
 235
 236 void MachineBasicBlock::moveAfter(MachineBasicBlock *NewBefore) {
 237   MachineFunction::iterator BBI = NewBefore;
 238   getParent()->splice(++BBI, this);
 239 }
 240
 241 void MachineBasicBlock::updateTerminator() {
 242   const TargetInstrInfo *TII = getParent()->getTarget().getInstrInfo();
 243   // A block with no successors has no concerns with fall-through edges.
 244   if (this->succ_empty()) return;
 245
 246   MachineBasicBlock *TBB = 0, *FBB = 0;
 247   SmallVector<MachineOperand, 4> Cond;
 248   DebugLoc dl;  // FIXME: this is nowhere
 249   bool B = TII->AnalyzeBranch(*this, TBB, FBB, Cond);
 250   (void) B;
 251   assert(!B && "UpdateTerminators requires analyzable predecessors!");
 252   if (Cond.empty()) {
 253     if (TBB) {
 254       // The block has an unconditional branch. If its successor is now
 255       // its layout successor, delete the branch.
 256       if (isLayoutSuccessor(TBB))
 257         TII->RemoveBranch(*this);
 258     } else {
 259       // The block has an unconditional fallthrough. If its successor is not
 260       // its layout successor, insert a branch.
 261       TBB = *succ_begin();
 262       if (!isLayoutSuccessor(TBB))
 263         TII->InsertBranch(*this, TBB, 0, Cond, dl);
 264     }
 265   } else {
 266     if (FBB) {
 267       // The block has a non-fallthrough conditional branch. If one of its
 268       // successors is its layout successor, rewrite it to a fallthrough
 269       // conditional branch.
 270       if (isLayoutSuccessor(TBB)) {
 271         if (TII->ReverseBranchCondition(Cond))
 272           return;
 273         TII->RemoveBranch(*this);
 274         TII->InsertBranch(*this, FBB, 0, Cond, dl);
 275       } else if (isLayoutSuccessor(FBB)) {
 276         TII->RemoveBranch(*this);
 277         TII->InsertBranch(*this, TBB, 0, Cond, dl);
 278       }
 279     } else {
 280       // The block has a fallthrough conditional branch.
 281       MachineBasicBlock *MBBA = *succ_begin();
 282       MachineBasicBlock *MBBB = *llvm::next(succ_begin());
 283       if (MBBA == TBB) std::swap(MBBB, MBBA);
 284       if (isLayoutSuccessor(TBB)) {
 285         if (TII->ReverseBranchCondition(Cond)) {
 286           // We can't reverse the condition, add an unconditional branch.
 287           Cond.clear();
 288           TII->InsertBranch(*this, MBBA, 0, Cond, dl);
 289           return;
 290         }
 291         TII->RemoveBranch(*this);
 292         TII->InsertBranch(*this, MBBA, 0, Cond, dl);
 293       } else if (!isLayoutSuccessor(MBBA)) {
 294         TII->RemoveBranch(*this);
 295         TII->InsertBranch(*this, TBB, MBBA, Cond, dl);
 296       }
 297     }
 298   }
 299 }
 300
 301 void MachineBasicBlock::addSuccessor(MachineBasicBlock *succ) {
 302   Successors.push_back(succ);
 303   succ->addPredecessor(this);
 304 }
 305
 306 void MachineBasicBlock::removeSuccessor(MachineBasicBlock *succ) {
 307   succ->removePredecessor(this);
 308   succ_iterator I = std::find(Successors.begin(), Successors.end(), succ);
 309   assert(I != Successors.end() && "Not a current successor!");
 310   Successors.erase(I);
 311 }
 312
 313 MachineBasicBlock::succ_iterator
 314 MachineBasicBlock::removeSuccessor(succ_iterator I) {
 315   assert(I != Successors.end() && "Not a current successor!");
 316   (*I)->removePredecessor(this);
 317   return Successors.erase(I);
 318 }
 319
 320 void MachineBasicBlock::addPredecessor(MachineBasicBlock *pred) {
 321   Predecessors.push_back(pred);
 322 }
 323
 324 void MachineBasicBlock::removePredecessor(MachineBasicBlock *pred) {
 325   std::vector<MachineBasicBlock *>::iterator I =
 326     std::find(Predecessors.begin(), Predecessors.end(), pred);
 327   assert(I != Predecessors.end() && "Pred is not a predecessor of this block!");
 328   Predecessors.erase(I);
 329 }
 330
 331 void MachineBasicBlock::transferSuccessors(MachineBasicBlock *fromMBB) {
 332   if (this == fromMBB)
 333     return;
 334
 335   for (MachineBasicBlock::succ_iterator I = fromMBB->succ_begin(),
 336        E = fromMBB->succ_end(); I != E; ++I)
 337     addSuccessor(*I);
 338
 339   while (!fromMBB->succ_empty())
 340     fromMBB->removeSuccessor(fromMBB->succ_begin());
 341 }
 342
 343 bool MachineBasicBlock::isSuccessor(const MachineBasicBlock *MBB) const {
 344   std::vector<MachineBasicBlock *>::const_iterator I =
 345     std::find(Successors.begin(), Successors.end(), MBB);
 346   return I != Successors.end();
 347 }
 348
 349 bool MachineBasicBlock::isLayoutSuccessor(const MachineBasicBlock *MBB) const {
 350   MachineFunction::const_iterator I(this);
 351   return llvm::next(I) == MachineFunction::const_iterator(MBB);
 352 }
 353
 354 bool MachineBasicBlock::canFallThrough() {
 355   MachineFunction::iterator Fallthrough = this;
 356   ++Fallthrough;
 357   // If FallthroughBlock is off the end of the function, it can't fall through.
 358   if (Fallthrough == getParent()->end())
 359     return false;
 360
 361   // If FallthroughBlock isn't a successor, no fallthrough is possible.
 362   if (!isSuccessor(Fallthrough))
 363     return false;
 364
 365   // Analyze the branches, if any, at the end of the block.
 366   MachineBasicBlock *TBB = 0, *FBB = 0;
 367   SmallVector<MachineOperand, 4> Cond;
 368   const TargetInstrInfo *TII = getParent()->getTarget().getInstrInfo();
 369   if (TII->AnalyzeBranch(*this, TBB, FBB, Cond)) {
 370     // If we couldn't analyze the branch, examine the last instruction.
 371     // If the block doesn't end in a known control barrier, assume fallthrough
 372     // is possible. The isPredicable check is needed because this code can be
 373     // called during IfConversion, where an instruction which is normally a
 374     // Barrier is predicated and thus no longer an actual control barrier. This
 375     // is over-conservative though, because if an instruction isn't actually
 376     // predicated we could still treat it like a barrier.
 377     return empty() || !back().getDesc().isBarrier() ||
 378            back().getDesc().isPredicable();
 379   }
 380
 381   // If there is no branch, control always falls through.
 382   if (TBB == 0) return true;
 383
 384   // If there is some explicit branch to the fallthrough block, it can obviously
 385   // reach, even though the branch should get folded to fall through implicitly.
 386   if (MachineFunction::iterator(TBB) == Fallthrough ||
 387       MachineFunction::iterator(FBB) == Fallthrough)
 388     return true;
 389
 390   // If it's an unconditional branch to some block not the fall through, it
 391   // doesn't fall through.
 392   if (Cond.empty()) return false;
 393
 394   // Otherwise, if it is conditional and has no explicit false block, it falls
 395   // through.
 396   return FBB == 0;
 397 }
 398
 399 /// removeFromParent - This method unlinks 'this' from the containing function,
 400 /// and returns it, but does not delete it.
 401 MachineBasicBlock *MachineBasicBlock::removeFromParent() {
 402   assert(getParent() && "Not embedded in a function!");
 403   getParent()->remove(this);
 404   return this;
 405 }
 406
 407
 408 /// eraseFromParent - This method unlinks 'this' from the containing function,
 409 /// and deletes it.
 410 void MachineBasicBlock::eraseFromParent() {
 411   assert(getParent() && "Not embedded in a function!");
 412   getParent()->erase(this);
 413 }
 414
 415
 416 /// ReplaceUsesOfBlockWith - Given a machine basic block that branched to
 417 /// 'Old', change the code and CFG so that it branches to 'New' instead.
 418 void MachineBasicBlock::ReplaceUsesOfBlockWith(MachineBasicBlock *Old,
 419                                                MachineBasicBlock *New) {
 420   assert(Old != New && "Cannot replace self with self!");
 421
 422   MachineBasicBlock::iterator I = end();
 423   while (I != begin()) {
 424     --I;
 425     if (!I->getDesc().isTerminator()) break;
 426
 427     // Scan the operands of this machine instruction, replacing any uses of Old
 428     // with New.
 429     for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
 430       if (I->getOperand(i).isMBB() &&
 431           I->getOperand(i).getMBB() == Old)
 432         I->getOperand(i).setMBB(New);
 433   }
 434
 435   // Update the successor information.
 436   removeSuccessor(Old);
 437   addSuccessor(New);
 438 }
 439
 440 /// CorrectExtraCFGEdges - Various pieces of code can cause excess edges in the
 441 /// CFG to be inserted.  If we have proven that MBB can only branch to DestA and
 442 /// DestB, remove any other MBB successors from the CFG.  DestA and DestB can be
 443 /// null.
 444 ///
 445 /// Besides DestA and DestB, retain other edges leading to LandingPads
 446 /// (currently there can be only one; we don't check or require that here).
 447 /// Note it is possible that DestA and/or DestB are LandingPads.
 448 bool MachineBasicBlock::CorrectExtraCFGEdges(MachineBasicBlock *DestA,
 449                                              MachineBasicBlock *DestB,
 450                                              bool isCond) {
 451   // The values of DestA and DestB frequently come from a call to the
 452   // 'TargetInstrInfo::AnalyzeBranch' method. We take our meaning of the initial
 453   // values from there.
 454   //
 455   // 1. If both DestA and DestB are null, then the block ends with no branches
 456   //    (it falls through to its successor).
 457   // 2. If DestA is set, DestB is null, and isCond is false, then the block ends
 458   //    with only an unconditional branch.
 459   // 3. If DestA is set, DestB is null, and isCond is true, then the block ends
 460   //    with a conditional branch that falls through to a successor (DestB).
 461   // 4. If DestA and DestB is set and isCond is true, then the block ends with a
 462   //    conditional branch followed by an unconditional branch. DestA is the
 463   //    'true' destination and DestB is the 'false' destination.
 464
 465   bool Changed = false;
 466
 467   MachineFunction::iterator FallThru =
 468     llvm::next(MachineFunction::iterator(this));
 469
 470   if (DestA == 0 && DestB == 0) {
 471     // Block falls through to successor.
 472     DestA = FallThru;
 473     DestB = FallThru;
 474   } else if (DestA != 0 && DestB == 0) {
 475     if (isCond)
 476       // Block ends in conditional jump that falls through to successor.
 477       DestB = FallThru;
 478   } else {
 479     assert(DestA && DestB && isCond &&
 480            "CFG in a bad state. Cannot correct CFG edges");
 481   }
 482
 483   // Remove superfluous edges. I.e., those which aren't destinations of this
 484   // basic block, duplicate edges, or landing pads.
 485   SmallPtrSet<const MachineBasicBlock*, 8> SeenMBBs;
 486   MachineBasicBlock::succ_iterator SI = succ_begin();
 487   while (SI != succ_end()) {
 488     const MachineBasicBlock *MBB = *SI;
 489     if (!SeenMBBs.insert(MBB) ||
 490         (MBB != DestA && MBB != DestB && !MBB->isLandingPad())) {
 491       // This is a superfluous edge, remove it.
 492       SI = removeSuccessor(SI);
 493       Changed = true;
 494     } else {
 495       ++SI;
 496     }
 497   }
 498
 499   return Changed;
 500 }
 501
 502 /// findDebugLoc - find the next valid DebugLoc starting at MBBI, skipping
 503 /// any DBG_VALUE instructions.  Return UnknownLoc if there is none.
 504 DebugLoc
 505 MachineBasicBlock::findDebugLoc(MachineBasicBlock::iterator &MBBI) {
 506   DebugLoc DL;
 507   MachineBasicBlock::iterator E = end();
 508   if (MBBI != E) {
 509     // Skip debug declarations, we don't want a DebugLoc from them.
 510     MachineBasicBlock::iterator MBBI2 = MBBI;
 511     while (MBBI2 != E && MBBI2->isDebugValue())
 512       MBBI2++;
 513     if (MBBI2 != E)
 514       DL = MBBI2->getDebugLoc();
 515   }
 516   return DL;
 517 }
 518
 519 void llvm::WriteAsOperand(raw_ostream &OS, const MachineBasicBlock *MBB,
 520                           bool t) {
 521   OS << "BB#" << MBB->getNumber();
 522 }
 523