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 VirtRegMap &VRM;
47 const LiveIntervals &LIS;
48 const MachineLoopInfo &Loops;
49 const TargetInstrInfo &TII;
51 // Instructions using the the current register.
52 typedef SmallPtrSet<const MachineInstr*, 16> InstrPtrSet;
53 InstrPtrSet UsingInstrs;
55 // Sorted slot indexes of using instructions.
56 SmallVector<SlotIndex, 8> UseSlots;
58 // The number of instructions using CurLI in each basic block.
59 typedef DenseMap<const MachineBasicBlock*, unsigned> BlockCountMap;
60 BlockCountMap UsingBlocks;
62 /// Additional information about basic blocks where the current variable is
63 /// live. Such a block will look like one of these templates:
65 /// 1. | o---x | Internal to block. Variable is only live in this block.
66 /// 2. |---x | Live-in, kill.
67 /// 3. | o---| Def, live-out.
68 /// 4. |---x o---| Live-in, kill, def, live-out.
69 /// 5. |---o---o---| Live-through with uses or defs.
70 /// 6. |-----------| Live-through without uses. Transparent.
73 MachineBasicBlock *MBB;
74 SlotIndex FirstUse; ///< First instr using current reg.
75 SlotIndex LastUse; ///< Last instr using current reg.
76 SlotIndex Kill; ///< Interval end point inside block.
77 SlotIndex Def; ///< Interval start point inside block.
78 /// Last possible point for splitting live ranges.
79 SlotIndex LastSplitPoint;
80 bool Uses; ///< Current reg has uses or defs in block.
81 bool LiveThrough; ///< Live in whole block (Templ 5. or 6. above).
82 bool LiveIn; ///< Current reg is live in.
83 bool LiveOut; ///< Current reg is live out.
85 // Per-interference pattern scratch data.
86 bool OverlapEntry; ///< Interference overlaps entering interval.
87 bool OverlapExit; ///< Interference overlaps exiting interval.
90 /// Basic blocks where var is live. This array is parallel to
92 SmallVector<BlockInfo, 8> LiveBlocks;
95 // Current live interval.
96 const LiveInterval *CurLI;
98 // Sumarize statistics by counting instructions using CurLI.
101 /// calcLiveBlockInfo - Compute per-block information about CurLI.
102 void calcLiveBlockInfo();
104 /// canAnalyzeBranch - Return true if MBB ends in a branch that can be
106 bool canAnalyzeBranch(const MachineBasicBlock *MBB);
109 SplitAnalysis(const VirtRegMap &vrm, const LiveIntervals &lis,
110 const MachineLoopInfo &mli);
112 /// analyze - set CurLI to the specified interval, and analyze how it may be
114 void analyze(const LiveInterval *li);
116 /// clear - clear all data structures so SplitAnalysis is ready to analyze a
120 /// getParent - Return the last analyzed interval.
121 const LiveInterval &getParent() const { return *CurLI; }
123 /// hasUses - Return true if MBB has any uses of CurLI.
124 bool hasUses(const MachineBasicBlock *MBB) const {
125 return UsingBlocks.lookup(MBB);
128 /// isOriginalEndpoint - Return true if the original live range was killed or
129 /// (re-)defined at Idx. Idx should be the 'def' slot for a normal kill/def,
130 /// and 'use' for an early-clobber def.
131 /// This can be used to recognize code inserted by earlier live range
133 bool isOriginalEndpoint(SlotIndex Idx) const;
135 typedef SmallPtrSet<const MachineBasicBlock*, 16> BlockPtrSet;
137 // Print a set of blocks with use counts.
138 void print(const BlockPtrSet&, raw_ostream&) const;
140 /// getMultiUseBlocks - Add basic blocks to Blocks that may benefit from
141 /// having CurLI split to a new live interval. Return true if Blocks can be
142 /// passed to SplitEditor::splitSingleBlocks.
143 bool getMultiUseBlocks(BlockPtrSet &Blocks);
147 /// LiveIntervalMap - Map values from a large LiveInterval into a small
148 /// interval that is a subset. Insert phi-def values as needed. This class is
149 /// used by SplitEditor to create new smaller LiveIntervals.
151 /// ParentLI is the larger interval, LI is the subset interval. Every value
152 /// in LI corresponds to exactly one value in ParentLI, and the live range
153 /// of the value is contained within the live range of the ParentLI value.
154 /// Values in ParentLI may map to any number of OpenLI values, including 0.
155 class LiveIntervalMap {
157 MachineDominatorTree &MDT;
159 // The parent interval is never changed.
160 const LiveInterval &ParentLI;
162 // The child interval's values are fully contained inside ParentLI values.
165 typedef DenseMap<const VNInfo*, VNInfo*> ValueMap;
167 // Map ParentLI values to simple values in LI that are defined at the same
168 // SlotIndex, or NULL for ParentLI values that have complex LI defs.
169 // Note there is a difference between values mapping to NULL (complex), and
170 // values not present (unknown/unmapped).
173 typedef std::pair<VNInfo*, MachineDomTreeNode*> LiveOutPair;
174 typedef DenseMap<MachineBasicBlock*,LiveOutPair> LiveOutMap;
176 // LiveOutCache - Map each basic block where LI is live out to the live-out
177 // value and its defining block. One of these conditions shall be true:
179 // 1. !LiveOutCache.count(MBB)
180 // 2. LiveOutCache[MBB].second.getNode() == MBB
181 // 3. forall P in preds(MBB): LiveOutCache[P] == LiveOutCache[MBB]
183 // This is only a cache, the values can be computed as:
185 // VNI = LI->getVNInfoAt(LIS.getMBBEndIdx(MBB))
186 // Node = mbt_[LIS.getMBBFromIndex(VNI->def)]
188 // The cache is also used as a visiteed set by mapValue().
189 LiveOutMap LiveOutCache;
191 // Dump the live-out cache to dbgs().
195 LiveIntervalMap(LiveIntervals &lis,
196 MachineDominatorTree &mdt,
197 const LiveInterval &parentli)
198 : LIS(lis), MDT(mdt), ParentLI(parentli), LI(0) {}
200 /// reset - clear all data structures and start a new live interval.
201 void reset(LiveInterval *);
203 /// getLI - return the current live interval.
204 LiveInterval *getLI() const { return LI; }
206 /// defValue - define a value in LI from the ParentLI value VNI and Idx.
207 /// Idx does not have to be ParentVNI->def, but it must be contained within
208 /// ParentVNI's live range in ParentLI.
209 /// Return the new LI value.
210 VNInfo *defValue(const VNInfo *ParentVNI, SlotIndex Idx);
212 /// mapValue - map ParentVNI to the corresponding LI value at Idx. It is
213 /// assumed that ParentVNI is live at Idx.
214 /// If ParentVNI has not been defined by defValue, it is assumed that
215 /// ParentVNI->def dominates Idx.
216 /// If ParentVNI has been defined by defValue one or more times, a value that
217 /// dominates Idx will be returned. This may require creating extra phi-def
218 /// values and adding live ranges to LI.
219 /// If simple is not NULL, *simple will indicate if ParentVNI is a simply
221 VNInfo *mapValue(const VNInfo *ParentVNI, SlotIndex Idx, bool *simple = 0);
223 // extendTo - Find the last LI value defined in MBB at or before Idx. The
224 // parentli is assumed to be live at Idx. Extend the live range to include
225 // Idx. Return the found VNInfo, or NULL.
226 VNInfo *extendTo(const MachineBasicBlock *MBB, SlotIndex Idx);
228 /// isMapped - Return true is ParentVNI is a known mapped value. It may be a
229 /// simple 1-1 mapping or a complex mapping to later defs.
230 bool isMapped(const VNInfo *ParentVNI) const {
231 return Values.count(ParentVNI);
234 /// isComplexMapped - Return true if ParentVNI has received new definitions
236 bool isComplexMapped(const VNInfo *ParentVNI) const;
238 /// markComplexMapped - Mark ParentVNI as complex mapped regardless of the
239 /// number of definitions.
240 void markComplexMapped(const VNInfo *ParentVNI) { Values[ParentVNI] = 0; }
242 // addSimpleRange - Add a simple range from ParentLI to LI.
243 // ParentVNI must be live in the [Start;End) interval.
244 void addSimpleRange(SlotIndex Start, SlotIndex End, const VNInfo *ParentVNI);
246 /// addRange - Add live ranges to LI where [Start;End) intersects ParentLI.
247 /// All needed values whose def is not inside [Start;End) must be defined
248 /// beforehand so mapValue will work.
249 void addRange(SlotIndex Start, SlotIndex End);
253 /// SplitEditor - Edit machine code and LiveIntervals for live range
256 /// - Create a SplitEditor from a SplitAnalysis.
257 /// - Start a new live interval with openIntv.
258 /// - Mark the places where the new interval is entered using enterIntv*
259 /// - Mark the ranges where the new interval is used with useIntv*
260 /// - Mark the places where the interval is exited with exitIntv*.
261 /// - Finish the current interval with closeIntv and repeat from 2.
262 /// - Rewrite instructions with finish().
268 MachineRegisterInfo &MRI;
269 MachineDominatorTree &MDT;
270 const TargetInstrInfo &TII;
271 const TargetRegisterInfo &TRI;
273 /// Edit - The current parent register and new intervals created.
276 /// Index into Edit of the currently open interval.
277 /// The index 0 is used for the complement, so the first interval started by
278 /// openIntv will be 1.
281 typedef IntervalMap<SlotIndex, unsigned> RegAssignMap;
283 /// Allocator for the interval map. This will eventually be shared with
284 /// SlotIndexes and LiveIntervals.
285 RegAssignMap::Allocator Allocator;
287 /// RegAssign - Map of the assigned register indexes.
288 /// Edit.get(RegAssign.lookup(Idx)) is the register that should be live at
290 RegAssignMap RegAssign;
292 /// LIMappers - One LiveIntervalMap or each interval in Edit.
293 SmallVector<LiveIntervalMap, 4> LIMappers;
295 /// defFromParent - Define Reg from ParentVNI at UseIdx using either
296 /// rematerialization or a COPY from parent. Return the new value.
297 VNInfo *defFromParent(unsigned RegIdx,
300 MachineBasicBlock &MBB,
301 MachineBasicBlock::iterator I);
303 /// rewriteAssigned - Rewrite all uses of Edit.getReg() to assigned registers.
304 void rewriteAssigned();
306 /// rewriteComponents - Rewrite all uses of Intv[0] according to the eq
307 /// classes in ConEQ.
308 /// This must be done when Intvs[0] is styill live at all uses, before calling
309 /// ConEq.Distribute().
310 void rewriteComponents(const SmallVectorImpl<LiveInterval*> &Intvs,
311 const ConnectedVNInfoEqClasses &ConEq);
314 /// Create a new SplitEditor for editing the LiveInterval analyzed by SA.
315 /// Newly created intervals will be appended to newIntervals.
316 SplitEditor(SplitAnalysis &SA, LiveIntervals&, VirtRegMap&,
317 MachineDominatorTree&, LiveRangeEdit&);
319 /// getAnalysis - Get the corresponding analysis.
320 SplitAnalysis &getAnalysis() { return SA; }
322 /// Create a new virtual register and live interval.
325 /// enterIntvBefore - Enter the open interval before the instruction at Idx.
326 /// If the parent interval is not live before Idx, a COPY is not inserted.
327 /// Return the beginning of the new live range.
328 SlotIndex enterIntvBefore(SlotIndex Idx);
330 /// enterIntvAtEnd - Enter the open interval at the end of MBB.
331 /// Use the open interval from he inserted copy to the MBB end.
332 /// Return the beginning of the new live range.
333 SlotIndex enterIntvAtEnd(MachineBasicBlock &MBB);
335 /// useIntv - indicate that all instructions in MBB should use OpenLI.
336 void useIntv(const MachineBasicBlock &MBB);
338 /// useIntv - indicate that all instructions in range should use OpenLI.
339 void useIntv(SlotIndex Start, SlotIndex End);
341 /// leaveIntvAfter - Leave the open interval after the instruction at Idx.
342 /// Return the end of the live range.
343 SlotIndex leaveIntvAfter(SlotIndex Idx);
345 /// leaveIntvBefore - Leave the open interval before the instruction at Idx.
346 /// Return the end of the live range.
347 SlotIndex leaveIntvBefore(SlotIndex Idx);
349 /// leaveIntvAtTop - Leave the interval at the top of MBB.
350 /// Add liveness from the MBB top to the copy.
351 /// Return the end of the live range.
352 SlotIndex leaveIntvAtTop(MachineBasicBlock &MBB);
354 /// overlapIntv - Indicate that all instructions in range should use the open
355 /// interval, but also let the complement interval be live.
357 /// This doubles the register pressure, but is sometimes required to deal with
358 /// register uses after the last valid split point.
360 /// The Start index should be a return value from a leaveIntv* call, and End
361 /// should be in the same basic block. The parent interval must have the same
362 /// value across the range.
364 void overlapIntv(SlotIndex Start, SlotIndex End);
366 /// closeIntv - Indicate that we are done editing the currently open
367 /// LiveInterval, and ranges can be trimmed.
370 /// finish - after all the new live ranges have been created, compute the
371 /// remaining live range, and rewrite instructions to use the new registers.
374 /// dump - print the current interval maping to dbgs().
377 // ===--- High level methods ---===
379 /// splitSingleBlocks - Split CurLI into a separate live interval inside each
380 /// basic block in Blocks.
381 void splitSingleBlocks(const SplitAnalysis::BlockPtrSet &Blocks);