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 X86MACHINEFUNCTIONINFO_H
  15 #define 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   /// ForceFramePointer - True if the function is required to use of frame
  25   /// pointer for reasons other than it containing dynamic allocation or
  26   /// that FP eliminatation is turned off. For example, Cygwin main function
  27   /// contains stack pointer re-alignment code which requires FP.
  28   bool ForceFramePointer;
  29
  30   /// CalleeSavedFrameSize - Size of the callee-saved register portion of the
  31   /// stack frame in bytes.
  32   unsigned CalleeSavedFrameSize;
  33
  34   /// BytesToPopOnReturn - Number of bytes function pops on return (in addition
  35   /// to the space used by the return address).
  36   /// Used on windows platform for stdcall & fastcall name decoration
  37   unsigned BytesToPopOnReturn;
  38
  39   /// ReturnAddrIndex - FrameIndex for return slot.
  40   int ReturnAddrIndex;
  41
  42   /// TailCallReturnAddrDelta - The number of bytes by which return address
  43   /// stack slot is moved as the result of tail call optimization.
  44   int TailCallReturnAddrDelta;
  45
  46   /// SRetReturnReg - Some subtargets require that sret lowering includes
  47   /// returning the value of the returned struct in a register. This field
  48   /// holds the virtual register into which the sret argument is passed.
  49   unsigned SRetReturnReg;
  50
  51   /// GlobalBaseReg - keeps track of the virtual register initialized for
  52   /// use as the global base register. This is used for PIC in some PIC
  53   /// relocation models.
  54   unsigned GlobalBaseReg;
  55
  56   /// ReserveFP - whether the function should reserve the frame pointer
  57   /// when allocating, even if there may not actually be a frame pointer used.
  58   bool ReserveFP;
  59
  60   /// VarArgsFrameIndex - FrameIndex for start of varargs area.
  61   int VarArgsFrameIndex;
  62   /// RegSaveFrameIndex - X86-64 vararg func register save area.
  63   int RegSaveFrameIndex;
  64   /// VarArgsGPOffset - X86-64 vararg func int reg offset.
  65   unsigned VarArgsGPOffset;
  66   /// VarArgsFPOffset - X86-64 vararg func fp reg offset.
  67   unsigned VarArgsFPOffset;
  68   /// ArgumentStackSize - The number of bytes on stack consumed by the arguments
  69   /// being passed on the stack.
  70   unsigned ArgumentStackSize;
  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
  86   explicit X86MachineFunctionInfo(MachineFunction &MF)
  87     : ForceFramePointer(false),
  88       CalleeSavedFrameSize(0),
  89       BytesToPopOnReturn(0),
  90       ReturnAddrIndex(0),
  91       TailCallReturnAddrDelta(0),
  92       SRetReturnReg(0),
  93       GlobalBaseReg(0),
  94       ReserveFP(false),
  95       VarArgsFrameIndex(0),
  96       RegSaveFrameIndex(0),
  97       VarArgsGPOffset(0),
  98       VarArgsFPOffset(0),
  99       ArgumentStackSize(0) {}
 100
 101   bool getForceFramePointer() const { return ForceFramePointer;}
 102   void setForceFramePointer(bool forceFP) { ForceFramePointer = forceFP; }
 103
 104   unsigned getCalleeSavedFrameSize() const { return CalleeSavedFrameSize; }
 105   void setCalleeSavedFrameSize(unsigned bytes) { CalleeSavedFrameSize = bytes; }
 106
 107   unsigned getBytesToPopOnReturn() const { return BytesToPopOnReturn; }
 108   void setBytesToPopOnReturn (unsigned bytes) { BytesToPopOnReturn = bytes;}
 109
 110   int getRAIndex() const { return ReturnAddrIndex; }
 111   void setRAIndex(int Index) { ReturnAddrIndex = Index; }
 112
 113   int getTCReturnAddrDelta() const { return TailCallReturnAddrDelta; }
 114   void setTCReturnAddrDelta(int delta) {TailCallReturnAddrDelta = delta;}
 115
 116   unsigned getSRetReturnReg() const { return SRetReturnReg; }
 117   void setSRetReturnReg(unsigned Reg) { SRetReturnReg = Reg; }
 118
 119   unsigned getGlobalBaseReg() const { return GlobalBaseReg; }
 120   void setGlobalBaseReg(unsigned Reg) { GlobalBaseReg = Reg; }
 121
 122   bool getReserveFP() const { return ReserveFP; }
 123   void setReserveFP(bool reserveFP) { ReserveFP = reserveFP; }
 124
 125   int getVarArgsFrameIndex() const { return VarArgsFrameIndex; }
 126   void setVarArgsFrameIndex(int Idx) { VarArgsFrameIndex = Idx; }
 127
 128   int getRegSaveFrameIndex() const { return RegSaveFrameIndex; }
 129   void setRegSaveFrameIndex(int Idx) { RegSaveFrameIndex = Idx; }
 130
 131   unsigned getVarArgsGPOffset() const { return VarArgsGPOffset; }
 132   void setVarArgsGPOffset(unsigned Offset) { VarArgsGPOffset = Offset; }
 133
 134   unsigned getVarArgsFPOffset() const { return VarArgsFPOffset; }
 135   void setVarArgsFPOffset(unsigned Offset) { VarArgsFPOffset = Offset; }
 136
 137   unsigned getArgumentStackSize() const { return ArgumentStackSize; }
 138   void setArgumentStackSize(unsigned size) { ArgumentStackSize = size; }
 139 };
 140
 141 } // End llvm namespace
 142
 143 #endif