1//===-- X86MachineFunctionInfo.h - X86 machine function info ----*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file declares X86-specific per-machine-function information.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_LIB_TARGET_X86_X86MACHINEFUNCTIONINFO_H
14#define LLVM_LIB_TARGET_X86_X86MACHINEFUNCTIONINFO_H
15
16#include "llvm/ADT/ArrayRef.h"
17#include "llvm/ADT/SmallVector.h"
18#include "llvm/CodeGen/CallingConvLower.h"
19#include "llvm/CodeGen/MachineFunction.h"
20
21namespace llvm {
22
23/// X86MachineFunctionInfo - This class is derived from MachineFunction and
24/// contains private X86 target-specific information for each MachineFunction.
25class 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 = false;
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 = 0;
39
40  /// WinEHXMMSlotInfo - Slot information of XMM registers in the stack frame
41  /// in bytes.
42  DenseMap<int, unsigned> WinEHXMMSlotInfo;
43
44  /// CalleeSavedFrameSize - Size of the callee-saved register portion of the
45  /// stack frame in bytes.
46  unsigned CalleeSavedFrameSize = 0;
47
48  /// BytesToPopOnReturn - Number of bytes function pops on return (in addition
49  /// to the space used by the return address).
50  /// Used on windows platform for stdcall & fastcall name decoration
51  unsigned BytesToPopOnReturn = 0;
52
53  /// ReturnAddrIndex - FrameIndex for return slot.
54  int ReturnAddrIndex = 0;
55
56  /// FrameIndex for return slot.
57  int FrameAddrIndex = 0;
58
59  /// TailCallReturnAddrDelta - The number of bytes by which return address
60  /// stack slot is moved as the result of tail call optimization.
61  int TailCallReturnAddrDelta = 0;
62
63  /// SRetReturnReg - Some subtargets require that sret lowering includes
64  /// returning the value of the returned struct in a register. This field
65  /// holds the virtual register into which the sret argument is passed.
66  Register SRetReturnReg;
67
68  /// GlobalBaseReg - keeps track of the virtual register initialized for
69  /// use as the global base register. This is used for PIC in some PIC
70  /// relocation models.
71  Register GlobalBaseReg;
72
73  /// VarArgsFrameIndex - FrameIndex for start of varargs area.
74  int VarArgsFrameIndex = 0;
75  /// RegSaveFrameIndex - X86-64 vararg func register save area.
76  int RegSaveFrameIndex = 0;
77  /// VarArgsGPOffset - X86-64 vararg func int reg offset.
78  unsigned VarArgsGPOffset = 0;
79  /// VarArgsFPOffset - X86-64 vararg func fp reg offset.
80  unsigned VarArgsFPOffset = 0;
81  /// ArgumentStackSize - The number of bytes on stack consumed by the arguments
82  /// being passed on the stack.
83  unsigned ArgumentStackSize = 0;
84  /// NumLocalDynamics - Number of local-dynamic TLS accesses.
85  unsigned NumLocalDynamics = 0;
86  /// HasPushSequences - Keeps track of whether this function uses sequences
87  /// of pushes to pass function parameters.
88  bool HasPushSequences = false;
89
90  /// True if the function recovers from an SEH exception, and therefore needs
91  /// to spill and restore the frame pointer.
92  bool HasSEHFramePtrSave = false;
93
94  /// The frame index of a stack object containing the original frame pointer
95  /// used to address arguments in a function using a base pointer.
96  int SEHFramePtrSaveIndex = 0;
97
98  /// True if this function has a subset of CSRs that is handled explicitly via
99  /// copies.
100  bool IsSplitCSR = false;
101
102  /// True if this function uses the red zone.
103  bool UsesRedZone = false;
104
105  /// True if this function has WIN_ALLOCA instructions.
106  bool HasWinAlloca = false;
107
108  /// True if this function has any preallocated calls.
109  bool HasPreallocatedCall = false;
110
111  ValueMap<const Value *, size_t> PreallocatedIds;
112  SmallVector<size_t, 0> PreallocatedStackSizes;
113  SmallVector<SmallVector<size_t, 4>, 0> PreallocatedArgOffsets;
114
115private:
116  /// ForwardedMustTailRegParms - A list of virtual and physical registers
117  /// that must be forwarded to every musttail call.
118  SmallVector<ForwardedRegister, 1> ForwardedMustTailRegParms;
119
120public:
121  X86MachineFunctionInfo() = default;
122
123  explicit X86MachineFunctionInfo(MachineFunction &MF) {}
124
125  bool getForceFramePointer() const { return ForceFramePointer;}
126  void setForceFramePointer(bool forceFP) { ForceFramePointer = forceFP; }
127
128  bool getHasPushSequences() const { return HasPushSequences; }
129  void setHasPushSequences(bool HasPush) { HasPushSequences = HasPush; }
130
131  bool getRestoreBasePointer() const { return RestoreBasePointerOffset!=0; }
132  void setRestoreBasePointer(const MachineFunction *MF);
133  int getRestoreBasePointerOffset() const {return RestoreBasePointerOffset; }
134
135  DenseMap<int, unsigned>& getWinEHXMMSlotInfo() { return WinEHXMMSlotInfo; }
136  const DenseMap<int, unsigned>& getWinEHXMMSlotInfo() const {
137    return WinEHXMMSlotInfo; }
138
139  unsigned getCalleeSavedFrameSize() const { return CalleeSavedFrameSize; }
140  void setCalleeSavedFrameSize(unsigned bytes) { CalleeSavedFrameSize = bytes; }
141
142  unsigned getBytesToPopOnReturn() const { return BytesToPopOnReturn; }
143  void setBytesToPopOnReturn (unsigned bytes) { BytesToPopOnReturn = bytes;}
144
145  int getRAIndex() const { return ReturnAddrIndex; }
146  void setRAIndex(int Index) { ReturnAddrIndex = Index; }
147
148  int getFAIndex() const { return FrameAddrIndex; }
149  void setFAIndex(int Index) { FrameAddrIndex = Index; }
150
151  int getTCReturnAddrDelta() const { return TailCallReturnAddrDelta; }
152  void setTCReturnAddrDelta(int delta) {TailCallReturnAddrDelta = delta;}
153
154  Register getSRetReturnReg() const { return SRetReturnReg; }
155  void setSRetReturnReg(Register Reg) { SRetReturnReg = Reg; }
156
157  Register getGlobalBaseReg() const { return GlobalBaseReg; }
158  void setGlobalBaseReg(Register Reg) { GlobalBaseReg = Reg; }
159
160  int getVarArgsFrameIndex() const { return VarArgsFrameIndex; }
161  void setVarArgsFrameIndex(int Idx) { VarArgsFrameIndex = Idx; }
162
163  int getRegSaveFrameIndex() const { return RegSaveFrameIndex; }
164  void setRegSaveFrameIndex(int Idx) { RegSaveFrameIndex = Idx; }
165
166  unsigned getVarArgsGPOffset() const { return VarArgsGPOffset; }
167  void setVarArgsGPOffset(unsigned Offset) { VarArgsGPOffset = Offset; }
168
169  unsigned getVarArgsFPOffset() const { return VarArgsFPOffset; }
170  void setVarArgsFPOffset(unsigned Offset) { VarArgsFPOffset = Offset; }
171
172  unsigned getArgumentStackSize() const { return ArgumentStackSize; }
173  void setArgumentStackSize(unsigned size) { ArgumentStackSize = size; }
174
175  unsigned getNumLocalDynamicTLSAccesses() const { return NumLocalDynamics; }
176  void incNumLocalDynamicTLSAccesses() { ++NumLocalDynamics; }
177
178  bool getHasSEHFramePtrSave() const { return HasSEHFramePtrSave; }
179  void setHasSEHFramePtrSave(bool V) { HasSEHFramePtrSave = V; }
180
181  int getSEHFramePtrSaveIndex() const { return SEHFramePtrSaveIndex; }
182  void setSEHFramePtrSaveIndex(int Index) { SEHFramePtrSaveIndex = Index; }
183
184  SmallVectorImpl<ForwardedRegister> &getForwardedMustTailRegParms() {
185    return ForwardedMustTailRegParms;
186  }
187
188  bool isSplitCSR() const { return IsSplitCSR; }
189  void setIsSplitCSR(bool s) { IsSplitCSR = s; }
190
191  bool getUsesRedZone() const { return UsesRedZone; }
192  void setUsesRedZone(bool V) { UsesRedZone = V; }
193
194  bool hasWinAlloca() const { return HasWinAlloca; }
195  void setHasWinAlloca(bool v) { HasWinAlloca = v; }
196
197  bool hasPreallocatedCall() const { return HasPreallocatedCall; }
198  void setHasPreallocatedCall(bool v) { HasPreallocatedCall = v; }
199
200  size_t getPreallocatedIdForCallSite(const Value *CS) {
201    auto Insert = PreallocatedIds.insert({CS, PreallocatedIds.size()});
202    if (Insert.second) {
203      PreallocatedStackSizes.push_back(0);
204      PreallocatedArgOffsets.emplace_back();
205    }
206    return Insert.first->second;
207  }
208
209  void setPreallocatedStackSize(size_t Id, size_t StackSize) {
210    PreallocatedStackSizes[Id] = StackSize;
211  }
212
213  size_t getPreallocatedStackSize(const size_t Id) {
214    assert(PreallocatedStackSizes[Id] != 0 && "stack size not set");
215    return PreallocatedStackSizes[Id];
216  }
217
218  void setPreallocatedArgOffsets(size_t Id, ArrayRef<size_t> AO) {
219    PreallocatedArgOffsets[Id].assign(AO.begin(), AO.end());
220  }
221
222  const ArrayRef<size_t> getPreallocatedArgOffsets(const size_t Id) {
223    assert(!PreallocatedArgOffsets[Id].empty() && "arg offsets not set");
224    return PreallocatedArgOffsets[Id];
225  }
226};
227
228} // End llvm namespace
229
230#endif
231