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_LIVEINTERVAL_ANALYSIS_H
  21 #define LLVM_CODEGEN_LIVEINTERVAL_ANALYSIS_H
  22
  23 #include "llvm/Target/TargetRegisterInfo.h"
  24 #include "llvm/CodeGen/MachineBasicBlock.h"
  25 #include "llvm/CodeGen/MachineFunctionPass.h"
  26 #include "llvm/CodeGen/LiveInterval.h"
  27 #include "llvm/CodeGen/SlotIndexes.h"
  28 #include "llvm/ADT/BitVector.h"
  29 #include "llvm/ADT/IndexedMap.h"
  30 #include "llvm/ADT/SmallPtrSet.h"
  31 #include "llvm/ADT/SmallVector.h"
  32 #include "llvm/Support/Allocator.h"
  33 #include <cmath>
  34 #include <iterator>
  35
  36 namespace llvm {
  37
  38   class AliasAnalysis;
  39   class LiveRangeCalc;
  40   class LiveVariables;
  41   class MachineDominatorTree;
  42   class MachineLoopInfo;
  43   class TargetRegisterInfo;
  44   class MachineRegisterInfo;
  45   class TargetInstrInfo;
  46   class TargetRegisterClass;
  47   class VirtRegMap;
  48
  49   class LiveIntervals : public MachineFunctionPass {
  50     MachineFunction* MF;
  51     MachineRegisterInfo* MRI;
  52     const TargetMachine* TM;
  53     const TargetRegisterInfo* TRI;
  54     const TargetInstrInfo* TII;
  55     AliasAnalysis *AA;
  56     LiveVariables* LV;
  57     SlotIndexes* Indexes;
  58     MachineDominatorTree *DomTree;
  59     LiveRangeCalc *LRCalc;
  60
  61     /// Special pool allocator for VNInfo's (LiveInterval val#).
  62     ///
  63     VNInfo::Allocator VNInfoAllocator;
  64
  65     /// Live interval pointers for all the virtual registers.
  66     IndexedMap<LiveInterval*, VirtReg2IndexFunctor> VirtRegIntervals;
  67
  68     /// AllocatableRegs - A bit vector of allocatable registers.
  69     BitVector AllocatableRegs;
  70
  71     /// ReservedRegs - A bit vector of reserved registers.
  72     BitVector ReservedRegs;
  73
  74     /// RegMaskSlots - Sorted list of instructions with register mask operands.
  75     /// Always use the 'r' slot, RegMasks are normal clobbers, not early
  76     /// clobbers.
  77     SmallVector<SlotIndex, 8> RegMaskSlots;
  78
  79     /// RegMaskBits - This vector is parallel to RegMaskSlots, it holds a
  80     /// pointer to the corresponding register mask.  This pointer can be
  81     /// recomputed as:
  82     ///
  83     ///   MI = Indexes->getInstructionFromIndex(RegMaskSlot[N]);
  84     ///   unsigned OpNum = findRegMaskOperand(MI);
  85     ///   RegMaskBits[N] = MI->getOperand(OpNum).getRegMask();
  86     ///
  87     /// This is kept in a separate vector partly because some standard
  88     /// libraries don't support lower_bound() with mixed objects, partly to
  89     /// improve locality when searching in RegMaskSlots.
  90     /// Also see the comment in LiveInterval::find().
  91     SmallVector<const uint32_t*, 8> RegMaskBits;
  92
  93     /// For each basic block number, keep (begin, size) pairs indexing into the
  94     /// RegMaskSlots and RegMaskBits arrays.
  95     /// Note that basic block numbers may not be layout contiguous, that's why
  96     /// we can't just keep track of the first register mask in each basic
  97     /// block.
  98     SmallVector<std::pair<unsigned, unsigned>, 8> RegMaskBlocks;
  99
 100     /// RegUnitIntervals - Keep a live interval for each register unit as a way
 101     /// of tracking fixed physreg interference.
 102     SmallVector<LiveInterval*, 0> RegUnitIntervals;
 103
 104   public:
 105     static char ID; // Pass identification, replacement for typeid
 106     LiveIntervals();
 107     virtual ~LiveIntervals();
 108
 109     // Calculate the spill weight to assign to a single instruction.
 110     static float getSpillWeight(bool isDef, bool isUse, unsigned loopDepth);
 111
 112     LiveInterval &getInterval(unsigned Reg) {
 113       LiveInterval *LI = VirtRegIntervals[Reg];
 114       assert(LI && "Interval does not exist for virtual register");
 115       return *LI;
 116     }
 117
 118     const LiveInterval &getInterval(unsigned Reg) const {
 119       return const_cast<LiveIntervals*>(this)->getInterval(Reg);
 120     }
 121
 122     bool hasInterval(unsigned Reg) const {
 123       return VirtRegIntervals.inBounds(Reg) && VirtRegIntervals[Reg];
 124     }
 125
 126     /// isAllocatable - is the physical register reg allocatable in the current
 127     /// function?
 128     bool isAllocatable(unsigned reg) const {
 129       return AllocatableRegs.test(reg);
 130     }
 131
 132     /// isReserved - is the physical register reg reserved in the current
 133     /// function
 134     bool isReserved(unsigned reg) const {
 135       return ReservedRegs.test(reg);
 136     }
 137
 138     // Interval creation.
 139     LiveInterval &getOrCreateInterval(unsigned Reg) {
 140       if (!hasInterval(Reg)) {
 141         VirtRegIntervals.grow(Reg);
 142         VirtRegIntervals[Reg] = createInterval(Reg);
 143       }
 144       return getInterval(Reg);
 145     }
 146
 147     // Interval removal.
 148     void removeInterval(unsigned Reg) {
 149       delete VirtRegIntervals[Reg];
 150       VirtRegIntervals[Reg] = 0;
 151     }
 152
 153     /// addLiveRangeToEndOfBlock - Given a register and an instruction,
 154     /// adds a live range from that instruction to the end of its MBB.
 155     LiveRange addLiveRangeToEndOfBlock(unsigned reg,
 156                                        MachineInstr* startInst);
 157
 158     /// shrinkToUses - After removing some uses of a register, shrink its live
 159     /// range to just the remaining uses. This method does not compute reaching
 160     /// defs for new uses, and it doesn't remove dead defs.
 161     /// Dead PHIDef values are marked as unused.
 162     /// New dead machine instructions are added to the dead vector.
 163     /// Return true if the interval may have been separated into multiple
 164     /// connected components.
 165     bool shrinkToUses(LiveInterval *li,
 166                       SmallVectorImpl<MachineInstr*> *dead = 0);
 167
 168     SlotIndexes *getSlotIndexes() const {
 169       return Indexes;
 170     }
 171
 172     AliasAnalysis *getAliasAnalysis() const {
 173       return AA;
 174     }
 175
 176     /// isNotInMIMap - returns true if the specified machine instr has been
 177     /// removed or was never entered in the map.
 178     bool isNotInMIMap(const MachineInstr* Instr) const {
 179       return !Indexes->hasIndex(Instr);
 180     }
 181
 182     /// Returns the base index of the given instruction.
 183     SlotIndex getInstructionIndex(const MachineInstr *instr) const {
 184       return Indexes->getInstructionIndex(instr);
 185     }
 186
 187     /// Returns the instruction associated with the given index.
 188     MachineInstr* getInstructionFromIndex(SlotIndex index) const {
 189       return Indexes->getInstructionFromIndex(index);
 190     }
 191
 192     /// Return the first index in the given basic block.
 193     SlotIndex getMBBStartIdx(const MachineBasicBlock *mbb) const {
 194       return Indexes->getMBBStartIdx(mbb);
 195     }
 196
 197     /// Return the last index in the given basic block.
 198     SlotIndex getMBBEndIdx(const MachineBasicBlock *mbb) const {
 199       return Indexes->getMBBEndIdx(mbb);
 200     }
 201
 202     bool isLiveInToMBB(const LiveInterval &li,
 203                        const MachineBasicBlock *mbb) const {
 204       return li.liveAt(getMBBStartIdx(mbb));
 205     }
 206
 207     bool isLiveOutOfMBB(const LiveInterval &li,
 208                         const MachineBasicBlock *mbb) const {
 209       return li.liveAt(getMBBEndIdx(mbb).getPrevSlot());
 210     }
 211
 212     MachineBasicBlock* getMBBFromIndex(SlotIndex index) const {
 213       return Indexes->getMBBFromIndex(index);
 214     }
 215
 216     SlotIndex InsertMachineInstrInMaps(MachineInstr *MI) {
 217       return Indexes->insertMachineInstrInMaps(MI);
 218     }
 219
 220     void RemoveMachineInstrFromMaps(MachineInstr *MI) {
 221       Indexes->removeMachineInstrFromMaps(MI);
 222     }
 223
 224     void ReplaceMachineInstrInMaps(MachineInstr *MI, MachineInstr *NewMI) {
 225       Indexes->replaceMachineInstrInMaps(MI, NewMI);
 226     }
 227
 228     bool findLiveInMBBs(SlotIndex Start, SlotIndex End,
 229                         SmallVectorImpl<MachineBasicBlock*> &MBBs) const {
 230       return Indexes->findLiveInMBBs(Start, End, MBBs);
 231     }
 232
 233     VNInfo::Allocator& getVNInfoAllocator() { return VNInfoAllocator; }
 234
 235     virtual void getAnalysisUsage(AnalysisUsage &AU) const;
 236     virtual void releaseMemory();
 237
 238     /// runOnMachineFunction - pass entry point
 239     virtual bool runOnMachineFunction(MachineFunction&);
 240
 241     /// print - Implement the dump method.
 242     virtual void print(raw_ostream &O, const Module* = 0) const;
 243
 244     /// isReMaterializable - Returns true if every definition of MI of every
 245     /// val# of the specified interval is re-materializable. Also returns true
 246     /// by reference if all of the defs are load instructions.
 247     bool isReMaterializable(const LiveInterval &li,
 248                             const SmallVectorImpl<LiveInterval*> *SpillIs,
 249                             bool &isLoad);
 250
 251     /// intervalIsInOneMBB - If LI is confined to a single basic block, return
 252     /// a pointer to that block.  If LI is live in to or out of any block,
 253     /// return NULL.
 254     MachineBasicBlock *intervalIsInOneMBB(const LiveInterval &LI) const;
 255
 256     /// addKillFlags - Add kill flags to any instruction that kills a virtual
 257     /// register.
 258     void addKillFlags();
 259
 260     /// handleMove - call this method to notify LiveIntervals that
 261     /// instruction 'mi' has been moved within a basic block. This will update
 262     /// the live intervals for all operands of mi. Moves between basic blocks
 263     /// are not supported.
 264     void handleMove(MachineInstr* MI);
 265
 266     /// moveIntoBundle - Update intervals for operands of MI so that they
 267     /// begin/end on the SlotIndex for BundleStart.
 268     ///
 269     /// Requires MI and BundleStart to have SlotIndexes, and assumes
 270     /// existing liveness is accurate. BundleStart should be the first
 271     /// instruction in the Bundle.
 272     void handleMoveIntoBundle(MachineInstr* MI, MachineInstr* BundleStart);
 273
 274     // Register mask functions.
 275     //
 276     // Machine instructions may use a register mask operand to indicate that a
 277     // large number of registers are clobbered by the instruction.  This is
 278     // typically used for calls.
 279     //
 280     // For compile time performance reasons, these clobbers are not recorded in
 281     // the live intervals for individual physical registers.  Instead,
 282     // LiveIntervalAnalysis maintains a sorted list of instructions with
 283     // register mask operands.
 284
 285     /// getRegMaskSlots - Returns a sorted array of slot indices of all
 286     /// instructions with register mask operands.
 287     ArrayRef<SlotIndex> getRegMaskSlots() const { return RegMaskSlots; }
 288
 289     /// getRegMaskSlotsInBlock - Returns a sorted array of slot indices of all
 290     /// instructions with register mask operands in the basic block numbered
 291     /// MBBNum.
 292     ArrayRef<SlotIndex> getRegMaskSlotsInBlock(unsigned MBBNum) const {
 293       std::pair<unsigned, unsigned> P = RegMaskBlocks[MBBNum];
 294       return getRegMaskSlots().slice(P.first, P.second);
 295     }
 296
 297     /// getRegMaskBits() - Returns an array of register mask pointers
 298     /// corresponding to getRegMaskSlots().
 299     ArrayRef<const uint32_t*> getRegMaskBits() const { return RegMaskBits; }
 300
 301     /// getRegMaskBitsInBlock - Returns an array of mask pointers corresponding
 302     /// to getRegMaskSlotsInBlock(MBBNum).
 303     ArrayRef<const uint32_t*> getRegMaskBitsInBlock(unsigned MBBNum) const {
 304       std::pair<unsigned, unsigned> P = RegMaskBlocks[MBBNum];
 305       return getRegMaskBits().slice(P.first, P.second);
 306     }
 307
 308     /// checkRegMaskInterference - Test if LI is live across any register mask
 309     /// instructions, and compute a bit mask of physical registers that are not
 310     /// clobbered by any of them.
 311     ///
 312     /// Returns false if LI doesn't cross any register mask instructions. In
 313     /// that case, the bit vector is not filled in.
 314     bool checkRegMaskInterference(LiveInterval &LI,
 315                                   BitVector &UsableRegs);
 316
 317     // Register unit functions.
 318     //
 319     // Fixed interference occurs when MachineInstrs use physregs directly
 320     // instead of virtual registers. This typically happens when passing
 321     // arguments to a function call, or when instructions require operands in
 322     // fixed registers.
 323     //
 324     // Each physreg has one or more register units, see MCRegisterInfo. We
 325     // track liveness per register unit to handle aliasing registers more
 326     // efficiently.
 327
 328     /// getRegUnit - Return the live range for Unit.
 329     /// It will be computed if it doesn't exist.
 330     LiveInterval &getRegUnit(unsigned Unit) {
 331       LiveInterval *LI = RegUnitIntervals[Unit];
 332       if (!LI) {
 333         // Compute missing ranges on demand.
 334         RegUnitIntervals[Unit] = LI = new LiveInterval(Unit, HUGE_VALF);
 335         computeRegUnitInterval(LI);
 336       }
 337       return *LI;
 338     }
 339
 340     /// getCachedRegUnit - Return the live range for Unit if it has already
 341     /// been computed, or NULL if it hasn't been computed yet.
 342     LiveInterval *getCachedRegUnit(unsigned Unit) {
 343       return RegUnitIntervals[Unit];
 344     }
 345
 346   private:
 347     /// computeIntervals - Compute live intervals.
 348     void computeIntervals();
 349
 350     /// handleRegisterDef - update intervals for a register def
 351     /// (calls handleVirtualRegisterDef)
 352     void handleRegisterDef(MachineBasicBlock *MBB,
 353                            MachineBasicBlock::iterator MI,
 354                            SlotIndex MIIdx,
 355                            MachineOperand& MO, unsigned MOIdx);
 356
 357     /// isPartialRedef - Return true if the specified def at the specific index
 358     /// is partially re-defining the specified live interval. A common case of
 359     /// this is a definition of the sub-register.
 360     bool isPartialRedef(SlotIndex MIIdx, MachineOperand &MO,
 361                         LiveInterval &interval);
 362
 363     /// handleVirtualRegisterDef - update intervals for a virtual
 364     /// register def
 365     void handleVirtualRegisterDef(MachineBasicBlock *MBB,
 366                                   MachineBasicBlock::iterator MI,
 367                                   SlotIndex MIIdx, MachineOperand& MO,
 368                                   unsigned MOIdx,
 369                                   LiveInterval& interval);
 370
 371     static LiveInterval* createInterval(unsigned Reg);
 372
 373     void printInstrs(raw_ostream &O) const;
 374     void dumpInstrs() const;
 375
 376     void computeLiveInRegUnits();
 377     void computeRegUnitInterval(LiveInterval*);
 378
 379     class HMEditor;
 380   };
 381 } // End llvm namespace
 382
 383 #endif