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