bef2502089e5db5b89a8597d38559c01bafd7084
[oota-llvm.git] / lib / CodeGen / MachineBasicBlock.cpp
1 //===-- llvm/CodeGen/MachineBasicBlock.cpp ----------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source 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/CodeGen/MachineInstr.h"
18 #include "llvm/Target/MRegisterInfo.h"
19 #include "llvm/Target/TargetData.h"
20 #include "llvm/Target/TargetInstrInfo.h"
21 #include "llvm/Target/TargetMachine.h"
22 #include "llvm/Support/LeakDetector.h"
23 #include <algorithm>
24 using namespace llvm;
25
26 MachineBasicBlock::~MachineBasicBlock() {
27   LeakDetector::removeGarbageObject(this);
28 }
29
30 std::ostream& llvm::operator<<(std::ostream &OS, const MachineBasicBlock &MBB) {
31   MBB.print(OS);
32   return OS;
33 }
34
35 // MBBs start out as #-1. When a MBB is added to a MachineFunction, it
36 // gets the next available unique MBB number. If it is removed from a
37 // MachineFunction, it goes back to being #-1.
38 void ilist_traits<MachineBasicBlock>::addNodeToList(MachineBasicBlock* N) {
39   assert(N->Parent == 0 && "machine instruction already in a basic block");
40   N->Parent = Parent;
41   N->Number = Parent->addToMBBNumbering(N);
42   LeakDetector::removeGarbageObject(N);
43 }
44
45 void ilist_traits<MachineBasicBlock>::removeNodeFromList(MachineBasicBlock* N) {
46   assert(N->Parent != 0 && "machine instruction not in a basic block");
47   N->Parent->removeFromMBBNumbering(N->Number);
48   N->Number = -1;
49   N->Parent = 0;
50   LeakDetector::addGarbageObject(N);
51 }
52
53
54 MachineInstr* ilist_traits<MachineInstr>::createSentinel() {
55   MachineInstr* dummy = new MachineInstr();
56   LeakDetector::removeGarbageObject(dummy);
57   return dummy;
58 }
59
60 void ilist_traits<MachineInstr>::addNodeToList(MachineInstr* N) {
61   assert(N->parent == 0 && "machine instruction already in a basic block");
62   N->parent = parent;
63   LeakDetector::removeGarbageObject(N);
64 }
65
66 void ilist_traits<MachineInstr>::removeNodeFromList(MachineInstr* N) {
67   assert(N->parent != 0 && "machine instruction not in a basic block");
68   N->parent = 0;
69   LeakDetector::addGarbageObject(N);
70 }
71
72 void ilist_traits<MachineInstr>::transferNodesFromList(
73   iplist<MachineInstr, ilist_traits<MachineInstr> >& fromList,
74   ilist_iterator<MachineInstr> first,
75   ilist_iterator<MachineInstr> last) {
76   if (parent != fromList.parent)
77     for (; first != last; ++first)
78       first->parent = parent;
79 }
80
81 MachineBasicBlock::iterator MachineBasicBlock::getFirstTerminator() {
82   const TargetInstrInfo& TII = *getParent()->getTarget().getInstrInfo();
83   iterator I = end();
84   while (I != begin() && TII.isTerminatorInstr((--I)->getOpcode()));
85   if (I != end() && !TII.isTerminatorInstr(I->getOpcode())) ++I;
86   return I;
87 }
88
89 void MachineBasicBlock::dump() const {
90   print(*cerr.stream());
91 }
92
93 static inline void OutputReg(std::ostream &os, unsigned RegNo,
94                              const MRegisterInfo *MRI = 0) {
95   if (!RegNo || MRegisterInfo::isPhysicalRegister(RegNo)) {
96     if (MRI)
97       os << " %" << MRI->get(RegNo).Name;
98     else
99       os << " %mreg(" << RegNo << ")";
100   } else
101     os << " %reg" << RegNo;
102 }
103
104 void MachineBasicBlock::print(std::ostream &OS) const {
105   const MachineFunction *MF = getParent();
106   if(!MF) {
107     OS << "Can't print out MachineBasicBlock because parent MachineFunction"
108        << " is null\n";
109     return;
110   }
111
112   const BasicBlock *LBB = getBasicBlock();
113   OS << "\n";
114   if (LBB) OS << LBB->getName();
115   OS << " (" << (const void*)this
116      << ", LLVM BB @" << (const void*) LBB << ", ID#" << getNumber()<< "):\n";
117
118   const MRegisterInfo *MRI = MF->getTarget().getRegisterInfo();  
119   if (livein_begin() != livein_end()) {
120     OS << "Live Ins:";
121     for (const_livein_iterator I = livein_begin(),E = livein_end(); I != E; ++I)
122       OutputReg(OS, *I, MRI);
123     OS << "\n";
124   }
125   // Print the preds of this block according to the CFG.
126   if (!pred_empty()) {
127     OS << "    Predecessors according to CFG:";
128     for (const_pred_iterator PI = pred_begin(), E = pred_end(); PI != E; ++PI)
129       OS << " " << *PI;
130     OS << "\n";
131   }
132   
133   for (const_iterator I = begin(); I != end(); ++I) {
134     OS << "\t";
135     I->print(OS, &getParent()->getTarget());
136   }
137
138   // Print the successors of this block according to the CFG.
139   if (!succ_empty()) {
140     OS << "    Successors according to CFG:";
141     for (const_succ_iterator SI = succ_begin(), E = succ_end(); SI != E; ++SI)
142       OS << " " << *SI;
143     OS << "\n";
144   }
145 }
146
147 void MachineBasicBlock::removeLiveIn(unsigned Reg) {
148   livein_iterator I = std::find(livein_begin(), livein_end(), Reg);
149   assert(I != livein_end() && "Not a live in!");
150   LiveIns.erase(I);
151 }
152
153 void MachineBasicBlock::moveBefore(MachineBasicBlock *NewAfter) {
154   MachineFunction::BasicBlockListType &BBList =getParent()->getBasicBlockList();
155   getParent()->getBasicBlockList().splice(NewAfter, BBList, this);
156 }
157
158 void MachineBasicBlock::moveAfter(MachineBasicBlock *NewBefore) {
159   MachineFunction::BasicBlockListType &BBList =getParent()->getBasicBlockList();
160   MachineFunction::iterator BBI = NewBefore;
161   getParent()->getBasicBlockList().splice(++BBI, BBList, this);
162 }
163
164
165 void MachineBasicBlock::addSuccessor(MachineBasicBlock *succ) {
166   Successors.push_back(succ);
167   succ->addPredecessor(this);
168 }
169
170 void MachineBasicBlock::removeSuccessor(MachineBasicBlock *succ) {
171   succ->removePredecessor(this);
172   succ_iterator I = std::find(Successors.begin(), Successors.end(), succ);
173   assert(I != Successors.end() && "Not a current successor!");
174   Successors.erase(I);
175 }
176
177 void MachineBasicBlock::removeSuccessor(succ_iterator I) {
178   assert(I != Successors.end() && "Not a current successor!");
179   (*I)->removePredecessor(this);
180   Successors.erase(I);
181 }
182
183 void MachineBasicBlock::addPredecessor(MachineBasicBlock *pred) {
184   Predecessors.push_back(pred);
185 }
186
187 void MachineBasicBlock::removePredecessor(MachineBasicBlock *pred) {
188   std::vector<MachineBasicBlock *>::iterator I =
189     std::find(Predecessors.begin(), Predecessors.end(), pred);
190   assert(I != Predecessors.end() && "Pred is not a predecessor of this block!");
191   Predecessors.erase(I);
192 }