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/Target/TargetRegisterInfo.h"
  18 #include "llvm/Target/TargetData.h"
  19 #include "llvm/Target/TargetInstrDesc.h"
  20 #include "llvm/Target/TargetMachine.h"
  21 #include "llvm/Support/LeakDetector.h"
  22 #include <algorithm>
  23 using namespace llvm;
  24
  25 MachineBasicBlock::~MachineBasicBlock() {
  26   LeakDetector::removeGarbageObject(this);
  27 }
  28
  29 std::ostream& llvm::operator<<(std::ostream &OS, const MachineBasicBlock &MBB) {
  30   MBB.print(OS);
  31   return OS;
  32 }
  33
  34 /// addNodeToList (MBB) - When an MBB is added to an MF, we need to update the
  35 /// parent pointer of the MBB, the MBB numbering, and any instructions in the
  36 /// MBB to be on the right operand list for registers.
  37 ///
  38 /// MBBs start out as #-1. When a MBB is added to a MachineFunction, it
  39 /// gets the next available unique MBB number. If it is removed from a
  40 /// MachineFunction, it goes back to being #-1.
  41 void ilist_traits<MachineBasicBlock>::addNodeToList(MachineBasicBlock* N) {
  42   assert(N->getParent() == 0 && "machine instruction already in a basic block");
  43   N->setParent(Parent);
  44   N->Number = Parent->addToMBBNumbering(N);
  45
  46   // Make sure the instructions have their operands in the reginfo lists.
  47   MachineRegisterInfo &RegInfo = Parent->getRegInfo();
  48   for (MachineBasicBlock::iterator I = N->begin(), E = N->end(); I != E; ++I)
  49     I->AddRegOperandsToUseLists(RegInfo);
  50
  51   LeakDetector::removeGarbageObject(N);
  52 }
  53
  54 void ilist_traits<MachineBasicBlock>::removeNodeFromList(MachineBasicBlock* N) {
  55   assert(N->getParent() != 0 && "machine instruction not in a basic block");
  56   N->getParent()->removeFromMBBNumbering(N->Number);
  57   N->Number = -1;
  58   N->setParent(0);
  59
  60   // Make sure the instructions have their operands removed from the reginfo
  61   // lists.
  62   for (MachineBasicBlock::iterator I = N->begin(), E = N->end(); I != E; ++I)
  63     I->RemoveRegOperandsFromUseLists();
  64
  65   LeakDetector::addGarbageObject(N);
  66 }
  67
  68
  69 MachineInstr* ilist_traits<MachineInstr>::createSentinel() {
  70   MachineInstr* dummy = new MachineInstr();
  71   LeakDetector::removeGarbageObject(dummy);
  72   return dummy;
  73 }
  74
  75 /// addNodeToList (MI) - When we add an instruction to a basic block
  76 /// list, we update its parent pointer and add its operands from reg use/def
  77 /// lists if appropriate.
  78 void ilist_traits<MachineInstr>::addNodeToList(MachineInstr* N) {
  79   assert(N->getParent() == 0 && "machine instruction already in a basic block");
  80   N->setParent(parent);
  81   LeakDetector::removeGarbageObject(N);
  82
  83   // If the block is in a function, add the instruction's register operands to
  84   // their corresponding use/def lists.
  85   if (MachineFunction *MF = parent->getParent())
  86     N->AddRegOperandsToUseLists(MF->getRegInfo());
  87 }
  88
  89 /// removeNodeFromList (MI) - When we remove an instruction from a basic block
  90 /// list, we update its parent pointer and remove its operands from reg use/def
  91 /// lists if appropriate.
  92 void ilist_traits<MachineInstr>::removeNodeFromList(MachineInstr* N) {
  93   assert(N->getParent() != 0 && "machine instruction not in a basic block");
  94   // If this block is in a function, remove from the use/def lists.
  95   if (parent->getParent() != 0)
  96     N->RemoveRegOperandsFromUseLists();
  97
  98   N->setParent(0);
  99   LeakDetector::addGarbageObject(N);
 100 }
 101
 102 /// transferNodesFromList (MI) - When moving a range of instructions from one
 103 /// MBB list to another, we need to update the parent pointers and the use/def
 104 /// lists.
 105 void ilist_traits<MachineInstr>::transferNodesFromList(
 106       iplist<MachineInstr, ilist_traits<MachineInstr> >& fromList,
 107       ilist_iterator<MachineInstr> first,
 108       ilist_iterator<MachineInstr> last) {
 109   // Splice within the same MBB -> no change.
 110   if (parent == fromList.parent) return;
 111
 112   // If splicing between two blocks within the same function, just update the
 113   // parent pointers.
 114   if (parent->getParent() == fromList.parent->getParent()) {
 115     for (; first != last; ++first)
 116       first->setParent(parent);
 117     return;
 118   }
 119
 120   // Otherwise, we have to update the parent and the use/def lists.  The common
 121   // case when this occurs is if we're splicing from a block in a MF to a block
 122   // that is not in an MF.
 123   bool HasOldMF = fromList.parent->getParent() != 0;
 124   MachineFunction *NewMF = parent->getParent();
 125
 126   for (; first != last; ++first) {
 127     if (HasOldMF) first->RemoveRegOperandsFromUseLists();
 128     first->setParent(parent);
 129     if (NewMF) first->AddRegOperandsToUseLists(NewMF->getRegInfo());
 130   }
 131 }
 132
 133 MachineBasicBlock::iterator MachineBasicBlock::getFirstTerminator() {
 134   iterator I = end();
 135   while (I != begin() && (--I)->getDesc().isTerminator())
 136     ; /*noop */
 137   if (I != end() && !I->getDesc().isTerminator()) ++I;
 138   return I;
 139 }
 140
 141 void MachineBasicBlock::dump() const {
 142   print(*cerr.stream());
 143 }
 144
 145 static inline void OutputReg(std::ostream &os, unsigned RegNo,
 146                              const TargetRegisterInfo *TRI = 0) {
 147   if (!RegNo || TargetRegisterInfo::isPhysicalRegister(RegNo)) {
 148     if (TRI)
 149       os << " %" << TRI->get(RegNo).Name;
 150     else
 151       os << " %mreg(" << RegNo << ")";
 152   } else
 153     os << " %reg" << RegNo;
 154 }
 155
 156 void MachineBasicBlock::print(std::ostream &OS) const {
 157   const MachineFunction *MF = getParent();
 158   if(!MF) {
 159     OS << "Can't print out MachineBasicBlock because parent MachineFunction"
 160        << " is null\n";
 161     return;
 162   }
 163
 164   const BasicBlock *LBB = getBasicBlock();
 165   OS << "\n";
 166   if (LBB) OS << LBB->getName() << ": ";
 167   OS << (const void*)this
 168      << ", LLVM BB @" << (const void*) LBB << ", ID#" << getNumber();
 169   if (Alignment) OS << ", Alignment " << Alignment;
 170   if (isLandingPad()) OS << ", EH LANDING PAD";
 171   OS << ":\n";
 172
 173   const TargetRegisterInfo *TRI = MF->getTarget().getRegisterInfo();
 174   if (!livein_empty()) {
 175     OS << "Live Ins:";
 176     for (const_livein_iterator I = livein_begin(),E = livein_end(); I != E; ++I)
 177       OutputReg(OS, *I, TRI);
 178     OS << "\n";
 179   }
 180   // Print the preds of this block according to the CFG.
 181   if (!pred_empty()) {
 182     OS << "    Predecessors according to CFG:";
 183     for (const_pred_iterator PI = pred_begin(), E = pred_end(); PI != E; ++PI)
 184       OS << " " << *PI << " (#" << (*PI)->getNumber() << ")";
 185     OS << "\n";
 186   }
 187
 188   for (const_iterator I = begin(); I != end(); ++I) {
 189     OS << "\t";
 190     I->print(OS, &getParent()->getTarget());
 191   }
 192
 193   // Print the successors of this block according to the CFG.
 194   if (!succ_empty()) {
 195     OS << "    Successors according to CFG:";
 196     for (const_succ_iterator SI = succ_begin(), E = succ_end(); SI != E; ++SI)
 197       OS << " " << *SI << " (#" << (*SI)->getNumber() << ")";
 198     OS << "\n";
 199   }
 200 }
 201
 202 void MachineBasicBlock::removeLiveIn(unsigned Reg) {
 203   livein_iterator I = std::find(livein_begin(), livein_end(), Reg);
 204   assert(I != livein_end() && "Not a live in!");
 205   LiveIns.erase(I);
 206 }
 207
 208 bool MachineBasicBlock::isLiveIn(unsigned Reg) const {
 209   const_livein_iterator I = std::find(livein_begin(), livein_end(), Reg);
 210   return I != livein_end();
 211 }
 212
 213 void MachineBasicBlock::moveBefore(MachineBasicBlock *NewAfter) {
 214   MachineFunction::BasicBlockListType &BBList =getParent()->getBasicBlockList();
 215   getParent()->getBasicBlockList().splice(NewAfter, BBList, this);
 216 }
 217
 218 void MachineBasicBlock::moveAfter(MachineBasicBlock *NewBefore) {
 219   MachineFunction::BasicBlockListType &BBList =getParent()->getBasicBlockList();
 220   MachineFunction::iterator BBI = NewBefore;
 221   getParent()->getBasicBlockList().splice(++BBI, BBList, this);
 222 }
 223
 224
 225 void MachineBasicBlock::addSuccessor(MachineBasicBlock *succ) {
 226   Successors.push_back(succ);
 227   succ->addPredecessor(this);
 228 }
 229
 230 void MachineBasicBlock::removeSuccessor(MachineBasicBlock *succ) {
 231   succ->removePredecessor(this);
 232   succ_iterator I = std::find(Successors.begin(), Successors.end(), succ);
 233   assert(I != Successors.end() && "Not a current successor!");
 234   Successors.erase(I);
 235 }
 236
 237 MachineBasicBlock::succ_iterator
 238 MachineBasicBlock::removeSuccessor(succ_iterator I) {
 239   assert(I != Successors.end() && "Not a current successor!");
 240   (*I)->removePredecessor(this);
 241   return(Successors.erase(I));
 242 }
 243
 244 void MachineBasicBlock::addPredecessor(MachineBasicBlock *pred) {
 245   Predecessors.push_back(pred);
 246 }
 247
 248 void MachineBasicBlock::removePredecessor(MachineBasicBlock *pred) {
 249   std::vector<MachineBasicBlock *>::iterator I =
 250     std::find(Predecessors.begin(), Predecessors.end(), pred);
 251   assert(I != Predecessors.end() && "Pred is not a predecessor of this block!");
 252   Predecessors.erase(I);
 253 }
 254
 255 void MachineBasicBlock::transferSuccessors(MachineBasicBlock *fromMBB)
 256 {
 257   if (this == fromMBB)
 258     return;
 259
 260   for(MachineBasicBlock::succ_iterator iter = fromMBB->succ_begin(),
 261       end = fromMBB->succ_end(); iter != end; ++iter) {
 262       addSuccessor(*iter);
 263   }
 264   while(!fromMBB->succ_empty())
 265     fromMBB->removeSuccessor(fromMBB->succ_begin());
 266 }
 267
 268 bool MachineBasicBlock::isSuccessor(MachineBasicBlock *MBB) const {
 269   std::vector<MachineBasicBlock *>::const_iterator I =
 270     std::find(Successors.begin(), Successors.end(), MBB);
 271   return I != Successors.end();
 272 }
 273
 274 /// ReplaceUsesOfBlockWith - Given a machine basic block that branched to
 275 /// 'Old', change the code and CFG so that it branches to 'New' instead.
 276 void MachineBasicBlock::ReplaceUsesOfBlockWith(MachineBasicBlock *Old,
 277                                                MachineBasicBlock *New) {
 278   assert(Old != New && "Cannot replace self with self!");
 279
 280   MachineBasicBlock::iterator I = end();
 281   while (I != begin()) {
 282     --I;
 283     if (!I->getDesc().isTerminator()) break;
 284
 285     // Scan the operands of this machine instruction, replacing any uses of Old
 286     // with New.
 287     for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
 288       if (I->getOperand(i).isMBB() && I->getOperand(i).getMBB() == Old)
 289         I->getOperand(i).setMBB(New);
 290   }
 291
 292   // Update the successor information.  If New was already a successor, just
 293   // remove the link to Old instead of creating another one.  PR 1444.
 294   removeSuccessor(Old);
 295   if (!isSuccessor(New))
 296     addSuccessor(New);
 297 }
 298
 299 /// CorrectExtraCFGEdges - Various pieces of code can cause excess edges in the
 300 /// CFG to be inserted.  If we have proven that MBB can only branch to DestA and
 301 /// DestB, remove any other MBB successors from the CFG.  DestA and DestB can
 302 /// be null.
 303 /// Besides DestA and DestB, retain other edges leading to LandingPads
 304 /// (currently there can be only one; we don't check or require that here).
 305 /// Note it is possible that DestA and/or DestB are LandingPads.
 306 bool MachineBasicBlock::CorrectExtraCFGEdges(MachineBasicBlock *DestA,
 307                                              MachineBasicBlock *DestB,
 308                                              bool isCond) {
 309   bool MadeChange = false;
 310   bool AddedFallThrough = false;
 311
 312   MachineBasicBlock *FallThru = getNext();
 313
 314   // If this block ends with a conditional branch that falls through to its
 315   // successor, set DestB as the successor.
 316   if (isCond) {
 317     if (DestB == 0 && FallThru != getParent()->end()) {
 318       DestB = FallThru;
 319       AddedFallThrough = true;
 320     }
 321   } else {
 322     // If this is an unconditional branch with no explicit dest, it must just be
 323     // a fallthrough into DestB.
 324     if (DestA == 0 && FallThru != getParent()->end()) {
 325       DestA = FallThru;
 326       AddedFallThrough = true;
 327     }
 328   }
 329
 330   MachineBasicBlock::succ_iterator SI = succ_begin();
 331   MachineBasicBlock *OrigDestA = DestA, *OrigDestB = DestB;
 332   while (SI != succ_end()) {
 333     if (*SI == DestA && DestA == DestB) {
 334       DestA = DestB = 0;
 335       ++SI;
 336     } else if (*SI == DestA) {
 337       DestA = 0;
 338       ++SI;
 339     } else if (*SI == DestB) {
 340       DestB = 0;
 341       ++SI;
 342     } else if ((*SI)->isLandingPad() &&
 343                *SI!=OrigDestA && *SI!=OrigDestB) {
 344       ++SI;
 345     } else {
 346       // Otherwise, this is a superfluous edge, remove it.
 347       SI = removeSuccessor(SI);
 348       MadeChange = true;
 349     }
 350   }
 351   if (!AddedFallThrough) {
 352     assert(DestA == 0 && DestB == 0 &&
 353            "MachineCFG is missing edges!");
 354   } else if (isCond) {
 355     assert(DestA == 0 && "MachineCFG is missing edges!");
 356   }
 357   return MadeChange;
 358 }