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 FirstUse;   ///< First instr using current reg.
  77     SlotIndex LastUse;    ///< Last instr using current reg.
  78     SlotIndex Kill;       ///< Interval end point inside block.
  79     SlotIndex Def;        ///< Interval start point inside block.
  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
  86   /// Basic blocks where var is live. This array is parallel to
  87   /// SpillConstraints.
  88   SmallVector<BlockInfo, 8> LiveBlocks;
  89
  90 private:
  91   // Current live interval.
  92   const LiveInterval *CurLI;
  93
  94   /// LastSplitPoint - Last legal split point in each basic block in the current
  95   /// function. The first entry is the first terminator, the second entry is the
  96   /// last valid split point for a variable that is live in to a landing pad
  97   /// successor.
  98   SmallVector<std::pair<SlotIndex, SlotIndex>, 8> LastSplitPoint;
  99
 100   SlotIndex computeLastSplitPoint(unsigned Num);
 101
 102   // Sumarize statistics by counting instructions using CurLI.
 103   void analyzeUses();
 104
 105   /// calcLiveBlockInfo - Compute per-block information about CurLI.
 106   bool calcLiveBlockInfo();
 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   /// getLastSplitPoint - Return that base index of the last valid split point
 124   /// in the basic block numbered Num.
 125   SlotIndex getLastSplitPoint(unsigned Num) {
 126     // Inline the common simple case.
 127     if (LastSplitPoint[Num].first.isValid() &&
 128         !LastSplitPoint[Num].second.isValid())
 129       return LastSplitPoint[Num].first;
 130     return computeLastSplitPoint(Num);
 131   }
 132
 133   /// hasUses - Return true if MBB has any uses of CurLI.
 134   bool hasUses(const MachineBasicBlock *MBB) const {
 135     return UsingBlocks.lookup(MBB);
 136   }
 137
 138   /// isOriginalEndpoint - Return true if the original live range was killed or
 139   /// (re-)defined at Idx. Idx should be the 'def' slot for a normal kill/def,
 140   /// and 'use' for an early-clobber def.
 141   /// This can be used to recognize code inserted by earlier live range
 142   /// splitting.
 143   bool isOriginalEndpoint(SlotIndex Idx) const;
 144
 145   typedef SmallPtrSet<const MachineBasicBlock*, 16> BlockPtrSet;
 146
 147   // Print a set of blocks with use counts.
 148   void print(const BlockPtrSet&, raw_ostream&) const;
 149
 150   /// getMultiUseBlocks - Add basic blocks to Blocks that may benefit from
 151   /// having CurLI split to a new live interval. Return true if Blocks can be
 152   /// passed to SplitEditor::splitSingleBlocks.
 153   bool getMultiUseBlocks(BlockPtrSet &Blocks);
 154 };
 155
 156
 157 /// SplitEditor - Edit machine code and LiveIntervals for live range
 158 /// splitting.
 159 ///
 160 /// - Create a SplitEditor from a SplitAnalysis.
 161 /// - Start a new live interval with openIntv.
 162 /// - Mark the places where the new interval is entered using enterIntv*
 163 /// - Mark the ranges where the new interval is used with useIntv*
 164 /// - Mark the places where the interval is exited with exitIntv*.
 165 /// - Finish the current interval with closeIntv and repeat from 2.
 166 /// - Rewrite instructions with finish().
 167 ///
 168 class SplitEditor {
 169   SplitAnalysis &SA;
 170   LiveIntervals &LIS;
 171   VirtRegMap &VRM;
 172   MachineRegisterInfo &MRI;
 173   MachineDominatorTree &MDT;
 174   const TargetInstrInfo &TII;
 175   const TargetRegisterInfo &TRI;
 176
 177   /// Edit - The current parent register and new intervals created.
 178   LiveRangeEdit *Edit;
 179
 180   /// Index into Edit of the currently open interval.
 181   /// The index 0 is used for the complement, so the first interval started by
 182   /// openIntv will be 1.
 183   unsigned OpenIdx;
 184
 185   typedef IntervalMap<SlotIndex, unsigned> RegAssignMap;
 186
 187   /// Allocator for the interval map. This will eventually be shared with
 188   /// SlotIndexes and LiveIntervals.
 189   RegAssignMap::Allocator Allocator;
 190
 191   /// RegAssign - Map of the assigned register indexes.
 192   /// Edit.get(RegAssign.lookup(Idx)) is the register that should be live at
 193   /// Idx.
 194   RegAssignMap RegAssign;
 195
 196   typedef DenseMap<std::pair<unsigned, unsigned>, VNInfo*> ValueMap;
 197
 198   /// Values - keep track of the mapping from parent values to values in the new
 199   /// intervals. Given a pair (RegIdx, ParentVNI->id), Values contains:
 200   ///
 201   /// 1. No entry - the value is not mapped to Edit.get(RegIdx).
 202   /// 2. Null - the value is mapped to multiple values in Edit.get(RegIdx).
 203   ///    Each value is represented by a minimal live range at its def.
 204   /// 3. A non-null VNInfo - the value is mapped to a single new value.
 205   ///    The new value has no live ranges anywhere.
 206   ValueMap Values;
 207
 208   typedef std::pair<VNInfo*, MachineDomTreeNode*> LiveOutPair;
 209   typedef IndexedMap<LiveOutPair, MBB2NumberFunctor> LiveOutMap;
 210
 211   // LiveOutCache - Map each basic block where a new register is live out to the
 212   // live-out value and its defining block.
 213   // One of these conditions shall be true:
 214   //
 215   //  1. !LiveOutCache.count(MBB)
 216   //  2. LiveOutCache[MBB].second.getNode() == MBB
 217   //  3. forall P in preds(MBB): LiveOutCache[P] == LiveOutCache[MBB]
 218   //
 219   // This is only a cache, the values can be computed as:
 220   //
 221   //  VNI = Edit.get(RegIdx)->getVNInfoAt(LIS.getMBBEndIdx(MBB))
 222   //  Node = mbt_[LIS.getMBBFromIndex(VNI->def)]
 223   //
 224   // The cache is also used as a visited set by extendRange(). It can be shared
 225   // by all the new registers because at most one is live out of each block.
 226   LiveOutMap LiveOutCache;
 227
 228   // LiveOutSeen - Indexed by MBB->getNumber(), a bit is set for each valid
 229   // entry in LiveOutCache.
 230   BitVector LiveOutSeen;
 231
 232   /// defValue - define a value in RegIdx from ParentVNI at Idx.
 233   /// Idx does not have to be ParentVNI->def, but it must be contained within
 234   /// ParentVNI's live range in ParentLI. The new value is added to the value
 235   /// map.
 236   /// Return the new LI value.
 237   VNInfo *defValue(unsigned RegIdx, const VNInfo *ParentVNI, SlotIndex Idx);
 238
 239   /// markComplexMapped - Mark ParentVNI as complex mapped in RegIdx regardless
 240   /// of the number of defs.
 241   void markComplexMapped(unsigned RegIdx, const VNInfo *ParentVNI);
 242
 243   /// defFromParent - Define Reg from ParentVNI at UseIdx using either
 244   /// rematerialization or a COPY from parent. Return the new value.
 245   VNInfo *defFromParent(unsigned RegIdx,
 246                         VNInfo *ParentVNI,
 247                         SlotIndex UseIdx,
 248                         MachineBasicBlock &MBB,
 249                         MachineBasicBlock::iterator I);
 250
 251   /// extendRange - Extend the live range of Edit.get(RegIdx) so it reaches Idx.
 252   /// Insert PHIDefs as needed to preserve SSA form.
 253   void extendRange(unsigned RegIdx, SlotIndex Idx);
 254
 255   /// updateSSA - Insert PHIDefs as necessary and update LiveOutCache such that
 256   /// Edit.get(RegIdx) is live-in to all the blocks in LiveIn.
 257   /// Return the value that is eventually live-in to IdxMBB.
 258   VNInfo *updateSSA(unsigned RegIdx,
 259                     SmallVectorImpl<MachineDomTreeNode*> &LiveIn,
 260                     SlotIndex Idx,
 261                     const MachineBasicBlock *IdxMBB);
 262
 263   /// transferSimpleValues - Transfer simply defined values to the new ranges.
 264   /// Return true if any complex ranges were skipped.
 265   bool transferSimpleValues();
 266
 267   /// extendPHIKillRanges - Extend the ranges of all values killed by original
 268   /// parent PHIDefs.
 269   void extendPHIKillRanges();
 270
 271   /// rewriteAssigned - Rewrite all uses of Edit.getReg() to assigned registers.
 272   void rewriteAssigned(bool ExtendRanges);
 273
 274   /// deleteRematVictims - Delete defs that are dead after rematerializing.
 275   void deleteRematVictims();
 276
 277 public:
 278   /// Create a new SplitEditor for editing the LiveInterval analyzed by SA.
 279   /// Newly created intervals will be appended to newIntervals.
 280   SplitEditor(SplitAnalysis &SA, LiveIntervals&, VirtRegMap&,
 281               MachineDominatorTree&);
 282
 283   /// reset - Prepare for a new split.
 284   void reset(LiveRangeEdit&);
 285
 286   /// Create a new virtual register and live interval.
 287   void openIntv();
 288
 289   /// enterIntvBefore - Enter the open interval before the instruction at Idx.
 290   /// If the parent interval is not live before Idx, a COPY is not inserted.
 291   /// Return the beginning of the new live range.
 292   SlotIndex enterIntvBefore(SlotIndex Idx);
 293
 294   /// enterIntvAtEnd - Enter the open interval at the end of MBB.
 295   /// Use the open interval from he inserted copy to the MBB end.
 296   /// Return the beginning of the new live range.
 297   SlotIndex enterIntvAtEnd(MachineBasicBlock &MBB);
 298
 299   /// useIntv - indicate that all instructions in MBB should use OpenLI.
 300   void useIntv(const MachineBasicBlock &MBB);
 301
 302   /// useIntv - indicate that all instructions in range should use OpenLI.
 303   void useIntv(SlotIndex Start, SlotIndex End);
 304
 305   /// leaveIntvAfter - Leave the open interval after the instruction at Idx.
 306   /// Return the end of the live range.
 307   SlotIndex leaveIntvAfter(SlotIndex Idx);
 308
 309   /// leaveIntvBefore - Leave the open interval before the instruction at Idx.
 310   /// Return the end of the live range.
 311   SlotIndex leaveIntvBefore(SlotIndex Idx);
 312
 313   /// leaveIntvAtTop - Leave the interval at the top of MBB.
 314   /// Add liveness from the MBB top to the copy.
 315   /// Return the end of the live range.
 316   SlotIndex leaveIntvAtTop(MachineBasicBlock &MBB);
 317
 318   /// overlapIntv - Indicate that all instructions in range should use the open
 319   /// interval, but also let the complement interval be live.
 320   ///
 321   /// This doubles the register pressure, but is sometimes required to deal with
 322   /// register uses after the last valid split point.
 323   ///
 324   /// The Start index should be a return value from a leaveIntv* call, and End
 325   /// should be in the same basic block. The parent interval must have the same
 326   /// value across the range.
 327   ///
 328   void overlapIntv(SlotIndex Start, SlotIndex End);
 329
 330   /// closeIntv - Indicate that we are done editing the currently open
 331   /// LiveInterval, and ranges can be trimmed.
 332   void closeIntv();
 333
 334   /// finish - after all the new live ranges have been created, compute the
 335   /// remaining live range, and rewrite instructions to use the new registers.
 336   void finish();
 337
 338   /// dump - print the current interval maping to dbgs().
 339   void dump() const;
 340
 341   // ===--- High level methods ---===
 342
 343   /// splitSingleBlocks - Split CurLI into a separate live interval inside each
 344   /// basic block in Blocks.
 345   void splitSingleBlocks(const SplitAnalysis::BlockPtrSet &Blocks);
 346 };
 347
 348 }