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
  81   std::string getRegTypeName(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 std::string WebAssemblyAsmPrinter::getRegTypeName(unsigned RegNo) const {
  93   const TargetRegisterClass *TRC = MRI->getRegClass(RegNo);
  94   for (MVT T : {MVT::i32, MVT::i64, MVT::f32, MVT::f64})
  95     if (TRC->hasType(T))
  96       return EVT(T).getEVTString();
  97   DEBUG(errs() << "Unknown type for register number: " << RegNo);
  98   llvm_unreachable("Unknown register type");
  99   return "?";
 100 }
 101
 102 std::string WebAssemblyAsmPrinter::regToString(const MachineOperand &MO) {
 103   unsigned RegNo = MO.getReg();
 104   if (TargetRegisterInfo::isPhysicalRegister(RegNo))
 105     return WebAssemblyInstPrinter::getRegisterName(RegNo);
 106
 107   unsigned WAReg = MFI->getWAReg(RegNo);
 108   assert(WAReg != WebAssemblyFunctionInfo::UnusedReg);
 109   return utostr(WAReg);
 110 }
 111
 112 const char *WebAssemblyAsmPrinter::toString(MVT VT) const {
 113   switch (VT.SimpleTy) {
 114   default:
 115     break;
 116   case MVT::f32:
 117     return "f32";
 118   case MVT::f64:
 119     return "f64";
 120   case MVT::i32:
 121     return "i32";
 122   case MVT::i64:
 123     return "i64";
 124   }
 125   DEBUG(dbgs() << "Invalid type " << EVT(VT).getEVTString() << '\n');
 126   llvm_unreachable("invalid type");
 127   return "<invalid>";
 128 }
 129
 130 //===----------------------------------------------------------------------===//
 131 // WebAssemblyAsmPrinter Implementation.
 132 //===----------------------------------------------------------------------===//
 133
 134 void WebAssemblyAsmPrinter::EmitConstantPool() {
 135   assert(MF->getConstantPool()->getConstants().empty() &&
 136          "WebAssembly disables constant pools");
 137 }
 138
 139 void WebAssemblyAsmPrinter::EmitJumpTableInfo() {
 140   // Nothing to do; jump tables are incorporated into the instruction stream.
 141 }
 142
 143 void WebAssemblyAsmPrinter::EmitFunctionBodyStart() {
 144   SmallString<128> Str;
 145   raw_svector_ostream OS(Str);
 146
 147   for (MVT VT : MFI->getParams())
 148     OS << "\t" ".param " << toString(VT) << '\n';
 149   for (MVT VT : MFI->getResults())
 150     OS << "\t" ".result " << toString(VT) << '\n';
 151
 152   bool FirstVReg = true;
 153   for (unsigned Idx = 0, IdxE = MRI->getNumVirtRegs(); Idx != IdxE; ++Idx) {
 154     unsigned VReg = TargetRegisterInfo::index2VirtReg(Idx);
 155     if (!MRI->use_empty(VReg)) {
 156       if (FirstVReg)
 157         OS << "\t" ".local ";
 158       else
 159         OS << ", ";
 160       OS << getRegTypeName(VReg);
 161       FirstVReg = false;
 162     }
 163   }
 164   if (!FirstVReg)
 165     OS << '\n';
 166
 167   // EmitRawText appends a newline, so strip off the last newline.
 168   StringRef Text = OS.str();
 169   if (!Text.empty())
 170     OutStreamer->EmitRawText(Text.substr(0, Text.size() - 1));
 171   AsmPrinter::EmitFunctionBodyStart();
 172 }
 173
 174 void WebAssemblyAsmPrinter::EmitInstruction(const MachineInstr *MI) {
 175   DEBUG(dbgs() << "EmitInstruction: " << *MI << '\n');
 176
 177   assert(MI->getDesc().getNumDefs() <= 1 &&
 178          "Instructions with multiple result values not implemented");
 179
 180   switch (MI->getOpcode()) {
 181   case TargetOpcode::COPY: {
 182     // TODO: Figure out a way to lower COPY instructions to MCInst form.
 183     SmallString<128> Str;
 184     raw_svector_ostream OS(Str);
 185     OS << "\t" "set_local " << regToString(MI->getOperand(0)) << ", "
 186                "(get_local " << regToString(MI->getOperand(1)) << ")";
 187     OutStreamer->EmitRawText(OS.str());
 188     break;
 189   }
 190   case WebAssembly::ARGUMENT_I32:
 191   case WebAssembly::ARGUMENT_I64:
 192   case WebAssembly::ARGUMENT_F32:
 193   case WebAssembly::ARGUMENT_F64:
 194     // These represent values which are live into the function entry, so there's
 195     // no instruction to emit.
 196     break;
 197   default: {
 198     WebAssemblyMCInstLower MCInstLowering(OutContext, *this);
 199     MCInst TmpInst;
 200     MCInstLowering.Lower(MI, TmpInst);
 201     EmitToStreamer(*OutStreamer, TmpInst);
 202     break;
 203   }
 204   }
 205 }
 206
 207 static void ComputeLegalValueVTs(LLVMContext &Context,
 208                                  const WebAssemblyTargetLowering &TLI,
 209                                  const DataLayout &DL, Type *Ty,
 210                                  SmallVectorImpl<MVT> &ValueVTs) {
 211   SmallVector<EVT, 4> VTs;
 212   ComputeValueVTs(TLI, DL, Ty, VTs);
 213
 214   for (EVT VT : VTs) {
 215     unsigned NumRegs = TLI.getNumRegisters(Context, VT);
 216     MVT RegisterVT = TLI.getRegisterType(Context, VT);
 217     for (unsigned i = 0; i != NumRegs; ++i)
 218       ValueVTs.push_back(RegisterVT);
 219   }
 220 }
 221
 222 void WebAssemblyAsmPrinter::EmitEndOfAsmFile(Module &M) {
 223   const DataLayout &DL = M.getDataLayout();
 224
 225   SmallString<128> Str;
 226   raw_svector_ostream OS(Str);
 227   for (const Function &F : M)
 228     if (F.isDeclarationForLinker()) {
 229       assert(F.hasName() && "imported functions must have a name");
 230       if (F.isIntrinsic())
 231         continue;
 232       if (Str.empty())
 233         OS << "\t.imports\n";
 234
 235       MCSymbol *Sym = OutStreamer->getContext().getOrCreateSymbol(F.getName());
 236       OS << "\t.import " << *Sym << " \"\" " << *Sym;
 237
 238       const WebAssemblyTargetLowering &TLI =
 239           *TM.getSubtarget<WebAssemblySubtarget>(F).getTargetLowering();
 240
 241       // If we need to legalize the return type, it'll get converted into
 242       // passing a pointer.
 243       bool SawParam = false;
 244       SmallVector<MVT, 4> ResultVTs;
 245       ComputeLegalValueVTs(M.getContext(), TLI, DL, F.getReturnType(),
 246                            ResultVTs);
 247       if (ResultVTs.size() > 1) {
 248         ResultVTs.clear();
 249         OS << " (param " << toString(TLI.getPointerTy(DL));
 250         SawParam = true;
 251       }
 252
 253       for (const Argument &A : F.args()) {
 254         SmallVector<MVT, 4> ParamVTs;
 255         ComputeLegalValueVTs(M.getContext(), TLI, DL, A.getType(), ParamVTs);
 256         for (EVT VT : ParamVTs) {
 257           if (!SawParam) {
 258             OS << " (param";
 259             SawParam = true;
 260           }
 261           OS << ' ' << toString(VT.getSimpleVT());
 262         }
 263       }
 264       if (SawParam)
 265         OS << ')';
 266
 267       for (EVT VT : ResultVTs)
 268         OS << " (result " << toString(VT.getSimpleVT()) << ')';
 269
 270       OS << '\n';
 271     }
 272
 273   StringRef Text = OS.str();
 274   if (!Text.empty())
 275     OutStreamer->EmitRawText(Text.substr(0, Text.size() - 1));
 276 }
 277
 278 // Force static initialization.
 279 extern "C" void LLVMInitializeWebAssemblyAsmPrinter() {
 280   RegisterAsmPrinter<WebAssemblyAsmPrinter> X(TheWebAssemblyTarget32);
 281   RegisterAsmPrinter<WebAssemblyAsmPrinter> Y(TheWebAssemblyTarget64);
 282 }