lib/Target/WebAssembly/WebAssemblyStoreResults.cpp

   1 //===-- WebAssemblyStoreResults.cpp - Optimize using store result values --===//
   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 This file implements an optimization pass using store result values.
  12 ///
  13 /// WebAssembly's store instructions return the stored value. This is to enable
  14 /// an optimization wherein uses of the stored value can be replaced by uses of
  15 /// the store's result value, making the stored value register more likely to
  16 /// be single-use, thus more likely to be useful to register stackifying, and
  17 /// potentially also exposing the store to register stackifying. These both can
  18 /// reduce get_local/set_local traffic.
  19 ///
  20 //===----------------------------------------------------------------------===//
  21
  22 #include "WebAssembly.h"
  23 #include "MCTargetDesc/WebAssemblyMCTargetDesc.h"
  24 #include "WebAssemblyMachineFunctionInfo.h"
  25 #include "WebAssemblySubtarget.h"
  26 #include "llvm/CodeGen/MachineBlockFrequencyInfo.h"
  27 #include "llvm/CodeGen/MachineDominators.h"
  28 #include "llvm/CodeGen/MachineRegisterInfo.h"
  29 #include "llvm/CodeGen/Passes.h"
  30 #include "llvm/Support/Debug.h"
  31 #include "llvm/Support/raw_ostream.h"
  32 using namespace llvm;
  33
  34 #define DEBUG_TYPE "wasm-store-results"
  35
  36 namespace {
  37 class WebAssemblyStoreResults final : public MachineFunctionPass {
  38 public:
  39   static char ID; // Pass identification, replacement for typeid
  40   WebAssemblyStoreResults() : MachineFunctionPass(ID) {}
  41
  42   const char *getPassName() const override {
  43     return "WebAssembly Store Results";
  44   }
  45
  46   void getAnalysisUsage(AnalysisUsage &AU) const override {
  47     AU.setPreservesCFG();
  48     AU.addRequired<MachineBlockFrequencyInfo>();
  49     AU.addPreserved<MachineBlockFrequencyInfo>();
  50     AU.addRequired<MachineDominatorTree>();
  51     AU.addPreserved<MachineDominatorTree>();
  52     MachineFunctionPass::getAnalysisUsage(AU);
  53   }
  54
  55   bool runOnMachineFunction(MachineFunction &MF) override;
  56
  57 private:
  58 };
  59 } // end anonymous namespace
  60
  61 char WebAssemblyStoreResults::ID = 0;
  62 FunctionPass *llvm::createWebAssemblyStoreResults() {
  63   return new WebAssemblyStoreResults();
  64 }
  65
  66 bool WebAssemblyStoreResults::runOnMachineFunction(MachineFunction &MF) {
  67   DEBUG({
  68     dbgs() << "********** Store Results **********\n"
  69            << "********** Function: " << MF.getName() << '\n';
  70   });
  71
  72   const MachineRegisterInfo &MRI = MF.getRegInfo();
  73   MachineDominatorTree &MDT = getAnalysis<MachineDominatorTree>();
  74   bool Changed = false;
  75
  76   assert(MRI.isSSA() && "StoreResults depends on SSA form");
  77
  78   for (auto &MBB : MF) {
  79     DEBUG(dbgs() << "Basic Block: " << MBB.getName() << '\n');
  80     for (auto &MI : MBB)
  81       switch (MI.getOpcode()) {
  82       default:
  83         break;
  84       case WebAssembly::STORE8_I32:
  85       case WebAssembly::STORE16_I32:
  86       case WebAssembly::STORE8_I64:
  87       case WebAssembly::STORE16_I64:
  88       case WebAssembly::STORE32_I64:
  89       case WebAssembly::STORE_F32:
  90       case WebAssembly::STORE_F64:
  91       case WebAssembly::STORE_I32:
  92       case WebAssembly::STORE_I64:
  93         unsigned ToReg = MI.getOperand(0).getReg();
  94         unsigned FromReg = MI.getOperand(3).getReg();
  95         for (auto I = MRI.use_begin(FromReg), E = MRI.use_end(); I != E;) {
  96           MachineOperand &O = *I++;
  97           MachineInstr *Where = O.getParent();
  98           if (Where->getOpcode() == TargetOpcode::PHI) {
  99             // PHIs use their operands on their incoming CFG edges rather than
 100             // in their parent blocks. Get the basic block paired with this use
 101             // of FromReg and check that MI's block dominates it.
 102             MachineBasicBlock *Pred =
 103                 Where->getOperand(&O - &Where->getOperand(0) + 1).getMBB();
 104             if (!MDT.dominates(&MBB, Pred))
 105               continue;
 106           } else {
 107             // For a non-PHI, check that MI dominates the instruction in the
 108             // normal way.
 109             if (&MI == Where || !MDT.dominates(&MI, Where))
 110               continue;
 111           }
 112           Changed = true;
 113           DEBUG(dbgs() << "Setting operand " << O << " in " << *Where
 114                        << " from " << MI << "\n");
 115           O.setReg(ToReg);
 116           // If the store's def was previously dead, it is no longer. But the
 117           // dead flag shouldn't be set yet.
 118           assert(!MI.getOperand(0).isDead() && "Dead flag set on store result");
 119         }
 120       }
 121   }
 122
 123   return Changed;
 124 }