1 //===- SplitKit.h - Toolkit for splitting live ranges -----------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file contains the SplitAnalysis class as well as mutator functions for
10 // live range splitting.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_LIB_CODEGEN_SPLITKIT_H
15 #define LLVM_LIB_CODEGEN_SPLITKIT_H
16 
17 #include "llvm/ADT/ArrayRef.h"
18 #include "llvm/ADT/BitVector.h"
19 #include "llvm/ADT/DenseMap.h"
20 #include "llvm/ADT/DenseSet.h"
21 #include "llvm/ADT/IntervalMap.h"
22 #include "llvm/ADT/PointerIntPair.h"
23 #include "llvm/ADT/SmallPtrSet.h"
24 #include "llvm/ADT/SmallVector.h"
25 #include "llvm/CodeGen/LiveInterval.h"
26 #include "llvm/CodeGen/LiveIntervalCalc.h"
27 #include "llvm/CodeGen/LiveIntervals.h"
28 #include "llvm/CodeGen/MachineBasicBlock.h"
29 #include "llvm/CodeGen/MachineFunction.h"
30 #include "llvm/CodeGen/SlotIndexes.h"
31 #include "llvm/MC/LaneBitmask.h"
32 #include "llvm/Support/Compiler.h"
33 #include <utility>
34 
35 namespace llvm {
36 
37 class AAResults;
38 class LiveIntervals;
39 class LiveRangeEdit;
40 class MachineBlockFrequencyInfo;
41 class MachineDominatorTree;
42 class MachineLoopInfo;
43 class MachineRegisterInfo;
44 class TargetInstrInfo;
45 class TargetRegisterInfo;
46 class VirtRegMap;
47 
48 /// Determines the latest safe point in a block in which we can insert a split,
49 /// spill or other instruction related with CurLI.
50 class LLVM_LIBRARY_VISIBILITY InsertPointAnalysis {
51 private:
52   const LiveIntervals &LIS;
53 
54   /// Last legal insert point in each basic block in the current function.
55   /// The first entry is the first terminator, the second entry is the
56   /// last valid point to insert a split or spill for a variable that is
57   /// live into a landing pad or inlineasm_br successor.
58   SmallVector<std::pair<SlotIndex, SlotIndex>, 8> LastInsertPoint;
59 
60   SlotIndex computeLastInsertPoint(const LiveInterval &CurLI,
61                                    const MachineBasicBlock &MBB);
62 
63 public:
64   InsertPointAnalysis(const LiveIntervals &lis, unsigned BBNum);
65 
66   /// Return the base index of the last valid insert point for \pCurLI in \pMBB.
67   SlotIndex getLastInsertPoint(const LiveInterval &CurLI,
68                                const MachineBasicBlock &MBB) {
69     unsigned Num = MBB.getNumber();
70     // Inline the common simple case.
71     if (LastInsertPoint[Num].first.isValid() &&
72         !LastInsertPoint[Num].second.isValid())
73       return LastInsertPoint[Num].first;
74     return computeLastInsertPoint(CurLI, MBB);
75   }
76 
77   /// Returns the last insert point as an iterator for \pCurLI in \pMBB.
78   MachineBasicBlock::iterator getLastInsertPointIter(const LiveInterval &CurLI,
79                                                      MachineBasicBlock &MBB);
80 
81   /// Return the base index of the first insert point in \pMBB.
82   SlotIndex getFirstInsertPoint(MachineBasicBlock &MBB) {
83     SlotIndex Res = LIS.getMBBStartIdx(&MBB);
84     if (!MBB.empty()) {
85       MachineBasicBlock::iterator MII = MBB.SkipPHIsLabelsAndDebug(MBB.begin());
86       if (MII != MBB.end())
87         Res = LIS.getInstructionIndex(*MII);
88     }
89     return Res;
90   }
91 
92 };
93 
94 /// SplitAnalysis - Analyze a LiveInterval, looking for live range splitting
95 /// opportunities.
96 class LLVM_LIBRARY_VISIBILITY SplitAnalysis {
97 public:
98   const MachineFunction &MF;
99   const VirtRegMap &VRM;
100   const LiveIntervals &LIS;
101   const MachineLoopInfo &Loops;
102   const TargetInstrInfo &TII;
103 
104   /// Additional information about basic blocks where the current variable is
105   /// live. Such a block will look like one of these templates:
106   ///
107   ///  1. |   o---x   | Internal to block. Variable is only live in this block.
108   ///  2. |---x       | Live-in, kill.
109   ///  3. |       o---| Def, live-out.
110   ///  4. |---x   o---| Live-in, kill, def, live-out. Counted by NumGapBlocks.
111   ///  5. |---o---o---| Live-through with uses or defs.
112   ///  6. |-----------| Live-through without uses. Counted by NumThroughBlocks.
113   ///
114   /// Two BlockInfo entries are created for template 4. One for the live-in
115   /// segment, and one for the live-out segment. These entries look as if the
116   /// block were split in the middle where the live range isn't live.
117   ///
118   /// Live-through blocks without any uses don't get BlockInfo entries. They
119   /// are simply listed in ThroughBlocks instead.
120   ///
121   struct BlockInfo {
122     MachineBasicBlock *MBB;
123     SlotIndex FirstInstr; ///< First instr accessing current reg.
124     SlotIndex LastInstr;  ///< Last instr accessing current reg.
125     SlotIndex FirstDef;   ///< First non-phi valno->def, or SlotIndex().
126     bool LiveIn;          ///< Current reg is live in.
127     bool LiveOut;         ///< Current reg is live out.
128 
129     /// isOneInstr - Returns true when this BlockInfo describes a single
130     /// instruction.
131     bool isOneInstr() const {
132       return SlotIndex::isSameInstr(FirstInstr, LastInstr);
133     }
134 
135     void print(raw_ostream &OS) const;
136     void dump() const;
137   };
138 
139 private:
140   // Current live interval.
141   const LiveInterval *CurLI = nullptr;
142 
143   /// Insert Point Analysis.
144   InsertPointAnalysis IPA;
145 
146   // Sorted slot indexes of using instructions.
147   SmallVector<SlotIndex, 8> UseSlots;
148 
149   /// UseBlocks - Blocks where CurLI has uses.
150   SmallVector<BlockInfo, 8> UseBlocks;
151 
152   /// NumGapBlocks - Number of duplicate entries in UseBlocks for blocks where
153   /// the live range has a gap.
154   unsigned NumGapBlocks;
155 
156   /// ThroughBlocks - Block numbers where CurLI is live through without uses.
157   BitVector ThroughBlocks;
158 
159   /// NumThroughBlocks - Number of live-through blocks.
160   unsigned NumThroughBlocks;
161 
162   /// DidRepairRange - analyze was forced to shrinkToUses().
163   bool DidRepairRange;
164 
165   // Sumarize statistics by counting instructions using CurLI.
166   void analyzeUses();
167 
168   /// calcLiveBlockInfo - Compute per-block information about CurLI.
169   bool calcLiveBlockInfo();
170 
171 public:
172   SplitAnalysis(const VirtRegMap &vrm, const LiveIntervals &lis,
173                 const MachineLoopInfo &mli);
174 
175   /// analyze - set CurLI to the specified interval, and analyze how it may be
176   /// split.
177   void analyze(const LiveInterval *li);
178 
179   /// didRepairRange() - Returns true if CurLI was invalid and has been repaired
180   /// by analyze(). This really shouldn't happen, but sometimes the coalescer
181   /// can create live ranges that end in mid-air.
182   bool didRepairRange() const { return DidRepairRange; }
183 
184   /// clear - clear all data structures so SplitAnalysis is ready to analyze a
185   /// new interval.
186   void clear();
187 
188   /// getParent - Return the last analyzed interval.
189   const LiveInterval &getParent() const { return *CurLI; }
190 
191   /// isOriginalEndpoint - Return true if the original live range was killed or
192   /// (re-)defined at Idx. Idx should be the 'def' slot for a normal kill/def,
193   /// and 'use' for an early-clobber def.
194   /// This can be used to recognize code inserted by earlier live range
195   /// splitting.
196   bool isOriginalEndpoint(SlotIndex Idx) const;
197 
198   /// getUseSlots - Return an array of SlotIndexes of instructions using CurLI.
199   /// This include both use and def operands, at most one entry per instruction.
200   ArrayRef<SlotIndex> getUseSlots() const { return UseSlots; }
201 
202   /// getUseBlocks - Return an array of BlockInfo objects for the basic blocks
203   /// where CurLI has uses.
204   ArrayRef<BlockInfo> getUseBlocks() const { return UseBlocks; }
205 
206   /// getNumThroughBlocks - Return the number of through blocks.
207   unsigned getNumThroughBlocks() const { return NumThroughBlocks; }
208 
209   /// isThroughBlock - Return true if CurLI is live through MBB without uses.
210   bool isThroughBlock(unsigned MBB) const { return ThroughBlocks.test(MBB); }
211 
212   /// getThroughBlocks - Return the set of through blocks.
213   const BitVector &getThroughBlocks() const { return ThroughBlocks; }
214 
215   /// getNumLiveBlocks - Return the number of blocks where CurLI is live.
216   unsigned getNumLiveBlocks() const {
217     return getUseBlocks().size() - NumGapBlocks + getNumThroughBlocks();
218   }
219 
220   /// countLiveBlocks - Return the number of blocks where li is live. This is
221   /// guaranteed to return the same number as getNumLiveBlocks() after calling
222   /// analyze(li).
223   unsigned countLiveBlocks(const LiveInterval *li) const;
224 
225   using BlockPtrSet = SmallPtrSet<const MachineBasicBlock *, 16>;
226 
227   /// shouldSplitSingleBlock - Returns true if it would help to create a local
228   /// live range for the instructions in BI. There is normally no benefit to
229   /// creating a live range for a single instruction, but it does enable
230   /// register class inflation if the instruction has a restricted register
231   /// class.
232   ///
233   /// @param BI           The block to be isolated.
234   /// @param SingleInstrs True when single instructions should be isolated.
235   bool shouldSplitSingleBlock(const BlockInfo &BI, bool SingleInstrs) const;
236 
237   SlotIndex getLastSplitPoint(unsigned Num) {
238     return IPA.getLastInsertPoint(*CurLI, *MF.getBlockNumbered(Num));
239   }
240 
241   MachineBasicBlock::iterator getLastSplitPointIter(MachineBasicBlock *BB) {
242     return IPA.getLastInsertPointIter(*CurLI, *BB);
243   }
244 
245   SlotIndex getFirstSplitPoint(unsigned Num) {
246     return IPA.getFirstInsertPoint(*MF.getBlockNumbered(Num));
247   }
248 };
249 
250 /// SplitEditor - Edit machine code and LiveIntervals for live range
251 /// splitting.
252 ///
253 /// - Create a SplitEditor from a SplitAnalysis.
254 /// - Start a new live interval with openIntv.
255 /// - Mark the places where the new interval is entered using enterIntv*
256 /// - Mark the ranges where the new interval is used with useIntv*
257 /// - Mark the places where the interval is exited with exitIntv*.
258 /// - Finish the current interval with closeIntv and repeat from 2.
259 /// - Rewrite instructions with finish().
260 ///
261 class LLVM_LIBRARY_VISIBILITY SplitEditor {
262   SplitAnalysis &SA;
263   AAResults &AA;
264   LiveIntervals &LIS;
265   VirtRegMap &VRM;
266   MachineRegisterInfo &MRI;
267   MachineDominatorTree &MDT;
268   const TargetInstrInfo &TII;
269   const TargetRegisterInfo &TRI;
270   const MachineBlockFrequencyInfo &MBFI;
271 
272 public:
273   /// ComplementSpillMode - Select how the complement live range should be
274   /// created.  SplitEditor automatically creates interval 0 to contain
275   /// anything that isn't added to another interval.  This complement interval
276   /// can get quite complicated, and it can sometimes be an advantage to allow
277   /// it to overlap the other intervals.  If it is going to spill anyway, no
278   /// registers are wasted by keeping a value in two places at the same time.
279   enum ComplementSpillMode {
280     /// SM_Partition(Default) - Try to create the complement interval so it
281     /// doesn't overlap any other intervals, and the original interval is
282     /// partitioned.  This may require a large number of back copies and extra
283     /// PHI-defs.  Only segments marked with overlapIntv will be overlapping.
284     SM_Partition,
285 
286     /// SM_Size - Overlap intervals to minimize the number of inserted COPY
287     /// instructions.  Copies to the complement interval are hoisted to their
288     /// common dominator, so only one COPY is required per value in the
289     /// complement interval.  This also means that no extra PHI-defs need to be
290     /// inserted in the complement interval.
291     SM_Size,
292 
293     /// SM_Speed - Overlap intervals to minimize the expected execution
294     /// frequency of the inserted copies.  This is very similar to SM_Size, but
295     /// the complement interval may get some extra PHI-defs.
296     SM_Speed
297   };
298 
299 private:
300   /// Edit - The current parent register and new intervals created.
301   LiveRangeEdit *Edit = nullptr;
302 
303   /// Index into Edit of the currently open interval.
304   /// The index 0 is used for the complement, so the first interval started by
305   /// openIntv will be 1.
306   unsigned OpenIdx = 0;
307 
308   /// The current spill mode, selected by reset().
309   ComplementSpillMode SpillMode = SM_Partition;
310 
311   using RegAssignMap = IntervalMap<SlotIndex, unsigned>;
312 
313   /// Allocator for the interval map. This will eventually be shared with
314   /// SlotIndexes and LiveIntervals.
315   RegAssignMap::Allocator Allocator;
316 
317   /// RegAssign - Map of the assigned register indexes.
318   /// Edit.get(RegAssign.lookup(Idx)) is the register that should be live at
319   /// Idx.
320   RegAssignMap RegAssign;
321 
322   using ValueForcePair = PointerIntPair<VNInfo *, 1>;
323   using ValueMap = DenseMap<std::pair<unsigned, unsigned>, ValueForcePair>;
324 
325   /// Values - keep track of the mapping from parent values to values in the new
326   /// intervals. Given a pair (RegIdx, ParentVNI->id), Values contains:
327   ///
328   /// 1. No entry - the value is not mapped to Edit.get(RegIdx).
329   /// 2. (Null, false) - the value is mapped to multiple values in
330   ///    Edit.get(RegIdx).  Each value is represented by a minimal live range at
331   ///    its def.  The full live range can be inferred exactly from the range
332   ///    of RegIdx in RegAssign.
333   /// 3. (Null, true).  As above, but the ranges in RegAssign are too large, and
334   ///    the live range must be recomputed using ::extend().
335   /// 4. (VNI, false) The value is mapped to a single new value.
336   ///    The new value has no live ranges anywhere.
337   ValueMap Values;
338 
339   /// LICalc - Cache for computing live ranges and SSA update.  Each instance
340   /// can only handle non-overlapping live ranges, so use a separate
341   /// LiveIntervalCalc instance for the complement interval when in spill mode.
342   LiveIntervalCalc LICalc[2];
343 
344   /// getLICalc - Return the LICalc to use for RegIdx.  In spill mode, the
345   /// complement interval can overlap the other intervals, so it gets its own
346   /// LICalc instance.  When not in spill mode, all intervals can share one.
347   LiveIntervalCalc &getLICalc(unsigned RegIdx) {
348     return LICalc[SpillMode != SM_Partition && RegIdx != 0];
349   }
350 
351   /// Find a subrange corresponding to the exact lane mask @p LM in the live
352   /// interval @p LI. The interval @p LI is assumed to contain such a subrange.
353   /// This function is used to find corresponding subranges between the
354   /// original interval and the new intervals.
355   LiveInterval::SubRange &getSubRangeForMaskExact(LaneBitmask LM,
356                                                   LiveInterval &LI);
357 
358   /// Find a subrange corresponding to the lane mask @p LM, or a superset of it,
359   /// in the live interval @p LI. The interval @p LI is assumed to contain such
360   /// a subrange.  This function is used to find corresponding subranges between
361   /// the original interval and the new intervals.
362   LiveInterval::SubRange &getSubRangeForMask(LaneBitmask LM, LiveInterval &LI);
363 
364   /// Add a segment to the interval LI for the value number VNI. If LI has
365   /// subranges, corresponding segments will be added to them as well, but
366   /// with newly created value numbers. If Original is true, dead def will
367   /// only be added a subrange of LI if the corresponding subrange of the
368   /// original interval has a def at this index. Otherwise, all subranges
369   /// of LI will be updated.
370   void addDeadDef(LiveInterval &LI, VNInfo *VNI, bool Original);
371 
372   /// defValue - define a value in RegIdx from ParentVNI at Idx.
373   /// Idx does not have to be ParentVNI->def, but it must be contained within
374   /// ParentVNI's live range in ParentLI. The new value is added to the value
375   /// map. The value being defined may either come from rematerialization
376   /// (or an inserted copy), or it may be coming from the original interval.
377   /// The parameter Original should be true in the latter case, otherwise
378   /// it should be false.
379   /// Return the new LI value.
380   VNInfo *defValue(unsigned RegIdx, const VNInfo *ParentVNI, SlotIndex Idx,
381                    bool Original);
382 
383   /// forceRecompute - Force the live range of ParentVNI in RegIdx to be
384   /// recomputed by LiveRangeCalc::extend regardless of the number of defs.
385   /// This is used for values whose live range doesn't match RegAssign exactly.
386   /// They could have rematerialized, or back-copies may have been moved.
387   void forceRecompute(unsigned RegIdx, const VNInfo &ParentVNI);
388 
389   /// Calls forceRecompute() on any affected regidx and on ParentVNI
390   /// predecessors in case of a phi definition.
391   void forceRecomputeVNI(const VNInfo &ParentVNI);
392 
393   /// defFromParent - Define Reg from ParentVNI at UseIdx using either
394   /// rematerialization or a COPY from parent. Return the new value.
395   VNInfo *defFromParent(unsigned RegIdx,
396                         VNInfo *ParentVNI,
397                         SlotIndex UseIdx,
398                         MachineBasicBlock &MBB,
399                         MachineBasicBlock::iterator I);
400 
401   /// removeBackCopies - Remove the copy instructions that defines the values
402   /// in the vector in the complement interval.
403   void removeBackCopies(SmallVectorImpl<VNInfo*> &Copies);
404 
405   /// getShallowDominator - Returns the least busy dominator of MBB that is
406   /// also dominated by DefMBB.  Busy is measured by loop depth.
407   MachineBasicBlock *findShallowDominator(MachineBasicBlock *MBB,
408                                           MachineBasicBlock *DefMBB);
409 
410   /// Find out all the backCopies dominated by others.
411   void computeRedundantBackCopies(DenseSet<unsigned> &NotToHoistSet,
412                                   SmallVectorImpl<VNInfo *> &BackCopies);
413 
414   /// Hoist back-copies to the complement interval. It tries to hoist all
415   /// the back-copies to one BB if it is beneficial, or else simply remove
416   /// redundant backcopies dominated by others.
417   void hoistCopies();
418 
419   /// transferValues - Transfer values to the new ranges.
420   /// Return true if any ranges were skipped.
421   bool transferValues();
422 
423   /// Live range @p LR corresponding to the lane Mask @p LM has a live
424   /// PHI def at the beginning of block @p B. Extend the range @p LR of
425   /// all predecessor values that reach this def. If @p LR is a subrange,
426   /// the array @p Undefs is the set of all locations where it is undefined
427   /// via <def,read-undef> in other subranges for the same register.
428   void extendPHIRange(MachineBasicBlock &B, LiveIntervalCalc &LIC,
429                       LiveRange &LR, LaneBitmask LM,
430                       ArrayRef<SlotIndex> Undefs);
431 
432   /// extendPHIKillRanges - Extend the ranges of all values killed by original
433   /// parent PHIDefs.
434   void extendPHIKillRanges();
435 
436   /// rewriteAssigned - Rewrite all uses of Edit.getReg() to assigned registers.
437   void rewriteAssigned(bool ExtendRanges);
438 
439   /// deleteRematVictims - Delete defs that are dead after rematerializing.
440   void deleteRematVictims();
441 
442   /// Add a copy instruction copying \p FromReg to \p ToReg before
443   /// \p InsertBefore. This can be invoked with a \p LaneMask which may make it
444   /// necessary to construct a sequence of copies to cover it exactly.
445   SlotIndex buildCopy(Register FromReg, Register ToReg, LaneBitmask LaneMask,
446       MachineBasicBlock &MBB, MachineBasicBlock::iterator InsertBefore,
447       bool Late, unsigned RegIdx);
448 
449   SlotIndex buildSingleSubRegCopy(Register FromReg, Register ToReg,
450       MachineBasicBlock &MB, MachineBasicBlock::iterator InsertBefore,
451       unsigned SubIdx, LiveInterval &DestLI, bool Late, SlotIndex Def);
452 
453 public:
454   /// Create a new SplitEditor for editing the LiveInterval analyzed by SA.
455   /// Newly created intervals will be appended to newIntervals.
456   SplitEditor(SplitAnalysis &sa, AAResults &aa, LiveIntervals &lis,
457               VirtRegMap &vrm, MachineDominatorTree &mdt,
458               MachineBlockFrequencyInfo &mbfi);
459 
460   /// reset - Prepare for a new split.
461   void reset(LiveRangeEdit&, ComplementSpillMode = SM_Partition);
462 
463   /// Create a new virtual register and live interval.
464   /// Return the interval index, starting from 1. Interval index 0 is the
465   /// implicit complement interval.
466   unsigned openIntv();
467 
468   /// currentIntv - Return the current interval index.
469   unsigned currentIntv() const { return OpenIdx; }
470 
471   /// selectIntv - Select a previously opened interval index.
472   void selectIntv(unsigned Idx);
473 
474   /// enterIntvBefore - Enter the open interval before the instruction at Idx.
475   /// If the parent interval is not live before Idx, a COPY is not inserted.
476   /// Return the beginning of the new live range.
477   SlotIndex enterIntvBefore(SlotIndex Idx);
478 
479   /// enterIntvAfter - Enter the open interval after the instruction at Idx.
480   /// Return the beginning of the new live range.
481   SlotIndex enterIntvAfter(SlotIndex Idx);
482 
483   /// enterIntvAtEnd - Enter the open interval at the end of MBB.
484   /// Use the open interval from the inserted copy to the MBB end.
485   /// Return the beginning of the new live range.
486   SlotIndex enterIntvAtEnd(MachineBasicBlock &MBB);
487 
488   /// useIntv - indicate that all instructions in MBB should use OpenLI.
489   void useIntv(const MachineBasicBlock &MBB);
490 
491   /// useIntv - indicate that all instructions in range should use OpenLI.
492   void useIntv(SlotIndex Start, SlotIndex End);
493 
494   /// leaveIntvAfter - Leave the open interval after the instruction at Idx.
495   /// Return the end of the live range.
496   SlotIndex leaveIntvAfter(SlotIndex Idx);
497 
498   /// leaveIntvBefore - Leave the open interval before the instruction at Idx.
499   /// Return the end of the live range.
500   SlotIndex leaveIntvBefore(SlotIndex Idx);
501 
502   /// leaveIntvAtTop - Leave the interval at the top of MBB.
503   /// Add liveness from the MBB top to the copy.
504   /// Return the end of the live range.
505   SlotIndex leaveIntvAtTop(MachineBasicBlock &MBB);
506 
507   /// overlapIntv - Indicate that all instructions in range should use the open
508   /// interval, but also let the complement interval be live.
509   ///
510   /// This doubles the register pressure, but is sometimes required to deal with
511   /// register uses after the last valid split point.
512   ///
513   /// The Start index should be a return value from a leaveIntv* call, and End
514   /// should be in the same basic block. The parent interval must have the same
515   /// value across the range.
516   ///
517   void overlapIntv(SlotIndex Start, SlotIndex End);
518 
519   /// finish - after all the new live ranges have been created, compute the
520   /// remaining live range, and rewrite instructions to use the new registers.
521   /// @param LRMap When not null, this vector will map each live range in Edit
522   ///              back to the indices returned by openIntv.
523   ///              There may be extra indices created by dead code elimination.
524   void finish(SmallVectorImpl<unsigned> *LRMap = nullptr);
525 
526   /// dump - print the current interval mapping to dbgs().
527   void dump() const;
528 
529   // ===--- High level methods ---===
530 
531   /// splitSingleBlock - Split CurLI into a separate live interval around the
532   /// uses in a single block. This is intended to be used as part of a larger
533   /// split, and doesn't call finish().
534   void splitSingleBlock(const SplitAnalysis::BlockInfo &BI);
535 
536   /// splitLiveThroughBlock - Split CurLI in the given block such that it
537   /// enters the block in IntvIn and leaves it in IntvOut. There may be uses in
538   /// the block, but they will be ignored when placing split points.
539   ///
540   /// @param MBBNum      Block number.
541   /// @param IntvIn      Interval index entering the block.
542   /// @param LeaveBefore When set, leave IntvIn before this point.
543   /// @param IntvOut     Interval index leaving the block.
544   /// @param EnterAfter  When set, enter IntvOut after this point.
545   void splitLiveThroughBlock(unsigned MBBNum,
546                              unsigned IntvIn, SlotIndex LeaveBefore,
547                              unsigned IntvOut, SlotIndex EnterAfter);
548 
549   /// splitRegInBlock - Split CurLI in the given block such that it enters the
550   /// block in IntvIn and leaves it on the stack (or not at all). Split points
551   /// are placed in a way that avoids putting uses in the stack interval. This
552   /// may require creating a local interval when there is interference.
553   ///
554   /// @param BI          Block descriptor.
555   /// @param IntvIn      Interval index entering the block. Not 0.
556   /// @param LeaveBefore When set, leave IntvIn before this point.
557   void splitRegInBlock(const SplitAnalysis::BlockInfo &BI,
558                        unsigned IntvIn, SlotIndex LeaveBefore);
559 
560   /// splitRegOutBlock - Split CurLI in the given block such that it enters the
561   /// block on the stack (or isn't live-in at all) and leaves it in IntvOut.
562   /// Split points are placed to avoid interference and such that the uses are
563   /// not in the stack interval. This may require creating a local interval
564   /// when there is interference.
565   ///
566   /// @param BI          Block descriptor.
567   /// @param IntvOut     Interval index leaving the block.
568   /// @param EnterAfter  When set, enter IntvOut after this point.
569   void splitRegOutBlock(const SplitAnalysis::BlockInfo &BI,
570                         unsigned IntvOut, SlotIndex EnterAfter);
571 };
572 
573 } // end namespace llvm
574 
575 #endif // LLVM_LIB_CODEGEN_SPLITKIT_H
576