1 //===-------- SplitKit.h - Toolkit for splitting live ranges ----*- 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 contains the SplitAnalysis class as well as mutator functions for
11 // live range splitting.
13 //===----------------------------------------------------------------------===//
15 #include "llvm/ADT/DenseMap.h"
16 #include "llvm/ADT/IntervalMap.h"
17 #include "llvm/ADT/SmallPtrSet.h"
18 #include "llvm/CodeGen/SlotIndexes.h"
22 class ConnectedVNInfoEqClasses;
27 class MachineLoopInfo;
28 class MachineRegisterInfo;
29 class TargetInstrInfo;
30 class TargetRegisterInfo;
35 /// At some point we should just include MachineDominators.h:
36 class MachineDominatorTree;
37 template <class NodeT> class DomTreeNodeBase;
38 typedef DomTreeNodeBase<MachineBasicBlock> MachineDomTreeNode;
41 /// SplitAnalysis - Analyze a LiveInterval, looking for live range splitting
45 const MachineFunction &MF;
46 const LiveIntervals &LIS;
47 const MachineLoopInfo &Loops;
48 const TargetInstrInfo &TII;
50 // Instructions using the the current register.
51 typedef SmallPtrSet<const MachineInstr*, 16> InstrPtrSet;
52 InstrPtrSet UsingInstrs;
54 // Sorted slot indexes of using instructions.
55 SmallVector<SlotIndex, 8> UseSlots;
57 // The number of instructions using CurLI in each basic block.
58 typedef DenseMap<const MachineBasicBlock*, unsigned> BlockCountMap;
59 BlockCountMap UsingBlocks;
61 /// Additional information about basic blocks where the current variable is
62 /// live. Such a block will look like one of these templates:
64 /// 1. | o---x | Internal to block. Variable is only live in this block.
65 /// 2. |---x | Live-in, kill.
66 /// 3. | o---| Def, live-out.
67 /// 4. |---x o---| Live-in, kill, def, live-out.
68 /// 5. |---o---o---| Live-through with uses or defs.
69 /// 6. |-----------| Live-through without uses. Transparent.
72 MachineBasicBlock *MBB;
73 SlotIndex FirstUse; ///< First instr using current reg.
74 SlotIndex LastUse; ///< Last instr using current reg.
75 SlotIndex Kill; ///< Interval end point inside block.
76 SlotIndex Def; ///< Interval start point inside block.
77 /// Last possible point for splitting live ranges.
78 SlotIndex LastSplitPoint;
79 bool Uses; ///< Current reg has uses or defs in block.
80 bool LiveThrough; ///< Live in whole block (Templ 5. or 6. above).
81 bool LiveIn; ///< Current reg is live in.
82 bool LiveOut; ///< Current reg is live out.
84 // Per-interference pattern scratch data.
85 bool OverlapEntry; ///< Interference overlaps entering interval.
86 bool OverlapExit; ///< Interference overlaps exiting interval.
89 /// Basic blocks where var is live. This array is parallel to
91 SmallVector<BlockInfo, 8> LiveBlocks;
94 // Current live interval.
95 const LiveInterval *CurLI;
97 // Sumarize statistics by counting instructions using CurLI.
100 /// calcLiveBlockInfo - Compute per-block information about CurLI.
101 void calcLiveBlockInfo();
103 /// canAnalyzeBranch - Return true if MBB ends in a branch that can be
105 bool canAnalyzeBranch(const MachineBasicBlock *MBB);
108 SplitAnalysis(const MachineFunction &mf, const LiveIntervals &lis,
109 const MachineLoopInfo &mli);
111 /// analyze - set CurLI to the specified interval, and analyze how it may be
113 void analyze(const LiveInterval *li);
115 /// clear - clear all data structures so SplitAnalysis is ready to analyze a
119 /// hasUses - Return true if MBB has any uses of CurLI.
120 bool hasUses(const MachineBasicBlock *MBB) const {
121 return UsingBlocks.lookup(MBB);
124 typedef SmallPtrSet<const MachineBasicBlock*, 16> BlockPtrSet;
126 // Print a set of blocks with use counts.
127 void print(const BlockPtrSet&, raw_ostream&) const;
129 /// getMultiUseBlocks - Add basic blocks to Blocks that may benefit from
130 /// having CurLI split to a new live interval. Return true if Blocks can be
131 /// passed to SplitEditor::splitSingleBlocks.
132 bool getMultiUseBlocks(BlockPtrSet &Blocks);
134 /// getBlockForInsideSplit - If CurLI is contained inside a single basic
135 /// block, and it would pay to subdivide the interval inside that block,
136 /// return it. Otherwise return NULL. The returned block can be passed to
137 /// SplitEditor::splitInsideBlock.
138 const MachineBasicBlock *getBlockForInsideSplit();
142 /// LiveIntervalMap - Map values from a large LiveInterval into a small
143 /// interval that is a subset. Insert phi-def values as needed. This class is
144 /// used by SplitEditor to create new smaller LiveIntervals.
146 /// ParentLI is the larger interval, LI is the subset interval. Every value
147 /// in LI corresponds to exactly one value in ParentLI, and the live range
148 /// of the value is contained within the live range of the ParentLI value.
149 /// Values in ParentLI may map to any number of OpenLI values, including 0.
150 class LiveIntervalMap {
152 MachineDominatorTree &MDT;
154 // The parent interval is never changed.
155 const LiveInterval &ParentLI;
157 // The child interval's values are fully contained inside ParentLI values.
160 typedef DenseMap<const VNInfo*, VNInfo*> ValueMap;
162 // Map ParentLI values to simple values in LI that are defined at the same
163 // SlotIndex, or NULL for ParentLI values that have complex LI defs.
164 // Note there is a difference between values mapping to NULL (complex), and
165 // values not present (unknown/unmapped).
168 typedef std::pair<VNInfo*, MachineDomTreeNode*> LiveOutPair;
169 typedef DenseMap<MachineBasicBlock*,LiveOutPair> LiveOutMap;
171 // LiveOutCache - Map each basic block where LI is live out to the live-out
172 // value and its defining block. One of these conditions shall be true:
174 // 1. !LiveOutCache.count(MBB)
175 // 2. LiveOutCache[MBB].second.getNode() == MBB
176 // 3. forall P in preds(MBB): LiveOutCache[P] == LiveOutCache[MBB]
178 // This is only a cache, the values can be computed as:
180 // VNI = LI->getVNInfoAt(LIS.getMBBEndIdx(MBB))
181 // Node = mbt_[LIS.getMBBFromIndex(VNI->def)]
183 // The cache is also used as a visiteed set by mapValue().
184 LiveOutMap LiveOutCache;
186 // Dump the live-out cache to dbgs().
190 LiveIntervalMap(LiveIntervals &lis,
191 MachineDominatorTree &mdt,
192 const LiveInterval &parentli)
193 : LIS(lis), MDT(mdt), ParentLI(parentli), LI(0) {}
195 /// reset - clear all data structures and start a new live interval.
196 void reset(LiveInterval *);
198 /// getLI - return the current live interval.
199 LiveInterval *getLI() const { return LI; }
201 /// defValue - define a value in LI from the ParentLI value VNI and Idx.
202 /// Idx does not have to be ParentVNI->def, but it must be contained within
203 /// ParentVNI's live range in ParentLI.
204 /// Return the new LI value.
205 VNInfo *defValue(const VNInfo *ParentVNI, SlotIndex Idx);
207 /// mapValue - map ParentVNI to the corresponding LI value at Idx. It is
208 /// assumed that ParentVNI is live at Idx.
209 /// If ParentVNI has not been defined by defValue, it is assumed that
210 /// ParentVNI->def dominates Idx.
211 /// If ParentVNI has been defined by defValue one or more times, a value that
212 /// dominates Idx will be returned. This may require creating extra phi-def
213 /// values and adding live ranges to LI.
214 /// If simple is not NULL, *simple will indicate if ParentVNI is a simply
216 VNInfo *mapValue(const VNInfo *ParentVNI, SlotIndex Idx, bool *simple = 0);
218 // extendTo - Find the last LI value defined in MBB at or before Idx. The
219 // parentli is assumed to be live at Idx. Extend the live range to include
220 // Idx. Return the found VNInfo, or NULL.
221 VNInfo *extendTo(const MachineBasicBlock *MBB, SlotIndex Idx);
223 /// isMapped - Return true is ParentVNI is a known mapped value. It may be a
224 /// simple 1-1 mapping or a complex mapping to later defs.
225 bool isMapped(const VNInfo *ParentVNI) const {
226 return Values.count(ParentVNI);
229 /// isComplexMapped - Return true if ParentVNI has received new definitions
231 bool isComplexMapped(const VNInfo *ParentVNI) const;
233 /// markComplexMapped - Mark ParentVNI as complex mapped regardless of the
234 /// number of definitions.
235 void markComplexMapped(const VNInfo *ParentVNI) { Values[ParentVNI] = 0; }
237 // addSimpleRange - Add a simple range from ParentLI to LI.
238 // ParentVNI must be live in the [Start;End) interval.
239 void addSimpleRange(SlotIndex Start, SlotIndex End, const VNInfo *ParentVNI);
241 /// addRange - Add live ranges to LI where [Start;End) intersects ParentLI.
242 /// All needed values whose def is not inside [Start;End) must be defined
243 /// beforehand so mapValue will work.
244 void addRange(SlotIndex Start, SlotIndex End);
248 /// SplitEditor - Edit machine code and LiveIntervals for live range
251 /// - Create a SplitEditor from a SplitAnalysis.
252 /// - Start a new live interval with openIntv.
253 /// - Mark the places where the new interval is entered using enterIntv*
254 /// - Mark the ranges where the new interval is used with useIntv*
255 /// - Mark the places where the interval is exited with exitIntv*.
256 /// - Finish the current interval with closeIntv and repeat from 2.
257 /// - Rewrite instructions with finish().
263 MachineRegisterInfo &MRI;
264 MachineDominatorTree &MDT;
265 const TargetInstrInfo &TII;
266 const TargetRegisterInfo &TRI;
268 /// Edit - The current parent register and new intervals created.
271 /// Index into Edit of the currently open interval.
272 /// The index 0 is used for the complement, so the first interval started by
273 /// openIntv will be 1.
276 typedef IntervalMap<SlotIndex, unsigned> RegAssignMap;
278 /// Allocator for the interval map. This will eventually be shared with
279 /// SlotIndexes and LiveIntervals.
280 RegAssignMap::Allocator Allocator;
282 /// RegAssign - Map of the assigned register indexes.
283 /// Edit.get(RegAssign.lookup(Idx)) is the register that should be live at
285 RegAssignMap RegAssign;
287 /// LIMappers - One LiveIntervalMap or each interval in Edit.
288 SmallVector<LiveIntervalMap, 4> LIMappers;
290 /// defFromParent - Define Reg from ParentVNI at UseIdx using either
291 /// rematerialization or a COPY from parent. Return the new value.
292 VNInfo *defFromParent(unsigned RegIdx,
295 MachineBasicBlock &MBB,
296 MachineBasicBlock::iterator I);
298 /// rewriteAssigned - Rewrite all uses of Edit.getReg() to assigned registers.
299 void rewriteAssigned();
301 /// rewriteComponents - Rewrite all uses of Intv[0] according to the eq
302 /// classes in ConEQ.
303 /// This must be done when Intvs[0] is styill live at all uses, before calling
304 /// ConEq.Distribute().
305 void rewriteComponents(const SmallVectorImpl<LiveInterval*> &Intvs,
306 const ConnectedVNInfoEqClasses &ConEq);
309 /// Create a new SplitEditor for editing the LiveInterval analyzed by SA.
310 /// Newly created intervals will be appended to newIntervals.
311 SplitEditor(SplitAnalysis &SA, LiveIntervals&, VirtRegMap&,
312 MachineDominatorTree&, LiveRangeEdit&);
314 /// getAnalysis - Get the corresponding analysis.
315 SplitAnalysis &getAnalysis() { return sa_; }
317 /// Create a new virtual register and live interval.
320 /// enterIntvBefore - Enter the open interval before the instruction at Idx.
321 /// If the parent interval is not live before Idx, a COPY is not inserted.
322 /// Return the beginning of the new live range.
323 SlotIndex enterIntvBefore(SlotIndex Idx);
325 /// enterIntvAtEnd - Enter the open interval at the end of MBB.
326 /// Use the open interval from he inserted copy to the MBB end.
327 /// Return the beginning of the new live range.
328 SlotIndex enterIntvAtEnd(MachineBasicBlock &MBB);
330 /// useIntv - indicate that all instructions in MBB should use OpenLI.
331 void useIntv(const MachineBasicBlock &MBB);
333 /// useIntv - indicate that all instructions in range should use OpenLI.
334 void useIntv(SlotIndex Start, SlotIndex End);
336 /// leaveIntvAfter - Leave the open interval after the instruction at Idx.
337 /// Return the end of the live range.
338 SlotIndex leaveIntvAfter(SlotIndex Idx);
340 /// leaveIntvBefore - Leave the open interval before the instruction at Idx.
341 /// Return the end of the live range.
342 SlotIndex leaveIntvBefore(SlotIndex Idx);
344 /// leaveIntvAtTop - Leave the interval at the top of MBB.
345 /// Add liveness from the MBB top to the copy.
346 /// Return the end of the live range.
347 SlotIndex leaveIntvAtTop(MachineBasicBlock &MBB);
349 /// overlapIntv - Indicate that all instructions in range should use the open
350 /// interval, but also let the complement interval be live.
352 /// This doubles the register pressure, but is sometimes required to deal with
353 /// register uses after the last valid split point.
355 /// The Start index should be a return value from a leaveIntv* call, and End
356 /// should be in the same basic block. The parent interval must have the same
357 /// value across the range.
359 void overlapIntv(SlotIndex Start, SlotIndex End);
361 /// closeIntv - Indicate that we are done editing the currently open
362 /// LiveInterval, and ranges can be trimmed.
365 /// finish - after all the new live ranges have been created, compute the
366 /// remaining live range, and rewrite instructions to use the new registers.
369 /// dump - print the current interval maping to dbgs().
372 // ===--- High level methods ---===
374 /// splitSingleBlocks - Split CurLI into a separate live interval inside each
375 /// basic block in Blocks.
376 void splitSingleBlocks(const SplitAnalysis::BlockPtrSet &Blocks);
378 /// splitInsideBlock - Split CurLI into multiple intervals inside MBB.
379 void splitInsideBlock(const MachineBasicBlock *);