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/MachineFunctionPass.h"
  24 #include "llvm/CodeGen/LiveInterval.h"
  25 #include "llvm/ADT/BitVector.h"
  26 #include "llvm/ADT/DenseMap.h"
  27 #include "llvm/ADT/SmallPtrSet.h"
  28 #include "llvm/ADT/SmallVector.h"
  29 #include "llvm/Support/Allocator.h"
  30 #include <cmath>
  31 #include <map>
  32
  33 namespace llvm {
  34
  35   class LiveVariables;
  36   class MachineLoopInfo;
  37   class TargetRegisterInfo;
  38   class MachineRegisterInfo;
  39   class TargetInstrInfo;
  40   class TargetRegisterClass;
  41   class VirtRegMap;
  42   typedef std::pair<unsigned, MachineBasicBlock*> IdxMBBPair;
  43
  44   inline bool operator<(unsigned V, const IdxMBBPair &IM) {
  45     return V < IM.first;
  46   }
  47
  48   inline bool operator<(const IdxMBBPair &IM, unsigned V) {
  49     return IM.first < V;
  50   }
  51
  52   struct Idx2MBBCompare {
  53     bool operator()(const IdxMBBPair &LHS, const IdxMBBPair &RHS) const {
  54       return LHS.first < RHS.first;
  55     }
  56   };
  57
  58   class LiveIntervals : public MachineFunctionPass {
  59     MachineFunction* mf_;
  60     MachineRegisterInfo* mri_;
  61     const TargetMachine* tm_;
  62     const TargetRegisterInfo* tri_;
  63     const TargetInstrInfo* tii_;
  64     LiveVariables* lv_;
  65
  66     /// Special pool allocator for VNInfo's (LiveInterval val#).
  67     ///
  68     BumpPtrAllocator VNInfoAllocator;
  69
  70     /// MBB2IdxMap - The indexes of the first and last instructions in the
  71     /// specified basic block.
  72     std::vector<std::pair<unsigned, unsigned> > MBB2IdxMap;
  73
  74     /// Idx2MBBMap - Sorted list of pairs of index of first instruction
  75     /// and MBB id.
  76     std::vector<IdxMBBPair> Idx2MBBMap;
  77
  78     typedef std::map<MachineInstr*, unsigned> Mi2IndexMap;
  79     Mi2IndexMap mi2iMap_;
  80
  81     typedef std::vector<MachineInstr*> Index2MiMap;
  82     Index2MiMap i2miMap_;
  83
  84     typedef std::map<unsigned, LiveInterval> Reg2IntervalMap;
  85     Reg2IntervalMap r2iMap_;
  86
  87     BitVector allocatableRegs_;
  88
  89     std::vector<MachineInstr*> ClonedMIs;
  90
  91   public:
  92     static char ID; // Pass identification, replacement for typeid
  93     LiveIntervals() : MachineFunctionPass((intptr_t)&ID) {}
  94
  95     struct InstrSlots {
  96       enum {
  97         LOAD  = 0,
  98         USE   = 1,
  99         DEF   = 2,
 100         STORE = 3,
 101         NUM   = 4
 102       };
 103     };
 104
 105     static unsigned getBaseIndex(unsigned index) {
 106       return index - (index % InstrSlots::NUM);
 107     }
 108     static unsigned getBoundaryIndex(unsigned index) {
 109       return getBaseIndex(index + InstrSlots::NUM - 1);
 110     }
 111     static unsigned getLoadIndex(unsigned index) {
 112       return getBaseIndex(index) + InstrSlots::LOAD;
 113     }
 114     static unsigned getUseIndex(unsigned index) {
 115       return getBaseIndex(index) + InstrSlots::USE;
 116     }
 117     static unsigned getDefIndex(unsigned index) {
 118       return getBaseIndex(index) + InstrSlots::DEF;
 119     }
 120     static unsigned getStoreIndex(unsigned index) {
 121       return getBaseIndex(index) + InstrSlots::STORE;
 122     }
 123
 124     static float getSpillWeight(bool isDef, bool isUse, unsigned loopDepth) {
 125       return (isDef + isUse) * powf(10.0F, (float)loopDepth);
 126     }
 127
 128     typedef Reg2IntervalMap::iterator iterator;
 129     typedef Reg2IntervalMap::const_iterator const_iterator;
 130     const_iterator begin() const { return r2iMap_.begin(); }
 131     const_iterator end() const { return r2iMap_.end(); }
 132     iterator begin() { return r2iMap_.begin(); }
 133     iterator end() { return r2iMap_.end(); }
 134     unsigned getNumIntervals() const { return (unsigned)r2iMap_.size(); }
 135
 136     LiveInterval &getInterval(unsigned reg) {
 137       Reg2IntervalMap::iterator I = r2iMap_.find(reg);
 138       assert(I != r2iMap_.end() && "Interval does not exist for register");
 139       return I->second;
 140     }
 141
 142     const LiveInterval &getInterval(unsigned reg) const {
 143       Reg2IntervalMap::const_iterator I = r2iMap_.find(reg);
 144       assert(I != r2iMap_.end() && "Interval does not exist for register");
 145       return I->second;
 146     }
 147
 148     bool hasInterval(unsigned reg) const {
 149       return r2iMap_.count(reg);
 150     }
 151
 152     /// getMBBStartIdx - Return the base index of the first instruction in the
 153     /// specified MachineBasicBlock.
 154     unsigned getMBBStartIdx(MachineBasicBlock *MBB) const {
 155       return getMBBStartIdx(MBB->getNumber());
 156     }
 157     unsigned getMBBStartIdx(unsigned MBBNo) const {
 158       assert(MBBNo < MBB2IdxMap.size() && "Invalid MBB number!");
 159       return MBB2IdxMap[MBBNo].first;
 160     }
 161
 162     /// getMBBEndIdx - Return the store index of the last instruction in the
 163     /// specified MachineBasicBlock.
 164     unsigned getMBBEndIdx(MachineBasicBlock *MBB) const {
 165       return getMBBEndIdx(MBB->getNumber());
 166     }
 167     unsigned getMBBEndIdx(unsigned MBBNo) const {
 168       assert(MBBNo < MBB2IdxMap.size() && "Invalid MBB number!");
 169       return MBB2IdxMap[MBBNo].second;
 170     }
 171
 172     /// getIntervalSize - get the size of an interval in "units,"
 173     /// where every function is composed of one thousand units.  This
 174     /// measure scales properly with empty index slots in the function.
 175     unsigned getScaledIntervalSize(LiveInterval& I) const {
 176       return (1000 / InstrSlots::NUM * I.getSize()) / i2miMap_.size();
 177     }
 178
 179     /// getMBBFromIndex - given an index in any instruction of an
 180     /// MBB return a pointer the MBB
 181     MachineBasicBlock* getMBBFromIndex(unsigned index) const {
 182       std::vector<IdxMBBPair>::const_iterator I =
 183         std::lower_bound(Idx2MBBMap.begin(), Idx2MBBMap.end(), index);
 184       // Take the pair containing the index
 185       std::vector<IdxMBBPair>::const_iterator J =
 186         ((I != Idx2MBBMap.end() && I->first > index) ||
 187          (I == Idx2MBBMap.end() && Idx2MBBMap.size()>0)) ? (I-1): I;
 188
 189       assert(J != Idx2MBBMap.end() && J->first < index+1 &&
 190              index <= getMBBEndIdx(J->second) &&
 191              "index does not correspond to an MBB");
 192       return J->second;
 193     }
 194
 195     /// getInstructionIndex - returns the base index of instr
 196     unsigned getInstructionIndex(MachineInstr* instr) const {
 197       Mi2IndexMap::const_iterator it = mi2iMap_.find(instr);
 198       assert(it != mi2iMap_.end() && "Invalid instruction!");
 199       return it->second;
 200     }
 201
 202     /// getInstructionFromIndex - given an index in any slot of an
 203     /// instruction return a pointer the instruction
 204     MachineInstr* getInstructionFromIndex(unsigned index) const {
 205       index /= InstrSlots::NUM; // convert index to vector index
 206       assert(index < i2miMap_.size() &&
 207              "index does not correspond to an instruction");
 208       return i2miMap_[index];
 209     }
 210
 211     /// conflictsWithPhysRegDef - Returns true if the specified register
 212     /// is defined during the duration of the specified interval.
 213     bool conflictsWithPhysRegDef(const LiveInterval &li, VirtRegMap &vrm,
 214                                  unsigned reg);
 215
 216     /// findLiveInMBBs - Given a live range, if the value of the range
 217     /// is live in any MBB returns true as well as the list of basic blocks
 218     /// where the value is live in.
 219     bool findLiveInMBBs(const LiveRange &LR,
 220                         SmallVectorImpl<MachineBasicBlock*> &MBBs) const;
 221
 222     // Interval creation
 223
 224     LiveInterval &getOrCreateInterval(unsigned reg) {
 225       Reg2IntervalMap::iterator I = r2iMap_.find(reg);
 226       if (I == r2iMap_.end())
 227         I = r2iMap_.insert(I, std::make_pair(reg, createInterval(reg)));
 228       return I->second;
 229     }
 230
 231     /// addLiveRangeToEndOfBlock - Given a register and an instruction,
 232     /// adds a live range from that instruction to the end of its MBB.
 233     LiveRange addLiveRangeToEndOfBlock(unsigned reg,
 234                                         MachineInstr* startInst);
 235
 236     // Interval removal
 237
 238     void removeInterval(unsigned Reg) {
 239       r2iMap_.erase(Reg);
 240     }
 241
 242     /// isRemoved - returns true if the specified machine instr has been
 243     /// removed.
 244     bool isRemoved(MachineInstr* instr) const {
 245       return !mi2iMap_.count(instr);
 246     }
 247
 248     /// RemoveMachineInstrFromMaps - This marks the specified machine instr as
 249     /// deleted.
 250     void RemoveMachineInstrFromMaps(MachineInstr *MI) {
 251       // remove index -> MachineInstr and
 252       // MachineInstr -> index mappings
 253       Mi2IndexMap::iterator mi2i = mi2iMap_.find(MI);
 254       if (mi2i != mi2iMap_.end()) {
 255         i2miMap_[mi2i->second/InstrSlots::NUM] = 0;
 256         mi2iMap_.erase(mi2i);
 257       }
 258     }
 259
 260     /// ReplaceMachineInstrInMaps - Replacing a machine instr with a new one in
 261     /// maps used by register allocator.
 262     void ReplaceMachineInstrInMaps(MachineInstr *MI, MachineInstr *NewMI) {
 263       Mi2IndexMap::iterator mi2i = mi2iMap_.find(MI);
 264       if (mi2i == mi2iMap_.end())
 265         return;
 266       i2miMap_[mi2i->second/InstrSlots::NUM] = NewMI;
 267       Mi2IndexMap::iterator it = mi2iMap_.find(MI);
 268       assert(it != mi2iMap_.end() && "Invalid instruction!");
 269       unsigned Index = it->second;
 270       mi2iMap_.erase(it);
 271       mi2iMap_[NewMI] = Index;
 272     }
 273
 274     BumpPtrAllocator& getVNInfoAllocator() { return VNInfoAllocator; }
 275
 276     /// getVNInfoSourceReg - Helper function that parses the specified VNInfo
 277     /// copy field and returns the source register that defines it.
 278     unsigned getVNInfoSourceReg(const VNInfo *VNI) const;
 279
 280     virtual void getAnalysisUsage(AnalysisUsage &AU) const;
 281     virtual void releaseMemory();
 282
 283     /// runOnMachineFunction - pass entry point
 284     virtual bool runOnMachineFunction(MachineFunction&);
 285
 286     /// print - Implement the dump method.
 287     virtual void print(std::ostream &O, const Module* = 0) const;
 288     void print(std::ostream *O, const Module* M = 0) const {
 289       if (O) print(*O, M);
 290     }
 291
 292     /// addIntervalsForSpills - Create new intervals for spilled defs / uses of
 293     /// the given interval. FIXME: It also returns the weight of the spill slot
 294     /// (if any is created) by reference. This is temporary.
 295     std::vector<LiveInterval*>
 296     addIntervalsForSpills(const LiveInterval& i,
 297                           const MachineLoopInfo *loopInfo, VirtRegMap& vrm,
 298                           float &SSWeight);
 299
 300     /// spillPhysRegAroundRegDefsUses - Spill the specified physical register
 301     /// around all defs and uses of the specified interval.
 302     void spillPhysRegAroundRegDefsUses(const LiveInterval &li,
 303                                        unsigned PhysReg, VirtRegMap &vrm);
 304
 305     /// isReMaterializable - Returns true if every definition of MI of every
 306     /// val# of the specified interval is re-materializable. Also returns true
 307     /// by reference if all of the defs are load instructions.
 308     bool isReMaterializable(const LiveInterval &li, bool &isLoad);
 309
 310     /// getRepresentativeReg - Find the largest super register of the specified
 311     /// physical register.
 312     unsigned getRepresentativeReg(unsigned Reg) const;
 313
 314     /// getNumConflictsWithPhysReg - Return the number of uses and defs of the
 315     /// specified interval that conflicts with the specified physical register.
 316     unsigned getNumConflictsWithPhysReg(const LiveInterval &li,
 317                                         unsigned PhysReg) const;
 318
 319     /// computeNumbering - Compute the index numbering.
 320     void computeNumbering();
 321
 322   private:
 323     /// computeIntervals - Compute live intervals.
 324     void computeIntervals();
 325
 326     /// handleRegisterDef - update intervals for a register def
 327     /// (calls handlePhysicalRegisterDef and
 328     /// handleVirtualRegisterDef)
 329     void handleRegisterDef(MachineBasicBlock *MBB,
 330                            MachineBasicBlock::iterator MI, unsigned MIIdx,
 331                            unsigned reg);
 332
 333     /// handleVirtualRegisterDef - update intervals for a virtual
 334     /// register def
 335     void handleVirtualRegisterDef(MachineBasicBlock *MBB,
 336                                   MachineBasicBlock::iterator MI,
 337                                   unsigned MIIdx,
 338                                   LiveInterval& interval);
 339
 340     /// handlePhysicalRegisterDef - update intervals for a physical register
 341     /// def.
 342     void handlePhysicalRegisterDef(MachineBasicBlock* mbb,
 343                                    MachineBasicBlock::iterator mi,
 344                                    unsigned MIIdx,
 345                                    LiveInterval &interval,
 346                                    MachineInstr *CopyMI);
 347
 348     /// handleLiveInRegister - Create interval for a livein register.
 349     void handleLiveInRegister(MachineBasicBlock* mbb,
 350                               unsigned MIIdx,
 351                               LiveInterval &interval, bool isAlias = false);
 352
 353     /// getReMatImplicitUse - If the remat definition MI has one (for now, we
 354     /// only allow one) virtual register operand, then its uses are implicitly
 355     /// using the register. Returns the virtual register.
 356     unsigned getReMatImplicitUse(const LiveInterval &li,
 357                                  MachineInstr *MI) const;
 358
 359     /// isValNoAvailableAt - Return true if the val# of the specified interval
 360     /// which reaches the given instruction also reaches the specified use
 361     /// index.
 362     bool isValNoAvailableAt(const LiveInterval &li, MachineInstr *MI,
 363                             unsigned UseIdx) const;
 364
 365     /// isReMaterializable - Returns true if the definition MI of the specified
 366     /// val# of the specified interval is re-materializable. Also returns true
 367     /// by reference if the def is a load.
 368     bool isReMaterializable(const LiveInterval &li, const VNInfo *ValNo,
 369                             MachineInstr *MI, bool &isLoad);
 370
 371     /// tryFoldMemoryOperand - Attempts to fold either a spill / restore from
 372     /// slot / to reg or any rematerialized load into ith operand of specified
 373     /// MI. If it is successul, MI is updated with the newly created MI and
 374     /// returns true.
 375     bool tryFoldMemoryOperand(MachineInstr* &MI, VirtRegMap &vrm,
 376                               MachineInstr *DefMI, unsigned InstrIdx,
 377                               SmallVector<unsigned, 2> &Ops,
 378                               bool isSS, int Slot, unsigned Reg);
 379
 380     /// canFoldMemoryOperand - Return true if the specified load / store
 381     /// folding is possible.
 382     bool canFoldMemoryOperand(MachineInstr *MI,
 383                               SmallVector<unsigned, 2> &Ops,
 384                               bool ReMatLoadSS) const;
 385
 386     /// anyKillInMBBAfterIdx - Returns true if there is a kill of the specified
 387     /// VNInfo that's after the specified index but is within the basic block.
 388     bool anyKillInMBBAfterIdx(const LiveInterval &li, const VNInfo *VNI,
 389                               MachineBasicBlock *MBB, unsigned Idx) const;
 390
 391     /// intervalIsInOneMBB - Returns true if the specified interval is entirely
 392     /// within a single basic block.
 393     bool intervalIsInOneMBB(const LiveInterval &li) const;
 394
 395     /// hasAllocatableSuperReg - Return true if the specified physical register
 396     /// has any super register that's allocatable.
 397     bool hasAllocatableSuperReg(unsigned Reg) const;
 398
 399     /// SRInfo - Spill / restore info.
 400     struct SRInfo {
 401       int index;
 402       unsigned vreg;
 403       bool canFold;
 404       SRInfo(int i, unsigned vr, bool f) : index(i), vreg(vr), canFold(f) {};
 405     };
 406
 407     bool alsoFoldARestore(int Id, int index, unsigned vr,
 408                           BitVector &RestoreMBBs,
 409                           std::map<unsigned,std::vector<SRInfo> >&RestoreIdxes);
 410     void eraseRestoreInfo(int Id, int index, unsigned vr,
 411                           BitVector &RestoreMBBs,
 412                           std::map<unsigned,std::vector<SRInfo> >&RestoreIdxes);
 413
 414     /// handleSpilledImpDefs - Remove IMPLICIT_DEF instructions which are being
 415     /// spilled and create empty intervals for their uses.
 416     void handleSpilledImpDefs(const LiveInterval &li, VirtRegMap &vrm,
 417                               const TargetRegisterClass* rc,
 418                               std::vector<LiveInterval*> &NewLIs);
 419
 420     /// rewriteImplicitOps - Rewrite implicit use operands of MI (i.e. uses of
 421     /// interval on to-be re-materialized operands of MI) with new register.
 422     void rewriteImplicitOps(const LiveInterval &li,
 423                            MachineInstr *MI, unsigned NewVReg, VirtRegMap &vrm);
 424
 425     /// rewriteInstructionForSpills, rewriteInstructionsForSpills - Helper
 426     /// functions for addIntervalsForSpills to rewrite uses / defs for the given
 427     /// live range.
 428     bool rewriteInstructionForSpills(const LiveInterval &li, const VNInfo *VNI,
 429         bool TrySplit, unsigned index, unsigned end, MachineInstr *MI,
 430         MachineInstr *OrigDefMI, MachineInstr *DefMI, unsigned Slot, int LdSlot,
 431         bool isLoad, bool isLoadSS, bool DefIsReMat, bool CanDelete,
 432         VirtRegMap &vrm, const TargetRegisterClass* rc,
 433         SmallVector<int, 4> &ReMatIds, const MachineLoopInfo *loopInfo,
 434         unsigned &NewVReg, unsigned ImpUse, bool &HasDef, bool &HasUse,
 435         std::map<unsigned,unsigned> &MBBVRegsMap,
 436         std::vector<LiveInterval*> &NewLIs, float &SSWeight);
 437     void rewriteInstructionsForSpills(const LiveInterval &li, bool TrySplit,
 438         LiveInterval::Ranges::const_iterator &I,
 439         MachineInstr *OrigDefMI, MachineInstr *DefMI, unsigned Slot, int LdSlot,
 440         bool isLoad, bool isLoadSS, bool DefIsReMat, bool CanDelete,
 441         VirtRegMap &vrm, const TargetRegisterClass* rc,
 442         SmallVector<int, 4> &ReMatIds, const MachineLoopInfo *loopInfo,
 443         BitVector &SpillMBBs,
 444         std::map<unsigned,std::vector<SRInfo> > &SpillIdxes,
 445         BitVector &RestoreMBBs,
 446         std::map<unsigned,std::vector<SRInfo> > &RestoreIdxes,
 447         std::map<unsigned,unsigned> &MBBVRegsMap,
 448         std::vector<LiveInterval*> &NewLIs, float &SSWeight);
 449
 450     static LiveInterval createInterval(unsigned Reg);
 451
 452     void printRegName(unsigned reg) const;
 453   };
 454
 455 } // End llvm namespace
 456
 457 #endif