xref: /freebsd/contrib/llvm-project/llvm/lib/Target/AArch64/AArch64RegisterInfo.cpp (revision 480093f4440d54b30b3025afeac24b48f2ba7a2e)
10b57cec5SDimitry Andric //===- AArch64RegisterInfo.cpp - AArch64 Register Information -------------===//
20b57cec5SDimitry Andric //
30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60b57cec5SDimitry Andric //
70b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
80b57cec5SDimitry Andric //
90b57cec5SDimitry Andric // This file contains the AArch64 implementation of the TargetRegisterInfo
100b57cec5SDimitry Andric // class.
110b57cec5SDimitry Andric //
120b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
130b57cec5SDimitry Andric 
140b57cec5SDimitry Andric #include "AArch64RegisterInfo.h"
150b57cec5SDimitry Andric #include "AArch64FrameLowering.h"
160b57cec5SDimitry Andric #include "AArch64InstrInfo.h"
170b57cec5SDimitry Andric #include "AArch64MachineFunctionInfo.h"
188bcb0991SDimitry Andric #include "AArch64StackOffset.h"
190b57cec5SDimitry Andric #include "AArch64Subtarget.h"
200b57cec5SDimitry Andric #include "MCTargetDesc/AArch64AddressingModes.h"
210b57cec5SDimitry Andric #include "llvm/ADT/BitVector.h"
220b57cec5SDimitry Andric #include "llvm/ADT/Triple.h"
230b57cec5SDimitry Andric #include "llvm/CodeGen/MachineFrameInfo.h"
240b57cec5SDimitry Andric #include "llvm/CodeGen/MachineInstrBuilder.h"
250b57cec5SDimitry Andric #include "llvm/CodeGen/MachineRegisterInfo.h"
260b57cec5SDimitry Andric #include "llvm/CodeGen/RegisterScavenging.h"
270b57cec5SDimitry Andric #include "llvm/CodeGen/TargetFrameLowering.h"
288bcb0991SDimitry Andric #include "llvm/IR/DiagnosticInfo.h"
298bcb0991SDimitry Andric #include "llvm/IR/Function.h"
308bcb0991SDimitry Andric #include "llvm/Support/raw_ostream.h"
310b57cec5SDimitry Andric #include "llvm/Target/TargetOptions.h"
320b57cec5SDimitry Andric 
330b57cec5SDimitry Andric using namespace llvm;
340b57cec5SDimitry Andric 
350b57cec5SDimitry Andric #define GET_REGINFO_TARGET_DESC
360b57cec5SDimitry Andric #include "AArch64GenRegisterInfo.inc"
370b57cec5SDimitry Andric 
380b57cec5SDimitry Andric AArch64RegisterInfo::AArch64RegisterInfo(const Triple &TT)
390b57cec5SDimitry Andric     : AArch64GenRegisterInfo(AArch64::LR), TT(TT) {
400b57cec5SDimitry Andric   AArch64_MC::initLLVMToCVRegMapping(this);
410b57cec5SDimitry Andric }
420b57cec5SDimitry Andric 
430b57cec5SDimitry Andric const MCPhysReg *
440b57cec5SDimitry Andric AArch64RegisterInfo::getCalleeSavedRegs(const MachineFunction *MF) const {
450b57cec5SDimitry Andric   assert(MF && "Invalid MachineFunction pointer.");
46*480093f4SDimitry Andric   if (MF->getFunction().getCallingConv() == CallingConv::CFGuard_Check)
47*480093f4SDimitry Andric     return CSR_Win_AArch64_CFGuard_Check_SaveList;
480b57cec5SDimitry Andric   if (MF->getSubtarget<AArch64Subtarget>().isTargetWindows())
490b57cec5SDimitry Andric     return CSR_Win_AArch64_AAPCS_SaveList;
500b57cec5SDimitry Andric   if (MF->getFunction().getCallingConv() == CallingConv::GHC)
510b57cec5SDimitry Andric     // GHC set of callee saved regs is empty as all those regs are
520b57cec5SDimitry Andric     // used for passing STG regs around
530b57cec5SDimitry Andric     return CSR_AArch64_NoRegs_SaveList;
540b57cec5SDimitry Andric   if (MF->getFunction().getCallingConv() == CallingConv::AnyReg)
550b57cec5SDimitry Andric     return CSR_AArch64_AllRegs_SaveList;
560b57cec5SDimitry Andric   if (MF->getFunction().getCallingConv() == CallingConv::AArch64_VectorCall)
570b57cec5SDimitry Andric     return CSR_AArch64_AAVPCS_SaveList;
58*480093f4SDimitry Andric   if (MF->getFunction().getCallingConv() == CallingConv::AArch64_SVE_VectorCall)
59*480093f4SDimitry Andric     return CSR_AArch64_SVE_AAPCS_SaveList;
600b57cec5SDimitry Andric   if (MF->getFunction().getCallingConv() == CallingConv::CXX_FAST_TLS)
610b57cec5SDimitry Andric     return MF->getInfo<AArch64FunctionInfo>()->isSplitCSR() ?
620b57cec5SDimitry Andric            CSR_AArch64_CXX_TLS_Darwin_PE_SaveList :
630b57cec5SDimitry Andric            CSR_AArch64_CXX_TLS_Darwin_SaveList;
640b57cec5SDimitry Andric   if (MF->getSubtarget<AArch64Subtarget>().getTargetLowering()
650b57cec5SDimitry Andric           ->supportSwiftError() &&
660b57cec5SDimitry Andric       MF->getFunction().getAttributes().hasAttrSomewhere(
670b57cec5SDimitry Andric           Attribute::SwiftError))
680b57cec5SDimitry Andric     return CSR_AArch64_AAPCS_SwiftError_SaveList;
690b57cec5SDimitry Andric   if (MF->getFunction().getCallingConv() == CallingConv::PreserveMost)
700b57cec5SDimitry Andric     return CSR_AArch64_RT_MostRegs_SaveList;
718bcb0991SDimitry Andric   if (MF->getSubtarget<AArch64Subtarget>().isTargetDarwin())
728bcb0991SDimitry Andric     return CSR_Darwin_AArch64_AAPCS_SaveList;
730b57cec5SDimitry Andric   return CSR_AArch64_AAPCS_SaveList;
740b57cec5SDimitry Andric }
750b57cec5SDimitry Andric 
760b57cec5SDimitry Andric const MCPhysReg *AArch64RegisterInfo::getCalleeSavedRegsViaCopy(
770b57cec5SDimitry Andric     const MachineFunction *MF) const {
780b57cec5SDimitry Andric   assert(MF && "Invalid MachineFunction pointer.");
790b57cec5SDimitry Andric   if (MF->getFunction().getCallingConv() == CallingConv::CXX_FAST_TLS &&
800b57cec5SDimitry Andric       MF->getInfo<AArch64FunctionInfo>()->isSplitCSR())
810b57cec5SDimitry Andric     return CSR_AArch64_CXX_TLS_Darwin_ViaCopy_SaveList;
820b57cec5SDimitry Andric   return nullptr;
830b57cec5SDimitry Andric }
840b57cec5SDimitry Andric 
850b57cec5SDimitry Andric void AArch64RegisterInfo::UpdateCustomCalleeSavedRegs(
860b57cec5SDimitry Andric     MachineFunction &MF) const {
870b57cec5SDimitry Andric   const MCPhysReg *CSRs = getCalleeSavedRegs(&MF);
880b57cec5SDimitry Andric   SmallVector<MCPhysReg, 32> UpdatedCSRs;
890b57cec5SDimitry Andric   for (const MCPhysReg *I = CSRs; *I; ++I)
900b57cec5SDimitry Andric     UpdatedCSRs.push_back(*I);
910b57cec5SDimitry Andric 
920b57cec5SDimitry Andric   for (size_t i = 0; i < AArch64::GPR64commonRegClass.getNumRegs(); ++i) {
930b57cec5SDimitry Andric     if (MF.getSubtarget<AArch64Subtarget>().isXRegCustomCalleeSaved(i)) {
940b57cec5SDimitry Andric       UpdatedCSRs.push_back(AArch64::GPR64commonRegClass.getRegister(i));
950b57cec5SDimitry Andric     }
960b57cec5SDimitry Andric   }
970b57cec5SDimitry Andric   // Register lists are zero-terminated.
980b57cec5SDimitry Andric   UpdatedCSRs.push_back(0);
990b57cec5SDimitry Andric   MF.getRegInfo().setCalleeSavedRegs(UpdatedCSRs);
1000b57cec5SDimitry Andric }
1010b57cec5SDimitry Andric 
1020b57cec5SDimitry Andric const TargetRegisterClass *
1030b57cec5SDimitry Andric AArch64RegisterInfo::getSubClassWithSubReg(const TargetRegisterClass *RC,
1040b57cec5SDimitry Andric                                        unsigned Idx) const {
1050b57cec5SDimitry Andric   // edge case for GPR/FPR register classes
1060b57cec5SDimitry Andric   if (RC == &AArch64::GPR32allRegClass && Idx == AArch64::hsub)
1070b57cec5SDimitry Andric     return &AArch64::FPR32RegClass;
1080b57cec5SDimitry Andric   else if (RC == &AArch64::GPR64allRegClass && Idx == AArch64::hsub)
1090b57cec5SDimitry Andric     return &AArch64::FPR64RegClass;
1100b57cec5SDimitry Andric 
1110b57cec5SDimitry Andric   // Forward to TableGen's default version.
1120b57cec5SDimitry Andric   return AArch64GenRegisterInfo::getSubClassWithSubReg(RC, Idx);
1130b57cec5SDimitry Andric }
1140b57cec5SDimitry Andric 
1150b57cec5SDimitry Andric const uint32_t *
1160b57cec5SDimitry Andric AArch64RegisterInfo::getCallPreservedMask(const MachineFunction &MF,
1170b57cec5SDimitry Andric                                           CallingConv::ID CC) const {
1180b57cec5SDimitry Andric   bool SCS = MF.getFunction().hasFnAttribute(Attribute::ShadowCallStack);
1190b57cec5SDimitry Andric   if (CC == CallingConv::GHC)
1200b57cec5SDimitry Andric     // This is academic because all GHC calls are (supposed to be) tail calls
1210b57cec5SDimitry Andric     return SCS ? CSR_AArch64_NoRegs_SCS_RegMask : CSR_AArch64_NoRegs_RegMask;
1220b57cec5SDimitry Andric   if (CC == CallingConv::AnyReg)
1230b57cec5SDimitry Andric     return SCS ? CSR_AArch64_AllRegs_SCS_RegMask : CSR_AArch64_AllRegs_RegMask;
1240b57cec5SDimitry Andric   if (CC == CallingConv::CXX_FAST_TLS)
1250b57cec5SDimitry Andric     return SCS ? CSR_AArch64_CXX_TLS_Darwin_SCS_RegMask
1260b57cec5SDimitry Andric                : CSR_AArch64_CXX_TLS_Darwin_RegMask;
1270b57cec5SDimitry Andric   if (CC == CallingConv::AArch64_VectorCall)
1280b57cec5SDimitry Andric     return SCS ? CSR_AArch64_AAVPCS_SCS_RegMask : CSR_AArch64_AAVPCS_RegMask;
1298bcb0991SDimitry Andric   if (CC == CallingConv::AArch64_SVE_VectorCall)
130*480093f4SDimitry Andric     return SCS ? CSR_AArch64_SVE_AAPCS_SCS_RegMask
131*480093f4SDimitry Andric                : CSR_AArch64_SVE_AAPCS_RegMask;
132*480093f4SDimitry Andric   if (CC == CallingConv::CFGuard_Check)
133*480093f4SDimitry Andric     return CSR_Win_AArch64_CFGuard_Check_RegMask;
1340b57cec5SDimitry Andric   if (MF.getSubtarget<AArch64Subtarget>().getTargetLowering()
1350b57cec5SDimitry Andric           ->supportSwiftError() &&
1360b57cec5SDimitry Andric       MF.getFunction().getAttributes().hasAttrSomewhere(Attribute::SwiftError))
1370b57cec5SDimitry Andric     return SCS ? CSR_AArch64_AAPCS_SwiftError_SCS_RegMask
1380b57cec5SDimitry Andric                : CSR_AArch64_AAPCS_SwiftError_RegMask;
1390b57cec5SDimitry Andric   if (CC == CallingConv::PreserveMost)
1400b57cec5SDimitry Andric     return SCS ? CSR_AArch64_RT_MostRegs_SCS_RegMask
1410b57cec5SDimitry Andric                : CSR_AArch64_RT_MostRegs_RegMask;
1420b57cec5SDimitry Andric   else
1430b57cec5SDimitry Andric     return SCS ? CSR_AArch64_AAPCS_SCS_RegMask : CSR_AArch64_AAPCS_RegMask;
1440b57cec5SDimitry Andric }
1450b57cec5SDimitry Andric 
1460b57cec5SDimitry Andric const uint32_t *AArch64RegisterInfo::getTLSCallPreservedMask() const {
1470b57cec5SDimitry Andric   if (TT.isOSDarwin())
1480b57cec5SDimitry Andric     return CSR_AArch64_TLS_Darwin_RegMask;
1490b57cec5SDimitry Andric 
1500b57cec5SDimitry Andric   assert(TT.isOSBinFormatELF() && "Invalid target");
1510b57cec5SDimitry Andric   return CSR_AArch64_TLS_ELF_RegMask;
1520b57cec5SDimitry Andric }
1530b57cec5SDimitry Andric 
1540b57cec5SDimitry Andric void AArch64RegisterInfo::UpdateCustomCallPreservedMask(MachineFunction &MF,
1550b57cec5SDimitry Andric                                                  const uint32_t **Mask) const {
1560b57cec5SDimitry Andric   uint32_t *UpdatedMask = MF.allocateRegMask();
1570b57cec5SDimitry Andric   unsigned RegMaskSize = MachineOperand::getRegMaskSize(getNumRegs());
1580b57cec5SDimitry Andric   memcpy(UpdatedMask, *Mask, sizeof(UpdatedMask[0]) * RegMaskSize);
1590b57cec5SDimitry Andric 
1600b57cec5SDimitry Andric   for (size_t i = 0; i < AArch64::GPR64commonRegClass.getNumRegs(); ++i) {
1610b57cec5SDimitry Andric     if (MF.getSubtarget<AArch64Subtarget>().isXRegCustomCalleeSaved(i)) {
1620b57cec5SDimitry Andric       for (MCSubRegIterator SubReg(AArch64::GPR64commonRegClass.getRegister(i),
1630b57cec5SDimitry Andric                                    this, true);
1640b57cec5SDimitry Andric            SubReg.isValid(); ++SubReg) {
1650b57cec5SDimitry Andric         // See TargetRegisterInfo::getCallPreservedMask for how to interpret the
1660b57cec5SDimitry Andric         // register mask.
1670b57cec5SDimitry Andric         UpdatedMask[*SubReg / 32] |= 1u << (*SubReg % 32);
1680b57cec5SDimitry Andric       }
1690b57cec5SDimitry Andric     }
1700b57cec5SDimitry Andric   }
1710b57cec5SDimitry Andric   *Mask = UpdatedMask;
1720b57cec5SDimitry Andric }
1730b57cec5SDimitry Andric 
1740b57cec5SDimitry Andric const uint32_t *AArch64RegisterInfo::getNoPreservedMask() const {
1750b57cec5SDimitry Andric   return CSR_AArch64_NoRegs_RegMask;
1760b57cec5SDimitry Andric }
1770b57cec5SDimitry Andric 
1780b57cec5SDimitry Andric const uint32_t *
1790b57cec5SDimitry Andric AArch64RegisterInfo::getThisReturnPreservedMask(const MachineFunction &MF,
1800b57cec5SDimitry Andric                                                 CallingConv::ID CC) const {
1810b57cec5SDimitry Andric   // This should return a register mask that is the same as that returned by
1820b57cec5SDimitry Andric   // getCallPreservedMask but that additionally preserves the register used for
1830b57cec5SDimitry Andric   // the first i64 argument (which must also be the register used to return a
1840b57cec5SDimitry Andric   // single i64 return value)
1850b57cec5SDimitry Andric   //
1860b57cec5SDimitry Andric   // In case that the calling convention does not use the same register for
1870b57cec5SDimitry Andric   // both, the function should return NULL (does not currently apply)
1880b57cec5SDimitry Andric   assert(CC != CallingConv::GHC && "should not be GHC calling convention.");
1890b57cec5SDimitry Andric   return CSR_AArch64_AAPCS_ThisReturn_RegMask;
1900b57cec5SDimitry Andric }
1910b57cec5SDimitry Andric 
1920b57cec5SDimitry Andric const uint32_t *AArch64RegisterInfo::getWindowsStackProbePreservedMask() const {
1930b57cec5SDimitry Andric   return CSR_AArch64_StackProbe_Windows_RegMask;
1940b57cec5SDimitry Andric }
1950b57cec5SDimitry Andric 
1960b57cec5SDimitry Andric BitVector
1970b57cec5SDimitry Andric AArch64RegisterInfo::getReservedRegs(const MachineFunction &MF) const {
1980b57cec5SDimitry Andric   const AArch64FrameLowering *TFI = getFrameLowering(MF);
1990b57cec5SDimitry Andric 
2000b57cec5SDimitry Andric   // FIXME: avoid re-calculating this every time.
2010b57cec5SDimitry Andric   BitVector Reserved(getNumRegs());
2020b57cec5SDimitry Andric   markSuperRegs(Reserved, AArch64::WSP);
2030b57cec5SDimitry Andric   markSuperRegs(Reserved, AArch64::WZR);
2040b57cec5SDimitry Andric 
2050b57cec5SDimitry Andric   if (TFI->hasFP(MF) || TT.isOSDarwin())
2060b57cec5SDimitry Andric     markSuperRegs(Reserved, AArch64::W29);
2070b57cec5SDimitry Andric 
2080b57cec5SDimitry Andric   for (size_t i = 0; i < AArch64::GPR32commonRegClass.getNumRegs(); ++i) {
2090b57cec5SDimitry Andric     if (MF.getSubtarget<AArch64Subtarget>().isXRegisterReserved(i))
2100b57cec5SDimitry Andric       markSuperRegs(Reserved, AArch64::GPR32commonRegClass.getRegister(i));
2110b57cec5SDimitry Andric   }
2120b57cec5SDimitry Andric 
2130b57cec5SDimitry Andric   if (hasBasePointer(MF))
2140b57cec5SDimitry Andric     markSuperRegs(Reserved, AArch64::W19);
2150b57cec5SDimitry Andric 
2160b57cec5SDimitry Andric   // SLH uses register W16/X16 as the taint register.
2170b57cec5SDimitry Andric   if (MF.getFunction().hasFnAttribute(Attribute::SpeculativeLoadHardening))
2180b57cec5SDimitry Andric     markSuperRegs(Reserved, AArch64::W16);
2190b57cec5SDimitry Andric 
2200b57cec5SDimitry Andric   assert(checkAllSuperRegsMarked(Reserved));
2210b57cec5SDimitry Andric   return Reserved;
2220b57cec5SDimitry Andric }
2230b57cec5SDimitry Andric 
2240b57cec5SDimitry Andric bool AArch64RegisterInfo::isReservedReg(const MachineFunction &MF,
2250b57cec5SDimitry Andric                                       unsigned Reg) const {
2260b57cec5SDimitry Andric   return getReservedRegs(MF)[Reg];
2270b57cec5SDimitry Andric }
2280b57cec5SDimitry Andric 
2290b57cec5SDimitry Andric bool AArch64RegisterInfo::isAnyArgRegReserved(const MachineFunction &MF) const {
2300b57cec5SDimitry Andric   return std::any_of(std::begin(*AArch64::GPR64argRegClass.MC),
2310b57cec5SDimitry Andric                      std::end(*AArch64::GPR64argRegClass.MC),
2320b57cec5SDimitry Andric                      [this, &MF](MCPhysReg r){return isReservedReg(MF, r);});
2330b57cec5SDimitry Andric }
2340b57cec5SDimitry Andric 
2350b57cec5SDimitry Andric void AArch64RegisterInfo::emitReservedArgRegCallError(
2360b57cec5SDimitry Andric     const MachineFunction &MF) const {
2370b57cec5SDimitry Andric   const Function &F = MF.getFunction();
2380b57cec5SDimitry Andric   F.getContext().diagnose(DiagnosticInfoUnsupported{F, "AArch64 doesn't support"
2390b57cec5SDimitry Andric     " function calls if any of the argument registers is reserved."});
2400b57cec5SDimitry Andric }
2410b57cec5SDimitry Andric 
2420b57cec5SDimitry Andric bool AArch64RegisterInfo::isAsmClobberable(const MachineFunction &MF,
2430b57cec5SDimitry Andric                                           unsigned PhysReg) const {
2440b57cec5SDimitry Andric   return !isReservedReg(MF, PhysReg);
2450b57cec5SDimitry Andric }
2460b57cec5SDimitry Andric 
2470b57cec5SDimitry Andric bool AArch64RegisterInfo::isConstantPhysReg(unsigned PhysReg) const {
2480b57cec5SDimitry Andric   return PhysReg == AArch64::WZR || PhysReg == AArch64::XZR;
2490b57cec5SDimitry Andric }
2500b57cec5SDimitry Andric 
2510b57cec5SDimitry Andric const TargetRegisterClass *
2520b57cec5SDimitry Andric AArch64RegisterInfo::getPointerRegClass(const MachineFunction &MF,
2530b57cec5SDimitry Andric                                       unsigned Kind) const {
2540b57cec5SDimitry Andric   return &AArch64::GPR64spRegClass;
2550b57cec5SDimitry Andric }
2560b57cec5SDimitry Andric 
2570b57cec5SDimitry Andric const TargetRegisterClass *
2580b57cec5SDimitry Andric AArch64RegisterInfo::getCrossCopyRegClass(const TargetRegisterClass *RC) const {
2590b57cec5SDimitry Andric   if (RC == &AArch64::CCRRegClass)
2600b57cec5SDimitry Andric     return &AArch64::GPR64RegClass; // Only MSR & MRS copy NZCV.
2610b57cec5SDimitry Andric   return RC;
2620b57cec5SDimitry Andric }
2630b57cec5SDimitry Andric 
2640b57cec5SDimitry Andric unsigned AArch64RegisterInfo::getBaseRegister() const { return AArch64::X19; }
2650b57cec5SDimitry Andric 
2660b57cec5SDimitry Andric bool AArch64RegisterInfo::hasBasePointer(const MachineFunction &MF) const {
2670b57cec5SDimitry Andric   const MachineFrameInfo &MFI = MF.getFrameInfo();
2680b57cec5SDimitry Andric 
2690b57cec5SDimitry Andric   // In the presence of variable sized objects or funclets, if the fixed stack
2700b57cec5SDimitry Andric   // size is large enough that referencing from the FP won't result in things
2710b57cec5SDimitry Andric   // being in range relatively often, we can use a base pointer to allow access
2720b57cec5SDimitry Andric   // from the other direction like the SP normally works.
2730b57cec5SDimitry Andric   //
2740b57cec5SDimitry Andric   // Furthermore, if both variable sized objects are present, and the
2750b57cec5SDimitry Andric   // stack needs to be dynamically re-aligned, the base pointer is the only
2760b57cec5SDimitry Andric   // reliable way to reference the locals.
2770b57cec5SDimitry Andric   if (MFI.hasVarSizedObjects() || MF.hasEHFunclets()) {
2780b57cec5SDimitry Andric     if (needsStackRealignment(MF))
2790b57cec5SDimitry Andric       return true;
2800b57cec5SDimitry Andric     // Conservatively estimate whether the negative offset from the frame
2810b57cec5SDimitry Andric     // pointer will be sufficient to reach. If a function has a smallish
2820b57cec5SDimitry Andric     // frame, it's less likely to have lots of spills and callee saved
2830b57cec5SDimitry Andric     // space, so it's all more likely to be within range of the frame pointer.
2840b57cec5SDimitry Andric     // If it's wrong, we'll materialize the constant and still get to the
2850b57cec5SDimitry Andric     // object; it's just suboptimal. Negative offsets use the unscaled
2860b57cec5SDimitry Andric     // load/store instructions, which have a 9-bit signed immediate.
2870b57cec5SDimitry Andric     return MFI.getLocalFrameSize() >= 256;
2880b57cec5SDimitry Andric   }
2890b57cec5SDimitry Andric 
2900b57cec5SDimitry Andric   return false;
2910b57cec5SDimitry Andric }
2920b57cec5SDimitry Andric 
2930b57cec5SDimitry Andric Register
2940b57cec5SDimitry Andric AArch64RegisterInfo::getFrameRegister(const MachineFunction &MF) const {
2950b57cec5SDimitry Andric   const AArch64FrameLowering *TFI = getFrameLowering(MF);
2960b57cec5SDimitry Andric   return TFI->hasFP(MF) ? AArch64::FP : AArch64::SP;
2970b57cec5SDimitry Andric }
2980b57cec5SDimitry Andric 
2990b57cec5SDimitry Andric bool AArch64RegisterInfo::requiresRegisterScavenging(
3000b57cec5SDimitry Andric     const MachineFunction &MF) const {
3010b57cec5SDimitry Andric   return true;
3020b57cec5SDimitry Andric }
3030b57cec5SDimitry Andric 
3040b57cec5SDimitry Andric bool AArch64RegisterInfo::requiresVirtualBaseRegisters(
3050b57cec5SDimitry Andric     const MachineFunction &MF) const {
3060b57cec5SDimitry Andric   return true;
3070b57cec5SDimitry Andric }
3080b57cec5SDimitry Andric 
3090b57cec5SDimitry Andric bool
3100b57cec5SDimitry Andric AArch64RegisterInfo::useFPForScavengingIndex(const MachineFunction &MF) const {
3110b57cec5SDimitry Andric   // This function indicates whether the emergency spillslot should be placed
3120b57cec5SDimitry Andric   // close to the beginning of the stackframe (closer to FP) or the end
3130b57cec5SDimitry Andric   // (closer to SP).
3140b57cec5SDimitry Andric   //
3150b57cec5SDimitry Andric   // The beginning works most reliably if we have a frame pointer.
3160b57cec5SDimitry Andric   const AArch64FrameLowering &TFI = *getFrameLowering(MF);
3170b57cec5SDimitry Andric   return TFI.hasFP(MF);
3180b57cec5SDimitry Andric }
3190b57cec5SDimitry Andric 
3200b57cec5SDimitry Andric bool AArch64RegisterInfo::requiresFrameIndexScavenging(
3210b57cec5SDimitry Andric     const MachineFunction &MF) const {
3220b57cec5SDimitry Andric   return true;
3230b57cec5SDimitry Andric }
3240b57cec5SDimitry Andric 
3250b57cec5SDimitry Andric bool
3260b57cec5SDimitry Andric AArch64RegisterInfo::cannotEliminateFrame(const MachineFunction &MF) const {
3270b57cec5SDimitry Andric   const MachineFrameInfo &MFI = MF.getFrameInfo();
3280b57cec5SDimitry Andric   if (MF.getTarget().Options.DisableFramePointerElim(MF) && MFI.adjustsStack())
3290b57cec5SDimitry Andric     return true;
3300b57cec5SDimitry Andric   return MFI.hasVarSizedObjects() || MFI.isFrameAddressTaken();
3310b57cec5SDimitry Andric }
3320b57cec5SDimitry Andric 
3330b57cec5SDimitry Andric /// needsFrameBaseReg - Returns true if the instruction's frame index
3340b57cec5SDimitry Andric /// reference would be better served by a base register other than FP
3350b57cec5SDimitry Andric /// or SP. Used by LocalStackFrameAllocation to determine which frame index
3360b57cec5SDimitry Andric /// references it should create new base registers for.
3370b57cec5SDimitry Andric bool AArch64RegisterInfo::needsFrameBaseReg(MachineInstr *MI,
3380b57cec5SDimitry Andric                                             int64_t Offset) const {
3390b57cec5SDimitry Andric   for (unsigned i = 0; !MI->getOperand(i).isFI(); ++i)
3400b57cec5SDimitry Andric     assert(i < MI->getNumOperands() &&
3410b57cec5SDimitry Andric            "Instr doesn't have FrameIndex operand!");
3420b57cec5SDimitry Andric 
3430b57cec5SDimitry Andric   // It's the load/store FI references that cause issues, as it can be difficult
3440b57cec5SDimitry Andric   // to materialize the offset if it won't fit in the literal field. Estimate
3450b57cec5SDimitry Andric   // based on the size of the local frame and some conservative assumptions
3460b57cec5SDimitry Andric   // about the rest of the stack frame (note, this is pre-regalloc, so
3470b57cec5SDimitry Andric   // we don't know everything for certain yet) whether this offset is likely
3480b57cec5SDimitry Andric   // to be out of range of the immediate. Return true if so.
3490b57cec5SDimitry Andric 
3500b57cec5SDimitry Andric   // We only generate virtual base registers for loads and stores, so
3510b57cec5SDimitry Andric   // return false for everything else.
3520b57cec5SDimitry Andric   if (!MI->mayLoad() && !MI->mayStore())
3530b57cec5SDimitry Andric     return false;
3540b57cec5SDimitry Andric 
3550b57cec5SDimitry Andric   // Without a virtual base register, if the function has variable sized
3560b57cec5SDimitry Andric   // objects, all fixed-size local references will be via the frame pointer,
3570b57cec5SDimitry Andric   // Approximate the offset and see if it's legal for the instruction.
3580b57cec5SDimitry Andric   // Note that the incoming offset is based on the SP value at function entry,
3590b57cec5SDimitry Andric   // so it'll be negative.
3600b57cec5SDimitry Andric   MachineFunction &MF = *MI->getParent()->getParent();
3610b57cec5SDimitry Andric   const AArch64FrameLowering *TFI = getFrameLowering(MF);
3620b57cec5SDimitry Andric   MachineFrameInfo &MFI = MF.getFrameInfo();
3630b57cec5SDimitry Andric 
3640b57cec5SDimitry Andric   // Estimate an offset from the frame pointer.
3650b57cec5SDimitry Andric   // Conservatively assume all GPR callee-saved registers get pushed.
3660b57cec5SDimitry Andric   // FP, LR, X19-X28, D8-D15. 64-bits each.
3670b57cec5SDimitry Andric   int64_t FPOffset = Offset - 16 * 20;
3680b57cec5SDimitry Andric   // Estimate an offset from the stack pointer.
3690b57cec5SDimitry Andric   // The incoming offset is relating to the SP at the start of the function,
3700b57cec5SDimitry Andric   // but when we access the local it'll be relative to the SP after local
3710b57cec5SDimitry Andric   // allocation, so adjust our SP-relative offset by that allocation size.
3720b57cec5SDimitry Andric   Offset += MFI.getLocalFrameSize();
3730b57cec5SDimitry Andric   // Assume that we'll have at least some spill slots allocated.
3740b57cec5SDimitry Andric   // FIXME: This is a total SWAG number. We should run some statistics
3750b57cec5SDimitry Andric   //        and pick a real one.
3760b57cec5SDimitry Andric   Offset += 128; // 128 bytes of spill slots
3770b57cec5SDimitry Andric 
3780b57cec5SDimitry Andric   // If there is a frame pointer, try using it.
3790b57cec5SDimitry Andric   // The FP is only available if there is no dynamic realignment. We
3800b57cec5SDimitry Andric   // don't know for sure yet whether we'll need that, so we guess based
3810b57cec5SDimitry Andric   // on whether there are any local variables that would trigger it.
3820b57cec5SDimitry Andric   if (TFI->hasFP(MF) && isFrameOffsetLegal(MI, AArch64::FP, FPOffset))
3830b57cec5SDimitry Andric     return false;
3840b57cec5SDimitry Andric 
3850b57cec5SDimitry Andric   // If we can reference via the stack pointer or base pointer, try that.
3860b57cec5SDimitry Andric   // FIXME: This (and the code that resolves the references) can be improved
3870b57cec5SDimitry Andric   //        to only disallow SP relative references in the live range of
3880b57cec5SDimitry Andric   //        the VLA(s). In practice, it's unclear how much difference that
3890b57cec5SDimitry Andric   //        would make, but it may be worth doing.
3900b57cec5SDimitry Andric   if (isFrameOffsetLegal(MI, AArch64::SP, Offset))
3910b57cec5SDimitry Andric     return false;
3920b57cec5SDimitry Andric 
3930b57cec5SDimitry Andric   // The offset likely isn't legal; we want to allocate a virtual base register.
3940b57cec5SDimitry Andric   return true;
3950b57cec5SDimitry Andric }
3960b57cec5SDimitry Andric 
3970b57cec5SDimitry Andric bool AArch64RegisterInfo::isFrameOffsetLegal(const MachineInstr *MI,
3980b57cec5SDimitry Andric                                              unsigned BaseReg,
3990b57cec5SDimitry Andric                                              int64_t Offset) const {
4000b57cec5SDimitry Andric   assert(MI && "Unable to get the legal offset for nil instruction.");
4018bcb0991SDimitry Andric   StackOffset SaveOffset(Offset, MVT::i8);
4020b57cec5SDimitry Andric   return isAArch64FrameOffsetLegal(*MI, SaveOffset) & AArch64FrameOffsetIsLegal;
4030b57cec5SDimitry Andric }
4040b57cec5SDimitry Andric 
4050b57cec5SDimitry Andric /// Insert defining instruction(s) for BaseReg to be a pointer to FrameIdx
4060b57cec5SDimitry Andric /// at the beginning of the basic block.
4070b57cec5SDimitry Andric void AArch64RegisterInfo::materializeFrameBaseRegister(MachineBasicBlock *MBB,
4080b57cec5SDimitry Andric                                                        unsigned BaseReg,
4090b57cec5SDimitry Andric                                                        int FrameIdx,
4100b57cec5SDimitry Andric                                                        int64_t Offset) const {
4110b57cec5SDimitry Andric   MachineBasicBlock::iterator Ins = MBB->begin();
4120b57cec5SDimitry Andric   DebugLoc DL; // Defaults to "unknown"
4130b57cec5SDimitry Andric   if (Ins != MBB->end())
4140b57cec5SDimitry Andric     DL = Ins->getDebugLoc();
4150b57cec5SDimitry Andric   const MachineFunction &MF = *MBB->getParent();
4160b57cec5SDimitry Andric   const AArch64InstrInfo *TII =
4170b57cec5SDimitry Andric       MF.getSubtarget<AArch64Subtarget>().getInstrInfo();
4180b57cec5SDimitry Andric   const MCInstrDesc &MCID = TII->get(AArch64::ADDXri);
4190b57cec5SDimitry Andric   MachineRegisterInfo &MRI = MBB->getParent()->getRegInfo();
4200b57cec5SDimitry Andric   MRI.constrainRegClass(BaseReg, TII->getRegClass(MCID, 0, this, MF));
4210b57cec5SDimitry Andric   unsigned Shifter = AArch64_AM::getShifterImm(AArch64_AM::LSL, 0);
4220b57cec5SDimitry Andric 
4230b57cec5SDimitry Andric   BuildMI(*MBB, Ins, DL, MCID, BaseReg)
4240b57cec5SDimitry Andric       .addFrameIndex(FrameIdx)
4250b57cec5SDimitry Andric       .addImm(Offset)
4260b57cec5SDimitry Andric       .addImm(Shifter);
4270b57cec5SDimitry Andric }
4280b57cec5SDimitry Andric 
4290b57cec5SDimitry Andric void AArch64RegisterInfo::resolveFrameIndex(MachineInstr &MI, unsigned BaseReg,
4300b57cec5SDimitry Andric                                             int64_t Offset) const {
4318bcb0991SDimitry Andric   // ARM doesn't need the general 64-bit offsets
4328bcb0991SDimitry Andric   StackOffset Off(Offset, MVT::i8);
4338bcb0991SDimitry Andric 
4340b57cec5SDimitry Andric   unsigned i = 0;
4350b57cec5SDimitry Andric 
4360b57cec5SDimitry Andric   while (!MI.getOperand(i).isFI()) {
4370b57cec5SDimitry Andric     ++i;
4380b57cec5SDimitry Andric     assert(i < MI.getNumOperands() && "Instr doesn't have FrameIndex operand!");
4390b57cec5SDimitry Andric   }
4400b57cec5SDimitry Andric   const MachineFunction *MF = MI.getParent()->getParent();
4410b57cec5SDimitry Andric   const AArch64InstrInfo *TII =
4420b57cec5SDimitry Andric       MF->getSubtarget<AArch64Subtarget>().getInstrInfo();
4430b57cec5SDimitry Andric   bool Done = rewriteAArch64FrameIndex(MI, i, BaseReg, Off, TII);
4440b57cec5SDimitry Andric   assert(Done && "Unable to resolve frame index!");
4450b57cec5SDimitry Andric   (void)Done;
4460b57cec5SDimitry Andric }
4470b57cec5SDimitry Andric 
4480b57cec5SDimitry Andric void AArch64RegisterInfo::eliminateFrameIndex(MachineBasicBlock::iterator II,
4490b57cec5SDimitry Andric                                               int SPAdj, unsigned FIOperandNum,
4500b57cec5SDimitry Andric                                               RegScavenger *RS) const {
4510b57cec5SDimitry Andric   assert(SPAdj == 0 && "Unexpected");
4520b57cec5SDimitry Andric 
4530b57cec5SDimitry Andric   MachineInstr &MI = *II;
4540b57cec5SDimitry Andric   MachineBasicBlock &MBB = *MI.getParent();
4550b57cec5SDimitry Andric   MachineFunction &MF = *MBB.getParent();
4568bcb0991SDimitry Andric   const MachineFrameInfo &MFI = MF.getFrameInfo();
4570b57cec5SDimitry Andric   const AArch64InstrInfo *TII =
4580b57cec5SDimitry Andric       MF.getSubtarget<AArch64Subtarget>().getInstrInfo();
4590b57cec5SDimitry Andric   const AArch64FrameLowering *TFI = getFrameLowering(MF);
4600b57cec5SDimitry Andric 
4610b57cec5SDimitry Andric   int FrameIndex = MI.getOperand(FIOperandNum).getIndex();
4628bcb0991SDimitry Andric   bool Tagged =
4638bcb0991SDimitry Andric       MI.getOperand(FIOperandNum).getTargetFlags() & AArch64II::MO_TAGGED;
4640b57cec5SDimitry Andric   unsigned FrameReg;
4650b57cec5SDimitry Andric 
4660b57cec5SDimitry Andric   // Special handling of dbg_value, stackmap and patchpoint instructions.
4670b57cec5SDimitry Andric   if (MI.isDebugValue() || MI.getOpcode() == TargetOpcode::STACKMAP ||
4680b57cec5SDimitry Andric       MI.getOpcode() == TargetOpcode::PATCHPOINT) {
4698bcb0991SDimitry Andric     StackOffset Offset =
4708bcb0991SDimitry Andric         TFI->resolveFrameIndexReference(MF, FrameIndex, FrameReg,
4710b57cec5SDimitry Andric                                         /*PreferFP=*/true,
4720b57cec5SDimitry Andric                                         /*ForSimm=*/false);
4738bcb0991SDimitry Andric     Offset += StackOffset(MI.getOperand(FIOperandNum + 1).getImm(), MVT::i8);
4740b57cec5SDimitry Andric     MI.getOperand(FIOperandNum).ChangeToRegister(FrameReg, false /*isDef*/);
4758bcb0991SDimitry Andric     MI.getOperand(FIOperandNum + 1).ChangeToImmediate(Offset.getBytes());
4760b57cec5SDimitry Andric     return;
4770b57cec5SDimitry Andric   }
4780b57cec5SDimitry Andric 
4790b57cec5SDimitry Andric   if (MI.getOpcode() == TargetOpcode::LOCAL_ESCAPE) {
4800b57cec5SDimitry Andric     MachineOperand &FI = MI.getOperand(FIOperandNum);
4818bcb0991SDimitry Andric     int Offset = TFI->getNonLocalFrameIndexReference(MF, FrameIndex);
4820b57cec5SDimitry Andric     FI.ChangeToImmediate(Offset);
4830b57cec5SDimitry Andric     return;
4840b57cec5SDimitry Andric   }
4850b57cec5SDimitry Andric 
4868bcb0991SDimitry Andric   StackOffset Offset;
4870b57cec5SDimitry Andric   if (MI.getOpcode() == AArch64::TAGPstack) {
4880b57cec5SDimitry Andric     // TAGPstack must use the virtual frame register in its 3rd operand.
4890b57cec5SDimitry Andric     const AArch64FunctionInfo *AFI = MF.getInfo<AArch64FunctionInfo>();
4900b57cec5SDimitry Andric     FrameReg = MI.getOperand(3).getReg();
4918bcb0991SDimitry Andric     Offset = {MFI.getObjectOffset(FrameIndex) +
4928bcb0991SDimitry Andric                   AFI->getTaggedBasePointerOffset(),
4938bcb0991SDimitry Andric               MVT::i8};
4948bcb0991SDimitry Andric   } else if (Tagged) {
4958bcb0991SDimitry Andric     StackOffset SPOffset = {
4968bcb0991SDimitry Andric         MFI.getObjectOffset(FrameIndex) + (int64_t)MFI.getStackSize(), MVT::i8};
4978bcb0991SDimitry Andric     if (MFI.hasVarSizedObjects() ||
4988bcb0991SDimitry Andric         isAArch64FrameOffsetLegal(MI, SPOffset, nullptr, nullptr, nullptr) !=
4998bcb0991SDimitry Andric             (AArch64FrameOffsetCanUpdate | AArch64FrameOffsetIsLegal)) {
5008bcb0991SDimitry Andric       // Can't update to SP + offset in place. Precalculate the tagged pointer
5018bcb0991SDimitry Andric       // in a scratch register.
5028bcb0991SDimitry Andric       Offset = TFI->resolveFrameIndexReference(
5038bcb0991SDimitry Andric           MF, FrameIndex, FrameReg, /*PreferFP=*/false, /*ForSimm=*/true);
5048bcb0991SDimitry Andric       Register ScratchReg =
5058bcb0991SDimitry Andric           MF.getRegInfo().createVirtualRegister(&AArch64::GPR64RegClass);
5068bcb0991SDimitry Andric       emitFrameOffset(MBB, II, MI.getDebugLoc(), ScratchReg, FrameReg, Offset,
5078bcb0991SDimitry Andric                       TII);
5088bcb0991SDimitry Andric       BuildMI(MBB, MI, MI.getDebugLoc(), TII->get(AArch64::LDG), ScratchReg)
5098bcb0991SDimitry Andric           .addReg(ScratchReg)
5108bcb0991SDimitry Andric           .addReg(ScratchReg)
5118bcb0991SDimitry Andric           .addImm(0);
5128bcb0991SDimitry Andric       MI.getOperand(FIOperandNum)
5138bcb0991SDimitry Andric           .ChangeToRegister(ScratchReg, false, false, true);
5148bcb0991SDimitry Andric       return;
5158bcb0991SDimitry Andric     }
5168bcb0991SDimitry Andric     FrameReg = AArch64::SP;
5178bcb0991SDimitry Andric     Offset = {MFI.getObjectOffset(FrameIndex) + (int64_t)MFI.getStackSize(),
5188bcb0991SDimitry Andric               MVT::i8};
5190b57cec5SDimitry Andric   } else {
5200b57cec5SDimitry Andric     Offset = TFI->resolveFrameIndexReference(
5210b57cec5SDimitry Andric         MF, FrameIndex, FrameReg, /*PreferFP=*/false, /*ForSimm=*/true);
5220b57cec5SDimitry Andric   }
5230b57cec5SDimitry Andric 
5240b57cec5SDimitry Andric   // Modify MI as necessary to handle as much of 'Offset' as possible
5250b57cec5SDimitry Andric   if (rewriteAArch64FrameIndex(MI, FIOperandNum, FrameReg, Offset, TII))
5260b57cec5SDimitry Andric     return;
5270b57cec5SDimitry Andric 
5280b57cec5SDimitry Andric   assert((!RS || !RS->isScavengingFrameIndex(FrameIndex)) &&
5290b57cec5SDimitry Andric          "Emergency spill slot is out of reach");
5300b57cec5SDimitry Andric 
5310b57cec5SDimitry Andric   // If we get here, the immediate doesn't fit into the instruction.  We folded
5320b57cec5SDimitry Andric   // as much as possible above.  Handle the rest, providing a register that is
5330b57cec5SDimitry Andric   // SP+LargeImm.
5348bcb0991SDimitry Andric   Register ScratchReg =
5350b57cec5SDimitry Andric       MF.getRegInfo().createVirtualRegister(&AArch64::GPR64RegClass);
5360b57cec5SDimitry Andric   emitFrameOffset(MBB, II, MI.getDebugLoc(), ScratchReg, FrameReg, Offset, TII);
5370b57cec5SDimitry Andric   MI.getOperand(FIOperandNum).ChangeToRegister(ScratchReg, false, false, true);
5380b57cec5SDimitry Andric }
5390b57cec5SDimitry Andric 
5400b57cec5SDimitry Andric unsigned AArch64RegisterInfo::getRegPressureLimit(const TargetRegisterClass *RC,
5410b57cec5SDimitry Andric                                                   MachineFunction &MF) const {
5420b57cec5SDimitry Andric   const AArch64FrameLowering *TFI = getFrameLowering(MF);
5430b57cec5SDimitry Andric 
5440b57cec5SDimitry Andric   switch (RC->getID()) {
5450b57cec5SDimitry Andric   default:
5460b57cec5SDimitry Andric     return 0;
5470b57cec5SDimitry Andric   case AArch64::GPR32RegClassID:
5480b57cec5SDimitry Andric   case AArch64::GPR32spRegClassID:
5490b57cec5SDimitry Andric   case AArch64::GPR32allRegClassID:
5500b57cec5SDimitry Andric   case AArch64::GPR64spRegClassID:
5510b57cec5SDimitry Andric   case AArch64::GPR64allRegClassID:
5520b57cec5SDimitry Andric   case AArch64::GPR64RegClassID:
5530b57cec5SDimitry Andric   case AArch64::GPR32commonRegClassID:
5540b57cec5SDimitry Andric   case AArch64::GPR64commonRegClassID:
5550b57cec5SDimitry Andric     return 32 - 1                                   // XZR/SP
5560b57cec5SDimitry Andric               - (TFI->hasFP(MF) || TT.isOSDarwin()) // FP
5570b57cec5SDimitry Andric               - MF.getSubtarget<AArch64Subtarget>().getNumXRegisterReserved()
5580b57cec5SDimitry Andric               - hasBasePointer(MF);  // X19
5590b57cec5SDimitry Andric   case AArch64::FPR8RegClassID:
5600b57cec5SDimitry Andric   case AArch64::FPR16RegClassID:
5610b57cec5SDimitry Andric   case AArch64::FPR32RegClassID:
5620b57cec5SDimitry Andric   case AArch64::FPR64RegClassID:
5630b57cec5SDimitry Andric   case AArch64::FPR128RegClassID:
5640b57cec5SDimitry Andric     return 32;
5650b57cec5SDimitry Andric 
5660b57cec5SDimitry Andric   case AArch64::DDRegClassID:
5670b57cec5SDimitry Andric   case AArch64::DDDRegClassID:
5680b57cec5SDimitry Andric   case AArch64::DDDDRegClassID:
5690b57cec5SDimitry Andric   case AArch64::QQRegClassID:
5700b57cec5SDimitry Andric   case AArch64::QQQRegClassID:
5710b57cec5SDimitry Andric   case AArch64::QQQQRegClassID:
5720b57cec5SDimitry Andric     return 32;
5730b57cec5SDimitry Andric 
5740b57cec5SDimitry Andric   case AArch64::FPR128_loRegClassID:
5750b57cec5SDimitry Andric     return 16;
5760b57cec5SDimitry Andric   }
5770b57cec5SDimitry Andric }
5780b57cec5SDimitry Andric 
5790b57cec5SDimitry Andric unsigned AArch64RegisterInfo::getLocalAddressRegister(
5800b57cec5SDimitry Andric   const MachineFunction &MF) const {
5810b57cec5SDimitry Andric   const auto &MFI = MF.getFrameInfo();
5820b57cec5SDimitry Andric   if (!MF.hasEHFunclets() && !MFI.hasVarSizedObjects())
5830b57cec5SDimitry Andric     return AArch64::SP;
5840b57cec5SDimitry Andric   else if (needsStackRealignment(MF))
5850b57cec5SDimitry Andric     return getBaseRegister();
5860b57cec5SDimitry Andric   return getFrameRegister(MF);
5870b57cec5SDimitry Andric }
588