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/BitVector.h"
  16 #include "llvm/ADT/DenseMap.h"
  17 #include "llvm/ADT/IndexedMap.h"
  18 #include "llvm/ADT/IntervalMap.h"
  19 #include "llvm/ADT/SmallPtrSet.h"
  20 #include "llvm/CodeGen/SlotIndexes.h"
  21
  22 namespace llvm {
  23
  24 class ConnectedVNInfoEqClasses;
  25 class LiveInterval;
  26 class LiveIntervals;
  27 class LiveRangeEdit;
  28 class MachineInstr;
  29 class MachineLoopInfo;
  30 class MachineRegisterInfo;
  31 class TargetInstrInfo;
  32 class TargetRegisterInfo;
  33 class VirtRegMap;
  34 class VNInfo;
  35 class raw_ostream;
  36
  37 /// At some point we should just include MachineDominators.h:
  38 class MachineDominatorTree;
  39 template <class NodeT> class DomTreeNodeBase;
  40 typedef DomTreeNodeBase<MachineBasicBlock> MachineDomTreeNode;
  41
  42
  43 /// SplitAnalysis - Analyze a LiveInterval, looking for live range splitting
  44 /// opportunities.
  45 class SplitAnalysis {
  46 public:
  47   const MachineFunction &MF;
  48   const VirtRegMap &VRM;
  49   const LiveIntervals &LIS;
  50   const MachineLoopInfo &Loops;
  51   const TargetInstrInfo &TII;
  52
  53   // Instructions using the the current register.
  54   typedef SmallPtrSet<const MachineInstr*, 16> InstrPtrSet;
  55   InstrPtrSet UsingInstrs;
  56
  57   // Sorted slot indexes of using instructions.
  58   SmallVector<SlotIndex, 8> UseSlots;
  59
  60   // The number of instructions using CurLI in each basic block.
  61   typedef DenseMap<const MachineBasicBlock*, unsigned> BlockCountMap;
  62   BlockCountMap UsingBlocks;
  63
  64   /// Additional information about basic blocks where the current variable is
  65   /// live. Such a block will look like one of these templates:
  66   ///
  67   ///  1. |   o---x   | Internal to block. Variable is only live in this block.
  68   ///  2. |---x       | Live-in, kill.
  69   ///  3. |       o---| Def, live-out.
  70   ///  4. |---x   o---| Live-in, kill, def, live-out.
  71   ///  5. |---o---o---| Live-through with uses or defs.
  72   ///  6. |-----------| Live-through without uses. Transparent.
  73   ///
  74   struct BlockInfo {
  75     MachineBasicBlock *MBB;
  76     SlotIndex Start;      ///< Beginining of block.
  77     SlotIndex Stop;       ///< End of block.
  78     SlotIndex FirstUse;   ///< First instr using current reg.
  79     SlotIndex LastUse;    ///< Last instr using current reg.
  80     SlotIndex Kill;       ///< Interval end point inside block.
  81     SlotIndex Def;        ///< Interval start point inside block.
  82     /// Last possible point for splitting live ranges.
  83     SlotIndex LastSplitPoint;
  84     bool Uses;            ///< Current reg has uses or defs in block.
  85     bool LiveThrough;     ///< Live in whole block (Templ 5. or 6. above).
  86     bool LiveIn;          ///< Current reg is live in.
  87     bool LiveOut;         ///< Current reg is live out.
  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   bool 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 /// SplitEditor - Edit machine code and LiveIntervals for live range
 148 /// splitting.
 149 ///
 150 /// - Create a SplitEditor from a SplitAnalysis.
 151 /// - Start a new live interval with openIntv.
 152 /// - Mark the places where the new interval is entered using enterIntv*
 153 /// - Mark the ranges where the new interval is used with useIntv*
 154 /// - Mark the places where the interval is exited with exitIntv*.
 155 /// - Finish the current interval with closeIntv and repeat from 2.
 156 /// - Rewrite instructions with finish().
 157 ///
 158 class SplitEditor {
 159   SplitAnalysis &SA;
 160   LiveIntervals &LIS;
 161   VirtRegMap &VRM;
 162   MachineRegisterInfo &MRI;
 163   MachineDominatorTree &MDT;
 164   const TargetInstrInfo &TII;
 165   const TargetRegisterInfo &TRI;
 166
 167   /// Edit - The current parent register and new intervals created.
 168   LiveRangeEdit *Edit;
 169
 170   /// Index into Edit of the currently open interval.
 171   /// The index 0 is used for the complement, so the first interval started by
 172   /// openIntv will be 1.
 173   unsigned OpenIdx;
 174
 175   typedef IntervalMap<SlotIndex, unsigned> RegAssignMap;
 176
 177   /// Allocator for the interval map. This will eventually be shared with
 178   /// SlotIndexes and LiveIntervals.
 179   RegAssignMap::Allocator Allocator;
 180
 181   /// RegAssign - Map of the assigned register indexes.
 182   /// Edit.get(RegAssign.lookup(Idx)) is the register that should be live at
 183   /// Idx.
 184   RegAssignMap RegAssign;
 185
 186   typedef DenseMap<std::pair<unsigned, unsigned>, VNInfo*> ValueMap;
 187
 188   /// Values - keep track of the mapping from parent values to values in the new
 189   /// intervals. Given a pair (RegIdx, ParentVNI->id), Values contains:
 190   ///
 191   /// 1. No entry - the value is not mapped to Edit.get(RegIdx).
 192   /// 2. Null - the value is mapped to multiple values in Edit.get(RegIdx).
 193   ///    Each value is represented by a minimal live range at its def.
 194   /// 3. A non-null VNInfo - the value is mapped to a single new value.
 195   ///    The new value has no live ranges anywhere.
 196   ValueMap Values;
 197
 198   typedef std::pair<VNInfo*, MachineDomTreeNode*> LiveOutPair;
 199   typedef IndexedMap<LiveOutPair, MBB2NumberFunctor> LiveOutMap;
 200
 201   // LiveOutCache - Map each basic block where a new register is live out to the
 202   // live-out value and its defining block.
 203   // One of these conditions shall be true:
 204   //
 205   //  1. !LiveOutCache.count(MBB)
 206   //  2. LiveOutCache[MBB].second.getNode() == MBB
 207   //  3. forall P in preds(MBB): LiveOutCache[P] == LiveOutCache[MBB]
 208   //
 209   // This is only a cache, the values can be computed as:
 210   //
 211   //  VNI = Edit.get(RegIdx)->getVNInfoAt(LIS.getMBBEndIdx(MBB))
 212   //  Node = mbt_[LIS.getMBBFromIndex(VNI->def)]
 213   //
 214   // The cache is also used as a visited set by extendRange(). It can be shared
 215   // by all the new registers because at most one is live out of each block.
 216   LiveOutMap LiveOutCache;
 217
 218   // LiveOutSeen - Indexed by MBB->getNumber(), a bit is set for each valid
 219   // entry in LiveOutCache.
 220   BitVector LiveOutSeen;
 221
 222   /// defValue - define a value in RegIdx from ParentVNI at Idx.
 223   /// Idx does not have to be ParentVNI->def, but it must be contained within
 224   /// ParentVNI's live range in ParentLI. The new value is added to the value
 225   /// map.
 226   /// Return the new LI value.
 227   VNInfo *defValue(unsigned RegIdx, const VNInfo *ParentVNI, SlotIndex Idx);
 228
 229   /// markComplexMapped - Mark ParentVNI as complex mapped in RegIdx regardless
 230   /// of the number of defs.
 231   void markComplexMapped(unsigned RegIdx, const VNInfo *ParentVNI);
 232
 233   /// defFromParent - Define Reg from ParentVNI at UseIdx using either
 234   /// rematerialization or a COPY from parent. Return the new value.
 235   VNInfo *defFromParent(unsigned RegIdx,
 236                         VNInfo *ParentVNI,
 237                         SlotIndex UseIdx,
 238                         MachineBasicBlock &MBB,
 239                         MachineBasicBlock::iterator I);
 240
 241   /// extendRange - Extend the live range of Edit.get(RegIdx) so it reaches Idx.
 242   /// Insert PHIDefs as needed to preserve SSA form.
 243   void extendRange(unsigned RegIdx, SlotIndex Idx);
 244
 245   /// updateSSA - Insert PHIDefs as necessary and update LiveOutCache such that
 246   /// Edit.get(RegIdx) is live-in to all the blocks in LiveIn.
 247   /// Return the value that is eventually live-in to IdxMBB.
 248   VNInfo *updateSSA(unsigned RegIdx,
 249                     SmallVectorImpl<MachineDomTreeNode*> &LiveIn,
 250                     SlotIndex Idx,
 251                     const MachineBasicBlock *IdxMBB);
 252
 253   /// transferSimpleValues - Transfer simply defined values to the new ranges.
 254   /// Return true if any complex ranges were skipped.
 255   bool transferSimpleValues();
 256
 257   /// extendPHIKillRanges - Extend the ranges of all values killed by original
 258   /// parent PHIDefs.
 259   void extendPHIKillRanges();
 260
 261   /// rewriteAssigned - Rewrite all uses of Edit.getReg() to assigned registers.
 262   void rewriteAssigned(bool ExtendRanges);
 263
 264   /// deleteRematVictims - Delete defs that are dead after rematerializing.
 265   void deleteRematVictims();
 266
 267 public:
 268   /// Create a new SplitEditor for editing the LiveInterval analyzed by SA.
 269   /// Newly created intervals will be appended to newIntervals.
 270   SplitEditor(SplitAnalysis &SA, LiveIntervals&, VirtRegMap&,
 271               MachineDominatorTree&);
 272
 273   /// reset - Prepare for a new split.
 274   void reset(LiveRangeEdit&);
 275
 276   /// Create a new virtual register and live interval.
 277   void openIntv();
 278
 279   /// enterIntvBefore - Enter the open interval before the instruction at Idx.
 280   /// If the parent interval is not live before Idx, a COPY is not inserted.
 281   /// Return the beginning of the new live range.
 282   SlotIndex enterIntvBefore(SlotIndex Idx);
 283
 284   /// enterIntvAtEnd - Enter the open interval at the end of MBB.
 285   /// Use the open interval from he inserted copy to the MBB end.
 286   /// Return the beginning of the new live range.
 287   SlotIndex enterIntvAtEnd(MachineBasicBlock &MBB);
 288
 289   /// useIntv - indicate that all instructions in MBB should use OpenLI.
 290   void useIntv(const MachineBasicBlock &MBB);
 291
 292   /// useIntv - indicate that all instructions in range should use OpenLI.
 293   void useIntv(SlotIndex Start, SlotIndex End);
 294
 295   /// leaveIntvAfter - Leave the open interval after the instruction at Idx.
 296   /// Return the end of the live range.
 297   SlotIndex leaveIntvAfter(SlotIndex Idx);
 298
 299   /// leaveIntvBefore - Leave the open interval before the instruction at Idx.
 300   /// Return the end of the live range.
 301   SlotIndex leaveIntvBefore(SlotIndex Idx);
 302
 303   /// leaveIntvAtTop - Leave the interval at the top of MBB.
 304   /// Add liveness from the MBB top to the copy.
 305   /// Return the end of the live range.
 306   SlotIndex leaveIntvAtTop(MachineBasicBlock &MBB);
 307
 308   /// overlapIntv - Indicate that all instructions in range should use the open
 309   /// interval, but also let the complement interval be live.
 310   ///
 311   /// This doubles the register pressure, but is sometimes required to deal with
 312   /// register uses after the last valid split point.
 313   ///
 314   /// The Start index should be a return value from a leaveIntv* call, and End
 315   /// should be in the same basic block. The parent interval must have the same
 316   /// value across the range.
 317   ///
 318   void overlapIntv(SlotIndex Start, SlotIndex End);
 319
 320   /// closeIntv - Indicate that we are done editing the currently open
 321   /// LiveInterval, and ranges can be trimmed.
 322   void closeIntv();
 323
 324   /// finish - after all the new live ranges have been created, compute the
 325   /// remaining live range, and rewrite instructions to use the new registers.
 326   void finish();
 327
 328   /// dump - print the current interval maping to dbgs().
 329   void dump() const;
 330
 331   // ===--- High level methods ---===
 332
 333   /// splitSingleBlocks - Split CurLI into a separate live interval inside each
 334   /// basic block in Blocks.
 335   void splitSingleBlocks(const SplitAnalysis::BlockPtrSet &Blocks);
 336 };
 337
 338 }