lib/Target/WebAssembly/WebAssemblyFrameLowering.cpp

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