1 //===- MachineSSAUpdater.cpp - Unstructured SSA Update Tool ---------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the MachineSSAUpdater class. It's based on SSAUpdater
11 // class in lib/Transforms/Utils.
13 //===----------------------------------------------------------------------===//
15 #include "llvm/CodeGen/MachineSSAUpdater.h"
16 #include "llvm/CodeGen/MachineInstr.h"
17 #include "llvm/CodeGen/MachineInstrBuilder.h"
18 #include "llvm/CodeGen/MachineRegisterInfo.h"
19 #include "llvm/Target/TargetInstrInfo.h"
20 #include "llvm/Target/TargetMachine.h"
21 #include "llvm/Target/TargetRegisterInfo.h"
22 #include "llvm/ADT/DenseMap.h"
23 #include "llvm/ADT/SmallVector.h"
24 #include "llvm/Support/AlignOf.h"
25 #include "llvm/Support/Allocator.h"
26 #include "llvm/Support/Debug.h"
27 #include "llvm/Support/ErrorHandling.h"
28 #include "llvm/Support/raw_ostream.h"
29 #include "llvm/Transforms/Utils/SSAUpdaterImpl.h"
32 typedef DenseMap<MachineBasicBlock*, unsigned> AvailableValsTy;
33 static AvailableValsTy &getAvailableVals(void *AV) {
34 return *static_cast<AvailableValsTy*>(AV);
37 MachineSSAUpdater::MachineSSAUpdater(MachineFunction &MF,
38 SmallVectorImpl<MachineInstr*> *NewPHI)
39 : AV(0), InsertedPHIs(NewPHI) {
40 TII = MF.getTarget().getInstrInfo();
41 MRI = &MF.getRegInfo();
44 MachineSSAUpdater::~MachineSSAUpdater() {
45 delete &getAvailableVals(AV);
48 /// Initialize - Reset this object to get ready for a new set of SSA
49 /// updates. ProtoValue is the value used to name PHI nodes.
50 void MachineSSAUpdater::Initialize(unsigned V) {
52 AV = new AvailableValsTy();
54 getAvailableVals(AV).clear();
57 VRC = MRI->getRegClass(VR);
60 /// HasValueForBlock - Return true if the MachineSSAUpdater already has a value for
61 /// the specified block.
62 bool MachineSSAUpdater::HasValueForBlock(MachineBasicBlock *BB) const {
63 return getAvailableVals(AV).count(BB);
66 /// AddAvailableValue - Indicate that a rewritten value is available in the
67 /// specified block with the specified value.
68 void MachineSSAUpdater::AddAvailableValue(MachineBasicBlock *BB, unsigned V) {
69 getAvailableVals(AV)[BB] = V;
72 /// GetValueAtEndOfBlock - Construct SSA form, materializing a value that is
73 /// live at the end of the specified block.
74 unsigned MachineSSAUpdater::GetValueAtEndOfBlock(MachineBasicBlock *BB) {
75 return GetValueAtEndOfBlockInternal(BB);
79 unsigned LookForIdenticalPHI(MachineBasicBlock *BB,
80 SmallVector<std::pair<MachineBasicBlock*, unsigned>, 8> &PredValues) {
84 MachineBasicBlock::iterator I = BB->begin();
88 AvailableValsTy AVals;
89 for (unsigned i = 0, e = PredValues.size(); i != e; ++i)
90 AVals[PredValues[i].first] = PredValues[i].second;
91 while (I != BB->end() && I->isPHI()) {
93 for (unsigned i = 1, e = I->getNumOperands(); i != e; i += 2) {
94 unsigned SrcReg = I->getOperand(i).getReg();
95 MachineBasicBlock *SrcBB = I->getOperand(i+1).getMBB();
96 if (AVals[SrcBB] != SrcReg) {
102 return I->getOperand(0).getReg();
108 /// InsertNewDef - Insert an empty PHI or IMPLICIT_DEF instruction which define
109 /// a value of the given register class at the start of the specified basic
110 /// block. It returns the virtual register defined by the instruction.
112 MachineInstr *InsertNewDef(unsigned Opcode,
113 MachineBasicBlock *BB, MachineBasicBlock::iterator I,
114 const TargetRegisterClass *RC,
115 MachineRegisterInfo *MRI,
116 const TargetInstrInfo *TII) {
117 unsigned NewVR = MRI->createVirtualRegister(RC);
118 return BuildMI(*BB, I, DebugLoc(), TII->get(Opcode), NewVR);
121 /// GetValueInMiddleOfBlock - Construct SSA form, materializing a value that
122 /// is live in the middle of the specified block.
124 /// GetValueInMiddleOfBlock is the same as GetValueAtEndOfBlock except in one
125 /// important case: if there is a definition of the rewritten value after the
126 /// 'use' in BB. Consider code like this:
132 /// br Cond, SomeBB, OutBB
134 /// In this case, there are two values (X1 and X2) added to the AvailableVals
135 /// set by the client of the rewriter, and those values are both live out of
136 /// their respective blocks. However, the use of X happens in the *middle* of
137 /// a block. Because of this, we need to insert a new PHI node in SomeBB to
138 /// merge the appropriate values, and this value isn't live out of the block.
140 unsigned MachineSSAUpdater::GetValueInMiddleOfBlock(MachineBasicBlock *BB) {
141 // If there is no definition of the renamed variable in this block, just use
142 // GetValueAtEndOfBlock to do our work.
143 if (!HasValueForBlock(BB))
144 return GetValueAtEndOfBlockInternal(BB);
146 // If there are no predecessors, just return undef.
147 if (BB->pred_empty()) {
148 // Insert an implicit_def to represent an undef value.
149 MachineInstr *NewDef = InsertNewDef(TargetOpcode::IMPLICIT_DEF,
150 BB, BB->getFirstTerminator(),
152 return NewDef->getOperand(0).getReg();
155 // Otherwise, we have the hard case. Get the live-in values for each
157 SmallVector<std::pair<MachineBasicBlock*, unsigned>, 8> PredValues;
158 unsigned SingularValue = 0;
160 bool isFirstPred = true;
161 for (MachineBasicBlock::pred_iterator PI = BB->pred_begin(),
162 E = BB->pred_end(); PI != E; ++PI) {
163 MachineBasicBlock *PredBB = *PI;
164 unsigned PredVal = GetValueAtEndOfBlockInternal(PredBB);
165 PredValues.push_back(std::make_pair(PredBB, PredVal));
167 // Compute SingularValue.
169 SingularValue = PredVal;
171 } else if (PredVal != SingularValue)
175 // Otherwise, if all the merged values are the same, just use it.
176 if (SingularValue != 0)
177 return SingularValue;
179 // If an identical PHI is already in BB, just reuse it.
180 unsigned DupPHI = LookForIdenticalPHI(BB, PredValues);
184 // Otherwise, we do need a PHI: insert one now.
185 MachineBasicBlock::iterator Loc = BB->empty() ? BB->end() : BB->begin();
186 MachineInstr *InsertedPHI = InsertNewDef(TargetOpcode::PHI, BB,
189 // Fill in all the predecessors of the PHI.
190 MachineInstrBuilder MIB(InsertedPHI);
191 for (unsigned i = 0, e = PredValues.size(); i != e; ++i)
192 MIB.addReg(PredValues[i].second).addMBB(PredValues[i].first);
194 // See if the PHI node can be merged to a single value. This can happen in
195 // loop cases when we get a PHI of itself and one other value.
196 if (unsigned ConstVal = InsertedPHI->isConstantValuePHI()) {
197 InsertedPHI->eraseFromParent();
201 // If the client wants to know about all new instructions, tell it.
202 if (InsertedPHIs) InsertedPHIs->push_back(InsertedPHI);
204 DEBUG(dbgs() << " Inserted PHI: " << *InsertedPHI << "\n");
205 return InsertedPHI->getOperand(0).getReg();
209 MachineBasicBlock *findCorrespondingPred(const MachineInstr *MI,
211 for (unsigned i = 1, e = MI->getNumOperands(); i != e; i += 2) {
212 if (&MI->getOperand(i) == U)
213 return MI->getOperand(i+1).getMBB();
216 llvm_unreachable("MachineOperand::getParent() failure?");
219 /// RewriteUse - Rewrite a use of the symbolic value. This handles PHI nodes,
220 /// which use their value in the corresponding predecessor.
221 void MachineSSAUpdater::RewriteUse(MachineOperand &U) {
222 MachineInstr *UseMI = U.getParent();
224 if (UseMI->isPHI()) {
225 MachineBasicBlock *SourceBB = findCorrespondingPred(UseMI, &U);
226 NewVR = GetValueAtEndOfBlockInternal(SourceBB);
228 NewVR = GetValueInMiddleOfBlock(UseMI->getParent());
234 void MachineSSAUpdater::ReplaceRegWith(unsigned OldReg, unsigned NewReg) {
235 MRI->replaceRegWith(OldReg, NewReg);
237 AvailableValsTy &AvailableVals = getAvailableVals(AV);
238 for (DenseMap<MachineBasicBlock*, unsigned>::iterator
239 I = AvailableVals.begin(), E = AvailableVals.end(); I != E; ++I)
240 if (I->second == OldReg)
244 /// MachinePHIiter - Iterator for PHI operands. This is used for the
245 /// PHI_iterator in the SSAUpdaterImpl template.
247 class MachinePHIiter {
253 explicit MachinePHIiter(MachineInstr *P) // begin iterator
255 MachinePHIiter(MachineInstr *P, bool) // end iterator
256 : PHI(P), idx(PHI->getNumOperands()) {}
258 MachinePHIiter &operator++() { idx += 2; return *this; }
259 bool operator==(const MachinePHIiter& x) const { return idx == x.idx; }
260 bool operator!=(const MachinePHIiter& x) const { return !operator==(x); }
261 unsigned getIncomingValue() { return PHI->getOperand(idx).getReg(); }
262 MachineBasicBlock *getIncomingBlock() {
263 return PHI->getOperand(idx+1).getMBB();
268 /// SSAUpdaterTraits<MachineSSAUpdater> - Traits for the SSAUpdaterImpl
269 /// template, specialized for MachineSSAUpdater.
272 class SSAUpdaterTraits<MachineSSAUpdater> {
274 typedef MachineBasicBlock BlkT;
275 typedef unsigned ValT;
276 typedef MachineInstr PhiT;
278 typedef MachineBasicBlock::succ_iterator BlkSucc_iterator;
279 static BlkSucc_iterator BlkSucc_begin(BlkT *BB) { return BB->succ_begin(); }
280 static BlkSucc_iterator BlkSucc_end(BlkT *BB) { return BB->succ_end(); }
282 typedef MachinePHIiter PHI_iterator;
283 static inline PHI_iterator PHI_begin(PhiT *PHI) { return PHI_iterator(PHI); }
284 static inline PHI_iterator PHI_end(PhiT *PHI) {
285 return PHI_iterator(PHI, true);
288 /// FindPredecessorBlocks - Put the predecessors of BB into the Preds
290 static void FindPredecessorBlocks(MachineBasicBlock *BB,
291 SmallVectorImpl<MachineBasicBlock*> *Preds){
292 for (MachineBasicBlock::pred_iterator PI = BB->pred_begin(),
293 E = BB->pred_end(); PI != E; ++PI)
294 Preds->push_back(*PI);
297 /// GetUndefVal - Create an IMPLICIT_DEF instruction with a new register.
298 /// Add it into the specified block and return the register.
299 static unsigned GetUndefVal(MachineBasicBlock *BB,
300 MachineSSAUpdater *Updater) {
301 // Insert an implicit_def to represent an undef value.
302 MachineInstr *NewDef = InsertNewDef(TargetOpcode::IMPLICIT_DEF,
303 BB, BB->getFirstTerminator(),
304 Updater->VRC, Updater->MRI,
306 return NewDef->getOperand(0).getReg();
309 /// CreateEmptyPHI - Create a PHI instruction that defines a new register.
310 /// Add it into the specified block and return the register.
311 static unsigned CreateEmptyPHI(MachineBasicBlock *BB, unsigned NumPreds,
312 MachineSSAUpdater *Updater) {
313 MachineBasicBlock::iterator Loc = BB->empty() ? BB->end() : BB->begin();
314 MachineInstr *PHI = InsertNewDef(TargetOpcode::PHI, BB, Loc,
315 Updater->VRC, Updater->MRI,
317 return PHI->getOperand(0).getReg();
320 /// AddPHIOperand - Add the specified value as an operand of the PHI for
321 /// the specified predecessor block.
322 static void AddPHIOperand(MachineInstr *PHI, unsigned Val,
323 MachineBasicBlock *Pred) {
324 PHI->addOperand(MachineOperand::CreateReg(Val, false));
325 PHI->addOperand(MachineOperand::CreateMBB(Pred));
328 /// InstrIsPHI - Check if an instruction is a PHI.
330 static MachineInstr *InstrIsPHI(MachineInstr *I) {
336 /// ValueIsPHI - Check if the instruction that defines the specified register
337 /// is a PHI instruction.
338 static MachineInstr *ValueIsPHI(unsigned Val, MachineSSAUpdater *Updater) {
339 return InstrIsPHI(Updater->MRI->getVRegDef(Val));
342 /// ValueIsNewPHI - Like ValueIsPHI but also check if the PHI has no source
343 /// operands, i.e., it was just added.
344 static MachineInstr *ValueIsNewPHI(unsigned Val, MachineSSAUpdater *Updater) {
345 MachineInstr *PHI = ValueIsPHI(Val, Updater);
346 if (PHI && PHI->getNumOperands() <= 1)
351 /// GetPHIValue - For the specified PHI instruction, return the register
353 static unsigned GetPHIValue(MachineInstr *PHI) {
354 return PHI->getOperand(0).getReg();
358 } // End llvm namespace
360 /// GetValueAtEndOfBlockInternal - Check to see if AvailableVals has an entry
361 /// for the specified BB and if so, return it. If not, construct SSA form by
362 /// first calculating the required placement of PHIs and then inserting new
363 /// PHIs where needed.
364 unsigned MachineSSAUpdater::GetValueAtEndOfBlockInternal(MachineBasicBlock *BB){
365 AvailableValsTy &AvailableVals = getAvailableVals(AV);
366 if (unsigned V = AvailableVals[BB])
369 SSAUpdaterImpl<MachineSSAUpdater> Impl(this, &AvailableVals, InsertedPHIs);
370 return Impl.GetValue(BB);