1 //===-- X86MachineFuctionInfo.h - X86 machine function info -----*- 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 declares X86-specific per-machine-function information.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_LIB_TARGET_X86_X86MACHINEFUNCTIONINFO_H
15 #define LLVM_LIB_TARGET_X86_X86MACHINEFUNCTIONINFO_H
16 
17 #include "llvm/CodeGen/CallingConvLower.h"
18 #include "llvm/CodeGen/MachineFunction.h"
19 #include "llvm/CodeGen/MachineValueType.h"
20 #include <vector>
21 
22 namespace llvm {
23 
24 /// X86MachineFunctionInfo - This class is derived from MachineFunction and
25 /// contains private X86 target-specific information for each MachineFunction.
26 class X86MachineFunctionInfo : public MachineFunctionInfo {
27   virtual void anchor();
28 
29   /// ForceFramePointer - True if the function is required to use of frame
30   /// pointer for reasons other than it containing dynamic allocation or
31   /// that FP eliminatation is turned off. For example, Cygwin main function
32   /// contains stack pointer re-alignment code which requires FP.
33   bool ForceFramePointer;
34 
35   /// RestoreBasePointerOffset - Non-zero if the function has base pointer
36   /// and makes call to llvm.eh.sjlj.setjmp. When non-zero, the value is a
37   /// displacement from the frame pointer to a slot where the base pointer
38   /// is stashed.
39   signed char RestoreBasePointerOffset;
40 
41   /// CalleeSavedFrameSize - Size of the callee-saved register portion of the
42   /// stack frame in bytes.
43   unsigned CalleeSavedFrameSize;
44 
45   /// BytesToPopOnReturn - Number of bytes function pops on return (in addition
46   /// to the space used by the return address).
47   /// Used on windows platform for stdcall & fastcall name decoration
48   unsigned BytesToPopOnReturn;
49 
50   /// ReturnAddrIndex - FrameIndex for return slot.
51   int ReturnAddrIndex;
52 
53   /// TailCallReturnAddrDelta - The number of bytes by which return address
54   /// stack slot is moved as the result of tail call optimization.
55   int TailCallReturnAddrDelta;
56 
57   /// SRetReturnReg - Some subtargets require that sret lowering includes
58   /// returning the value of the returned struct in a register. This field
59   /// holds the virtual register into which the sret argument is passed.
60   unsigned SRetReturnReg;
61 
62   /// GlobalBaseReg - keeps track of the virtual register initialized for
63   /// use as the global base register. This is used for PIC in some PIC
64   /// relocation models.
65   unsigned GlobalBaseReg;
66 
67   /// VarArgsFrameIndex - FrameIndex for start of varargs area.
68   int VarArgsFrameIndex;
69   /// RegSaveFrameIndex - X86-64 vararg func register save area.
70   int RegSaveFrameIndex;
71   /// VarArgsGPOffset - X86-64 vararg func int reg offset.
72   unsigned VarArgsGPOffset;
73   /// VarArgsFPOffset - X86-64 vararg func fp reg offset.
74   unsigned VarArgsFPOffset;
75   /// ArgumentStackSize - The number of bytes on stack consumed by the arguments
76   /// being passed on the stack.
77   unsigned ArgumentStackSize;
78   /// NumLocalDynamics - Number of local-dynamic TLS accesses.
79   unsigned NumLocalDynamics;
80 
81 private:
82   /// ForwardedMustTailRegParms - A list of virtual and physical registers
83   /// that must be forwarded to every musttail call.
84   SmallVector<ForwardedRegister, 1> ForwardedMustTailRegParms;
85 
86 public:
X86MachineFunctionInfo()87   X86MachineFunctionInfo() : ForceFramePointer(false),
88                              RestoreBasePointerOffset(0),
89                              CalleeSavedFrameSize(0),
90                              BytesToPopOnReturn(0),
91                              ReturnAddrIndex(0),
92                              TailCallReturnAddrDelta(0),
93                              SRetReturnReg(0),
94                              GlobalBaseReg(0),
95                              VarArgsFrameIndex(0),
96                              RegSaveFrameIndex(0),
97                              VarArgsGPOffset(0),
98                              VarArgsFPOffset(0),
99                              ArgumentStackSize(0),
100                              NumLocalDynamics(0) {}
101 
X86MachineFunctionInfo(MachineFunction & MF)102   explicit X86MachineFunctionInfo(MachineFunction &MF)
103     : ForceFramePointer(false),
104       RestoreBasePointerOffset(0),
105       CalleeSavedFrameSize(0),
106       BytesToPopOnReturn(0),
107       ReturnAddrIndex(0),
108       TailCallReturnAddrDelta(0),
109       SRetReturnReg(0),
110       GlobalBaseReg(0),
111       VarArgsFrameIndex(0),
112       RegSaveFrameIndex(0),
113       VarArgsGPOffset(0),
114       VarArgsFPOffset(0),
115       ArgumentStackSize(0),
116       NumLocalDynamics(0) {}
117 
getForceFramePointer()118   bool getForceFramePointer() const { return ForceFramePointer;}
setForceFramePointer(bool forceFP)119   void setForceFramePointer(bool forceFP) { ForceFramePointer = forceFP; }
120 
getRestoreBasePointer()121   bool getRestoreBasePointer() const { return RestoreBasePointerOffset!=0; }
122   void setRestoreBasePointer(const MachineFunction *MF);
getRestoreBasePointerOffset()123   int getRestoreBasePointerOffset() const {return RestoreBasePointerOffset; }
124 
getCalleeSavedFrameSize()125   unsigned getCalleeSavedFrameSize() const { return CalleeSavedFrameSize; }
setCalleeSavedFrameSize(unsigned bytes)126   void setCalleeSavedFrameSize(unsigned bytes) { CalleeSavedFrameSize = bytes; }
127 
getBytesToPopOnReturn()128   unsigned getBytesToPopOnReturn() const { return BytesToPopOnReturn; }
setBytesToPopOnReturn(unsigned bytes)129   void setBytesToPopOnReturn (unsigned bytes) { BytesToPopOnReturn = bytes;}
130 
getRAIndex()131   int getRAIndex() const { return ReturnAddrIndex; }
setRAIndex(int Index)132   void setRAIndex(int Index) { ReturnAddrIndex = Index; }
133 
getTCReturnAddrDelta()134   int getTCReturnAddrDelta() const { return TailCallReturnAddrDelta; }
setTCReturnAddrDelta(int delta)135   void setTCReturnAddrDelta(int delta) {TailCallReturnAddrDelta = delta;}
136 
getSRetReturnReg()137   unsigned getSRetReturnReg() const { return SRetReturnReg; }
setSRetReturnReg(unsigned Reg)138   void setSRetReturnReg(unsigned Reg) { SRetReturnReg = Reg; }
139 
getGlobalBaseReg()140   unsigned getGlobalBaseReg() const { return GlobalBaseReg; }
setGlobalBaseReg(unsigned Reg)141   void setGlobalBaseReg(unsigned Reg) { GlobalBaseReg = Reg; }
142 
getVarArgsFrameIndex()143   int getVarArgsFrameIndex() const { return VarArgsFrameIndex; }
setVarArgsFrameIndex(int Idx)144   void setVarArgsFrameIndex(int Idx) { VarArgsFrameIndex = Idx; }
145 
getRegSaveFrameIndex()146   int getRegSaveFrameIndex() const { return RegSaveFrameIndex; }
setRegSaveFrameIndex(int Idx)147   void setRegSaveFrameIndex(int Idx) { RegSaveFrameIndex = Idx; }
148 
getVarArgsGPOffset()149   unsigned getVarArgsGPOffset() const { return VarArgsGPOffset; }
setVarArgsGPOffset(unsigned Offset)150   void setVarArgsGPOffset(unsigned Offset) { VarArgsGPOffset = Offset; }
151 
getVarArgsFPOffset()152   unsigned getVarArgsFPOffset() const { return VarArgsFPOffset; }
setVarArgsFPOffset(unsigned Offset)153   void setVarArgsFPOffset(unsigned Offset) { VarArgsFPOffset = Offset; }
154 
getArgumentStackSize()155   unsigned getArgumentStackSize() const { return ArgumentStackSize; }
setArgumentStackSize(unsigned size)156   void setArgumentStackSize(unsigned size) { ArgumentStackSize = size; }
157 
getNumLocalDynamicTLSAccesses()158   unsigned getNumLocalDynamicTLSAccesses() const { return NumLocalDynamics; }
incNumLocalDynamicTLSAccesses()159   void incNumLocalDynamicTLSAccesses() { ++NumLocalDynamics; }
160 
getForwardedMustTailRegParms()161   SmallVectorImpl<ForwardedRegister> &getForwardedMustTailRegParms() {
162     return ForwardedMustTailRegParms;
163   }
164 };
165 
166 } // End llvm namespace
167 
168 #endif
169