18971842fSAlex Bradbury //===-- RISCVFrameLowering.cpp - RISCV Frame Information ------------------===// 28971842fSAlex Bradbury // 32946cd70SChandler Carruth // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 42946cd70SChandler Carruth // See https://llvm.org/LICENSE.txt for license information. 52946cd70SChandler Carruth // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 68971842fSAlex Bradbury // 78971842fSAlex Bradbury //===----------------------------------------------------------------------===// 88971842fSAlex Bradbury // 98971842fSAlex Bradbury // This file contains the RISCV implementation of TargetFrameLowering class. 108971842fSAlex Bradbury // 118971842fSAlex Bradbury //===----------------------------------------------------------------------===// 128971842fSAlex Bradbury 138971842fSAlex Bradbury #include "RISCVFrameLowering.h" 14c85be0deSAlex Bradbury #include "RISCVMachineFunctionInfo.h" 158971842fSAlex Bradbury #include "RISCVSubtarget.h" 168971842fSAlex Bradbury #include "llvm/CodeGen/MachineFrameInfo.h" 178971842fSAlex Bradbury #include "llvm/CodeGen/MachineFunction.h" 188971842fSAlex Bradbury #include "llvm/CodeGen/MachineInstrBuilder.h" 198971842fSAlex Bradbury #include "llvm/CodeGen/MachineRegisterInfo.h" 200715d35eSAlex Bradbury #include "llvm/CodeGen/RegisterScavenging.h" 21aed9d6d6SSimon Cook #include "llvm/IR/DiagnosticInfo.h" 2204ddf39bSHsiangkai Wang #include "llvm/MC/MCDwarf.h" 238971842fSAlex Bradbury 248971842fSAlex Bradbury using namespace llvm; 258971842fSAlex Bradbury 261c466477SZhaoshi Zheng // For now we use x18, a.k.a s2, as pointer to shadow call stack. 271c466477SZhaoshi Zheng // User should explicitly set -ffixed-x18 and not use x18 in their asm. 281c466477SZhaoshi Zheng static void emitSCSPrologue(MachineFunction &MF, MachineBasicBlock &MBB, 291c466477SZhaoshi Zheng MachineBasicBlock::iterator MI, 301c466477SZhaoshi Zheng const DebugLoc &DL) { 311c466477SZhaoshi Zheng if (!MF.getFunction().hasFnAttribute(Attribute::ShadowCallStack)) 321c466477SZhaoshi Zheng return; 331c466477SZhaoshi Zheng 341c466477SZhaoshi Zheng const auto &STI = MF.getSubtarget<RISCVSubtarget>(); 351c466477SZhaoshi Zheng Register RAReg = STI.getRegisterInfo()->getRARegister(); 361c466477SZhaoshi Zheng 371c466477SZhaoshi Zheng // Do not save RA to the SCS if it's not saved to the regular stack, 381c466477SZhaoshi Zheng // i.e. RA is not at risk of being overwritten. 391c466477SZhaoshi Zheng std::vector<CalleeSavedInfo> &CSI = MF.getFrameInfo().getCalleeSavedInfo(); 401c466477SZhaoshi Zheng if (std::none_of(CSI.begin(), CSI.end(), 411c466477SZhaoshi Zheng [&](CalleeSavedInfo &CSR) { return CSR.getReg() == RAReg; })) 421c466477SZhaoshi Zheng return; 431c466477SZhaoshi Zheng 441c466477SZhaoshi Zheng Register SCSPReg = RISCVABI::getSCSPReg(); 451c466477SZhaoshi Zheng 461c466477SZhaoshi Zheng auto &Ctx = MF.getFunction().getContext(); 471c466477SZhaoshi Zheng if (!STI.isRegisterReservedByUser(SCSPReg)) { 481c466477SZhaoshi Zheng Ctx.diagnose(DiagnosticInfoUnsupported{ 491c466477SZhaoshi Zheng MF.getFunction(), "x18 not reserved by user for Shadow Call Stack."}); 501c466477SZhaoshi Zheng return; 511c466477SZhaoshi Zheng } 521c466477SZhaoshi Zheng 531c466477SZhaoshi Zheng const auto *RVFI = MF.getInfo<RISCVMachineFunctionInfo>(); 541c466477SZhaoshi Zheng if (RVFI->useSaveRestoreLibCalls(MF)) { 551c466477SZhaoshi Zheng Ctx.diagnose(DiagnosticInfoUnsupported{ 561c466477SZhaoshi Zheng MF.getFunction(), 571c466477SZhaoshi Zheng "Shadow Call Stack cannot be combined with Save/Restore LibCalls."}); 581c466477SZhaoshi Zheng return; 591c466477SZhaoshi Zheng } 601c466477SZhaoshi Zheng 611c466477SZhaoshi Zheng const RISCVInstrInfo *TII = STI.getInstrInfo(); 621c466477SZhaoshi Zheng bool IsRV64 = STI.hasFeature(RISCV::Feature64Bit); 631c466477SZhaoshi Zheng int64_t SlotSize = STI.getXLen() / 8; 641c466477SZhaoshi Zheng // Store return address to shadow call stack 651c466477SZhaoshi Zheng // s[w|d] ra, 0(s2) 661c466477SZhaoshi Zheng // addi s2, s2, [4|8] 671c466477SZhaoshi Zheng BuildMI(MBB, MI, DL, TII->get(IsRV64 ? RISCV::SD : RISCV::SW)) 681c466477SZhaoshi Zheng .addReg(RAReg) 691c466477SZhaoshi Zheng .addReg(SCSPReg) 70*4b2dd318SHsiangkai Wang .addImm(0) 71*4b2dd318SHsiangkai Wang .setMIFlag(MachineInstr::FrameSetup); 721c466477SZhaoshi Zheng BuildMI(MBB, MI, DL, TII->get(RISCV::ADDI)) 731c466477SZhaoshi Zheng .addReg(SCSPReg, RegState::Define) 741c466477SZhaoshi Zheng .addReg(SCSPReg) 75*4b2dd318SHsiangkai Wang .addImm(SlotSize) 76*4b2dd318SHsiangkai Wang .setMIFlag(MachineInstr::FrameSetup); 771c466477SZhaoshi Zheng } 781c466477SZhaoshi Zheng 791c466477SZhaoshi Zheng static void emitSCSEpilogue(MachineFunction &MF, MachineBasicBlock &MBB, 801c466477SZhaoshi Zheng MachineBasicBlock::iterator MI, 811c466477SZhaoshi Zheng const DebugLoc &DL) { 821c466477SZhaoshi Zheng if (!MF.getFunction().hasFnAttribute(Attribute::ShadowCallStack)) 831c466477SZhaoshi Zheng return; 841c466477SZhaoshi Zheng 851c466477SZhaoshi Zheng const auto &STI = MF.getSubtarget<RISCVSubtarget>(); 861c466477SZhaoshi Zheng Register RAReg = STI.getRegisterInfo()->getRARegister(); 871c466477SZhaoshi Zheng 881c466477SZhaoshi Zheng // See emitSCSPrologue() above. 891c466477SZhaoshi Zheng std::vector<CalleeSavedInfo> &CSI = MF.getFrameInfo().getCalleeSavedInfo(); 901c466477SZhaoshi Zheng if (std::none_of(CSI.begin(), CSI.end(), 911c466477SZhaoshi Zheng [&](CalleeSavedInfo &CSR) { return CSR.getReg() == RAReg; })) 921c466477SZhaoshi Zheng return; 931c466477SZhaoshi Zheng 941c466477SZhaoshi Zheng Register SCSPReg = RISCVABI::getSCSPReg(); 951c466477SZhaoshi Zheng 961c466477SZhaoshi Zheng auto &Ctx = MF.getFunction().getContext(); 971c466477SZhaoshi Zheng if (!STI.isRegisterReservedByUser(SCSPReg)) { 981c466477SZhaoshi Zheng Ctx.diagnose(DiagnosticInfoUnsupported{ 991c466477SZhaoshi Zheng MF.getFunction(), "x18 not reserved by user for Shadow Call Stack."}); 1001c466477SZhaoshi Zheng return; 1011c466477SZhaoshi Zheng } 1021c466477SZhaoshi Zheng 1031c466477SZhaoshi Zheng const auto *RVFI = MF.getInfo<RISCVMachineFunctionInfo>(); 1041c466477SZhaoshi Zheng if (RVFI->useSaveRestoreLibCalls(MF)) { 1051c466477SZhaoshi Zheng Ctx.diagnose(DiagnosticInfoUnsupported{ 1061c466477SZhaoshi Zheng MF.getFunction(), 1071c466477SZhaoshi Zheng "Shadow Call Stack cannot be combined with Save/Restore LibCalls."}); 1081c466477SZhaoshi Zheng return; 1091c466477SZhaoshi Zheng } 1101c466477SZhaoshi Zheng 1111c466477SZhaoshi Zheng const RISCVInstrInfo *TII = STI.getInstrInfo(); 1121c466477SZhaoshi Zheng bool IsRV64 = STI.hasFeature(RISCV::Feature64Bit); 1131c466477SZhaoshi Zheng int64_t SlotSize = STI.getXLen() / 8; 1141c466477SZhaoshi Zheng // Load return address from shadow call stack 1151c466477SZhaoshi Zheng // l[w|d] ra, -[4|8](s2) 1161c466477SZhaoshi Zheng // addi s2, s2, -[4|8] 1171c466477SZhaoshi Zheng BuildMI(MBB, MI, DL, TII->get(IsRV64 ? RISCV::LD : RISCV::LW)) 1181c466477SZhaoshi Zheng .addReg(RAReg, RegState::Define) 1191c466477SZhaoshi Zheng .addReg(SCSPReg) 120*4b2dd318SHsiangkai Wang .addImm(-SlotSize) 121*4b2dd318SHsiangkai Wang .setMIFlag(MachineInstr::FrameDestroy); 1221c466477SZhaoshi Zheng BuildMI(MBB, MI, DL, TII->get(RISCV::ADDI)) 1231c466477SZhaoshi Zheng .addReg(SCSPReg, RegState::Define) 1241c466477SZhaoshi Zheng .addReg(SCSPReg) 125*4b2dd318SHsiangkai Wang .addImm(-SlotSize) 126*4b2dd318SHsiangkai Wang .setMIFlag(MachineInstr::FrameDestroy); 1271c466477SZhaoshi Zheng } 1281c466477SZhaoshi Zheng 12907f7c002Slewis-revill // Get the ID of the libcall used for spilling and restoring callee saved 13007f7c002Slewis-revill // registers. The ID is representative of the number of registers saved or 13107f7c002Slewis-revill // restored by the libcall, except it is zero-indexed - ID 0 corresponds to a 13207f7c002Slewis-revill // single register. 13307f7c002Slewis-revill static int getLibCallID(const MachineFunction &MF, 13407f7c002Slewis-revill const std::vector<CalleeSavedInfo> &CSI) { 13507f7c002Slewis-revill const auto *RVFI = MF.getInfo<RISCVMachineFunctionInfo>(); 13607f7c002Slewis-revill 13708649f0aSMatt Arsenault if (CSI.empty() || !RVFI->useSaveRestoreLibCalls(MF)) 13807f7c002Slewis-revill return -1; 13907f7c002Slewis-revill 14007f7c002Slewis-revill Register MaxReg = RISCV::NoRegister; 14107f7c002Slewis-revill for (auto &CS : CSI) 14207f7c002Slewis-revill // RISCVRegisterInfo::hasReservedSpillSlot assigns negative frame indexes to 14307f7c002Slewis-revill // registers which can be saved by libcall. 14407f7c002Slewis-revill if (CS.getFrameIdx() < 0) 145d8938c8bSMatt Arsenault MaxReg = std::max(MaxReg.id(), CS.getReg().id()); 14607f7c002Slewis-revill 14707f7c002Slewis-revill if (MaxReg == RISCV::NoRegister) 14807f7c002Slewis-revill return -1; 14907f7c002Slewis-revill 15007f7c002Slewis-revill switch (MaxReg) { 15107f7c002Slewis-revill default: 15207f7c002Slewis-revill llvm_unreachable("Something has gone wrong!"); 15307f7c002Slewis-revill case /*s11*/ RISCV::X27: return 12; 15407f7c002Slewis-revill case /*s10*/ RISCV::X26: return 11; 15507f7c002Slewis-revill case /*s9*/ RISCV::X25: return 10; 15607f7c002Slewis-revill case /*s8*/ RISCV::X24: return 9; 15707f7c002Slewis-revill case /*s7*/ RISCV::X23: return 8; 15807f7c002Slewis-revill case /*s6*/ RISCV::X22: return 7; 15907f7c002Slewis-revill case /*s5*/ RISCV::X21: return 6; 16007f7c002Slewis-revill case /*s4*/ RISCV::X20: return 5; 16107f7c002Slewis-revill case /*s3*/ RISCV::X19: return 4; 16207f7c002Slewis-revill case /*s2*/ RISCV::X18: return 3; 16307f7c002Slewis-revill case /*s1*/ RISCV::X9: return 2; 16407f7c002Slewis-revill case /*s0*/ RISCV::X8: return 1; 16507f7c002Slewis-revill case /*ra*/ RISCV::X1: return 0; 16607f7c002Slewis-revill } 16707f7c002Slewis-revill } 16807f7c002Slewis-revill 16907f7c002Slewis-revill // Get the name of the libcall used for spilling callee saved registers. 17007f7c002Slewis-revill // If this function will not use save/restore libcalls, then return a nullptr. 17107f7c002Slewis-revill static const char * 17207f7c002Slewis-revill getSpillLibCallName(const MachineFunction &MF, 17307f7c002Slewis-revill const std::vector<CalleeSavedInfo> &CSI) { 17407f7c002Slewis-revill static const char *const SpillLibCalls[] = { 17507f7c002Slewis-revill "__riscv_save_0", 17607f7c002Slewis-revill "__riscv_save_1", 17707f7c002Slewis-revill "__riscv_save_2", 17807f7c002Slewis-revill "__riscv_save_3", 17907f7c002Slewis-revill "__riscv_save_4", 18007f7c002Slewis-revill "__riscv_save_5", 18107f7c002Slewis-revill "__riscv_save_6", 18207f7c002Slewis-revill "__riscv_save_7", 18307f7c002Slewis-revill "__riscv_save_8", 18407f7c002Slewis-revill "__riscv_save_9", 18507f7c002Slewis-revill "__riscv_save_10", 18607f7c002Slewis-revill "__riscv_save_11", 18707f7c002Slewis-revill "__riscv_save_12" 18807f7c002Slewis-revill }; 18907f7c002Slewis-revill 19007f7c002Slewis-revill int LibCallID = getLibCallID(MF, CSI); 19107f7c002Slewis-revill if (LibCallID == -1) 19207f7c002Slewis-revill return nullptr; 19307f7c002Slewis-revill return SpillLibCalls[LibCallID]; 19407f7c002Slewis-revill } 19507f7c002Slewis-revill 19607f7c002Slewis-revill // Get the name of the libcall used for restoring callee saved registers. 19707f7c002Slewis-revill // If this function will not use save/restore libcalls, then return a nullptr. 19807f7c002Slewis-revill static const char * 19907f7c002Slewis-revill getRestoreLibCallName(const MachineFunction &MF, 20007f7c002Slewis-revill const std::vector<CalleeSavedInfo> &CSI) { 20107f7c002Slewis-revill static const char *const RestoreLibCalls[] = { 20207f7c002Slewis-revill "__riscv_restore_0", 20307f7c002Slewis-revill "__riscv_restore_1", 20407f7c002Slewis-revill "__riscv_restore_2", 20507f7c002Slewis-revill "__riscv_restore_3", 20607f7c002Slewis-revill "__riscv_restore_4", 20707f7c002Slewis-revill "__riscv_restore_5", 20807f7c002Slewis-revill "__riscv_restore_6", 20907f7c002Slewis-revill "__riscv_restore_7", 21007f7c002Slewis-revill "__riscv_restore_8", 21107f7c002Slewis-revill "__riscv_restore_9", 21207f7c002Slewis-revill "__riscv_restore_10", 21307f7c002Slewis-revill "__riscv_restore_11", 21407f7c002Slewis-revill "__riscv_restore_12" 21507f7c002Slewis-revill }; 21607f7c002Slewis-revill 21707f7c002Slewis-revill int LibCallID = getLibCallID(MF, CSI); 21807f7c002Slewis-revill if (LibCallID == -1) 21907f7c002Slewis-revill return nullptr; 22007f7c002Slewis-revill return RestoreLibCalls[LibCallID]; 22107f7c002Slewis-revill } 22207f7c002Slewis-revill 2237d6aa1f7SAlex Bradbury bool RISCVFrameLowering::hasFP(const MachineFunction &MF) const { 2247d6aa1f7SAlex Bradbury const TargetRegisterInfo *RegInfo = MF.getSubtarget().getRegisterInfo(); 2257d6aa1f7SAlex Bradbury 2267d6aa1f7SAlex Bradbury const MachineFrameInfo &MFI = MF.getFrameInfo(); 2277d6aa1f7SAlex Bradbury return MF.getTarget().Options.DisableFramePointerElim(MF) || 228a9968c0aSTomas Matheson RegInfo->hasStackRealignment(MF) || MFI.hasVarSizedObjects() || 2297d6aa1f7SAlex Bradbury MFI.isFrameAddressTaken(); 2307d6aa1f7SAlex Bradbury } 2318971842fSAlex Bradbury 232cf6cf0cdSShiva Chen bool RISCVFrameLowering::hasBP(const MachineFunction &MF) const { 233cf6cf0cdSShiva Chen const MachineFrameInfo &MFI = MF.getFrameInfo(); 234cf6cf0cdSShiva Chen const TargetRegisterInfo *TRI = STI.getRegisterInfo(); 235cf6cf0cdSShiva Chen 236a9968c0aSTomas Matheson return MFI.hasVarSizedObjects() && TRI->hasStackRealignment(MF); 237cf6cf0cdSShiva Chen } 238cf6cf0cdSShiva Chen 239b014e3deSAlex Bradbury // Determines the size of the frame and maximum call frame size. 240b014e3deSAlex Bradbury void RISCVFrameLowering::determineFrameLayout(MachineFunction &MF) const { 241b014e3deSAlex Bradbury MachineFrameInfo &MFI = MF.getFrameInfo(); 242b014e3deSAlex Bradbury 243b014e3deSAlex Bradbury // Get the number of bytes to allocate from the FrameInfo. 244b014e3deSAlex Bradbury uint64_t FrameSize = MFI.getStackSize(); 245b014e3deSAlex Bradbury 246b014e3deSAlex Bradbury // Get the alignment. 247d000655aSGuillaume Chatelet Align StackAlign = getStackAlign(); 248cd44aee3SSam Elliott 249b014e3deSAlex Bradbury // Make sure the frame is aligned. 250b014e3deSAlex Bradbury FrameSize = alignTo(FrameSize, StackAlign); 251b014e3deSAlex Bradbury 252b014e3deSAlex Bradbury // Update frame info. 253b014e3deSAlex Bradbury MFI.setStackSize(FrameSize); 254b014e3deSAlex Bradbury } 255b014e3deSAlex Bradbury 256b014e3deSAlex Bradbury void RISCVFrameLowering::adjustReg(MachineBasicBlock &MBB, 257b014e3deSAlex Bradbury MachineBasicBlock::iterator MBBI, 258fa06e958SLuis Marques const DebugLoc &DL, Register DestReg, 259fa06e958SLuis Marques Register SrcReg, int64_t Val, 260b014e3deSAlex Bradbury MachineInstr::MIFlag Flag) const { 2619fea4881SAlex Bradbury MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo(); 262b014e3deSAlex Bradbury const RISCVInstrInfo *TII = STI.getInstrInfo(); 263b014e3deSAlex Bradbury 264b014e3deSAlex Bradbury if (DestReg == SrcReg && Val == 0) 265b014e3deSAlex Bradbury return; 266b014e3deSAlex Bradbury 2679fea4881SAlex Bradbury if (isInt<12>(Val)) { 268b014e3deSAlex Bradbury BuildMI(MBB, MBBI, DL, TII->get(RISCV::ADDI), DestReg) 269b014e3deSAlex Bradbury .addReg(SrcReg) 270b014e3deSAlex Bradbury .addImm(Val) 271b014e3deSAlex Bradbury .setMIFlag(Flag); 272a49a16ddSShiva Chen } else { 2739fea4881SAlex Bradbury unsigned Opc = RISCV::ADD; 2749fea4881SAlex Bradbury bool isSub = Val < 0; 2759fea4881SAlex Bradbury if (isSub) { 2769fea4881SAlex Bradbury Val = -Val; 2779fea4881SAlex Bradbury Opc = RISCV::SUB; 2789fea4881SAlex Bradbury } 2799fea4881SAlex Bradbury 2803836874dSDaniel Sanders Register ScratchReg = MRI.createVirtualRegister(&RISCV::GPRRegClass); 281a49a16ddSShiva Chen TII->movImm(MBB, MBBI, DL, ScratchReg, Val, Flag); 2829fea4881SAlex Bradbury BuildMI(MBB, MBBI, DL, TII->get(Opc), DestReg) 2839fea4881SAlex Bradbury .addReg(SrcReg) 2849fea4881SAlex Bradbury .addReg(ScratchReg, RegState::Kill) 2859fea4881SAlex Bradbury .setMIFlag(Flag); 2869fea4881SAlex Bradbury } 287b014e3deSAlex Bradbury } 288b014e3deSAlex Bradbury 289b014e3deSAlex Bradbury // Returns the register used to hold the frame pointer. 290fa06e958SLuis Marques static Register getFPReg(const RISCVSubtarget &STI) { return RISCV::X8; } 291b014e3deSAlex Bradbury 292b014e3deSAlex Bradbury // Returns the register used to hold the stack pointer. 293fa06e958SLuis Marques static Register getSPReg(const RISCVSubtarget &STI) { return RISCV::X2; } 294b014e3deSAlex Bradbury 29507f7c002Slewis-revill static SmallVector<CalleeSavedInfo, 8> 2965a31a673SHsiangkai Wang getNonLibcallCSI(const MachineFunction &MF, 2975a31a673SHsiangkai Wang const std::vector<CalleeSavedInfo> &CSI) { 2985a31a673SHsiangkai Wang const MachineFrameInfo &MFI = MF.getFrameInfo(); 29907f7c002Slewis-revill SmallVector<CalleeSavedInfo, 8> NonLibcallCSI; 30007f7c002Slewis-revill 3015a31a673SHsiangkai Wang for (auto &CS : CSI) { 3025a31a673SHsiangkai Wang int FI = CS.getFrameIdx(); 3035a31a673SHsiangkai Wang if (FI >= 0 && MFI.getStackID(FI) == TargetStackID::Default) 30407f7c002Slewis-revill NonLibcallCSI.push_back(CS); 3055a31a673SHsiangkai Wang } 30607f7c002Slewis-revill 30707f7c002Slewis-revill return NonLibcallCSI; 30807f7c002Slewis-revill } 30907f7c002Slewis-revill 3105a31a673SHsiangkai Wang void RISCVFrameLowering::adjustStackForRVV(MachineFunction &MF, 3115a31a673SHsiangkai Wang MachineBasicBlock &MBB, 3125a31a673SHsiangkai Wang MachineBasicBlock::iterator MBBI, 313*4b2dd318SHsiangkai Wang const DebugLoc &DL, int64_t Amount, 314*4b2dd318SHsiangkai Wang MachineInstr::MIFlag Flag) const { 3155a31a673SHsiangkai Wang assert(Amount != 0 && "Did not need to adjust stack pointer for RVV."); 3165a31a673SHsiangkai Wang 3175a31a673SHsiangkai Wang const RISCVInstrInfo *TII = STI.getInstrInfo(); 3185a31a673SHsiangkai Wang Register SPReg = getSPReg(STI); 3195a31a673SHsiangkai Wang unsigned Opc = RISCV::ADD; 3205a31a673SHsiangkai Wang if (Amount < 0) { 3215a31a673SHsiangkai Wang Amount = -Amount; 3225a31a673SHsiangkai Wang Opc = RISCV::SUB; 3235a31a673SHsiangkai Wang } 3245a31a673SHsiangkai Wang // 1. Multiply the number of v-slots to the length of registers 325b41e1306SHsiangkai Wang Register FactorRegister = 326*4b2dd318SHsiangkai Wang TII->getVLENFactoredAmount(MF, MBB, MBBI, DL, Amount, Flag); 3275a31a673SHsiangkai Wang // 2. SP = SP - RVV stack size 3285a31a673SHsiangkai Wang BuildMI(MBB, MBBI, DL, TII->get(Opc), SPReg) 3295a31a673SHsiangkai Wang .addReg(SPReg) 330*4b2dd318SHsiangkai Wang .addReg(FactorRegister, RegState::Kill) 331*4b2dd318SHsiangkai Wang .setMIFlag(Flag); 3325a31a673SHsiangkai Wang } 3335a31a673SHsiangkai Wang 3348971842fSAlex Bradbury void RISCVFrameLowering::emitPrologue(MachineFunction &MF, 335b014e3deSAlex Bradbury MachineBasicBlock &MBB) const { 336b014e3deSAlex Bradbury MachineFrameInfo &MFI = MF.getFrameInfo(); 337c85be0deSAlex Bradbury auto *RVFI = MF.getInfo<RISCVMachineFunctionInfo>(); 33804ddf39bSHsiangkai Wang const RISCVRegisterInfo *RI = STI.getRegisterInfo(); 33904ddf39bSHsiangkai Wang const RISCVInstrInfo *TII = STI.getInstrInfo(); 340b014e3deSAlex Bradbury MachineBasicBlock::iterator MBBI = MBB.begin(); 341b014e3deSAlex Bradbury 342fa06e958SLuis Marques Register FPReg = getFPReg(STI); 343fa06e958SLuis Marques Register SPReg = getSPReg(STI); 344cf6cf0cdSShiva Chen Register BPReg = RISCVABI::getBPReg(); 345b014e3deSAlex Bradbury 3461c466477SZhaoshi Zheng // Debug location must be unknown since the first debug location is used 3471c466477SZhaoshi Zheng // to determine the end of the prologue. 3481c466477SZhaoshi Zheng DebugLoc DL; 3491c466477SZhaoshi Zheng 350a8dc2110SLuís Marques // All calls are tail calls in GHC calling conv, and functions have no 351a8dc2110SLuís Marques // prologue/epilogue. 352a8dc2110SLuís Marques if (MF.getFunction().getCallingConv() == CallingConv::GHC) 353a8dc2110SLuís Marques return; 354a8dc2110SLuís Marques 3551c466477SZhaoshi Zheng // Emit prologue for shadow call stack. 3561c466477SZhaoshi Zheng emitSCSPrologue(MF, MBB, MBBI, DL); 3571c466477SZhaoshi Zheng 35807f7c002Slewis-revill // Since spillCalleeSavedRegisters may have inserted a libcall, skip past 35907f7c002Slewis-revill // any instructions marked as FrameSetup 36007f7c002Slewis-revill while (MBBI != MBB.end() && MBBI->getFlag(MachineInstr::FrameSetup)) 36107f7c002Slewis-revill ++MBBI; 36207f7c002Slewis-revill 363b014e3deSAlex Bradbury // Determine the correct frame layout 364b014e3deSAlex Bradbury determineFrameLayout(MF); 365b014e3deSAlex Bradbury 36607f7c002Slewis-revill // If libcalls are used to spill and restore callee-saved registers, the frame 36707f7c002Slewis-revill // has two sections; the opaque section managed by the libcalls, and the 36807f7c002Slewis-revill // section managed by MachineFrameInfo which can also hold callee saved 36907f7c002Slewis-revill // registers in fixed stack slots, both of which have negative frame indices. 37007f7c002Slewis-revill // This gets even more complicated when incoming arguments are passed via the 37107f7c002Slewis-revill // stack, as these too have negative frame indices. An example is detailed 37207f7c002Slewis-revill // below: 37307f7c002Slewis-revill // 37407f7c002Slewis-revill // | incoming arg | <- FI[-3] 37507f7c002Slewis-revill // | libcallspill | 37607f7c002Slewis-revill // | calleespill | <- FI[-2] 37707f7c002Slewis-revill // | calleespill | <- FI[-1] 37807f7c002Slewis-revill // | this_frame | <- FI[0] 37907f7c002Slewis-revill // 38007f7c002Slewis-revill // For negative frame indices, the offset from the frame pointer will differ 38107f7c002Slewis-revill // depending on which of these groups the frame index applies to. 38207f7c002Slewis-revill // The following calculates the correct offset knowing the number of callee 38307f7c002Slewis-revill // saved registers spilt by the two methods. 38407f7c002Slewis-revill if (int LibCallRegs = getLibCallID(MF, MFI.getCalleeSavedInfo()) + 1) { 38507f7c002Slewis-revill // Calculate the size of the frame managed by the libcall. The libcalls are 38607f7c002Slewis-revill // implemented such that the stack will always be 16 byte aligned. 38707f7c002Slewis-revill unsigned LibCallFrameSize = alignTo((STI.getXLen() / 8) * LibCallRegs, 16); 38807f7c002Slewis-revill RVFI->setLibCallStackSize(LibCallFrameSize); 38907f7c002Slewis-revill } 39007f7c002Slewis-revill 391b014e3deSAlex Bradbury // FIXME (note copied from Lanai): This appears to be overallocating. Needs 392b014e3deSAlex Bradbury // investigation. Get the number of bytes to allocate from the FrameInfo. 393ef76a333SRoger Ferrer Ibanez uint64_t StackSize = MFI.getStackSize() + RVFI->getRVVPadding(); 39407f7c002Slewis-revill uint64_t RealStackSize = StackSize + RVFI->getLibCallStackSize(); 3955a31a673SHsiangkai Wang uint64_t RVVStackSize = RVFI->getRVVStackSize(); 396b014e3deSAlex Bradbury 397b014e3deSAlex Bradbury // Early exit if there is no need to allocate on the stack 3985a31a673SHsiangkai Wang if (RealStackSize == 0 && !MFI.adjustsStack() && RVVStackSize == 0) 399b014e3deSAlex Bradbury return; 400b014e3deSAlex Bradbury 401aed9d6d6SSimon Cook // If the stack pointer has been marked as reserved, then produce an error if 402aed9d6d6SSimon Cook // the frame requires stack allocation 403aed9d6d6SSimon Cook if (STI.isRegisterReservedByUser(SPReg)) 404aed9d6d6SSimon Cook MF.getFunction().getContext().diagnose(DiagnosticInfoUnsupported{ 405aed9d6d6SSimon Cook MF.getFunction(), "Stack pointer required, but has been reserved."}); 406aed9d6d6SSimon Cook 407ff55e2e0SShiva Chen uint64_t FirstSPAdjustAmount = getFirstSPAdjustAmount(MF); 408ff55e2e0SShiva Chen // Split the SP adjustment to reduce the offsets of callee saved spill. 40907f7c002Slewis-revill if (FirstSPAdjustAmount) { 410ff55e2e0SShiva Chen StackSize = FirstSPAdjustAmount; 41107f7c002Slewis-revill RealStackSize = FirstSPAdjustAmount; 41207f7c002Slewis-revill } 413ff55e2e0SShiva Chen 414b014e3deSAlex Bradbury // Allocate space on the stack if necessary. 415b014e3deSAlex Bradbury adjustReg(MBB, MBBI, DL, SPReg, SPReg, -StackSize, MachineInstr::FrameSetup); 416b014e3deSAlex Bradbury 41707f7c002Slewis-revill // Emit ".cfi_def_cfa_offset RealStackSize" 41804ddf39bSHsiangkai Wang unsigned CFIIndex = MF.addFrameInst( 4190840d725SFangrui Song MCCFIInstruction::cfiDefCfaOffset(nullptr, RealStackSize)); 42004ddf39bSHsiangkai Wang BuildMI(MBB, MBBI, DL, TII->get(TargetOpcode::CFI_INSTRUCTION)) 421*4b2dd318SHsiangkai Wang .addCFIIndex(CFIIndex) 422*4b2dd318SHsiangkai Wang .setMIFlag(MachineInstr::FrameSetup); 42304ddf39bSHsiangkai Wang 42407f7c002Slewis-revill const auto &CSI = MFI.getCalleeSavedInfo(); 42507f7c002Slewis-revill 426b014e3deSAlex Bradbury // The frame pointer is callee-saved, and code has been generated for us to 427b014e3deSAlex Bradbury // save it to the stack. We need to skip over the storing of callee-saved 428b014e3deSAlex Bradbury // registers as the frame pointer must be modified after it has been saved 429b014e3deSAlex Bradbury // to the stack, not before. 430b014e3deSAlex Bradbury // FIXME: assumes exactly one instruction is used to save each callee-saved 431b014e3deSAlex Bradbury // register. 4325a31a673SHsiangkai Wang std::advance(MBBI, getNonLibcallCSI(MF, CSI).size()); 433b014e3deSAlex Bradbury 43404ddf39bSHsiangkai Wang // Iterate over list of callee-saved registers and emit .cfi_offset 43504ddf39bSHsiangkai Wang // directives. 43604ddf39bSHsiangkai Wang for (const auto &Entry : CSI) { 43707f7c002Slewis-revill int FrameIdx = Entry.getFrameIdx(); 43807f7c002Slewis-revill int64_t Offset; 43907f7c002Slewis-revill // Offsets for objects with fixed locations (IE: those saved by libcall) are 44007f7c002Slewis-revill // simply calculated from the frame index. 44107f7c002Slewis-revill if (FrameIdx < 0) 44207f7c002Slewis-revill Offset = FrameIdx * (int64_t) STI.getXLen() / 8; 44307f7c002Slewis-revill else 44407f7c002Slewis-revill Offset = MFI.getObjectOffset(Entry.getFrameIdx()) - 44507f7c002Slewis-revill RVFI->getLibCallStackSize(); 446fa06e958SLuis Marques Register Reg = Entry.getReg(); 44704ddf39bSHsiangkai Wang unsigned CFIIndex = MF.addFrameInst(MCCFIInstruction::createOffset( 44804ddf39bSHsiangkai Wang nullptr, RI->getDwarfRegNum(Reg, true), Offset)); 44904ddf39bSHsiangkai Wang BuildMI(MBB, MBBI, DL, TII->get(TargetOpcode::CFI_INSTRUCTION)) 450*4b2dd318SHsiangkai Wang .addCFIIndex(CFIIndex) 451*4b2dd318SHsiangkai Wang .setMIFlag(MachineInstr::FrameSetup); 45204ddf39bSHsiangkai Wang } 45304ddf39bSHsiangkai Wang 454b014e3deSAlex Bradbury // Generate new FP. 45504ddf39bSHsiangkai Wang if (hasFP(MF)) { 456aed9d6d6SSimon Cook if (STI.isRegisterReservedByUser(FPReg)) 457aed9d6d6SSimon Cook MF.getFunction().getContext().diagnose(DiagnosticInfoUnsupported{ 458aed9d6d6SSimon Cook MF.getFunction(), "Frame pointer required, but has been reserved."}); 459aed9d6d6SSimon Cook 4607d6aa1f7SAlex Bradbury adjustReg(MBB, MBBI, DL, FPReg, SPReg, 46107f7c002Slewis-revill RealStackSize - RVFI->getVarArgsSaveSize(), 46207f7c002Slewis-revill MachineInstr::FrameSetup); 46304ddf39bSHsiangkai Wang 4647e49dc61SFangrui Song // Emit ".cfi_def_cfa $fp, RVFI->getVarArgsSaveSize()" 4657e49dc61SFangrui Song unsigned CFIIndex = MF.addFrameInst(MCCFIInstruction::cfiDefCfa( 4667e49dc61SFangrui Song nullptr, RI->getDwarfRegNum(FPReg, true), RVFI->getVarArgsSaveSize())); 46704ddf39bSHsiangkai Wang BuildMI(MBB, MBBI, DL, TII->get(TargetOpcode::CFI_INSTRUCTION)) 468*4b2dd318SHsiangkai Wang .addCFIIndex(CFIIndex) 469*4b2dd318SHsiangkai Wang .setMIFlag(MachineInstr::FrameSetup); 470ff55e2e0SShiva Chen } 471cd44aee3SSam Elliott 472ff55e2e0SShiva Chen // Emit the second SP adjustment after saving callee saved registers. 473ff55e2e0SShiva Chen if (FirstSPAdjustAmount) { 474ff55e2e0SShiva Chen uint64_t SecondSPAdjustAmount = MFI.getStackSize() - FirstSPAdjustAmount; 475ff55e2e0SShiva Chen assert(SecondSPAdjustAmount > 0 && 476ff55e2e0SShiva Chen "SecondSPAdjustAmount should be greater than zero"); 477ff55e2e0SShiva Chen adjustReg(MBB, MBBI, DL, SPReg, SPReg, -SecondSPAdjustAmount, 478ff55e2e0SShiva Chen MachineInstr::FrameSetup); 4791c737f54SLuís Marques 4801c737f54SLuís Marques // If we are using a frame-pointer, and thus emitted ".cfi_def_cfa fp, 0", 4811c737f54SLuís Marques // don't emit an sp-based .cfi_def_cfa_offset 4821c737f54SLuís Marques if (!hasFP(MF)) { 483ff55e2e0SShiva Chen // Emit ".cfi_def_cfa_offset StackSize" 484ff55e2e0SShiva Chen unsigned CFIIndex = MF.addFrameInst( 4850840d725SFangrui Song MCCFIInstruction::cfiDefCfaOffset(nullptr, MFI.getStackSize())); 486ff55e2e0SShiva Chen BuildMI(MBB, MBBI, DL, TII->get(TargetOpcode::CFI_INSTRUCTION)) 487*4b2dd318SHsiangkai Wang .addCFIIndex(CFIIndex) 488*4b2dd318SHsiangkai Wang .setMIFlag(MachineInstr::FrameSetup); 489ff55e2e0SShiva Chen } 4901c737f54SLuís Marques } 491ff55e2e0SShiva Chen 492a9b9c64fSluxufan if (RVVStackSize) 493*4b2dd318SHsiangkai Wang adjustStackForRVV(MF, MBB, MBBI, DL, -RVVStackSize, 494*4b2dd318SHsiangkai Wang MachineInstr::FrameSetup); 495a9b9c64fSluxufan 496ff55e2e0SShiva Chen if (hasFP(MF)) { 497cd44aee3SSam Elliott // Realign Stack 498cd44aee3SSam Elliott const RISCVRegisterInfo *RI = STI.getRegisterInfo(); 499a9968c0aSTomas Matheson if (RI->hasStackRealignment(MF)) { 500d000655aSGuillaume Chatelet Align MaxAlignment = MFI.getMaxAlign(); 501cd44aee3SSam Elliott 502cd44aee3SSam Elliott const RISCVInstrInfo *TII = STI.getInstrInfo(); 503d000655aSGuillaume Chatelet if (isInt<12>(-(int)MaxAlignment.value())) { 504cd44aee3SSam Elliott BuildMI(MBB, MBBI, DL, TII->get(RISCV::ANDI), SPReg) 505cd44aee3SSam Elliott .addReg(SPReg) 506*4b2dd318SHsiangkai Wang .addImm(-(int)MaxAlignment.value()) 507*4b2dd318SHsiangkai Wang .setMIFlag(MachineInstr::FrameSetup); 508cd44aee3SSam Elliott } else { 509d000655aSGuillaume Chatelet unsigned ShiftAmount = Log2(MaxAlignment); 510fa06e958SLuis Marques Register VR = 511cd44aee3SSam Elliott MF.getRegInfo().createVirtualRegister(&RISCV::GPRRegClass); 512cd44aee3SSam Elliott BuildMI(MBB, MBBI, DL, TII->get(RISCV::SRLI), VR) 513cd44aee3SSam Elliott .addReg(SPReg) 514*4b2dd318SHsiangkai Wang .addImm(ShiftAmount) 515*4b2dd318SHsiangkai Wang .setMIFlag(MachineInstr::FrameSetup); 516cd44aee3SSam Elliott BuildMI(MBB, MBBI, DL, TII->get(RISCV::SLLI), SPReg) 517cd44aee3SSam Elliott .addReg(VR) 518*4b2dd318SHsiangkai Wang .addImm(ShiftAmount) 519*4b2dd318SHsiangkai Wang .setMIFlag(MachineInstr::FrameSetup); 520cd44aee3SSam Elliott } 521cf6cf0cdSShiva Chen // FP will be used to restore the frame in the epilogue, so we need 522cf6cf0cdSShiva Chen // another base register BP to record SP after re-alignment. SP will 523cf6cf0cdSShiva Chen // track the current stack after allocating variable sized objects. 524cf6cf0cdSShiva Chen if (hasBP(MF)) { 525cf6cf0cdSShiva Chen // move BP, SP 526*4b2dd318SHsiangkai Wang BuildMI(MBB, MBBI, DL, TII->get(RISCV::ADDI), BPReg) 527*4b2dd318SHsiangkai Wang .addReg(SPReg) 528*4b2dd318SHsiangkai Wang .addImm(0) 529*4b2dd318SHsiangkai Wang .setMIFlag(MachineInstr::FrameSetup); 530cf6cf0cdSShiva Chen } 531cd44aee3SSam Elliott } 53204ddf39bSHsiangkai Wang } 533b014e3deSAlex Bradbury } 5348971842fSAlex Bradbury 5358971842fSAlex Bradbury void RISCVFrameLowering::emitEpilogue(MachineFunction &MF, 536b014e3deSAlex Bradbury MachineBasicBlock &MBB) const { 537b014e3deSAlex Bradbury const RISCVRegisterInfo *RI = STI.getRegisterInfo(); 538b014e3deSAlex Bradbury MachineFrameInfo &MFI = MF.getFrameInfo(); 539c85be0deSAlex Bradbury auto *RVFI = MF.getInfo<RISCVMachineFunctionInfo>(); 540fa06e958SLuis Marques Register FPReg = getFPReg(STI); 541fa06e958SLuis Marques Register SPReg = getSPReg(STI); 542b014e3deSAlex Bradbury 543a8dc2110SLuís Marques // All calls are tail calls in GHC calling conv, and functions have no 544a8dc2110SLuís Marques // prologue/epilogue. 545a8dc2110SLuís Marques if (MF.getFunction().getCallingConv() == CallingConv::GHC) 546a8dc2110SLuís Marques return; 547a8dc2110SLuís Marques 548cd800f3bSlewis-revill // Get the insert location for the epilogue. If there were no terminators in 549cd800f3bSlewis-revill // the block, get the last instruction. 550cd800f3bSlewis-revill MachineBasicBlock::iterator MBBI = MBB.end(); 551cd800f3bSlewis-revill DebugLoc DL; 552cd800f3bSlewis-revill if (!MBB.empty()) { 553cd800f3bSlewis-revill MBBI = MBB.getFirstTerminator(); 554cd800f3bSlewis-revill if (MBBI == MBB.end()) 555cd800f3bSlewis-revill MBBI = MBB.getLastNonDebugInstr(); 556cd800f3bSlewis-revill DL = MBBI->getDebugLoc(); 557cd800f3bSlewis-revill 558cd800f3bSlewis-revill // If this is not a terminator, the actual insert location should be after the 559cd800f3bSlewis-revill // last instruction. 560cd800f3bSlewis-revill if (!MBBI->isTerminator()) 561cd800f3bSlewis-revill MBBI = std::next(MBBI); 56207f7c002Slewis-revill 56307f7c002Slewis-revill // If callee-saved registers are saved via libcall, place stack adjustment 56407f7c002Slewis-revill // before this call. 56507f7c002Slewis-revill while (MBBI != MBB.begin() && 56607f7c002Slewis-revill std::prev(MBBI)->getFlag(MachineInstr::FrameDestroy)) 56707f7c002Slewis-revill --MBBI; 568cd800f3bSlewis-revill } 569cd800f3bSlewis-revill 5705a31a673SHsiangkai Wang const auto &CSI = getNonLibcallCSI(MF, MFI.getCalleeSavedInfo()); 57107f7c002Slewis-revill 572b014e3deSAlex Bradbury // Skip to before the restores of callee-saved registers 573b014e3deSAlex Bradbury // FIXME: assumes exactly one instruction is used to restore each 574b014e3deSAlex Bradbury // callee-saved register. 57507f7c002Slewis-revill auto LastFrameDestroy = MBBI; 57607f7c002Slewis-revill if (!CSI.empty()) 57707f7c002Slewis-revill LastFrameDestroy = std::prev(MBBI, CSI.size()); 578b014e3deSAlex Bradbury 579ef76a333SRoger Ferrer Ibanez uint64_t StackSize = MFI.getStackSize() + RVFI->getRVVPadding(); 58007f7c002Slewis-revill uint64_t RealStackSize = StackSize + RVFI->getLibCallStackSize(); 58107f7c002Slewis-revill uint64_t FPOffset = RealStackSize - RVFI->getVarArgsSaveSize(); 5825a31a673SHsiangkai Wang uint64_t RVVStackSize = RVFI->getRVVStackSize(); 583b014e3deSAlex Bradbury 584b014e3deSAlex Bradbury // Restore the stack pointer using the value of the frame pointer. Only 585b014e3deSAlex Bradbury // necessary if the stack pointer was modified, meaning the stack size is 586b014e3deSAlex Bradbury // unknown. 587a9968c0aSTomas Matheson if (RI->hasStackRealignment(MF) || MFI.hasVarSizedObjects()) { 5887d6aa1f7SAlex Bradbury assert(hasFP(MF) && "frame pointer should not have been eliminated"); 58904ddf39bSHsiangkai Wang adjustReg(MBB, LastFrameDestroy, DL, SPReg, FPReg, -FPOffset, 590b014e3deSAlex Bradbury MachineInstr::FrameDestroy); 5915a31a673SHsiangkai Wang } else { 5925a31a673SHsiangkai Wang if (RVVStackSize) 593*4b2dd318SHsiangkai Wang adjustStackForRVV(MF, MBB, LastFrameDestroy, DL, RVVStackSize, 594*4b2dd318SHsiangkai Wang MachineInstr::FrameDestroy); 595b014e3deSAlex Bradbury } 596b014e3deSAlex Bradbury 597ff55e2e0SShiva Chen uint64_t FirstSPAdjustAmount = getFirstSPAdjustAmount(MF); 598ff55e2e0SShiva Chen if (FirstSPAdjustAmount) { 599ff55e2e0SShiva Chen uint64_t SecondSPAdjustAmount = MFI.getStackSize() - FirstSPAdjustAmount; 600ff55e2e0SShiva Chen assert(SecondSPAdjustAmount > 0 && 601ff55e2e0SShiva Chen "SecondSPAdjustAmount should be greater than zero"); 602ff55e2e0SShiva Chen 603ff55e2e0SShiva Chen adjustReg(MBB, LastFrameDestroy, DL, SPReg, SPReg, SecondSPAdjustAmount, 604ff55e2e0SShiva Chen MachineInstr::FrameDestroy); 60504ddf39bSHsiangkai Wang } 60604ddf39bSHsiangkai Wang 607ff55e2e0SShiva Chen if (FirstSPAdjustAmount) 608ff55e2e0SShiva Chen StackSize = FirstSPAdjustAmount; 609ff55e2e0SShiva Chen 610b014e3deSAlex Bradbury // Deallocate stack 611b014e3deSAlex Bradbury adjustReg(MBB, MBBI, DL, SPReg, SPReg, StackSize, MachineInstr::FrameDestroy); 6121c466477SZhaoshi Zheng 6131c466477SZhaoshi Zheng // Emit epilogue for shadow call stack. 6141c466477SZhaoshi Zheng emitSCSEpilogue(MF, MBB, MBBI, DL); 615b014e3deSAlex Bradbury } 616660bccecSAlex Bradbury 617d57bba7cSSander de Smalen StackOffset 618d57bba7cSSander de Smalen RISCVFrameLowering::getFrameIndexReference(const MachineFunction &MF, int FI, 6192481f26aSMatt Arsenault Register &FrameReg) const { 620660bccecSAlex Bradbury const MachineFrameInfo &MFI = MF.getFrameInfo(); 621660bccecSAlex Bradbury const TargetRegisterInfo *RI = MF.getSubtarget().getRegisterInfo(); 622c85be0deSAlex Bradbury const auto *RVFI = MF.getInfo<RISCVMachineFunctionInfo>(); 623660bccecSAlex Bradbury 624660bccecSAlex Bradbury // Callee-saved registers should be referenced relative to the stack 625660bccecSAlex Bradbury // pointer (positive offset), otherwise use the frame pointer (negative 626660bccecSAlex Bradbury // offset). 6275a31a673SHsiangkai Wang const auto &CSI = getNonLibcallCSI(MF, MFI.getCalleeSavedInfo()); 628660bccecSAlex Bradbury int MinCSFI = 0; 629660bccecSAlex Bradbury int MaxCSFI = -1; 6305a31a673SHsiangkai Wang StackOffset Offset; 6315a31a673SHsiangkai Wang auto StackID = MFI.getStackID(FI); 632660bccecSAlex Bradbury 6335a31a673SHsiangkai Wang assert((StackID == TargetStackID::Default || 6345a31a673SHsiangkai Wang StackID == TargetStackID::ScalableVector) && 6355a31a673SHsiangkai Wang "Unexpected stack ID for the frame object."); 6365a31a673SHsiangkai Wang if (StackID == TargetStackID::Default) { 6375a31a673SHsiangkai Wang Offset = 6385a31a673SHsiangkai Wang StackOffset::getFixed(MFI.getObjectOffset(FI) - getOffsetOfLocalArea() + 6395a31a673SHsiangkai Wang MFI.getOffsetAdjustment()); 6405a31a673SHsiangkai Wang } else if (StackID == TargetStackID::ScalableVector) { 6415a31a673SHsiangkai Wang Offset = StackOffset::getScalable(MFI.getObjectOffset(FI)); 6425a31a673SHsiangkai Wang } 643660bccecSAlex Bradbury 644ff55e2e0SShiva Chen uint64_t FirstSPAdjustAmount = getFirstSPAdjustAmount(MF); 645ff55e2e0SShiva Chen 646660bccecSAlex Bradbury if (CSI.size()) { 647660bccecSAlex Bradbury MinCSFI = CSI[0].getFrameIdx(); 648660bccecSAlex Bradbury MaxCSFI = CSI[CSI.size() - 1].getFrameIdx(); 649660bccecSAlex Bradbury } 650660bccecSAlex Bradbury 651660bccecSAlex Bradbury if (FI >= MinCSFI && FI <= MaxCSFI) { 652660bccecSAlex Bradbury FrameReg = RISCV::X2; 653ff55e2e0SShiva Chen 654ff55e2e0SShiva Chen if (FirstSPAdjustAmount) 6555a31a673SHsiangkai Wang Offset += StackOffset::getFixed(FirstSPAdjustAmount); 656ff55e2e0SShiva Chen else 657ef76a333SRoger Ferrer Ibanez Offset += 658ef76a333SRoger Ferrer Ibanez StackOffset::getFixed(MFI.getStackSize() + RVFI->getRVVPadding()); 659a9968c0aSTomas Matheson } else if (RI->hasStackRealignment(MF) && !MFI.isFixedObjectIndex(FI)) { 660cd44aee3SSam Elliott // If the stack was realigned, the frame pointer is set in order to allow 661cf6cf0cdSShiva Chen // SP to be restored, so we need another base register to record the stack 662cf6cf0cdSShiva Chen // after realignment. 6635a31a673SHsiangkai Wang if (hasBP(MF)) { 664cf6cf0cdSShiva Chen FrameReg = RISCVABI::getBPReg(); 6655a31a673SHsiangkai Wang // |--------------------------| -- <-- FP 666ef76a333SRoger Ferrer Ibanez // | callee-saved registers | | <----. 667a9b9c64fSluxufan // |--------------------------| -- | 668a9b9c64fSluxufan // | realignment (the size of | | | 669a9b9c64fSluxufan // | this area is not counted | | | 670a9b9c64fSluxufan // | in MFI.getStackSize()) | | | 671ef76a333SRoger Ferrer Ibanez // |--------------------------| -- | 672ef76a333SRoger Ferrer Ibanez // | Padding after RVV | | | 673ef76a333SRoger Ferrer Ibanez // | (not counted in | | | 674ef76a333SRoger Ferrer Ibanez // | MFI.getStackSize() | | | 675a9b9c64fSluxufan // |--------------------------| -- |-- MFI.getStackSize() 676a9b9c64fSluxufan // | RVV objects | | | 677ef76a333SRoger Ferrer Ibanez // | (not counted in | | | 678ef76a333SRoger Ferrer Ibanez // | MFI.getStackSize() | | | 679a9b9c64fSluxufan // |--------------------------| -- | 680ef76a333SRoger Ferrer Ibanez // | Padding before RVV | | | 681ef76a333SRoger Ferrer Ibanez // | (not counted in | | | 682ef76a333SRoger Ferrer Ibanez // | MFI.getStackSize() | | | 683ef76a333SRoger Ferrer Ibanez // |--------------------------| -- | 684ef76a333SRoger Ferrer Ibanez // | scalar local variables | | <----' 6855a31a673SHsiangkai Wang // |--------------------------| -- <-- BP 6865a31a673SHsiangkai Wang // | VarSize objects | | 6875a31a673SHsiangkai Wang // |--------------------------| -- <-- SP 6885a31a673SHsiangkai Wang } else { 689cd44aee3SSam Elliott FrameReg = RISCV::X2; 6905a31a673SHsiangkai Wang // |--------------------------| -- <-- FP 691ef76a333SRoger Ferrer Ibanez // | callee-saved registers | | <----. 692a9b9c64fSluxufan // |--------------------------| -- | 693a9b9c64fSluxufan // | realignment (the size of | | | 694a9b9c64fSluxufan // | this area is not counted | | | 695a9b9c64fSluxufan // | in MFI.getStackSize()) | | | 696ef76a333SRoger Ferrer Ibanez // |--------------------------| -- | 697ef76a333SRoger Ferrer Ibanez // | Padding after RVV | | | 698ef76a333SRoger Ferrer Ibanez // | (not counted in | | | 699ef76a333SRoger Ferrer Ibanez // | MFI.getStackSize() | | | 700a9b9c64fSluxufan // |--------------------------| -- |-- MFI.getStackSize() 701a9b9c64fSluxufan // | RVV objects | | | 702ef76a333SRoger Ferrer Ibanez // | (not counted in | | | 703ef76a333SRoger Ferrer Ibanez // | MFI.getStackSize() | | | 704a9b9c64fSluxufan // |--------------------------| -- | 705ef76a333SRoger Ferrer Ibanez // | Padding before RVV | | | 706ef76a333SRoger Ferrer Ibanez // | (not counted in | | | 707ef76a333SRoger Ferrer Ibanez // | MFI.getStackSize() | | | 708ef76a333SRoger Ferrer Ibanez // |--------------------------| -- | 709ef76a333SRoger Ferrer Ibanez // | scalar local variables | | <----' 7105a31a673SHsiangkai Wang // |--------------------------| -- <-- SP 7115a31a673SHsiangkai Wang } 712ef76a333SRoger Ferrer Ibanez // The total amount of padding surrounding RVV objects is described by 713ef76a333SRoger Ferrer Ibanez // RVV->getRVVPadding() and it can be zero. It allows us to align the RVV 714ef76a333SRoger Ferrer Ibanez // objects to 8 bytes. 7155a31a673SHsiangkai Wang if (MFI.getStackID(FI) == TargetStackID::Default) { 7165a31a673SHsiangkai Wang Offset += StackOffset::getFixed(MFI.getStackSize()); 71707f7c002Slewis-revill if (FI < 0) 7185a31a673SHsiangkai Wang Offset += StackOffset::getFixed(RVFI->getLibCallStackSize()); 719a9b9c64fSluxufan } else if (MFI.getStackID(FI) == TargetStackID::ScalableVector) { 720ef76a333SRoger Ferrer Ibanez Offset += StackOffset::get( 721ef76a333SRoger Ferrer Ibanez alignTo(MFI.getStackSize() - RVFI->getCalleeSavedStackSize(), 8), 722a9b9c64fSluxufan RVFI->getRVVStackSize()); 7235a31a673SHsiangkai Wang } 724c85be0deSAlex Bradbury } else { 725c85be0deSAlex Bradbury FrameReg = RI->getFrameRegister(MF); 72607f7c002Slewis-revill if (hasFP(MF)) { 7275a31a673SHsiangkai Wang Offset += StackOffset::getFixed(RVFI->getVarArgsSaveSize()); 72807f7c002Slewis-revill if (FI >= 0) 7295a31a673SHsiangkai Wang Offset -= StackOffset::getFixed(RVFI->getLibCallStackSize()); 7305a31a673SHsiangkai Wang // When using FP to access scalable vector objects, we need to minus 7315a31a673SHsiangkai Wang // the frame size. 7325a31a673SHsiangkai Wang // 7335a31a673SHsiangkai Wang // |--------------------------| -- <-- FP 7345a31a673SHsiangkai Wang // | callee-saved registers | | 7355a31a673SHsiangkai Wang // |--------------------------| | MFI.getStackSize() 7365a31a673SHsiangkai Wang // | scalar local variables | | 7375a31a673SHsiangkai Wang // |--------------------------| -- (Offset of RVV objects is from here.) 7385a31a673SHsiangkai Wang // | RVV objects | 7395a31a673SHsiangkai Wang // |--------------------------| 7405a31a673SHsiangkai Wang // | VarSize objects | 7415a31a673SHsiangkai Wang // |--------------------------| <-- SP 7425a31a673SHsiangkai Wang if (MFI.getStackID(FI) == TargetStackID::ScalableVector) 7435a31a673SHsiangkai Wang Offset -= StackOffset::getFixed(MFI.getStackSize()); 74407f7c002Slewis-revill } else { 7455a31a673SHsiangkai Wang // When using SP to access frame objects, we need to add RVV stack size. 7465a31a673SHsiangkai Wang // 7475a31a673SHsiangkai Wang // |--------------------------| -- <-- FP 748ef76a333SRoger Ferrer Ibanez // | callee-saved registers | | <----. 749ef76a333SRoger Ferrer Ibanez // |--------------------------| -- | 750ef76a333SRoger Ferrer Ibanez // | Padding after RVV | | | 751ef76a333SRoger Ferrer Ibanez // | (not counted in | | | 752ef76a333SRoger Ferrer Ibanez // | MFI.getStackSize() | | | 753a9b9c64fSluxufan // |--------------------------| -- | 754a9b9c64fSluxufan // | RVV objects | | |-- MFI.getStackSize() 755ef76a333SRoger Ferrer Ibanez // | (not counted in | | | 756ef76a333SRoger Ferrer Ibanez // | MFI.getStackSize() | | | 757a9b9c64fSluxufan // |--------------------------| -- | 758ef76a333SRoger Ferrer Ibanez // | Padding before RVV | | | 759ef76a333SRoger Ferrer Ibanez // | (not counted in | | | 760ef76a333SRoger Ferrer Ibanez // | MFI.getStackSize() | | | 761ef76a333SRoger Ferrer Ibanez // |--------------------------| -- | 762ef76a333SRoger Ferrer Ibanez // | scalar local variables | | <----' 7635a31a673SHsiangkai Wang // |--------------------------| -- <-- SP 764ef76a333SRoger Ferrer Ibanez // 765ef76a333SRoger Ferrer Ibanez // The total amount of padding surrounding RVV objects is described by 766ef76a333SRoger Ferrer Ibanez // RVV->getRVVPadding() and it can be zero. It allows us to align the RVV 767ef76a333SRoger Ferrer Ibanez // objects to 8 bytes. 7685a31a673SHsiangkai Wang if (MFI.getStackID(FI) == TargetStackID::Default) { 7695603ed60Sluxufan if (MFI.isFixedObjectIndex(FI)) { 7705603ed60Sluxufan Offset += StackOffset::get(MFI.getStackSize() + RVFI->getRVVPadding() 7715603ed60Sluxufan + RVFI->getLibCallStackSize(), RVFI->getRVVStackSize()); 7725603ed60Sluxufan } else { 7735a31a673SHsiangkai Wang Offset += StackOffset::getFixed(MFI.getStackSize()); 7745603ed60Sluxufan } 775a9b9c64fSluxufan } else if (MFI.getStackID(FI) == TargetStackID::ScalableVector) { 776ef76a333SRoger Ferrer Ibanez Offset += StackOffset::get( 777ef76a333SRoger Ferrer Ibanez alignTo(MFI.getStackSize() - RVFI->getCalleeSavedStackSize(), 8), 778a9b9c64fSluxufan RVFI->getRVVStackSize()); 77907f7c002Slewis-revill } 780660bccecSAlex Bradbury } 7815a31a673SHsiangkai Wang } 7825a31a673SHsiangkai Wang 7835a31a673SHsiangkai Wang return Offset; 784660bccecSAlex Bradbury } 785b014e3deSAlex Bradbury 786b014e3deSAlex Bradbury void RISCVFrameLowering::determineCalleeSaves(MachineFunction &MF, 787b014e3deSAlex Bradbury BitVector &SavedRegs, 788b014e3deSAlex Bradbury RegScavenger *RS) const { 789b014e3deSAlex Bradbury TargetFrameLowering::determineCalleeSaves(MF, SavedRegs, RS); 7907d6aa1f7SAlex Bradbury // Unconditionally spill RA and FP only if the function uses a frame 7917d6aa1f7SAlex Bradbury // pointer. 7927d6aa1f7SAlex Bradbury if (hasFP(MF)) { 793b014e3deSAlex Bradbury SavedRegs.set(RISCV::X1); 794b014e3deSAlex Bradbury SavedRegs.set(RISCV::X8); 795b014e3deSAlex Bradbury } 796cf6cf0cdSShiva Chen // Mark BP as used if function has dedicated base pointer. 797cf6cf0cdSShiva Chen if (hasBP(MF)) 798cf6cf0cdSShiva Chen SavedRegs.set(RISCVABI::getBPReg()); 7992e4106b7SAna Pazos 8002e4106b7SAna Pazos // If interrupt is enabled and there are calls in the handler, 8012e4106b7SAna Pazos // unconditionally save all Caller-saved registers and 8022e4106b7SAna Pazos // all FP registers, regardless whether they are used. 8032e4106b7SAna Pazos MachineFrameInfo &MFI = MF.getFrameInfo(); 8042e4106b7SAna Pazos 8052e4106b7SAna Pazos if (MF.getFunction().hasFnAttribute("interrupt") && MFI.hasCalls()) { 8062e4106b7SAna Pazos 8072e4106b7SAna Pazos static const MCPhysReg CSRegs[] = { RISCV::X1, /* ra */ 8082e4106b7SAna Pazos RISCV::X5, RISCV::X6, RISCV::X7, /* t0-t2 */ 8092e4106b7SAna Pazos RISCV::X10, RISCV::X11, /* a0-a1, a2-a7 */ 8102e4106b7SAna Pazos RISCV::X12, RISCV::X13, RISCV::X14, RISCV::X15, RISCV::X16, RISCV::X17, 8112e4106b7SAna Pazos RISCV::X28, RISCV::X29, RISCV::X30, RISCV::X31, 0 /* t3-t6 */ 8122e4106b7SAna Pazos }; 8132e4106b7SAna Pazos 8142e4106b7SAna Pazos for (unsigned i = 0; CSRegs[i]; ++i) 8152e4106b7SAna Pazos SavedRegs.set(CSRegs[i]); 8162e4106b7SAna Pazos 817f7bc7c29SHsiangkai Wang if (MF.getSubtarget<RISCVSubtarget>().hasStdExtF()) { 8182e4106b7SAna Pazos 8192e4106b7SAna Pazos // If interrupt is enabled, this list contains all FP registers. 8202e4106b7SAna Pazos const MCPhysReg * Regs = MF.getRegInfo().getCalleeSavedRegs(); 8212e4106b7SAna Pazos 8222e4106b7SAna Pazos for (unsigned i = 0; Regs[i]; ++i) 823f7bc7c29SHsiangkai Wang if (RISCV::FPR16RegClass.contains(Regs[i]) || 824f7bc7c29SHsiangkai Wang RISCV::FPR32RegClass.contains(Regs[i]) || 8252e4106b7SAna Pazos RISCV::FPR64RegClass.contains(Regs[i])) 8262e4106b7SAna Pazos SavedRegs.set(Regs[i]); 8272e4106b7SAna Pazos } 8282e4106b7SAna Pazos } 8297d6aa1f7SAlex Bradbury } 8300715d35eSAlex Bradbury 8315a31a673SHsiangkai Wang int64_t 8325a31a673SHsiangkai Wang RISCVFrameLowering::assignRVVStackObjectOffsets(MachineFrameInfo &MFI) const { 8335a31a673SHsiangkai Wang int64_t Offset = 0; 8345a31a673SHsiangkai Wang // Create a buffer of RVV objects to allocate. 8355a31a673SHsiangkai Wang SmallVector<int, 8> ObjectsToAllocate; 8365a31a673SHsiangkai Wang for (int I = 0, E = MFI.getObjectIndexEnd(); I != E; ++I) { 8375a31a673SHsiangkai Wang unsigned StackID = MFI.getStackID(I); 8385a31a673SHsiangkai Wang if (StackID != TargetStackID::ScalableVector) 8395a31a673SHsiangkai Wang continue; 8405a31a673SHsiangkai Wang if (MFI.isDeadObjectIndex(I)) 8415a31a673SHsiangkai Wang continue; 8425a31a673SHsiangkai Wang 8435a31a673SHsiangkai Wang ObjectsToAllocate.push_back(I); 8445a31a673SHsiangkai Wang } 8455a31a673SHsiangkai Wang 8465a31a673SHsiangkai Wang // Allocate all RVV locals and spills 8475a31a673SHsiangkai Wang for (int FI : ObjectsToAllocate) { 8485a31a673SHsiangkai Wang // ObjectSize in bytes. 8495a31a673SHsiangkai Wang int64_t ObjectSize = MFI.getObjectSize(FI); 8505a31a673SHsiangkai Wang // If the data type is the fractional vector type, reserve one vector 8515a31a673SHsiangkai Wang // register for it. 8525a31a673SHsiangkai Wang if (ObjectSize < 8) 8535a31a673SHsiangkai Wang ObjectSize = 8; 8545a31a673SHsiangkai Wang // Currently, all scalable vector types are aligned to 8 bytes. 8555a31a673SHsiangkai Wang Offset = alignTo(Offset + ObjectSize, 8); 8565a31a673SHsiangkai Wang MFI.setObjectOffset(FI, -Offset); 8575a31a673SHsiangkai Wang } 8585a31a673SHsiangkai Wang 8595a31a673SHsiangkai Wang return Offset; 8605a31a673SHsiangkai Wang } 8615a31a673SHsiangkai Wang 8628790e852SFraser Cormack static bool hasRVVSpillWithFIs(MachineFunction &MF, const RISCVInstrInfo &TII) { 8638790e852SFraser Cormack if (!MF.getSubtarget<RISCVSubtarget>().hasStdExtV()) 8648790e852SFraser Cormack return false; 8658790e852SFraser Cormack return any_of(MF, [&TII](const MachineBasicBlock &MBB) { 8668790e852SFraser Cormack return any_of(MBB, [&TII](const MachineInstr &MI) { 8678790e852SFraser Cormack return TII.isRVVSpill(MI, /*CheckFIs*/ true); 8688790e852SFraser Cormack }); 8698790e852SFraser Cormack }); 8708790e852SFraser Cormack } 8718790e852SFraser Cormack 8720715d35eSAlex Bradbury void RISCVFrameLowering::processFunctionBeforeFrameFinalized( 8730715d35eSAlex Bradbury MachineFunction &MF, RegScavenger *RS) const { 8748790e852SFraser Cormack const RISCVRegisterInfo *RegInfo = 8758790e852SFraser Cormack MF.getSubtarget<RISCVSubtarget>().getRegisterInfo(); 8760715d35eSAlex Bradbury MachineFrameInfo &MFI = MF.getFrameInfo(); 8770715d35eSAlex Bradbury const TargetRegisterClass *RC = &RISCV::GPRRegClass; 878a9b9c64fSluxufan auto *RVFI = MF.getInfo<RISCVMachineFunctionInfo>(); 879a9b9c64fSluxufan 880a9b9c64fSluxufan int64_t RVVStackSize = assignRVVStackObjectOffsets(MFI); 881a9b9c64fSluxufan RVFI->setRVVStackSize(RVVStackSize); 8828790e852SFraser Cormack const RISCVInstrInfo &TII = *MF.getSubtarget<RISCVSubtarget>().getInstrInfo(); 883a9b9c64fSluxufan 8840715d35eSAlex Bradbury // estimateStackSize has been observed to under-estimate the final stack 8850715d35eSAlex Bradbury // size, so give ourselves wiggle-room by checking for stack size 8860715d35eSAlex Bradbury // representable an 11-bit signed field rather than 12-bits. 8870715d35eSAlex Bradbury // FIXME: It may be possible to craft a function with a small stack that 8880715d35eSAlex Bradbury // still needs an emergency spill slot for branch relaxation. This case 8890715d35eSAlex Bradbury // would currently be missed. 8908790e852SFraser Cormack // RVV loads & stores have no capacity to hold the immediate address offsets 8918790e852SFraser Cormack // so we must always reserve an emergency spill slot if the MachineFunction 8928790e852SFraser Cormack // contains any RVV spills. 8938790e852SFraser Cormack if (!isInt<11>(MFI.estimateStackSize(MF)) || hasRVVSpillWithFIs(MF, TII)) { 89428de229bSGuillaume Chatelet int RegScavFI = MFI.CreateStackObject(RegInfo->getSpillSize(*RC), 89528de229bSGuillaume Chatelet RegInfo->getSpillAlign(*RC), false); 8960715d35eSAlex Bradbury RS->addScavengingFrameIndex(RegScavFI); 897b4a358a7SFraser Cormack // For RVV, scalable stack offsets require up to two scratch registers to 898b4a358a7SFraser Cormack // compute the final offset. Reserve an additional emergency spill slot. 899b4a358a7SFraser Cormack if (RVVStackSize != 0) { 900b4a358a7SFraser Cormack int RVVRegScavFI = MFI.CreateStackObject( 901b4a358a7SFraser Cormack RegInfo->getSpillSize(*RC), RegInfo->getSpillAlign(*RC), false); 902b4a358a7SFraser Cormack RS->addScavengingFrameIndex(RVVRegScavFI); 903b4a358a7SFraser Cormack } 9040715d35eSAlex Bradbury } 9055a31a673SHsiangkai Wang 906a9b9c64fSluxufan if (MFI.getCalleeSavedInfo().empty() || RVFI->useSaveRestoreLibCalls(MF)) { 907a9b9c64fSluxufan RVFI->setCalleeSavedStackSize(0); 908a9b9c64fSluxufan return; 909a9b9c64fSluxufan } 910a9b9c64fSluxufan 911ef76a333SRoger Ferrer Ibanez unsigned Size = 0; 912a9b9c64fSluxufan for (const auto &Info : MFI.getCalleeSavedInfo()) { 913a9b9c64fSluxufan int FrameIdx = Info.getFrameIdx(); 914a9b9c64fSluxufan if (MFI.getStackID(FrameIdx) != TargetStackID::Default) 915a9b9c64fSluxufan continue; 916a9b9c64fSluxufan 917ef76a333SRoger Ferrer Ibanez Size += MFI.getObjectSize(FrameIdx); 918a9b9c64fSluxufan } 919a9b9c64fSluxufan RVFI->setCalleeSavedStackSize(Size); 920ef76a333SRoger Ferrer Ibanez 921ef76a333SRoger Ferrer Ibanez // Padding required to keep the RVV stack aligned to 8 bytes 922ef76a333SRoger Ferrer Ibanez // within the main stack. We only need this when not using FP. 923ef76a333SRoger Ferrer Ibanez if (RVVStackSize && !hasFP(MF) && Size % 8 != 0) { 924ef76a333SRoger Ferrer Ibanez // Because we add the padding to the size of the stack, adding 925ef76a333SRoger Ferrer Ibanez // getStackAlign() will keep it aligned. 926ef76a333SRoger Ferrer Ibanez RVFI->setRVVPadding(getStackAlign().value()); 927ef76a333SRoger Ferrer Ibanez } 9280715d35eSAlex Bradbury } 929cbd498acSShiva Chen 930643b6407SHsiangkai Wang static bool hasRVVFrameObject(const MachineFunction &MF) { 931643b6407SHsiangkai Wang const MachineFrameInfo &MFI = MF.getFrameInfo(); 932643b6407SHsiangkai Wang for (int I = 0, E = MFI.getObjectIndexEnd(); I != E; ++I) 933643b6407SHsiangkai Wang if (MFI.getStackID(I) == TargetStackID::ScalableVector) 934643b6407SHsiangkai Wang return true; 935643b6407SHsiangkai Wang return false; 936643b6407SHsiangkai Wang } 937643b6407SHsiangkai Wang 938cbd498acSShiva Chen // Not preserve stack space within prologue for outgoing variables when the 939643b6407SHsiangkai Wang // function contains variable size objects or there are vector objects accessed 940643b6407SHsiangkai Wang // by the frame pointer. 941643b6407SHsiangkai Wang // Let eliminateCallFramePseudoInstr preserve stack space for it. 942cbd498acSShiva Chen bool RISCVFrameLowering::hasReservedCallFrame(const MachineFunction &MF) const { 943643b6407SHsiangkai Wang return !MF.getFrameInfo().hasVarSizedObjects() && 944643b6407SHsiangkai Wang !(hasFP(MF) && hasRVVFrameObject(MF)); 945cbd498acSShiva Chen } 946cbd498acSShiva Chen 947cbd498acSShiva Chen // Eliminate ADJCALLSTACKDOWN, ADJCALLSTACKUP pseudo instructions. 948cbd498acSShiva Chen MachineBasicBlock::iterator RISCVFrameLowering::eliminateCallFramePseudoInstr( 949cbd498acSShiva Chen MachineFunction &MF, MachineBasicBlock &MBB, 950cbd498acSShiva Chen MachineBasicBlock::iterator MI) const { 951fa06e958SLuis Marques Register SPReg = RISCV::X2; 952cbd498acSShiva Chen DebugLoc DL = MI->getDebugLoc(); 953cbd498acSShiva Chen 954cbd498acSShiva Chen if (!hasReservedCallFrame(MF)) { 955cbd498acSShiva Chen // If space has not been reserved for a call frame, ADJCALLSTACKDOWN and 956cbd498acSShiva Chen // ADJCALLSTACKUP must be converted to instructions manipulating the stack 957cbd498acSShiva Chen // pointer. This is necessary when there is a variable length stack 958cbd498acSShiva Chen // allocation (e.g. alloca), which means it's not possible to allocate 959cbd498acSShiva Chen // space for outgoing arguments from within the function prologue. 960cbd498acSShiva Chen int64_t Amount = MI->getOperand(0).getImm(); 961cbd498acSShiva Chen 962cbd498acSShiva Chen if (Amount != 0) { 963cbd498acSShiva Chen // Ensure the stack remains aligned after adjustment. 964cbd498acSShiva Chen Amount = alignSPAdjust(Amount); 965cbd498acSShiva Chen 966cbd498acSShiva Chen if (MI->getOpcode() == RISCV::ADJCALLSTACKDOWN) 967cbd498acSShiva Chen Amount = -Amount; 968cbd498acSShiva Chen 969cbd498acSShiva Chen adjustReg(MBB, MI, DL, SPReg, SPReg, Amount, MachineInstr::NoFlags); 970cbd498acSShiva Chen } 971cbd498acSShiva Chen } 972cbd498acSShiva Chen 973cbd498acSShiva Chen return MBB.erase(MI); 974cbd498acSShiva Chen } 975ff55e2e0SShiva Chen 976ff55e2e0SShiva Chen // We would like to split the SP adjustment to reduce prologue/epilogue 977ff55e2e0SShiva Chen // as following instructions. In this way, the offset of the callee saved 978ff55e2e0SShiva Chen // register could fit in a single store. 979ff55e2e0SShiva Chen // add sp,sp,-2032 980ff55e2e0SShiva Chen // sw ra,2028(sp) 981ff55e2e0SShiva Chen // sw s0,2024(sp) 982ff55e2e0SShiva Chen // sw s1,2020(sp) 983ff55e2e0SShiva Chen // sw s3,2012(sp) 984ff55e2e0SShiva Chen // sw s4,2008(sp) 985ff55e2e0SShiva Chen // add sp,sp,-64 986ff55e2e0SShiva Chen uint64_t 987ff55e2e0SShiva Chen RISCVFrameLowering::getFirstSPAdjustAmount(const MachineFunction &MF) const { 98807f7c002Slewis-revill const auto *RVFI = MF.getInfo<RISCVMachineFunctionInfo>(); 989ff55e2e0SShiva Chen const MachineFrameInfo &MFI = MF.getFrameInfo(); 990ff55e2e0SShiva Chen const std::vector<CalleeSavedInfo> &CSI = MFI.getCalleeSavedInfo(); 991ff55e2e0SShiva Chen uint64_t StackSize = MFI.getStackSize(); 992ff55e2e0SShiva Chen 99307f7c002Slewis-revill // Disable SplitSPAdjust if save-restore libcall used. The callee saved 99407f7c002Slewis-revill // registers will be pushed by the save-restore libcalls, so we don't have to 99507f7c002Slewis-revill // split the SP adjustment in this case. 99607f7c002Slewis-revill if (RVFI->getLibCallStackSize()) 99707f7c002Slewis-revill return 0; 99807f7c002Slewis-revill 999ff55e2e0SShiva Chen // Return the FirstSPAdjustAmount if the StackSize can not fit in signed 1000ff55e2e0SShiva Chen // 12-bit and there exists a callee saved register need to be pushed. 1001ff55e2e0SShiva Chen if (!isInt<12>(StackSize) && (CSI.size() > 0)) { 1002ff55e2e0SShiva Chen // FirstSPAdjustAmount is choosed as (2048 - StackAlign) 1003ff55e2e0SShiva Chen // because 2048 will cause sp = sp + 2048 in epilogue split into 1004ff55e2e0SShiva Chen // multi-instructions. The offset smaller than 2048 can fit in signle 1005ff55e2e0SShiva Chen // load/store instruction and we have to stick with the stack alignment. 1006ff55e2e0SShiva Chen // 2048 is 16-byte alignment. The stack alignment for RV32 and RV64 is 16, 1007ff55e2e0SShiva Chen // for RV32E is 4. So (2048 - StackAlign) will satisfy the stack alignment. 10083ba550a0SGuillaume Chatelet return 2048 - getStackAlign().value(); 1009ff55e2e0SShiva Chen } 1010ff55e2e0SShiva Chen return 0; 1011ff55e2e0SShiva Chen } 101207f7c002Slewis-revill 101307f7c002Slewis-revill bool RISCVFrameLowering::spillCalleeSavedRegisters( 101407f7c002Slewis-revill MachineBasicBlock &MBB, MachineBasicBlock::iterator MI, 101507f7c002Slewis-revill ArrayRef<CalleeSavedInfo> CSI, const TargetRegisterInfo *TRI) const { 101607f7c002Slewis-revill if (CSI.empty()) 101707f7c002Slewis-revill return true; 101807f7c002Slewis-revill 101907f7c002Slewis-revill MachineFunction *MF = MBB.getParent(); 102007f7c002Slewis-revill const TargetInstrInfo &TII = *MF->getSubtarget().getInstrInfo(); 102107f7c002Slewis-revill DebugLoc DL; 102207f7c002Slewis-revill if (MI != MBB.end() && !MI->isDebugInstr()) 102307f7c002Slewis-revill DL = MI->getDebugLoc(); 102407f7c002Slewis-revill 102507f7c002Slewis-revill const char *SpillLibCall = getSpillLibCallName(*MF, CSI); 102607f7c002Slewis-revill if (SpillLibCall) { 102707f7c002Slewis-revill // Add spill libcall via non-callee-saved register t0. 102807f7c002Slewis-revill BuildMI(MBB, MI, DL, TII.get(RISCV::PseudoCALLReg), RISCV::X5) 102907f7c002Slewis-revill .addExternalSymbol(SpillLibCall, RISCVII::MO_CALL) 103007f7c002Slewis-revill .setMIFlag(MachineInstr::FrameSetup); 103107f7c002Slewis-revill 103207f7c002Slewis-revill // Add registers spilled in libcall as liveins. 103307f7c002Slewis-revill for (auto &CS : CSI) 103407f7c002Slewis-revill MBB.addLiveIn(CS.getReg()); 103507f7c002Slewis-revill } 103607f7c002Slewis-revill 103707f7c002Slewis-revill // Manually spill values not spilled by libcall. 10385a31a673SHsiangkai Wang const auto &NonLibcallCSI = getNonLibcallCSI(*MF, CSI); 103907f7c002Slewis-revill for (auto &CS : NonLibcallCSI) { 104007f7c002Slewis-revill // Insert the spill to the stack frame. 104107f7c002Slewis-revill Register Reg = CS.getReg(); 104207f7c002Slewis-revill const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg); 104307f7c002Slewis-revill TII.storeRegToStackSlot(MBB, MI, Reg, true, CS.getFrameIdx(), RC, TRI); 104407f7c002Slewis-revill } 104507f7c002Slewis-revill 104607f7c002Slewis-revill return true; 104707f7c002Slewis-revill } 104807f7c002Slewis-revill 104907f7c002Slewis-revill bool RISCVFrameLowering::restoreCalleeSavedRegisters( 105007f7c002Slewis-revill MachineBasicBlock &MBB, MachineBasicBlock::iterator MI, 1051186dd631SBenjamin Kramer MutableArrayRef<CalleeSavedInfo> CSI, const TargetRegisterInfo *TRI) const { 105207f7c002Slewis-revill if (CSI.empty()) 105307f7c002Slewis-revill return true; 105407f7c002Slewis-revill 105507f7c002Slewis-revill MachineFunction *MF = MBB.getParent(); 105607f7c002Slewis-revill const TargetInstrInfo &TII = *MF->getSubtarget().getInstrInfo(); 105707f7c002Slewis-revill DebugLoc DL; 105807f7c002Slewis-revill if (MI != MBB.end() && !MI->isDebugInstr()) 105907f7c002Slewis-revill DL = MI->getDebugLoc(); 106007f7c002Slewis-revill 106107f7c002Slewis-revill // Manually restore values not restored by libcall. Insert in reverse order. 106207f7c002Slewis-revill // loadRegFromStackSlot can insert multiple instructions. 10635a31a673SHsiangkai Wang const auto &NonLibcallCSI = getNonLibcallCSI(*MF, CSI); 106407f7c002Slewis-revill for (auto &CS : reverse(NonLibcallCSI)) { 106507f7c002Slewis-revill Register Reg = CS.getReg(); 106607f7c002Slewis-revill const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg); 106707f7c002Slewis-revill TII.loadRegFromStackSlot(MBB, MI, Reg, CS.getFrameIdx(), RC, TRI); 106807f7c002Slewis-revill assert(MI != MBB.begin() && "loadRegFromStackSlot didn't insert any code!"); 106907f7c002Slewis-revill } 107007f7c002Slewis-revill 107107f7c002Slewis-revill const char *RestoreLibCall = getRestoreLibCallName(*MF, CSI); 107207f7c002Slewis-revill if (RestoreLibCall) { 107307f7c002Slewis-revill // Add restore libcall via tail call. 107407f7c002Slewis-revill MachineBasicBlock::iterator NewMI = 107507f7c002Slewis-revill BuildMI(MBB, MI, DL, TII.get(RISCV::PseudoTAIL)) 107607f7c002Slewis-revill .addExternalSymbol(RestoreLibCall, RISCVII::MO_CALL) 107707f7c002Slewis-revill .setMIFlag(MachineInstr::FrameDestroy); 107807f7c002Slewis-revill 107907f7c002Slewis-revill // Remove trailing returns, since the terminator is now a tail call to the 108007f7c002Slewis-revill // restore function. 108107f7c002Slewis-revill if (MI != MBB.end() && MI->getOpcode() == RISCV::PseudoRET) { 108207f7c002Slewis-revill NewMI->copyImplicitOps(*MF, *MI); 108307f7c002Slewis-revill MI->eraseFromParent(); 108407f7c002Slewis-revill } 108507f7c002Slewis-revill } 108607f7c002Slewis-revill 108707f7c002Slewis-revill return true; 108807f7c002Slewis-revill } 108907f7c002Slewis-revill 109007f7c002Slewis-revill bool RISCVFrameLowering::canUseAsPrologue(const MachineBasicBlock &MBB) const { 109107f7c002Slewis-revill MachineBasicBlock *TmpMBB = const_cast<MachineBasicBlock *>(&MBB); 109208649f0aSMatt Arsenault const MachineFunction *MF = MBB.getParent(); 109308649f0aSMatt Arsenault const auto *RVFI = MF->getInfo<RISCVMachineFunctionInfo>(); 109407f7c002Slewis-revill 109508649f0aSMatt Arsenault if (!RVFI->useSaveRestoreLibCalls(*MF)) 109607f7c002Slewis-revill return true; 109707f7c002Slewis-revill 109807f7c002Slewis-revill // Inserting a call to a __riscv_save libcall requires the use of the register 109907f7c002Slewis-revill // t0 (X5) to hold the return address. Therefore if this register is already 110007f7c002Slewis-revill // used we can't insert the call. 110107f7c002Slewis-revill 110207f7c002Slewis-revill RegScavenger RS; 110307f7c002Slewis-revill RS.enterBasicBlock(*TmpMBB); 110407f7c002Slewis-revill return !RS.isRegUsed(RISCV::X5); 110507f7c002Slewis-revill } 110607f7c002Slewis-revill 110707f7c002Slewis-revill bool RISCVFrameLowering::canUseAsEpilogue(const MachineBasicBlock &MBB) const { 110808649f0aSMatt Arsenault const MachineFunction *MF = MBB.getParent(); 110907f7c002Slewis-revill MachineBasicBlock *TmpMBB = const_cast<MachineBasicBlock *>(&MBB); 111008649f0aSMatt Arsenault const auto *RVFI = MF->getInfo<RISCVMachineFunctionInfo>(); 111107f7c002Slewis-revill 111208649f0aSMatt Arsenault if (!RVFI->useSaveRestoreLibCalls(*MF)) 111307f7c002Slewis-revill return true; 111407f7c002Slewis-revill 111507f7c002Slewis-revill // Using the __riscv_restore libcalls to restore CSRs requires a tail call. 111607f7c002Slewis-revill // This means if we still need to continue executing code within this function 111707f7c002Slewis-revill // the restore cannot take place in this basic block. 111807f7c002Slewis-revill 111907f7c002Slewis-revill if (MBB.succ_size() > 1) 112007f7c002Slewis-revill return false; 112107f7c002Slewis-revill 112207f7c002Slewis-revill MachineBasicBlock *SuccMBB = 112307f7c002Slewis-revill MBB.succ_empty() ? TmpMBB->getFallThrough() : *MBB.succ_begin(); 112407f7c002Slewis-revill 112507f7c002Slewis-revill // Doing a tail call should be safe if there are no successors, because either 112607f7c002Slewis-revill // we have a returning block or the end of the block is unreachable, so the 112707f7c002Slewis-revill // restore will be eliminated regardless. 112807f7c002Slewis-revill if (!SuccMBB) 112907f7c002Slewis-revill return true; 113007f7c002Slewis-revill 113107f7c002Slewis-revill // The successor can only contain a return, since we would effectively be 113207f7c002Slewis-revill // replacing the successor with our own tail return at the end of our block. 113307f7c002Slewis-revill return SuccMBB->isReturnBlock() && SuccMBB->size() == 1; 113407f7c002Slewis-revill } 11355a31a673SHsiangkai Wang 11365a31a673SHsiangkai Wang bool RISCVFrameLowering::isSupportedStackID(TargetStackID::Value ID) const { 11375a31a673SHsiangkai Wang switch (ID) { 11385a31a673SHsiangkai Wang case TargetStackID::Default: 11395a31a673SHsiangkai Wang case TargetStackID::ScalableVector: 11405a31a673SHsiangkai Wang return true; 11415a31a673SHsiangkai Wang case TargetStackID::NoAlloc: 11425a31a673SHsiangkai Wang case TargetStackID::SGPRSpill: 114382f92e35SAndy Wingo case TargetStackID::WasmLocal: 11445a31a673SHsiangkai Wang return false; 11455a31a673SHsiangkai Wang } 11465a31a673SHsiangkai Wang llvm_unreachable("Invalid TargetStackID::Value"); 11475a31a673SHsiangkai Wang } 11485a31a673SHsiangkai Wang 11495a31a673SHsiangkai Wang TargetStackID::Value RISCVFrameLowering::getStackIDForScalableVectors() const { 11505a31a673SHsiangkai Wang return TargetStackID::ScalableVector; 11515a31a673SHsiangkai Wang } 1152