1 //===-- LiveIntervalAnalysis.h - Live Interval Analysis ---------*- C++ -*-===//
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 LiveInterval analysis pass. Given some numbering of
11 // each the machine instructions (in this implemention depth-first order) an
12 // interval [i, j) is said to be a live interval for register v if there is no
13 // instruction with number j' > j such that v is live at j' and there is no
14 // instruction with number i' < i such that v is live at i'. In this
15 // implementation intervals can have holes, i.e. an interval might look like
16 // [1,20), [50,65), [1000,1001).
18 //===----------------------------------------------------------------------===//
20 #ifndef LLVM_CODEGEN_LIVEINTERVAL_ANALYSIS_H
21 #define LLVM_CODEGEN_LIVEINTERVAL_ANALYSIS_H
23 #include "llvm/CodeGen/MachineBasicBlock.h"
24 #include "llvm/CodeGen/MachineFunctionPass.h"
25 #include "llvm/CodeGen/LiveInterval.h"
26 #include "llvm/CodeGen/SlotIndexes.h"
27 #include "llvm/ADT/BitVector.h"
28 #include "llvm/ADT/DenseMap.h"
29 #include "llvm/ADT/SmallPtrSet.h"
30 #include "llvm/ADT/SmallVector.h"
31 #include "llvm/Support/Allocator.h"
39 class MachineLoopInfo;
40 class TargetRegisterInfo;
41 class MachineRegisterInfo;
42 class TargetInstrInfo;
43 class TargetRegisterClass;
46 class LiveIntervals : public MachineFunctionPass {
48 MachineRegisterInfo* mri_;
49 const TargetMachine* tm_;
50 const TargetRegisterInfo* tri_;
51 const TargetInstrInfo* tii_;
54 SlotIndexes* indexes_;
56 /// Special pool allocator for VNInfo's (LiveInterval val#).
58 VNInfo::Allocator VNInfoAllocator;
60 typedef DenseMap<unsigned, LiveInterval*> Reg2IntervalMap;
61 Reg2IntervalMap r2iMap_;
63 /// allocatableRegs_ - A bit vector of allocatable registers.
64 BitVector allocatableRegs_;
66 /// CloneMIs - A list of clones as result of re-materialization.
67 std::vector<MachineInstr*> CloneMIs;
70 static char ID; // Pass identification, replacement for typeid
71 LiveIntervals() : MachineFunctionPass(ID) {
72 initializeLiveIntervalsPass(*PassRegistry::getPassRegistry());
75 // Calculate the spill weight to assign to a single instruction.
76 static float getSpillWeight(bool isDef, bool isUse, unsigned loopDepth);
78 // After summing the spill weights of all defs and uses, the final weight
79 // should be normalized, dividing the weight of the interval by its size.
80 // This encourages spilling of intervals that are large and have few uses,
81 // and discourages spilling of small intervals with many uses.
82 void normalizeSpillWeight(LiveInterval &li) {
83 li.weight /= getApproximateInstructionCount(li) + 25;
86 typedef Reg2IntervalMap::iterator iterator;
87 typedef Reg2IntervalMap::const_iterator const_iterator;
88 const_iterator begin() const { return r2iMap_.begin(); }
89 const_iterator end() const { return r2iMap_.end(); }
90 iterator begin() { return r2iMap_.begin(); }
91 iterator end() { return r2iMap_.end(); }
92 unsigned getNumIntervals() const { return (unsigned)r2iMap_.size(); }
94 LiveInterval &getInterval(unsigned reg) {
95 Reg2IntervalMap::iterator I = r2iMap_.find(reg);
96 assert(I != r2iMap_.end() && "Interval does not exist for register");
100 const LiveInterval &getInterval(unsigned reg) const {
101 Reg2IntervalMap::const_iterator I = r2iMap_.find(reg);
102 assert(I != r2iMap_.end() && "Interval does not exist for register");
106 bool hasInterval(unsigned reg) const {
107 return r2iMap_.count(reg);
110 /// isAllocatable - is the physical register reg allocatable in the current
112 bool isAllocatable(unsigned reg) const {
113 return allocatableRegs_.test(reg);
116 /// getScaledIntervalSize - get the size of an interval in "units,"
117 /// where every function is composed of one thousand units. This
118 /// measure scales properly with empty index slots in the function.
119 double getScaledIntervalSize(LiveInterval& I) {
120 return (1000.0 * I.getSize()) / indexes_->getIndexesLength();
123 /// getFuncInstructionCount - Return the number of instructions in the
124 /// current function.
125 unsigned getFuncInstructionCount() {
126 return indexes_->getFunctionSize();
129 /// getApproximateInstructionCount - computes an estimate of the number
130 /// of instructions in a given LiveInterval.
131 unsigned getApproximateInstructionCount(LiveInterval& I) {
132 double IntervalPercentage = getScaledIntervalSize(I) / 1000.0;
133 return (unsigned)(IntervalPercentage * indexes_->getFunctionSize());
136 /// conflictsWithPhysReg - Returns true if the specified register is used or
137 /// defined during the duration of the specified interval. Copies to and
138 /// from li.reg are allowed. This method is only able to analyze simple
139 /// ranges that stay within a single basic block. Anything else is
140 /// considered a conflict.
141 bool conflictsWithPhysReg(const LiveInterval &li, VirtRegMap &vrm,
144 /// conflictsWithAliasRef - Similar to conflictsWithPhysRegRef except
145 /// it checks for alias uses and defs.
146 bool conflictsWithAliasRef(LiveInterval &li, unsigned Reg,
147 SmallPtrSet<MachineInstr*,32> &JoinedCopies);
150 LiveInterval &getOrCreateInterval(unsigned reg) {
151 Reg2IntervalMap::iterator I = r2iMap_.find(reg);
152 if (I == r2iMap_.end())
153 I = r2iMap_.insert(std::make_pair(reg, createInterval(reg))).first;
157 /// dupInterval - Duplicate a live interval. The caller is responsible for
158 /// managing the allocated memory.
159 LiveInterval *dupInterval(LiveInterval *li);
161 /// addLiveRangeToEndOfBlock - Given a register and an instruction,
162 /// adds a live range from that instruction to the end of its MBB.
163 LiveRange addLiveRangeToEndOfBlock(unsigned reg,
164 MachineInstr* startInst);
168 void removeInterval(unsigned Reg) {
169 DenseMap<unsigned, LiveInterval*>::iterator I = r2iMap_.find(Reg);
174 SlotIndexes *getSlotIndexes() const {
178 SlotIndex getZeroIndex() const {
179 return indexes_->getZeroIndex();
182 SlotIndex getInvalidIndex() const {
183 return indexes_->getInvalidIndex();
186 /// isNotInMIMap - returns true if the specified machine instr has been
187 /// removed or was never entered in the map.
188 bool isNotInMIMap(const MachineInstr* Instr) const {
189 return !indexes_->hasIndex(Instr);
192 /// Returns the base index of the given instruction.
193 SlotIndex getInstructionIndex(const MachineInstr *instr) const {
194 return indexes_->getInstructionIndex(instr);
197 /// Returns the instruction associated with the given index.
198 MachineInstr* getInstructionFromIndex(SlotIndex index) const {
199 return indexes_->getInstructionFromIndex(index);
202 /// Return the first index in the given basic block.
203 SlotIndex getMBBStartIdx(const MachineBasicBlock *mbb) const {
204 return indexes_->getMBBStartIdx(mbb);
207 /// Return the last index in the given basic block.
208 SlotIndex getMBBEndIdx(const MachineBasicBlock *mbb) const {
209 return indexes_->getMBBEndIdx(mbb);
212 bool isLiveInToMBB(const LiveInterval &li,
213 const MachineBasicBlock *mbb) const {
214 return li.liveAt(getMBBStartIdx(mbb));
217 LiveRange* findEnteringRange(LiveInterval &li,
218 const MachineBasicBlock *mbb) {
219 return li.getLiveRangeContaining(getMBBStartIdx(mbb));
222 bool isLiveOutOfMBB(const LiveInterval &li,
223 const MachineBasicBlock *mbb) const {
224 return li.liveAt(getMBBEndIdx(mbb).getPrevSlot());
227 LiveRange* findExitingRange(LiveInterval &li,
228 const MachineBasicBlock *mbb) {
229 return li.getLiveRangeContaining(getMBBEndIdx(mbb).getPrevSlot());
232 MachineBasicBlock* getMBBFromIndex(SlotIndex index) const {
233 return indexes_->getMBBFromIndex(index);
236 SlotIndex InsertMachineInstrInMaps(MachineInstr *MI) {
237 return indexes_->insertMachineInstrInMaps(MI);
240 void RemoveMachineInstrFromMaps(MachineInstr *MI) {
241 indexes_->removeMachineInstrFromMaps(MI);
244 void ReplaceMachineInstrInMaps(MachineInstr *MI, MachineInstr *NewMI) {
245 indexes_->replaceMachineInstrInMaps(MI, NewMI);
248 void InsertMBBInMaps(MachineBasicBlock *MBB) {
249 indexes_->insertMBBInMaps(MBB);
252 bool findLiveInMBBs(SlotIndex Start, SlotIndex End,
253 SmallVectorImpl<MachineBasicBlock*> &MBBs) const {
254 return indexes_->findLiveInMBBs(Start, End, MBBs);
258 indexes_->renumberIndexes();
261 VNInfo::Allocator& getVNInfoAllocator() { return VNInfoAllocator; }
263 virtual void getAnalysisUsage(AnalysisUsage &AU) const;
264 virtual void releaseMemory();
266 /// runOnMachineFunction - pass entry point
267 virtual bool runOnMachineFunction(MachineFunction&);
269 /// print - Implement the dump method.
270 virtual void print(raw_ostream &O, const Module* = 0) const;
272 /// addIntervalsForSpills - Create new intervals for spilled defs / uses of
273 /// the given interval. FIXME: It also returns the weight of the spill slot
274 /// (if any is created) by reference. This is temporary.
275 std::vector<LiveInterval*>
276 addIntervalsForSpills(const LiveInterval& i,
277 const SmallVectorImpl<LiveInterval*> &SpillIs,
278 const MachineLoopInfo *loopInfo, VirtRegMap& vrm);
280 /// spillPhysRegAroundRegDefsUses - Spill the specified physical register
281 /// around all defs and uses of the specified interval. Return true if it
282 /// was able to cut its interval.
283 bool spillPhysRegAroundRegDefsUses(const LiveInterval &li,
284 unsigned PhysReg, VirtRegMap &vrm);
286 /// isReMaterializable - Returns true if every definition of MI of every
287 /// val# of the specified interval is re-materializable. Also returns true
288 /// by reference if all of the defs are load instructions.
289 bool isReMaterializable(const LiveInterval &li,
290 const SmallVectorImpl<LiveInterval*> &SpillIs,
293 /// isReMaterializable - Returns true if the definition MI of the specified
294 /// val# of the specified interval is re-materializable.
295 bool isReMaterializable(const LiveInterval &li, const VNInfo *ValNo,
298 /// getRepresentativeReg - Find the largest super register of the specified
299 /// physical register.
300 unsigned getRepresentativeReg(unsigned Reg) const;
302 /// getNumConflictsWithPhysReg - Return the number of uses and defs of the
303 /// specified interval that conflicts with the specified physical register.
304 unsigned getNumConflictsWithPhysReg(const LiveInterval &li,
305 unsigned PhysReg) const;
307 /// intervalIsInOneMBB - Returns true if the specified interval is entirely
308 /// within a single basic block.
309 bool intervalIsInOneMBB(const LiveInterval &li) const;
312 /// computeIntervals - Compute live intervals.
313 void computeIntervals();
315 /// handleRegisterDef - update intervals for a register def
316 /// (calls handlePhysicalRegisterDef and
317 /// handleVirtualRegisterDef)
318 void handleRegisterDef(MachineBasicBlock *MBB,
319 MachineBasicBlock::iterator MI,
321 MachineOperand& MO, unsigned MOIdx);
323 /// isPartialRedef - Return true if the specified def at the specific index
324 /// is partially re-defining the specified live interval. A common case of
325 /// this is a definition of the sub-register.
326 bool isPartialRedef(SlotIndex MIIdx, MachineOperand &MO,
327 LiveInterval &interval);
329 /// handleVirtualRegisterDef - update intervals for a virtual
331 void handleVirtualRegisterDef(MachineBasicBlock *MBB,
332 MachineBasicBlock::iterator MI,
333 SlotIndex MIIdx, MachineOperand& MO,
335 LiveInterval& interval);
337 /// handlePhysicalRegisterDef - update intervals for a physical register
339 void handlePhysicalRegisterDef(MachineBasicBlock* mbb,
340 MachineBasicBlock::iterator mi,
341 SlotIndex MIIdx, MachineOperand& MO,
342 LiveInterval &interval,
343 MachineInstr *CopyMI);
345 /// handleLiveInRegister - Create interval for a livein register.
346 void handleLiveInRegister(MachineBasicBlock* mbb,
348 LiveInterval &interval, bool isAlias = false);
350 /// getReMatImplicitUse - If the remat definition MI has one (for now, we
351 /// only allow one) virtual register operand, then its uses are implicitly
352 /// using the register. Returns the virtual register.
353 unsigned getReMatImplicitUse(const LiveInterval &li,
354 MachineInstr *MI) const;
356 /// isValNoAvailableAt - Return true if the val# of the specified interval
357 /// which reaches the given instruction also reaches the specified use
359 bool isValNoAvailableAt(const LiveInterval &li, MachineInstr *MI,
360 SlotIndex UseIdx) const;
362 /// isReMaterializable - Returns true if the definition MI of the specified
363 /// val# of the specified interval is re-materializable. Also returns true
364 /// by reference if the def is a load.
365 bool isReMaterializable(const LiveInterval &li, const VNInfo *ValNo,
367 const SmallVectorImpl<LiveInterval*> &SpillIs,
370 /// tryFoldMemoryOperand - Attempts to fold either a spill / restore from
371 /// slot / to reg or any rematerialized load into ith operand of specified
372 /// MI. If it is successul, MI is updated with the newly created MI and
374 bool tryFoldMemoryOperand(MachineInstr* &MI, VirtRegMap &vrm,
375 MachineInstr *DefMI, SlotIndex InstrIdx,
376 SmallVector<unsigned, 2> &Ops,
377 bool isSS, int FrameIndex, unsigned Reg);
379 /// canFoldMemoryOperand - Return true if the specified load / store
380 /// folding is possible.
381 bool canFoldMemoryOperand(MachineInstr *MI,
382 SmallVector<unsigned, 2> &Ops,
383 bool ReMatLoadSS) const;
385 /// anyKillInMBBAfterIdx - Returns true if there is a kill of the specified
386 /// VNInfo that's after the specified index but is within the basic block.
387 bool anyKillInMBBAfterIdx(const LiveInterval &li, const VNInfo *VNI,
388 MachineBasicBlock *MBB,
389 SlotIndex Idx) const;
391 /// hasAllocatableSuperReg - Return true if the specified physical register
392 /// has any super register that's allocatable.
393 bool hasAllocatableSuperReg(unsigned Reg) const;
395 /// SRInfo - Spill / restore info.
400 SRInfo(SlotIndex i, unsigned vr, bool f)
401 : index(i), vreg(vr), canFold(f) {}
404 bool alsoFoldARestore(int Id, SlotIndex index, unsigned vr,
405 BitVector &RestoreMBBs,
406 DenseMap<unsigned,std::vector<SRInfo> >&RestoreIdxes);
407 void eraseRestoreInfo(int Id, SlotIndex index, unsigned vr,
408 BitVector &RestoreMBBs,
409 DenseMap<unsigned,std::vector<SRInfo> >&RestoreIdxes);
411 /// handleSpilledImpDefs - Remove IMPLICIT_DEF instructions which are being
412 /// spilled and create empty intervals for their uses.
413 void handleSpilledImpDefs(const LiveInterval &li, VirtRegMap &vrm,
414 const TargetRegisterClass* rc,
415 std::vector<LiveInterval*> &NewLIs);
417 /// rewriteImplicitOps - Rewrite implicit use operands of MI (i.e. uses of
418 /// interval on to-be re-materialized operands of MI) with new register.
419 void rewriteImplicitOps(const LiveInterval &li,
420 MachineInstr *MI, unsigned NewVReg, VirtRegMap &vrm);
422 /// rewriteInstructionForSpills, rewriteInstructionsForSpills - Helper
423 /// functions for addIntervalsForSpills to rewrite uses / defs for the given
425 bool rewriteInstructionForSpills(const LiveInterval &li, const VNInfo *VNI,
426 bool TrySplit, SlotIndex index, SlotIndex end,
427 MachineInstr *MI, MachineInstr *OrigDefMI, MachineInstr *DefMI,
428 unsigned Slot, int LdSlot,
429 bool isLoad, bool isLoadSS, bool DefIsReMat, bool CanDelete,
430 VirtRegMap &vrm, const TargetRegisterClass* rc,
431 SmallVector<int, 4> &ReMatIds, const MachineLoopInfo *loopInfo,
432 unsigned &NewVReg, unsigned ImpUse, bool &HasDef, bool &HasUse,
433 DenseMap<unsigned,unsigned> &MBBVRegsMap,
434 std::vector<LiveInterval*> &NewLIs);
435 void rewriteInstructionsForSpills(const LiveInterval &li, bool TrySplit,
436 LiveInterval::Ranges::const_iterator &I,
437 MachineInstr *OrigDefMI, MachineInstr *DefMI, unsigned Slot, int LdSlot,
438 bool isLoad, bool isLoadSS, bool DefIsReMat, bool CanDelete,
439 VirtRegMap &vrm, const TargetRegisterClass* rc,
440 SmallVector<int, 4> &ReMatIds, const MachineLoopInfo *loopInfo,
441 BitVector &SpillMBBs,
442 DenseMap<unsigned,std::vector<SRInfo> > &SpillIdxes,
443 BitVector &RestoreMBBs,
444 DenseMap<unsigned,std::vector<SRInfo> > &RestoreIdxes,
445 DenseMap<unsigned,unsigned> &MBBVRegsMap,
446 std::vector<LiveInterval*> &NewLIs);
448 // Normalize the spill weight of all the intervals in NewLIs.
449 void normalizeSpillWeights(std::vector<LiveInterval*> &NewLIs);
451 static LiveInterval* createInterval(unsigned Reg);
453 void printInstrs(raw_ostream &O) const;
454 void dumpInstrs() const;
456 } // End llvm namespace