1 //===- AArch64RegisterInfo.cpp - AArch64 Register Information -------------===//
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 contains the AArch64 implementation of the TargetRegisterInfo
10 // class.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "AArch64RegisterInfo.h"
15 #include "AArch64FrameLowering.h"
16 #include "AArch64InstrInfo.h"
17 #include "AArch64MachineFunctionInfo.h"
18 #include "AArch64StackOffset.h"
19 #include "AArch64Subtarget.h"
20 #include "MCTargetDesc/AArch64AddressingModes.h"
21 #include "llvm/ADT/BitVector.h"
22 #include "llvm/ADT/Triple.h"
23 #include "llvm/CodeGen/MachineFrameInfo.h"
24 #include "llvm/CodeGen/MachineInstrBuilder.h"
25 #include "llvm/CodeGen/MachineRegisterInfo.h"
26 #include "llvm/CodeGen/RegisterScavenging.h"
27 #include "llvm/CodeGen/TargetFrameLowering.h"
28 #include "llvm/IR/DiagnosticInfo.h"
29 #include "llvm/IR/Function.h"
30 #include "llvm/Support/raw_ostream.h"
31 #include "llvm/Target/TargetOptions.h"
32 
33 using namespace llvm;
34 
35 #define GET_REGINFO_TARGET_DESC
36 #include "AArch64GenRegisterInfo.inc"
37 
AArch64RegisterInfo(const Triple & TT)38 AArch64RegisterInfo::AArch64RegisterInfo(const Triple &TT)
39     : AArch64GenRegisterInfo(AArch64::LR), TT(TT) {
40   AArch64_MC::initLLVMToCVRegMapping(this);
41 }
42 
43 const MCPhysReg *
getCalleeSavedRegs(const MachineFunction * MF) const44 AArch64RegisterInfo::getCalleeSavedRegs(const MachineFunction *MF) const {
45   assert(MF && "Invalid MachineFunction pointer.");
46   if (MF->getFunction().getCallingConv() == CallingConv::CFGuard_Check)
47     return CSR_Win_AArch64_CFGuard_Check_SaveList;
48   if (MF->getSubtarget<AArch64Subtarget>().isTargetWindows())
49     return CSR_Win_AArch64_AAPCS_SaveList;
50   if (MF->getFunction().getCallingConv() == CallingConv::GHC)
51     // GHC set of callee saved regs is empty as all those regs are
52     // used for passing STG regs around
53     return CSR_AArch64_NoRegs_SaveList;
54   if (MF->getFunction().getCallingConv() == CallingConv::AnyReg)
55     return CSR_AArch64_AllRegs_SaveList;
56   if (MF->getFunction().getCallingConv() == CallingConv::AArch64_VectorCall)
57     return CSR_AArch64_AAVPCS_SaveList;
58   if (MF->getFunction().getCallingConv() == CallingConv::AArch64_SVE_VectorCall)
59     return CSR_AArch64_SVE_AAPCS_SaveList;
60   if (MF->getFunction().getCallingConv() == CallingConv::CXX_FAST_TLS)
61     return MF->getInfo<AArch64FunctionInfo>()->isSplitCSR() ?
62            CSR_AArch64_CXX_TLS_Darwin_PE_SaveList :
63            CSR_AArch64_CXX_TLS_Darwin_SaveList;
64   if (MF->getSubtarget<AArch64Subtarget>().getTargetLowering()
65           ->supportSwiftError() &&
66       MF->getFunction().getAttributes().hasAttrSomewhere(
67           Attribute::SwiftError))
68     return CSR_AArch64_AAPCS_SwiftError_SaveList;
69   if (MF->getFunction().getCallingConv() == CallingConv::PreserveMost)
70     return CSR_AArch64_RT_MostRegs_SaveList;
71   if (MF->getSubtarget<AArch64Subtarget>().isTargetDarwin())
72     return CSR_Darwin_AArch64_AAPCS_SaveList;
73   return CSR_AArch64_AAPCS_SaveList;
74 }
75 
getCalleeSavedRegsViaCopy(const MachineFunction * MF) const76 const MCPhysReg *AArch64RegisterInfo::getCalleeSavedRegsViaCopy(
77     const MachineFunction *MF) const {
78   assert(MF && "Invalid MachineFunction pointer.");
79   if (MF->getFunction().getCallingConv() == CallingConv::CXX_FAST_TLS &&
80       MF->getInfo<AArch64FunctionInfo>()->isSplitCSR())
81     return CSR_AArch64_CXX_TLS_Darwin_ViaCopy_SaveList;
82   return nullptr;
83 }
84 
UpdateCustomCalleeSavedRegs(MachineFunction & MF) const85 void AArch64RegisterInfo::UpdateCustomCalleeSavedRegs(
86     MachineFunction &MF) const {
87   const MCPhysReg *CSRs = getCalleeSavedRegs(&MF);
88   SmallVector<MCPhysReg, 32> UpdatedCSRs;
89   for (const MCPhysReg *I = CSRs; *I; ++I)
90     UpdatedCSRs.push_back(*I);
91 
92   for (size_t i = 0; i < AArch64::GPR64commonRegClass.getNumRegs(); ++i) {
93     if (MF.getSubtarget<AArch64Subtarget>().isXRegCustomCalleeSaved(i)) {
94       UpdatedCSRs.push_back(AArch64::GPR64commonRegClass.getRegister(i));
95     }
96   }
97   // Register lists are zero-terminated.
98   UpdatedCSRs.push_back(0);
99   MF.getRegInfo().setCalleeSavedRegs(UpdatedCSRs);
100 }
101 
102 const TargetRegisterClass *
getSubClassWithSubReg(const TargetRegisterClass * RC,unsigned Idx) const103 AArch64RegisterInfo::getSubClassWithSubReg(const TargetRegisterClass *RC,
104                                        unsigned Idx) const {
105   // edge case for GPR/FPR register classes
106   if (RC == &AArch64::GPR32allRegClass && Idx == AArch64::hsub)
107     return &AArch64::FPR32RegClass;
108   else if (RC == &AArch64::GPR64allRegClass && Idx == AArch64::hsub)
109     return &AArch64::FPR64RegClass;
110 
111   // Forward to TableGen's default version.
112   return AArch64GenRegisterInfo::getSubClassWithSubReg(RC, Idx);
113 }
114 
115 const uint32_t *
getCallPreservedMask(const MachineFunction & MF,CallingConv::ID CC) const116 AArch64RegisterInfo::getCallPreservedMask(const MachineFunction &MF,
117                                           CallingConv::ID CC) const {
118   bool SCS = MF.getFunction().hasFnAttribute(Attribute::ShadowCallStack);
119   if (CC == CallingConv::GHC)
120     // This is academic because all GHC calls are (supposed to be) tail calls
121     return SCS ? CSR_AArch64_NoRegs_SCS_RegMask : CSR_AArch64_NoRegs_RegMask;
122   if (CC == CallingConv::AnyReg)
123     return SCS ? CSR_AArch64_AllRegs_SCS_RegMask : CSR_AArch64_AllRegs_RegMask;
124   if (CC == CallingConv::CXX_FAST_TLS)
125     return SCS ? CSR_AArch64_CXX_TLS_Darwin_SCS_RegMask
126                : CSR_AArch64_CXX_TLS_Darwin_RegMask;
127   if (CC == CallingConv::AArch64_VectorCall)
128     return SCS ? CSR_AArch64_AAVPCS_SCS_RegMask : CSR_AArch64_AAVPCS_RegMask;
129   if (CC == CallingConv::AArch64_SVE_VectorCall)
130     return SCS ? CSR_AArch64_SVE_AAPCS_SCS_RegMask
131                : CSR_AArch64_SVE_AAPCS_RegMask;
132   if (CC == CallingConv::CFGuard_Check)
133     return CSR_Win_AArch64_CFGuard_Check_RegMask;
134   if (MF.getSubtarget<AArch64Subtarget>().getTargetLowering()
135           ->supportSwiftError() &&
136       MF.getFunction().getAttributes().hasAttrSomewhere(Attribute::SwiftError))
137     return SCS ? CSR_AArch64_AAPCS_SwiftError_SCS_RegMask
138                : CSR_AArch64_AAPCS_SwiftError_RegMask;
139   if (CC == CallingConv::PreserveMost)
140     return SCS ? CSR_AArch64_RT_MostRegs_SCS_RegMask
141                : CSR_AArch64_RT_MostRegs_RegMask;
142   else
143     return SCS ? CSR_AArch64_AAPCS_SCS_RegMask : CSR_AArch64_AAPCS_RegMask;
144 }
145 
getTLSCallPreservedMask() const146 const uint32_t *AArch64RegisterInfo::getTLSCallPreservedMask() const {
147   if (TT.isOSDarwin())
148     return CSR_AArch64_TLS_Darwin_RegMask;
149 
150   assert(TT.isOSBinFormatELF() && "Invalid target");
151   return CSR_AArch64_TLS_ELF_RegMask;
152 }
153 
UpdateCustomCallPreservedMask(MachineFunction & MF,const uint32_t ** Mask) const154 void AArch64RegisterInfo::UpdateCustomCallPreservedMask(MachineFunction &MF,
155                                                  const uint32_t **Mask) const {
156   uint32_t *UpdatedMask = MF.allocateRegMask();
157   unsigned RegMaskSize = MachineOperand::getRegMaskSize(getNumRegs());
158   memcpy(UpdatedMask, *Mask, sizeof(UpdatedMask[0]) * RegMaskSize);
159 
160   for (size_t i = 0; i < AArch64::GPR64commonRegClass.getNumRegs(); ++i) {
161     if (MF.getSubtarget<AArch64Subtarget>().isXRegCustomCalleeSaved(i)) {
162       for (MCSubRegIterator SubReg(AArch64::GPR64commonRegClass.getRegister(i),
163                                    this, true);
164            SubReg.isValid(); ++SubReg) {
165         // See TargetRegisterInfo::getCallPreservedMask for how to interpret the
166         // register mask.
167         UpdatedMask[*SubReg / 32] |= 1u << (*SubReg % 32);
168       }
169     }
170   }
171   *Mask = UpdatedMask;
172 }
173 
getNoPreservedMask() const174 const uint32_t *AArch64RegisterInfo::getNoPreservedMask() const {
175   return CSR_AArch64_NoRegs_RegMask;
176 }
177 
178 const uint32_t *
getThisReturnPreservedMask(const MachineFunction & MF,CallingConv::ID CC) const179 AArch64RegisterInfo::getThisReturnPreservedMask(const MachineFunction &MF,
180                                                 CallingConv::ID CC) const {
181   // This should return a register mask that is the same as that returned by
182   // getCallPreservedMask but that additionally preserves the register used for
183   // the first i64 argument (which must also be the register used to return a
184   // single i64 return value)
185   //
186   // In case that the calling convention does not use the same register for
187   // both, the function should return NULL (does not currently apply)
188   assert(CC != CallingConv::GHC && "should not be GHC calling convention.");
189   return CSR_AArch64_AAPCS_ThisReturn_RegMask;
190 }
191 
getWindowsStackProbePreservedMask() const192 const uint32_t *AArch64RegisterInfo::getWindowsStackProbePreservedMask() const {
193   return CSR_AArch64_StackProbe_Windows_RegMask;
194 }
195 
196 BitVector
getReservedRegs(const MachineFunction & MF) const197 AArch64RegisterInfo::getReservedRegs(const MachineFunction &MF) const {
198   const AArch64FrameLowering *TFI = getFrameLowering(MF);
199 
200   // FIXME: avoid re-calculating this every time.
201   BitVector Reserved(getNumRegs());
202   markSuperRegs(Reserved, AArch64::WSP);
203   markSuperRegs(Reserved, AArch64::WZR);
204 
205   if (TFI->hasFP(MF) || TT.isOSDarwin())
206     markSuperRegs(Reserved, AArch64::W29);
207 
208   for (size_t i = 0; i < AArch64::GPR32commonRegClass.getNumRegs(); ++i) {
209     if (MF.getSubtarget<AArch64Subtarget>().isXRegisterReserved(i))
210       markSuperRegs(Reserved, AArch64::GPR32commonRegClass.getRegister(i));
211   }
212 
213   if (hasBasePointer(MF))
214     markSuperRegs(Reserved, AArch64::W19);
215 
216   // SLH uses register W16/X16 as the taint register.
217   if (MF.getFunction().hasFnAttribute(Attribute::SpeculativeLoadHardening))
218     markSuperRegs(Reserved, AArch64::W16);
219 
220   assert(checkAllSuperRegsMarked(Reserved));
221   return Reserved;
222 }
223 
isReservedReg(const MachineFunction & MF,unsigned Reg) const224 bool AArch64RegisterInfo::isReservedReg(const MachineFunction &MF,
225                                       unsigned Reg) const {
226   return getReservedRegs(MF)[Reg];
227 }
228 
isAnyArgRegReserved(const MachineFunction & MF) const229 bool AArch64RegisterInfo::isAnyArgRegReserved(const MachineFunction &MF) const {
230   return std::any_of(std::begin(*AArch64::GPR64argRegClass.MC),
231                      std::end(*AArch64::GPR64argRegClass.MC),
232                      [this, &MF](MCPhysReg r){return isReservedReg(MF, r);});
233 }
234 
emitReservedArgRegCallError(const MachineFunction & MF) const235 void AArch64RegisterInfo::emitReservedArgRegCallError(
236     const MachineFunction &MF) const {
237   const Function &F = MF.getFunction();
238   F.getContext().diagnose(DiagnosticInfoUnsupported{F, "AArch64 doesn't support"
239     " function calls if any of the argument registers is reserved."});
240 }
241 
isAsmClobberable(const MachineFunction & MF,unsigned PhysReg) const242 bool AArch64RegisterInfo::isAsmClobberable(const MachineFunction &MF,
243                                           unsigned PhysReg) const {
244   return !isReservedReg(MF, PhysReg);
245 }
246 
isConstantPhysReg(unsigned PhysReg) const247 bool AArch64RegisterInfo::isConstantPhysReg(unsigned PhysReg) const {
248   return PhysReg == AArch64::WZR || PhysReg == AArch64::XZR;
249 }
250 
251 const TargetRegisterClass *
getPointerRegClass(const MachineFunction & MF,unsigned Kind) const252 AArch64RegisterInfo::getPointerRegClass(const MachineFunction &MF,
253                                       unsigned Kind) const {
254   return &AArch64::GPR64spRegClass;
255 }
256 
257 const TargetRegisterClass *
getCrossCopyRegClass(const TargetRegisterClass * RC) const258 AArch64RegisterInfo::getCrossCopyRegClass(const TargetRegisterClass *RC) const {
259   if (RC == &AArch64::CCRRegClass)
260     return &AArch64::GPR64RegClass; // Only MSR & MRS copy NZCV.
261   return RC;
262 }
263 
getBaseRegister() const264 unsigned AArch64RegisterInfo::getBaseRegister() const { return AArch64::X19; }
265 
hasBasePointer(const MachineFunction & MF) const266 bool AArch64RegisterInfo::hasBasePointer(const MachineFunction &MF) const {
267   const MachineFrameInfo &MFI = MF.getFrameInfo();
268 
269   // In the presence of variable sized objects or funclets, if the fixed stack
270   // size is large enough that referencing from the FP won't result in things
271   // being in range relatively often, we can use a base pointer to allow access
272   // from the other direction like the SP normally works.
273   //
274   // Furthermore, if both variable sized objects are present, and the
275   // stack needs to be dynamically re-aligned, the base pointer is the only
276   // reliable way to reference the locals.
277   if (MFI.hasVarSizedObjects() || MF.hasEHFunclets()) {
278     if (needsStackRealignment(MF))
279       return true;
280     // Conservatively estimate whether the negative offset from the frame
281     // pointer will be sufficient to reach. If a function has a smallish
282     // frame, it's less likely to have lots of spills and callee saved
283     // space, so it's all more likely to be within range of the frame pointer.
284     // If it's wrong, we'll materialize the constant and still get to the
285     // object; it's just suboptimal. Negative offsets use the unscaled
286     // load/store instructions, which have a 9-bit signed immediate.
287     return MFI.getLocalFrameSize() >= 256;
288   }
289 
290   return false;
291 }
292 
293 Register
getFrameRegister(const MachineFunction & MF) const294 AArch64RegisterInfo::getFrameRegister(const MachineFunction &MF) const {
295   const AArch64FrameLowering *TFI = getFrameLowering(MF);
296   return TFI->hasFP(MF) ? AArch64::FP : AArch64::SP;
297 }
298 
requiresRegisterScavenging(const MachineFunction & MF) const299 bool AArch64RegisterInfo::requiresRegisterScavenging(
300     const MachineFunction &MF) const {
301   return true;
302 }
303 
requiresVirtualBaseRegisters(const MachineFunction & MF) const304 bool AArch64RegisterInfo::requiresVirtualBaseRegisters(
305     const MachineFunction &MF) const {
306   return true;
307 }
308 
309 bool
useFPForScavengingIndex(const MachineFunction & MF) const310 AArch64RegisterInfo::useFPForScavengingIndex(const MachineFunction &MF) const {
311   // This function indicates whether the emergency spillslot should be placed
312   // close to the beginning of the stackframe (closer to FP) or the end
313   // (closer to SP).
314   //
315   // The beginning works most reliably if we have a frame pointer.
316   const AArch64FrameLowering &TFI = *getFrameLowering(MF);
317   return TFI.hasFP(MF);
318 }
319 
requiresFrameIndexScavenging(const MachineFunction & MF) const320 bool AArch64RegisterInfo::requiresFrameIndexScavenging(
321     const MachineFunction &MF) const {
322   return true;
323 }
324 
325 bool
cannotEliminateFrame(const MachineFunction & MF) const326 AArch64RegisterInfo::cannotEliminateFrame(const MachineFunction &MF) const {
327   const MachineFrameInfo &MFI = MF.getFrameInfo();
328   if (MF.getTarget().Options.DisableFramePointerElim(MF) && MFI.adjustsStack())
329     return true;
330   return MFI.hasVarSizedObjects() || MFI.isFrameAddressTaken();
331 }
332 
333 /// needsFrameBaseReg - Returns true if the instruction's frame index
334 /// reference would be better served by a base register other than FP
335 /// or SP. Used by LocalStackFrameAllocation to determine which frame index
336 /// references it should create new base registers for.
needsFrameBaseReg(MachineInstr * MI,int64_t Offset) const337 bool AArch64RegisterInfo::needsFrameBaseReg(MachineInstr *MI,
338                                             int64_t Offset) const {
339   for (unsigned i = 0; !MI->getOperand(i).isFI(); ++i)
340     assert(i < MI->getNumOperands() &&
341            "Instr doesn't have FrameIndex operand!");
342 
343   // It's the load/store FI references that cause issues, as it can be difficult
344   // to materialize the offset if it won't fit in the literal field. Estimate
345   // based on the size of the local frame and some conservative assumptions
346   // about the rest of the stack frame (note, this is pre-regalloc, so
347   // we don't know everything for certain yet) whether this offset is likely
348   // to be out of range of the immediate. Return true if so.
349 
350   // We only generate virtual base registers for loads and stores, so
351   // return false for everything else.
352   if (!MI->mayLoad() && !MI->mayStore())
353     return false;
354 
355   // Without a virtual base register, if the function has variable sized
356   // objects, all fixed-size local references will be via the frame pointer,
357   // Approximate the offset and see if it's legal for the instruction.
358   // Note that the incoming offset is based on the SP value at function entry,
359   // so it'll be negative.
360   MachineFunction &MF = *MI->getParent()->getParent();
361   const AArch64FrameLowering *TFI = getFrameLowering(MF);
362   MachineFrameInfo &MFI = MF.getFrameInfo();
363 
364   // Estimate an offset from the frame pointer.
365   // Conservatively assume all GPR callee-saved registers get pushed.
366   // FP, LR, X19-X28, D8-D15. 64-bits each.
367   int64_t FPOffset = Offset - 16 * 20;
368   // Estimate an offset from the stack pointer.
369   // The incoming offset is relating to the SP at the start of the function,
370   // but when we access the local it'll be relative to the SP after local
371   // allocation, so adjust our SP-relative offset by that allocation size.
372   Offset += MFI.getLocalFrameSize();
373   // Assume that we'll have at least some spill slots allocated.
374   // FIXME: This is a total SWAG number. We should run some statistics
375   //        and pick a real one.
376   Offset += 128; // 128 bytes of spill slots
377 
378   // If there is a frame pointer, try using it.
379   // The FP is only available if there is no dynamic realignment. We
380   // don't know for sure yet whether we'll need that, so we guess based
381   // on whether there are any local variables that would trigger it.
382   if (TFI->hasFP(MF) && isFrameOffsetLegal(MI, AArch64::FP, FPOffset))
383     return false;
384 
385   // If we can reference via the stack pointer or base pointer, try that.
386   // FIXME: This (and the code that resolves the references) can be improved
387   //        to only disallow SP relative references in the live range of
388   //        the VLA(s). In practice, it's unclear how much difference that
389   //        would make, but it may be worth doing.
390   if (isFrameOffsetLegal(MI, AArch64::SP, Offset))
391     return false;
392 
393   // The offset likely isn't legal; we want to allocate a virtual base register.
394   return true;
395 }
396 
isFrameOffsetLegal(const MachineInstr * MI,unsigned BaseReg,int64_t Offset) const397 bool AArch64RegisterInfo::isFrameOffsetLegal(const MachineInstr *MI,
398                                              unsigned BaseReg,
399                                              int64_t Offset) const {
400   assert(MI && "Unable to get the legal offset for nil instruction.");
401   StackOffset SaveOffset(Offset, MVT::i8);
402   return isAArch64FrameOffsetLegal(*MI, SaveOffset) & AArch64FrameOffsetIsLegal;
403 }
404 
405 /// Insert defining instruction(s) for BaseReg to be a pointer to FrameIdx
406 /// at the beginning of the basic block.
materializeFrameBaseRegister(MachineBasicBlock * MBB,unsigned BaseReg,int FrameIdx,int64_t Offset) const407 void AArch64RegisterInfo::materializeFrameBaseRegister(MachineBasicBlock *MBB,
408                                                        unsigned BaseReg,
409                                                        int FrameIdx,
410                                                        int64_t Offset) const {
411   MachineBasicBlock::iterator Ins = MBB->begin();
412   DebugLoc DL; // Defaults to "unknown"
413   if (Ins != MBB->end())
414     DL = Ins->getDebugLoc();
415   const MachineFunction &MF = *MBB->getParent();
416   const AArch64InstrInfo *TII =
417       MF.getSubtarget<AArch64Subtarget>().getInstrInfo();
418   const MCInstrDesc &MCID = TII->get(AArch64::ADDXri);
419   MachineRegisterInfo &MRI = MBB->getParent()->getRegInfo();
420   MRI.constrainRegClass(BaseReg, TII->getRegClass(MCID, 0, this, MF));
421   unsigned Shifter = AArch64_AM::getShifterImm(AArch64_AM::LSL, 0);
422 
423   BuildMI(*MBB, Ins, DL, MCID, BaseReg)
424       .addFrameIndex(FrameIdx)
425       .addImm(Offset)
426       .addImm(Shifter);
427 }
428 
resolveFrameIndex(MachineInstr & MI,unsigned BaseReg,int64_t Offset) const429 void AArch64RegisterInfo::resolveFrameIndex(MachineInstr &MI, unsigned BaseReg,
430                                             int64_t Offset) const {
431   // ARM doesn't need the general 64-bit offsets
432   StackOffset Off(Offset, MVT::i8);
433 
434   unsigned i = 0;
435 
436   while (!MI.getOperand(i).isFI()) {
437     ++i;
438     assert(i < MI.getNumOperands() && "Instr doesn't have FrameIndex operand!");
439   }
440   const MachineFunction *MF = MI.getParent()->getParent();
441   const AArch64InstrInfo *TII =
442       MF->getSubtarget<AArch64Subtarget>().getInstrInfo();
443   bool Done = rewriteAArch64FrameIndex(MI, i, BaseReg, Off, TII);
444   assert(Done && "Unable to resolve frame index!");
445   (void)Done;
446 }
447 
eliminateFrameIndex(MachineBasicBlock::iterator II,int SPAdj,unsigned FIOperandNum,RegScavenger * RS) const448 void AArch64RegisterInfo::eliminateFrameIndex(MachineBasicBlock::iterator II,
449                                               int SPAdj, unsigned FIOperandNum,
450                                               RegScavenger *RS) const {
451   assert(SPAdj == 0 && "Unexpected");
452 
453   MachineInstr &MI = *II;
454   MachineBasicBlock &MBB = *MI.getParent();
455   MachineFunction &MF = *MBB.getParent();
456   const MachineFrameInfo &MFI = MF.getFrameInfo();
457   const AArch64InstrInfo *TII =
458       MF.getSubtarget<AArch64Subtarget>().getInstrInfo();
459   const AArch64FrameLowering *TFI = getFrameLowering(MF);
460 
461   int FrameIndex = MI.getOperand(FIOperandNum).getIndex();
462   bool Tagged =
463       MI.getOperand(FIOperandNum).getTargetFlags() & AArch64II::MO_TAGGED;
464   unsigned FrameReg;
465 
466   // Special handling of dbg_value, stackmap and patchpoint instructions.
467   if (MI.isDebugValue() || MI.getOpcode() == TargetOpcode::STACKMAP ||
468       MI.getOpcode() == TargetOpcode::PATCHPOINT) {
469     StackOffset Offset =
470         TFI->resolveFrameIndexReference(MF, FrameIndex, FrameReg,
471                                         /*PreferFP=*/true,
472                                         /*ForSimm=*/false);
473     Offset += StackOffset(MI.getOperand(FIOperandNum + 1).getImm(), MVT::i8);
474     MI.getOperand(FIOperandNum).ChangeToRegister(FrameReg, false /*isDef*/);
475     MI.getOperand(FIOperandNum + 1).ChangeToImmediate(Offset.getBytes());
476     return;
477   }
478 
479   if (MI.getOpcode() == TargetOpcode::LOCAL_ESCAPE) {
480     MachineOperand &FI = MI.getOperand(FIOperandNum);
481     int Offset = TFI->getNonLocalFrameIndexReference(MF, FrameIndex);
482     FI.ChangeToImmediate(Offset);
483     return;
484   }
485 
486   StackOffset Offset;
487   if (MI.getOpcode() == AArch64::TAGPstack) {
488     // TAGPstack must use the virtual frame register in its 3rd operand.
489     const AArch64FunctionInfo *AFI = MF.getInfo<AArch64FunctionInfo>();
490     FrameReg = MI.getOperand(3).getReg();
491     Offset = {MFI.getObjectOffset(FrameIndex) +
492                   AFI->getTaggedBasePointerOffset(),
493               MVT::i8};
494   } else if (Tagged) {
495     StackOffset SPOffset = {
496         MFI.getObjectOffset(FrameIndex) + (int64_t)MFI.getStackSize(), MVT::i8};
497     if (MFI.hasVarSizedObjects() ||
498         isAArch64FrameOffsetLegal(MI, SPOffset, nullptr, nullptr, nullptr) !=
499             (AArch64FrameOffsetCanUpdate | AArch64FrameOffsetIsLegal)) {
500       // Can't update to SP + offset in place. Precalculate the tagged pointer
501       // in a scratch register.
502       Offset = TFI->resolveFrameIndexReference(
503           MF, FrameIndex, FrameReg, /*PreferFP=*/false, /*ForSimm=*/true);
504       Register ScratchReg =
505           MF.getRegInfo().createVirtualRegister(&AArch64::GPR64RegClass);
506       emitFrameOffset(MBB, II, MI.getDebugLoc(), ScratchReg, FrameReg, Offset,
507                       TII);
508       BuildMI(MBB, MI, MI.getDebugLoc(), TII->get(AArch64::LDG), ScratchReg)
509           .addReg(ScratchReg)
510           .addReg(ScratchReg)
511           .addImm(0);
512       MI.getOperand(FIOperandNum)
513           .ChangeToRegister(ScratchReg, false, false, true);
514       return;
515     }
516     FrameReg = AArch64::SP;
517     Offset = {MFI.getObjectOffset(FrameIndex) + (int64_t)MFI.getStackSize(),
518               MVT::i8};
519   } else {
520     Offset = TFI->resolveFrameIndexReference(
521         MF, FrameIndex, FrameReg, /*PreferFP=*/false, /*ForSimm=*/true);
522   }
523 
524   // Modify MI as necessary to handle as much of 'Offset' as possible
525   if (rewriteAArch64FrameIndex(MI, FIOperandNum, FrameReg, Offset, TII))
526     return;
527 
528   assert((!RS || !RS->isScavengingFrameIndex(FrameIndex)) &&
529          "Emergency spill slot is out of reach");
530 
531   // If we get here, the immediate doesn't fit into the instruction.  We folded
532   // as much as possible above.  Handle the rest, providing a register that is
533   // SP+LargeImm.
534   Register ScratchReg =
535       MF.getRegInfo().createVirtualRegister(&AArch64::GPR64RegClass);
536   emitFrameOffset(MBB, II, MI.getDebugLoc(), ScratchReg, FrameReg, Offset, TII);
537   MI.getOperand(FIOperandNum).ChangeToRegister(ScratchReg, false, false, true);
538 }
539 
getRegPressureLimit(const TargetRegisterClass * RC,MachineFunction & MF) const540 unsigned AArch64RegisterInfo::getRegPressureLimit(const TargetRegisterClass *RC,
541                                                   MachineFunction &MF) const {
542   const AArch64FrameLowering *TFI = getFrameLowering(MF);
543 
544   switch (RC->getID()) {
545   default:
546     return 0;
547   case AArch64::GPR32RegClassID:
548   case AArch64::GPR32spRegClassID:
549   case AArch64::GPR32allRegClassID:
550   case AArch64::GPR64spRegClassID:
551   case AArch64::GPR64allRegClassID:
552   case AArch64::GPR64RegClassID:
553   case AArch64::GPR32commonRegClassID:
554   case AArch64::GPR64commonRegClassID:
555     return 32 - 1                                   // XZR/SP
556               - (TFI->hasFP(MF) || TT.isOSDarwin()) // FP
557               - MF.getSubtarget<AArch64Subtarget>().getNumXRegisterReserved()
558               - hasBasePointer(MF);  // X19
559   case AArch64::FPR8RegClassID:
560   case AArch64::FPR16RegClassID:
561   case AArch64::FPR32RegClassID:
562   case AArch64::FPR64RegClassID:
563   case AArch64::FPR128RegClassID:
564     return 32;
565 
566   case AArch64::DDRegClassID:
567   case AArch64::DDDRegClassID:
568   case AArch64::DDDDRegClassID:
569   case AArch64::QQRegClassID:
570   case AArch64::QQQRegClassID:
571   case AArch64::QQQQRegClassID:
572     return 32;
573 
574   case AArch64::FPR128_loRegClassID:
575     return 16;
576   }
577 }
578 
getLocalAddressRegister(const MachineFunction & MF) const579 unsigned AArch64RegisterInfo::getLocalAddressRegister(
580   const MachineFunction &MF) const {
581   const auto &MFI = MF.getFrameInfo();
582   if (!MF.hasEHFunclets() && !MFI.hasVarSizedObjects())
583     return AArch64::SP;
584   else if (needsStackRealignment(MF))
585     return getBaseRegister();
586   return getFrameRegister(MF);
587 }
588