include/llvm/CodeGen/LiveIntervalAnalysis.h

   1 //===-- LiveIntervalAnalysis.h - Live Interval Analysis ---------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source 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' abd 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/ADT/DenseMap.h"
  24 #include "llvm/CodeGen/MachineFunctionPass.h"
  25 #include "llvm/CodeGen/LiveInterval.h"
  26
  27 namespace llvm {
  28
  29   class LiveVariables;
  30   class MRegisterInfo;
  31   class TargetInstrInfo;
  32   class VirtRegMap;
  33
  34   class LiveIntervals : public MachineFunctionPass {
  35     MachineFunction* mf_;
  36     const TargetMachine* tm_;
  37     const MRegisterInfo* mri_;
  38     const TargetInstrInfo* tii_;
  39     LiveVariables* lv_;
  40
  41     typedef std::map<MachineInstr*, unsigned> Mi2IndexMap;
  42     Mi2IndexMap mi2iMap_;
  43
  44     typedef std::vector<MachineInstr*> Index2MiMap;
  45     Index2MiMap i2miMap_;
  46
  47     typedef std::map<unsigned, LiveInterval> Reg2IntervalMap;
  48     Reg2IntervalMap r2iMap_;
  49
  50     typedef DenseMap<unsigned> Reg2RegMap;
  51     Reg2RegMap r2rMap_;
  52
  53     std::vector<bool> allocatableRegs_;
  54
  55   public:
  56     struct CopyRec {
  57       MachineInstr *MI;
  58       unsigned SrcReg, DstReg;
  59     };
  60     CopyRec getCopyRec(MachineInstr *MI, unsigned SrcReg, unsigned DstReg) {
  61       CopyRec R;
  62       R.MI = MI;
  63       R.SrcReg = SrcReg;
  64       R.DstReg = DstReg;
  65       return R;
  66     }
  67     struct InstrSlots {
  68       enum {
  69         LOAD  = 0,
  70         USE   = 1,
  71         DEF   = 2,
  72         STORE = 3,
  73         NUM   = 4
  74       };
  75     };
  76
  77     static unsigned getBaseIndex(unsigned index) {
  78       return index - (index % InstrSlots::NUM);
  79     }
  80     static unsigned getBoundaryIndex(unsigned index) {
  81       return getBaseIndex(index + InstrSlots::NUM - 1);
  82     }
  83     static unsigned getLoadIndex(unsigned index) {
  84       return getBaseIndex(index) + InstrSlots::LOAD;
  85     }
  86     static unsigned getUseIndex(unsigned index) {
  87       return getBaseIndex(index) + InstrSlots::USE;
  88     }
  89     static unsigned getDefIndex(unsigned index) {
  90       return getBaseIndex(index) + InstrSlots::DEF;
  91     }
  92     static unsigned getStoreIndex(unsigned index) {
  93       return getBaseIndex(index) + InstrSlots::STORE;
  94     }
  95
  96     typedef Reg2IntervalMap::iterator iterator;
  97     typedef Reg2IntervalMap::const_iterator const_iterator;
  98     const_iterator begin() const { return r2iMap_.begin(); }
  99     const_iterator end() const { return r2iMap_.end(); }
 100     iterator begin() { return r2iMap_.begin(); }
 101     iterator end() { return r2iMap_.end(); }
 102     unsigned getNumIntervals() const { return r2iMap_.size(); }
 103
 104     LiveInterval &getInterval(unsigned reg) {
 105       Reg2IntervalMap::iterator I = r2iMap_.find(reg);
 106       assert(I != r2iMap_.end() && "Interval does not exist for register");
 107       return I->second;
 108     }
 109
 110     const LiveInterval &getInterval(unsigned reg) const {
 111       Reg2IntervalMap::const_iterator I = r2iMap_.find(reg);
 112       assert(I != r2iMap_.end() && "Interval does not exist for register");
 113       return I->second;
 114     }
 115
 116     /// getInstructionIndex - returns the base index of instr
 117     unsigned getInstructionIndex(MachineInstr* instr) const {
 118       Mi2IndexMap::const_iterator it = mi2iMap_.find(instr);
 119       assert(it != mi2iMap_.end() && "Invalid instruction!");
 120       return it->second;
 121     }
 122
 123     /// getInstructionFromIndex - given an index in any slot of an
 124     /// instruction return a pointer the instruction
 125     MachineInstr* getInstructionFromIndex(unsigned index) const {
 126       index /= InstrSlots::NUM; // convert index to vector index
 127       assert(index < i2miMap_.size() &&
 128              "index does not correspond to an instruction");
 129       return i2miMap_[index];
 130     }
 131
 132     std::vector<LiveInterval*> addIntervalsForSpills(const LiveInterval& i,
 133                                                      VirtRegMap& vrm,
 134                                                      int slot);
 135
 136     virtual void getAnalysisUsage(AnalysisUsage &AU) const;
 137     virtual void releaseMemory();
 138
 139     /// runOnMachineFunction - pass entry point
 140     virtual bool runOnMachineFunction(MachineFunction&);
 141
 142     /// print - Implement the dump method.
 143     virtual void print(std::ostream &O, const Module* = 0) const;
 144
 145   private:
 146     /// RemoveMachineInstrFromMaps - This marks the specified machine instr as
 147     /// deleted.
 148     void RemoveMachineInstrFromMaps(MachineInstr *MI) {
 149       // remove index -> MachineInstr and
 150       // MachineInstr -> index mappings
 151       Mi2IndexMap::iterator mi2i = mi2iMap_.find(MI);
 152       if (mi2i != mi2iMap_.end()) {
 153         i2miMap_[mi2i->second/InstrSlots::NUM] = 0;
 154         mi2iMap_.erase(mi2i);
 155       }
 156     }
 157
 158     /// computeIntervals - compute live intervals
 159     void computeIntervals();
 160
 161     /// joinIntervals - join compatible live intervals
 162     void joinIntervals();
 163
 164     /// CopyCoallesceInMBB - Coallsece copies in the specified MBB, putting
 165     /// copies that cannot yet be coallesced into the "TryAgain" list.
 166     void CopyCoallesceInMBB(MachineBasicBlock *MBB,
 167                             std::vector<CopyRec> &TryAgain);
 168     /// JoinCopy - Attempt to join intervals corresponding to SrcReg/DstReg,
 169     /// which are the src/dst of the copy instruction CopyMI.  This returns true
 170     /// if the copy was successfully coallesced away, or if it is never possible
 171     /// to coallesce these this copy, due to register constraints.  It returns
 172     /// false if it is not currently possible to coallesce this interval, but
 173     /// it may be possible if other things get coallesced.
 174     bool JoinCopy(MachineInstr *CopyMI, unsigned SrcReg, unsigned DstReg);
 175
 176     /// JoinIntervals - Attempt to join these two intervals.  On failure, this
 177     /// returns false.  Otherwise, if one of the intervals being joined is a
 178     /// physreg, this method always canonicalizes DestInt to be it.  The output
 179     /// "SrcInt" will not have been modified, so we can use this information
 180     /// below to update aliases.
 181     bool JoinIntervals(LiveInterval &LHS, LiveInterval &RHS);
 182
 183     /// SimpleJoin - Attempt to join the specified interval into this one. The
 184     /// caller of this method must guarantee that the RHS only contains a single
 185     /// value number and that the RHS is not defined by a copy from this
 186     /// interval.  This returns false if the intervals are not joinable, or it
 187     /// joins them and returns true.
 188     bool SimpleJoin(LiveInterval &LHS, LiveInterval &RHS);
 189
 190     /// handleRegisterDef - update intervals for a register def
 191     /// (calls handlePhysicalRegisterDef and
 192     /// handleVirtualRegisterDef)
 193     void handleRegisterDef(MachineBasicBlock *MBB,
 194                            MachineBasicBlock::iterator MI, unsigned MIIdx,
 195                            unsigned reg);
 196
 197     /// handleVirtualRegisterDef - update intervals for a virtual
 198     /// register def
 199     void handleVirtualRegisterDef(MachineBasicBlock *MBB,
 200                                   MachineBasicBlock::iterator MI,
 201                                   unsigned MIIdx,
 202                                   LiveInterval& interval);
 203
 204     /// handlePhysicalRegisterDef - update intervals for a physical register
 205     /// def.
 206     void handlePhysicalRegisterDef(MachineBasicBlock* mbb,
 207                                    MachineBasicBlock::iterator mi,
 208                                    unsigned MIIdx,
 209                                    LiveInterval &interval,
 210                                    unsigned SrcReg);
 211
 212     /// Return true if the two specified registers belong to different
 213     /// register classes.  The registers may be either phys or virt regs.
 214     bool differingRegisterClasses(unsigned RegA, unsigned RegB) const;
 215
 216
 217     bool AdjustCopiesBackFrom(LiveInterval &IntA, LiveInterval &IntB,
 218                               MachineInstr *CopyMI);
 219
 220     bool overlapsAliases(const LiveInterval *lhs,
 221                          const LiveInterval *rhs) const;
 222
 223     static LiveInterval createInterval(unsigned Reg);
 224
 225     LiveInterval &getOrCreateInterval(unsigned reg) {
 226       Reg2IntervalMap::iterator I = r2iMap_.find(reg);
 227       if (I == r2iMap_.end())
 228         I = r2iMap_.insert(I, std::make_pair(reg, createInterval(reg)));
 229       return I->second;
 230     }
 231
 232     /// rep - returns the representative of this register
 233     unsigned rep(unsigned Reg) {
 234       unsigned Rep = r2rMap_[Reg];
 235       if (Rep)
 236         return r2rMap_[Reg] = rep(Rep);
 237       return Reg;
 238     }
 239
 240     void printRegName(unsigned reg) const;
 241   };
 242
 243 } // End llvm namespace
 244
 245 #endif