lib/Target/WebAssembly/WebAssemblyAsmPrinter.cpp

   1 //===-- WebAssemblyAsmPrinter.cpp - WebAssembly LLVM assembly writer ------===//
   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 contains a printer that converts from our internal
  12 /// representation of machine-dependent LLVM code to the WebAssembly assembly
  13 /// language.
  14 ///
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "WebAssembly.h"
  18 #include "InstPrinter/WebAssemblyInstPrinter.h"
  19 #include "MCTargetDesc/WebAssemblyMCTargetDesc.h"
  20 #include "WebAssemblyMCInstLower.h"
  21 #include "WebAssemblyMachineFunctionInfo.h"
  22 #include "WebAssemblyRegisterInfo.h"
  23 #include "WebAssemblySubtarget.h"
  24 #include "llvm/ADT/StringExtras.h"
  25 #include "llvm/CodeGen/Analysis.h"
  26 #include "llvm/CodeGen/AsmPrinter.h"
  27 #include "llvm/CodeGen/MachineConstantPool.h"
  28 #include "llvm/CodeGen/MachineInstr.h"
  29 #include "llvm/IR/DataLayout.h"
  30 #include "llvm/MC/MCContext.h"
  31 #include "llvm/MC/MCStreamer.h"
  32 #include "llvm/MC/MCSymbol.h"
  33 #include "llvm/Support/Debug.h"
  34 #include "llvm/Support/TargetRegistry.h"
  35 #include "llvm/Support/raw_ostream.h"
  36 using namespace llvm;
  37
  38 #define DEBUG_TYPE "asm-printer"
  39
  40 namespace {
  41
  42 class WebAssemblyAsmPrinter final : public AsmPrinter {
  43   const MachineRegisterInfo *MRI;
  44   const WebAssemblyFunctionInfo *MFI;
  45
  46 public:
  47   WebAssemblyAsmPrinter(TargetMachine &TM, std::unique_ptr<MCStreamer> Streamer)
  48       : AsmPrinter(TM, std::move(Streamer)), MRI(nullptr), MFI(nullptr) {}
  49
  50 private:
  51   const char *getPassName() const override {
  52     return "WebAssembly Assembly Printer";
  53   }
  54
  55   //===------------------------------------------------------------------===//
  56   // MachineFunctionPass Implementation.
  57   //===------------------------------------------------------------------===//
  58
  59   bool runOnMachineFunction(MachineFunction &MF) override {
  60     MRI = &MF.getRegInfo();
  61     MFI = MF.getInfo<WebAssemblyFunctionInfo>();
  62     return AsmPrinter::runOnMachineFunction(MF);
  63   }
  64
  65   //===------------------------------------------------------------------===//
  66   // AsmPrinter Implementation.
  67   //===------------------------------------------------------------------===//
  68
  69   void EmitJumpTableInfo() override;
  70   void EmitConstantPool() override;
  71   void EmitFunctionBodyStart() override;
  72   void EmitInstruction(const MachineInstr *MI) override;
  73   const MCExpr *lowerConstant(const Constant *CV) override;
  74   bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
  75                        unsigned AsmVariant, const char *ExtraCode,
  76                        raw_ostream &OS) override;
  77   bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
  78                              unsigned AsmVariant, const char *ExtraCode,
  79                              raw_ostream &OS) override;
  80
  81   MVT getRegType(unsigned RegNo) const;
  82   const char *toString(MVT VT) const;
  83   std::string regToString(const MachineOperand &MO);
  84 };
  85
  86 } // end anonymous namespace
  87
  88 //===----------------------------------------------------------------------===//
  89 // Helpers.
  90 //===----------------------------------------------------------------------===//
  91
  92 MVT WebAssemblyAsmPrinter::getRegType(unsigned RegNo) const {
  93   const TargetRegisterClass *TRC =
  94       TargetRegisterInfo::isVirtualRegister(RegNo)
  95           ? MRI->getRegClass(RegNo)
  96           : MRI->getTargetRegisterInfo()->getMinimalPhysRegClass(RegNo);
  97   for (MVT T : {MVT::i32, MVT::i64, MVT::f32, MVT::f64})
  98     if (TRC->hasType(T))
  99       return T;
 100   DEBUG(errs() << "Unknown type for register number: " << RegNo);
 101   llvm_unreachable("Unknown register type");
 102   return MVT::Other;
 103 }
 104
 105 std::string WebAssemblyAsmPrinter::regToString(const MachineOperand &MO) {
 106   unsigned RegNo = MO.getReg();
 107   assert(TargetRegisterInfo::isVirtualRegister(RegNo) &&
 108          "Unlowered physical register encountered during assembly printing");
 109   assert(!MFI->isVRegStackified(RegNo));
 110   unsigned WAReg = MFI->getWAReg(RegNo);
 111   assert(WAReg != WebAssemblyFunctionInfo::UnusedReg);
 112   return '$' + utostr(WAReg);
 113 }
 114
 115 const char *WebAssemblyAsmPrinter::toString(MVT VT) const {
 116   return WebAssembly::TypeToString(VT);
 117 }
 118
 119 //===----------------------------------------------------------------------===//
 120 // WebAssemblyAsmPrinter Implementation.
 121 //===----------------------------------------------------------------------===//
 122
 123 void WebAssemblyAsmPrinter::EmitConstantPool() {
 124   assert(MF->getConstantPool()->getConstants().empty() &&
 125          "WebAssembly disables constant pools");
 126 }
 127
 128 void WebAssemblyAsmPrinter::EmitJumpTableInfo() {
 129   // Nothing to do; jump tables are incorporated into the instruction stream.
 130 }
 131
 132 static void ComputeLegalValueVTs(const Function &F, const TargetMachine &TM,
 133                                  Type *Ty, SmallVectorImpl<MVT> &ValueVTs) {
 134   const DataLayout &DL(F.getParent()->getDataLayout());
 135   const WebAssemblyTargetLowering &TLI =
 136       *TM.getSubtarget<WebAssemblySubtarget>(F).getTargetLowering();
 137   SmallVector<EVT, 4> VTs;
 138   ComputeValueVTs(TLI, DL, Ty, VTs);
 139
 140   for (EVT VT : VTs) {
 141     unsigned NumRegs = TLI.getNumRegisters(F.getContext(), VT);
 142     MVT RegisterVT = TLI.getRegisterType(F.getContext(), VT);
 143     for (unsigned i = 0; i != NumRegs; ++i)
 144       ValueVTs.push_back(RegisterVT);
 145   }
 146 }
 147
 148 void WebAssemblyAsmPrinter::EmitFunctionBodyStart() {
 149   if (!MFI->getParams().empty()) {
 150     MCInst Param;
 151     Param.setOpcode(WebAssembly::PARAM);
 152     for (MVT VT : MFI->getParams())
 153       Param.addOperand(MCOperand::createImm(VT.SimpleTy));
 154     EmitToStreamer(*OutStreamer, Param);
 155   }
 156
 157   SmallVector<MVT, 4> ResultVTs;
 158   const Function &F(*MF->getFunction());
 159   ComputeLegalValueVTs(F, TM, F.getReturnType(), ResultVTs);
 160   // If the return type needs to be legalized it will get converted into
 161   // passing a pointer.
 162   if (ResultVTs.size() == 1) {
 163     MCInst Result;
 164     Result.setOpcode(WebAssembly::RESULT);
 165     Result.addOperand(MCOperand::createImm(ResultVTs.front().SimpleTy));
 166     EmitToStreamer(*OutStreamer, Result);
 167   }
 168
 169   bool AnyWARegs = false;
 170   MCInst Local;
 171   Local.setOpcode(WebAssembly::LOCAL);
 172   for (unsigned Idx = 0, IdxE = MRI->getNumVirtRegs(); Idx != IdxE; ++Idx) {
 173     unsigned VReg = TargetRegisterInfo::index2VirtReg(Idx);
 174     unsigned WAReg = MFI->getWAReg(VReg);
 175     // Don't declare unused registers.
 176     if (WAReg == WebAssemblyFunctionInfo::UnusedReg)
 177       continue;
 178     // Don't redeclare parameters.
 179     if (WAReg < MFI->getParams().size())
 180       continue;
 181     // Don't declare stackified registers.
 182     if (int(WAReg) < 0)
 183       continue;
 184     Local.addOperand(MCOperand::createImm(getRegType(VReg).SimpleTy));
 185     AnyWARegs = true;
 186   }
 187   auto &PhysRegs = MFI->getPhysRegs();
 188   for (unsigned PReg = 0; PReg < PhysRegs.size(); ++PReg) {
 189     if (PhysRegs[PReg] == -1U)
 190       continue;
 191     Local.addOperand(MCOperand::createImm(getRegType(PReg).SimpleTy));
 192     AnyWARegs = true;
 193   }
 194   if (AnyWARegs)
 195     EmitToStreamer(*OutStreamer, Local);
 196
 197   AsmPrinter::EmitFunctionBodyStart();
 198 }
 199
 200 void WebAssemblyAsmPrinter::EmitInstruction(const MachineInstr *MI) {
 201   DEBUG(dbgs() << "EmitInstruction: " << *MI << '\n');
 202
 203   switch (MI->getOpcode()) {
 204   case WebAssembly::ARGUMENT_I32:
 205   case WebAssembly::ARGUMENT_I64:
 206   case WebAssembly::ARGUMENT_F32:
 207   case WebAssembly::ARGUMENT_F64:
 208     // These represent values which are live into the function entry, so there's
 209     // no instruction to emit.
 210     break;
 211   case WebAssembly::LOOP_END:
 212     // This is a no-op which just exists to tell AsmPrinter.cpp that there's a
 213     // fallthrough which nevertheless requires a label for the destination here.
 214     break;
 215   default: {
 216     WebAssemblyMCInstLower MCInstLowering(OutContext, *this);
 217     MCInst TmpInst;
 218     MCInstLowering.Lower(MI, TmpInst);
 219     EmitToStreamer(*OutStreamer, TmpInst);
 220     break;
 221   }
 222   }
 223 }
 224
 225 const MCExpr *WebAssemblyAsmPrinter::lowerConstant(const Constant *CV) {
 226   if (const GlobalValue *GV = dyn_cast<GlobalValue>(CV))
 227     if (GV->getValueType()->isFunctionTy())
 228       return MCSymbolRefExpr::create(
 229           getSymbol(GV), MCSymbolRefExpr::VK_WebAssembly_FUNCTION, OutContext);
 230   return AsmPrinter::lowerConstant(CV);
 231 }
 232
 233 bool WebAssemblyAsmPrinter::PrintAsmOperand(const MachineInstr *MI,
 234                                             unsigned OpNo, unsigned AsmVariant,
 235                                             const char *ExtraCode,
 236                                             raw_ostream &OS) {
 237   if (AsmVariant != 0)
 238     report_fatal_error("There are no defined alternate asm variants");
 239
 240   // First try the generic code, which knows about modifiers like 'c' and 'n'.
 241   if (!AsmPrinter::PrintAsmOperand(MI, OpNo, AsmVariant, ExtraCode, OS))
 242     return false;
 243
 244   if (!ExtraCode) {
 245     const MachineOperand &MO = MI->getOperand(OpNo);
 246     switch (MO.getType()) {
 247     case MachineOperand::MO_Immediate:
 248       OS << MO.getImm();
 249       return false;
 250     case MachineOperand::MO_Register:
 251       OS << regToString(MO);
 252       return false;
 253     case MachineOperand::MO_GlobalAddress:
 254       getSymbol(MO.getGlobal())->print(OS, MAI);
 255       printOffset(MO.getOffset(), OS);
 256       return false;
 257     case MachineOperand::MO_ExternalSymbol:
 258       GetExternalSymbolSymbol(MO.getSymbolName())->print(OS, MAI);
 259       printOffset(MO.getOffset(), OS);
 260       return false;
 261     case MachineOperand::MO_MachineBasicBlock:
 262       MO.getMBB()->getSymbol()->print(OS, MAI);
 263       return false;
 264     default:
 265       break;
 266     }
 267   }
 268
 269   return true;
 270 }
 271
 272 bool WebAssemblyAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
 273                                                   unsigned OpNo,
 274                                                   unsigned AsmVariant,
 275                                                   const char *ExtraCode,
 276                                                   raw_ostream &OS) {
 277   if (AsmVariant != 0)
 278     report_fatal_error("There are no defined alternate asm variants");
 279
 280   if (!ExtraCode) {
 281     // TODO: For now, we just hard-code 0 as the constant offset; teach
 282     // SelectInlineAsmMemoryOperand how to do address mode matching.
 283     OS << "0(" + regToString(MI->getOperand(OpNo)) + ')';
 284     return false;
 285   }
 286
 287   return AsmPrinter::PrintAsmMemoryOperand(MI, OpNo, AsmVariant, ExtraCode, OS);
 288 }
 289
 290 // Force static initialization.
 291 extern "C" void LLVMInitializeWebAssemblyAsmPrinter() {
 292   RegisterAsmPrinter<WebAssemblyAsmPrinter> X(TheWebAssemblyTarget32);
 293   RegisterAsmPrinter<WebAssemblyAsmPrinter> Y(TheWebAssemblyTarget64);
 294 }