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