1 //===-- MipsMachineFunctionInfo.h - Private data used for Mips ----*- C++ -*-=//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the Mips specific subclass of MachineFunctionInfo.
12 //===----------------------------------------------------------------------===//
14 #ifndef MIPS_MACHINE_FUNCTION_INFO_H
15 #define MIPS_MACHINE_FUNCTION_INFO_H
18 #include "llvm/ADT/SmallVector.h"
19 #include "llvm/ADT/VectorExtras.h"
20 #include "llvm/CodeGen/MachineFunction.h"
21 #include "llvm/CodeGen/MachineFrameInfo.h"
25 /// MipsFunctionInfo - This class is derived from MachineFunction private
26 /// Mips target-specific information for each MachineFunction.
27 class MipsFunctionInfo : public MachineFunctionInfo {
30 /// Holds for each function where on the stack the Frame Pointer must be
31 /// saved. This is used on Prologue and Epilogue to emit FP save/restore
34 /// Holds for each function where on the stack the Return Address must be
35 /// saved. This is used on Prologue and Epilogue to emit RA save/restore
38 /// At each function entry, two special bitmask directives must be emitted
39 /// to help debugging, for CPU and FPU callee saved registers. Both need
40 /// the negative offset from the final stack size and its higher registers
41 /// location on the stack.
42 int CPUTopSavedRegOff;
43 int FPUTopSavedRegOff;
45 /// MipsFIHolder - Holds a FrameIndex and it's Stack Pointer Offset
51 MipsFIHolder(int FrameIndex, int StackPointerOffset)
52 : FI(FrameIndex), SPOffset(StackPointerOffset) {}
55 /// When PIC is used the GP must be saved on the stack on the function
56 /// prologue and must be reloaded from this stack location after every
57 /// call. A reference to its stack location and frame index must be kept
58 /// to be used on emitPrologue and processFunctionBeforeFrameFinalized.
59 MipsFIHolder GPHolder;
61 /// On LowerFormalArguments the stack size is unknown, so the Stack
62 /// Pointer Offset calculation of "not in register arguments" must be
63 /// postponed to emitPrologue.
64 SmallVector<MipsFIHolder, 16> FnLoadArgs;
67 // When VarArgs, we must write registers back to caller stack, preserving
68 // on register arguments. Since the stack size is unknown on
69 // LowerFormalArguments, the Stack Pointer Offset calculation must be
70 // postponed to emitPrologue.
71 SmallVector<MipsFIHolder, 4> FnStoreVarArgs;
74 /// SRetReturnReg - Some subtargets require that sret lowering includes
75 /// returning the value of the returned struct in a register. This field
76 /// holds the virtual register into which the sret argument is passed.
77 unsigned SRetReturnReg;
79 /// GlobalBaseReg - keeps track of the virtual register initialized for
80 /// use as the global base register. This is used for PIC in some PIC
81 /// relocation models.
82 unsigned GlobalBaseReg;
84 /// VarArgsFrameIndex - FrameIndex for start of varargs area.
85 int VarArgsFrameIndex;
87 // Range of frame object indices.
88 // InArgFIRange: Range of indices of all frame objects created during call to
89 // LowerFormalArguments.
90 // OutArgFIRange: Range of indices of all frame objects created during call to
91 // LowerCall except for the frame object for restoring $gp.
92 std::pair<int, int> InArgFIRange, OutArgFIRange;
93 int GPFI; // Index of the frame object for restoring $gp
94 bool HasCall; // True if function has a function call.
96 MipsFunctionInfo(MachineFunction& MF)
97 : FPStackOffset(0), RAStackOffset(0), CPUTopSavedRegOff(0),
98 FPUTopSavedRegOff(0), GPHolder(-1,-1), HasLoadArgs(false),
99 HasStoreVarArgs(false), SRetReturnReg(0), GlobalBaseReg(0),
100 VarArgsFrameIndex(0), InArgFIRange(std::make_pair(-1, 0)),
101 OutArgFIRange(std::make_pair(-1, 0)), GPFI(0), HasCall(false)
104 int getFPStackOffset() const { return FPStackOffset; }
105 void setFPStackOffset(int Off) { FPStackOffset = Off; }
107 int getRAStackOffset() const { return RAStackOffset; }
108 void setRAStackOffset(int Off) { RAStackOffset = Off; }
110 int getCPUTopSavedRegOff() const { return CPUTopSavedRegOff; }
111 void setCPUTopSavedRegOff(int Off) { CPUTopSavedRegOff = Off; }
113 int getFPUTopSavedRegOff() const { return FPUTopSavedRegOff; }
114 void setFPUTopSavedRegOff(int Off) { FPUTopSavedRegOff = Off; }
116 bool isInArgFI(int FI) const {
117 return FI <= InArgFIRange.first && FI >= InArgFIRange.second;
119 void setLastInArgFI(int FI) { InArgFIRange.second = FI; }
121 bool isOutArgFI(int FI) const {
122 return FI <= OutArgFIRange.first && FI >= OutArgFIRange.second;
124 void extendOutArgFIRange(int FirstFI, int LastFI) {
125 if (!OutArgFIRange.second)
126 // this must be the first time this function was called.
127 OutArgFIRange.first = FirstFI;
128 OutArgFIRange.second = LastFI;
131 int getGPStackOffset() const { return GPHolder.SPOffset; }
132 int getGPFI() const { return GPHolder.FI; }
133 void setGPStackOffset(int Off) { GPHolder.SPOffset = Off; }
134 void setGPFI(int FI) { GPHolder.FI = FI; }
135 bool needGPSaveRestore() const { return GPHolder.SPOffset != -1; }
136 bool isGPFI(int FI) const { return GPFI && GPFI == FI; }
138 bool hasLoadArgs() const { return HasLoadArgs; }
139 bool hasStoreVarArgs() const { return HasStoreVarArgs; }
141 void recordLoadArgsFI(int FI, int SPOffset) {
142 if (!HasLoadArgs) HasLoadArgs=true;
143 FnLoadArgs.push_back(MipsFIHolder(FI, SPOffset));
145 void recordStoreVarArgsFI(int FI, int SPOffset) {
146 if (!HasStoreVarArgs) HasStoreVarArgs=true;
147 FnStoreVarArgs.push_back(MipsFIHolder(FI, SPOffset));
150 void adjustLoadArgsFI(MachineFrameInfo *MFI) const {
151 if (!hasLoadArgs()) return;
152 for (unsigned i = 0, e = FnLoadArgs.size(); i != e; ++i)
153 MFI->setObjectOffset( FnLoadArgs[i].FI, FnLoadArgs[i].SPOffset );
155 void adjustStoreVarArgsFI(MachineFrameInfo *MFI) const {
156 if (!hasStoreVarArgs()) return;
157 for (unsigned i = 0, e = FnStoreVarArgs.size(); i != e; ++i)
158 MFI->setObjectOffset( FnStoreVarArgs[i].FI, FnStoreVarArgs[i].SPOffset );
161 unsigned getSRetReturnReg() const { return SRetReturnReg; }
162 void setSRetReturnReg(unsigned Reg) { SRetReturnReg = Reg; }
164 unsigned getGlobalBaseReg() const { return GlobalBaseReg; }
165 void setGlobalBaseReg(unsigned Reg) { GlobalBaseReg = Reg; }
167 int getVarArgsFrameIndex() const { return VarArgsFrameIndex; }
168 void setVarArgsFrameIndex(int Index) { VarArgsFrameIndex = Index; }
170 bool hasCall() const { return HasCall; }
171 void setHasCall() { HasCall = true; }
174 } // end of namespace llvm
176 #endif // MIPS_MACHINE_FUNCTION_INFO_H