lib/Target/Mips/MipsMachineFunction.h

   1 //===-- MipsMachineFunctionInfo.h - Private data used for Mips ----*- 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 the Mips specific subclass of MachineFunctionInfo.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef MIPS_MACHINE_FUNCTION_INFO_H
  15 #define MIPS_MACHINE_FUNCTION_INFO_H
  16
  17 #include <utility>
  18 #include "llvm/ADT/SmallVector.h"
  19 #include "llvm/ADT/VectorExtras.h"
  20 #include "llvm/CodeGen/MachineFunction.h"
  21 #include "llvm/CodeGen/MachineFrameInfo.h"
  22
  23 namespace llvm {
  24
  25 /// MipsFunctionInfo - This class is derived from MachineFunction private
  26 /// Mips target-specific information for each MachineFunction.
  27 class MipsFunctionInfo : public MachineFunctionInfo {
  28
  29 private:
  30   /// At each function entry, two special bitmask directives must be emitted
  31   /// to help debugging, for CPU and FPU callee saved registers. Both need
  32   /// the negative offset from the final stack size and its higher registers
  33   /// location on the stack.
  34   int CPUTopSavedRegOff;
  35   int FPUTopSavedRegOff;
  36
  37   /// MipsFIHolder - Holds a FrameIndex and it's Stack Pointer Offset
  38   struct MipsFIHolder {
  39
  40     int FI;
  41     int SPOffset;
  42
  43     MipsFIHolder(int FrameIndex, int StackPointerOffset)
  44       : FI(FrameIndex), SPOffset(StackPointerOffset) {}
  45   };
  46
  47   /// When PIC is used the GP must be saved on the stack on the function
  48   /// prologue and must be reloaded from this stack location after every
  49   /// call. A reference to its stack location and frame index must be kept
  50   /// to be used on emitPrologue and processFunctionBeforeFrameFinalized.
  51   MipsFIHolder GPHolder;
  52
  53   /// On LowerFormalArguments the stack size is unknown, so the Stack
  54   /// Pointer Offset calculation of "not in register arguments" must be
  55   /// postponed to emitPrologue.
  56   SmallVector<MipsFIHolder, 16> FnLoadArgs;
  57   bool HasLoadArgs;
  58
  59   // When VarArgs, we must write registers back to caller stack, preserving
  60   // on register arguments. Since the stack size is unknown on
  61   // LowerFormalArguments, the Stack Pointer Offset calculation must be
  62   // postponed to emitPrologue.
  63   SmallVector<MipsFIHolder, 4> FnStoreVarArgs;
  64   bool HasStoreVarArgs;
  65
  66   /// SRetReturnReg - Some subtargets require that sret lowering includes
  67   /// returning the value of the returned struct in a register. This field
  68   /// holds the virtual register into which the sret argument is passed.
  69   unsigned SRetReturnReg;
  70
  71   /// GlobalBaseReg - keeps track of the virtual register initialized for
  72   /// use as the global base register. This is used for PIC in some PIC
  73   /// relocation models.
  74   unsigned GlobalBaseReg;
  75
  76   /// VarArgsFrameIndex - FrameIndex for start of varargs area.
  77   int VarArgsFrameIndex;
  78
  79   // Range of frame object indices.
  80   // InArgFIRange: Range of indices of all frame objects created during call to
  81   //               LowerFormalArguments.
  82   // OutArgFIRange: Range of indices of all frame objects created during call to
  83   //                LowerCall except for the frame object for restoring $gp.
  84   std::pair<int, int> InArgFIRange, OutArgFIRange;
  85   int GPFI; // Index of the frame object for restoring $gp
  86   bool HasCall; // True if function has a function call.
  87 public:
  88   MipsFunctionInfo(MachineFunction& MF)
  89   : CPUTopSavedRegOff(0),
  90     FPUTopSavedRegOff(0), GPHolder(-1,-1), HasLoadArgs(false),
  91     HasStoreVarArgs(false), SRetReturnReg(0), GlobalBaseReg(0),
  92     VarArgsFrameIndex(0), InArgFIRange(std::make_pair(-1, 0)),
  93     OutArgFIRange(std::make_pair(-1, 0)), GPFI(0), HasCall(false)
  94   {}
  95
  96   int getCPUTopSavedRegOff() const { return CPUTopSavedRegOff; }
  97   void setCPUTopSavedRegOff(int Off) { CPUTopSavedRegOff = Off; }
  98
  99   int getFPUTopSavedRegOff() const { return FPUTopSavedRegOff; }
 100   void setFPUTopSavedRegOff(int Off) { FPUTopSavedRegOff = Off; }
 101
 102   bool isInArgFI(int FI) const {
 103     return FI <= InArgFIRange.first && FI >= InArgFIRange.second;
 104   }
 105   void setLastInArgFI(int FI) { InArgFIRange.second = FI; }
 106
 107   bool isOutArgFI(int FI) const {
 108     return FI <= OutArgFIRange.first && FI >= OutArgFIRange.second;
 109   }
 110   void extendOutArgFIRange(int FirstFI, int LastFI) {
 111     if (!OutArgFIRange.second)
 112       // this must be the first time this function was called.
 113       OutArgFIRange.first = FirstFI;
 114     OutArgFIRange.second = LastFI;
 115   }
 116
 117   int getGPStackOffset() const { return GPHolder.SPOffset; }
 118   int getGPFI() const { return GPHolder.FI; }
 119   void setGPStackOffset(int Off) { GPHolder.SPOffset = Off; }
 120   void setGPFI(int FI) { GPHolder.FI = FI; }
 121   bool needGPSaveRestore() const { return GPHolder.SPOffset != -1; }
 122   bool isGPFI(int FI) const { return GPFI && GPFI == FI; }
 123
 124   bool hasLoadArgs() const { return HasLoadArgs; }
 125   bool hasStoreVarArgs() const { return HasStoreVarArgs; }
 126
 127   void recordLoadArgsFI(int FI, int SPOffset) {
 128     if (!HasLoadArgs) HasLoadArgs=true;
 129     FnLoadArgs.push_back(MipsFIHolder(FI, SPOffset));
 130   }
 131   void recordStoreVarArgsFI(int FI, int SPOffset) {
 132     if (!HasStoreVarArgs) HasStoreVarArgs=true;
 133     FnStoreVarArgs.push_back(MipsFIHolder(FI, SPOffset));
 134   }
 135
 136   void adjustLoadArgsFI(MachineFrameInfo *MFI) const {
 137     if (!hasLoadArgs()) return;
 138     for (unsigned i = 0, e = FnLoadArgs.size(); i != e; ++i)
 139       MFI->setObjectOffset( FnLoadArgs[i].FI, FnLoadArgs[i].SPOffset );
 140   }
 141   void adjustStoreVarArgsFI(MachineFrameInfo *MFI) const {
 142     if (!hasStoreVarArgs()) return;
 143     for (unsigned i = 0, e = FnStoreVarArgs.size(); i != e; ++i)
 144       MFI->setObjectOffset( FnStoreVarArgs[i].FI, FnStoreVarArgs[i].SPOffset );
 145   }
 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 Index) { VarArgsFrameIndex = Index; }
 155
 156   bool hasCall() const { return HasCall; }
 157   void setHasCall() { HasCall = true; }
 158 };
 159
 160 } // end of namespace llvm
 161
 162 #endif // MIPS_MACHINE_FUNCTION_INFO_H