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