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 LiveIntervals &LIS;
  47   const MachineLoopInfo &Loops;
  48   const TargetInstrInfo &TII;
  49
  50   // Instructions using the the current register.
  51   typedef SmallPtrSet<const MachineInstr*, 16> InstrPtrSet;
  52   InstrPtrSet UsingInstrs;
  53
  54   // Sorted slot indexes of using instructions.
  55   SmallVector<SlotIndex, 8> UseSlots;
  56
  57   // The number of instructions using CurLI in each basic block.
  58   typedef DenseMap<const MachineBasicBlock*, unsigned> BlockCountMap;
  59   BlockCountMap UsingBlocks;
  60
  61   /// Additional information about basic blocks where the current variable is
  62   /// live. Such a block will look like one of these templates:
  63   ///
  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.
  70   ///
  71   struct BlockInfo {
  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.
  83
  84     // Per-interference pattern scratch data.
  85     bool OverlapEntry;    ///< Interference overlaps entering interval.
  86     bool OverlapExit;     ///< Interference overlaps exiting interval.
  87   };
  88
  89   /// Basic blocks where var is live. This array is parallel to
  90   /// SpillConstraints.
  91   SmallVector<BlockInfo, 8> LiveBlocks;
  92
  93 private:
  94   // Current live interval.
  95   const LiveInterval *CurLI;
  96
  97   // Sumarize statistics by counting instructions using CurLI.
  98   void analyzeUses();
  99
 100   /// calcLiveBlockInfo - Compute per-block information about CurLI.
 101   void calcLiveBlockInfo();
 102
 103   /// canAnalyzeBranch - Return true if MBB ends in a branch that can be
 104   /// analyzed.
 105   bool canAnalyzeBranch(const MachineBasicBlock *MBB);
 106
 107 public:
 108   SplitAnalysis(const MachineFunction &mf, const LiveIntervals &lis,
 109                 const MachineLoopInfo &mli);
 110
 111   /// analyze - set CurLI to the specified interval, and analyze how it may be
 112   /// split.
 113   void analyze(const LiveInterval *li);
 114
 115   /// clear - clear all data structures so SplitAnalysis is ready to analyze a
 116   /// new interval.
 117   void clear();
 118
 119   /// getParent - Return the last analyzed interval.
 120   const LiveInterval &getParent() const { return *CurLI; }
 121
 122   /// hasUses - Return true if MBB has any uses of CurLI.
 123   bool hasUses(const MachineBasicBlock *MBB) const {
 124     return UsingBlocks.lookup(MBB);
 125   }
 126
 127   typedef SmallPtrSet<const MachineBasicBlock*, 16> BlockPtrSet;
 128
 129   // Print a set of blocks with use counts.
 130   void print(const BlockPtrSet&, raw_ostream&) const;
 131
 132   /// getMultiUseBlocks - Add basic blocks to Blocks that may benefit from
 133   /// having CurLI split to a new live interval. Return true if Blocks can be
 134   /// passed to SplitEditor::splitSingleBlocks.
 135   bool getMultiUseBlocks(BlockPtrSet &Blocks);
 136
 137   /// getBlockForInsideSplit - If CurLI is contained inside a single basic
 138   /// block, and it would pay to subdivide the interval inside that block,
 139   /// return it. Otherwise return NULL. The returned block can be passed to
 140   /// SplitEditor::splitInsideBlock.
 141   const MachineBasicBlock *getBlockForInsideSplit();
 142 };
 143
 144
 145 /// LiveIntervalMap - Map values from a large LiveInterval into a small
 146 /// interval that is a subset. Insert phi-def values as needed. This class is
 147 /// used by SplitEditor to create new smaller LiveIntervals.
 148 ///
 149 /// ParentLI is the larger interval, LI is the subset interval. Every value
 150 /// in LI corresponds to exactly one value in ParentLI, and the live range
 151 /// of the value is contained within the live range of the ParentLI value.
 152 /// Values in ParentLI may map to any number of OpenLI values, including 0.
 153 class LiveIntervalMap {
 154   LiveIntervals &LIS;
 155   MachineDominatorTree &MDT;
 156
 157   // The parent interval is never changed.
 158   const LiveInterval &ParentLI;
 159
 160   // The child interval's values are fully contained inside ParentLI values.
 161   LiveInterval *LI;
 162
 163   typedef DenseMap<const VNInfo*, VNInfo*> ValueMap;
 164
 165   // Map ParentLI values to simple values in LI that are defined at the same
 166   // SlotIndex, or NULL for ParentLI values that have complex LI defs.
 167   // Note there is a difference between values mapping to NULL (complex), and
 168   // values not present (unknown/unmapped).
 169   ValueMap Values;
 170
 171   typedef std::pair<VNInfo*, MachineDomTreeNode*> LiveOutPair;
 172   typedef DenseMap<MachineBasicBlock*,LiveOutPair> LiveOutMap;
 173
 174   // LiveOutCache - Map each basic block where LI is live out to the live-out
 175   // value and its defining block. One of these conditions shall be true:
 176   //
 177   //  1. !LiveOutCache.count(MBB)
 178   //  2. LiveOutCache[MBB].second.getNode() == MBB
 179   //  3. forall P in preds(MBB): LiveOutCache[P] == LiveOutCache[MBB]
 180   //
 181   // This is only a cache, the values can be computed as:
 182   //
 183   //  VNI = LI->getVNInfoAt(LIS.getMBBEndIdx(MBB))
 184   //  Node = mbt_[LIS.getMBBFromIndex(VNI->def)]
 185   //
 186   // The cache is also used as a visiteed set by mapValue().
 187   LiveOutMap LiveOutCache;
 188
 189   // Dump the live-out cache to dbgs().
 190   void dumpCache();
 191
 192 public:
 193   LiveIntervalMap(LiveIntervals &lis,
 194                   MachineDominatorTree &mdt,
 195                   const LiveInterval &parentli)
 196     : LIS(lis), MDT(mdt), ParentLI(parentli), LI(0) {}
 197
 198   /// reset - clear all data structures and start a new live interval.
 199   void reset(LiveInterval *);
 200
 201   /// getLI - return the current live interval.
 202   LiveInterval *getLI() const { return LI; }
 203
 204   /// defValue - define a value in LI from the ParentLI value VNI and Idx.
 205   /// Idx does not have to be ParentVNI->def, but it must be contained within
 206   /// ParentVNI's live range in ParentLI.
 207   /// Return the new LI value.
 208   VNInfo *defValue(const VNInfo *ParentVNI, SlotIndex Idx);
 209
 210   /// mapValue - map ParentVNI to the corresponding LI value at Idx. It is
 211   /// assumed that ParentVNI is live at Idx.
 212   /// If ParentVNI has not been defined by defValue, it is assumed that
 213   /// ParentVNI->def dominates Idx.
 214   /// If ParentVNI has been defined by defValue one or more times, a value that
 215   /// dominates Idx will be returned. This may require creating extra phi-def
 216   /// values and adding live ranges to LI.
 217   /// If simple is not NULL, *simple will indicate if ParentVNI is a simply
 218   /// mapped value.
 219   VNInfo *mapValue(const VNInfo *ParentVNI, SlotIndex Idx, bool *simple = 0);
 220
 221   // extendTo - Find the last LI value defined in MBB at or before Idx. The
 222   // parentli is assumed to be live at Idx. Extend the live range to include
 223   // Idx. Return the found VNInfo, or NULL.
 224   VNInfo *extendTo(const MachineBasicBlock *MBB, SlotIndex Idx);
 225
 226   /// isMapped - Return true is ParentVNI is a known mapped value. It may be a
 227   /// simple 1-1 mapping or a complex mapping to later defs.
 228   bool isMapped(const VNInfo *ParentVNI) const {
 229     return Values.count(ParentVNI);
 230   }
 231
 232   /// isComplexMapped - Return true if ParentVNI has received new definitions
 233   /// with defValue.
 234   bool isComplexMapped(const VNInfo *ParentVNI) const;
 235
 236   /// markComplexMapped - Mark ParentVNI as complex mapped regardless of the
 237   /// number of definitions.
 238   void markComplexMapped(const VNInfo *ParentVNI) { Values[ParentVNI] = 0; }
 239
 240   // addSimpleRange - Add a simple range from ParentLI to LI.
 241   // ParentVNI must be live in the [Start;End) interval.
 242   void addSimpleRange(SlotIndex Start, SlotIndex End, const VNInfo *ParentVNI);
 243
 244   /// addRange - Add live ranges to LI where [Start;End) intersects ParentLI.
 245   /// All needed values whose def is not inside [Start;End) must be defined
 246   /// beforehand so mapValue will work.
 247   void addRange(SlotIndex Start, SlotIndex End);
 248 };
 249
 250
 251 /// SplitEditor - Edit machine code and LiveIntervals for live range
 252 /// splitting.
 253 ///
 254 /// - Create a SplitEditor from a SplitAnalysis.
 255 /// - Start a new live interval with openIntv.
 256 /// - Mark the places where the new interval is entered using enterIntv*
 257 /// - Mark the ranges where the new interval is used with useIntv*
 258 /// - Mark the places where the interval is exited with exitIntv*.
 259 /// - Finish the current interval with closeIntv and repeat from 2.
 260 /// - Rewrite instructions with finish().
 261 ///
 262 class SplitEditor {
 263   SplitAnalysis &SA;
 264   LiveIntervals &LIS;
 265   VirtRegMap &VRM;
 266   MachineRegisterInfo &MRI;
 267   MachineDominatorTree &MDT;
 268   const TargetInstrInfo &TII;
 269   const TargetRegisterInfo &TRI;
 270
 271   /// Edit - The current parent register and new intervals created.
 272   LiveRangeEdit &Edit;
 273
 274   /// Index into Edit of the currently open interval.
 275   /// The index 0 is used for the complement, so the first interval started by
 276   /// openIntv will be 1.
 277   unsigned OpenIdx;
 278
 279   typedef IntervalMap<SlotIndex, unsigned> RegAssignMap;
 280
 281   /// Allocator for the interval map. This will eventually be shared with
 282   /// SlotIndexes and LiveIntervals.
 283   RegAssignMap::Allocator Allocator;
 284
 285   /// RegAssign - Map of the assigned register indexes.
 286   /// Edit.get(RegAssign.lookup(Idx)) is the register that should be live at
 287   /// Idx.
 288   RegAssignMap RegAssign;
 289
 290   /// LIMappers - One LiveIntervalMap or each interval in Edit.
 291   SmallVector<LiveIntervalMap, 4> LIMappers;
 292
 293   /// defFromParent - Define Reg from ParentVNI at UseIdx using either
 294   /// rematerialization or a COPY from parent. Return the new value.
 295   VNInfo *defFromParent(unsigned RegIdx,
 296                         VNInfo *ParentVNI,
 297                         SlotIndex UseIdx,
 298                         MachineBasicBlock &MBB,
 299                         MachineBasicBlock::iterator I);
 300
 301   /// rewriteAssigned - Rewrite all uses of Edit.getReg() to assigned registers.
 302   void rewriteAssigned();
 303
 304   /// rewriteComponents - Rewrite all uses of Intv[0] according to the eq
 305   /// classes in ConEQ.
 306   /// This must be done when Intvs[0] is styill live at all uses, before calling
 307   /// ConEq.Distribute().
 308   void rewriteComponents(const SmallVectorImpl<LiveInterval*> &Intvs,
 309                          const ConnectedVNInfoEqClasses &ConEq);
 310
 311 public:
 312   /// Create a new SplitEditor for editing the LiveInterval analyzed by SA.
 313   /// Newly created intervals will be appended to newIntervals.
 314   SplitEditor(SplitAnalysis &SA, LiveIntervals&, VirtRegMap&,
 315               MachineDominatorTree&, LiveRangeEdit&);
 316
 317   /// getAnalysis - Get the corresponding analysis.
 318   SplitAnalysis &getAnalysis() { return SA; }
 319
 320   /// Create a new virtual register and live interval.
 321   void openIntv();
 322
 323   /// enterIntvBefore - Enter the open interval before the instruction at Idx.
 324   /// If the parent interval is not live before Idx, a COPY is not inserted.
 325   /// Return the beginning of the new live range.
 326   SlotIndex enterIntvBefore(SlotIndex Idx);
 327
 328   /// enterIntvAtEnd - Enter the open interval at the end of MBB.
 329   /// Use the open interval from he inserted copy to the MBB end.
 330   /// Return the beginning of the new live range.
 331   SlotIndex enterIntvAtEnd(MachineBasicBlock &MBB);
 332
 333   /// useIntv - indicate that all instructions in MBB should use OpenLI.
 334   void useIntv(const MachineBasicBlock &MBB);
 335
 336   /// useIntv - indicate that all instructions in range should use OpenLI.
 337   void useIntv(SlotIndex Start, SlotIndex End);
 338
 339   /// leaveIntvAfter - Leave the open interval after the instruction at Idx.
 340   /// Return the end of the live range.
 341   SlotIndex leaveIntvAfter(SlotIndex Idx);
 342
 343   /// leaveIntvBefore - Leave the open interval before the instruction at Idx.
 344   /// Return the end of the live range.
 345   SlotIndex leaveIntvBefore(SlotIndex Idx);
 346
 347   /// leaveIntvAtTop - Leave the interval at the top of MBB.
 348   /// Add liveness from the MBB top to the copy.
 349   /// Return the end of the live range.
 350   SlotIndex leaveIntvAtTop(MachineBasicBlock &MBB);
 351
 352   /// overlapIntv - Indicate that all instructions in range should use the open
 353   /// interval, but also let the complement interval be live.
 354   ///
 355   /// This doubles the register pressure, but is sometimes required to deal with
 356   /// register uses after the last valid split point.
 357   ///
 358   /// The Start index should be a return value from a leaveIntv* call, and End
 359   /// should be in the same basic block. The parent interval must have the same
 360   /// value across the range.
 361   ///
 362   void overlapIntv(SlotIndex Start, SlotIndex End);
 363
 364   /// closeIntv - Indicate that we are done editing the currently open
 365   /// LiveInterval, and ranges can be trimmed.
 366   void closeIntv();
 367
 368   /// finish - after all the new live ranges have been created, compute the
 369   /// remaining live range, and rewrite instructions to use the new registers.
 370   void finish();
 371
 372   /// dump - print the current interval maping to dbgs().
 373   void dump() const;
 374
 375   // ===--- High level methods ---===
 376
 377   /// splitSingleBlocks - Split CurLI into a separate live interval inside each
 378   /// basic block in Blocks.
 379   void splitSingleBlocks(const SplitAnalysis::BlockPtrSet &Blocks);
 380
 381   /// splitInsideBlock - Split CurLI into multiple intervals inside MBB.
 382   void splitInsideBlock(const MachineBasicBlock *);
 383 };
 384
 385 }