lib/CodeGen/SplitKit.h

   1 //===-------- SplitKit.h - Toolkit for splitting live ranges ----*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains the SplitAnalysis class as well as mutator functions for
  11 // live range splitting.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/ADT/DenseMap.h"
  16 #include "llvm/ADT/IntervalMap.h"
  17 #include "llvm/ADT/SmallPtrSet.h"
  18 #include "llvm/CodeGen/SlotIndexes.h"
  19
  20 namespace llvm {
  21
  22 class ConnectedVNInfoEqClasses;
  23 class LiveInterval;
  24 class LiveIntervals;
  25 class LiveRangeEdit;
  26 class MachineInstr;
  27 class MachineLoopInfo;
  28 class MachineRegisterInfo;
  29 class TargetInstrInfo;
  30 class TargetRegisterInfo;
  31 class VirtRegMap;
  32 class VNInfo;
  33 class raw_ostream;
  34
  35 /// At some point we should just include MachineDominators.h:
  36 class MachineDominatorTree;
  37 template <class NodeT> class DomTreeNodeBase;
  38 typedef DomTreeNodeBase<MachineBasicBlock> MachineDomTreeNode;
  39
  40
  41 /// SplitAnalysis - Analyze a LiveInterval, looking for live range splitting
  42 /// opportunities.
  43 class SplitAnalysis {
  44 public:
  45   const MachineFunction &MF;
  46   const VirtRegMap &VRM;
  47   const LiveIntervals &LIS;
  48   const MachineLoopInfo &Loops;
  49   const TargetInstrInfo &TII;
  50
  51   // Instructions using the the current register.
  52   typedef SmallPtrSet<const MachineInstr*, 16> InstrPtrSet;
  53   InstrPtrSet UsingInstrs;
  54
  55   // Sorted slot indexes of using instructions.
  56   SmallVector<SlotIndex, 8> UseSlots;
  57
  58   // The number of instructions using CurLI in each basic block.
  59   typedef DenseMap<const MachineBasicBlock*, unsigned> BlockCountMap;
  60   BlockCountMap UsingBlocks;
  61
  62   /// Additional information about basic blocks where the current variable is
  63   /// live. Such a block will look like one of these templates:
  64   ///
  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.
  71   ///
  72   struct BlockInfo {
  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.
  84
  85     // Per-interference pattern scratch data.
  86     bool OverlapEntry;    ///< Interference overlaps entering interval.
  87     bool OverlapExit;     ///< Interference overlaps exiting interval.
  88   };
  89
  90   /// Basic blocks where var is live. This array is parallel to
  91   /// SpillConstraints.
  92   SmallVector<BlockInfo, 8> LiveBlocks;
  93
  94 private:
  95   // Current live interval.
  96   const LiveInterval *CurLI;
  97
  98   // Sumarize statistics by counting instructions using CurLI.
  99   void analyzeUses();
 100
 101   /// calcLiveBlockInfo - Compute per-block information about CurLI.
 102   void calcLiveBlockInfo();
 103
 104   /// canAnalyzeBranch - Return true if MBB ends in a branch that can be
 105   /// analyzed.
 106   bool canAnalyzeBranch(const MachineBasicBlock *MBB);
 107
 108 public:
 109   SplitAnalysis(const VirtRegMap &vrm, const LiveIntervals &lis,
 110                 const MachineLoopInfo &mli);
 111
 112   /// analyze - set CurLI to the specified interval, and analyze how it may be
 113   /// split.
 114   void analyze(const LiveInterval *li);
 115
 116   /// clear - clear all data structures so SplitAnalysis is ready to analyze a
 117   /// new interval.
 118   void clear();
 119
 120   /// getParent - Return the last analyzed interval.
 121   const LiveInterval &getParent() const { return *CurLI; }
 122
 123   /// hasUses - Return true if MBB has any uses of CurLI.
 124   bool hasUses(const MachineBasicBlock *MBB) const {
 125     return UsingBlocks.lookup(MBB);
 126   }
 127
 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
 132   /// splitting.
 133   bool isOriginalEndpoint(SlotIndex Idx) const;
 134
 135   typedef SmallPtrSet<const MachineBasicBlock*, 16> BlockPtrSet;
 136
 137   // Print a set of blocks with use counts.
 138   void print(const BlockPtrSet&, raw_ostream&) const;
 139
 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);
 144 };
 145
 146
 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.
 150 ///
 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 {
 156   LiveIntervals &LIS;
 157   MachineDominatorTree &MDT;
 158
 159   // The parent interval is never changed.
 160   const LiveInterval &ParentLI;
 161
 162   // The child interval's values are fully contained inside ParentLI values.
 163   LiveInterval *LI;
 164
 165   typedef std::pair<VNInfo*, MachineDomTreeNode*> LiveOutPair;
 166   typedef DenseMap<MachineBasicBlock*,LiveOutPair> LiveOutMap;
 167
 168   // LiveOutCache - Map each basic block where LI is live out to the live-out
 169   // value and its defining block. One of these conditions shall be true:
 170   //
 171   //  1. !LiveOutCache.count(MBB)
 172   //  2. LiveOutCache[MBB].second.getNode() == MBB
 173   //  3. forall P in preds(MBB): LiveOutCache[P] == LiveOutCache[MBB]
 174   //
 175   // This is only a cache, the values can be computed as:
 176   //
 177   //  VNI = LI->getVNInfoAt(LIS.getMBBEndIdx(MBB))
 178   //  Node = mbt_[LIS.getMBBFromIndex(VNI->def)]
 179   //
 180   // The cache is also used as a visiteed set by mapValue().
 181   LiveOutMap LiveOutCache;
 182
 183   // Dump the live-out cache to dbgs().
 184   void dumpCache();
 185
 186 public:
 187   LiveIntervalMap(LiveIntervals &lis,
 188                   MachineDominatorTree &mdt,
 189                   const LiveInterval &parentli)
 190     : LIS(lis), MDT(mdt), ParentLI(parentli), LI(0) {}
 191
 192   /// reset - clear all data structures and start a new live interval.
 193   void reset(LiveInterval *);
 194
 195   /// getLI - return the current live interval.
 196   LiveInterval *getLI() const { return LI; }
 197
 198   /// mapValue - map ParentVNI to the corresponding LI value at Idx. It is
 199   /// assumed that ParentVNI is live at Idx.
 200   /// If ParentVNI has not been defined by defValue, it is assumed that
 201   /// ParentVNI->def dominates Idx.
 202   /// If ParentVNI has been defined by defValue one or more times, a value that
 203   /// dominates Idx will be returned. This may require creating extra phi-def
 204   /// values and adding live ranges to LI.
 205   /// If simple is not NULL, *simple will indicate if ParentVNI is a simply
 206   /// mapped value.
 207   VNInfo *mapValue(const VNInfo *ParentVNI, SlotIndex Idx, bool *simple = 0);
 208
 209   // extendTo - Find the last LI value defined in MBB at or before Idx. The
 210   // parentli is assumed to be live at Idx. Extend the live range to include
 211   // Idx. Return the found VNInfo, or NULL.
 212   VNInfo *extendTo(const MachineBasicBlock *MBB, SlotIndex Idx);
 213
 214   // addSimpleRange - Add a simple range from ParentLI to LI.
 215   // ParentVNI must be live in the [Start;End) interval.
 216   void addSimpleRange(SlotIndex Start, SlotIndex End, const VNInfo *ParentVNI);
 217
 218   /// addRange - Add live ranges to LI where [Start;End) intersects ParentLI.
 219   /// All needed values whose def is not inside [Start;End) must be defined
 220   /// beforehand so mapValue will work.
 221   void addRange(SlotIndex Start, SlotIndex End);
 222 };
 223
 224
 225 /// SplitEditor - Edit machine code and LiveIntervals for live range
 226 /// splitting.
 227 ///
 228 /// - Create a SplitEditor from a SplitAnalysis.
 229 /// - Start a new live interval with openIntv.
 230 /// - Mark the places where the new interval is entered using enterIntv*
 231 /// - Mark the ranges where the new interval is used with useIntv*
 232 /// - Mark the places where the interval is exited with exitIntv*.
 233 /// - Finish the current interval with closeIntv and repeat from 2.
 234 /// - Rewrite instructions with finish().
 235 ///
 236 class SplitEditor {
 237   SplitAnalysis &SA;
 238   LiveIntervals &LIS;
 239   VirtRegMap &VRM;
 240   MachineRegisterInfo &MRI;
 241   MachineDominatorTree &MDT;
 242   const TargetInstrInfo &TII;
 243   const TargetRegisterInfo &TRI;
 244
 245   /// Edit - The current parent register and new intervals created.
 246   LiveRangeEdit &Edit;
 247
 248   /// Index into Edit of the currently open interval.
 249   /// The index 0 is used for the complement, so the first interval started by
 250   /// openIntv will be 1.
 251   unsigned OpenIdx;
 252
 253   typedef IntervalMap<SlotIndex, unsigned> RegAssignMap;
 254
 255   /// Allocator for the interval map. This will eventually be shared with
 256   /// SlotIndexes and LiveIntervals.
 257   RegAssignMap::Allocator Allocator;
 258
 259   /// RegAssign - Map of the assigned register indexes.
 260   /// Edit.get(RegAssign.lookup(Idx)) is the register that should be live at
 261   /// Idx.
 262   RegAssignMap RegAssign;
 263
 264   /// LIMappers - One LiveIntervalMap or each interval in Edit.
 265   SmallVector<LiveIntervalMap, 4> LIMappers;
 266
 267   typedef DenseMap<std::pair<unsigned, unsigned>, VNInfo*> ValueMap;
 268
 269   /// Values - keep track of the mapping from parent values to values in the new
 270   /// intervals. Given a pair (RegIdx, ParentVNI->id), Values contains:
 271   ///
 272   /// 1. No entry - the value is not mapped to Edit.get(RegIdx).
 273   /// 2. Null - the value is mapped to multiple values in Edit.get(RegIdx).
 274   ///    Each value is represented by a minimal live range at its def.
 275   /// 3. A non-null VNInfo - the value is mapped to a single new value.
 276   ///    The new value has no live ranges anywhere.
 277   ValueMap Values;
 278
 279   /// defValue - define a value in RegIdx from ParentVNI at Idx.
 280   /// Idx does not have to be ParentVNI->def, but it must be contained within
 281   /// ParentVNI's live range in ParentLI. The new value is added to the value
 282   /// map.
 283   /// Return the new LI value.
 284   VNInfo *defValue(unsigned RegIdx, const VNInfo *ParentVNI, SlotIndex Idx);
 285
 286   /// markComplexMapped - Mark ParentVNI as complex mapped in RegIdx regardless
 287   /// of the number of defs.
 288   void markComplexMapped(unsigned RegIdx, const VNInfo *ParentVNI);
 289
 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,
 293                         VNInfo *ParentVNI,
 294                         SlotIndex UseIdx,
 295                         MachineBasicBlock &MBB,
 296                         MachineBasicBlock::iterator I);
 297
 298   /// rewriteAssigned - Rewrite all uses of Edit.getReg() to assigned registers.
 299   void rewriteAssigned();
 300
 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);
 307
 308 public:
 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&);
 313
 314   /// getAnalysis - Get the corresponding analysis.
 315   SplitAnalysis &getAnalysis() { return SA; }
 316
 317   /// Create a new virtual register and live interval.
 318   void openIntv();
 319
 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);
 324
 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);
 329
 330   /// useIntv - indicate that all instructions in MBB should use OpenLI.
 331   void useIntv(const MachineBasicBlock &MBB);
 332
 333   /// useIntv - indicate that all instructions in range should use OpenLI.
 334   void useIntv(SlotIndex Start, SlotIndex End);
 335
 336   /// leaveIntvAfter - Leave the open interval after the instruction at Idx.
 337   /// Return the end of the live range.
 338   SlotIndex leaveIntvAfter(SlotIndex Idx);
 339
 340   /// leaveIntvBefore - Leave the open interval before the instruction at Idx.
 341   /// Return the end of the live range.
 342   SlotIndex leaveIntvBefore(SlotIndex Idx);
 343
 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);
 348
 349   /// overlapIntv - Indicate that all instructions in range should use the open
 350   /// interval, but also let the complement interval be live.
 351   ///
 352   /// This doubles the register pressure, but is sometimes required to deal with
 353   /// register uses after the last valid split point.
 354   ///
 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.
 358   ///
 359   void overlapIntv(SlotIndex Start, SlotIndex End);
 360
 361   /// closeIntv - Indicate that we are done editing the currently open
 362   /// LiveInterval, and ranges can be trimmed.
 363   void closeIntv();
 364
 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.
 367   void finish();
 368
 369   /// dump - print the current interval maping to dbgs().
 370   void dump() const;
 371
 372   // ===--- High level methods ---===
 373
 374   /// splitSingleBlocks - Split CurLI into a separate live interval inside each
 375   /// basic block in Blocks.
 376   void splitSingleBlocks(const SplitAnalysis::BlockPtrSet &Blocks);
 377 };
 378
 379 }