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" 18 #include "llvm/CodeGen/MachineFunction.h" 19 #include "llvm/IR/GlobalVariable.h" 20 #include "llvm/Support/ErrorHandling.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. 27 class ARMFunctionInfo : public MachineFunctionInfo { 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 /// ArgsRegSaveSize - Size of the register save area for vararg functions or 47 /// those making guaranteed tail calls that need more stack argument space 48 /// than is provided by this functions incoming parameters. 49 /// 50 unsigned ArgRegsSaveSize = 0; 51 52 /// ReturnRegsCount - Number of registers used up in the return. 53 unsigned ReturnRegsCount = 0; 54 55 /// HasStackFrame - True if this function has a stack frame. Set by 56 /// determineCalleeSaves(). 57 bool HasStackFrame = false; 58 59 /// RestoreSPFromFP - True if epilogue should restore SP from FP. Set by 60 /// emitPrologue. 61 bool RestoreSPFromFP = false; 62 63 /// LRSpilled - True if the LR register has been for spilled for 64 /// any reason, so it's legal to emit an ARM::tBfar (i.e. "bl"). 65 bool LRSpilled = false; 66 67 /// FramePtrSpillOffset - If HasStackFrame, this records the frame pointer 68 /// spill stack offset. 69 unsigned FramePtrSpillOffset = 0; 70 71 /// GPRCS1Offset, GPRCS2Offset, DPRCSOffset - Starting offset of callee saved 72 /// register spills areas. For Mac OS X: 73 /// 74 /// GPR callee-saved (1) : r4, r5, r6, r7, lr 75 /// -------------------------------------------- 76 /// GPR callee-saved (2) : r8, r10, r11 77 /// -------------------------------------------- 78 /// DPR callee-saved : d8 - d15 79 /// 80 /// Also see AlignedDPRCSRegs below. Not all D-regs need to go in area 3. 81 /// Some may be spilled after the stack has been realigned. 82 unsigned GPRCS1Offset = 0; 83 unsigned GPRCS2Offset = 0; 84 unsigned DPRCSOffset = 0; 85 86 /// GPRCS1Size, GPRCS2Size, DPRCSSize - Sizes of callee saved register spills 87 /// areas. 88 unsigned FPCXTSaveSize = 0; 89 unsigned GPRCS1Size = 0; 90 unsigned GPRCS2Size = 0; 91 unsigned DPRCSAlignGapSize = 0; 92 unsigned DPRCSSize = 0; 93 94 /// NumAlignedDPRCS2Regs - The number of callee-saved DPRs that are saved in 95 /// the aligned portion of the stack frame. This is always a contiguous 96 /// sequence of D-registers starting from d8. 97 /// 98 /// We do not keep track of the frame indices used for these registers - they 99 /// behave like any other frame index in the aligned stack frame. These 100 /// registers also aren't included in DPRCSSize above. 101 unsigned NumAlignedDPRCS2Regs = 0; 102 103 unsigned PICLabelUId = 0; 104 105 /// VarArgsFrameIndex - FrameIndex for start of varargs area. 106 int VarArgsFrameIndex = 0; 107 108 /// HasITBlocks - True if IT blocks have been inserted. 109 bool HasITBlocks = false; 110 111 // Security Extensions 112 bool IsCmseNSEntry; 113 bool IsCmseNSCall; 114 115 /// CPEClones - Track constant pool entries clones created by Constant Island 116 /// pass. 117 DenseMap<unsigned, unsigned> CPEClones; 118 119 /// ArgumentStackSize - amount of bytes on stack consumed by the arguments 120 /// being passed on the stack 121 unsigned ArgumentStackSize = 0; 122 123 /// ArgumentStackToRestore - amount of bytes on stack consumed that we must 124 /// restore on return. 125 unsigned ArgumentStackToRestore = 0; 126 127 /// CoalescedWeights - mapping of basic blocks to the rolling counter of 128 /// coalesced weights. 129 DenseMap<const MachineBasicBlock*, unsigned> CoalescedWeights; 130 131 /// True if this function has a subset of CSRs that is handled explicitly via 132 /// copies. 133 bool IsSplitCSR = false; 134 135 /// Globals that have had their storage promoted into the constant pool. 136 SmallPtrSet<const GlobalVariable*,2> PromotedGlobals; 137 138 /// The amount the literal pool has been increasedby due to promoted globals. 139 int PromotedGlobalsIncrease = 0; 140 141 /// True if r0 will be preserved by a call to this function (e.g. C++ 142 /// con/destructors). 143 bool PreservesR0 = false; 144 145 /// True if the function should sign its return address. 146 bool SignReturnAddress = false; 147 148 /// True if the fucntion should sign its return address, even if LR is not 149 /// saved. 150 bool SignReturnAddressAll = false; 151 152 /// True if BTI instructions should be placed at potential indirect jump 153 /// destinations. 154 bool BranchTargetEnforcement = false; 155 156 public: 157 ARMFunctionInfo() = default; 158 159 explicit ARMFunctionInfo(MachineFunction &MF); 160 161 bool isThumbFunction() const { return isThumb; } 162 bool isThumb1OnlyFunction() const { return isThumb && !hasThumb2; } 163 bool isThumb2Function() const { return isThumb && hasThumb2; } 164 165 bool isCmseNSEntryFunction() const { return IsCmseNSEntry; } 166 bool isCmseNSCallFunction() const { return IsCmseNSCall; } 167 168 unsigned getStoredByValParamsPadding() const { return StByValParamsPadding; } 169 void setStoredByValParamsPadding(unsigned p) { StByValParamsPadding = p; } 170 171 unsigned getArgRegsSaveSize() const { return ArgRegsSaveSize; } 172 void setArgRegsSaveSize(unsigned s) { ArgRegsSaveSize = s; } 173 174 unsigned getReturnRegsCount() const { return ReturnRegsCount; } 175 void setReturnRegsCount(unsigned s) { ReturnRegsCount = s; } 176 177 bool hasStackFrame() const { return HasStackFrame; } 178 void setHasStackFrame(bool s) { HasStackFrame = s; } 179 180 bool shouldRestoreSPFromFP() const { return RestoreSPFromFP; } 181 void setShouldRestoreSPFromFP(bool s) { RestoreSPFromFP = s; } 182 183 bool isLRSpilled() const { return LRSpilled; } 184 void setLRIsSpilled(bool s) { LRSpilled = s; } 185 186 unsigned getFramePtrSpillOffset() const { return FramePtrSpillOffset; } 187 void setFramePtrSpillOffset(unsigned o) { FramePtrSpillOffset = o; } 188 189 unsigned getNumAlignedDPRCS2Regs() const { return NumAlignedDPRCS2Regs; } 190 void setNumAlignedDPRCS2Regs(unsigned n) { NumAlignedDPRCS2Regs = n; } 191 192 unsigned getGPRCalleeSavedArea1Offset() const { return GPRCS1Offset; } 193 unsigned getGPRCalleeSavedArea2Offset() const { return GPRCS2Offset; } 194 unsigned getDPRCalleeSavedAreaOffset() const { return DPRCSOffset; } 195 196 void setGPRCalleeSavedArea1Offset(unsigned o) { GPRCS1Offset = o; } 197 void setGPRCalleeSavedArea2Offset(unsigned o) { GPRCS2Offset = o; } 198 void setDPRCalleeSavedAreaOffset(unsigned o) { DPRCSOffset = o; } 199 200 unsigned getFPCXTSaveAreaSize() const { return FPCXTSaveSize; } 201 unsigned getGPRCalleeSavedArea1Size() const { return GPRCS1Size; } 202 unsigned getGPRCalleeSavedArea2Size() const { return GPRCS2Size; } 203 unsigned getDPRCalleeSavedGapSize() const { return DPRCSAlignGapSize; } 204 unsigned getDPRCalleeSavedAreaSize() const { return DPRCSSize; } 205 206 void setFPCXTSaveAreaSize(unsigned s) { FPCXTSaveSize = s; } 207 void setGPRCalleeSavedArea1Size(unsigned s) { GPRCS1Size = s; } 208 void setGPRCalleeSavedArea2Size(unsigned s) { GPRCS2Size = s; } 209 void setDPRCalleeSavedGapSize(unsigned s) { DPRCSAlignGapSize = s; } 210 void setDPRCalleeSavedAreaSize(unsigned s) { DPRCSSize = s; } 211 212 unsigned getArgumentStackSize() const { return ArgumentStackSize; } 213 void setArgumentStackSize(unsigned size) { ArgumentStackSize = size; } 214 215 unsigned getArgumentStackToRestore() const { return ArgumentStackToRestore; } 216 void setArgumentStackToRestore(unsigned v) { ArgumentStackToRestore = v; } 217 218 void initPICLabelUId(unsigned UId) { 219 PICLabelUId = UId; 220 } 221 222 unsigned getNumPICLabels() const { 223 return PICLabelUId; 224 } 225 226 unsigned createPICLabelUId() { 227 return PICLabelUId++; 228 } 229 230 int getVarArgsFrameIndex() const { return VarArgsFrameIndex; } 231 void setVarArgsFrameIndex(int Index) { VarArgsFrameIndex = Index; } 232 233 bool hasITBlocks() const { return HasITBlocks; } 234 void setHasITBlocks(bool h) { HasITBlocks = h; } 235 236 bool isSplitCSR() const { return IsSplitCSR; } 237 void setIsSplitCSR(bool s) { IsSplitCSR = s; } 238 239 void recordCPEClone(unsigned CPIdx, unsigned CPCloneIdx) { 240 if (!CPEClones.insert(std::make_pair(CPCloneIdx, CPIdx)).second) 241 llvm_unreachable("Duplicate entries!"); 242 } 243 244 unsigned getOriginalCPIdx(unsigned CloneIdx) const { 245 DenseMap<unsigned, unsigned>::const_iterator I = CPEClones.find(CloneIdx); 246 if (I != CPEClones.end()) 247 return I->second; 248 else 249 return -1U; 250 } 251 252 DenseMap<const MachineBasicBlock*, unsigned>::iterator getCoalescedWeight( 253 MachineBasicBlock* MBB) { 254 auto It = CoalescedWeights.find(MBB); 255 if (It == CoalescedWeights.end()) { 256 It = CoalescedWeights.insert(std::make_pair(MBB, 0)).first; 257 } 258 return It; 259 } 260 261 /// Indicate to the backend that \c GV has had its storage changed to inside 262 /// a constant pool. This means it no longer needs to be emitted as a 263 /// global variable. 264 void markGlobalAsPromotedToConstantPool(const GlobalVariable *GV) { 265 PromotedGlobals.insert(GV); 266 } 267 SmallPtrSet<const GlobalVariable*, 2>& getGlobalsPromotedToConstantPool() { 268 return PromotedGlobals; 269 } 270 int getPromotedConstpoolIncrease() const { 271 return PromotedGlobalsIncrease; 272 } 273 void setPromotedConstpoolIncrease(int Sz) { 274 PromotedGlobalsIncrease = Sz; 275 } 276 277 DenseMap<unsigned, unsigned> EHPrologueRemappedRegs; 278 DenseMap<unsigned, unsigned> EHPrologueOffsetInRegs; 279 280 void setPreservesR0() { PreservesR0 = true; } 281 bool getPreservesR0() const { return PreservesR0; } 282 283 bool shouldSignReturnAddress() const { 284 return shouldSignReturnAddress(LRSpilled); 285 } 286 287 bool shouldSignReturnAddress(bool SpillsLR) const { 288 if (!SignReturnAddress) 289 return false; 290 if (SignReturnAddressAll) 291 return true; 292 return SpillsLR; 293 } 294 295 bool branchTargetEnforcement() const { return BranchTargetEnforcement; } 296 }; 297 298 } // end namespace llvm 299 300 #endif // LLVM_LIB_TARGET_ARM_ARMMACHINEFUNCTIONINFO_H 301