include/llvm/CodeGen/LiveIntervalAnalysis.h

   1 //===-- LiveIntervalAnalysis.h - Live Interval Analysis ---------*- 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 implements the LiveInterval analysis pass.  Given some numbering of
  11 // each the machine instructions (in this implemention depth-first order) an
  12 // interval [i, j) is said to be a live interval for register v if there is no
  13 // instruction with number j' > j such that v is live at j' and there is no
  14 // instruction with number i' < i such that v is live at i'. In this
  15 // implementation intervals can have holes, i.e. an interval might look like
  16 // [1,20), [50,65), [1000,1001).
  17 //
  18 //===----------------------------------------------------------------------===//
  19
  20 #ifndef LLVM_CODEGEN_LIVEINTERVALANALYSIS_H
  21 #define LLVM_CODEGEN_LIVEINTERVALANALYSIS_H
  22
  23 #include "llvm/ADT/IndexedMap.h"
  24 #include "llvm/ADT/SmallVector.h"
  25 #include "llvm/Analysis/AliasAnalysis.h"
  26 #include "llvm/CodeGen/LiveInterval.h"
  27 #include "llvm/CodeGen/MachineBasicBlock.h"
  28 #include "llvm/CodeGen/MachineFunctionPass.h"
  29 #include "llvm/CodeGen/SlotIndexes.h"
  30 #include "llvm/Support/Allocator.h"
  31 #include "llvm/Support/CommandLine.h"
  32 #include "llvm/Target/TargetRegisterInfo.h"
  33 #include <cmath>
  34 #include <iterator>
  35
  36 namespace llvm {
  37
  38 extern cl::opt<bool> UseSegmentSetForPhysRegs;
  39
  40   class BitVector;
  41   class BlockFrequency;
  42   class LiveRangeCalc;
  43   class LiveVariables;
  44   class MachineDominatorTree;
  45   class MachineLoopInfo;
  46   class TargetRegisterInfo;
  47   class MachineRegisterInfo;
  48   class TargetInstrInfo;
  49   class TargetRegisterClass;
  50   class VirtRegMap;
  51   class MachineBlockFrequencyInfo;
  52
  53   class LiveIntervals : public MachineFunctionPass {
  54     MachineFunction* MF;
  55     MachineRegisterInfo* MRI;
  56     const TargetRegisterInfo* TRI;
  57     const TargetInstrInfo* TII;
  58     AliasAnalysis *AA;
  59     SlotIndexes* Indexes;
  60     MachineDominatorTree *DomTree;
  61     LiveRangeCalc *LRCalc;
  62
  63     /// Special pool allocator for VNInfo's (LiveInterval val#).
  64     ///
  65     VNInfo::Allocator VNInfoAllocator;
  66
  67     /// Live interval pointers for all the virtual registers.
  68     IndexedMap<LiveInterval*, VirtReg2IndexFunctor> VirtRegIntervals;
  69
  70     /// RegMaskSlots - Sorted list of instructions with register mask operands.
  71     /// Always use the 'r' slot, RegMasks are normal clobbers, not early
  72     /// clobbers.
  73     SmallVector<SlotIndex, 8> RegMaskSlots;
  74
  75     /// RegMaskBits - This vector is parallel to RegMaskSlots, it holds a
  76     /// pointer to the corresponding register mask.  This pointer can be
  77     /// recomputed as:
  78     ///
  79     ///   MI = Indexes->getInstructionFromIndex(RegMaskSlot[N]);
  80     ///   unsigned OpNum = findRegMaskOperand(MI);
  81     ///   RegMaskBits[N] = MI->getOperand(OpNum).getRegMask();
  82     ///
  83     /// This is kept in a separate vector partly because some standard
  84     /// libraries don't support lower_bound() with mixed objects, partly to
  85     /// improve locality when searching in RegMaskSlots.
  86     /// Also see the comment in LiveInterval::find().
  87     SmallVector<const uint32_t*, 8> RegMaskBits;
  88
  89     /// For each basic block number, keep (begin, size) pairs indexing into the
  90     /// RegMaskSlots and RegMaskBits arrays.
  91     /// Note that basic block numbers may not be layout contiguous, that's why
  92     /// we can't just keep track of the first register mask in each basic
  93     /// block.
  94     SmallVector<std::pair<unsigned, unsigned>, 8> RegMaskBlocks;
  95
  96     /// Keeps a live range set for each register unit to track fixed physreg
  97     /// interference.
  98     SmallVector<LiveRange*, 0> RegUnitRanges;
  99
 100   public:
 101     static char ID; // Pass identification, replacement for typeid
 102     LiveIntervals();
 103     ~LiveIntervals() override;
 104
 105     // Calculate the spill weight to assign to a single instruction.
 106     static float getSpillWeight(bool isDef, bool isUse,
 107                                 const MachineBlockFrequencyInfo *MBFI,
 108                                 const MachineInstr *Instr);
 109
 110     LiveInterval &getInterval(unsigned Reg) {
 111       if (hasInterval(Reg))
 112         return *VirtRegIntervals[Reg];
 113       else
 114         return createAndComputeVirtRegInterval(Reg);
 115     }
 116
 117     const LiveInterval &getInterval(unsigned Reg) const {
 118       return const_cast<LiveIntervals*>(this)->getInterval(Reg);
 119     }
 120
 121     bool hasInterval(unsigned Reg) const {
 122       return VirtRegIntervals.inBounds(Reg) && VirtRegIntervals[Reg];
 123     }
 124
 125     // Interval creation.
 126     LiveInterval &createEmptyInterval(unsigned Reg) {
 127       assert(!hasInterval(Reg) && "Interval already exists!");
 128       VirtRegIntervals.grow(Reg);
 129       VirtRegIntervals[Reg] = createInterval(Reg);
 130       return *VirtRegIntervals[Reg];
 131     }
 132
 133     LiveInterval &createAndComputeVirtRegInterval(unsigned Reg) {
 134       LiveInterval &LI = createEmptyInterval(Reg);
 135       computeVirtRegInterval(LI);
 136       return LI;
 137     }
 138
 139     // Interval removal.
 140     void removeInterval(unsigned Reg) {
 141       delete VirtRegIntervals[Reg];
 142       VirtRegIntervals[Reg] = nullptr;
 143     }
 144
 145     /// Given a register and an instruction, adds a live segment from that
 146     /// instruction to the end of its MBB.
 147     LiveInterval::Segment addSegmentToEndOfBlock(unsigned reg,
 148                                                  MachineInstr* startInst);
 149
 150     /// After removing some uses of a register, shrink its live range to just
 151     /// the remaining uses. This method does not compute reaching defs for new
 152     /// uses, and it doesn't remove dead defs.
 153     /// Dead PHIDef values are marked as unused. New dead machine instructions
 154     /// are added to the dead vector. Returns true if the interval may have been
 155     /// separated into multiple connected components.
 156     bool shrinkToUses(LiveInterval *li,
 157                       SmallVectorImpl<MachineInstr*> *dead = nullptr);
 158
 159     /// Specialized version of
 160     /// shrinkToUses(LiveInterval *li, SmallVectorImpl<MachineInstr*> *dead)
 161     /// that works on a subregister live range and only looks at uses matching
 162     /// the lane mask of the subregister range.
 163     /// This may leave the subrange empty which needs to be cleaned up with
 164     /// LiveInterval::removeEmptySubranges() afterwards.
 165     void shrinkToUses(LiveInterval::SubRange &SR, unsigned Reg);
 166
 167     /// extendToIndices - Extend the live range of LI to reach all points in
 168     /// Indices. The points in the Indices array must be jointly dominated by
 169     /// existing defs in LI. PHI-defs are added as needed to maintain SSA form.
 170     ///
 171     /// If a SlotIndex in Indices is the end index of a basic block, LI will be
 172     /// extended to be live out of the basic block.
 173     ///
 174     /// See also LiveRangeCalc::extend().
 175     void extendToIndices(LiveRange &LR, ArrayRef<SlotIndex> Indices);
 176
 177
 178     /// If @p LR has a live value at @p Kill, prune its live range by removing
 179     /// any liveness reachable from Kill. Add live range end points to
 180     /// EndPoints such that extendToIndices(LI, EndPoints) will reconstruct the
 181     /// value's live range.
 182     ///
 183     /// Calling pruneValue() and extendToIndices() can be used to reconstruct
 184     /// SSA form after adding defs to a virtual register.
 185     void pruneValue(LiveRange &LR, SlotIndex Kill,
 186                     SmallVectorImpl<SlotIndex> *EndPoints);
 187
 188     SlotIndexes *getSlotIndexes() const {
 189       return Indexes;
 190     }
 191
 192     AliasAnalysis *getAliasAnalysis() const {
 193       return AA;
 194     }
 195
 196     /// isNotInMIMap - returns true if the specified machine instr has been
 197     /// removed or was never entered in the map.
 198     bool isNotInMIMap(const MachineInstr* Instr) const {
 199       return !Indexes->hasIndex(Instr);
 200     }
 201
 202     /// Returns the base index of the given instruction.
 203     SlotIndex getInstructionIndex(const MachineInstr *instr) const {
 204       return Indexes->getInstructionIndex(instr);
 205     }
 206
 207     /// Returns the instruction associated with the given index.
 208     MachineInstr* getInstructionFromIndex(SlotIndex index) const {
 209       return Indexes->getInstructionFromIndex(index);
 210     }
 211
 212     /// Return the first index in the given basic block.
 213     SlotIndex getMBBStartIdx(const MachineBasicBlock *mbb) const {
 214       return Indexes->getMBBStartIdx(mbb);
 215     }
 216
 217     /// Return the last index in the given basic block.
 218     SlotIndex getMBBEndIdx(const MachineBasicBlock *mbb) const {
 219       return Indexes->getMBBEndIdx(mbb);
 220     }
 221
 222     bool isLiveInToMBB(const LiveRange &LR,
 223                        const MachineBasicBlock *mbb) const {
 224       return LR.liveAt(getMBBStartIdx(mbb));
 225     }
 226
 227     bool isLiveOutOfMBB(const LiveRange &LR,
 228                         const MachineBasicBlock *mbb) const {
 229       return LR.liveAt(getMBBEndIdx(mbb).getPrevSlot());
 230     }
 231
 232     MachineBasicBlock* getMBBFromIndex(SlotIndex index) const {
 233       return Indexes->getMBBFromIndex(index);
 234     }
 235
 236     void insertMBBInMaps(MachineBasicBlock *MBB) {
 237       Indexes->insertMBBInMaps(MBB);
 238       assert(unsigned(MBB->getNumber()) == RegMaskBlocks.size() &&
 239              "Blocks must be added in order.");
 240       RegMaskBlocks.push_back(std::make_pair(RegMaskSlots.size(), 0));
 241     }
 242
 243     SlotIndex InsertMachineInstrInMaps(MachineInstr *MI) {
 244       return Indexes->insertMachineInstrInMaps(MI);
 245     }
 246
 247     void InsertMachineInstrRangeInMaps(MachineBasicBlock::iterator B,
 248                                        MachineBasicBlock::iterator E) {
 249       for (MachineBasicBlock::iterator I = B; I != E; ++I)
 250         Indexes->insertMachineInstrInMaps(I);
 251     }
 252
 253     void RemoveMachineInstrFromMaps(MachineInstr *MI) {
 254       Indexes->removeMachineInstrFromMaps(MI);
 255     }
 256
 257     void ReplaceMachineInstrInMaps(MachineInstr *MI, MachineInstr *NewMI) {
 258       Indexes->replaceMachineInstrInMaps(MI, NewMI);
 259     }
 260
 261     bool findLiveInMBBs(SlotIndex Start, SlotIndex End,
 262                         SmallVectorImpl<MachineBasicBlock*> &MBBs) const {
 263       return Indexes->findLiveInMBBs(Start, End, MBBs);
 264     }
 265
 266     VNInfo::Allocator& getVNInfoAllocator() { return VNInfoAllocator; }
 267
 268     void getAnalysisUsage(AnalysisUsage &AU) const override;
 269     void releaseMemory() override;
 270
 271     /// runOnMachineFunction - pass entry point
 272     bool runOnMachineFunction(MachineFunction&) override;
 273
 274     /// print - Implement the dump method.
 275     void print(raw_ostream &O, const Module* = nullptr) const override;
 276
 277     /// intervalIsInOneMBB - If LI is confined to a single basic block, return
 278     /// a pointer to that block.  If LI is live in to or out of any block,
 279     /// return NULL.
 280     MachineBasicBlock *intervalIsInOneMBB(const LiveInterval &LI) const;
 281
 282     /// Returns true if VNI is killed by any PHI-def values in LI.
 283     /// This may conservatively return true to avoid expensive computations.
 284     bool hasPHIKill(const LiveInterval &LI, const VNInfo *VNI) const;
 285
 286     /// addKillFlags - Add kill flags to any instruction that kills a virtual
 287     /// register.
 288     void addKillFlags(const VirtRegMap*);
 289
 290     /// handleMove - call this method to notify LiveIntervals that
 291     /// instruction 'mi' has been moved within a basic block. This will update
 292     /// the live intervals for all operands of mi. Moves between basic blocks
 293     /// are not supported.
 294     ///
 295     /// \param UpdateFlags Update live intervals for nonallocatable physregs.
 296     void handleMove(MachineInstr* MI, bool UpdateFlags = false);
 297
 298     /// moveIntoBundle - Update intervals for operands of MI so that they
 299     /// begin/end on the SlotIndex for BundleStart.
 300     ///
 301     /// \param UpdateFlags Update live intervals for nonallocatable physregs.
 302     ///
 303     /// Requires MI and BundleStart to have SlotIndexes, and assumes
 304     /// existing liveness is accurate. BundleStart should be the first
 305     /// instruction in the Bundle.
 306     void handleMoveIntoBundle(MachineInstr* MI, MachineInstr* BundleStart,
 307                               bool UpdateFlags = false);
 308
 309     /// repairIntervalsInRange - Update live intervals for instructions in a
 310     /// range of iterators. It is intended for use after target hooks that may
 311     /// insert or remove instructions, and is only efficient for a small number
 312     /// of instructions.
 313     ///
 314     /// OrigRegs is a vector of registers that were originally used by the
 315     /// instructions in the range between the two iterators.
 316     ///
 317     /// Currently, the only only changes that are supported are simple removal
 318     /// and addition of uses.
 319     void repairIntervalsInRange(MachineBasicBlock *MBB,
 320                                 MachineBasicBlock::iterator Begin,
 321                                 MachineBasicBlock::iterator End,
 322                                 ArrayRef<unsigned> OrigRegs);
 323
 324     // Register mask functions.
 325     //
 326     // Machine instructions may use a register mask operand to indicate that a
 327     // large number of registers are clobbered by the instruction.  This is
 328     // typically used for calls.
 329     //
 330     // For compile time performance reasons, these clobbers are not recorded in
 331     // the live intervals for individual physical registers.  Instead,
 332     // LiveIntervalAnalysis maintains a sorted list of instructions with
 333     // register mask operands.
 334
 335     /// getRegMaskSlots - Returns a sorted array of slot indices of all
 336     /// instructions with register mask operands.
 337     ArrayRef<SlotIndex> getRegMaskSlots() const { return RegMaskSlots; }
 338
 339     /// getRegMaskSlotsInBlock - Returns a sorted array of slot indices of all
 340     /// instructions with register mask operands in the basic block numbered
 341     /// MBBNum.
 342     ArrayRef<SlotIndex> getRegMaskSlotsInBlock(unsigned MBBNum) const {
 343       std::pair<unsigned, unsigned> P = RegMaskBlocks[MBBNum];
 344       return getRegMaskSlots().slice(P.first, P.second);
 345     }
 346
 347     /// getRegMaskBits() - Returns an array of register mask pointers
 348     /// corresponding to getRegMaskSlots().
 349     ArrayRef<const uint32_t*> getRegMaskBits() const { return RegMaskBits; }
 350
 351     /// getRegMaskBitsInBlock - Returns an array of mask pointers corresponding
 352     /// to getRegMaskSlotsInBlock(MBBNum).
 353     ArrayRef<const uint32_t*> getRegMaskBitsInBlock(unsigned MBBNum) const {
 354       std::pair<unsigned, unsigned> P = RegMaskBlocks[MBBNum];
 355       return getRegMaskBits().slice(P.first, P.second);
 356     }
 357
 358     /// checkRegMaskInterference - Test if LI is live across any register mask
 359     /// instructions, and compute a bit mask of physical registers that are not
 360     /// clobbered by any of them.
 361     ///
 362     /// Returns false if LI doesn't cross any register mask instructions. In
 363     /// that case, the bit vector is not filled in.
 364     bool checkRegMaskInterference(LiveInterval &LI,
 365                                   BitVector &UsableRegs);
 366
 367     // Register unit functions.
 368     //
 369     // Fixed interference occurs when MachineInstrs use physregs directly
 370     // instead of virtual registers. This typically happens when passing
 371     // arguments to a function call, or when instructions require operands in
 372     // fixed registers.
 373     //
 374     // Each physreg has one or more register units, see MCRegisterInfo. We
 375     // track liveness per register unit to handle aliasing registers more
 376     // efficiently.
 377
 378     /// getRegUnit - Return the live range for Unit.
 379     /// It will be computed if it doesn't exist.
 380     LiveRange &getRegUnit(unsigned Unit) {
 381       LiveRange *LR = RegUnitRanges[Unit];
 382       if (!LR) {
 383         // Compute missing ranges on demand.
 384         // Use segment set to speed-up initial computation of the live range.
 385         RegUnitRanges[Unit] = LR = new LiveRange(UseSegmentSetForPhysRegs);
 386         computeRegUnitRange(*LR, Unit);
 387       }
 388       return *LR;
 389     }
 390
 391     /// getCachedRegUnit - Return the live range for Unit if it has already
 392     /// been computed, or NULL if it hasn't been computed yet.
 393     LiveRange *getCachedRegUnit(unsigned Unit) {
 394       return RegUnitRanges[Unit];
 395     }
 396
 397     const LiveRange *getCachedRegUnit(unsigned Unit) const {
 398       return RegUnitRanges[Unit];
 399     }
 400
 401     /// Remove value numbers and related live segments starting at position
 402     /// @p Pos that are part of any liverange of physical register @p Reg or one
 403     /// of its subregisters.
 404     void removePhysRegDefAt(unsigned Reg, SlotIndex Pos);
 405
 406     /// Remove value number and related live segments of @p LI and its subranges
 407     /// that start at position @p Pos.
 408     void removeVRegDefAt(LiveInterval &LI, SlotIndex Pos);
 409
 410   private:
 411     /// Compute live intervals for all virtual registers.
 412     void computeVirtRegs();
 413
 414     /// Compute RegMaskSlots and RegMaskBits.
 415     void computeRegMasks();
 416
 417     /// Walk the values in @p LI and check for dead values:
 418     /// - Dead PHIDef values are marked as unused.
 419     /// - Dead operands are marked as such.
 420     /// - Completely dead machine instructions are added to the @p dead vector
 421     ///   if it is not nullptr.
 422     /// Returns true if any PHI value numbers have been removed which may
 423     /// have separated the interval into multiple connected components.
 424     bool computeDeadValues(LiveInterval &LI,
 425                            SmallVectorImpl<MachineInstr*> *dead);
 426
 427     static LiveInterval* createInterval(unsigned Reg);
 428
 429     void printInstrs(raw_ostream &O) const;
 430     void dumpInstrs() const;
 431
 432     void computeLiveInRegUnits();
 433     void computeRegUnitRange(LiveRange&, unsigned Unit);
 434     void computeVirtRegInterval(LiveInterval&);
 435
 436
 437     /// Helper function for repairIntervalsInRange(), walks backwards and
 438     /// creates/modifies live segments in @p LR to match the operands found.
 439     /// Only full operands or operands with subregisters matching @p LaneMask
 440     /// are considered.
 441     void repairOldRegInRange(MachineBasicBlock::iterator Begin,
 442                              MachineBasicBlock::iterator End,
 443                              const SlotIndex endIdx, LiveRange &LR,
 444                              unsigned Reg, unsigned LaneMask = ~0u);
 445
 446     class HMEditor;
 447   };
 448 } // End llvm namespace
 449
 450 #endif