Canonicalize header guards into a common format.
[oota-llvm.git] / lib / Target / X86 / X86MachineFunctionInfo.h
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/MachineFunction.h"
18
19 namespace llvm {
20
21 /// X86MachineFunctionInfo - This class is derived from MachineFunction and
22 /// contains private X86 target-specific information for each MachineFunction.
23 class X86MachineFunctionInfo : public MachineFunctionInfo {
24   virtual void anchor();
25
26   /// ForceFramePointer - True if the function is required to use of frame
27   /// pointer for reasons other than it containing dynamic allocation or
28   /// that FP eliminatation is turned off. For example, Cygwin main function
29   /// contains stack pointer re-alignment code which requires FP.
30   bool ForceFramePointer;
31
32   /// CalleeSavedFrameSize - Size of the callee-saved register portion of the
33   /// stack frame in bytes.
34   unsigned CalleeSavedFrameSize;
35
36   /// BytesToPopOnReturn - Number of bytes function pops on return (in addition
37   /// to the space used by the return address).
38   /// Used on windows platform for stdcall & fastcall name decoration
39   unsigned BytesToPopOnReturn;
40
41   /// ReturnAddrIndex - FrameIndex for return slot.
42   int ReturnAddrIndex;
43
44   /// TailCallReturnAddrDelta - The number of bytes by which return address
45   /// stack slot is moved as the result of tail call optimization.
46   int TailCallReturnAddrDelta;
47
48   /// SRetReturnReg - Some subtargets require that sret lowering includes
49   /// returning the value of the returned struct in a register. This field
50   /// holds the virtual register into which the sret argument is passed.
51   unsigned SRetReturnReg;
52
53   /// GlobalBaseReg - keeps track of the virtual register initialized for
54   /// use as the global base register. This is used for PIC in some PIC
55   /// relocation models.
56   unsigned GlobalBaseReg;
57
58   /// VarArgsFrameIndex - FrameIndex for start of varargs area.
59   int VarArgsFrameIndex;
60   /// RegSaveFrameIndex - X86-64 vararg func register save area.
61   int RegSaveFrameIndex;
62   /// VarArgsGPOffset - X86-64 vararg func int reg offset.
63   unsigned VarArgsGPOffset;
64   /// VarArgsFPOffset - X86-64 vararg func fp reg offset.
65   unsigned VarArgsFPOffset;
66   /// ArgumentStackSize - The number of bytes on stack consumed by the arguments
67   /// being passed on the stack.
68   unsigned ArgumentStackSize;
69   /// NumLocalDynamics - Number of local-dynamic TLS accesses.
70   unsigned NumLocalDynamics;
71
72 public:
73   X86MachineFunctionInfo() : ForceFramePointer(false),
74                              CalleeSavedFrameSize(0),
75                              BytesToPopOnReturn(0),
76                              ReturnAddrIndex(0),
77                              TailCallReturnAddrDelta(0),
78                              SRetReturnReg(0),
79                              GlobalBaseReg(0),
80                              VarArgsFrameIndex(0),
81                              RegSaveFrameIndex(0),
82                              VarArgsGPOffset(0),
83                              VarArgsFPOffset(0),
84                              ArgumentStackSize(0),
85                              NumLocalDynamics(0) {}
86
87   explicit X86MachineFunctionInfo(MachineFunction &MF)
88     : ForceFramePointer(false),
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
102   bool getForceFramePointer() const { return ForceFramePointer;}
103   void setForceFramePointer(bool forceFP) { ForceFramePointer = forceFP; }
104
105   unsigned getCalleeSavedFrameSize() const { return CalleeSavedFrameSize; }
106   void setCalleeSavedFrameSize(unsigned bytes) { CalleeSavedFrameSize = bytes; }
107
108   unsigned getBytesToPopOnReturn() const { return BytesToPopOnReturn; }
109   void setBytesToPopOnReturn (unsigned bytes) { BytesToPopOnReturn = bytes;}
110
111   int getRAIndex() const { return ReturnAddrIndex; }
112   void setRAIndex(int Index) { ReturnAddrIndex = Index; }
113
114   int getTCReturnAddrDelta() const { return TailCallReturnAddrDelta; }
115   void setTCReturnAddrDelta(int delta) {TailCallReturnAddrDelta = delta;}
116
117   unsigned getSRetReturnReg() const { return SRetReturnReg; }
118   void setSRetReturnReg(unsigned Reg) { SRetReturnReg = Reg; }
119
120   unsigned getGlobalBaseReg() const { return GlobalBaseReg; }
121   void setGlobalBaseReg(unsigned Reg) { GlobalBaseReg = Reg; }
122
123   int getVarArgsFrameIndex() const { return VarArgsFrameIndex; }
124   void setVarArgsFrameIndex(int Idx) { VarArgsFrameIndex = Idx; }
125
126   int getRegSaveFrameIndex() const { return RegSaveFrameIndex; }
127   void setRegSaveFrameIndex(int Idx) { RegSaveFrameIndex = Idx; }
128
129   unsigned getVarArgsGPOffset() const { return VarArgsGPOffset; }
130   void setVarArgsGPOffset(unsigned Offset) { VarArgsGPOffset = Offset; }
131
132   unsigned getVarArgsFPOffset() const { return VarArgsFPOffset; }
133   void setVarArgsFPOffset(unsigned Offset) { VarArgsFPOffset = Offset; }
134
135   unsigned getArgumentStackSize() const { return ArgumentStackSize; }
136   void setArgumentStackSize(unsigned size) { ArgumentStackSize = size; }
137
138   unsigned getNumLocalDynamicTLSAccesses() const { return NumLocalDynamics; }
139   void incNumLocalDynamicTLSAccesses() { ++NumLocalDynamics; }
140
141 };
142
143 } // End llvm namespace
144
145 #endif