Make assertIGNode be private to the InterferenceGraph.cpp file
[oota-llvm.git] / lib / Target / SparcV9 / 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 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   LiveRange* createNewLiveRange         (const Value* Def,
62                                          bool isCC = false);
63
64   LiveRange* createOrAddToLiveRange     (const Value* Def,
65                                          bool isCC = false);
66
67   void unionAndUpdateLRs                (LiveRange *L1,
68                                          LiveRange *L2);
69
70   void addInterference                  (const Instruction *Inst,
71                                          const ValueSet *LVSet);
72   
73   void suggestRegs4CallRets             ();
74
75   const Function *getMethod             () const { return Meth; }
76
77 public:
78   
79   LiveRangeInfo(const Function *F, 
80                 const TargetMachine& tm,
81                 std::vector<RegClass *> & RCList);
82
83
84   // Destructor to destroy all LiveRanges in the LiveRange Map
85   ~LiveRangeInfo();
86
87   // Main entry point for live range construction
88   //
89   void constructLiveRanges();
90   
91   // return the common live range map for this method
92   //
93   inline const LiveRangeMapType *const getLiveRangeMap() const 
94     { return &LiveRangeMap; }
95
96   // Method sed to get the corresponding live range of a Value
97   //
98   inline LiveRange *getLiveRangeForValue( const Value *const Val) 
99     { return LiveRangeMap[Val]; }
100
101   // Method used to get the Call and Return instruction list
102   //
103   inline  CallRetInstrListType &getCallRetInstrList() {
104     return CallRetInstrList;
105   }
106
107   // Method for coalescing live ranges. Called only after interference info
108   // is calculated.
109   //
110   void coalesceLRs();  
111
112   // debugging method to print the live ranges
113   //
114   void printLiveRanges();
115 };
116
117 #endif