Move several SelectionDAG-independent utility functions out of the
[oota-llvm.git] / lib / CodeGen / SelectionDAG / FunctionLoweringInfo.h
1 //===-- FunctionLoweringInfo.h - Lower functions from LLVM IR to CodeGen --===//
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 implements routines for translating functions from LLVM IR into
11 // Machine IR.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #ifndef FUNCTIONLOWERINGINFO_H
16 #define FUNCTIONLOWERINGINFO_H
17
18 #include "llvm/InlineAsm.h"
19 #include "llvm/Instructions.h"
20 #include "llvm/ADT/APInt.h"
21 #include "llvm/ADT/DenseMap.h"
22 #ifndef NDEBUG
23 #include "llvm/ADT/SmallSet.h"
24 #endif
25 #include "llvm/CodeGen/ValueTypes.h"
26 #include "llvm/CodeGen/ISDOpcodes.h"
27 #include "llvm/Support/CallSite.h"
28 #include <vector>
29
30 namespace llvm {
31
32 class AllocaInst;
33 class BasicBlock;
34 class CallInst;
35 class Function;
36 class GlobalVariable;
37 class Instruction;
38 class MachineBasicBlock;
39 class MachineFunction;
40 class MachineModuleInfo;
41 class MachineRegisterInfo;
42 class TargetLowering;
43 class Value;
44
45 //===--------------------------------------------------------------------===//
46 /// FunctionLoweringInfo - This contains information that is global to a
47 /// function that is used when lowering a region of the function.
48 ///
49 class FunctionLoweringInfo {
50 public:
51   const TargetLowering &TLI;
52   const Function *Fn;
53   MachineFunction *MF;
54   MachineRegisterInfo *RegInfo;
55
56   /// CanLowerReturn - true iff the function's return value can be lowered to
57   /// registers.
58   bool CanLowerReturn;
59
60   /// DemoteRegister - if CanLowerReturn is false, DemoteRegister is a vreg
61   /// allocated to hold a pointer to the hidden sret parameter.
62   unsigned DemoteRegister;
63
64   /// MBBMap - A mapping from LLVM basic blocks to their machine code entry.
65   DenseMap<const BasicBlock*, MachineBasicBlock *> MBBMap;
66
67   /// ValueMap - Since we emit code for the function a basic block at a time,
68   /// we must remember which virtual registers hold the values for
69   /// cross-basic-block values.
70   DenseMap<const Value*, unsigned> ValueMap;
71
72   /// StaticAllocaMap - Keep track of frame indices for fixed sized allocas in
73   /// the entry block.  This allows the allocas to be efficiently referenced
74   /// anywhere in the function.
75   DenseMap<const AllocaInst*, int> StaticAllocaMap;
76
77 #ifndef NDEBUG
78   SmallSet<const Instruction *, 8> CatchInfoLost;
79   SmallSet<const Instruction *, 8> CatchInfoFound;
80 #endif
81
82   struct LiveOutInfo {
83     unsigned NumSignBits;
84     APInt KnownOne, KnownZero;
85     LiveOutInfo() : NumSignBits(0), KnownOne(1, 0), KnownZero(1, 0) {}
86   };
87   
88   /// LiveOutRegInfo - Information about live out vregs, indexed by their
89   /// register number offset by 'FirstVirtualRegister'.
90   std::vector<LiveOutInfo> LiveOutRegInfo;
91
92   explicit FunctionLoweringInfo(const TargetLowering &TLI);
93
94   /// set - Initialize this FunctionLoweringInfo with the given Function
95   /// and its associated MachineFunction.
96   ///
97   void set(const Function &Fn, MachineFunction &MF, bool EnableFastISel);
98
99   /// clear - Clear out all the function-specific state. This returns this
100   /// FunctionLoweringInfo to an empty state, ready to be used for a
101   /// different function.
102   void clear();
103
104   unsigned MakeReg(EVT VT);
105   
106   /// isExportedInst - Return true if the specified value is an instruction
107   /// exported from its block.
108   bool isExportedInst(const Value *V) {
109     return ValueMap.count(V);
110   }
111
112   unsigned CreateRegForValue(const Value *V);
113   
114   unsigned InitializeRegForValue(const Value *V) {
115     unsigned &R = ValueMap[V];
116     assert(R == 0 && "Already initialized this value register!");
117     return R = CreateRegForValue(V);
118   }
119 };
120
121 /// AddCatchInfo - Extract the personality and type infos from an eh.selector
122 /// call, and add them to the specified machine basic block.
123 void AddCatchInfo(const CallInst &I,
124                   MachineModuleInfo *MMI, MachineBasicBlock *MBB);
125
126 /// CopyCatchInfo - Copy catch information from DestBB to SrcBB.
127 void CopyCatchInfo(const BasicBlock *SrcBB, const BasicBlock *DestBB,
128                    MachineModuleInfo *MMI, FunctionLoweringInfo &FLI);
129
130 } // end namespace llvm
131
132 #endif