1 //===-- WebAssemblyPeephole.cpp - WebAssembly Peephole Optimiztions -------===//
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 /// \brief Late peephole optimizations for WebAssembly.
12 ///
13 //===----------------------------------------------------------------------===//
14 
15 #include "MCTargetDesc/WebAssemblyMCTargetDesc.h"
16 #include "WebAssembly.h"
17 #include "WebAssemblyMachineFunctionInfo.h"
18 #include "WebAssemblySubtarget.h"
19 #include "llvm/Analysis/TargetLibraryInfo.h"
20 #include "llvm/CodeGen/MachineFunctionPass.h"
21 #include "llvm/CodeGen/MachineInstrBuilder.h"
22 #include "llvm/CodeGen/MachineRegisterInfo.h"
23 using namespace llvm;
24 
25 #define DEBUG_TYPE "wasm-peephole"
26 
27 static cl::opt<bool> DisableWebAssemblyFallthroughReturnOpt(
28     "disable-wasm-fallthrough-return-opt", cl::Hidden,
29     cl::desc("WebAssembly: Disable fallthrough-return optimizations."),
30     cl::init(false));
31 
32 namespace {
33 class WebAssemblyPeephole final : public MachineFunctionPass {
34   StringRef getPassName() const override {
35     return "WebAssembly late peephole optimizer";
36   }
37 
38   void getAnalysisUsage(AnalysisUsage &AU) const override {
39     AU.setPreservesCFG();
40     AU.addRequired<TargetLibraryInfoWrapperPass>();
41     MachineFunctionPass::getAnalysisUsage(AU);
42   }
43 
44   bool runOnMachineFunction(MachineFunction &MF) override;
45 
46 public:
47   static char ID;
48   WebAssemblyPeephole() : MachineFunctionPass(ID) {}
49 };
50 } // end anonymous namespace
51 
52 char WebAssemblyPeephole::ID = 0;
53 FunctionPass *llvm::createWebAssemblyPeephole() {
54   return new WebAssemblyPeephole();
55 }
56 
57 /// If desirable, rewrite NewReg to a drop register.
58 static bool MaybeRewriteToDrop(unsigned OldReg, unsigned NewReg,
59                                MachineOperand &MO, WebAssemblyFunctionInfo &MFI,
60                                MachineRegisterInfo &MRI) {
61   bool Changed = false;
62   if (OldReg == NewReg) {
63     Changed = true;
64     unsigned NewReg = MRI.createVirtualRegister(MRI.getRegClass(OldReg));
65     MO.setReg(NewReg);
66     MO.setIsDead();
67     MFI.stackifyVReg(NewReg);
68   }
69   return Changed;
70 }
71 
72 static bool MaybeRewriteToFallthrough(MachineInstr &MI, MachineBasicBlock &MBB,
73                                       const MachineFunction &MF,
74                                       WebAssemblyFunctionInfo &MFI,
75                                       MachineRegisterInfo &MRI,
76                                       const WebAssemblyInstrInfo &TII,
77                                       unsigned FallthroughOpc,
78                                       unsigned CopyLocalOpc) {
79   if (DisableWebAssemblyFallthroughReturnOpt)
80     return false;
81   if (&MBB != &MF.back())
82     return false;
83   if (&MI != &MBB.back())
84     return false;
85 
86   if (FallthroughOpc != WebAssembly::FALLTHROUGH_RETURN_VOID) {
87     // If the operand isn't stackified, insert a COPY to read the operand and
88     // stackify it.
89     MachineOperand &MO = MI.getOperand(0);
90     unsigned Reg = MO.getReg();
91     if (!MFI.isVRegStackified(Reg)) {
92       unsigned NewReg = MRI.createVirtualRegister(MRI.getRegClass(Reg));
93       BuildMI(MBB, MI, MI.getDebugLoc(), TII.get(CopyLocalOpc), NewReg)
94           .addReg(Reg);
95       MO.setReg(NewReg);
96       MFI.stackifyVReg(NewReg);
97     }
98   }
99 
100   // Rewrite the return.
101   MI.setDesc(TII.get(FallthroughOpc));
102   return true;
103 }
104 
105 bool WebAssemblyPeephole::runOnMachineFunction(MachineFunction &MF) {
106   DEBUG({
107     dbgs() << "********** Peephole **********\n"
108            << "********** Function: " << MF.getName() << '\n';
109   });
110 
111   MachineRegisterInfo &MRI = MF.getRegInfo();
112   WebAssemblyFunctionInfo &MFI = *MF.getInfo<WebAssemblyFunctionInfo>();
113   const auto &TII = *MF.getSubtarget<WebAssemblySubtarget>().getInstrInfo();
114   const WebAssemblyTargetLowering &TLI =
115       *MF.getSubtarget<WebAssemblySubtarget>().getTargetLowering();
116   auto &LibInfo = getAnalysis<TargetLibraryInfoWrapperPass>().getTLI();
117   bool Changed = false;
118 
119   for (auto &MBB : MF)
120     for (auto &MI : MBB)
121       switch (MI.getOpcode()) {
122       default:
123         break;
124       case WebAssembly::CALL_I32:
125       case WebAssembly::CALL_I64: {
126         MachineOperand &Op1 = MI.getOperand(1);
127         if (Op1.isSymbol()) {
128           StringRef Name(Op1.getSymbolName());
129           if (Name == TLI.getLibcallName(RTLIB::MEMCPY) ||
130               Name == TLI.getLibcallName(RTLIB::MEMMOVE) ||
131               Name == TLI.getLibcallName(RTLIB::MEMSET)) {
132             LibFunc Func;
133             if (LibInfo.getLibFunc(Name, Func)) {
134               const auto &Op2 = MI.getOperand(2);
135               if (!Op2.isReg())
136                 report_fatal_error("Peephole: call to builtin function with "
137                                    "wrong signature, not consuming reg");
138               MachineOperand &MO = MI.getOperand(0);
139               unsigned OldReg = MO.getReg();
140               unsigned NewReg = Op2.getReg();
141 
142               if (MRI.getRegClass(NewReg) != MRI.getRegClass(OldReg))
143                 report_fatal_error("Peephole: call to builtin function with "
144                                    "wrong signature, from/to mismatch");
145               Changed |= MaybeRewriteToDrop(OldReg, NewReg, MO, MFI, MRI);
146             }
147           }
148         }
149         break;
150       }
151       // Optimize away an explicit void return at the end of the function.
152       case WebAssembly::RETURN_I32:
153         Changed |= MaybeRewriteToFallthrough(
154             MI, MBB, MF, MFI, MRI, TII, WebAssembly::FALLTHROUGH_RETURN_I32,
155             WebAssembly::COPY_I32);
156         break;
157       case WebAssembly::RETURN_I64:
158         Changed |= MaybeRewriteToFallthrough(
159             MI, MBB, MF, MFI, MRI, TII, WebAssembly::FALLTHROUGH_RETURN_I64,
160             WebAssembly::COPY_I64);
161         break;
162       case WebAssembly::RETURN_F32:
163         Changed |= MaybeRewriteToFallthrough(
164             MI, MBB, MF, MFI, MRI, TII, WebAssembly::FALLTHROUGH_RETURN_F32,
165             WebAssembly::COPY_F32);
166         break;
167       case WebAssembly::RETURN_F64:
168         Changed |= MaybeRewriteToFallthrough(
169             MI, MBB, MF, MFI, MRI, TII, WebAssembly::FALLTHROUGH_RETURN_F64,
170             WebAssembly::COPY_F64);
171         break;
172       case WebAssembly::RETURN_v16i8:
173         Changed |= MaybeRewriteToFallthrough(
174             MI, MBB, MF, MFI, MRI, TII, WebAssembly::FALLTHROUGH_RETURN_v16i8,
175             WebAssembly::COPY_V128);
176         break;
177       case WebAssembly::RETURN_v8i16:
178         Changed |= MaybeRewriteToFallthrough(
179             MI, MBB, MF, MFI, MRI, TII, WebAssembly::FALLTHROUGH_RETURN_v8i16,
180             WebAssembly::COPY_V128);
181         break;
182       case WebAssembly::RETURN_v4i32:
183         Changed |= MaybeRewriteToFallthrough(
184             MI, MBB, MF, MFI, MRI, TII, WebAssembly::FALLTHROUGH_RETURN_v4i32,
185             WebAssembly::COPY_V128);
186         break;
187       case WebAssembly::RETURN_v4f32:
188         Changed |= MaybeRewriteToFallthrough(
189             MI, MBB, MF, MFI, MRI, TII, WebAssembly::FALLTHROUGH_RETURN_v4f32,
190             WebAssembly::COPY_V128);
191         break;
192       case WebAssembly::RETURN_VOID:
193         Changed |= MaybeRewriteToFallthrough(
194             MI, MBB, MF, MFI, MRI, TII, WebAssembly::FALLTHROUGH_RETURN_VOID,
195             WebAssembly::INSTRUCTION_LIST_END);
196         break;
197       }
198 
199   return Changed;
200 }
201