1 //===---------- SplitKit.cpp - Toolkit for splitting live ranges ----------===//
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 contains the SplitAnalysis class as well as mutator functions for
11 // live range splitting.
13 //===----------------------------------------------------------------------===//
15 #include "llvm/ADT/SmallPtrSet.h"
16 #include "llvm/ADT/DenseMap.h"
17 #include "llvm/CodeGen/SlotIndexes.h"
25 class MachineLoopInfo;
26 class MachineRegisterInfo;
27 class TargetInstrInfo;
31 /// SplitAnalysis - Analyze a LiveInterval, looking for live range splitting
35 const MachineFunction &mf_;
36 const LiveIntervals &lis_;
37 const MachineLoopInfo &loops_;
38 const TargetInstrInfo &tii_;
40 // Instructions using the the current register.
41 typedef SmallPtrSet<const MachineInstr*, 16> InstrPtrSet;
42 InstrPtrSet usingInstrs_;
44 // The number of instructions using curli in each basic block.
45 typedef DenseMap<const MachineBasicBlock*, unsigned> BlockCountMap;
46 BlockCountMap usingBlocks_;
48 // The number of basic block using curli in each loop.
49 typedef DenseMap<const MachineLoop*, unsigned> LoopCountMap;
50 LoopCountMap usingLoops_;
53 // Current live interval.
54 const LiveInterval *curli_;
56 // Sumarize statistics by counting instructions using curli_.
59 /// canAnalyzeBranch - Return true if MBB ends in a branch that can be
61 bool canAnalyzeBranch(const MachineBasicBlock *MBB);
64 SplitAnalysis(const MachineFunction &mf, const LiveIntervals &lis,
65 const MachineLoopInfo &mli);
67 /// analyze - set curli to the specified interval, and analyze how it may be
69 void analyze(const LiveInterval *li);
71 /// removeUse - Update statistics by noting that mi no longer uses curli.
72 void removeUse(const MachineInstr *mi);
74 const LiveInterval *getCurLI() { return curli_; }
76 /// clear - clear all data structures so SplitAnalysis is ready to analyze a
80 typedef SmallPtrSet<const MachineBasicBlock*, 16> BlockPtrSet;
81 typedef SmallPtrSet<const MachineLoop*, 16> LoopPtrSet;
83 // Sets of basic blocks surrounding a machine loop.
85 BlockPtrSet Loop; // Blocks in the loop.
86 BlockPtrSet Preds; // Loop predecessor blocks.
87 BlockPtrSet Exits; // Loop exit blocks.
96 // Calculate the block sets surrounding the loop.
97 void getLoopBlocks(const MachineLoop *Loop, LoopBlocks &Blocks);
99 /// LoopPeripheralUse - how is a variable used in and around a loop?
100 /// Peripheral blocks are the loop predecessors and exit blocks.
101 enum LoopPeripheralUse {
102 ContainedInLoop, // All uses are inside the loop.
103 SinglePeripheral, // At most one instruction per peripheral block.
104 MultiPeripheral, // Multiple instructions in some peripheral blocks.
105 OutsideLoop // Uses outside loop periphery.
108 /// analyzeLoopPeripheralUse - Return an enum describing how curli_ is used in
109 /// and around the Loop.
110 LoopPeripheralUse analyzeLoopPeripheralUse(const LoopBlocks&);
112 /// getCriticalExits - It may be necessary to partially break critical edges
113 /// leaving the loop if an exit block has phi uses of curli. Collect the exit
114 /// blocks that need special treatment into CriticalExits.
115 void getCriticalExits(const LoopBlocks &Blocks, BlockPtrSet &CriticalExits);
117 /// canSplitCriticalExits - Return true if it is possible to insert new exit
118 /// blocks before the blocks in CriticalExits.
119 bool canSplitCriticalExits(const LoopBlocks &Blocks,
120 BlockPtrSet &CriticalExits);
122 /// getBestSplitLoop - Return the loop where curli may best be split to a
123 /// separate register, or NULL.
124 const MachineLoop *getBestSplitLoop();
126 /// getMultiUseBlocks - Add basic blocks to Blocks that may benefit from
127 /// having curli split to a new live interval. Return true if Blocks can be
128 /// passed to SplitEditor::splitSingleBlocks.
129 bool getMultiUseBlocks(BlockPtrSet &Blocks);
132 /// SplitEditor - Edit machine code and LiveIntervals for live range
135 /// - Create a SplitEditor from a SplitAnalysis.
136 /// - Start a new live interval with openIntv.
137 /// - Mark the places where the new interval is entered using enterIntv*
138 /// - Mark the ranges where the new interval is used with useIntv*
139 /// - Mark the places where the interval is exited with exitIntv*.
140 /// - Finish the current interval with closeIntv and repeat from 2.
141 /// - Rewrite instructions with rewrite().
147 MachineRegisterInfo &mri_;
148 const TargetInstrInfo &tii_;
150 /// curli_ - The immutable interval we are currently splitting.
151 const LiveInterval *const curli_;
153 /// dupli_ - Created as a copy of curli_, ranges are carved out as new
154 /// intervals get added through openIntv / closeIntv. This is used to avoid
156 LiveInterval *dupli_;
158 /// Currently open LiveInterval.
159 LiveInterval *openli_;
161 /// createInterval - Create a new virtual register and LiveInterval with same
162 /// register class and spill slot as curli.
163 LiveInterval *createInterval();
165 /// getDupLI - Ensure dupli is created and return it.
166 LiveInterval *getDupLI();
168 /// valueMap_ - Map values in cupli to values in openli. These are direct 1-1
169 /// mappings, and do not include values created by inserted copies.
170 DenseMap<const VNInfo*, VNInfo*> valueMap_;
172 /// mapValue - Return the openIntv value that corresponds to the given curli
174 VNInfo *mapValue(const VNInfo *curliVNI);
176 /// A dupli value is live through openIntv.
179 /// All the new intervals created for this split are added to intervals_.
180 std::vector<LiveInterval*> &intervals_;
182 /// The index into intervals_ of the first interval we added. There may be
183 /// others from before we got it.
184 unsigned firstInterval;
186 /// Insert a COPY instruction curli -> li. Allocate a new value from li
187 /// defined by the COPY
188 VNInfo *insertCopy(LiveInterval &LI,
189 MachineBasicBlock &MBB,
190 MachineBasicBlock::iterator I);
193 /// Create a new SplitEditor for editing the LiveInterval analyzed by SA.
194 /// Newly created intervals will be appended to newIntervals.
195 SplitEditor(SplitAnalysis &SA, LiveIntervals&, VirtRegMap&,
196 std::vector<LiveInterval*> &newIntervals);
198 /// getAnalysis - Get the corresponding analysis.
199 SplitAnalysis &getAnalysis() { return sa_; }
201 /// Create a new virtual register and live interval.
204 /// enterIntvBefore - Enter openli before the instruction at Idx. If curli is
205 /// not live before Idx, a COPY is not inserted.
206 void enterIntvBefore(SlotIndex Idx);
208 /// enterIntvAtEnd - Enter openli at the end of MBB.
209 /// PhiMBB is a successor inside openli where a PHI value is created.
210 /// Currently, all entries must share the same PhiMBB.
211 void enterIntvAtEnd(MachineBasicBlock &MBB, MachineBasicBlock &PhiMBB);
213 /// useIntv - indicate that all instructions in MBB should use openli.
214 void useIntv(const MachineBasicBlock &MBB);
216 /// useIntv - indicate that all instructions in range should use openli.
217 void useIntv(SlotIndex Start, SlotIndex End);
219 /// leaveIntvAfter - Leave openli after the instruction at Idx.
220 void leaveIntvAfter(SlotIndex Idx);
222 /// leaveIntvAtTop - Leave the interval at the top of MBB.
223 /// Currently, only one value can leave the interval.
224 void leaveIntvAtTop(MachineBasicBlock &MBB);
226 /// closeIntv - Indicate that we are done editing the currently open
227 /// LiveInterval, and ranges can be trimmed.
230 /// rewrite - after all the new live ranges have been created, rewrite
231 /// instructions using curli to use the new intervals.
234 // ===--- High level methods ---===
236 /// splitAroundLoop - Split curli into a separate live interval inside
237 /// the loop. Return true if curli has been completely replaced, false if
238 /// curli is still intact, and needs to be spilled or split further.
239 bool splitAroundLoop(const MachineLoop*);
241 /// splitSingleBlocks - Split curli into a separate live interval inside each
242 /// basic block in Blocks. Return true if curli has been completely replaced,
243 /// false if curli is still intact, and needs to be spilled or split further.
244 bool splitSingleBlocks(const SplitAnalysis::BlockPtrSet &Blocks);