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 <algorithm>
  22 using namespace llvm;
  23
  24 MachineBasicBlock::MachineBasicBlock(MachineFunction &mf, const BasicBlock *bb)
  25   : BB(bb), Number(-1), xParent(&mf), Alignment(0), IsLandingPad(false) {
  26   Insts.getTraits().Parent = 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 alist_traits<MachineBasicBlock>::addNodeToList(MachineBasicBlock* N) {
  42   MachineFunction &MF = *N->getParent();
  43   N->Number = MF.addToMBBNumbering(N);
  44
  45   // Make sure the instructions have their operands in the reginfo lists.
  46   MachineRegisterInfo &RegInfo = MF.getRegInfo();
  47   for (MachineBasicBlock::iterator I = N->begin(), E = N->end(); I != E; ++I)
  48     I->AddRegOperandsToUseLists(RegInfo);
  49 }
  50
  51 void alist_traits<MachineBasicBlock>::removeNodeFromList(MachineBasicBlock* N) {
  52   N->getParent()->removeFromMBBNumbering(N->Number);
  53   N->Number = -1;
  54 }
  55
  56
  57 /// addNodeToList (MI) - When we add an instruction to a basic block
  58 /// list, we update its parent pointer and add its operands from reg use/def
  59 /// lists if appropriate.
  60 void alist_traits<MachineInstr>::addNodeToList(MachineInstr* N) {
  61   assert(N->getParent() == 0 && "machine instruction already in a basic block");
  62   N->setParent(Parent);
  63
  64   // Add the instruction's register operands to their corresponding
  65   // use/def lists.
  66   MachineFunction *MF = Parent->getParent();
  67   N->AddRegOperandsToUseLists(MF->getRegInfo());
  68 }
  69
  70 /// removeNodeFromList (MI) - When we remove an instruction from a basic block
  71 /// list, we update its parent pointer and remove its operands from reg use/def
  72 /// lists if appropriate.
  73 void alist_traits<MachineInstr>::removeNodeFromList(MachineInstr* N) {
  74   assert(N->getParent() != 0 && "machine instruction not in a basic block");
  75
  76   // Remove from the use/def lists.
  77   N->RemoveRegOperandsFromUseLists();
  78
  79   N->setParent(0);
  80 }
  81
  82 /// transferNodesFromList (MI) - When moving a range of instructions from one
  83 /// MBB list to another, we need to update the parent pointers and the use/def
  84 /// lists.
  85 void alist_traits<MachineInstr>::transferNodesFromList(
  86       alist_traits<MachineInstr>& fromList,
  87       MachineBasicBlock::iterator first,
  88       MachineBasicBlock::iterator last) {
  89   // Splice within the same MBB -> no change.
  90   if (Parent == fromList.Parent) return;
  91
  92   // If splicing between two blocks within the same function, just update the
  93   // parent pointers.
  94   if (Parent->getParent() == fromList.Parent->getParent()) {
  95     for (; first != last; ++first)
  96       first->setParent(Parent);
  97     return;
  98   }
  99
 100   // Otherwise, we have to update the parent and the use/def lists.  The common
 101   // case when this occurs is if we're splicing from a block in a MF to a block
 102   // that is not in an MF.
 103   bool HasOldMF = fromList.Parent->getParent() != 0;
 104   MachineFunction *NewMF = Parent->getParent();
 105
 106   for (; first != last; ++first) {
 107     if (HasOldMF) first->RemoveRegOperandsFromUseLists();
 108     first->setParent(Parent);
 109     if (NewMF) first->AddRegOperandsToUseLists(NewMF->getRegInfo());
 110   }
 111 }
 112
 113 void alist_traits<MachineInstr>::deleteNode(MachineInstr* MI) {
 114   assert(!MI->getParent() && "MI is still in a block!");
 115   Parent->getParent()->DeleteMachineInstr(MI);
 116 }
 117
 118 MachineBasicBlock::iterator MachineBasicBlock::getFirstTerminator() {
 119   iterator I = end();
 120   while (I != begin() && (--I)->getDesc().isTerminator())
 121     ; /*noop */
 122   if (I != end() && !I->getDesc().isTerminator()) ++I;
 123   return I;
 124 }
 125
 126 void MachineBasicBlock::dump() const {
 127   print(*cerr.stream());
 128 }
 129
 130 static inline void OutputReg(std::ostream &os, unsigned RegNo,
 131                              const TargetRegisterInfo *TRI = 0) {
 132   if (!RegNo || TargetRegisterInfo::isPhysicalRegister(RegNo)) {
 133     if (TRI)
 134       os << " %" << TRI->get(RegNo).Name;
 135     else
 136       os << " %mreg(" << RegNo << ")";
 137   } else
 138     os << " %reg" << RegNo;
 139 }
 140
 141 void MachineBasicBlock::print(std::ostream &OS) const {
 142   const MachineFunction *MF = getParent();
 143   if(!MF) {
 144     OS << "Can't print out MachineBasicBlock because parent MachineFunction"
 145        << " is null\n";
 146     return;
 147   }
 148
 149   const BasicBlock *LBB = getBasicBlock();
 150   OS << "\n";
 151   if (LBB) OS << LBB->getName() << ": ";
 152   OS << (const void*)this
 153      << ", LLVM BB @" << (const void*) LBB << ", ID#" << getNumber();
 154   if (Alignment) OS << ", Alignment " << Alignment;
 155   if (isLandingPad()) OS << ", EH LANDING PAD";
 156   OS << ":\n";
 157
 158   const TargetRegisterInfo *TRI = MF->getTarget().getRegisterInfo();
 159   if (!livein_empty()) {
 160     OS << "Live Ins:";
 161     for (const_livein_iterator I = livein_begin(),E = livein_end(); I != E; ++I)
 162       OutputReg(OS, *I, TRI);
 163     OS << "\n";
 164   }
 165   // Print the preds of this block according to the CFG.
 166   if (!pred_empty()) {
 167     OS << "    Predecessors according to CFG:";
 168     for (const_pred_iterator PI = pred_begin(), E = pred_end(); PI != E; ++PI)
 169       OS << " " << *PI << " (#" << (*PI)->getNumber() << ")";
 170     OS << "\n";
 171   }
 172
 173   for (const_iterator I = begin(); I != end(); ++I) {
 174     OS << "\t";
 175     I->print(OS, &getParent()->getTarget());
 176   }
 177
 178   // Print the successors of this block according to the CFG.
 179   if (!succ_empty()) {
 180     OS << "    Successors according to CFG:";
 181     for (const_succ_iterator SI = succ_begin(), E = succ_end(); SI != E; ++SI)
 182       OS << " " << *SI << " (#" << (*SI)->getNumber() << ")";
 183     OS << "\n";
 184   }
 185 }
 186
 187 void MachineBasicBlock::removeLiveIn(unsigned Reg) {
 188   livein_iterator I = std::find(livein_begin(), livein_end(), Reg);
 189   assert(I != livein_end() && "Not a live in!");
 190   LiveIns.erase(I);
 191 }
 192
 193 bool MachineBasicBlock::isLiveIn(unsigned Reg) const {
 194   const_livein_iterator I = std::find(livein_begin(), livein_end(), Reg);
 195   return I != livein_end();
 196 }
 197
 198 void MachineBasicBlock::moveBefore(MachineBasicBlock *NewAfter) {
 199   getParent()->splice(NewAfter, this);
 200 }
 201
 202 void MachineBasicBlock::moveAfter(MachineBasicBlock *NewBefore) {
 203   MachineFunction::iterator BBI = NewBefore;
 204   getParent()->splice(++BBI, this);
 205 }
 206
 207
 208 void MachineBasicBlock::addSuccessor(MachineBasicBlock *succ) {
 209   Successors.push_back(succ);
 210   succ->addPredecessor(this);
 211 }
 212
 213 void MachineBasicBlock::removeSuccessor(MachineBasicBlock *succ) {
 214   succ->removePredecessor(this);
 215   succ_iterator I = std::find(Successors.begin(), Successors.end(), succ);
 216   assert(I != Successors.end() && "Not a current successor!");
 217   Successors.erase(I);
 218 }
 219
 220 MachineBasicBlock::succ_iterator
 221 MachineBasicBlock::removeSuccessor(succ_iterator I) {
 222   assert(I != Successors.end() && "Not a current successor!");
 223   (*I)->removePredecessor(this);
 224   return(Successors.erase(I));
 225 }
 226
 227 void MachineBasicBlock::addPredecessor(MachineBasicBlock *pred) {
 228   Predecessors.push_back(pred);
 229 }
 230
 231 void MachineBasicBlock::removePredecessor(MachineBasicBlock *pred) {
 232   std::vector<MachineBasicBlock *>::iterator I =
 233     std::find(Predecessors.begin(), Predecessors.end(), pred);
 234   assert(I != Predecessors.end() && "Pred is not a predecessor of this block!");
 235   Predecessors.erase(I);
 236 }
 237
 238 void MachineBasicBlock::transferSuccessors(MachineBasicBlock *fromMBB)
 239 {
 240   if (this == fromMBB)
 241     return;
 242
 243   for(MachineBasicBlock::succ_iterator iter = fromMBB->succ_begin(),
 244       end = fromMBB->succ_end(); iter != end; ++iter) {
 245       addSuccessor(*iter);
 246   }
 247   while(!fromMBB->succ_empty())
 248     fromMBB->removeSuccessor(fromMBB->succ_begin());
 249 }
 250
 251 bool MachineBasicBlock::isSuccessor(MachineBasicBlock *MBB) const {
 252   std::vector<MachineBasicBlock *>::const_iterator I =
 253     std::find(Successors.begin(), Successors.end(), MBB);
 254   return I != Successors.end();
 255 }
 256
 257 /// removeFromParent - This method unlinks 'this' from the containing function,
 258 /// and returns it, but does not delete it.
 259 MachineBasicBlock *MachineBasicBlock::removeFromParent() {
 260   assert(getParent() && "Not embedded in a function!");
 261   getParent()->remove(this);
 262   return this;
 263 }
 264
 265
 266 /// eraseFromParent - This method unlinks 'this' from the containing function,
 267 /// and deletes it.
 268 void MachineBasicBlock::eraseFromParent() {
 269   assert(getParent() && "Not embedded in a function!");
 270   getParent()->erase(this);
 271 }
 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   MachineFunction::iterator FallThru = next(MachineFunction::iterator(this));
 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 }