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     SmallVector<MVT, 1> VTs;
184     Type *GlobalVT = GV->getValueType();
185     if (Subtarget) {
186       // Subtarget is only set when a function is defined, because
187       // each function can declare a different subtarget. For example,
188       // on ARM a compilation unit might have a function on ARM and
189       // another on Thumb. Therefore only if Subtarget is non-null we
190       // can actually calculate the legal VTs.
191       const WebAssemblyTargetLowering &TLI = *Subtarget->getTargetLowering();
192       computeLegalValueVTs(TLI, GV->getParent()->getContext(),
193                            GV->getParent()->getDataLayout(), GlobalVT, VTs);
194     }
195     WebAssembly::wasmSymbolSetType(Sym, GlobalVT, VTs);
196   }
197 
198   emitVisibility(Sym, GV->getVisibility(), !GV->isDeclaration());
199   emitSymbolType(Sym);
200   if (GV->hasInitializer()) {
201     assert(getSymbolPreferLocal(*GV) == Sym);
202     emitLinkage(GV, Sym);
203     OutStreamer->emitLabel(Sym);
204     // TODO: Actually emit the initializer value.  Otherwise the global has the
205     // default value for its type (0, ref.null, etc).
206     OutStreamer->AddBlankLine();
207   }
208 }
209 
210 MCSymbol *WebAssemblyAsmPrinter::getOrCreateWasmSymbol(StringRef Name) {
211   auto *WasmSym = cast<MCSymbolWasm>(GetExternalSymbolSymbol(Name));
212 
213   // May be called multiple times, so early out.
214   if (WasmSym->getType().hasValue())
215     return WasmSym;
216 
217   const WebAssemblySubtarget &Subtarget = getSubtarget();
218 
219   // Except for certain known symbols, all symbols used by CodeGen are
220   // functions. It's OK to hardcode knowledge of specific symbols here; this
221   // method is precisely there for fetching the signatures of known
222   // Clang-provided symbols.
223   if (Name == "__stack_pointer" || Name == "__tls_base" ||
224       Name == "__memory_base" || Name == "__table_base" ||
225       Name == "__tls_size" || Name == "__tls_align") {
226     bool Mutable =
227         Name == "__stack_pointer" || Name == "__tls_base";
228     WasmSym->setType(wasm::WASM_SYMBOL_TYPE_GLOBAL);
229     WasmSym->setGlobalType(wasm::WasmGlobalType{
230         uint8_t(Subtarget.hasAddr64() ? wasm::WASM_TYPE_I64
231                                       : wasm::WASM_TYPE_I32),
232         Mutable});
233     return WasmSym;
234   }
235 
236   if (Name.startswith("GCC_except_table")) {
237     WasmSym->setType(wasm::WASM_SYMBOL_TYPE_DATA);
238     return WasmSym;
239   }
240 
241   SmallVector<wasm::ValType, 4> Returns;
242   SmallVector<wasm::ValType, 4> Params;
243   if (Name == "__cpp_exception" || Name == "__c_longjmp") {
244     WasmSym->setType(wasm::WASM_SYMBOL_TYPE_TAG);
245     // In static linking we define tag symbols in WasmException::endModule().
246     // But we may have multiple objects to be linked together, each of which
247     // defines the tag symbols. To resolve them, we declare them as weak. In
248     // dynamic linking we make tag symbols undefined in the backend, define it
249     // in JS, and feed them to each importing module.
250     if (!isPositionIndependent())
251       WasmSym->setWeak(true);
252     WasmSym->setExternal(true);
253 
254     // Currently both C++ exceptions and C longjmps have a single pointer type
255     // param. For C++ exceptions it is a pointer to an exception object, and for
256     // C longjmps it is pointer to a struct that contains a setjmp buffer and a
257     // longjmp return value. We may consider using multiple value parameters for
258     // longjmps later when multivalue support is ready.
259     wasm::ValType AddrType =
260         Subtarget.hasAddr64() ? wasm::ValType::I64 : wasm::ValType::I32;
261     Params.push_back(AddrType);
262   } else { // Function symbols
263     WasmSym->setType(wasm::WASM_SYMBOL_TYPE_FUNCTION);
264     getLibcallSignature(Subtarget, Name, Returns, Params);
265   }
266   auto Signature = std::make_unique<wasm::WasmSignature>(std::move(Returns),
267                                                          std::move(Params));
268   WasmSym->setSignature(Signature.get());
269   addSignature(std::move(Signature));
270 
271   return WasmSym;
272 }
273 
274 void WebAssemblyAsmPrinter::emitSymbolType(const MCSymbolWasm *Sym) {
275   Optional<wasm::WasmSymbolType> WasmTy = Sym->getType();
276   if (!WasmTy)
277     return;
278 
279   switch (WasmTy.getValue()) {
280   case wasm::WASM_SYMBOL_TYPE_GLOBAL:
281     getTargetStreamer()->emitGlobalType(Sym);
282     break;
283   case wasm::WASM_SYMBOL_TYPE_TAG:
284     getTargetStreamer()->emitTagType(Sym);
285     break;
286   case wasm::WASM_SYMBOL_TYPE_TABLE:
287     getTargetStreamer()->emitTableType(Sym);
288     break;
289   default:
290     break; // We only handle globals, tags and tables here
291   }
292 }
293 
294 void WebAssemblyAsmPrinter::emitExternalDecls(const Module &M) {
295   if (signaturesEmitted)
296     return;
297   signaturesEmitted = true;
298 
299   // Normally symbols for globals get discovered as the MI gets lowered,
300   // but we need to know about them ahead of time. This will however,
301   // only find symbols that have been used. Unused symbols from globals will
302   // not be found here.
303   MachineModuleInfoWasm &MMIW = MMI->getObjFileInfo<MachineModuleInfoWasm>();
304   for (const auto &Name : MMIW.MachineSymbolsUsed) {
305     getOrCreateWasmSymbol(Name.getKey());
306   }
307 
308   for (auto &It : OutContext.getSymbols()) {
309     // Emit .globaltype, .tagtype, or .tabletype declarations for extern
310     // declarations, i.e. those that have only been declared (but not defined)
311     // in the current module
312     auto Sym = cast<MCSymbolWasm>(It.getValue());
313     if (!Sym->isDefined())
314       emitSymbolType(Sym);
315   }
316 
317   DenseSet<MCSymbol *> InvokeSymbols;
318   for (const auto &F : M) {
319     if (F.isIntrinsic())
320       continue;
321 
322     // Emit function type info for all undefined functions
323     if (F.isDeclarationForLinker()) {
324       SmallVector<MVT, 4> Results;
325       SmallVector<MVT, 4> Params;
326       computeSignatureVTs(F.getFunctionType(), &F, F, TM, Params, Results);
327       // At this point these MCSymbols may or may not have been created already
328       // and thus also contain a signature, but we need to get the signature
329       // anyway here in case it is an invoke that has not yet been created. We
330       // will discard it later if it turns out not to be necessary.
331       auto Signature = signatureFromMVTs(Results, Params);
332       bool InvokeDetected = false;
333       auto *Sym = getMCSymbolForFunction(
334           &F, WebAssembly::WasmEnableEmEH || WebAssembly::WasmEnableEmSjLj,
335           Signature.get(), InvokeDetected);
336 
337       // Multiple functions can be mapped to the same invoke symbol. For
338       // example, two IR functions '__invoke_void_i8*' and '__invoke_void_i32'
339       // are both mapped to '__invoke_vi'. We keep them in a set once we emit an
340       // Emscripten EH symbol so we don't emit the same symbol twice.
341       if (InvokeDetected && !InvokeSymbols.insert(Sym).second)
342         continue;
343 
344       Sym->setType(wasm::WASM_SYMBOL_TYPE_FUNCTION);
345       if (!Sym->getSignature()) {
346         Sym->setSignature(Signature.get());
347         addSignature(std::move(Signature));
348       } else {
349         // This symbol has already been created and had a signature. Discard it.
350         Signature.reset();
351       }
352 
353       getTargetStreamer()->emitFunctionType(Sym);
354 
355       if (F.hasFnAttribute("wasm-import-module")) {
356         StringRef Name =
357             F.getFnAttribute("wasm-import-module").getValueAsString();
358         Sym->setImportModule(storeName(Name));
359         getTargetStreamer()->emitImportModule(Sym, Name);
360       }
361       if (F.hasFnAttribute("wasm-import-name")) {
362         // If this is a converted Emscripten EH/SjLj symbol, we shouldn't use
363         // the original function name but the converted symbol name.
364         StringRef Name =
365             InvokeDetected
366                 ? Sym->getName()
367                 : F.getFnAttribute("wasm-import-name").getValueAsString();
368         Sym->setImportName(storeName(Name));
369         getTargetStreamer()->emitImportName(Sym, Name);
370       }
371     }
372 
373     if (F.hasFnAttribute("wasm-export-name")) {
374       auto *Sym = cast<MCSymbolWasm>(getSymbol(&F));
375       StringRef Name = F.getFnAttribute("wasm-export-name").getValueAsString();
376       Sym->setExportName(storeName(Name));
377       getTargetStreamer()->emitExportName(Sym, Name);
378     }
379   }
380 }
381 
382 void WebAssemblyAsmPrinter::emitEndOfAsmFile(Module &M) {
383   // This is required to emit external declarations (like .functypes) when
384   // no functions are defined in the compilation unit and therefore,
385   // emitExternalDecls() is not called until now.
386   emitExternalDecls(M);
387 
388   // When a function's address is taken, a TABLE_INDEX relocation is emitted
389   // against the function symbol at the use site.  However the relocation
390   // doesn't explicitly refer to the table.  In the future we may want to
391   // define a new kind of reloc against both the function and the table, so
392   // that the linker can see that the function symbol keeps the table alive,
393   // but for now manually mark the table as live.
394   for (const auto &F : M) {
395     if (!F.isIntrinsic() && F.hasAddressTaken()) {
396       MCSymbolWasm *FunctionTable =
397           WebAssembly::getOrCreateFunctionTableSymbol(OutContext, Subtarget);
398       OutStreamer->emitSymbolAttribute(FunctionTable, MCSA_NoDeadStrip);
399       break;
400     }
401   }
402 
403   for (const auto &G : M.globals()) {
404     if (!G.hasInitializer() && G.hasExternalLinkage() &&
405         !WebAssembly::isWasmVarAddressSpace(G.getAddressSpace()) &&
406         G.getValueType()->isSized()) {
407       uint16_t Size = M.getDataLayout().getTypeAllocSize(G.getValueType());
408       OutStreamer->emitELFSize(getSymbol(&G),
409                                MCConstantExpr::create(Size, OutContext));
410     }
411   }
412 
413   if (const NamedMDNode *Named = M.getNamedMetadata("wasm.custom_sections")) {
414     for (const Metadata *MD : Named->operands()) {
415       const auto *Tuple = dyn_cast<MDTuple>(MD);
416       if (!Tuple || Tuple->getNumOperands() != 2)
417         continue;
418       const MDString *Name = dyn_cast<MDString>(Tuple->getOperand(0));
419       const MDString *Contents = dyn_cast<MDString>(Tuple->getOperand(1));
420       if (!Name || !Contents)
421         continue;
422 
423       OutStreamer->PushSection();
424       std::string SectionName = (".custom_section." + Name->getString()).str();
425       MCSectionWasm *MySection =
426           OutContext.getWasmSection(SectionName, SectionKind::getMetadata());
427       OutStreamer->SwitchSection(MySection);
428       OutStreamer->emitBytes(Contents->getString());
429       OutStreamer->PopSection();
430     }
431   }
432 
433   EmitProducerInfo(M);
434   EmitTargetFeatures(M);
435 }
436 
437 void WebAssemblyAsmPrinter::EmitProducerInfo(Module &M) {
438   llvm::SmallVector<std::pair<std::string, std::string>, 4> Languages;
439   if (const NamedMDNode *Debug = M.getNamedMetadata("llvm.dbg.cu")) {
440     llvm::SmallSet<StringRef, 4> SeenLanguages;
441     for (size_t I = 0, E = Debug->getNumOperands(); I < E; ++I) {
442       const auto *CU = cast<DICompileUnit>(Debug->getOperand(I));
443       StringRef Language = dwarf::LanguageString(CU->getSourceLanguage());
444       Language.consume_front("DW_LANG_");
445       if (SeenLanguages.insert(Language).second)
446         Languages.emplace_back(Language.str(), "");
447     }
448   }
449 
450   llvm::SmallVector<std::pair<std::string, std::string>, 4> Tools;
451   if (const NamedMDNode *Ident = M.getNamedMetadata("llvm.ident")) {
452     llvm::SmallSet<StringRef, 4> SeenTools;
453     for (size_t I = 0, E = Ident->getNumOperands(); I < E; ++I) {
454       const auto *S = cast<MDString>(Ident->getOperand(I)->getOperand(0));
455       std::pair<StringRef, StringRef> Field = S->getString().split("version");
456       StringRef Name = Field.first.trim();
457       StringRef Version = Field.second.trim();
458       if (SeenTools.insert(Name).second)
459         Tools.emplace_back(Name.str(), Version.str());
460     }
461   }
462 
463   int FieldCount = int(!Languages.empty()) + int(!Tools.empty());
464   if (FieldCount != 0) {
465     MCSectionWasm *Producers = OutContext.getWasmSection(
466         ".custom_section.producers", SectionKind::getMetadata());
467     OutStreamer->PushSection();
468     OutStreamer->SwitchSection(Producers);
469     OutStreamer->emitULEB128IntValue(FieldCount);
470     for (auto &Producers : {std::make_pair("language", &Languages),
471             std::make_pair("processed-by", &Tools)}) {
472       if (Producers.second->empty())
473         continue;
474       OutStreamer->emitULEB128IntValue(strlen(Producers.first));
475       OutStreamer->emitBytes(Producers.first);
476       OutStreamer->emitULEB128IntValue(Producers.second->size());
477       for (auto &Producer : *Producers.second) {
478         OutStreamer->emitULEB128IntValue(Producer.first.size());
479         OutStreamer->emitBytes(Producer.first);
480         OutStreamer->emitULEB128IntValue(Producer.second.size());
481         OutStreamer->emitBytes(Producer.second);
482       }
483     }
484     OutStreamer->PopSection();
485   }
486 }
487 
488 void WebAssemblyAsmPrinter::EmitTargetFeatures(Module &M) {
489   struct FeatureEntry {
490     uint8_t Prefix;
491     std::string Name;
492   };
493 
494   // Read target features and linkage policies from module metadata
495   SmallVector<FeatureEntry, 4> EmittedFeatures;
496   auto EmitFeature = [&](std::string Feature) {
497     std::string MDKey = (StringRef("wasm-feature-") + Feature).str();
498     Metadata *Policy = M.getModuleFlag(MDKey);
499     if (Policy == nullptr)
500       return;
501 
502     FeatureEntry Entry;
503     Entry.Prefix = 0;
504     Entry.Name = Feature;
505 
506     if (auto *MD = cast<ConstantAsMetadata>(Policy))
507       if (auto *I = cast<ConstantInt>(MD->getValue()))
508         Entry.Prefix = I->getZExtValue();
509 
510     // Silently ignore invalid metadata
511     if (Entry.Prefix != wasm::WASM_FEATURE_PREFIX_USED &&
512         Entry.Prefix != wasm::WASM_FEATURE_PREFIX_REQUIRED &&
513         Entry.Prefix != wasm::WASM_FEATURE_PREFIX_DISALLOWED)
514       return;
515 
516     EmittedFeatures.push_back(Entry);
517   };
518 
519   for (const SubtargetFeatureKV &KV : WebAssemblyFeatureKV) {
520     EmitFeature(KV.Key);
521   }
522   // This pseudo-feature tells the linker whether shared memory would be safe
523   EmitFeature("shared-mem");
524 
525   // This is an "architecture", not a "feature", but we emit it as such for
526   // the benefit of tools like Binaryen and consistency with other producers.
527   // FIXME: Subtarget is null here, so can't Subtarget->hasAddr64() ?
528   if (M.getDataLayout().getPointerSize() == 8) {
529     // Can't use EmitFeature since "wasm-feature-memory64" is not a module
530     // flag.
531     EmittedFeatures.push_back({wasm::WASM_FEATURE_PREFIX_USED, "memory64"});
532   }
533 
534   if (EmittedFeatures.size() == 0)
535     return;
536 
537   // Emit features and linkage policies into the "target_features" section
538   MCSectionWasm *FeaturesSection = OutContext.getWasmSection(
539       ".custom_section.target_features", SectionKind::getMetadata());
540   OutStreamer->PushSection();
541   OutStreamer->SwitchSection(FeaturesSection);
542 
543   OutStreamer->emitULEB128IntValue(EmittedFeatures.size());
544   for (auto &F : EmittedFeatures) {
545     OutStreamer->emitIntValue(F.Prefix, 1);
546     OutStreamer->emitULEB128IntValue(F.Name.size());
547     OutStreamer->emitBytes(F.Name);
548   }
549 
550   OutStreamer->PopSection();
551 }
552 
553 void WebAssemblyAsmPrinter::emitConstantPool() {
554   emitExternalDecls(*MMI->getModule());
555   assert(MF->getConstantPool()->getConstants().empty() &&
556          "WebAssembly disables constant pools");
557 }
558 
559 void WebAssemblyAsmPrinter::emitJumpTableInfo() {
560   // Nothing to do; jump tables are incorporated into the instruction stream.
561 }
562 
563 void WebAssemblyAsmPrinter::emitFunctionBodyStart() {
564   const Function &F = MF->getFunction();
565   SmallVector<MVT, 1> ResultVTs;
566   SmallVector<MVT, 4> ParamVTs;
567   computeSignatureVTs(F.getFunctionType(), &F, F, TM, ParamVTs, ResultVTs);
568 
569   auto Signature = signatureFromMVTs(ResultVTs, ParamVTs);
570   auto *WasmSym = cast<MCSymbolWasm>(CurrentFnSym);
571   WasmSym->setSignature(Signature.get());
572   addSignature(std::move(Signature));
573   WasmSym->setType(wasm::WASM_SYMBOL_TYPE_FUNCTION);
574 
575   getTargetStreamer()->emitFunctionType(WasmSym);
576 
577   // Emit the function index.
578   if (MDNode *Idx = F.getMetadata("wasm.index")) {
579     assert(Idx->getNumOperands() == 1);
580 
581     getTargetStreamer()->emitIndIdx(AsmPrinter::lowerConstant(
582         cast<ConstantAsMetadata>(Idx->getOperand(0))->getValue()));
583   }
584 
585   SmallVector<wasm::ValType, 16> Locals;
586   valTypesFromMVTs(MFI->getLocals(), Locals);
587   getTargetStreamer()->emitLocal(Locals);
588 
589   AsmPrinter::emitFunctionBodyStart();
590 }
591 
592 void WebAssemblyAsmPrinter::emitInstruction(const MachineInstr *MI) {
593   LLVM_DEBUG(dbgs() << "EmitInstruction: " << *MI << '\n');
594 
595   switch (MI->getOpcode()) {
596   case WebAssembly::ARGUMENT_i32:
597   case WebAssembly::ARGUMENT_i32_S:
598   case WebAssembly::ARGUMENT_i64:
599   case WebAssembly::ARGUMENT_i64_S:
600   case WebAssembly::ARGUMENT_f32:
601   case WebAssembly::ARGUMENT_f32_S:
602   case WebAssembly::ARGUMENT_f64:
603   case WebAssembly::ARGUMENT_f64_S:
604   case WebAssembly::ARGUMENT_v16i8:
605   case WebAssembly::ARGUMENT_v16i8_S:
606   case WebAssembly::ARGUMENT_v8i16:
607   case WebAssembly::ARGUMENT_v8i16_S:
608   case WebAssembly::ARGUMENT_v4i32:
609   case WebAssembly::ARGUMENT_v4i32_S:
610   case WebAssembly::ARGUMENT_v2i64:
611   case WebAssembly::ARGUMENT_v2i64_S:
612   case WebAssembly::ARGUMENT_v4f32:
613   case WebAssembly::ARGUMENT_v4f32_S:
614   case WebAssembly::ARGUMENT_v2f64:
615   case WebAssembly::ARGUMENT_v2f64_S:
616     // These represent values which are live into the function entry, so there's
617     // no instruction to emit.
618     break;
619   case WebAssembly::FALLTHROUGH_RETURN: {
620     // These instructions represent the implicit return at the end of a
621     // function body.
622     if (isVerbose()) {
623       OutStreamer->AddComment("fallthrough-return");
624       OutStreamer->AddBlankLine();
625     }
626     break;
627   }
628   case WebAssembly::COMPILER_FENCE:
629     // This is a compiler barrier that prevents instruction reordering during
630     // backend compilation, and should not be emitted.
631     break;
632   default: {
633     WebAssemblyMCInstLower MCInstLowering(OutContext, *this);
634     MCInst TmpInst;
635     MCInstLowering.lower(MI, TmpInst);
636     EmitToStreamer(*OutStreamer, TmpInst);
637     break;
638   }
639   }
640 }
641 
642 bool WebAssemblyAsmPrinter::PrintAsmOperand(const MachineInstr *MI,
643                                             unsigned OpNo,
644                                             const char *ExtraCode,
645                                             raw_ostream &OS) {
646   // First try the generic code, which knows about modifiers like 'c' and 'n'.
647   if (!AsmPrinter::PrintAsmOperand(MI, OpNo, ExtraCode, OS))
648     return false;
649 
650   if (!ExtraCode) {
651     const MachineOperand &MO = MI->getOperand(OpNo);
652     switch (MO.getType()) {
653     case MachineOperand::MO_Immediate:
654       OS << MO.getImm();
655       return false;
656     case MachineOperand::MO_Register:
657       // FIXME: only opcode that still contains registers, as required by
658       // MachineInstr::getDebugVariable().
659       assert(MI->getOpcode() == WebAssembly::INLINEASM);
660       OS << regToString(MO);
661       return false;
662     case MachineOperand::MO_GlobalAddress:
663       PrintSymbolOperand(MO, OS);
664       return false;
665     case MachineOperand::MO_ExternalSymbol:
666       GetExternalSymbolSymbol(MO.getSymbolName())->print(OS, MAI);
667       printOffset(MO.getOffset(), OS);
668       return false;
669     case MachineOperand::MO_MachineBasicBlock:
670       MO.getMBB()->getSymbol()->print(OS, MAI);
671       return false;
672     default:
673       break;
674     }
675   }
676 
677   return true;
678 }
679 
680 bool WebAssemblyAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
681                                                   unsigned OpNo,
682                                                   const char *ExtraCode,
683                                                   raw_ostream &OS) {
684   // The current approach to inline asm is that "r" constraints are expressed
685   // as local indices, rather than values on the operand stack. This simplifies
686   // using "r" as it eliminates the need to push and pop the values in a
687   // particular order, however it also makes it impossible to have an "m"
688   // constraint. So we don't support it.
689 
690   return AsmPrinter::PrintAsmMemoryOperand(MI, OpNo, ExtraCode, OS);
691 }
692 
693 // Force static initialization.
694 extern "C" LLVM_EXTERNAL_VISIBILITY void LLVMInitializeWebAssemblyAsmPrinter() {
695   RegisterAsmPrinter<WebAssemblyAsmPrinter> X(getTheWebAssemblyTarget32());
696   RegisterAsmPrinter<WebAssemblyAsmPrinter> Y(getTheWebAssemblyTarget64());
697 }
698