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