1 //===-- WebAssemblyAsmPrinter.cpp - WebAssembly LLVM assembly writer ------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 ///
9 /// \file
10 /// This file contains a printer that converts from our internal
11 /// representation of machine-dependent LLVM code to the WebAssembly assembly
12 /// language.
13 ///
14 //===----------------------------------------------------------------------===//
15 
16 #include "WebAssemblyAsmPrinter.h"
17 #include "MCTargetDesc/WebAssemblyMCTargetDesc.h"
18 #include "MCTargetDesc/WebAssemblyTargetStreamer.h"
19 #include "TargetInfo/WebAssemblyTargetInfo.h"
20 #include "Utils/WebAssemblyTypeUtilities.h"
21 #include "Utils/WebAssemblyUtilities.h"
22 #include "WebAssembly.h"
23 #include "WebAssemblyMCInstLower.h"
24 #include "WebAssemblyMachineFunctionInfo.h"
25 #include "WebAssemblyRegisterInfo.h"
26 #include "WebAssemblyRuntimeLibcallSignatures.h"
27 #include "WebAssemblyTargetMachine.h"
28 #include "llvm/ADT/SmallSet.h"
29 #include "llvm/ADT/StringExtras.h"
30 #include "llvm/BinaryFormat/Wasm.h"
31 #include "llvm/CodeGen/Analysis.h"
32 #include "llvm/CodeGen/AsmPrinter.h"
33 #include "llvm/CodeGen/MachineConstantPool.h"
34 #include "llvm/CodeGen/MachineInstr.h"
35 #include "llvm/CodeGen/MachineModuleInfoImpls.h"
36 #include "llvm/IR/DataLayout.h"
37 #include "llvm/IR/DebugInfoMetadata.h"
38 #include "llvm/IR/GlobalVariable.h"
39 #include "llvm/IR/Metadata.h"
40 #include "llvm/MC/MCContext.h"
41 #include "llvm/MC/MCSectionWasm.h"
42 #include "llvm/MC/MCStreamer.h"
43 #include "llvm/MC/MCSymbol.h"
44 #include "llvm/MC/MCSymbolWasm.h"
45 #include "llvm/MC/TargetRegistry.h"
46 #include "llvm/Support/Debug.h"
47 #include "llvm/Support/raw_ostream.h"
48 
49 using namespace llvm;
50 
51 #define DEBUG_TYPE "asm-printer"
52 
53 extern cl::opt<bool> WasmKeepRegisters;
54 
55 //===----------------------------------------------------------------------===//
56 // Helpers.
57 //===----------------------------------------------------------------------===//
58 
59 MVT WebAssemblyAsmPrinter::getRegType(unsigned RegNo) const {
60   const TargetRegisterInfo *TRI = Subtarget->getRegisterInfo();
61   const TargetRegisterClass *TRC = MRI->getRegClass(RegNo);
62   for (MVT T : {MVT::i32, MVT::i64, MVT::f32, MVT::f64, MVT::v16i8, MVT::v8i16,
63                 MVT::v4i32, MVT::v2i64, MVT::v4f32, MVT::v2f64})
64     if (TRI->isTypeLegalForClass(*TRC, T))
65       return T;
66   LLVM_DEBUG(errs() << "Unknown type for register number: " << RegNo);
67   llvm_unreachable("Unknown register type");
68   return MVT::Other;
69 }
70 
71 std::string WebAssemblyAsmPrinter::regToString(const MachineOperand &MO) {
72   Register RegNo = MO.getReg();
73   assert(Register::isVirtualRegister(RegNo) &&
74          "Unlowered physical register encountered during assembly printing");
75   assert(!MFI->isVRegStackified(RegNo));
76   unsigned WAReg = MFI->getWAReg(RegNo);
77   assert(WAReg != WebAssemblyFunctionInfo::UnusedReg);
78   return '$' + utostr(WAReg);
79 }
80 
81 WebAssemblyTargetStreamer *WebAssemblyAsmPrinter::getTargetStreamer() {
82   MCTargetStreamer *TS = OutStreamer->getTargetStreamer();
83   return static_cast<WebAssemblyTargetStreamer *>(TS);
84 }
85 
86 // Emscripten exception handling helpers
87 //
88 // This converts invoke names generated by LowerEmscriptenEHSjLj to real names
89 // that are expected by JavaScript glue code. The invoke names generated by
90 // Emscripten JS glue code are based on their argument and return types; for
91 // example, for a function that takes an i32 and returns nothing, it is
92 // 'invoke_vi'. But the format of invoke generated by LowerEmscriptenEHSjLj pass
93 // contains a mangled string generated from their IR types, for example,
94 // "__invoke_void_%struct.mystruct*_int", because final wasm types are not
95 // available in the IR pass. So we convert those names to the form that
96 // Emscripten JS code expects.
97 //
98 // Refer to LowerEmscriptenEHSjLj pass for more details.
99 
100 // Returns true if the given function name is an invoke name generated by
101 // LowerEmscriptenEHSjLj pass.
102 static bool isEmscriptenInvokeName(StringRef Name) {
103   if (Name.front() == '"' && Name.back() == '"')
104     Name = Name.substr(1, Name.size() - 2);
105   return Name.startswith("__invoke_");
106 }
107 
108 // Returns a character that represents the given wasm value type in invoke
109 // signatures.
110 static char getInvokeSig(wasm::ValType VT) {
111   switch (VT) {
112   case wasm::ValType::I32:
113     return 'i';
114   case wasm::ValType::I64:
115     return 'j';
116   case wasm::ValType::F32:
117     return 'f';
118   case wasm::ValType::F64:
119     return 'd';
120   case wasm::ValType::V128:
121     return 'V';
122   case wasm::ValType::FUNCREF:
123     return 'F';
124   case wasm::ValType::EXTERNREF:
125     return 'X';
126   }
127   llvm_unreachable("Unhandled wasm::ValType enum");
128 }
129 
130 // Given the wasm signature, generate the invoke name in the format JS glue code
131 // expects.
132 static std::string getEmscriptenInvokeSymbolName(wasm::WasmSignature *Sig) {
133   assert(Sig->Returns.size() <= 1);
134   std::string Ret = "invoke_";
135   if (!Sig->Returns.empty())
136     for (auto VT : Sig->Returns)
137       Ret += getInvokeSig(VT);
138   else
139     Ret += 'v';
140   // Invokes' first argument is a pointer to the original function, so skip it
141   for (unsigned I = 1, E = Sig->Params.size(); I < E; I++)
142     Ret += getInvokeSig(Sig->Params[I]);
143   return Ret;
144 }
145 
146 //===----------------------------------------------------------------------===//
147 // WebAssemblyAsmPrinter Implementation.
148 //===----------------------------------------------------------------------===//
149 
150 MCSymbolWasm *WebAssemblyAsmPrinter::getMCSymbolForFunction(
151     const Function *F, bool EnableEmEH, wasm::WasmSignature *Sig,
152     bool &InvokeDetected) {
153   MCSymbolWasm *WasmSym = nullptr;
154   if (EnableEmEH && isEmscriptenInvokeName(F->getName())) {
155     assert(Sig);
156     InvokeDetected = true;
157     if (Sig->Returns.size() > 1) {
158       std::string Msg =
159           "Emscripten EH/SjLj does not support multivalue returns: " +
160           std::string(F->getName()) + ": " +
161           WebAssembly::signatureToString(Sig);
162       report_fatal_error(Twine(Msg));
163     }
164     WasmSym = cast<MCSymbolWasm>(
165         GetExternalSymbolSymbol(getEmscriptenInvokeSymbolName(Sig)));
166   } else {
167     WasmSym = cast<MCSymbolWasm>(getSymbol(F));
168   }
169   return WasmSym;
170 }
171 
172 void WebAssemblyAsmPrinter::emitGlobalVariable(const GlobalVariable *GV) {
173   if (!WebAssembly::isWasmVarAddressSpace(GV->getAddressSpace())) {
174     AsmPrinter::emitGlobalVariable(GV);
175     return;
176   }
177 
178   assert(!GV->isThreadLocal());
179 
180   MCSymbolWasm *Sym = cast<MCSymbolWasm>(getSymbol(GV));
181 
182   if (!Sym->getType()) {
183     const WebAssemblyTargetLowering &TLI = *Subtarget->getTargetLowering();
184     SmallVector<MVT, 1> VTs;
185     Type *GlobalVT = GV->getValueType();
186     computeLegalValueVTs(TLI, GV->getParent()->getContext(),
187                          GV->getParent()->getDataLayout(), GlobalVT, VTs);
188     WebAssembly::wasmSymbolSetType(Sym, GlobalVT, VTs);
189   }
190 
191   emitVisibility(Sym, GV->getVisibility(), !GV->isDeclaration());
192   emitSymbolType(Sym);
193   if (GV->hasInitializer()) {
194     assert(getSymbolPreferLocal(*GV) == Sym);
195     emitLinkage(GV, Sym);
196     OutStreamer->emitLabel(Sym);
197     // TODO: Actually emit the initializer value.  Otherwise the global has the
198     // default value for its type (0, ref.null, etc).
199     OutStreamer->AddBlankLine();
200   }
201 }
202 
203 MCSymbol *WebAssemblyAsmPrinter::getOrCreateWasmSymbol(StringRef Name) {
204   auto *WasmSym = cast<MCSymbolWasm>(GetExternalSymbolSymbol(Name));
205 
206   // May be called multiple times, so early out.
207   if (WasmSym->getType().hasValue())
208     return WasmSym;
209 
210   const WebAssemblySubtarget &Subtarget = getSubtarget();
211 
212   // Except for certain known symbols, all symbols used by CodeGen are
213   // functions. It's OK to hardcode knowledge of specific symbols here; this
214   // method is precisely there for fetching the signatures of known
215   // Clang-provided symbols.
216   if (Name == "__stack_pointer" || Name == "__tls_base" ||
217       Name == "__memory_base" || Name == "__table_base" ||
218       Name == "__tls_size" || Name == "__tls_align") {
219     bool Mutable =
220         Name == "__stack_pointer" || Name == "__tls_base";
221     WasmSym->setType(wasm::WASM_SYMBOL_TYPE_GLOBAL);
222     WasmSym->setGlobalType(wasm::WasmGlobalType{
223         uint8_t(Subtarget.hasAddr64() ? wasm::WASM_TYPE_I64
224                                       : wasm::WASM_TYPE_I32),
225         Mutable});
226     return WasmSym;
227   }
228 
229   if (Name.startswith("GCC_except_table")) {
230     WasmSym->setType(wasm::WASM_SYMBOL_TYPE_DATA);
231     return WasmSym;
232   }
233 
234   SmallVector<wasm::ValType, 4> Returns;
235   SmallVector<wasm::ValType, 4> Params;
236   if (Name == "__cpp_exception" || Name == "__c_longjmp") {
237     WasmSym->setType(wasm::WASM_SYMBOL_TYPE_TAG);
238     // In static linking we define tag symbols in WasmException::endModule().
239     // But we may have multiple objects to be linked together, each of which
240     // defines the tag symbols. To resolve them, we declare them as weak. In
241     // dynamic linking we make tag symbols undefined in the backend, define it
242     // in JS, and feed them to each importing module.
243     if (!isPositionIndependent())
244       WasmSym->setWeak(true);
245     WasmSym->setExternal(true);
246 
247     // Currently both C++ exceptions and C longjmps have a single pointer type
248     // param. For C++ exceptions it is a pointer to an exception object, and for
249     // C longjmps it is pointer to a struct that contains a setjmp buffer and a
250     // longjmp return value. We may consider using multiple value parameters for
251     // longjmps later when multivalue support is ready.
252     wasm::ValType AddrType =
253         Subtarget.hasAddr64() ? wasm::ValType::I64 : wasm::ValType::I32;
254     Params.push_back(AddrType);
255   } else { // Function symbols
256     WasmSym->setType(wasm::WASM_SYMBOL_TYPE_FUNCTION);
257     getLibcallSignature(Subtarget, Name, Returns, Params);
258   }
259   auto Signature = std::make_unique<wasm::WasmSignature>(std::move(Returns),
260                                                          std::move(Params));
261   WasmSym->setSignature(Signature.get());
262   addSignature(std::move(Signature));
263 
264   return WasmSym;
265 }
266 
267 void WebAssemblyAsmPrinter::emitSymbolType(const MCSymbolWasm *Sym) {
268   Optional<wasm::WasmSymbolType> WasmTy = Sym->getType();
269   if (!WasmTy)
270     return;
271 
272   switch (WasmTy.getValue()) {
273   case wasm::WASM_SYMBOL_TYPE_GLOBAL:
274     getTargetStreamer()->emitGlobalType(Sym);
275     break;
276   case wasm::WASM_SYMBOL_TYPE_TAG:
277     getTargetStreamer()->emitTagType(Sym);
278     break;
279   case wasm::WASM_SYMBOL_TYPE_TABLE:
280     getTargetStreamer()->emitTableType(Sym);
281     break;
282   default:
283     break; // We only handle globals, tags and tables here
284   }
285 }
286 
287 void WebAssemblyAsmPrinter::emitExternalDecls(const Module &M) {
288   if (signaturesEmitted)
289     return;
290   signaturesEmitted = true;
291 
292   // Normally symbols for globals get discovered as the MI gets lowered,
293   // but we need to know about them ahead of time. This will however,
294   // only find symbols that have been used. Unused symbols from globals will
295   // not be found here.
296   MachineModuleInfoWasm &MMIW = MMI->getObjFileInfo<MachineModuleInfoWasm>();
297   for (const auto &Name : MMIW.MachineSymbolsUsed) {
298     getOrCreateWasmSymbol(Name.getKey());
299   }
300 
301   for (auto &It : OutContext.getSymbols()) {
302     // Emit .globaltype, .tagtype, or .tabletype declarations for extern
303     // declarations, i.e. those that have only been declared (but not defined)
304     // in the current module
305     auto Sym = cast<MCSymbolWasm>(It.getValue());
306     if (!Sym->isDefined())
307       emitSymbolType(Sym);
308   }
309 
310   DenseSet<MCSymbol *> InvokeSymbols;
311   for (const auto &F : M) {
312     if (F.isIntrinsic())
313       continue;
314 
315     // Emit function type info for all undefined functions
316     if (F.isDeclarationForLinker()) {
317       SmallVector<MVT, 4> Results;
318       SmallVector<MVT, 4> Params;
319       computeSignatureVTs(F.getFunctionType(), &F, F, TM, Params, Results);
320       // At this point these MCSymbols may or may not have been created already
321       // and thus also contain a signature, but we need to get the signature
322       // anyway here in case it is an invoke that has not yet been created. We
323       // will discard it later if it turns out not to be necessary.
324       auto Signature = signatureFromMVTs(Results, Params);
325       bool InvokeDetected = false;
326       auto *Sym = getMCSymbolForFunction(
327           &F, WebAssembly::WasmEnableEmEH || WebAssembly::WasmEnableEmSjLj,
328           Signature.get(), InvokeDetected);
329 
330       // Multiple functions can be mapped to the same invoke symbol. For
331       // example, two IR functions '__invoke_void_i8*' and '__invoke_void_i32'
332       // are both mapped to '__invoke_vi'. We keep them in a set once we emit an
333       // Emscripten EH symbol so we don't emit the same symbol twice.
334       if (InvokeDetected && !InvokeSymbols.insert(Sym).second)
335         continue;
336 
337       Sym->setType(wasm::WASM_SYMBOL_TYPE_FUNCTION);
338       if (!Sym->getSignature()) {
339         Sym->setSignature(Signature.get());
340         addSignature(std::move(Signature));
341       } else {
342         // This symbol has already been created and had a signature. Discard it.
343         Signature.reset();
344       }
345 
346       getTargetStreamer()->emitFunctionType(Sym);
347 
348       if (F.hasFnAttribute("wasm-import-module")) {
349         StringRef Name =
350             F.getFnAttribute("wasm-import-module").getValueAsString();
351         Sym->setImportModule(storeName(Name));
352         getTargetStreamer()->emitImportModule(Sym, Name);
353       }
354       if (F.hasFnAttribute("wasm-import-name")) {
355         // If this is a converted Emscripten EH/SjLj symbol, we shouldn't use
356         // the original function name but the converted symbol name.
357         StringRef Name =
358             InvokeDetected
359                 ? Sym->getName()
360                 : F.getFnAttribute("wasm-import-name").getValueAsString();
361         Sym->setImportName(storeName(Name));
362         getTargetStreamer()->emitImportName(Sym, Name);
363       }
364     }
365 
366     if (F.hasFnAttribute("wasm-export-name")) {
367       auto *Sym = cast<MCSymbolWasm>(getSymbol(&F));
368       StringRef Name = F.getFnAttribute("wasm-export-name").getValueAsString();
369       Sym->setExportName(storeName(Name));
370       getTargetStreamer()->emitExportName(Sym, Name);
371     }
372   }
373 }
374 
375 void WebAssemblyAsmPrinter::emitEndOfAsmFile(Module &M) {
376   // When a function's address is taken, a TABLE_INDEX relocation is emitted
377   // against the function symbol at the use site.  However the relocation
378   // doesn't explicitly refer to the table.  In the future we may want to
379   // define a new kind of reloc against both the function and the table, so
380   // that the linker can see that the function symbol keeps the table alive,
381   // but for now manually mark the table as live.
382   for (const auto &F : M) {
383     if (!F.isIntrinsic() && F.hasAddressTaken()) {
384       MCSymbolWasm *FunctionTable =
385           WebAssembly::getOrCreateFunctionTableSymbol(OutContext, Subtarget);
386       OutStreamer->emitSymbolAttribute(FunctionTable, MCSA_NoDeadStrip);
387       break;
388     }
389   }
390 
391   for (const auto &G : M.globals()) {
392     if (!G.hasInitializer() && G.hasExternalLinkage() &&
393         !WebAssembly::isWasmVarAddressSpace(G.getAddressSpace()) &&
394         G.getValueType()->isSized()) {
395       uint16_t Size = M.getDataLayout().getTypeAllocSize(G.getValueType());
396       OutStreamer->emitELFSize(getSymbol(&G),
397                                MCConstantExpr::create(Size, OutContext));
398     }
399   }
400 
401   if (const NamedMDNode *Named = M.getNamedMetadata("wasm.custom_sections")) {
402     for (const Metadata *MD : Named->operands()) {
403       const auto *Tuple = dyn_cast<MDTuple>(MD);
404       if (!Tuple || Tuple->getNumOperands() != 2)
405         continue;
406       const MDString *Name = dyn_cast<MDString>(Tuple->getOperand(0));
407       const MDString *Contents = dyn_cast<MDString>(Tuple->getOperand(1));
408       if (!Name || !Contents)
409         continue;
410 
411       OutStreamer->PushSection();
412       std::string SectionName = (".custom_section." + Name->getString()).str();
413       MCSectionWasm *MySection =
414           OutContext.getWasmSection(SectionName, SectionKind::getMetadata());
415       OutStreamer->SwitchSection(MySection);
416       OutStreamer->emitBytes(Contents->getString());
417       OutStreamer->PopSection();
418     }
419   }
420 
421   EmitProducerInfo(M);
422   EmitTargetFeatures(M);
423 }
424 
425 void WebAssemblyAsmPrinter::EmitProducerInfo(Module &M) {
426   llvm::SmallVector<std::pair<std::string, std::string>, 4> Languages;
427   if (const NamedMDNode *Debug = M.getNamedMetadata("llvm.dbg.cu")) {
428     llvm::SmallSet<StringRef, 4> SeenLanguages;
429     for (size_t I = 0, E = Debug->getNumOperands(); I < E; ++I) {
430       const auto *CU = cast<DICompileUnit>(Debug->getOperand(I));
431       StringRef Language = dwarf::LanguageString(CU->getSourceLanguage());
432       Language.consume_front("DW_LANG_");
433       if (SeenLanguages.insert(Language).second)
434         Languages.emplace_back(Language.str(), "");
435     }
436   }
437 
438   llvm::SmallVector<std::pair<std::string, std::string>, 4> Tools;
439   if (const NamedMDNode *Ident = M.getNamedMetadata("llvm.ident")) {
440     llvm::SmallSet<StringRef, 4> SeenTools;
441     for (size_t I = 0, E = Ident->getNumOperands(); I < E; ++I) {
442       const auto *S = cast<MDString>(Ident->getOperand(I)->getOperand(0));
443       std::pair<StringRef, StringRef> Field = S->getString().split("version");
444       StringRef Name = Field.first.trim();
445       StringRef Version = Field.second.trim();
446       if (SeenTools.insert(Name).second)
447         Tools.emplace_back(Name.str(), Version.str());
448     }
449   }
450 
451   int FieldCount = int(!Languages.empty()) + int(!Tools.empty());
452   if (FieldCount != 0) {
453     MCSectionWasm *Producers = OutContext.getWasmSection(
454         ".custom_section.producers", SectionKind::getMetadata());
455     OutStreamer->PushSection();
456     OutStreamer->SwitchSection(Producers);
457     OutStreamer->emitULEB128IntValue(FieldCount);
458     for (auto &Producers : {std::make_pair("language", &Languages),
459             std::make_pair("processed-by", &Tools)}) {
460       if (Producers.second->empty())
461         continue;
462       OutStreamer->emitULEB128IntValue(strlen(Producers.first));
463       OutStreamer->emitBytes(Producers.first);
464       OutStreamer->emitULEB128IntValue(Producers.second->size());
465       for (auto &Producer : *Producers.second) {
466         OutStreamer->emitULEB128IntValue(Producer.first.size());
467         OutStreamer->emitBytes(Producer.first);
468         OutStreamer->emitULEB128IntValue(Producer.second.size());
469         OutStreamer->emitBytes(Producer.second);
470       }
471     }
472     OutStreamer->PopSection();
473   }
474 }
475 
476 void WebAssemblyAsmPrinter::EmitTargetFeatures(Module &M) {
477   struct FeatureEntry {
478     uint8_t Prefix;
479     std::string Name;
480   };
481 
482   // Read target features and linkage policies from module metadata
483   SmallVector<FeatureEntry, 4> EmittedFeatures;
484   auto EmitFeature = [&](std::string Feature) {
485     std::string MDKey = (StringRef("wasm-feature-") + Feature).str();
486     Metadata *Policy = M.getModuleFlag(MDKey);
487     if (Policy == nullptr)
488       return;
489 
490     FeatureEntry Entry;
491     Entry.Prefix = 0;
492     Entry.Name = Feature;
493 
494     if (auto *MD = cast<ConstantAsMetadata>(Policy))
495       if (auto *I = cast<ConstantInt>(MD->getValue()))
496         Entry.Prefix = I->getZExtValue();
497 
498     // Silently ignore invalid metadata
499     if (Entry.Prefix != wasm::WASM_FEATURE_PREFIX_USED &&
500         Entry.Prefix != wasm::WASM_FEATURE_PREFIX_REQUIRED &&
501         Entry.Prefix != wasm::WASM_FEATURE_PREFIX_DISALLOWED)
502       return;
503 
504     EmittedFeatures.push_back(Entry);
505   };
506 
507   for (const SubtargetFeatureKV &KV : WebAssemblyFeatureKV) {
508     EmitFeature(KV.Key);
509   }
510   // This pseudo-feature tells the linker whether shared memory would be safe
511   EmitFeature("shared-mem");
512 
513   // This is an "architecture", not a "feature", but we emit it as such for
514   // the benefit of tools like Binaryen and consistency with other producers.
515   // FIXME: Subtarget is null here, so can't Subtarget->hasAddr64() ?
516   if (M.getDataLayout().getPointerSize() == 8) {
517     // Can't use EmitFeature since "wasm-feature-memory64" is not a module
518     // flag.
519     EmittedFeatures.push_back({wasm::WASM_FEATURE_PREFIX_USED, "memory64"});
520   }
521 
522   if (EmittedFeatures.size() == 0)
523     return;
524 
525   // Emit features and linkage policies into the "target_features" section
526   MCSectionWasm *FeaturesSection = OutContext.getWasmSection(
527       ".custom_section.target_features", SectionKind::getMetadata());
528   OutStreamer->PushSection();
529   OutStreamer->SwitchSection(FeaturesSection);
530 
531   OutStreamer->emitULEB128IntValue(EmittedFeatures.size());
532   for (auto &F : EmittedFeatures) {
533     OutStreamer->emitIntValue(F.Prefix, 1);
534     OutStreamer->emitULEB128IntValue(F.Name.size());
535     OutStreamer->emitBytes(F.Name);
536   }
537 
538   OutStreamer->PopSection();
539 }
540 
541 void WebAssemblyAsmPrinter::emitConstantPool() {
542   const Module *M = MMI->getModule();
543   emitExternalDecls(*M);
544   assert(MF->getConstantPool()->getConstants().empty() &&
545          "WebAssembly disables constant pools");
546 }
547 
548 void WebAssemblyAsmPrinter::emitJumpTableInfo() {
549   // Nothing to do; jump tables are incorporated into the instruction stream.
550 }
551 
552 void WebAssemblyAsmPrinter::emitFunctionBodyStart() {
553   const Function &F = MF->getFunction();
554   SmallVector<MVT, 1> ResultVTs;
555   SmallVector<MVT, 4> ParamVTs;
556   computeSignatureVTs(F.getFunctionType(), &F, F, TM, ParamVTs, ResultVTs);
557 
558   auto Signature = signatureFromMVTs(ResultVTs, ParamVTs);
559   auto *WasmSym = cast<MCSymbolWasm>(CurrentFnSym);
560   WasmSym->setSignature(Signature.get());
561   addSignature(std::move(Signature));
562   WasmSym->setType(wasm::WASM_SYMBOL_TYPE_FUNCTION);
563 
564   getTargetStreamer()->emitFunctionType(WasmSym);
565 
566   // Emit the function index.
567   if (MDNode *Idx = F.getMetadata("wasm.index")) {
568     assert(Idx->getNumOperands() == 1);
569 
570     getTargetStreamer()->emitIndIdx(AsmPrinter::lowerConstant(
571         cast<ConstantAsMetadata>(Idx->getOperand(0))->getValue()));
572   }
573 
574   SmallVector<wasm::ValType, 16> Locals;
575   valTypesFromMVTs(MFI->getLocals(), Locals);
576   getTargetStreamer()->emitLocal(Locals);
577 
578   AsmPrinter::emitFunctionBodyStart();
579 }
580 
581 void WebAssemblyAsmPrinter::emitInstruction(const MachineInstr *MI) {
582   LLVM_DEBUG(dbgs() << "EmitInstruction: " << *MI << '\n');
583 
584   switch (MI->getOpcode()) {
585   case WebAssembly::ARGUMENT_i32:
586   case WebAssembly::ARGUMENT_i32_S:
587   case WebAssembly::ARGUMENT_i64:
588   case WebAssembly::ARGUMENT_i64_S:
589   case WebAssembly::ARGUMENT_f32:
590   case WebAssembly::ARGUMENT_f32_S:
591   case WebAssembly::ARGUMENT_f64:
592   case WebAssembly::ARGUMENT_f64_S:
593   case WebAssembly::ARGUMENT_v16i8:
594   case WebAssembly::ARGUMENT_v16i8_S:
595   case WebAssembly::ARGUMENT_v8i16:
596   case WebAssembly::ARGUMENT_v8i16_S:
597   case WebAssembly::ARGUMENT_v4i32:
598   case WebAssembly::ARGUMENT_v4i32_S:
599   case WebAssembly::ARGUMENT_v2i64:
600   case WebAssembly::ARGUMENT_v2i64_S:
601   case WebAssembly::ARGUMENT_v4f32:
602   case WebAssembly::ARGUMENT_v4f32_S:
603   case WebAssembly::ARGUMENT_v2f64:
604   case WebAssembly::ARGUMENT_v2f64_S:
605     // These represent values which are live into the function entry, so there's
606     // no instruction to emit.
607     break;
608   case WebAssembly::FALLTHROUGH_RETURN: {
609     // These instructions represent the implicit return at the end of a
610     // function body.
611     if (isVerbose()) {
612       OutStreamer->AddComment("fallthrough-return");
613       OutStreamer->AddBlankLine();
614     }
615     break;
616   }
617   case WebAssembly::COMPILER_FENCE:
618     // This is a compiler barrier that prevents instruction reordering during
619     // backend compilation, and should not be emitted.
620     break;
621   default: {
622     WebAssemblyMCInstLower MCInstLowering(OutContext, *this);
623     MCInst TmpInst;
624     MCInstLowering.lower(MI, TmpInst);
625     EmitToStreamer(*OutStreamer, TmpInst);
626     break;
627   }
628   }
629 }
630 
631 bool WebAssemblyAsmPrinter::PrintAsmOperand(const MachineInstr *MI,
632                                             unsigned OpNo,
633                                             const char *ExtraCode,
634                                             raw_ostream &OS) {
635   // First try the generic code, which knows about modifiers like 'c' and 'n'.
636   if (!AsmPrinter::PrintAsmOperand(MI, OpNo, ExtraCode, OS))
637     return false;
638 
639   if (!ExtraCode) {
640     const MachineOperand &MO = MI->getOperand(OpNo);
641     switch (MO.getType()) {
642     case MachineOperand::MO_Immediate:
643       OS << MO.getImm();
644       return false;
645     case MachineOperand::MO_Register:
646       // FIXME: only opcode that still contains registers, as required by
647       // MachineInstr::getDebugVariable().
648       assert(MI->getOpcode() == WebAssembly::INLINEASM);
649       OS << regToString(MO);
650       return false;
651     case MachineOperand::MO_GlobalAddress:
652       PrintSymbolOperand(MO, OS);
653       return false;
654     case MachineOperand::MO_ExternalSymbol:
655       GetExternalSymbolSymbol(MO.getSymbolName())->print(OS, MAI);
656       printOffset(MO.getOffset(), OS);
657       return false;
658     case MachineOperand::MO_MachineBasicBlock:
659       MO.getMBB()->getSymbol()->print(OS, MAI);
660       return false;
661     default:
662       break;
663     }
664   }
665 
666   return true;
667 }
668 
669 bool WebAssemblyAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
670                                                   unsigned OpNo,
671                                                   const char *ExtraCode,
672                                                   raw_ostream &OS) {
673   // The current approach to inline asm is that "r" constraints are expressed
674   // as local indices, rather than values on the operand stack. This simplifies
675   // using "r" as it eliminates the need to push and pop the values in a
676   // particular order, however it also makes it impossible to have an "m"
677   // constraint. So we don't support it.
678 
679   return AsmPrinter::PrintAsmMemoryOperand(MI, OpNo, ExtraCode, OS);
680 }
681 
682 // Force static initialization.
683 extern "C" LLVM_EXTERNAL_VISIBILITY void LLVMInitializeWebAssemblyAsmPrinter() {
684   RegisterAsmPrinter<WebAssemblyAsmPrinter> X(getTheWebAssemblyTarget32());
685   RegisterAsmPrinter<WebAssemblyAsmPrinter> Y(getTheWebAssemblyTarget64());
686 }
687