Simplify the side effect stuff a bit more and make licm/sinking
[oota-llvm.git] / lib / CodeGen / MachineSink.cpp
1 //===-- MachineSink.cpp - Sinking for machine instructions ----------------===//
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 // This pass 
11 //
12 //===----------------------------------------------------------------------===//
13
14 #define DEBUG_TYPE "machine-sink"
15 #include "llvm/CodeGen/Passes.h"
16 #include "llvm/CodeGen/MachineRegisterInfo.h"
17 #include "llvm/CodeGen/MachineDominators.h"
18 #include "llvm/Target/MRegisterInfo.h"
19 #include "llvm/Target/TargetInstrInfo.h"
20 #include "llvm/Target/TargetMachine.h"
21 #include "llvm/ADT/SmallVector.h"
22 #include "llvm/ADT/Statistic.h"
23 #include "llvm/Support/Compiler.h"
24 #include "llvm/Support/Debug.h"
25 using namespace llvm;
26
27 STATISTIC(NumSunk, "Number of machine instructions sunk");
28
29 namespace {
30   class VISIBILITY_HIDDEN MachineSinking : public MachineFunctionPass {
31     const TargetMachine   *TM;
32     const TargetInstrInfo *TII;
33     MachineFunction       *CurMF; // Current MachineFunction
34     MachineRegisterInfo  *RegInfo; // Machine register information
35     MachineDominatorTree *DT;   // Machine dominator tree for the current Loop
36
37   public:
38     static char ID; // Pass identification
39     MachineSinking() : MachineFunctionPass((intptr_t)&ID) {}
40     
41     virtual bool runOnMachineFunction(MachineFunction &MF);
42     
43     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
44       MachineFunctionPass::getAnalysisUsage(AU);
45       AU.addRequired<MachineDominatorTree>();
46       AU.addPreserved<MachineDominatorTree>();
47     }
48   private:
49     bool ProcessBlock(MachineBasicBlock &MBB);
50     bool SinkInstruction(MachineInstr *MI);
51     bool AllUsesDominatedByBlock(unsigned Reg, MachineBasicBlock *MBB) const;
52   };
53   
54   char MachineSinking::ID = 0;
55   RegisterPass<MachineSinking> X("machine-sink", "Machine code sinking");
56 } // end anonymous namespace
57
58 FunctionPass *llvm::createMachineSinkingPass() { return new MachineSinking(); }
59
60 /// AllUsesDominatedByBlock - Return true if all uses of the specified register
61 /// occur in blocks dominated by the specified block.
62 bool MachineSinking::AllUsesDominatedByBlock(unsigned Reg, 
63                                              MachineBasicBlock *MBB) const {
64   assert(MRegisterInfo::isVirtualRegister(Reg) && "Only makes sense for vregs");
65   for (MachineRegisterInfo::reg_iterator I = RegInfo->reg_begin(Reg),
66        E = RegInfo->reg_end(); I != E; ++I) {
67     if (I.getOperand().isDef()) continue;  // ignore def.
68     
69     // Determine the block of the use.
70     MachineInstr *UseInst = &*I;
71     MachineBasicBlock *UseBlock = UseInst->getParent();
72     if (UseInst->getOpcode() == TargetInstrInfo::PHI) {
73       // PHI nodes use the operand in the predecessor block, not the block with
74       // the PHI.
75       UseBlock = UseInst->getOperand(I.getOperandNo()+1).getMBB();
76     }
77     // Check that it dominates.
78     if (!DT->dominates(MBB, UseBlock))
79       return false;
80   }
81   return true;
82 }
83
84
85
86 bool MachineSinking::runOnMachineFunction(MachineFunction &MF) {
87   DOUT << "******** Machine Sinking ********\n";
88   
89   CurMF = &MF;
90   TM = &CurMF->getTarget();
91   TII = TM->getInstrInfo();
92   RegInfo = &CurMF->getRegInfo();
93   DT = &getAnalysis<MachineDominatorTree>();
94
95   bool EverMadeChange = false;
96   
97   while (1) {
98     bool MadeChange = false;
99
100     // Process all basic blocks.
101     for (MachineFunction::iterator I = CurMF->begin(), E = CurMF->end(); 
102          I != E; ++I)
103       MadeChange |= ProcessBlock(*I);
104     
105     // If this iteration over the code changed anything, keep iterating.
106     if (!MadeChange) break;
107     EverMadeChange = true;
108   } 
109   return EverMadeChange;
110 }
111
112 bool MachineSinking::ProcessBlock(MachineBasicBlock &MBB) {
113   bool MadeChange = false;
114   
115   // Can't sink anything out of a block that has less than two successors.
116   if (MBB.succ_size() <= 1) return false;
117   
118   // Walk the basic block bottom-up
119   for (MachineBasicBlock::iterator I = MBB.end(); I != MBB.begin(); ){
120     MachineBasicBlock::iterator LastIt = I;
121     if (SinkInstruction(--I)) {
122       I = LastIt;
123       ++NumSunk;
124     }
125   }
126   
127   return MadeChange;
128 }
129
130 /// SinkInstruction - Determine whether it is safe to sink the specified machine
131 /// instruction out of its current block into a successor.
132 bool MachineSinking::SinkInstruction(MachineInstr *MI) {
133   const TargetInstrDesc &TID = MI->getDesc();
134   
135   // Ignore stuff that we obviously can't sink.
136   if (TID.mayStore() || TID.isCall() || TID.isReturn() || TID.isBranch() ||
137       TID.hasUnmodeledSideEffects())
138     return false;
139
140   if (TID.mayLoad()) {
141     // Okay, this instruction does a load.  As a refinement, allow the target
142     // to decide whether the loaded value is actually a constant.  If so, we
143     // can actually use it as a load.
144     if (!TII->isInvariantLoad(MI)) {
145       // FIXME: we should be able to sink loads with no other side effects if
146       // there is nothing that can change memory from here until the end of
147       // block.  This is a trivial form of alias analysis.
148       return false;
149     }
150   }
151   
152   // FIXME: This should include support for sinking instructions within the
153   // block they are currently in to shorten the live ranges.  We often get
154   // instructions sunk into the top of a large block, but it would be better to
155   // also sink them down before their first use in the block.  This xform has to
156   // be careful not to *increase* register pressure though, e.g. sinking
157   // "x = y + z" down if it kills y and z would increase the live ranges of y
158   // and z only the shrink the live range of x.
159   
160   // Loop over all the operands of the specified instruction.  If there is
161   // anything we can't handle, bail out.
162   MachineBasicBlock *ParentBlock = MI->getParent();
163   
164   // SuccToSinkTo - This is the successor to sink this instruction to, once we
165   // decide.
166   MachineBasicBlock *SuccToSinkTo = 0;
167   
168   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
169     const MachineOperand &MO = MI->getOperand(i);
170     if (!MO.isReg()) continue;  // Ignore non-register operands.
171     
172     unsigned Reg = MO.getReg();
173     if (Reg == 0) continue;
174     
175     if (MRegisterInfo::isPhysicalRegister(Reg)) {
176       // If this is a physical register use, we can't move it.  If it is a def,
177       // we can move it, but only if the def is dead.
178       if (MO.isUse() || !MO.isDead())
179         return false;
180     } else {
181       // Virtual register uses are always safe to sink.
182       if (MO.isUse()) continue;
183       
184       // FIXME: This picks a successor to sink into based on having one
185       // successor that dominates all the uses.  However, there are cases where
186       // sinking can happen but where the sink point isn't a successor.  For
187       // example:
188       //   x = computation
189       //   if () {} else {}
190       //   use x
191       // the instruction could be sunk over the whole diamond for the 
192       // if/then/else (or loop, etc), allowing it to be sunk into other blocks
193       // after that.
194       
195       // Virtual register defs can only be sunk if all their uses are in blocks
196       // dominated by one of the successors.
197       if (SuccToSinkTo) {
198         // If a previous operand picked a block to sink to, then this operand
199         // must be sinkable to the same block.
200         if (!AllUsesDominatedByBlock(Reg, SuccToSinkTo)) 
201           return false;
202         continue;
203       }
204       
205       // Otherwise, we should look at all the successors and decide which one
206       // we should sink to.
207       for (MachineBasicBlock::succ_iterator SI = ParentBlock->succ_begin(),
208            E = ParentBlock->succ_end(); SI != E; ++SI) {
209         if (AllUsesDominatedByBlock(Reg, *SI)) {
210           SuccToSinkTo = *SI;
211           break;
212         }
213       }
214       
215       // If we couldn't find a block to sink to, ignore this instruction.
216       if (SuccToSinkTo == 0)
217         return false;
218     }
219   }
220   
221   // If there are no outputs, it must have side-effects.
222   if (SuccToSinkTo == 0)
223     return false;
224   
225   DEBUG(cerr << "Sink instr " << *MI);
226   DEBUG(cerr << "to block " << *SuccToSinkTo);
227   
228   // If the block has multiple predecessors, this would introduce computation on
229   // a path that it doesn't already exist.  We could split the critical edge,
230   // but for now we just punt.
231   // FIXME: Split critical edges if not backedges.
232   if (SuccToSinkTo->pred_size() > 1) {
233     DEBUG(cerr << " *** PUNTING: Critical edge found\n");
234     return false;
235   }
236   
237   // Determine where to insert into.  Skip phi nodes.
238   MachineBasicBlock::iterator InsertPos = SuccToSinkTo->begin();
239   while (InsertPos != SuccToSinkTo->end() && 
240          InsertPos->getOpcode() == TargetInstrInfo::PHI)
241     ++InsertPos;
242   
243   // Move the instruction.
244   SuccToSinkTo->splice(InsertPos, ParentBlock, MI,
245                        ++MachineBasicBlock::iterator(MI));
246   return true;
247 }