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