1 //=- AArch64MachineFunctionInfo.h - AArch64 machine function info -*- 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 AArch64-specific per-machine-function information.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_LIB_TARGET_AARCH64_AARCH64MACHINEFUNCTIONINFO_H
15 #define LLVM_LIB_TARGET_AARCH64_AARCH64MACHINEFUNCTIONINFO_H
17 #include "llvm/ADT/SmallPtrSet.h"
18 #include "llvm/ADT/SmallVector.h"
19 #include "llvm/CodeGen/MachineFunction.h"
20 #include "llvm/MC/MCLinkerOptimizationHint.h"
24 /// AArch64FunctionInfo - This class is derived from MachineFunctionInfo and
25 /// contains private AArch64-specific information for each MachineFunction.
26 class AArch64FunctionInfo final : public MachineFunctionInfo {
28 /// Number of bytes of arguments this function has on the stack. If the callee
29 /// is expected to restore the argument stack this should be a multiple of 16,
30 /// all usable during a tail call.
32 /// The alternative would forbid tail call optimisation in some cases: if we
33 /// want to transfer control from a function with 8-bytes of stack-argument
34 /// space to a function with 16-bytes then misalignment of this value would
35 /// make a stack adjustment necessary, which could not be undone by the
37 unsigned BytesInStackArgArea;
39 /// The number of bytes to restore to deallocate space for incoming
40 /// arguments. Canonically 0 in the C calling convention, but non-zero when
41 /// callee is expected to pop the args.
42 unsigned ArgumentStackToRestore;
44 /// HasStackFrame - True if this function has a stack frame. Set by
45 /// determineCalleeSaves().
48 /// \brief Amount of stack frame size, not including callee-saved registers.
49 unsigned LocalStackSize;
51 /// \brief Amount of stack frame size used for saving callee-saved registers.
52 unsigned CalleeSavedStackSize;
54 /// \brief Number of TLS accesses using the special (combinable)
55 /// _TLS_MODULE_BASE_ symbol.
56 unsigned NumLocalDynamicTLSAccesses;
58 /// \brief FrameIndex for start of varargs area for arguments passed on the
60 int VarArgsStackIndex;
62 /// \brief FrameIndex for start of varargs area for arguments passed in
63 /// general purpose registers.
66 /// \brief Size of the varargs area for arguments passed in general purpose
68 unsigned VarArgsGPRSize;
70 /// \brief FrameIndex for start of varargs area for arguments passed in
71 /// floating-point registers.
74 /// \brief Size of the varargs area for arguments passed in floating-point
76 unsigned VarArgsFPRSize;
78 /// True if this function has a subset of CSRs that is handled explicitly via
82 /// True when the stack gets realigned dynamically because the size of stack
83 /// frame is unknown at compile time. e.g., in case of VLAs.
86 /// True when the callee-save stack area has unused gaps that may be used for
87 /// other stack allocations.
88 bool CalleeSaveStackHasFreeSpace;
92 : BytesInStackArgArea(0), ArgumentStackToRestore(0), HasStackFrame(false),
93 NumLocalDynamicTLSAccesses(0), VarArgsStackIndex(0), VarArgsGPRIndex(0),
94 VarArgsGPRSize(0), VarArgsFPRIndex(0), VarArgsFPRSize(0),
95 IsSplitCSR(false), StackRealigned(false),
96 CalleeSaveStackHasFreeSpace(false) {}
98 explicit AArch64FunctionInfo(MachineFunction &MF)
99 : BytesInStackArgArea(0), ArgumentStackToRestore(0), HasStackFrame(false),
100 NumLocalDynamicTLSAccesses(0), VarArgsStackIndex(0), VarArgsGPRIndex(0),
101 VarArgsGPRSize(0), VarArgsFPRIndex(0), VarArgsFPRSize(0),
102 IsSplitCSR(false), StackRealigned(false),
103 CalleeSaveStackHasFreeSpace(false) {
107 unsigned getBytesInStackArgArea() const { return BytesInStackArgArea; }
108 void setBytesInStackArgArea(unsigned bytes) { BytesInStackArgArea = bytes; }
110 unsigned getArgumentStackToRestore() const { return ArgumentStackToRestore; }
111 void setArgumentStackToRestore(unsigned bytes) {
112 ArgumentStackToRestore = bytes;
115 bool hasStackFrame() const { return HasStackFrame; }
116 void setHasStackFrame(bool s) { HasStackFrame = s; }
118 bool isStackRealigned() const { return StackRealigned; }
119 void setStackRealigned(bool s) { StackRealigned = s; }
121 bool hasCalleeSaveStackFreeSpace() const {
122 return CalleeSaveStackHasFreeSpace;
124 void setCalleeSaveStackHasFreeSpace(bool s) {
125 CalleeSaveStackHasFreeSpace = s;
128 bool isSplitCSR() const { return IsSplitCSR; }
129 void setIsSplitCSR(bool s) { IsSplitCSR = s; }
131 void setLocalStackSize(unsigned Size) { LocalStackSize = Size; }
132 unsigned getLocalStackSize() const { return LocalStackSize; }
134 void setCalleeSavedStackSize(unsigned Size) { CalleeSavedStackSize = Size; }
135 unsigned getCalleeSavedStackSize() const { return CalleeSavedStackSize; }
137 void incNumLocalDynamicTLSAccesses() { ++NumLocalDynamicTLSAccesses; }
138 unsigned getNumLocalDynamicTLSAccesses() const {
139 return NumLocalDynamicTLSAccesses;
142 int getVarArgsStackIndex() const { return VarArgsStackIndex; }
143 void setVarArgsStackIndex(int Index) { VarArgsStackIndex = Index; }
145 int getVarArgsGPRIndex() const { return VarArgsGPRIndex; }
146 void setVarArgsGPRIndex(int Index) { VarArgsGPRIndex = Index; }
148 unsigned getVarArgsGPRSize() const { return VarArgsGPRSize; }
149 void setVarArgsGPRSize(unsigned Size) { VarArgsGPRSize = Size; }
151 int getVarArgsFPRIndex() const { return VarArgsFPRIndex; }
152 void setVarArgsFPRIndex(int Index) { VarArgsFPRIndex = Index; }
154 unsigned getVarArgsFPRSize() const { return VarArgsFPRSize; }
155 void setVarArgsFPRSize(unsigned Size) { VarArgsFPRSize = Size; }
157 typedef SmallPtrSet<const MachineInstr *, 16> SetOfInstructions;
159 const SetOfInstructions &getLOHRelated() const { return LOHRelated; }
161 // Shortcuts for LOH related types.
162 class MILOHDirective {
165 /// Arguments of this directive. Order matters.
166 SmallVector<const MachineInstr *, 3> Args;
169 typedef ArrayRef<const MachineInstr *> LOHArgs;
171 MILOHDirective(MCLOHType Kind, LOHArgs Args)
172 : Kind(Kind), Args(Args.begin(), Args.end()) {
173 assert(isValidMCLOHType(Kind) && "Invalid LOH directive type!");
176 MCLOHType getKind() const { return Kind; }
177 LOHArgs getArgs() const { return Args; }
180 typedef MILOHDirective::LOHArgs MILOHArgs;
181 typedef SmallVector<MILOHDirective, 32> MILOHContainer;
183 const MILOHContainer &getLOHContainer() const { return LOHContainerSet; }
185 /// Add a LOH directive of this @p Kind and this @p Args.
186 void addLOHDirective(MCLOHType Kind, MILOHArgs Args) {
187 LOHContainerSet.push_back(MILOHDirective(Kind, Args));
188 LOHRelated.insert(Args.begin(), Args.end());
192 // Hold the lists of LOHs.
193 MILOHContainer LOHContainerSet;
194 SetOfInstructions LOHRelated;
196 } // End llvm namespace