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> EnableEmException;
55 extern cl::opt<bool> EnableEmSjLj;
56 
57 //===----------------------------------------------------------------------===//
58 // Helpers.
59 //===----------------------------------------------------------------------===//
60 
getRegType(unsigned RegNo) const61 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 
regToString(const MachineOperand & MO)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 
getTargetStreamer()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.
isEmscriptenInvokeName(StringRef Name)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.
getInvokeSig(wasm::ValType VT)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.
getEmscriptenInvokeSymbolName(wasm::WasmSignature * Sig)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 
getMCSymbolForFunction(const Function * F,bool EnableEmEH,wasm::WasmSignature * Sig,bool & InvokeDetected)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 
emitGlobalVariable(const GlobalVariable * GV)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 
getOrCreateWasmSymbol(StringRef Name)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") {
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     // All C++ exceptions are assumed to have a single i32 (for wasm32) or i64
252     // (for wasm64) param type and void return type. The reaon is, all C++
253     // exception values are pointers, and to share the type section with
254     // functions, exceptions are assumed to have void return type.
255     Params.push_back(Subtarget.hasAddr64() ? wasm::ValType::I64
256                                            : wasm::ValType::I32);
257   } else { // Function symbols
258     WasmSym->setType(wasm::WASM_SYMBOL_TYPE_FUNCTION);
259     getLibcallSignature(Subtarget, Name, Returns, Params);
260   }
261   auto Signature = std::make_unique<wasm::WasmSignature>(std::move(Returns),
262                                                          std::move(Params));
263   WasmSym->setSignature(Signature.get());
264   addSignature(std::move(Signature));
265 
266   return WasmSym;
267 }
268 
emitExternalDecls(const Module & M)269 void WebAssemblyAsmPrinter::emitExternalDecls(const Module &M) {
270   if (signaturesEmitted)
271     return;
272   signaturesEmitted = true;
273 
274   // Normally symbols for globals get discovered as the MI gets lowered,
275   // but we need to know about them ahead of time.
276   MachineModuleInfoWasm &MMIW = MMI->getObjFileInfo<MachineModuleInfoWasm>();
277   for (const auto &Name : MMIW.MachineSymbolsUsed) {
278     getOrCreateWasmSymbol(Name.getKey());
279   }
280 
281   for (auto &It : OutContext.getSymbols()) {
282     // Emit .globaltype, .tagtype, or .tabletype declarations.
283     auto Sym = cast<MCSymbolWasm>(It.getValue());
284     if (Sym->getType() == wasm::WASM_SYMBOL_TYPE_GLOBAL) {
285       // .globaltype already handled by emitGlobalVariable for defined
286       // variables; here we make sure the types of external wasm globals get
287       // written to the file.
288       if (Sym->isUndefined())
289         getTargetStreamer()->emitGlobalType(Sym);
290     } else if (Sym->getType() == wasm::WASM_SYMBOL_TYPE_TAG)
291       getTargetStreamer()->emitTagType(Sym);
292     else if (Sym->getType() == wasm::WASM_SYMBOL_TYPE_TABLE)
293       getTargetStreamer()->emitTableType(Sym);
294   }
295 
296   DenseSet<MCSymbol *> InvokeSymbols;
297   for (const auto &F : M) {
298     if (F.isIntrinsic())
299       continue;
300 
301     // Emit function type info for all undefined functions
302     if (F.isDeclarationForLinker()) {
303       SmallVector<MVT, 4> Results;
304       SmallVector<MVT, 4> Params;
305       computeSignatureVTs(F.getFunctionType(), &F, F, TM, Params, Results);
306       // At this point these MCSymbols may or may not have been created already
307       // and thus also contain a signature, but we need to get the signature
308       // anyway here in case it is an invoke that has not yet been created. We
309       // will discard it later if it turns out not to be necessary.
310       auto Signature = signatureFromMVTs(Results, Params);
311       bool InvokeDetected = false;
312       auto *Sym = getMCSymbolForFunction(&F, EnableEmException || EnableEmSjLj,
313                                          Signature.get(), InvokeDetected);
314 
315       // Multiple functions can be mapped to the same invoke symbol. For
316       // example, two IR functions '__invoke_void_i8*' and '__invoke_void_i32'
317       // are both mapped to '__invoke_vi'. We keep them in a set once we emit an
318       // Emscripten EH symbol so we don't emit the same symbol twice.
319       if (InvokeDetected && !InvokeSymbols.insert(Sym).second)
320         continue;
321 
322       Sym->setType(wasm::WASM_SYMBOL_TYPE_FUNCTION);
323       if (!Sym->getSignature()) {
324         Sym->setSignature(Signature.get());
325         addSignature(std::move(Signature));
326       } else {
327         // This symbol has already been created and had a signature. Discard it.
328         Signature.reset();
329       }
330 
331       getTargetStreamer()->emitFunctionType(Sym);
332 
333       if (F.hasFnAttribute("wasm-import-module")) {
334         StringRef Name =
335             F.getFnAttribute("wasm-import-module").getValueAsString();
336         Sym->setImportModule(storeName(Name));
337         getTargetStreamer()->emitImportModule(Sym, Name);
338       }
339       if (F.hasFnAttribute("wasm-import-name")) {
340         // If this is a converted Emscripten EH/SjLj symbol, we shouldn't use
341         // the original function name but the converted symbol name.
342         StringRef Name =
343             InvokeDetected
344                 ? Sym->getName()
345                 : F.getFnAttribute("wasm-import-name").getValueAsString();
346         Sym->setImportName(storeName(Name));
347         getTargetStreamer()->emitImportName(Sym, Name);
348       }
349     }
350 
351     if (F.hasFnAttribute("wasm-export-name")) {
352       auto *Sym = cast<MCSymbolWasm>(getSymbol(&F));
353       StringRef Name = F.getFnAttribute("wasm-export-name").getValueAsString();
354       Sym->setExportName(storeName(Name));
355       getTargetStreamer()->emitExportName(Sym, Name);
356     }
357   }
358 }
359 
emitEndOfAsmFile(Module & M)360 void WebAssemblyAsmPrinter::emitEndOfAsmFile(Module &M) {
361   emitExternalDecls(M);
362 
363   // When a function's address is taken, a TABLE_INDEX relocation is emitted
364   // against the function symbol at the use site.  However the relocation
365   // doesn't explicitly refer to the table.  In the future we may want to
366   // define a new kind of reloc against both the function and the table, so
367   // that the linker can see that the function symbol keeps the table alive,
368   // but for now manually mark the table as live.
369   for (const auto &F : M) {
370     if (!F.isIntrinsic() && F.hasAddressTaken()) {
371       MCSymbolWasm *FunctionTable =
372           WebAssembly::getOrCreateFunctionTableSymbol(OutContext, Subtarget);
373       OutStreamer->emitSymbolAttribute(FunctionTable, MCSA_NoDeadStrip);
374       break;
375     }
376   }
377 
378   for (const auto &G : M.globals()) {
379     if (!G.hasInitializer() && G.hasExternalLinkage() &&
380         !WebAssembly::isWasmVarAddressSpace(G.getAddressSpace()) &&
381         G.getValueType()->isSized()) {
382       uint16_t Size = M.getDataLayout().getTypeAllocSize(G.getValueType());
383       OutStreamer->emitELFSize(getSymbol(&G),
384                                MCConstantExpr::create(Size, OutContext));
385     }
386   }
387 
388   if (const NamedMDNode *Named = M.getNamedMetadata("wasm.custom_sections")) {
389     for (const Metadata *MD : Named->operands()) {
390       const auto *Tuple = dyn_cast<MDTuple>(MD);
391       if (!Tuple || Tuple->getNumOperands() != 2)
392         continue;
393       const MDString *Name = dyn_cast<MDString>(Tuple->getOperand(0));
394       const MDString *Contents = dyn_cast<MDString>(Tuple->getOperand(1));
395       if (!Name || !Contents)
396         continue;
397 
398       OutStreamer->PushSection();
399       std::string SectionName = (".custom_section." + Name->getString()).str();
400       MCSectionWasm *MySection =
401           OutContext.getWasmSection(SectionName, SectionKind::getMetadata());
402       OutStreamer->SwitchSection(MySection);
403       OutStreamer->emitBytes(Contents->getString());
404       OutStreamer->PopSection();
405     }
406   }
407 
408   EmitProducerInfo(M);
409   EmitTargetFeatures(M);
410 }
411 
EmitProducerInfo(Module & M)412 void WebAssemblyAsmPrinter::EmitProducerInfo(Module &M) {
413   llvm::SmallVector<std::pair<std::string, std::string>, 4> Languages;
414   if (const NamedMDNode *Debug = M.getNamedMetadata("llvm.dbg.cu")) {
415     llvm::SmallSet<StringRef, 4> SeenLanguages;
416     for (size_t I = 0, E = Debug->getNumOperands(); I < E; ++I) {
417       const auto *CU = cast<DICompileUnit>(Debug->getOperand(I));
418       StringRef Language = dwarf::LanguageString(CU->getSourceLanguage());
419       Language.consume_front("DW_LANG_");
420       if (SeenLanguages.insert(Language).second)
421         Languages.emplace_back(Language.str(), "");
422     }
423   }
424 
425   llvm::SmallVector<std::pair<std::string, std::string>, 4> Tools;
426   if (const NamedMDNode *Ident = M.getNamedMetadata("llvm.ident")) {
427     llvm::SmallSet<StringRef, 4> SeenTools;
428     for (size_t I = 0, E = Ident->getNumOperands(); I < E; ++I) {
429       const auto *S = cast<MDString>(Ident->getOperand(I)->getOperand(0));
430       std::pair<StringRef, StringRef> Field = S->getString().split("version");
431       StringRef Name = Field.first.trim();
432       StringRef Version = Field.second.trim();
433       if (SeenTools.insert(Name).second)
434         Tools.emplace_back(Name.str(), Version.str());
435     }
436   }
437 
438   int FieldCount = int(!Languages.empty()) + int(!Tools.empty());
439   if (FieldCount != 0) {
440     MCSectionWasm *Producers = OutContext.getWasmSection(
441         ".custom_section.producers", SectionKind::getMetadata());
442     OutStreamer->PushSection();
443     OutStreamer->SwitchSection(Producers);
444     OutStreamer->emitULEB128IntValue(FieldCount);
445     for (auto &Producers : {std::make_pair("language", &Languages),
446             std::make_pair("processed-by", &Tools)}) {
447       if (Producers.second->empty())
448         continue;
449       OutStreamer->emitULEB128IntValue(strlen(Producers.first));
450       OutStreamer->emitBytes(Producers.first);
451       OutStreamer->emitULEB128IntValue(Producers.second->size());
452       for (auto &Producer : *Producers.second) {
453         OutStreamer->emitULEB128IntValue(Producer.first.size());
454         OutStreamer->emitBytes(Producer.first);
455         OutStreamer->emitULEB128IntValue(Producer.second.size());
456         OutStreamer->emitBytes(Producer.second);
457       }
458     }
459     OutStreamer->PopSection();
460   }
461 }
462 
EmitTargetFeatures(Module & M)463 void WebAssemblyAsmPrinter::EmitTargetFeatures(Module &M) {
464   struct FeatureEntry {
465     uint8_t Prefix;
466     std::string Name;
467   };
468 
469   // Read target features and linkage policies from module metadata
470   SmallVector<FeatureEntry, 4> EmittedFeatures;
471   auto EmitFeature = [&](std::string Feature) {
472     std::string MDKey = (StringRef("wasm-feature-") + Feature).str();
473     Metadata *Policy = M.getModuleFlag(MDKey);
474     if (Policy == nullptr)
475       return;
476 
477     FeatureEntry Entry;
478     Entry.Prefix = 0;
479     Entry.Name = Feature;
480 
481     if (auto *MD = cast<ConstantAsMetadata>(Policy))
482       if (auto *I = cast<ConstantInt>(MD->getValue()))
483         Entry.Prefix = I->getZExtValue();
484 
485     // Silently ignore invalid metadata
486     if (Entry.Prefix != wasm::WASM_FEATURE_PREFIX_USED &&
487         Entry.Prefix != wasm::WASM_FEATURE_PREFIX_REQUIRED &&
488         Entry.Prefix != wasm::WASM_FEATURE_PREFIX_DISALLOWED)
489       return;
490 
491     EmittedFeatures.push_back(Entry);
492   };
493 
494   for (const SubtargetFeatureKV &KV : WebAssemblyFeatureKV) {
495     EmitFeature(KV.Key);
496   }
497   // This pseudo-feature tells the linker whether shared memory would be safe
498   EmitFeature("shared-mem");
499 
500   if (EmittedFeatures.size() == 0)
501     return;
502 
503   // Emit features and linkage policies into the "target_features" section
504   MCSectionWasm *FeaturesSection = OutContext.getWasmSection(
505       ".custom_section.target_features", SectionKind::getMetadata());
506   OutStreamer->PushSection();
507   OutStreamer->SwitchSection(FeaturesSection);
508 
509   OutStreamer->emitULEB128IntValue(EmittedFeatures.size());
510   for (auto &F : EmittedFeatures) {
511     OutStreamer->emitIntValue(F.Prefix, 1);
512     OutStreamer->emitULEB128IntValue(F.Name.size());
513     OutStreamer->emitBytes(F.Name);
514   }
515 
516   OutStreamer->PopSection();
517 }
518 
emitConstantPool()519 void WebAssemblyAsmPrinter::emitConstantPool() {
520   assert(MF->getConstantPool()->getConstants().empty() &&
521          "WebAssembly disables constant pools");
522 }
523 
emitJumpTableInfo()524 void WebAssemblyAsmPrinter::emitJumpTableInfo() {
525   // Nothing to do; jump tables are incorporated into the instruction stream.
526 }
527 
emitLinkage(const GlobalValue * GV,MCSymbol * Sym) const528 void WebAssemblyAsmPrinter::emitLinkage(const GlobalValue *GV, MCSymbol *Sym)
529   const {
530   AsmPrinter::emitLinkage(GV, Sym);
531   // This gets called before the function label and type are emitted.
532   // We use it to emit signatures of external functions.
533   // FIXME casts!
534   const_cast<WebAssemblyAsmPrinter *>(this)
535     ->emitExternalDecls(*MMI->getModule());
536 }
537 
538 
emitFunctionBodyStart()539 void WebAssemblyAsmPrinter::emitFunctionBodyStart() {
540   const Function &F = MF->getFunction();
541   SmallVector<MVT, 1> ResultVTs;
542   SmallVector<MVT, 4> ParamVTs;
543   computeSignatureVTs(F.getFunctionType(), &F, F, TM, ParamVTs, ResultVTs);
544 
545   auto Signature = signatureFromMVTs(ResultVTs, ParamVTs);
546   auto *WasmSym = cast<MCSymbolWasm>(CurrentFnSym);
547   WasmSym->setSignature(Signature.get());
548   addSignature(std::move(Signature));
549   WasmSym->setType(wasm::WASM_SYMBOL_TYPE_FUNCTION);
550 
551   getTargetStreamer()->emitFunctionType(WasmSym);
552 
553   // Emit the function index.
554   if (MDNode *Idx = F.getMetadata("wasm.index")) {
555     assert(Idx->getNumOperands() == 1);
556 
557     getTargetStreamer()->emitIndIdx(AsmPrinter::lowerConstant(
558         cast<ConstantAsMetadata>(Idx->getOperand(0))->getValue()));
559   }
560 
561   SmallVector<wasm::ValType, 16> Locals;
562   valTypesFromMVTs(MFI->getLocals(), Locals);
563   getTargetStreamer()->emitLocal(Locals);
564 
565   AsmPrinter::emitFunctionBodyStart();
566 }
567 
emitInstruction(const MachineInstr * MI)568 void WebAssemblyAsmPrinter::emitInstruction(const MachineInstr *MI) {
569   LLVM_DEBUG(dbgs() << "EmitInstruction: " << *MI << '\n');
570 
571   switch (MI->getOpcode()) {
572   case WebAssembly::ARGUMENT_i32:
573   case WebAssembly::ARGUMENT_i32_S:
574   case WebAssembly::ARGUMENT_i64:
575   case WebAssembly::ARGUMENT_i64_S:
576   case WebAssembly::ARGUMENT_f32:
577   case WebAssembly::ARGUMENT_f32_S:
578   case WebAssembly::ARGUMENT_f64:
579   case WebAssembly::ARGUMENT_f64_S:
580   case WebAssembly::ARGUMENT_v16i8:
581   case WebAssembly::ARGUMENT_v16i8_S:
582   case WebAssembly::ARGUMENT_v8i16:
583   case WebAssembly::ARGUMENT_v8i16_S:
584   case WebAssembly::ARGUMENT_v4i32:
585   case WebAssembly::ARGUMENT_v4i32_S:
586   case WebAssembly::ARGUMENT_v2i64:
587   case WebAssembly::ARGUMENT_v2i64_S:
588   case WebAssembly::ARGUMENT_v4f32:
589   case WebAssembly::ARGUMENT_v4f32_S:
590   case WebAssembly::ARGUMENT_v2f64:
591   case WebAssembly::ARGUMENT_v2f64_S:
592     // These represent values which are live into the function entry, so there's
593     // no instruction to emit.
594     break;
595   case WebAssembly::FALLTHROUGH_RETURN: {
596     // These instructions represent the implicit return at the end of a
597     // function body.
598     if (isVerbose()) {
599       OutStreamer->AddComment("fallthrough-return");
600       OutStreamer->AddBlankLine();
601     }
602     break;
603   }
604   case WebAssembly::COMPILER_FENCE:
605     // This is a compiler barrier that prevents instruction reordering during
606     // backend compilation, and should not be emitted.
607     break;
608   default: {
609     WebAssemblyMCInstLower MCInstLowering(OutContext, *this);
610     MCInst TmpInst;
611     MCInstLowering.lower(MI, TmpInst);
612     EmitToStreamer(*OutStreamer, TmpInst);
613     break;
614   }
615   }
616 }
617 
PrintAsmOperand(const MachineInstr * MI,unsigned OpNo,const char * ExtraCode,raw_ostream & OS)618 bool WebAssemblyAsmPrinter::PrintAsmOperand(const MachineInstr *MI,
619                                             unsigned OpNo,
620                                             const char *ExtraCode,
621                                             raw_ostream &OS) {
622   // First try the generic code, which knows about modifiers like 'c' and 'n'.
623   if (!AsmPrinter::PrintAsmOperand(MI, OpNo, ExtraCode, OS))
624     return false;
625 
626   if (!ExtraCode) {
627     const MachineOperand &MO = MI->getOperand(OpNo);
628     switch (MO.getType()) {
629     case MachineOperand::MO_Immediate:
630       OS << MO.getImm();
631       return false;
632     case MachineOperand::MO_Register:
633       // FIXME: only opcode that still contains registers, as required by
634       // MachineInstr::getDebugVariable().
635       assert(MI->getOpcode() == WebAssembly::INLINEASM);
636       OS << regToString(MO);
637       return false;
638     case MachineOperand::MO_GlobalAddress:
639       PrintSymbolOperand(MO, OS);
640       return false;
641     case MachineOperand::MO_ExternalSymbol:
642       GetExternalSymbolSymbol(MO.getSymbolName())->print(OS, MAI);
643       printOffset(MO.getOffset(), OS);
644       return false;
645     case MachineOperand::MO_MachineBasicBlock:
646       MO.getMBB()->getSymbol()->print(OS, MAI);
647       return false;
648     default:
649       break;
650     }
651   }
652 
653   return true;
654 }
655 
PrintAsmMemoryOperand(const MachineInstr * MI,unsigned OpNo,const char * ExtraCode,raw_ostream & OS)656 bool WebAssemblyAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
657                                                   unsigned OpNo,
658                                                   const char *ExtraCode,
659                                                   raw_ostream &OS) {
660   // The current approach to inline asm is that "r" constraints are expressed
661   // as local indices, rather than values on the operand stack. This simplifies
662   // using "r" as it eliminates the need to push and pop the values in a
663   // particular order, however it also makes it impossible to have an "m"
664   // constraint. So we don't support it.
665 
666   return AsmPrinter::PrintAsmMemoryOperand(MI, OpNo, ExtraCode, OS);
667 }
668 
669 // Force static initialization.
LLVMInitializeWebAssemblyAsmPrinter()670 extern "C" LLVM_EXTERNAL_VISIBILITY void LLVMInitializeWebAssemblyAsmPrinter() {
671   RegisterAsmPrinter<WebAssemblyAsmPrinter> X(getTheWebAssemblyTarget32());
672   RegisterAsmPrinter<WebAssemblyAsmPrinter> Y(getTheWebAssemblyTarget64());
673 }
674