lib/CodeGen/RegAlloc/LiveRangeInfo.h

   1 //===-- LiveRangeInfo.h - Track all LiveRanges for a Function ----*- C++ -*-==//
   2 //
   3 // This file contains the class LiveRangeInfo which constructs and keeps
   4 // the LiveRangMap which contains all the live ranges used in a method.
   5 //
   6 // Assumptions:
   7 //
   8 // All variables (llvm Values) are defined before they are used. However, a
   9 // constant may not be defined in the machine instruction stream if it can be
  10 // used as an immediate value within a machine instruction. However, register
  11 // allocation does not have to worry about immediate constants since they
  12 // do not require registers.
  13 //
  14 // Since an llvm Value has a list of uses associated, it is sufficient to
  15 // record only the defs in a Live Range.
  16 //
  17 //===----------------------------------------------------------------------===//
  18
  19 #ifndef LIVE_RANGE_INFO_H
  20 #define LIVE_RANGE_INFO_H
  21
  22 #include "Support/HashExtras.h"
  23 #include "llvm/Analysis/LiveVar/ValueSet.h"
  24
  25 class LiveRange;
  26 class MachineInstr;
  27 class RegClass;
  28 class MachineRegInfo;
  29 class TargetMachine;
  30 class Value;
  31 class Function;
  32 class Instruction;
  33
  34 typedef std::hash_map<const Value*, LiveRange*> LiveRangeMapType;
  35 typedef std::vector<MachineInstr*> CallRetInstrListType;
  36
  37 //----------------------------------------------------------------------------
  38 // Class LiveRangeInfo
  39 //
  40 // Constructs and keeps the LiveRangMap which contains all the live
  41 // ranges used in a method. Also contain methods to coalesce live ranges.
  42 //----------------------------------------------------------------------------
  43
  44 class LiveRangeInfo {
  45   const Function *const Meth;       // Func for which live range info is held
  46   LiveRangeMapType  LiveRangeMap;   // A map from Value * to LiveRange * to
  47                                     // record all live ranges in a method
  48                                     // created by constructLiveRanges
  49
  50   const TargetMachine& TM;          // target machine description
  51
  52   std::vector<RegClass *> & RegClassList;// vector containing register classess
  53
  54   const MachineRegInfo& MRI;        // machine reg info
  55
  56   CallRetInstrListType  CallRetInstrList;  // a list of all call/ret instrs
  57
  58
  59   //------------ Private methods (see LiveRangeInfo.cpp for description)-------
  60
  61   void unionAndUpdateLRs(LiveRange *L1, LiveRange *L2);
  62
  63   void addInterference(const Instruction *Inst, const ValueSet *LVSet);
  64
  65   void suggestRegs4CallRets();
  66
  67   const Function *getMethod() { return Meth; }
  68
  69 public:
  70
  71   LiveRangeInfo(const Function *F,
  72                 const TargetMachine& tm,
  73                 std::vector<RegClass *> & RCList);
  74
  75
  76   // Destructor to destroy all LiveRanges in the LiveRange Map
  77   ~LiveRangeInfo();
  78
  79   // Main entry point for live range construction
  80   //
  81   void constructLiveRanges();
  82
  83   // This method is used to add a live range created elsewhere (e.g.,
  84   // in machine specific code) to the common live range map
  85   //
  86   inline void addLRToMap(const Value *Val, LiveRange *LR) {
  87     assert(Val && LR && "Val/LR is NULL!\n");
  88     assert((!LiveRangeMap[Val]) && "LR already set in map");
  89     LiveRangeMap[Val] = LR;
  90   }
  91
  92   // return the common live range map for this method
  93   //
  94   inline const LiveRangeMapType *const getLiveRangeMap() const
  95     { return &LiveRangeMap; }
  96
  97   // Method sed to get the corresponding live range of a Value
  98   //
  99   inline LiveRange *getLiveRangeForValue( const Value *const Val)
 100     { return LiveRangeMap[Val]; }
 101
 102   // Method used to get the Call and Return instruction list
 103   //
 104   inline  CallRetInstrListType &getCallRetInstrList() {
 105     return CallRetInstrList;
 106   }
 107
 108   // Method for coalescing live ranges. Called only after interference info
 109   // is calculated.
 110   //
 111   void coalesceLRs();
 112
 113   // debugging method to print the live ranges
 114   //
 115   void printLiveRanges();
 116 };
 117
 118 #endif