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/SmallString.h"
  25 #include "llvm/ADT/StringExtras.h"
  26 #include "llvm/CodeGen/Analysis.h"
  27 #include "llvm/CodeGen/AsmPrinter.h"
  28 #include "llvm/CodeGen/MachineConstantPool.h"
  29 #include "llvm/CodeGen/MachineInstr.h"
  30 #include "llvm/IR/DataLayout.h"
  31 #include "llvm/MC/MCContext.h"
  32 #include "llvm/MC/MCStreamer.h"
  33 #include "llvm/MC/MCSymbol.h"
  34 #include "llvm/Support/Debug.h"
  35 #include "llvm/Support/TargetRegistry.h"
  36 #include "llvm/Support/raw_ostream.h"
  37
  38 using namespace llvm;
  39
  40 #define DEBUG_TYPE "asm-printer"
  41
  42 namespace {
  43
  44 class WebAssemblyAsmPrinter final : public AsmPrinter {
  45   const MachineRegisterInfo *MRI;
  46   const WebAssemblyFunctionInfo *MFI;
  47
  48 public:
  49   WebAssemblyAsmPrinter(TargetMachine &TM, std::unique_ptr<MCStreamer> Streamer)
  50       : AsmPrinter(TM, std::move(Streamer)), MRI(nullptr), MFI(nullptr) {}
  51
  52 private:
  53   const char *getPassName() const override {
  54     return "WebAssembly Assembly Printer";
  55   }
  56
  57   //===------------------------------------------------------------------===//
  58   // MachineFunctionPass Implementation.
  59   //===------------------------------------------------------------------===//
  60
  61   void getAnalysisUsage(AnalysisUsage &AU) const override {
  62     AsmPrinter::getAnalysisUsage(AU);
  63   }
  64
  65   bool runOnMachineFunction(MachineFunction &MF) override {
  66     MRI = &MF.getRegInfo();
  67     MFI = MF.getInfo<WebAssemblyFunctionInfo>();
  68     return AsmPrinter::runOnMachineFunction(MF);
  69   }
  70
  71   //===------------------------------------------------------------------===//
  72   // AsmPrinter Implementation.
  73   //===------------------------------------------------------------------===//
  74
  75   void EmitJumpTableInfo() override;
  76   void EmitConstantPool() override;
  77   void EmitFunctionBodyStart() override;
  78   void EmitInstruction(const MachineInstr *MI) override;
  79   void EmitEndOfAsmFile(Module &M) override;
  80   bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo,
  81                        unsigned AsmVariant, const char *ExtraCode,
  82                        raw_ostream &OS) override;
  83   bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo,
  84                              unsigned AsmVariant, const char *ExtraCode,
  85                              raw_ostream &OS) override;
  86
  87   std::string getRegTypeName(unsigned RegNo) const;
  88   const char *toString(MVT VT) const;
  89   std::string regToString(const MachineOperand &MO);
  90 };
  91
  92 } // end anonymous namespace
  93
  94 //===----------------------------------------------------------------------===//
  95 // Helpers.
  96 //===----------------------------------------------------------------------===//
  97
  98 std::string WebAssemblyAsmPrinter::getRegTypeName(unsigned RegNo) const {
  99   const TargetRegisterClass *TRC = MRI->getRegClass(RegNo);
 100   for (MVT T : {MVT::i32, MVT::i64, MVT::f32, MVT::f64})
 101     if (TRC->hasType(T))
 102       return EVT(T).getEVTString();
 103   DEBUG(errs() << "Unknown type for register number: " << RegNo);
 104   llvm_unreachable("Unknown register type");
 105   return "?";
 106 }
 107
 108 std::string WebAssemblyAsmPrinter::regToString(const MachineOperand &MO) {
 109   unsigned RegNo = MO.getReg();
 110   if (TargetRegisterInfo::isPhysicalRegister(RegNo))
 111     return WebAssemblyInstPrinter::getRegisterName(RegNo);
 112
 113   unsigned WAReg = MFI->getWAReg(RegNo);
 114   assert(WAReg != WebAssemblyFunctionInfo::UnusedReg);
 115   return utostr(WAReg);
 116 }
 117
 118 const char *WebAssemblyAsmPrinter::toString(MVT VT) const {
 119   switch (VT.SimpleTy) {
 120   default:
 121     break;
 122   case MVT::f32:
 123     return "f32";
 124   case MVT::f64:
 125     return "f64";
 126   case MVT::i32:
 127     return "i32";
 128   case MVT::i64:
 129     return "i64";
 130   }
 131   DEBUG(dbgs() << "Invalid type " << EVT(VT).getEVTString() << '\n');
 132   llvm_unreachable("invalid type");
 133   return "<invalid>";
 134 }
 135
 136 //===----------------------------------------------------------------------===//
 137 // WebAssemblyAsmPrinter Implementation.
 138 //===----------------------------------------------------------------------===//
 139
 140 void WebAssemblyAsmPrinter::EmitConstantPool() {
 141   assert(MF->getConstantPool()->getConstants().empty() &&
 142          "WebAssembly disables constant pools");
 143 }
 144
 145 void WebAssemblyAsmPrinter::EmitJumpTableInfo() {
 146   // Nothing to do; jump tables are incorporated into the instruction stream.
 147 }
 148
 149 void WebAssemblyAsmPrinter::EmitFunctionBodyStart() {
 150   SmallString<128> Str;
 151   raw_svector_ostream OS(Str);
 152
 153   for (MVT VT : MFI->getParams())
 154     OS << "\t" ".param " << toString(VT) << '\n';
 155   for (MVT VT : MFI->getResults())
 156     OS << "\t" ".result " << toString(VT) << '\n';
 157
 158   bool FirstVReg = true;
 159   for (unsigned Idx = 0, IdxE = MRI->getNumVirtRegs(); Idx != IdxE; ++Idx) {
 160     unsigned VReg = TargetRegisterInfo::index2VirtReg(Idx);
 161     if (!MRI->use_empty(VReg)) {
 162       if (FirstVReg)
 163         OS << "\t" ".local ";
 164       else
 165         OS << ", ";
 166       OS << getRegTypeName(VReg);
 167       FirstVReg = false;
 168     }
 169   }
 170   if (!FirstVReg)
 171     OS << '\n';
 172
 173   // EmitRawText appends a newline, so strip off the last newline.
 174   StringRef Text = OS.str();
 175   if (!Text.empty())
 176     OutStreamer->EmitRawText(Text.substr(0, Text.size() - 1));
 177   AsmPrinter::EmitFunctionBodyStart();
 178 }
 179
 180 void WebAssemblyAsmPrinter::EmitInstruction(const MachineInstr *MI) {
 181   DEBUG(dbgs() << "EmitInstruction: " << *MI << '\n');
 182
 183   assert(MI->getDesc().getNumDefs() <= 1 &&
 184          "Instructions with multiple result values not implemented");
 185
 186   switch (MI->getOpcode()) {
 187   case TargetOpcode::COPY: {
 188     // TODO: Figure out a way to lower COPY instructions to MCInst form.
 189     SmallString<128> Str;
 190     raw_svector_ostream OS(Str);
 191     OS << "\t" "set_local " << regToString(MI->getOperand(0)) << ", "
 192                "(get_local " << regToString(MI->getOperand(1)) << ")";
 193     OutStreamer->EmitRawText(OS.str());
 194     break;
 195   }
 196   case WebAssembly::ARGUMENT_I32:
 197   case WebAssembly::ARGUMENT_I64:
 198   case WebAssembly::ARGUMENT_F32:
 199   case WebAssembly::ARGUMENT_F64:
 200     // These represent values which are live into the function entry, so there's
 201     // no instruction to emit.
 202     break;
 203   default: {
 204     WebAssemblyMCInstLower MCInstLowering(OutContext, *this);
 205     MCInst TmpInst;
 206     MCInstLowering.Lower(MI, TmpInst);
 207     EmitToStreamer(*OutStreamer, TmpInst);
 208     break;
 209   }
 210   }
 211 }
 212
 213 static void ComputeLegalValueVTs(LLVMContext &Context,
 214                                  const WebAssemblyTargetLowering &TLI,
 215                                  const DataLayout &DL, Type *Ty,
 216                                  SmallVectorImpl<MVT> &ValueVTs) {
 217   SmallVector<EVT, 4> VTs;
 218   ComputeValueVTs(TLI, DL, Ty, VTs);
 219
 220   for (EVT VT : VTs) {
 221     unsigned NumRegs = TLI.getNumRegisters(Context, VT);
 222     MVT RegisterVT = TLI.getRegisterType(Context, VT);
 223     for (unsigned i = 0; i != NumRegs; ++i)
 224       ValueVTs.push_back(RegisterVT);
 225   }
 226 }
 227
 228 void WebAssemblyAsmPrinter::EmitEndOfAsmFile(Module &M) {
 229   const DataLayout &DL = M.getDataLayout();
 230
 231   SmallString<128> Str;
 232   raw_svector_ostream OS(Str);
 233   for (const Function &F : M)
 234     if (F.isDeclarationForLinker()) {
 235       assert(F.hasName() && "imported functions must have a name");
 236       if (F.isIntrinsic())
 237         continue;
 238       if (Str.empty())
 239         OS << "\t.imports\n";
 240
 241       MCSymbol *Sym = OutStreamer->getContext().getOrCreateSymbol(F.getName());
 242       OS << "\t.import " << *Sym << " \"\" " << *Sym;
 243
 244       const WebAssemblyTargetLowering &TLI =
 245           *TM.getSubtarget<WebAssemblySubtarget>(F).getTargetLowering();
 246
 247       // If we need to legalize the return type, it'll get converted into
 248       // passing a pointer.
 249       bool SawParam = false;
 250       SmallVector<MVT, 4> ResultVTs;
 251       ComputeLegalValueVTs(M.getContext(), TLI, DL, F.getReturnType(),
 252                            ResultVTs);
 253       if (ResultVTs.size() > 1) {
 254         ResultVTs.clear();
 255         OS << " (param " << toString(TLI.getPointerTy(DL));
 256         SawParam = true;
 257       }
 258
 259       for (const Argument &A : F.args()) {
 260         SmallVector<MVT, 4> ParamVTs;
 261         ComputeLegalValueVTs(M.getContext(), TLI, DL, A.getType(), ParamVTs);
 262         for (EVT VT : ParamVTs) {
 263           if (!SawParam) {
 264             OS << " (param";
 265             SawParam = true;
 266           }
 267           OS << ' ' << toString(VT.getSimpleVT());
 268         }
 269       }
 270       if (SawParam)
 271         OS << ')';
 272
 273       for (EVT VT : ResultVTs)
 274         OS << " (result " << toString(VT.getSimpleVT()) << ')';
 275
 276       OS << '\n';
 277     }
 278
 279   StringRef Text = OS.str();
 280   if (!Text.empty())
 281     OutStreamer->EmitRawText(Text.substr(0, Text.size() - 1));
 282 }
 283
 284 bool WebAssemblyAsmPrinter::PrintAsmOperand(const MachineInstr *MI,
 285                                             unsigned OpNo, unsigned AsmVariant,
 286                                             const char *ExtraCode,
 287                                             raw_ostream &OS) {
 288   if (AsmVariant != 0)
 289     report_fatal_error("There are no defined alternate asm variants");
 290
 291   if (!ExtraCode) {
 292     const MachineOperand &MO = MI->getOperand(OpNo);
 293     if (MO.isImm())
 294       OS << MO.getImm();
 295     else
 296       OS << regToString(MO);
 297     return false;
 298   }
 299
 300   return AsmPrinter::PrintAsmOperand(MI, OpNo, AsmVariant, ExtraCode, OS);
 301 }
 302
 303 bool WebAssemblyAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
 304                                                   unsigned OpNo,
 305                                                   unsigned AsmVariant,
 306                                                   const char *ExtraCode,
 307                                                   raw_ostream &OS) {
 308   if (AsmVariant != 0)
 309     report_fatal_error("There are no defined alternate asm variants");
 310
 311   if (!ExtraCode) {
 312     OS << regToString(MI->getOperand(OpNo));
 313     return false;
 314   }
 315
 316   return AsmPrinter::PrintAsmMemoryOperand(MI, OpNo, AsmVariant, ExtraCode, OS);
 317 }
 318
 319 // Force static initialization.
 320 extern "C" void LLVMInitializeWebAssemblyAsmPrinter() {
 321   RegisterAsmPrinter<WebAssemblyAsmPrinter> X(TheWebAssemblyTarget32);
 322   RegisterAsmPrinter<WebAssemblyAsmPrinter> Y(TheWebAssemblyTarget64);
 323 }