LLVM  13.0.0git
ARMMachineFunctionInfo.h
Go to the documentation of this file.
1 //===-- ARMMachineFunctionInfo.h - ARM 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 ARM-specific per-machine-function information.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef LLVM_LIB_TARGET_ARM_ARMMACHINEFUNCTIONINFO_H
14 #define LLVM_LIB_TARGET_ARM_ARMMACHINEFUNCTIONINFO_H
15 
16 #include "llvm/ADT/DenseMap.h"
17 #include "llvm/ADT/SmallPtrSet.h"
19 #include "llvm/IR/GlobalVariable.h"
21 #include <utility>
22 
23 namespace llvm {
24 
25 /// ARMFunctionInfo - This class is derived from MachineFunctionInfo and
26 /// contains private ARM-specific information for each MachineFunction.
28  virtual void anchor();
29 
30  /// isThumb - True if this function is compiled under Thumb mode.
31  /// Used to initialized Align, so must precede it.
32  bool isThumb = false;
33 
34  /// hasThumb2 - True if the target architecture supports Thumb2. Do not use
35  /// to determine if function is compiled under Thumb mode, for that use
36  /// 'isThumb'.
37  bool hasThumb2 = false;
38 
39  /// StByValParamsPadding - For parameter that is split between
40  /// GPRs and memory; while recovering GPRs part, when
41  /// StackAlignment > 4, and GPRs-part-size mod StackAlignment != 0,
42  /// we need to insert gap before parameter start address. It allows to
43  /// "attach" GPR-part to the part that was passed via stack.
44  unsigned StByValParamsPadding = 0;
45 
46  /// VarArgsRegSaveSize - Size of the register save area for vararg functions.
47  ///
48  unsigned ArgRegsSaveSize = 0;
49 
50  /// ReturnRegsCount - Number of registers used up in the return.
51  unsigned ReturnRegsCount = 0;
52 
53  /// HasStackFrame - True if this function has a stack frame. Set by
54  /// determineCalleeSaves().
55  bool HasStackFrame = false;
56 
57  /// RestoreSPFromFP - True if epilogue should restore SP from FP. Set by
58  /// emitPrologue.
59  bool RestoreSPFromFP = false;
60 
61  /// LRSpilled - True if the LR register has been for spilled for
62  /// any reason, so it's legal to emit an ARM::tBfar (i.e. "bl").
63  bool LRSpilled = false;
64 
65  /// FramePtrSpillOffset - If HasStackFrame, this records the frame pointer
66  /// spill stack offset.
67  unsigned FramePtrSpillOffset = 0;
68 
69  /// GPRCS1Offset, GPRCS2Offset, DPRCSOffset - Starting offset of callee saved
70  /// register spills areas. For Mac OS X:
71  ///
72  /// GPR callee-saved (1) : r4, r5, r6, r7, lr
73  /// --------------------------------------------
74  /// GPR callee-saved (2) : r8, r10, r11
75  /// --------------------------------------------
76  /// DPR callee-saved : d8 - d15
77  ///
78  /// Also see AlignedDPRCSRegs below. Not all D-regs need to go in area 3.
79  /// Some may be spilled after the stack has been realigned.
80  unsigned GPRCS1Offset = 0;
81  unsigned GPRCS2Offset = 0;
82  unsigned DPRCSOffset = 0;
83 
84  /// GPRCS1Size, GPRCS2Size, DPRCSSize - Sizes of callee saved register spills
85  /// areas.
86  unsigned FPCXTSaveSize = 0;
87  unsigned GPRCS1Size = 0;
88  unsigned GPRCS2Size = 0;
89  unsigned DPRCSAlignGapSize = 0;
90  unsigned DPRCSSize = 0;
91 
92  /// NumAlignedDPRCS2Regs - The number of callee-saved DPRs that are saved in
93  /// the aligned portion of the stack frame. This is always a contiguous
94  /// sequence of D-registers starting from d8.
95  ///
96  /// We do not keep track of the frame indices used for these registers - they
97  /// behave like any other frame index in the aligned stack frame. These
98  /// registers also aren't included in DPRCSSize above.
99  unsigned NumAlignedDPRCS2Regs = 0;
100 
101  unsigned PICLabelUId = 0;
102 
103  /// VarArgsFrameIndex - FrameIndex for start of varargs area.
104  int VarArgsFrameIndex = 0;
105 
106  /// HasITBlocks - True if IT blocks have been inserted.
107  bool HasITBlocks = false;
108 
109  // Security Extensions
110  bool IsCmseNSEntry;
111  bool IsCmseNSCall;
112 
113  /// CPEClones - Track constant pool entries clones created by Constant Island
114  /// pass.
116 
117  /// ArgumentStackSize - amount of bytes on stack consumed by the arguments
118  /// being passed on the stack
119  unsigned ArgumentStackSize = 0;
120 
121  /// CoalescedWeights - mapping of basic blocks to the rolling counter of
122  /// coalesced weights.
124 
125  /// True if this function has a subset of CSRs that is handled explicitly via
126  /// copies.
127  bool IsSplitCSR = false;
128 
129  /// Globals that have had their storage promoted into the constant pool.
130  SmallPtrSet<const GlobalVariable*,2> PromotedGlobals;
131 
132  /// The amount the literal pool has been increasedby due to promoted globals.
133  int PromotedGlobalsIncrease = 0;
134 
135  /// True if r0 will be preserved by a call to this function (e.g. C++
136  /// con/destructors).
137  bool PreservesR0 = false;
138 
139 public:
140  ARMFunctionInfo() = default;
141 
142  explicit ARMFunctionInfo(MachineFunction &MF);
143 
144  bool isThumbFunction() const { return isThumb; }
145  bool isThumb1OnlyFunction() const { return isThumb && !hasThumb2; }
146  bool isThumb2Function() const { return isThumb && hasThumb2; }
147 
148  bool isCmseNSEntryFunction() const { return IsCmseNSEntry; }
149  bool isCmseNSCallFunction() const { return IsCmseNSCall; }
150 
151  unsigned getStoredByValParamsPadding() const { return StByValParamsPadding; }
152  void setStoredByValParamsPadding(unsigned p) { StByValParamsPadding = p; }
153 
154  unsigned getArgRegsSaveSize() const { return ArgRegsSaveSize; }
155  void setArgRegsSaveSize(unsigned s) { ArgRegsSaveSize = s; }
156 
157  unsigned getReturnRegsCount() const { return ReturnRegsCount; }
158  void setReturnRegsCount(unsigned s) { ReturnRegsCount = s; }
159 
160  bool hasStackFrame() const { return HasStackFrame; }
161  void setHasStackFrame(bool s) { HasStackFrame = s; }
162 
163  bool shouldRestoreSPFromFP() const { return RestoreSPFromFP; }
164  void setShouldRestoreSPFromFP(bool s) { RestoreSPFromFP = s; }
165 
166  bool isLRSpilled() const { return LRSpilled; }
167  void setLRIsSpilled(bool s) { LRSpilled = s; }
168 
169  unsigned getFramePtrSpillOffset() const { return FramePtrSpillOffset; }
170  void setFramePtrSpillOffset(unsigned o) { FramePtrSpillOffset = o; }
171 
172  unsigned getNumAlignedDPRCS2Regs() const { return NumAlignedDPRCS2Regs; }
173  void setNumAlignedDPRCS2Regs(unsigned n) { NumAlignedDPRCS2Regs = n; }
174 
175  unsigned getGPRCalleeSavedArea1Offset() const { return GPRCS1Offset; }
176  unsigned getGPRCalleeSavedArea2Offset() const { return GPRCS2Offset; }
177  unsigned getDPRCalleeSavedAreaOffset() const { return DPRCSOffset; }
178 
179  void setGPRCalleeSavedArea1Offset(unsigned o) { GPRCS1Offset = o; }
180  void setGPRCalleeSavedArea2Offset(unsigned o) { GPRCS2Offset = o; }
181  void setDPRCalleeSavedAreaOffset(unsigned o) { DPRCSOffset = o; }
182 
183  unsigned getFPCXTSaveAreaSize() const { return FPCXTSaveSize; }
184  unsigned getGPRCalleeSavedArea1Size() const { return GPRCS1Size; }
185  unsigned getGPRCalleeSavedArea2Size() const { return GPRCS2Size; }
186  unsigned getDPRCalleeSavedGapSize() const { return DPRCSAlignGapSize; }
187  unsigned getDPRCalleeSavedAreaSize() const { return DPRCSSize; }
188 
189  void setFPCXTSaveAreaSize(unsigned s) { FPCXTSaveSize = s; }
190  void setGPRCalleeSavedArea1Size(unsigned s) { GPRCS1Size = s; }
191  void setGPRCalleeSavedArea2Size(unsigned s) { GPRCS2Size = s; }
192  void setDPRCalleeSavedGapSize(unsigned s) { DPRCSAlignGapSize = s; }
193  void setDPRCalleeSavedAreaSize(unsigned s) { DPRCSSize = s; }
194 
195  unsigned getArgumentStackSize() const { return ArgumentStackSize; }
196  void setArgumentStackSize(unsigned size) { ArgumentStackSize = size; }
197 
198  void initPICLabelUId(unsigned UId) {
199  PICLabelUId = UId;
200  }
201 
202  unsigned getNumPICLabels() const {
203  return PICLabelUId;
204  }
205 
206  unsigned createPICLabelUId() {
207  return PICLabelUId++;
208  }
209 
210  int getVarArgsFrameIndex() const { return VarArgsFrameIndex; }
211  void setVarArgsFrameIndex(int Index) { VarArgsFrameIndex = Index; }
212 
213  bool hasITBlocks() const { return HasITBlocks; }
214  void setHasITBlocks(bool h) { HasITBlocks = h; }
215 
216  bool isSplitCSR() const { return IsSplitCSR; }
217  void setIsSplitCSR(bool s) { IsSplitCSR = s; }
218 
219  void recordCPEClone(unsigned CPIdx, unsigned CPCloneIdx) {
220  if (!CPEClones.insert(std::make_pair(CPCloneIdx, CPIdx)).second)
221  llvm_unreachable("Duplicate entries!");
222  }
223 
224  unsigned getOriginalCPIdx(unsigned CloneIdx) const {
226  if (I != CPEClones.end())
227  return I->second;
228  else
229  return -1U;
230  }
231 
234  auto It = CoalescedWeights.find(MBB);
235  if (It == CoalescedWeights.end()) {
236  It = CoalescedWeights.insert(std::make_pair(MBB, 0)).first;
237  }
238  return It;
239  }
240 
241  /// Indicate to the backend that \c GV has had its storage changed to inside
242  /// a constant pool. This means it no longer needs to be emitted as a
243  /// global variable.
245  PromotedGlobals.insert(GV);
246  }
248  return PromotedGlobals;
249  }
251  return PromotedGlobalsIncrease;
252  }
254  PromotedGlobalsIncrease = Sz;
255  }
256 
259 
260  void setPreservesR0() { PreservesR0 = true; }
261  bool getPreservesR0() const { return PreservesR0; }
262 };
263 
264 } // end namespace llvm
265 
266 #endif // LLVM_LIB_TARGET_ARM_ARMMACHINEFUNCTIONINFO_H
llvm::ARMFunctionInfo::isCmseNSCallFunction
bool isCmseNSCallFunction() const
Definition: ARMMachineFunctionInfo.h:149
llvm::ARMFunctionInfo::getReturnRegsCount
unsigned getReturnRegsCount() const
Definition: ARMMachineFunctionInfo.h:157
llvm::ARMFunctionInfo
ARMFunctionInfo - This class is derived from MachineFunctionInfo and contains private ARM-specific in...
Definition: ARMMachineFunctionInfo.h:27
llvm::ARMFunctionInfo::isLRSpilled
bool isLRSpilled() const
Definition: ARMMachineFunctionInfo.h:166
llvm
Definition: AllocatorList.h:23
llvm::ARMFunctionInfo::isSplitCSR
bool isSplitCSR() const
Definition: ARMMachineFunctionInfo.h:216
llvm::ARMFunctionInfo::setGPRCalleeSavedArea2Size
void setGPRCalleeSavedArea2Size(unsigned s)
Definition: ARMMachineFunctionInfo.h:191
llvm::ARMFunctionInfo::setDPRCalleeSavedGapSize
void setDPRCalleeSavedGapSize(unsigned s)
Definition: ARMMachineFunctionInfo.h:192
llvm::ARMFunctionInfo::getNumPICLabels
unsigned getNumPICLabels() const
Definition: ARMMachineFunctionInfo.h:202
llvm::ARMFunctionInfo::shouldRestoreSPFromFP
bool shouldRestoreSPFromFP() const
Definition: ARMMachineFunctionInfo.h:163
llvm::ARMFunctionInfo::setGPRCalleeSavedArea1Size
void setGPRCalleeSavedArea1Size(unsigned s)
Definition: ARMMachineFunctionInfo.h:190
llvm::ARMFunctionInfo::initPICLabelUId
void initPICLabelUId(unsigned UId)
Definition: ARMMachineFunctionInfo.h:198
llvm::ARMFunctionInfo::EHPrologueOffsetInRegs
DenseMap< unsigned, unsigned > EHPrologueOffsetInRegs
Definition: ARMMachineFunctionInfo.h:258
llvm::ARMFunctionInfo::isThumb1OnlyFunction
bool isThumb1OnlyFunction() const
Definition: ARMMachineFunctionInfo.h:145
ErrorHandling.h
llvm::ARMFunctionInfo::createPICLabelUId
unsigned createPICLabelUId()
Definition: ARMMachineFunctionInfo.h:206
llvm::ARMFunctionInfo::getGPRCalleeSavedArea1Size
unsigned getGPRCalleeSavedArea1Size() const
Definition: ARMMachineFunctionInfo.h:184
llvm::GlobalVariable
Definition: GlobalVariable.h:40
llvm::ARMFunctionInfo::setNumAlignedDPRCS2Regs
void setNumAlignedDPRCS2Regs(unsigned n)
Definition: ARMMachineFunctionInfo.h:173
llvm::ARMFunctionInfo::getOriginalCPIdx
unsigned getOriginalCPIdx(unsigned CloneIdx) const
Definition: ARMMachineFunctionInfo.h:224
llvm::ARMFunctionInfo::getGPRCalleeSavedArea2Size
unsigned getGPRCalleeSavedArea2Size() const
Definition: ARMMachineFunctionInfo.h:185
llvm::DenseMapIterator
Definition: DenseMap.h:56
DenseMap.h
llvm::SmallPtrSet
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements.
Definition: SmallPtrSet.h:449
p
the resulting code requires compare and branches when and if * p
Definition: README.txt:396
llvm::ARMFunctionInfo::getDPRCalleeSavedAreaSize
unsigned getDPRCalleeSavedAreaSize() const
Definition: ARMMachineFunctionInfo.h:187
llvm::ARMFunctionInfo::EHPrologueRemappedRegs
DenseMap< unsigned, unsigned > EHPrologueRemappedRegs
Definition: ARMMachineFunctionInfo.h:257
llvm::ARMFunctionInfo::isCmseNSEntryFunction
bool isCmseNSEntryFunction() const
Definition: ARMMachineFunctionInfo.h:148
llvm::ARMFunctionInfo::setStoredByValParamsPadding
void setStoredByValParamsPadding(unsigned p)
Definition: ARMMachineFunctionInfo.h:152
llvm::ARMFunctionInfo::setShouldRestoreSPFromFP
void setShouldRestoreSPFromFP(bool s)
Definition: ARMMachineFunctionInfo.h:164
llvm::ARMFunctionInfo::getDPRCalleeSavedGapSize
unsigned getDPRCalleeSavedGapSize() const
Definition: ARMMachineFunctionInfo.h:186
llvm::ARMFunctionInfo::getGPRCalleeSavedArea2Offset
unsigned getGPRCalleeSavedArea2Offset() const
Definition: ARMMachineFunctionInfo.h:176
llvm::ARMFunctionInfo::setDPRCalleeSavedAreaSize
void setDPRCalleeSavedAreaSize(unsigned s)
Definition: ARMMachineFunctionInfo.h:193
llvm::ARMFunctionInfo::setPreservesR0
void setPreservesR0()
Definition: ARMMachineFunctionInfo.h:260
llvm::ARMFunctionInfo::getPromotedConstpoolIncrease
int getPromotedConstpoolIncrease() const
Definition: ARMMachineFunctionInfo.h:250
llvm::ARMFunctionInfo::getFramePtrSpillOffset
unsigned getFramePtrSpillOffset() const
Definition: ARMMachineFunctionInfo.h:169
llvm::ARMFunctionInfo::ARMFunctionInfo
ARMFunctionInfo()=default
llvm::ARMFunctionInfo::setVarArgsFrameIndex
void setVarArgsFrameIndex(int Index)
Definition: ARMMachineFunctionInfo.h:211
SmallPtrSet.h
llvm::ARMFunctionInfo::setHasStackFrame
void setHasStackFrame(bool s)
Definition: ARMMachineFunctionInfo.h:161
llvm::ARMFunctionInfo::isThumbFunction
bool isThumbFunction() const
Definition: ARMMachineFunctionInfo.h:144
llvm::ARMFunctionInfo::setArgRegsSaveSize
void setArgRegsSaveSize(unsigned s)
Definition: ARMMachineFunctionInfo.h:155
llvm::MachineBasicBlock
Definition: MachineBasicBlock.h:95
llvm::ARMFunctionInfo::getCoalescedWeight
DenseMap< const MachineBasicBlock *, unsigned >::iterator getCoalescedWeight(MachineBasicBlock *MBB)
Definition: ARMMachineFunctionInfo.h:232
llvm::ARMFunctionInfo::setIsSplitCSR
void setIsSplitCSR(bool s)
Definition: ARMMachineFunctionInfo.h:217
Index
uint32_t Index
Definition: ELFObjHandler.cpp:84
llvm::ARMFunctionInfo::getVarArgsFrameIndex
int getVarArgsFrameIndex() const
Definition: ARMMachineFunctionInfo.h:210
llvm::ARMFunctionInfo::getFPCXTSaveAreaSize
unsigned getFPCXTSaveAreaSize() const
Definition: ARMMachineFunctionInfo.h:183
s
multiplies can be turned into SHL s
Definition: README.txt:370
llvm::DenseMap< unsigned, unsigned >
I
#define I(x, y, z)
Definition: MD5.cpp:59
llvm::ARMFunctionInfo::setHasITBlocks
void setHasITBlocks(bool h)
Definition: ARMMachineFunctionInfo.h:214
llvm::ARMFunctionInfo::setFPCXTSaveAreaSize
void setFPCXTSaveAreaSize(unsigned s)
Definition: ARMMachineFunctionInfo.h:189
llvm::ARMFunctionInfo::setReturnRegsCount
void setReturnRegsCount(unsigned s)
Definition: ARMMachineFunctionInfo.h:158
llvm::DenseMapBase::find
iterator find(const_arg_type_t< KeyT > Val)
Definition: DenseMap.h:150
llvm::ARMFunctionInfo::getDPRCalleeSavedAreaOffset
unsigned getDPRCalleeSavedAreaOffset() const
Definition: ARMMachineFunctionInfo.h:177
llvm::ARMFunctionInfo::getGlobalsPromotedToConstantPool
SmallPtrSet< const GlobalVariable *, 2 > & getGlobalsPromotedToConstantPool()
Definition: ARMMachineFunctionInfo.h:247
llvm::MachineFunction
Definition: MachineFunction.h:230
llvm::ARMFunctionInfo::getStoredByValParamsPadding
unsigned getStoredByValParamsPadding() const
Definition: ARMMachineFunctionInfo.h:151
llvm::size
auto size(R &&Range, std::enable_if_t< std::is_base_of< std::random_access_iterator_tag, typename std::iterator_traits< decltype(Range.begin())>::iterator_category >::value, void > *=nullptr)
Get the size of a range.
Definition: STLExtras.h:1463
llvm::ARMFunctionInfo::recordCPEClone
void recordCPEClone(unsigned CPIdx, unsigned CPCloneIdx)
Definition: ARMMachineFunctionInfo.h:219
llvm::ARMFunctionInfo::setFramePtrSpillOffset
void setFramePtrSpillOffset(unsigned o)
Definition: ARMMachineFunctionInfo.h:170
llvm_unreachable
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
Definition: ErrorHandling.h:136
llvm::ARMFunctionInfo::setGPRCalleeSavedArea2Offset
void setGPRCalleeSavedArea2Offset(unsigned o)
Definition: ARMMachineFunctionInfo.h:180
llvm::ARMFunctionInfo::setArgumentStackSize
void setArgumentStackSize(unsigned size)
Definition: ARMMachineFunctionInfo.h:196
llvm::DenseMapBase::insert
std::pair< iterator, bool > insert(const std::pair< KeyT, ValueT > &KV)
Definition: DenseMap.h:207
llvm::ARMFunctionInfo::setGPRCalleeSavedArea1Offset
void setGPRCalleeSavedArea1Offset(unsigned o)
Definition: ARMMachineFunctionInfo.h:179
llvm::ARMFunctionInfo::setPromotedConstpoolIncrease
void setPromotedConstpoolIncrease(int Sz)
Definition: ARMMachineFunctionInfo.h:253
MBB
MachineBasicBlock & MBB
Definition: AArch64SLSHardening.cpp:74
llvm::DenseMapBase::end
iterator end()
Definition: DenseMap.h:83
GlobalVariable.h
llvm::ARMFunctionInfo::setDPRCalleeSavedAreaOffset
void setDPRCalleeSavedAreaOffset(unsigned o)
Definition: ARMMachineFunctionInfo.h:181
llvm::ARMFunctionInfo::setLRIsSpilled
void setLRIsSpilled(bool s)
Definition: ARMMachineFunctionInfo.h:167
llvm::ARMFunctionInfo::getArgumentStackSize
unsigned getArgumentStackSize() const
Definition: ARMMachineFunctionInfo.h:195
llvm::ARMFunctionInfo::getGPRCalleeSavedArea1Offset
unsigned getGPRCalleeSavedArea1Offset() const
Definition: ARMMachineFunctionInfo.h:175
llvm::ARMFunctionInfo::getNumAlignedDPRCS2Regs
unsigned getNumAlignedDPRCS2Regs() const
Definition: ARMMachineFunctionInfo.h:172
llvm::ARMFunctionInfo::hasStackFrame
bool hasStackFrame() const
Definition: ARMMachineFunctionInfo.h:160
llvm::ARMFunctionInfo::getArgRegsSaveSize
unsigned getArgRegsSaveSize() const
Definition: ARMMachineFunctionInfo.h:154
h
the multiplication has a latency of four as opposed to two cycles for the movl lea variant It appears gcc place string data with linkonce linkage in section coalesced instead of section coalesced Take a look at darwin h
Definition: README.txt:261
llvm::ARMFunctionInfo::getPreservesR0
bool getPreservesR0() const
Definition: ARMMachineFunctionInfo.h:261
llvm::ARMFunctionInfo::hasITBlocks
bool hasITBlocks() const
Definition: ARMMachineFunctionInfo.h:213
llvm::ARMFunctionInfo::markGlobalAsPromotedToConstantPool
void markGlobalAsPromotedToConstantPool(const GlobalVariable *GV)
Indicate to the backend that GV has had its storage changed to inside a constant pool.
Definition: ARMMachineFunctionInfo.h:244
n
The same transformation can work with an even modulo with the addition of a and shrink the compare RHS by the same amount Unless the target supports that transformation probably isn t worthwhile The transformation can also easily be made to work with non zero equality for n
Definition: README.txt:685
MachineFunction.h
llvm::ARMFunctionInfo::isThumb2Function
bool isThumb2Function() const
Definition: ARMMachineFunctionInfo.h:146
llvm::MachineFunctionInfo
MachineFunctionInfo - This class can be derived from and used by targets to hold private target-speci...
Definition: MachineFunction.h:95
llvm::SmallPtrSetImpl::insert
std::pair< iterator, bool > insert(PtrType Ptr)
Inserts Ptr if and only if there is no element in the container equal to Ptr.
Definition: SmallPtrSet.h:364