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     /// CloneMIs - A list of clones as result of re-materialization.
  67     std::vector<MachineInstr*> CloneMIs;
  68
  69   public:
  70     static char ID; // Pass identification, replacement for typeid
  71     LiveIntervals() : MachineFunctionPass(&ID) {}
  72
  73     // Calculate the spill weight to assign to a single instruction.
  74     static float getSpillWeight(bool isDef, bool isUse, unsigned loopDepth);
  75
  76     // After summing the spill weights of all defs and uses, the final weight
  77     // should be normalized, dividing the weight of the interval by its size.
  78     // This encourages spilling of intervals that are large and have few uses,
  79     // and discourages spilling of small intervals with many uses.
  80     void normalizeSpillWeight(LiveInterval &li) {
  81       li.weight /= getApproximateInstructionCount(li) + 25;
  82     }
  83
  84     typedef Reg2IntervalMap::iterator iterator;
  85     typedef Reg2IntervalMap::const_iterator const_iterator;
  86     const_iterator begin() const { return r2iMap_.begin(); }
  87     const_iterator end() const { return r2iMap_.end(); }
  88     iterator begin() { return r2iMap_.begin(); }
  89     iterator end() { return r2iMap_.end(); }
  90     unsigned getNumIntervals() const { return (unsigned)r2iMap_.size(); }
  91
  92     LiveInterval &getInterval(unsigned reg) {
  93       Reg2IntervalMap::iterator I = r2iMap_.find(reg);
  94       assert(I != r2iMap_.end() && "Interval does not exist for register");
  95       return *I->second;
  96     }
  97
  98     const LiveInterval &getInterval(unsigned reg) const {
  99       Reg2IntervalMap::const_iterator I = r2iMap_.find(reg);
 100       assert(I != r2iMap_.end() && "Interval does not exist for register");
 101       return *I->second;
 102     }
 103
 104     bool hasInterval(unsigned reg) const {
 105       return r2iMap_.count(reg);
 106     }
 107
 108     /// getScaledIntervalSize - get the size of an interval in "units,"
 109     /// where every function is composed of one thousand units.  This
 110     /// measure scales properly with empty index slots in the function.
 111     double getScaledIntervalSize(LiveInterval& I) {
 112       return (1000.0 * I.getSize()) / indexes_->getIndexesLength();
 113     }
 114
 115     /// getFuncInstructionCount - Return the number of instructions in the
 116     /// current function.
 117     unsigned getFuncInstructionCount() {
 118       return indexes_->getFunctionSize();
 119     }
 120
 121     /// getApproximateInstructionCount - computes an estimate of the number
 122     /// of instructions in a given LiveInterval.
 123     unsigned getApproximateInstructionCount(LiveInterval& I) {
 124       double IntervalPercentage = getScaledIntervalSize(I) / 1000.0;
 125       return (unsigned)(IntervalPercentage * indexes_->getFunctionSize());
 126     }
 127
 128     /// conflictsWithPhysReg - Returns true if the specified register is used or
 129     /// defined during the duration of the specified interval. Copies to and
 130     /// from li.reg are allowed. This method is only able to analyze simple
 131     /// ranges that stay within a single basic block. Anything else is
 132     /// considered a conflict.
 133     bool conflictsWithPhysReg(const LiveInterval &li, VirtRegMap &vrm,
 134                               unsigned reg);
 135
 136     /// conflictsWithAliasRef - Similar to conflictsWithPhysRegRef except
 137     /// it checks for alias uses and defs.
 138     bool conflictsWithAliasRef(LiveInterval &li, unsigned Reg,
 139                                    SmallPtrSet<MachineInstr*,32> &JoinedCopies);
 140
 141     // Interval creation
 142     LiveInterval &getOrCreateInterval(unsigned reg) {
 143       Reg2IntervalMap::iterator I = r2iMap_.find(reg);
 144       if (I == r2iMap_.end())
 145         I = r2iMap_.insert(std::make_pair(reg, createInterval(reg))).first;
 146       return *I->second;
 147     }
 148
 149     /// dupInterval - Duplicate a live interval. The caller is responsible for
 150     /// managing the allocated memory.
 151     LiveInterval *dupInterval(LiveInterval *li);
 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     // Interval removal
 159
 160     void removeInterval(unsigned Reg) {
 161       DenseMap<unsigned, LiveInterval*>::iterator I = r2iMap_.find(Reg);
 162       delete I->second;
 163       r2iMap_.erase(I);
 164     }
 165
 166     SlotIndex getZeroIndex() const {
 167       return indexes_->getZeroIndex();
 168     }
 169
 170     SlotIndex getInvalidIndex() const {
 171       return indexes_->getInvalidIndex();
 172     }
 173
 174     /// isNotInMIMap - returns true if the specified machine instr has been
 175     /// removed or was never entered in the map.
 176     bool isNotInMIMap(const MachineInstr* Instr) const {
 177       return !indexes_->hasIndex(Instr);
 178     }
 179
 180     /// Returns the base index of the given instruction.
 181     SlotIndex getInstructionIndex(const MachineInstr *instr) const {
 182       return indexes_->getInstructionIndex(instr);
 183     }
 184
 185     /// Returns the instruction associated with the given index.
 186     MachineInstr* getInstructionFromIndex(SlotIndex index) const {
 187       return indexes_->getInstructionFromIndex(index);
 188     }
 189
 190     /// Return the first index in the given basic block.
 191     SlotIndex getMBBStartIdx(const MachineBasicBlock *mbb) const {
 192       return indexes_->getMBBStartIdx(mbb);
 193     }
 194
 195     /// Return the last index in the given basic block.
 196     SlotIndex getMBBEndIdx(const MachineBasicBlock *mbb) const {
 197       return indexes_->getMBBEndIdx(mbb);
 198     }
 199
 200     MachineBasicBlock* getMBBFromIndex(SlotIndex index) const {
 201       return indexes_->getMBBFromIndex(index);
 202     }
 203
 204     SlotIndex getMBBTerminatorGap(const MachineBasicBlock *mbb) {
 205       return indexes_->getTerminatorGap(mbb);
 206     }
 207
 208     SlotIndex InsertMachineInstrInMaps(MachineInstr *MI) {
 209       return indexes_->insertMachineInstrInMaps(MI);
 210     }
 211
 212     void RemoveMachineInstrFromMaps(MachineInstr *MI) {
 213       indexes_->removeMachineInstrFromMaps(MI);
 214     }
 215
 216     void ReplaceMachineInstrInMaps(MachineInstr *MI, MachineInstr *NewMI) {
 217       indexes_->replaceMachineInstrInMaps(MI, NewMI);
 218     }
 219
 220     bool findLiveInMBBs(SlotIndex Start, SlotIndex End,
 221                         SmallVectorImpl<MachineBasicBlock*> &MBBs) const {
 222       return indexes_->findLiveInMBBs(Start, End, MBBs);
 223     }
 224
 225     void renumber() {
 226       indexes_->renumberIndexes();
 227     }
 228
 229     VNInfo::Allocator& getVNInfoAllocator() { return VNInfoAllocator; }
 230
 231     virtual void getAnalysisUsage(AnalysisUsage &AU) const;
 232     virtual void releaseMemory();
 233
 234     /// runOnMachineFunction - pass entry point
 235     virtual bool runOnMachineFunction(MachineFunction&);
 236
 237     /// print - Implement the dump method.
 238     virtual void print(raw_ostream &O, const Module* = 0) const;
 239
 240     /// addIntervalsForSpills - Create new intervals for spilled defs / uses of
 241     /// the given interval. FIXME: It also returns the weight of the spill slot
 242     /// (if any is created) by reference. This is temporary.
 243     std::vector<LiveInterval*>
 244     addIntervalsForSpills(const LiveInterval& i,
 245                           SmallVectorImpl<LiveInterval*> &SpillIs,
 246                           const MachineLoopInfo *loopInfo, VirtRegMap& vrm);
 247
 248     /// spillPhysRegAroundRegDefsUses - Spill the specified physical register
 249     /// around all defs and uses of the specified interval. Return true if it
 250     /// was able to cut its interval.
 251     bool spillPhysRegAroundRegDefsUses(const LiveInterval &li,
 252                                        unsigned PhysReg, VirtRegMap &vrm);
 253
 254     /// isReMaterializable - Returns true if every definition of MI of every
 255     /// val# of the specified interval is re-materializable. Also returns true
 256     /// by reference if all of the defs are load instructions.
 257     bool isReMaterializable(const LiveInterval &li,
 258                             SmallVectorImpl<LiveInterval*> &SpillIs,
 259                             bool &isLoad);
 260
 261     /// isReMaterializable - Returns true if the definition MI of the specified
 262     /// val# of the specified interval is re-materializable.
 263     bool isReMaterializable(const LiveInterval &li, const VNInfo *ValNo,
 264                             MachineInstr *MI);
 265
 266     /// getRepresentativeReg - Find the largest super register of the specified
 267     /// physical register.
 268     unsigned getRepresentativeReg(unsigned Reg) const;
 269
 270     /// getNumConflictsWithPhysReg - Return the number of uses and defs of the
 271     /// specified interval that conflicts with the specified physical register.
 272     unsigned getNumConflictsWithPhysReg(const LiveInterval &li,
 273                                         unsigned PhysReg) const;
 274
 275     /// intervalIsInOneMBB - Returns true if the specified interval is entirely
 276     /// within a single basic block.
 277     bool intervalIsInOneMBB(const LiveInterval &li) const;
 278
 279   private:
 280     /// computeIntervals - Compute live intervals.
 281     void computeIntervals();
 282
 283     /// handleRegisterDef - update intervals for a register def
 284     /// (calls handlePhysicalRegisterDef and
 285     /// handleVirtualRegisterDef)
 286     void handleRegisterDef(MachineBasicBlock *MBB,
 287                            MachineBasicBlock::iterator MI,
 288                            SlotIndex MIIdx,
 289                            MachineOperand& MO, unsigned MOIdx);
 290
 291     /// isPartialRedef - Return true if the specified def at the specific index
 292     /// is partially re-defining the specified live interval. A common case of
 293     /// this is a definition of the sub-register.
 294     bool isPartialRedef(SlotIndex MIIdx, MachineOperand &MO,
 295                         LiveInterval &interval);
 296
 297     /// handleVirtualRegisterDef - update intervals for a virtual
 298     /// register def
 299     void handleVirtualRegisterDef(MachineBasicBlock *MBB,
 300                                   MachineBasicBlock::iterator MI,
 301                                   SlotIndex MIIdx, MachineOperand& MO,
 302                                   unsigned MOIdx,
 303                                   LiveInterval& interval);
 304
 305     /// handlePhysicalRegisterDef - update intervals for a physical register
 306     /// def.
 307     void handlePhysicalRegisterDef(MachineBasicBlock* mbb,
 308                                    MachineBasicBlock::iterator mi,
 309                                    SlotIndex MIIdx, MachineOperand& MO,
 310                                    LiveInterval &interval,
 311                                    MachineInstr *CopyMI);
 312
 313     /// handleLiveInRegister - Create interval for a livein register.
 314     void handleLiveInRegister(MachineBasicBlock* mbb,
 315                               SlotIndex MIIdx,
 316                               LiveInterval &interval, bool isAlias = false);
 317
 318     /// getReMatImplicitUse - If the remat definition MI has one (for now, we
 319     /// only allow one) virtual register operand, then its uses are implicitly
 320     /// using the register. Returns the virtual register.
 321     unsigned getReMatImplicitUse(const LiveInterval &li,
 322                                  MachineInstr *MI) const;
 323
 324     /// isValNoAvailableAt - Return true if the val# of the specified interval
 325     /// which reaches the given instruction also reaches the specified use
 326     /// index.
 327     bool isValNoAvailableAt(const LiveInterval &li, MachineInstr *MI,
 328                             SlotIndex UseIdx) const;
 329
 330     /// isReMaterializable - Returns true if the definition MI of the specified
 331     /// val# of the specified interval is re-materializable. Also returns true
 332     /// by reference if the def is a load.
 333     bool isReMaterializable(const LiveInterval &li, const VNInfo *ValNo,
 334                             MachineInstr *MI,
 335                             SmallVectorImpl<LiveInterval*> &SpillIs,
 336                             bool &isLoad);
 337
 338     /// tryFoldMemoryOperand - Attempts to fold either a spill / restore from
 339     /// slot / to reg or any rematerialized load into ith operand of specified
 340     /// MI. If it is successul, MI is updated with the newly created MI and
 341     /// returns true.
 342     bool tryFoldMemoryOperand(MachineInstr* &MI, VirtRegMap &vrm,
 343                               MachineInstr *DefMI, SlotIndex InstrIdx,
 344                               SmallVector<unsigned, 2> &Ops,
 345                               bool isSS, int FrameIndex, unsigned Reg);
 346
 347     /// canFoldMemoryOperand - Return true if the specified load / store
 348     /// folding is possible.
 349     bool canFoldMemoryOperand(MachineInstr *MI,
 350                               SmallVector<unsigned, 2> &Ops,
 351                               bool ReMatLoadSS) const;
 352
 353     /// anyKillInMBBAfterIdx - Returns true if there is a kill of the specified
 354     /// VNInfo that's after the specified index but is within the basic block.
 355     bool anyKillInMBBAfterIdx(const LiveInterval &li, const VNInfo *VNI,
 356                               MachineBasicBlock *MBB,
 357                               SlotIndex Idx) const;
 358
 359     /// hasAllocatableSuperReg - Return true if the specified physical register
 360     /// has any super register that's allocatable.
 361     bool hasAllocatableSuperReg(unsigned Reg) const;
 362
 363     /// SRInfo - Spill / restore info.
 364     struct SRInfo {
 365       SlotIndex index;
 366       unsigned vreg;
 367       bool canFold;
 368       SRInfo(SlotIndex i, unsigned vr, bool f)
 369         : index(i), vreg(vr), canFold(f) {}
 370     };
 371
 372     bool alsoFoldARestore(int Id, SlotIndex index, unsigned vr,
 373                           BitVector &RestoreMBBs,
 374                           DenseMap<unsigned,std::vector<SRInfo> >&RestoreIdxes);
 375     void eraseRestoreInfo(int Id, SlotIndex index, unsigned vr,
 376                           BitVector &RestoreMBBs,
 377                           DenseMap<unsigned,std::vector<SRInfo> >&RestoreIdxes);
 378
 379     /// handleSpilledImpDefs - Remove IMPLICIT_DEF instructions which are being
 380     /// spilled and create empty intervals for their uses.
 381     void handleSpilledImpDefs(const LiveInterval &li, VirtRegMap &vrm,
 382                               const TargetRegisterClass* rc,
 383                               std::vector<LiveInterval*> &NewLIs);
 384
 385     /// rewriteImplicitOps - Rewrite implicit use operands of MI (i.e. uses of
 386     /// interval on to-be re-materialized operands of MI) with new register.
 387     void rewriteImplicitOps(const LiveInterval &li,
 388                            MachineInstr *MI, unsigned NewVReg, VirtRegMap &vrm);
 389
 390     /// rewriteInstructionForSpills, rewriteInstructionsForSpills - Helper
 391     /// functions for addIntervalsForSpills to rewrite uses / defs for the given
 392     /// live range.
 393     bool rewriteInstructionForSpills(const LiveInterval &li, const VNInfo *VNI,
 394         bool TrySplit, SlotIndex index, SlotIndex end,
 395         MachineInstr *MI, MachineInstr *OrigDefMI, MachineInstr *DefMI,
 396         unsigned Slot, int LdSlot,
 397         bool isLoad, bool isLoadSS, bool DefIsReMat, bool CanDelete,
 398         VirtRegMap &vrm, const TargetRegisterClass* rc,
 399         SmallVector<int, 4> &ReMatIds, const MachineLoopInfo *loopInfo,
 400         unsigned &NewVReg, unsigned ImpUse, bool &HasDef, bool &HasUse,
 401         DenseMap<unsigned,unsigned> &MBBVRegsMap,
 402         std::vector<LiveInterval*> &NewLIs);
 403     void rewriteInstructionsForSpills(const LiveInterval &li, bool TrySplit,
 404         LiveInterval::Ranges::const_iterator &I,
 405         MachineInstr *OrigDefMI, MachineInstr *DefMI, unsigned Slot, int LdSlot,
 406         bool isLoad, bool isLoadSS, bool DefIsReMat, bool CanDelete,
 407         VirtRegMap &vrm, const TargetRegisterClass* rc,
 408         SmallVector<int, 4> &ReMatIds, const MachineLoopInfo *loopInfo,
 409         BitVector &SpillMBBs,
 410         DenseMap<unsigned,std::vector<SRInfo> > &SpillIdxes,
 411         BitVector &RestoreMBBs,
 412         DenseMap<unsigned,std::vector<SRInfo> > &RestoreIdxes,
 413         DenseMap<unsigned,unsigned> &MBBVRegsMap,
 414         std::vector<LiveInterval*> &NewLIs);
 415
 416     // Normalize the spill weight of all the intervals in NewLIs.
 417     void normalizeSpillWeights(std::vector<LiveInterval*> &NewLIs);
 418
 419     static LiveInterval* createInterval(unsigned Reg);
 420
 421     void printInstrs(raw_ostream &O) const;
 422     void dumpInstrs() const;
 423   };
 424 } // End llvm namespace
 425
 426 #endif