1 //===-- WebAssemblyFrameLowering.cpp - WebAssembly Frame Lowering ----------==//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 ///
10 /// \file
11 /// This file contains the WebAssembly implementation of
12 /// TargetFrameLowering class.
13 ///
14 /// On WebAssembly, there aren't a lot of things to do here. There are no
15 /// callee-saved registers to save, and no spill slots.
16 ///
17 /// The stack grows downward.
18 ///
19 //===----------------------------------------------------------------------===//
20 
21 #include "WebAssemblyFrameLowering.h"
22 #include "MCTargetDesc/WebAssemblyMCTargetDesc.h"
23 #include "WebAssemblyInstrInfo.h"
24 #include "WebAssemblyMachineFunctionInfo.h"
25 #include "WebAssemblySubtarget.h"
26 #include "WebAssemblyTargetMachine.h"
27 #include "WebAssemblyUtilities.h"
28 #include "llvm/CodeGen/MachineFrameInfo.h"
29 #include "llvm/CodeGen/MachineFunction.h"
30 #include "llvm/CodeGen/MachineInstrBuilder.h"
31 #include "llvm/CodeGen/MachineModuleInfoImpls.h"
32 #include "llvm/CodeGen/MachineRegisterInfo.h"
33 #include "llvm/MC/MCAsmInfo.h"
34 #include "llvm/Support/Debug.h"
35 using namespace llvm;
36 
37 #define DEBUG_TYPE "wasm-frame-info"
38 
39 // TODO: wasm64
40 // TODO: Emit TargetOpcode::CFI_INSTRUCTION instructions
41 
42 /// We need a base pointer in the case of having items on the stack that
43 /// require stricter alignment than the stack pointer itself.  Because we need
44 /// to shift the stack pointer by some unknown amount to force the alignment,
45 /// we need to record the value of the stack pointer on entry to the function.
46 bool WebAssemblyFrameLowering::hasBP(
47     const MachineFunction &MF) const {
48   const auto *RegInfo =
49       MF.getSubtarget<WebAssemblySubtarget>().getRegisterInfo();
50   return RegInfo->needsStackRealignment(MF);
51 }
52 
53 /// Return true if the specified function should have a dedicated frame pointer
54 /// register.
55 bool WebAssemblyFrameLowering::hasFP(const MachineFunction &MF) const {
56   const MachineFrameInfo &MFI = MF.getFrameInfo();
57 
58   // When we have var-sized objects, we move the stack pointer by an unknown
59   // amount, and need to emit a frame pointer to restore the stack to where we
60   // were on function entry.
61   // If we already need a base pointer, we use that to fix up the stack pointer.
62   // If there are no fixed-size objects, we would have no use of a frame
63   // pointer, and thus should not emit one.
64   bool HasFixedSizedObjects = MFI.getStackSize() > 0;
65   bool NeedsFixedReference = !hasBP(MF) || HasFixedSizedObjects;
66 
67   return MFI.isFrameAddressTaken() ||
68          (MFI.hasVarSizedObjects() && NeedsFixedReference) ||
69          MFI.hasStackMap() || MFI.hasPatchPoint();
70 }
71 
72 /// Under normal circumstances, when a frame pointer is not required, we reserve
73 /// argument space for call sites in the function immediately on entry to the
74 /// current function. This eliminates the need for add/sub sp brackets around
75 /// call sites. Returns true if the call frame is included as part of the stack
76 /// frame.
77 bool WebAssemblyFrameLowering::hasReservedCallFrame(
78     const MachineFunction &MF) const {
79   return !MF.getFrameInfo().hasVarSizedObjects();
80 }
81 
82 // In function with EH pads, we need to make a copy of the value of
83 // __stack_pointer global in SP32 register, in order to use it when restoring
84 // __stack_pointer after an exception is caught.
85 bool WebAssemblyFrameLowering::needsPrologForEH(
86     const MachineFunction &MF) const {
87   auto EHType = MF.getTarget().getMCAsmInfo()->getExceptionHandlingType();
88   return EHType == ExceptionHandling::Wasm &&
89          MF.getFunction().hasPersonalityFn() && MF.getFrameInfo().hasCalls();
90 }
91 
92 /// Returns true if this function needs a local user-space stack pointer.
93 /// Unlike a machine stack pointer, the wasm user stack pointer is a global
94 /// variable, so it is loaded into a register in the prolog.
95 bool WebAssemblyFrameLowering::needsSP(const MachineFunction &MF,
96                                        const MachineFrameInfo &MFI) const {
97   return MFI.getStackSize() || MFI.adjustsStack() || hasFP(MF) ||
98          needsPrologForEH(MF);
99 }
100 
101 /// Returns true if the local user-space stack pointer needs to be written back
102 /// to memory by this function (this is not meaningful if needsSP is false). If
103 /// false, the stack red zone can be used and only a local SP is needed.
104 bool WebAssemblyFrameLowering::needsSPWriteback(
105     const MachineFunction &MF, const MachineFrameInfo &MFI) const {
106   assert(needsSP(MF, MFI));
107   return MFI.getStackSize() > RedZoneSize || MFI.hasCalls() ||
108          MF.getFunction().hasFnAttribute(Attribute::NoRedZone);
109 }
110 
111 void WebAssemblyFrameLowering::writeSPToGlobal(
112     unsigned SrcReg, MachineFunction &MF, MachineBasicBlock &MBB,
113     MachineBasicBlock::iterator &InsertStore, const DebugLoc &DL) const {
114   const auto *TII = MF.getSubtarget<WebAssemblySubtarget>().getInstrInfo();
115 
116   const char *ES = "__stack_pointer";
117   auto *SPSymbol = MF.createExternalSymbolName(ES);
118   BuildMI(MBB, InsertStore, DL, TII->get(WebAssembly::SET_GLOBAL_I32))
119       .addExternalSymbol(SPSymbol, WebAssemblyII::MO_SYMBOL_GLOBAL)
120       .addReg(SrcReg);
121 }
122 
123 MachineBasicBlock::iterator
124 WebAssemblyFrameLowering::eliminateCallFramePseudoInstr(
125     MachineFunction &MF, MachineBasicBlock &MBB,
126     MachineBasicBlock::iterator I) const {
127   assert(!I->getOperand(0).getImm() && (hasFP(MF) || hasBP(MF)) &&
128          "Call frame pseudos should only be used for dynamic stack adjustment");
129   const auto *TII = MF.getSubtarget<WebAssemblySubtarget>().getInstrInfo();
130   if (I->getOpcode() == TII->getCallFrameDestroyOpcode() &&
131       needsSPWriteback(MF, MF.getFrameInfo())) {
132     DebugLoc DL = I->getDebugLoc();
133     writeSPToGlobal(WebAssembly::SP32, MF, MBB, I, DL);
134   }
135   return MBB.erase(I);
136 }
137 
138 void WebAssemblyFrameLowering::emitPrologue(MachineFunction &MF,
139                                             MachineBasicBlock &MBB) const {
140   // TODO: Do ".setMIFlag(MachineInstr::FrameSetup)" on emitted instructions
141   auto &MFI = MF.getFrameInfo();
142   assert(MFI.getCalleeSavedInfo().empty() &&
143          "WebAssembly should not have callee-saved registers");
144 
145   if (!needsSP(MF, MFI)) return;
146   uint64_t StackSize = MFI.getStackSize();
147 
148   const auto *TII = MF.getSubtarget<WebAssemblySubtarget>().getInstrInfo();
149   auto &MRI = MF.getRegInfo();
150 
151   auto InsertPt = MBB.begin();
152   while (InsertPt != MBB.end() && WebAssembly::isArgument(*InsertPt))
153     ++InsertPt;
154   DebugLoc DL;
155 
156   const TargetRegisterClass *PtrRC =
157       MRI.getTargetRegisterInfo()->getPointerRegClass(MF);
158   unsigned SPReg = WebAssembly::SP32;
159   if (StackSize)
160     SPReg = MRI.createVirtualRegister(PtrRC);
161 
162   const char *ES = "__stack_pointer";
163   auto *SPSymbol = MF.createExternalSymbolName(ES);
164   BuildMI(MBB, InsertPt, DL, TII->get(WebAssembly::GET_GLOBAL_I32), SPReg)
165       .addExternalSymbol(SPSymbol, WebAssemblyII::MO_SYMBOL_GLOBAL);
166 
167   bool HasBP = hasBP(MF);
168   if (HasBP) {
169     auto FI = MF.getInfo<WebAssemblyFunctionInfo>();
170     unsigned BasePtr = MRI.createVirtualRegister(PtrRC);
171     FI->setBasePointerVreg(BasePtr);
172     BuildMI(MBB, InsertPt, DL, TII->get(WebAssembly::COPY), BasePtr)
173         .addReg(SPReg);
174   }
175   if (StackSize) {
176     // Subtract the frame size
177     unsigned OffsetReg = MRI.createVirtualRegister(PtrRC);
178     BuildMI(MBB, InsertPt, DL, TII->get(WebAssembly::CONST_I32), OffsetReg)
179         .addImm(StackSize);
180     BuildMI(MBB, InsertPt, DL, TII->get(WebAssembly::SUB_I32),
181             WebAssembly::SP32)
182         .addReg(SPReg)
183         .addReg(OffsetReg);
184   }
185   if (HasBP) {
186     unsigned BitmaskReg = MRI.createVirtualRegister(PtrRC);
187     unsigned Alignment = MFI.getMaxAlignment();
188     assert((1u << countTrailingZeros(Alignment)) == Alignment &&
189       "Alignment must be a power of 2");
190     BuildMI(MBB, InsertPt, DL, TII->get(WebAssembly::CONST_I32), BitmaskReg)
191         .addImm((int)~(Alignment - 1));
192     BuildMI(MBB, InsertPt, DL, TII->get(WebAssembly::AND_I32),
193             WebAssembly::SP32)
194         .addReg(WebAssembly::SP32)
195         .addReg(BitmaskReg);
196   }
197   if (hasFP(MF)) {
198     // Unlike most conventional targets (where FP points to the saved FP),
199     // FP points to the bottom of the fixed-size locals, so we can use positive
200     // offsets in load/store instructions.
201     BuildMI(MBB, InsertPt, DL, TII->get(WebAssembly::COPY),
202             WebAssembly::FP32)
203         .addReg(WebAssembly::SP32);
204   }
205   if (StackSize && needsSPWriteback(MF, MFI)) {
206     writeSPToGlobal(WebAssembly::SP32, MF, MBB, InsertPt, DL);
207   }
208 }
209 
210 void WebAssemblyFrameLowering::emitEpilogue(MachineFunction &MF,
211                                             MachineBasicBlock &MBB) const {
212   auto &MFI = MF.getFrameInfo();
213   uint64_t StackSize = MFI.getStackSize();
214   if (!needsSP(MF, MFI) || !needsSPWriteback(MF, MFI)) return;
215   const auto *TII = MF.getSubtarget<WebAssemblySubtarget>().getInstrInfo();
216   auto &MRI = MF.getRegInfo();
217   auto InsertPt = MBB.getFirstTerminator();
218   DebugLoc DL;
219 
220   if (InsertPt != MBB.end())
221     DL = InsertPt->getDebugLoc();
222 
223   // Restore the stack pointer. If we had fixed-size locals, add the offset
224   // subtracted in the prolog.
225   unsigned SPReg = 0;
226   if (hasBP(MF)) {
227     auto FI = MF.getInfo<WebAssemblyFunctionInfo>();
228     SPReg = FI->getBasePointerVreg();
229   } else if (StackSize) {
230     const TargetRegisterClass *PtrRC =
231         MRI.getTargetRegisterInfo()->getPointerRegClass(MF);
232     unsigned OffsetReg = MRI.createVirtualRegister(PtrRC);
233     BuildMI(MBB, InsertPt, DL, TII->get(WebAssembly::CONST_I32), OffsetReg)
234         .addImm(StackSize);
235     // In the epilog we don't need to write the result back to the SP32 physreg
236     // because it won't be used again. We can use a stackified register instead.
237     SPReg = MRI.createVirtualRegister(PtrRC);
238     BuildMI(MBB, InsertPt, DL, TII->get(WebAssembly::ADD_I32), SPReg)
239         .addReg(hasFP(MF) ? WebAssembly::FP32 : WebAssembly::SP32)
240         .addReg(OffsetReg);
241   } else {
242     SPReg = hasFP(MF) ? WebAssembly::FP32 : WebAssembly::SP32;
243   }
244 
245   writeSPToGlobal(SPReg, MF, MBB, InsertPt, DL);
246 }
247