1 //===-- RISCVFrameLowering.cpp - RISCV Frame Information ------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file contains the RISCV implementation of TargetFrameLowering class.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "RISCVFrameLowering.h"
14 #include "RISCVMachineFunctionInfo.h"
15 #include "RISCVSubtarget.h"
16 #include "llvm/CodeGen/MachineFrameInfo.h"
17 #include "llvm/CodeGen/MachineFunction.h"
18 #include "llvm/CodeGen/MachineInstrBuilder.h"
19 #include "llvm/CodeGen/MachineRegisterInfo.h"
20 #include "llvm/CodeGen/RegisterScavenging.h"
21 #include "llvm/IR/DiagnosticInfo.h"
22 #include "llvm/MC/MCDwarf.h"
23 
24 using namespace llvm;
25 
26 // For now we use x18, a.k.a s2, as pointer to shadow call stack.
27 // User should explicitly set -ffixed-x18 and not use x18 in their asm.
28 static void emitSCSPrologue(MachineFunction &MF, MachineBasicBlock &MBB,
29                             MachineBasicBlock::iterator MI,
30                             const DebugLoc &DL) {
31   if (!MF.getFunction().hasFnAttribute(Attribute::ShadowCallStack))
32     return;
33 
34   const auto &STI = MF.getSubtarget<RISCVSubtarget>();
35   Register RAReg = STI.getRegisterInfo()->getRARegister();
36 
37   // Do not save RA to the SCS if it's not saved to the regular stack,
38   // i.e. RA is not at risk of being overwritten.
39   std::vector<CalleeSavedInfo> &CSI = MF.getFrameInfo().getCalleeSavedInfo();
40   if (std::none_of(CSI.begin(), CSI.end(),
41                    [&](CalleeSavedInfo &CSR) { return CSR.getReg() == RAReg; }))
42     return;
43 
44   Register SCSPReg = RISCVABI::getSCSPReg();
45 
46   auto &Ctx = MF.getFunction().getContext();
47   if (!STI.isRegisterReservedByUser(SCSPReg)) {
48     Ctx.diagnose(DiagnosticInfoUnsupported{
49         MF.getFunction(), "x18 not reserved by user for Shadow Call Stack."});
50     return;
51   }
52 
53   const auto *RVFI = MF.getInfo<RISCVMachineFunctionInfo>();
54   if (RVFI->useSaveRestoreLibCalls(MF)) {
55     Ctx.diagnose(DiagnosticInfoUnsupported{
56         MF.getFunction(),
57         "Shadow Call Stack cannot be combined with Save/Restore LibCalls."});
58     return;
59   }
60 
61   const RISCVInstrInfo *TII = STI.getInstrInfo();
62   bool IsRV64 = STI.hasFeature(RISCV::Feature64Bit);
63   int64_t SlotSize = STI.getXLen() / 8;
64   // Store return address to shadow call stack
65   // s[w|d]  ra, 0(s2)
66   // addi    s2, s2, [4|8]
67   BuildMI(MBB, MI, DL, TII->get(IsRV64 ? RISCV::SD : RISCV::SW))
68       .addReg(RAReg)
69       .addReg(SCSPReg)
70       .addImm(0)
71       .setMIFlag(MachineInstr::FrameSetup);
72   BuildMI(MBB, MI, DL, TII->get(RISCV::ADDI))
73       .addReg(SCSPReg, RegState::Define)
74       .addReg(SCSPReg)
75       .addImm(SlotSize)
76       .setMIFlag(MachineInstr::FrameSetup);
77 }
78 
79 static void emitSCSEpilogue(MachineFunction &MF, MachineBasicBlock &MBB,
80                             MachineBasicBlock::iterator MI,
81                             const DebugLoc &DL) {
82   if (!MF.getFunction().hasFnAttribute(Attribute::ShadowCallStack))
83     return;
84 
85   const auto &STI = MF.getSubtarget<RISCVSubtarget>();
86   Register RAReg = STI.getRegisterInfo()->getRARegister();
87 
88   // See emitSCSPrologue() above.
89   std::vector<CalleeSavedInfo> &CSI = MF.getFrameInfo().getCalleeSavedInfo();
90   if (std::none_of(CSI.begin(), CSI.end(),
91                    [&](CalleeSavedInfo &CSR) { return CSR.getReg() == RAReg; }))
92     return;
93 
94   Register SCSPReg = RISCVABI::getSCSPReg();
95 
96   auto &Ctx = MF.getFunction().getContext();
97   if (!STI.isRegisterReservedByUser(SCSPReg)) {
98     Ctx.diagnose(DiagnosticInfoUnsupported{
99         MF.getFunction(), "x18 not reserved by user for Shadow Call Stack."});
100     return;
101   }
102 
103   const auto *RVFI = MF.getInfo<RISCVMachineFunctionInfo>();
104   if (RVFI->useSaveRestoreLibCalls(MF)) {
105     Ctx.diagnose(DiagnosticInfoUnsupported{
106         MF.getFunction(),
107         "Shadow Call Stack cannot be combined with Save/Restore LibCalls."});
108     return;
109   }
110 
111   const RISCVInstrInfo *TII = STI.getInstrInfo();
112   bool IsRV64 = STI.hasFeature(RISCV::Feature64Bit);
113   int64_t SlotSize = STI.getXLen() / 8;
114   // Load return address from shadow call stack
115   // l[w|d]  ra, -[4|8](s2)
116   // addi    s2, s2, -[4|8]
117   BuildMI(MBB, MI, DL, TII->get(IsRV64 ? RISCV::LD : RISCV::LW))
118       .addReg(RAReg, RegState::Define)
119       .addReg(SCSPReg)
120       .addImm(-SlotSize)
121       .setMIFlag(MachineInstr::FrameDestroy);
122   BuildMI(MBB, MI, DL, TII->get(RISCV::ADDI))
123       .addReg(SCSPReg, RegState::Define)
124       .addReg(SCSPReg)
125       .addImm(-SlotSize)
126       .setMIFlag(MachineInstr::FrameDestroy);
127 }
128 
129 // Get the ID of the libcall used for spilling and restoring callee saved
130 // registers. The ID is representative of the number of registers saved or
131 // restored by the libcall, except it is zero-indexed - ID 0 corresponds to a
132 // single register.
133 static int getLibCallID(const MachineFunction &MF,
134                         const std::vector<CalleeSavedInfo> &CSI) {
135   const auto *RVFI = MF.getInfo<RISCVMachineFunctionInfo>();
136 
137   if (CSI.empty() || !RVFI->useSaveRestoreLibCalls(MF))
138     return -1;
139 
140   Register MaxReg = RISCV::NoRegister;
141   for (auto &CS : CSI)
142     // RISCVRegisterInfo::hasReservedSpillSlot assigns negative frame indexes to
143     // registers which can be saved by libcall.
144     if (CS.getFrameIdx() < 0)
145       MaxReg = std::max(MaxReg.id(), CS.getReg().id());
146 
147   if (MaxReg == RISCV::NoRegister)
148     return -1;
149 
150   switch (MaxReg) {
151   default:
152     llvm_unreachable("Something has gone wrong!");
153   case /*s11*/ RISCV::X27: return 12;
154   case /*s10*/ RISCV::X26: return 11;
155   case /*s9*/  RISCV::X25: return 10;
156   case /*s8*/  RISCV::X24: return 9;
157   case /*s7*/  RISCV::X23: return 8;
158   case /*s6*/  RISCV::X22: return 7;
159   case /*s5*/  RISCV::X21: return 6;
160   case /*s4*/  RISCV::X20: return 5;
161   case /*s3*/  RISCV::X19: return 4;
162   case /*s2*/  RISCV::X18: return 3;
163   case /*s1*/  RISCV::X9:  return 2;
164   case /*s0*/  RISCV::X8:  return 1;
165   case /*ra*/  RISCV::X1:  return 0;
166   }
167 }
168 
169 // Get the name of the libcall used for spilling callee saved registers.
170 // If this function will not use save/restore libcalls, then return a nullptr.
171 static const char *
172 getSpillLibCallName(const MachineFunction &MF,
173                     const std::vector<CalleeSavedInfo> &CSI) {
174   static const char *const SpillLibCalls[] = {
175     "__riscv_save_0",
176     "__riscv_save_1",
177     "__riscv_save_2",
178     "__riscv_save_3",
179     "__riscv_save_4",
180     "__riscv_save_5",
181     "__riscv_save_6",
182     "__riscv_save_7",
183     "__riscv_save_8",
184     "__riscv_save_9",
185     "__riscv_save_10",
186     "__riscv_save_11",
187     "__riscv_save_12"
188   };
189 
190   int LibCallID = getLibCallID(MF, CSI);
191   if (LibCallID == -1)
192     return nullptr;
193   return SpillLibCalls[LibCallID];
194 }
195 
196 // Get the name of the libcall used for restoring callee saved registers.
197 // If this function will not use save/restore libcalls, then return a nullptr.
198 static const char *
199 getRestoreLibCallName(const MachineFunction &MF,
200                       const std::vector<CalleeSavedInfo> &CSI) {
201   static const char *const RestoreLibCalls[] = {
202     "__riscv_restore_0",
203     "__riscv_restore_1",
204     "__riscv_restore_2",
205     "__riscv_restore_3",
206     "__riscv_restore_4",
207     "__riscv_restore_5",
208     "__riscv_restore_6",
209     "__riscv_restore_7",
210     "__riscv_restore_8",
211     "__riscv_restore_9",
212     "__riscv_restore_10",
213     "__riscv_restore_11",
214     "__riscv_restore_12"
215   };
216 
217   int LibCallID = getLibCallID(MF, CSI);
218   if (LibCallID == -1)
219     return nullptr;
220   return RestoreLibCalls[LibCallID];
221 }
222 
223 bool RISCVFrameLowering::hasFP(const MachineFunction &MF) const {
224   const TargetRegisterInfo *RegInfo = MF.getSubtarget().getRegisterInfo();
225 
226   const MachineFrameInfo &MFI = MF.getFrameInfo();
227   return MF.getTarget().Options.DisableFramePointerElim(MF) ||
228          RegInfo->hasStackRealignment(MF) || MFI.hasVarSizedObjects() ||
229          MFI.isFrameAddressTaken();
230 }
231 
232 bool RISCVFrameLowering::hasBP(const MachineFunction &MF) const {
233   const MachineFrameInfo &MFI = MF.getFrameInfo();
234   const TargetRegisterInfo *TRI = STI.getRegisterInfo();
235 
236   return MFI.hasVarSizedObjects() && TRI->hasStackRealignment(MF);
237 }
238 
239 // Determines the size of the frame and maximum call frame size.
240 void RISCVFrameLowering::determineFrameLayout(MachineFunction &MF) const {
241   MachineFrameInfo &MFI = MF.getFrameInfo();
242 
243   // Get the number of bytes to allocate from the FrameInfo.
244   uint64_t FrameSize = MFI.getStackSize();
245 
246   // Get the alignment.
247   Align StackAlign = getStackAlign();
248 
249   // Make sure the frame is aligned.
250   FrameSize = alignTo(FrameSize, StackAlign);
251 
252   // Update frame info.
253   MFI.setStackSize(FrameSize);
254 }
255 
256 void RISCVFrameLowering::adjustReg(MachineBasicBlock &MBB,
257                                    MachineBasicBlock::iterator MBBI,
258                                    const DebugLoc &DL, Register DestReg,
259                                    Register SrcReg, int64_t Val,
260                                    MachineInstr::MIFlag Flag) const {
261   MachineRegisterInfo &MRI = MBB.getParent()->getRegInfo();
262   const RISCVInstrInfo *TII = STI.getInstrInfo();
263 
264   if (DestReg == SrcReg && Val == 0)
265     return;
266 
267   if (isInt<12>(Val)) {
268     BuildMI(MBB, MBBI, DL, TII->get(RISCV::ADDI), DestReg)
269         .addReg(SrcReg)
270         .addImm(Val)
271         .setMIFlag(Flag);
272   } else {
273     unsigned Opc = RISCV::ADD;
274     bool isSub = Val < 0;
275     if (isSub) {
276       Val = -Val;
277       Opc = RISCV::SUB;
278     }
279 
280     Register ScratchReg = MRI.createVirtualRegister(&RISCV::GPRRegClass);
281     TII->movImm(MBB, MBBI, DL, ScratchReg, Val, Flag);
282     BuildMI(MBB, MBBI, DL, TII->get(Opc), DestReg)
283         .addReg(SrcReg)
284         .addReg(ScratchReg, RegState::Kill)
285         .setMIFlag(Flag);
286   }
287 }
288 
289 // Returns the register used to hold the frame pointer.
290 static Register getFPReg(const RISCVSubtarget &STI) { return RISCV::X8; }
291 
292 // Returns the register used to hold the stack pointer.
293 static Register getSPReg(const RISCVSubtarget &STI) { return RISCV::X2; }
294 
295 static SmallVector<CalleeSavedInfo, 8>
296 getNonLibcallCSI(const MachineFunction &MF,
297                  const std::vector<CalleeSavedInfo> &CSI) {
298   const MachineFrameInfo &MFI = MF.getFrameInfo();
299   SmallVector<CalleeSavedInfo, 8> NonLibcallCSI;
300 
301   for (auto &CS : CSI) {
302     int FI = CS.getFrameIdx();
303     if (FI >= 0 && MFI.getStackID(FI) == TargetStackID::Default)
304       NonLibcallCSI.push_back(CS);
305   }
306 
307   return NonLibcallCSI;
308 }
309 
310 void RISCVFrameLowering::adjustStackForRVV(MachineFunction &MF,
311                                            MachineBasicBlock &MBB,
312                                            MachineBasicBlock::iterator MBBI,
313                                            const DebugLoc &DL, int64_t Amount,
314                                            MachineInstr::MIFlag Flag) const {
315   assert(Amount != 0 && "Did not need to adjust stack pointer for RVV.");
316 
317   const RISCVInstrInfo *TII = STI.getInstrInfo();
318   Register SPReg = getSPReg(STI);
319   unsigned Opc = RISCV::ADD;
320   if (Amount < 0) {
321     Amount = -Amount;
322     Opc = RISCV::SUB;
323   }
324   // 1. Multiply the number of v-slots to the length of registers
325   Register FactorRegister =
326       TII->getVLENFactoredAmount(MF, MBB, MBBI, DL, Amount, Flag);
327   // 2. SP = SP - RVV stack size
328   BuildMI(MBB, MBBI, DL, TII->get(Opc), SPReg)
329       .addReg(SPReg)
330       .addReg(FactorRegister, RegState::Kill)
331       .setMIFlag(Flag);
332 }
333 
334 void RISCVFrameLowering::emitPrologue(MachineFunction &MF,
335                                       MachineBasicBlock &MBB) const {
336   MachineFrameInfo &MFI = MF.getFrameInfo();
337   auto *RVFI = MF.getInfo<RISCVMachineFunctionInfo>();
338   const RISCVRegisterInfo *RI = STI.getRegisterInfo();
339   const RISCVInstrInfo *TII = STI.getInstrInfo();
340   MachineBasicBlock::iterator MBBI = MBB.begin();
341 
342   Register FPReg = getFPReg(STI);
343   Register SPReg = getSPReg(STI);
344   Register BPReg = RISCVABI::getBPReg();
345 
346   // Debug location must be unknown since the first debug location is used
347   // to determine the end of the prologue.
348   DebugLoc DL;
349 
350   // All calls are tail calls in GHC calling conv, and functions have no
351   // prologue/epilogue.
352   if (MF.getFunction().getCallingConv() == CallingConv::GHC)
353     return;
354 
355   // Emit prologue for shadow call stack.
356   emitSCSPrologue(MF, MBB, MBBI, DL);
357 
358   // Since spillCalleeSavedRegisters may have inserted a libcall, skip past
359   // any instructions marked as FrameSetup
360   while (MBBI != MBB.end() && MBBI->getFlag(MachineInstr::FrameSetup))
361     ++MBBI;
362 
363   // Determine the correct frame layout
364   determineFrameLayout(MF);
365 
366   // If libcalls are used to spill and restore callee-saved registers, the frame
367   // has two sections; the opaque section managed by the libcalls, and the
368   // section managed by MachineFrameInfo which can also hold callee saved
369   // registers in fixed stack slots, both of which have negative frame indices.
370   // This gets even more complicated when incoming arguments are passed via the
371   // stack, as these too have negative frame indices. An example is detailed
372   // below:
373   //
374   //  | incoming arg | <- FI[-3]
375   //  | libcallspill |
376   //  | calleespill  | <- FI[-2]
377   //  | calleespill  | <- FI[-1]
378   //  | this_frame   | <- FI[0]
379   //
380   // For negative frame indices, the offset from the frame pointer will differ
381   // depending on which of these groups the frame index applies to.
382   // The following calculates the correct offset knowing the number of callee
383   // saved registers spilt by the two methods.
384   if (int LibCallRegs = getLibCallID(MF, MFI.getCalleeSavedInfo()) + 1) {
385     // Calculate the size of the frame managed by the libcall. The libcalls are
386     // implemented such that the stack will always be 16 byte aligned.
387     unsigned LibCallFrameSize = alignTo((STI.getXLen() / 8) * LibCallRegs, 16);
388     RVFI->setLibCallStackSize(LibCallFrameSize);
389   }
390 
391   // FIXME (note copied from Lanai): This appears to be overallocating.  Needs
392   // investigation. Get the number of bytes to allocate from the FrameInfo.
393   uint64_t StackSize = MFI.getStackSize() + RVFI->getRVVPadding();
394   uint64_t RealStackSize = StackSize + RVFI->getLibCallStackSize();
395   uint64_t RVVStackSize = RVFI->getRVVStackSize();
396 
397   // Early exit if there is no need to allocate on the stack
398   if (RealStackSize == 0 && !MFI.adjustsStack() && RVVStackSize == 0)
399     return;
400 
401   // If the stack pointer has been marked as reserved, then produce an error if
402   // the frame requires stack allocation
403   if (STI.isRegisterReservedByUser(SPReg))
404     MF.getFunction().getContext().diagnose(DiagnosticInfoUnsupported{
405         MF.getFunction(), "Stack pointer required, but has been reserved."});
406 
407   uint64_t FirstSPAdjustAmount = getFirstSPAdjustAmount(MF);
408   // Split the SP adjustment to reduce the offsets of callee saved spill.
409   if (FirstSPAdjustAmount) {
410     StackSize = FirstSPAdjustAmount;
411     RealStackSize = FirstSPAdjustAmount;
412   }
413 
414   // Allocate space on the stack if necessary.
415   adjustReg(MBB, MBBI, DL, SPReg, SPReg, -StackSize, MachineInstr::FrameSetup);
416 
417   // Emit ".cfi_def_cfa_offset RealStackSize"
418   unsigned CFIIndex = MF.addFrameInst(
419       MCCFIInstruction::cfiDefCfaOffset(nullptr, RealStackSize));
420   BuildMI(MBB, MBBI, DL, TII->get(TargetOpcode::CFI_INSTRUCTION))
421       .addCFIIndex(CFIIndex)
422       .setMIFlag(MachineInstr::FrameSetup);
423 
424   const auto &CSI = MFI.getCalleeSavedInfo();
425 
426   // The frame pointer is callee-saved, and code has been generated for us to
427   // save it to the stack. We need to skip over the storing of callee-saved
428   // registers as the frame pointer must be modified after it has been saved
429   // to the stack, not before.
430   // FIXME: assumes exactly one instruction is used to save each callee-saved
431   // register.
432   std::advance(MBBI, getNonLibcallCSI(MF, CSI).size());
433 
434   // Iterate over list of callee-saved registers and emit .cfi_offset
435   // directives.
436   for (const auto &Entry : CSI) {
437     int FrameIdx = Entry.getFrameIdx();
438     int64_t Offset;
439     // Offsets for objects with fixed locations (IE: those saved by libcall) are
440     // simply calculated from the frame index.
441     if (FrameIdx < 0)
442       Offset = FrameIdx * (int64_t) STI.getXLen() / 8;
443     else
444       Offset = MFI.getObjectOffset(Entry.getFrameIdx()) -
445                RVFI->getLibCallStackSize();
446     Register Reg = Entry.getReg();
447     unsigned CFIIndex = MF.addFrameInst(MCCFIInstruction::createOffset(
448         nullptr, RI->getDwarfRegNum(Reg, true), Offset));
449     BuildMI(MBB, MBBI, DL, TII->get(TargetOpcode::CFI_INSTRUCTION))
450         .addCFIIndex(CFIIndex)
451         .setMIFlag(MachineInstr::FrameSetup);
452   }
453 
454   // Generate new FP.
455   if (hasFP(MF)) {
456     if (STI.isRegisterReservedByUser(FPReg))
457       MF.getFunction().getContext().diagnose(DiagnosticInfoUnsupported{
458           MF.getFunction(), "Frame pointer required, but has been reserved."});
459 
460     adjustReg(MBB, MBBI, DL, FPReg, SPReg,
461               RealStackSize - RVFI->getVarArgsSaveSize(),
462               MachineInstr::FrameSetup);
463 
464     // Emit ".cfi_def_cfa $fp, RVFI->getVarArgsSaveSize()"
465     unsigned CFIIndex = MF.addFrameInst(MCCFIInstruction::cfiDefCfa(
466         nullptr, RI->getDwarfRegNum(FPReg, true), RVFI->getVarArgsSaveSize()));
467     BuildMI(MBB, MBBI, DL, TII->get(TargetOpcode::CFI_INSTRUCTION))
468         .addCFIIndex(CFIIndex)
469         .setMIFlag(MachineInstr::FrameSetup);
470   }
471 
472   // Emit the second SP adjustment after saving callee saved registers.
473   if (FirstSPAdjustAmount) {
474     uint64_t SecondSPAdjustAmount = MFI.getStackSize() - FirstSPAdjustAmount;
475     assert(SecondSPAdjustAmount > 0 &&
476            "SecondSPAdjustAmount should be greater than zero");
477     adjustReg(MBB, MBBI, DL, SPReg, SPReg, -SecondSPAdjustAmount,
478               MachineInstr::FrameSetup);
479 
480     // If we are using a frame-pointer, and thus emitted ".cfi_def_cfa fp, 0",
481     // don't emit an sp-based .cfi_def_cfa_offset
482     if (!hasFP(MF)) {
483       // Emit ".cfi_def_cfa_offset StackSize"
484       unsigned CFIIndex = MF.addFrameInst(
485           MCCFIInstruction::cfiDefCfaOffset(nullptr, MFI.getStackSize()));
486       BuildMI(MBB, MBBI, DL, TII->get(TargetOpcode::CFI_INSTRUCTION))
487           .addCFIIndex(CFIIndex)
488           .setMIFlag(MachineInstr::FrameSetup);
489     }
490   }
491 
492   if (RVVStackSize)
493     adjustStackForRVV(MF, MBB, MBBI, DL, -RVVStackSize,
494                       MachineInstr::FrameSetup);
495 
496   if (hasFP(MF)) {
497     // Realign Stack
498     const RISCVRegisterInfo *RI = STI.getRegisterInfo();
499     if (RI->hasStackRealignment(MF)) {
500       Align MaxAlignment = MFI.getMaxAlign();
501 
502       const RISCVInstrInfo *TII = STI.getInstrInfo();
503       if (isInt<12>(-(int)MaxAlignment.value())) {
504         BuildMI(MBB, MBBI, DL, TII->get(RISCV::ANDI), SPReg)
505             .addReg(SPReg)
506             .addImm(-(int)MaxAlignment.value())
507             .setMIFlag(MachineInstr::FrameSetup);
508       } else {
509         unsigned ShiftAmount = Log2(MaxAlignment);
510         Register VR =
511             MF.getRegInfo().createVirtualRegister(&RISCV::GPRRegClass);
512         BuildMI(MBB, MBBI, DL, TII->get(RISCV::SRLI), VR)
513             .addReg(SPReg)
514             .addImm(ShiftAmount)
515             .setMIFlag(MachineInstr::FrameSetup);
516         BuildMI(MBB, MBBI, DL, TII->get(RISCV::SLLI), SPReg)
517             .addReg(VR)
518             .addImm(ShiftAmount)
519             .setMIFlag(MachineInstr::FrameSetup);
520       }
521       // FP will be used to restore the frame in the epilogue, so we need
522       // another base register BP to record SP after re-alignment. SP will
523       // track the current stack after allocating variable sized objects.
524       if (hasBP(MF)) {
525         // move BP, SP
526         BuildMI(MBB, MBBI, DL, TII->get(RISCV::ADDI), BPReg)
527             .addReg(SPReg)
528             .addImm(0)
529             .setMIFlag(MachineInstr::FrameSetup);
530       }
531     }
532   }
533 }
534 
535 void RISCVFrameLowering::emitEpilogue(MachineFunction &MF,
536                                       MachineBasicBlock &MBB) const {
537   const RISCVRegisterInfo *RI = STI.getRegisterInfo();
538   MachineFrameInfo &MFI = MF.getFrameInfo();
539   auto *RVFI = MF.getInfo<RISCVMachineFunctionInfo>();
540   Register FPReg = getFPReg(STI);
541   Register SPReg = getSPReg(STI);
542 
543   // All calls are tail calls in GHC calling conv, and functions have no
544   // prologue/epilogue.
545   if (MF.getFunction().getCallingConv() == CallingConv::GHC)
546     return;
547 
548   // Get the insert location for the epilogue. If there were no terminators in
549   // the block, get the last instruction.
550   MachineBasicBlock::iterator MBBI = MBB.end();
551   DebugLoc DL;
552   if (!MBB.empty()) {
553     MBBI = MBB.getFirstTerminator();
554     if (MBBI == MBB.end())
555       MBBI = MBB.getLastNonDebugInstr();
556     DL = MBBI->getDebugLoc();
557 
558     // If this is not a terminator, the actual insert location should be after the
559     // last instruction.
560     if (!MBBI->isTerminator())
561       MBBI = std::next(MBBI);
562 
563     // If callee-saved registers are saved via libcall, place stack adjustment
564     // before this call.
565     while (MBBI != MBB.begin() &&
566            std::prev(MBBI)->getFlag(MachineInstr::FrameDestroy))
567       --MBBI;
568   }
569 
570   const auto &CSI = getNonLibcallCSI(MF, MFI.getCalleeSavedInfo());
571 
572   // Skip to before the restores of callee-saved registers
573   // FIXME: assumes exactly one instruction is used to restore each
574   // callee-saved register.
575   auto LastFrameDestroy = MBBI;
576   if (!CSI.empty())
577     LastFrameDestroy = std::prev(MBBI, CSI.size());
578 
579   uint64_t StackSize = MFI.getStackSize() + RVFI->getRVVPadding();
580   uint64_t RealStackSize = StackSize + RVFI->getLibCallStackSize();
581   uint64_t FPOffset = RealStackSize - RVFI->getVarArgsSaveSize();
582   uint64_t RVVStackSize = RVFI->getRVVStackSize();
583 
584   // Restore the stack pointer using the value of the frame pointer. Only
585   // necessary if the stack pointer was modified, meaning the stack size is
586   // unknown.
587   if (RI->hasStackRealignment(MF) || MFI.hasVarSizedObjects()) {
588     assert(hasFP(MF) && "frame pointer should not have been eliminated");
589     adjustReg(MBB, LastFrameDestroy, DL, SPReg, FPReg, -FPOffset,
590               MachineInstr::FrameDestroy);
591   } else {
592     if (RVVStackSize)
593       adjustStackForRVV(MF, MBB, LastFrameDestroy, DL, RVVStackSize,
594                         MachineInstr::FrameDestroy);
595   }
596 
597   uint64_t FirstSPAdjustAmount = getFirstSPAdjustAmount(MF);
598   if (FirstSPAdjustAmount) {
599     uint64_t SecondSPAdjustAmount = MFI.getStackSize() - FirstSPAdjustAmount;
600     assert(SecondSPAdjustAmount > 0 &&
601            "SecondSPAdjustAmount should be greater than zero");
602 
603     adjustReg(MBB, LastFrameDestroy, DL, SPReg, SPReg, SecondSPAdjustAmount,
604               MachineInstr::FrameDestroy);
605   }
606 
607   if (FirstSPAdjustAmount)
608     StackSize = FirstSPAdjustAmount;
609 
610   // Deallocate stack
611   adjustReg(MBB, MBBI, DL, SPReg, SPReg, StackSize, MachineInstr::FrameDestroy);
612 
613   // Emit epilogue for shadow call stack.
614   emitSCSEpilogue(MF, MBB, MBBI, DL);
615 }
616 
617 StackOffset
618 RISCVFrameLowering::getFrameIndexReference(const MachineFunction &MF, int FI,
619                                            Register &FrameReg) const {
620   const MachineFrameInfo &MFI = MF.getFrameInfo();
621   const TargetRegisterInfo *RI = MF.getSubtarget().getRegisterInfo();
622   const auto *RVFI = MF.getInfo<RISCVMachineFunctionInfo>();
623 
624   // Callee-saved registers should be referenced relative to the stack
625   // pointer (positive offset), otherwise use the frame pointer (negative
626   // offset).
627   const auto &CSI = getNonLibcallCSI(MF, MFI.getCalleeSavedInfo());
628   int MinCSFI = 0;
629   int MaxCSFI = -1;
630   StackOffset Offset;
631   auto StackID = MFI.getStackID(FI);
632 
633   assert((StackID == TargetStackID::Default ||
634           StackID == TargetStackID::ScalableVector) &&
635          "Unexpected stack ID for the frame object.");
636   if (StackID == TargetStackID::Default) {
637     Offset =
638         StackOffset::getFixed(MFI.getObjectOffset(FI) - getOffsetOfLocalArea() +
639                               MFI.getOffsetAdjustment());
640   } else if (StackID == TargetStackID::ScalableVector) {
641     Offset = StackOffset::getScalable(MFI.getObjectOffset(FI));
642   }
643 
644   uint64_t FirstSPAdjustAmount = getFirstSPAdjustAmount(MF);
645 
646   if (CSI.size()) {
647     MinCSFI = CSI[0].getFrameIdx();
648     MaxCSFI = CSI[CSI.size() - 1].getFrameIdx();
649   }
650 
651   if (FI >= MinCSFI && FI <= MaxCSFI) {
652     FrameReg = RISCV::X2;
653 
654     if (FirstSPAdjustAmount)
655       Offset += StackOffset::getFixed(FirstSPAdjustAmount);
656     else
657       Offset +=
658           StackOffset::getFixed(MFI.getStackSize() + RVFI->getRVVPadding());
659   } else if (RI->hasStackRealignment(MF) && !MFI.isFixedObjectIndex(FI)) {
660     // If the stack was realigned, the frame pointer is set in order to allow
661     // SP to be restored, so we need another base register to record the stack
662     // after realignment.
663     if (hasBP(MF)) {
664       FrameReg = RISCVABI::getBPReg();
665       // |--------------------------| -- <-- FP
666       // | callee-saved registers   | | <----.
667       // |--------------------------| --     |
668       // | realignment (the size of | |      |
669       // | this area is not counted | |      |
670       // | in MFI.getStackSize())   | |      |
671       // |--------------------------| --     |
672       // | Padding after RVV        | |      |
673       // | (not counted in          | |      |
674       // | MFI.getStackSize())      | |      |
675       // |--------------------------| --     |-- MFI.getStackSize()
676       // | RVV objects              | |      |
677       // | (not counted in          | |      |
678       // | MFI.getStackSize())      | |      |
679       // |--------------------------| --     |
680       // | Padding before RVV       | |      |
681       // | (not counted in          | |      |
682       // | MFI.getStackSize())      | |      |
683       // |--------------------------| --     |
684       // | scalar local variables   | | <----'
685       // |--------------------------| -- <-- BP
686       // | VarSize objects          | |
687       // |--------------------------| -- <-- SP
688     } else {
689       FrameReg = RISCV::X2;
690       // |--------------------------| -- <-- FP
691       // | callee-saved registers   | | <----.
692       // |--------------------------| --     |
693       // | realignment (the size of | |      |
694       // | this area is not counted | |      |
695       // | in MFI.getStackSize())   | |      |
696       // |--------------------------| --     |
697       // | Padding after RVV        | |      |
698       // | (not counted in          | |      |
699       // | MFI.getStackSize())      | |      |
700       // |--------------------------| --     |-- MFI.getStackSize()
701       // | RVV objects              | |      |
702       // | (not counted in          | |      |
703       // | MFI.getStackSize())      | |      |
704       // |--------------------------| --     |
705       // | Padding before RVV       | |      |
706       // | (not counted in          | |      |
707       // | MFI.getStackSize())      | |      |
708       // |--------------------------| --     |
709       // | scalar local variables   | | <----'
710       // |--------------------------| -- <-- SP
711     }
712     // The total amount of padding surrounding RVV objects is described by
713     // RVV->getRVVPadding() and it can be zero. It allows us to align the RVV
714     // objects to 8 bytes.
715     if (MFI.getStackID(FI) == TargetStackID::Default) {
716       Offset += StackOffset::getFixed(MFI.getStackSize());
717       if (FI < 0)
718         Offset += StackOffset::getFixed(RVFI->getLibCallStackSize());
719     } else if (MFI.getStackID(FI) == TargetStackID::ScalableVector) {
720       Offset += StackOffset::get(
721           alignTo(MFI.getStackSize() - RVFI->getCalleeSavedStackSize(), 8),
722           RVFI->getRVVStackSize());
723     }
724   } else {
725     FrameReg = RI->getFrameRegister(MF);
726     if (hasFP(MF)) {
727       Offset += StackOffset::getFixed(RVFI->getVarArgsSaveSize());
728       if (FI >= 0)
729         Offset -= StackOffset::getFixed(RVFI->getLibCallStackSize());
730       // When using FP to access scalable vector objects, we need to minus
731       // the frame size.
732       //
733       // |--------------------------| -- <-- FP
734       // | callee-saved registers   | |
735       // |--------------------------| | MFI.getStackSize()
736       // | scalar local variables   | |
737       // |--------------------------| -- (Offset of RVV objects is from here.)
738       // | RVV objects              |
739       // |--------------------------|
740       // | VarSize objects          |
741       // |--------------------------| <-- SP
742       if (MFI.getStackID(FI) == TargetStackID::ScalableVector)
743         Offset -= StackOffset::getFixed(MFI.getStackSize());
744     } else {
745       // When using SP to access frame objects, we need to add RVV stack size.
746       //
747       // |--------------------------| -- <-- FP
748       // | callee-saved registers   | | <----.
749       // |--------------------------| --     |
750       // | Padding after RVV        | |      |
751       // | (not counted in          | |      |
752       // | MFI.getStackSize())      | |      |
753       // |--------------------------| --     |
754       // | RVV objects              | |      |-- MFI.getStackSize()
755       // | (not counted in          | |      |
756       // | MFI.getStackSize())      | |      |
757       // |--------------------------| --     |
758       // | Padding before RVV       | |      |
759       // | (not counted in          | |      |
760       // | MFI.getStackSize())      | |      |
761       // |--------------------------| --     |
762       // | scalar local variables   | | <----'
763       // |--------------------------| -- <-- SP
764       //
765       // The total amount of padding surrounding RVV objects is described by
766       // RVV->getRVVPadding() and it can be zero. It allows us to align the RVV
767       // objects to 8 bytes.
768       if (MFI.getStackID(FI) == TargetStackID::Default) {
769         if (MFI.isFixedObjectIndex(FI)) {
770           Offset +=
771               StackOffset::get(MFI.getStackSize() + RVFI->getRVVPadding() +
772                                    RVFI->getLibCallStackSize(),
773                                RVFI->getRVVStackSize());
774         } else {
775           Offset += StackOffset::getFixed(MFI.getStackSize());
776         }
777       } else if (MFI.getStackID(FI) == TargetStackID::ScalableVector) {
778         Offset += StackOffset::get(
779             alignTo(MFI.getStackSize() - RVFI->getCalleeSavedStackSize(), 8),
780             RVFI->getRVVStackSize());
781       }
782     }
783   }
784 
785   return Offset;
786 }
787 
788 void RISCVFrameLowering::determineCalleeSaves(MachineFunction &MF,
789                                               BitVector &SavedRegs,
790                                               RegScavenger *RS) const {
791   TargetFrameLowering::determineCalleeSaves(MF, SavedRegs, RS);
792   // Unconditionally spill RA and FP only if the function uses a frame
793   // pointer.
794   if (hasFP(MF)) {
795     SavedRegs.set(RISCV::X1);
796     SavedRegs.set(RISCV::X8);
797   }
798   // Mark BP as used if function has dedicated base pointer.
799   if (hasBP(MF))
800     SavedRegs.set(RISCVABI::getBPReg());
801 
802   // If interrupt is enabled and there are calls in the handler,
803   // unconditionally save all Caller-saved registers and
804   // all FP registers, regardless whether they are used.
805   MachineFrameInfo &MFI = MF.getFrameInfo();
806 
807   if (MF.getFunction().hasFnAttribute("interrupt") && MFI.hasCalls()) {
808 
809     static const MCPhysReg CSRegs[] = { RISCV::X1,      /* ra */
810       RISCV::X5, RISCV::X6, RISCV::X7,                  /* t0-t2 */
811       RISCV::X10, RISCV::X11,                           /* a0-a1, a2-a7 */
812       RISCV::X12, RISCV::X13, RISCV::X14, RISCV::X15, RISCV::X16, RISCV::X17,
813       RISCV::X28, RISCV::X29, RISCV::X30, RISCV::X31, 0 /* t3-t6 */
814     };
815 
816     for (unsigned i = 0; CSRegs[i]; ++i)
817       SavedRegs.set(CSRegs[i]);
818 
819     if (MF.getSubtarget<RISCVSubtarget>().hasStdExtF()) {
820 
821       // If interrupt is enabled, this list contains all FP registers.
822       const MCPhysReg * Regs = MF.getRegInfo().getCalleeSavedRegs();
823 
824       for (unsigned i = 0; Regs[i]; ++i)
825         if (RISCV::FPR16RegClass.contains(Regs[i]) ||
826             RISCV::FPR32RegClass.contains(Regs[i]) ||
827             RISCV::FPR64RegClass.contains(Regs[i]))
828           SavedRegs.set(Regs[i]);
829     }
830   }
831 }
832 
833 int64_t
834 RISCVFrameLowering::assignRVVStackObjectOffsets(MachineFrameInfo &MFI) const {
835   int64_t Offset = 0;
836   // Create a buffer of RVV objects to allocate.
837   SmallVector<int, 8> ObjectsToAllocate;
838   for (int I = 0, E = MFI.getObjectIndexEnd(); I != E; ++I) {
839     unsigned StackID = MFI.getStackID(I);
840     if (StackID != TargetStackID::ScalableVector)
841       continue;
842     if (MFI.isDeadObjectIndex(I))
843       continue;
844 
845     ObjectsToAllocate.push_back(I);
846   }
847 
848   // Allocate all RVV locals and spills
849   for (int FI : ObjectsToAllocate) {
850     // ObjectSize in bytes.
851     int64_t ObjectSize = MFI.getObjectSize(FI);
852     // If the data type is the fractional vector type, reserve one vector
853     // register for it.
854     if (ObjectSize < 8)
855       ObjectSize = 8;
856     // Currently, all scalable vector types are aligned to 8 bytes.
857     Offset = alignTo(Offset + ObjectSize, 8);
858     MFI.setObjectOffset(FI, -Offset);
859   }
860 
861   return Offset;
862 }
863 
864 static bool hasRVVSpillWithFIs(MachineFunction &MF, const RISCVInstrInfo &TII) {
865   if (!MF.getSubtarget<RISCVSubtarget>().hasStdExtV())
866     return false;
867   return any_of(MF, [&TII](const MachineBasicBlock &MBB) {
868     return any_of(MBB, [&TII](const MachineInstr &MI) {
869       return TII.isRVVSpill(MI, /*CheckFIs*/ true);
870     });
871   });
872 }
873 
874 void RISCVFrameLowering::processFunctionBeforeFrameFinalized(
875     MachineFunction &MF, RegScavenger *RS) const {
876   const RISCVRegisterInfo *RegInfo =
877       MF.getSubtarget<RISCVSubtarget>().getRegisterInfo();
878   MachineFrameInfo &MFI = MF.getFrameInfo();
879   const TargetRegisterClass *RC = &RISCV::GPRRegClass;
880   auto *RVFI = MF.getInfo<RISCVMachineFunctionInfo>();
881 
882   int64_t RVVStackSize = assignRVVStackObjectOffsets(MFI);
883   RVFI->setRVVStackSize(RVVStackSize);
884   const RISCVInstrInfo &TII = *MF.getSubtarget<RISCVSubtarget>().getInstrInfo();
885 
886   // estimateStackSize has been observed to under-estimate the final stack
887   // size, so give ourselves wiggle-room by checking for stack size
888   // representable an 11-bit signed field rather than 12-bits.
889   // FIXME: It may be possible to craft a function with a small stack that
890   // still needs an emergency spill slot for branch relaxation. This case
891   // would currently be missed.
892   // RVV loads & stores have no capacity to hold the immediate address offsets
893   // so we must always reserve an emergency spill slot if the MachineFunction
894   // contains any RVV spills.
895   if (!isInt<11>(MFI.estimateStackSize(MF)) || hasRVVSpillWithFIs(MF, TII)) {
896     int RegScavFI = MFI.CreateStackObject(RegInfo->getSpillSize(*RC),
897                                           RegInfo->getSpillAlign(*RC), false);
898     RS->addScavengingFrameIndex(RegScavFI);
899     // For RVV, scalable stack offsets require up to two scratch registers to
900     // compute the final offset. Reserve an additional emergency spill slot.
901     if (RVVStackSize != 0) {
902       int RVVRegScavFI = MFI.CreateStackObject(
903           RegInfo->getSpillSize(*RC), RegInfo->getSpillAlign(*RC), false);
904       RS->addScavengingFrameIndex(RVVRegScavFI);
905     }
906   }
907 
908   if (MFI.getCalleeSavedInfo().empty() || RVFI->useSaveRestoreLibCalls(MF)) {
909     RVFI->setCalleeSavedStackSize(0);
910     return;
911   }
912 
913   unsigned Size = 0;
914   for (const auto &Info : MFI.getCalleeSavedInfo()) {
915     int FrameIdx = Info.getFrameIdx();
916     if (MFI.getStackID(FrameIdx) != TargetStackID::Default)
917       continue;
918 
919     Size += MFI.getObjectSize(FrameIdx);
920   }
921   RVFI->setCalleeSavedStackSize(Size);
922 
923   // Padding required to keep the RVV stack aligned to 8 bytes
924   // within the main stack. We only need this when not using FP.
925   if (RVVStackSize && !hasFP(MF) && Size % 8 != 0) {
926     // Because we add the padding to the size of the stack, adding
927     // getStackAlign() will keep it aligned.
928     RVFI->setRVVPadding(getStackAlign().value());
929   }
930 }
931 
932 static bool hasRVVFrameObject(const MachineFunction &MF) {
933   const MachineFrameInfo &MFI = MF.getFrameInfo();
934   for (int I = 0, E = MFI.getObjectIndexEnd(); I != E; ++I)
935     if (MFI.getStackID(I) == TargetStackID::ScalableVector)
936       return true;
937   return false;
938 }
939 
940 // Not preserve stack space within prologue for outgoing variables when the
941 // function contains variable size objects or there are vector objects accessed
942 // by the frame pointer.
943 // Let eliminateCallFramePseudoInstr preserve stack space for it.
944 bool RISCVFrameLowering::hasReservedCallFrame(const MachineFunction &MF) const {
945   return !MF.getFrameInfo().hasVarSizedObjects() &&
946          !(hasFP(MF) && hasRVVFrameObject(MF));
947 }
948 
949 // Eliminate ADJCALLSTACKDOWN, ADJCALLSTACKUP pseudo instructions.
950 MachineBasicBlock::iterator RISCVFrameLowering::eliminateCallFramePseudoInstr(
951     MachineFunction &MF, MachineBasicBlock &MBB,
952     MachineBasicBlock::iterator MI) const {
953   Register SPReg = RISCV::X2;
954   DebugLoc DL = MI->getDebugLoc();
955 
956   if (!hasReservedCallFrame(MF)) {
957     // If space has not been reserved for a call frame, ADJCALLSTACKDOWN and
958     // ADJCALLSTACKUP must be converted to instructions manipulating the stack
959     // pointer. This is necessary when there is a variable length stack
960     // allocation (e.g. alloca), which means it's not possible to allocate
961     // space for outgoing arguments from within the function prologue.
962     int64_t Amount = MI->getOperand(0).getImm();
963 
964     if (Amount != 0) {
965       // Ensure the stack remains aligned after adjustment.
966       Amount = alignSPAdjust(Amount);
967 
968       if (MI->getOpcode() == RISCV::ADJCALLSTACKDOWN)
969         Amount = -Amount;
970 
971       adjustReg(MBB, MI, DL, SPReg, SPReg, Amount, MachineInstr::NoFlags);
972     }
973   }
974 
975   return MBB.erase(MI);
976 }
977 
978 // We would like to split the SP adjustment to reduce prologue/epilogue
979 // as following instructions. In this way, the offset of the callee saved
980 // register could fit in a single store.
981 //   add     sp,sp,-2032
982 //   sw      ra,2028(sp)
983 //   sw      s0,2024(sp)
984 //   sw      s1,2020(sp)
985 //   sw      s3,2012(sp)
986 //   sw      s4,2008(sp)
987 //   add     sp,sp,-64
988 uint64_t
989 RISCVFrameLowering::getFirstSPAdjustAmount(const MachineFunction &MF) const {
990   const auto *RVFI = MF.getInfo<RISCVMachineFunctionInfo>();
991   const MachineFrameInfo &MFI = MF.getFrameInfo();
992   const std::vector<CalleeSavedInfo> &CSI = MFI.getCalleeSavedInfo();
993   uint64_t StackSize = MFI.getStackSize();
994 
995   // Disable SplitSPAdjust if save-restore libcall used. The callee saved
996   // registers will be pushed by the save-restore libcalls, so we don't have to
997   // split the SP adjustment in this case.
998   if (RVFI->getLibCallStackSize())
999     return 0;
1000 
1001   // Return the FirstSPAdjustAmount if the StackSize can not fit in signed
1002   // 12-bit and there exists a callee saved register need to be pushed.
1003   if (!isInt<12>(StackSize) && (CSI.size() > 0)) {
1004     // FirstSPAdjustAmount is choosed as (2048 - StackAlign)
1005     // because 2048 will cause sp = sp + 2048 in epilogue split into
1006     // multi-instructions. The offset smaller than 2048 can fit in signle
1007     // load/store instruction and we have to stick with the stack alignment.
1008     // 2048 is 16-byte alignment. The stack alignment for RV32 and RV64 is 16,
1009     // for RV32E is 4. So (2048 - StackAlign) will satisfy the stack alignment.
1010     return 2048 - getStackAlign().value();
1011   }
1012   return 0;
1013 }
1014 
1015 bool RISCVFrameLowering::spillCalleeSavedRegisters(
1016     MachineBasicBlock &MBB, MachineBasicBlock::iterator MI,
1017     ArrayRef<CalleeSavedInfo> CSI, const TargetRegisterInfo *TRI) const {
1018   if (CSI.empty())
1019     return true;
1020 
1021   MachineFunction *MF = MBB.getParent();
1022   const TargetInstrInfo &TII = *MF->getSubtarget().getInstrInfo();
1023   DebugLoc DL;
1024   if (MI != MBB.end() && !MI->isDebugInstr())
1025     DL = MI->getDebugLoc();
1026 
1027   const char *SpillLibCall = getSpillLibCallName(*MF, CSI);
1028   if (SpillLibCall) {
1029     // Add spill libcall via non-callee-saved register t0.
1030     BuildMI(MBB, MI, DL, TII.get(RISCV::PseudoCALLReg), RISCV::X5)
1031         .addExternalSymbol(SpillLibCall, RISCVII::MO_CALL)
1032         .setMIFlag(MachineInstr::FrameSetup);
1033 
1034     // Add registers spilled in libcall as liveins.
1035     for (auto &CS : CSI)
1036       MBB.addLiveIn(CS.getReg());
1037   }
1038 
1039   // Manually spill values not spilled by libcall.
1040   const auto &NonLibcallCSI = getNonLibcallCSI(*MF, CSI);
1041   for (auto &CS : NonLibcallCSI) {
1042     // Insert the spill to the stack frame.
1043     Register Reg = CS.getReg();
1044     const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
1045     TII.storeRegToStackSlot(MBB, MI, Reg, true, CS.getFrameIdx(), RC, TRI);
1046   }
1047 
1048   return true;
1049 }
1050 
1051 bool RISCVFrameLowering::restoreCalleeSavedRegisters(
1052     MachineBasicBlock &MBB, MachineBasicBlock::iterator MI,
1053     MutableArrayRef<CalleeSavedInfo> CSI, const TargetRegisterInfo *TRI) const {
1054   if (CSI.empty())
1055     return true;
1056 
1057   MachineFunction *MF = MBB.getParent();
1058   const TargetInstrInfo &TII = *MF->getSubtarget().getInstrInfo();
1059   DebugLoc DL;
1060   if (MI != MBB.end() && !MI->isDebugInstr())
1061     DL = MI->getDebugLoc();
1062 
1063   // Manually restore values not restored by libcall. Insert in reverse order.
1064   // loadRegFromStackSlot can insert multiple instructions.
1065   const auto &NonLibcallCSI = getNonLibcallCSI(*MF, CSI);
1066   for (auto &CS : reverse(NonLibcallCSI)) {
1067     Register Reg = CS.getReg();
1068     const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
1069     TII.loadRegFromStackSlot(MBB, MI, Reg, CS.getFrameIdx(), RC, TRI);
1070     assert(MI != MBB.begin() && "loadRegFromStackSlot didn't insert any code!");
1071   }
1072 
1073   const char *RestoreLibCall = getRestoreLibCallName(*MF, CSI);
1074   if (RestoreLibCall) {
1075     // Add restore libcall via tail call.
1076     MachineBasicBlock::iterator NewMI =
1077         BuildMI(MBB, MI, DL, TII.get(RISCV::PseudoTAIL))
1078             .addExternalSymbol(RestoreLibCall, RISCVII::MO_CALL)
1079             .setMIFlag(MachineInstr::FrameDestroy);
1080 
1081     // Remove trailing returns, since the terminator is now a tail call to the
1082     // restore function.
1083     if (MI != MBB.end() && MI->getOpcode() == RISCV::PseudoRET) {
1084       NewMI->copyImplicitOps(*MF, *MI);
1085       MI->eraseFromParent();
1086     }
1087   }
1088 
1089   return true;
1090 }
1091 
1092 bool RISCVFrameLowering::enableShrinkWrapping(const MachineFunction &MF) const {
1093   // Keep the conventional code flow when not optimizing.
1094   if (MF.getFunction().hasOptNone())
1095     return false;
1096 
1097   return true;
1098 }
1099 
1100 bool RISCVFrameLowering::canUseAsPrologue(const MachineBasicBlock &MBB) const {
1101   MachineBasicBlock *TmpMBB = const_cast<MachineBasicBlock *>(&MBB);
1102   const MachineFunction *MF = MBB.getParent();
1103   const auto *RVFI = MF->getInfo<RISCVMachineFunctionInfo>();
1104 
1105   if (!RVFI->useSaveRestoreLibCalls(*MF))
1106     return true;
1107 
1108   // Inserting a call to a __riscv_save libcall requires the use of the register
1109   // t0 (X5) to hold the return address. Therefore if this register is already
1110   // used we can't insert the call.
1111 
1112   RegScavenger RS;
1113   RS.enterBasicBlock(*TmpMBB);
1114   return !RS.isRegUsed(RISCV::X5);
1115 }
1116 
1117 bool RISCVFrameLowering::canUseAsEpilogue(const MachineBasicBlock &MBB) const {
1118   const MachineFunction *MF = MBB.getParent();
1119   MachineBasicBlock *TmpMBB = const_cast<MachineBasicBlock *>(&MBB);
1120   const auto *RVFI = MF->getInfo<RISCVMachineFunctionInfo>();
1121 
1122   if (!RVFI->useSaveRestoreLibCalls(*MF))
1123     return true;
1124 
1125   // Using the __riscv_restore libcalls to restore CSRs requires a tail call.
1126   // This means if we still need to continue executing code within this function
1127   // the restore cannot take place in this basic block.
1128 
1129   if (MBB.succ_size() > 1)
1130     return false;
1131 
1132   MachineBasicBlock *SuccMBB =
1133       MBB.succ_empty() ? TmpMBB->getFallThrough() : *MBB.succ_begin();
1134 
1135   // Doing a tail call should be safe if there are no successors, because either
1136   // we have a returning block or the end of the block is unreachable, so the
1137   // restore will be eliminated regardless.
1138   if (!SuccMBB)
1139     return true;
1140 
1141   // The successor can only contain a return, since we would effectively be
1142   // replacing the successor with our own tail return at the end of our block.
1143   return SuccMBB->isReturnBlock() && SuccMBB->size() == 1;
1144 }
1145 
1146 bool RISCVFrameLowering::isSupportedStackID(TargetStackID::Value ID) const {
1147   switch (ID) {
1148   case TargetStackID::Default:
1149   case TargetStackID::ScalableVector:
1150     return true;
1151   case TargetStackID::NoAlloc:
1152   case TargetStackID::SGPRSpill:
1153   case TargetStackID::WasmLocal:
1154     return false;
1155   }
1156   llvm_unreachable("Invalid TargetStackID::Value");
1157 }
1158 
1159 TargetStackID::Value RISCVFrameLowering::getStackIDForScalableVectors() const {
1160   return TargetStackID::ScalableVector;
1161 }
1162