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/WebAssemblyMCAsmInfo.h"
18#include "MCTargetDesc/WebAssemblyMCTargetDesc.h"
19#include "MCTargetDesc/WebAssemblyTargetStreamer.h"
20#include "TargetInfo/WebAssemblyTargetInfo.h"
21#include "Utils/WebAssemblyTypeUtilities.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 "WebAssemblyUtilities.h"
29#include "llvm/ADT/MapVector.h"
30#include "llvm/ADT/SmallSet.h"
31#include "llvm/ADT/StringExtras.h"
32#include "llvm/Analysis/ValueTracking.h"
33#include "llvm/BinaryFormat/Wasm.h"
34#include "llvm/CodeGen/Analysis.h"
35#include "llvm/CodeGen/AsmPrinter.h"
36#include "llvm/CodeGen/AsmPrinterAnalysis.h"
37#include "llvm/CodeGen/MachineConstantPool.h"
38#include "llvm/CodeGen/MachineFunction.h"
39#include "llvm/CodeGen/MachineFunctionAnalysisManager.h"
40#include "llvm/CodeGen/MachineInstr.h"
41#include "llvm/CodeGen/MachineModuleInfoImpls.h"
42#include "llvm/CodeGen/MachinePassManager.h"
43#include "llvm/IR/Analysis.h"
44#include "llvm/IR/DataLayout.h"
45#include "llvm/IR/DebugInfoMetadata.h"
46#include "llvm/IR/GlobalVariable.h"
47#include "llvm/IR/Metadata.h"
48#include "llvm/IR/Module.h"
49#include "llvm/IR/PassManager.h"
50#include "llvm/MC/MCContext.h"
51#include "llvm/MC/MCSectionWasm.h"
52#include "llvm/MC/MCStreamer.h"
53#include "llvm/MC/MCSymbol.h"
54#include "llvm/MC/MCSymbolWasm.h"
55#include "llvm/MC/TargetRegistry.h"
56#include "llvm/Support/Compiler.h"
57#include "llvm/Support/Debug.h"
58#include "llvm/Support/raw_ostream.h"
59
60using namespace llvm;
61
62#define DEBUG_TYPE "asm-printer"
63
64extern cl::opt<bool> WasmKeepRegisters;
65
66//===----------------------------------------------------------------------===//
67// Helpers.
68//===----------------------------------------------------------------------===//
69
70MVT WebAssemblyAsmPrinter::getRegType(unsigned RegNo) const {
71 const TargetRegisterInfo *TRI = Subtarget->getRegisterInfo();
72 const TargetRegisterClass *TRC = MRI->getRegClass(Reg: RegNo);
73 for (MVT T : {MVT::i32, MVT::i64, MVT::f32, MVT::f64, MVT::v16i8, MVT::v8i16,
74 MVT::v4i32, MVT::v2i64, MVT::v4f32, MVT::v2f64, MVT::v8f16})
75 if (TRI->isTypeLegalForClass(RC: *TRC, T))
76 return T;
77 LLVM_DEBUG(errs() << "Unknown type for register number: " << RegNo);
78 llvm_unreachable("Unknown register type");
79 return MVT::Other;
80}
81
82std::string WebAssemblyAsmPrinter::regToString(const MachineOperand &MO) {
83 Register RegNo = MO.getReg();
84 assert(RegNo.isVirtual() &&
85 "Unlowered physical register encountered during assembly printing");
86 assert(!MFI->isVRegStackified(RegNo));
87 unsigned WAReg = MFI->getWAReg(VReg: RegNo);
88 assert(WAReg != WebAssembly::UnusedReg);
89 return '$' + utostr(X: WAReg);
90}
91
92WebAssemblyTargetStreamer *WebAssemblyAsmPrinter::getTargetStreamer() {
93 MCTargetStreamer *TS = OutStreamer->getTargetStreamer();
94 return static_cast<WebAssemblyTargetStreamer *>(TS);
95}
96
97// Emscripten exception handling helpers
98//
99// This converts invoke names generated by LowerEmscriptenEHSjLj to real names
100// that are expected by JavaScript glue code. The invoke names generated by
101// Emscripten JS glue code are based on their argument and return types; for
102// example, for a function that takes an i32 and returns nothing, it is
103// 'invoke_vi'. But the format of invoke generated by LowerEmscriptenEHSjLj pass
104// contains a mangled string generated from their IR types, for example,
105// "__invoke_void_%struct.mystruct*_int", because final wasm types are not
106// available in the IR pass. So we convert those names to the form that
107// Emscripten JS code expects.
108//
109// Refer to LowerEmscriptenEHSjLj pass for more details.
110
111// Returns true if the given function name is an invoke name generated by
112// LowerEmscriptenEHSjLj pass.
113static bool isEmscriptenInvokeName(StringRef Name) {
114 if (Name.front() == '"' && Name.back() == '"')
115 Name = Name.substr(Start: 1, N: Name.size() - 2);
116 return Name.starts_with(Prefix: "__invoke_");
117}
118
119// Returns a character that represents the given wasm value type in invoke
120// signatures.
121static char getInvokeSig(wasm::ValType VT) {
122 switch (VT) {
123 case wasm::ValType::I32:
124 return 'i';
125 case wasm::ValType::I64:
126 return 'j';
127 case wasm::ValType::F32:
128 return 'f';
129 case wasm::ValType::F64:
130 return 'd';
131 case wasm::ValType::V128:
132 return 'V';
133 case wasm::ValType::FUNCREF:
134 return 'F';
135 case wasm::ValType::EXTERNREF:
136 return 'X';
137 case wasm::ValType::EXNREF:
138 return 'E';
139 default:
140 llvm_unreachable("Unhandled wasm::ValType enum");
141 }
142}
143
144// Given the wasm signature, generate the invoke name in the format JS glue code
145// expects.
146static std::string getEmscriptenInvokeSymbolName(wasm::WasmSignature *Sig) {
147 assert(Sig->Returns.size() <= 1);
148 std::string Ret = "invoke_";
149 if (!Sig->Returns.empty())
150 for (auto VT : Sig->Returns)
151 Ret += getInvokeSig(VT);
152 else
153 Ret += 'v';
154 // Invokes' first argument is a pointer to the original function, so skip it
155 for (unsigned I = 1, E = Sig->Params.size(); I < E; I++)
156 Ret += getInvokeSig(VT: Sig->Params[I]);
157 return Ret;
158}
159
160//===----------------------------------------------------------------------===//
161// WebAssemblyAsmPrinter Implementation.
162//===----------------------------------------------------------------------===//
163
164MCSymbolWasm *WebAssemblyAsmPrinter::getMCSymbolForFunction(
165 const Function *F, wasm::WasmSignature *Sig, bool &InvokeDetected) {
166 MCSymbolWasm *WasmSym = nullptr;
167
168 ExceptionHandling EM = F->getParent()->getExceptionModel();
169 const bool EnableEmEH =
170 EM == ExceptionHandling::Emscripten || WebAssembly::WasmEnableEmSjLj;
171 if (EnableEmEH && isEmscriptenInvokeName(Name: F->getName())) {
172 assert(Sig);
173 InvokeDetected = true;
174 if (Sig->Returns.size() > 1) {
175 std::string Msg =
176 "Emscripten EH/SjLj does not support multivalue returns: " +
177 std::string(F->getName()) + ": " +
178 WebAssembly::signatureToString(Sig);
179 report_fatal_error(reason: Twine(Msg));
180 }
181 WasmSym = static_cast<MCSymbolWasm *>(
182 GetExternalSymbolSymbol(Sym: getEmscriptenInvokeSymbolName(Sig)));
183 } else {
184 WasmSym = static_cast<MCSymbolWasm *>(getSymbol(GV: F));
185 }
186 return WasmSym;
187}
188
189void WebAssemblyAsmPrinter::emitGlobalVariable(const GlobalVariable *GV) {
190 if (GV->hasAttribute(Kind: "wasm-import-module") ||
191 GV->hasAttribute(Kind: "wasm-import-name")) {
192 if (!GV->isDeclaration()) {
193 OutContext.reportError(L: SMLoc(), Msg: "definition of global '" + GV->getName() +
194 "' cannot have import attribute");
195 return;
196 }
197 if (!WebAssembly::isWasmVarAddressSpace(AS: GV->getAddressSpace())) {
198 OutContext.reportError(L: SMLoc(),
199 Msg: "imported global '" + GV->getName() +
200 "' must be in a wasm variable address space");
201 return;
202 }
203 }
204 if (!WebAssembly::isWasmVarAddressSpace(AS: GV->getAddressSpace())) {
205 if (GV->hasAttribute(Kind: "wasm-export-name")) {
206 auto *Sym = static_cast<MCSymbolWasm *>(getSymbol(GV));
207 StringRef Name = GV->getAttribute(Kind: "wasm-export-name").getValueAsString();
208 Sym->setExportName(OutContext.allocateString(s: Name));
209 getTargetStreamer()->emitExportName(Sym, ExportName: Name);
210 }
211 AsmPrinter::emitGlobalVariable(GV);
212 return;
213 }
214
215 assert(!GV->isThreadLocal());
216 auto *Sym = static_cast<MCSymbolWasm *>(getSymbol(GV));
217 if (!Sym->getType()) {
218 SmallVector<MVT, 1> VTs;
219 Type *GlobalVT = GV->getValueType();
220 // Function-specific subtargets are not needed here: WebAssembly
221 // coalesces features before isel, so use the TargetMachine's
222 // module-wide subtarget to compute legal value types.
223 auto &WasmTM = static_cast<const WebAssemblyTargetMachine &>(TM);
224 const WebAssemblySubtarget *ST = WasmTM.getSubtargetImpl(
225 CPU: WasmTM.getTargetCPU(), FS: WasmTM.getTargetFeatureString(),
226 ABIName: WasmTM.getTargetABIName(M: *GV->getParent()));
227 const WebAssemblyTargetLowering &TLI = *ST->getTargetLowering();
228 computeLegalValueVTs(TLI, Ctx&: GV->getParent()->getContext(),
229 DL: GV->getDataLayout(), Ty: GlobalVT, ValueVTs&: VTs);
230
231 WebAssembly::wasmSymbolSetType(Sym, GlobalVT, VTs,
232 /*Mutable=*/!GV->isConstant());
233 }
234
235 emitVisibility(Sym, Visibility: GV->getVisibility(), IsDefinition: !GV->isDeclaration());
236 emitSymbolType(Sym);
237 if (GV->isDeclaration()) {
238 if (GV->hasAttribute(Kind: "wasm-import-module")) {
239 StringRef ImportModule =
240 GV->getAttribute(Kind: "wasm-import-module").getValueAsString();
241 Sym->setImportModule(OutContext.allocateString(s: ImportModule));
242 getTargetStreamer()->emitImportModule(Sym, ImportModule);
243 }
244 if (GV->hasAttribute(Kind: "wasm-import-name")) {
245 StringRef ImportName =
246 GV->getAttribute(Kind: "wasm-import-name").getValueAsString();
247 Sym->setImportName(OutContext.allocateString(s: ImportName));
248 getTargetStreamer()->emitImportName(Sym, ImportName);
249 }
250 }
251 if (GV->hasInitializer()) {
252 assert(getSymbolPreferLocal(*GV) == Sym);
253 emitLinkage(GV, GVSym: Sym);
254 OutStreamer->emitLabel(Symbol: Sym);
255 if (GV->hasAttribute(Kind: "wasm-export-name")) {
256 StringRef ExportName =
257 GV->getAttribute(Kind: "wasm-export-name").getValueAsString();
258 Sym->setExportName(OutContext.allocateString(s: ExportName));
259 getTargetStreamer()->emitExportName(Sym, ExportName);
260 }
261 // TODO: Actually emit the initializer value. Otherwise the global has the
262 // default value for its type (0, ref.null, etc).
263 OutStreamer->addBlankLine();
264 }
265}
266
267MCSymbol *WebAssemblyAsmPrinter::getOrCreateWasmSymbol(StringRef Name) {
268 auto *WasmSym = static_cast<MCSymbolWasm *>(GetExternalSymbolSymbol(Sym: Name));
269 // May be called multiple times, so early out.
270 if (WasmSym->getType())
271 return WasmSym;
272
273 const WebAssemblySubtarget &Subtarget = getSubtarget();
274
275 // Except for certain known symbols, all symbols used by CodeGen are
276 // functions. It's OK to hardcode knowledge of specific symbols here; this
277 // method is precisely there for fetching the signatures of known
278 // Clang-provided symbols.
279 if (Name == "__stack_pointer" || Name == "__tls_base" ||
280 Name == "__memory_base" || Name == "__table_base" ||
281 Name == "__tls_size" || Name == "__tls_align") {
282 bool Mutable = Name == "__stack_pointer" || Name == "__tls_base";
283 WasmSym->setType(wasm::WASM_SYMBOL_TYPE_GLOBAL);
284 WasmSym->setGlobalType(wasm::WasmGlobalType{
285 .Type: uint8_t(Subtarget.hasAddr64() ? wasm::WASM_TYPE_I64
286 : wasm::WASM_TYPE_I32),
287 .Mutable: Mutable});
288 return WasmSym;
289 }
290
291 if (Name.starts_with(Prefix: "GCC_except_table")) {
292 WasmSym->setType(wasm::WASM_SYMBOL_TYPE_DATA);
293 return WasmSym;
294 }
295
296 SmallVector<wasm::ValType, 4> Returns;
297 SmallVector<wasm::ValType, 4> Params;
298 if (Name == "__cpp_exception" || Name == "__c_longjmp") {
299 WasmSym->setType(wasm::WASM_SYMBOL_TYPE_TAG);
300 WasmSym->setExternal(true);
301
302 // Currently both C++ exceptions and C longjmps have a single pointer type
303 // param. For C++ exceptions it is a pointer to an exception object, and for
304 // C longjmps it is pointer to a struct that contains a setjmp buffer and a
305 // longjmp return value. We may consider using multiple value parameters for
306 // longjmps later when multivalue support is ready.
307 wasm::ValType AddrType =
308 Subtarget.hasAddr64() ? wasm::ValType::I64 : wasm::ValType::I32;
309 Params.push_back(Elt: AddrType);
310 } else if (Name == "__wasm_get_stack_pointer" ||
311 Name == "__wasm_get_tls_base") {
312 WasmSym->setType(wasm::WASM_SYMBOL_TYPE_FUNCTION);
313 Returns.push_back(Elt: wasm::ValType::I32);
314 } else if (Name == "__wasm_set_stack_pointer" ||
315 Name == "__wasm_set_tls_base") {
316 WasmSym->setType(wasm::WASM_SYMBOL_TYPE_FUNCTION);
317 Params.push_back(Elt: wasm::ValType::I32);
318 } else { // Function symbols
319 WasmSym->setType(wasm::WASM_SYMBOL_TYPE_FUNCTION);
320 WebAssembly::getLibcallSignature(Subtarget, Name, Rets&: Returns, Params);
321 }
322 auto Signature = OutContext.createWasmSignature();
323 Signature->Returns = std::move(Returns);
324 Signature->Params = std::move(Params);
325 WasmSym->setSignature(Signature);
326
327 return WasmSym;
328}
329
330void WebAssemblyAsmPrinter::emitSymbolType(const MCSymbolWasm *Sym) {
331 std::optional<wasm::WasmSymbolType> WasmTy = Sym->getType();
332 if (!WasmTy)
333 return;
334
335 switch (*WasmTy) {
336 case wasm::WASM_SYMBOL_TYPE_GLOBAL:
337 getTargetStreamer()->emitGlobalType(Sym);
338 break;
339 case wasm::WASM_SYMBOL_TYPE_TAG:
340 getTargetStreamer()->emitTagType(Sym);
341 break;
342 case wasm::WASM_SYMBOL_TYPE_TABLE:
343 getTargetStreamer()->emitTableType(Sym);
344 break;
345 default:
346 break; // We only handle globals, tags and tables here
347 }
348}
349
350void WebAssemblyAsmPrinter::emitDecls(const Module &M) {
351 if (signaturesEmitted)
352 return;
353 signaturesEmitted = true;
354
355 // Normally symbols for globals get discovered as the MI gets lowered,
356 // but we need to know about them ahead of time. This will however,
357 // only find symbols that have been used. Unused symbols from globals will
358 // not be found here.
359 MachineModuleInfoWasm &MMIW = MMI->getObjFileInfo<MachineModuleInfoWasm>();
360 for (StringRef Name : MMIW.MachineSymbolsUsed) {
361 auto *WasmSym = static_cast<MCSymbolWasm *>(getOrCreateWasmSymbol(Name));
362 if (WasmSym->isFunction()) {
363 // TODO(wvo): is there any case where this overlaps with the call to
364 // emitFunctionType in the loop below?
365 getTargetStreamer()->emitFunctionType(Sym: WasmSym);
366 }
367 }
368
369 for (auto &It : OutContext.getSymbols()) {
370 // Emit .globaltype, .tagtype, or .tabletype declarations for extern
371 // declarations, i.e. those that have only been declared (but not defined)
372 // in the current module
373 auto Sym = static_cast<MCSymbolWasm *>(It.getValue().Symbol);
374 if (Sym && !Sym->isDefined())
375 emitSymbolType(Sym);
376 }
377
378 // We handle `__funcref_call_table` specially here.
379 //
380 // Unlike most table symbols, which are attached to a `GlobalVariable`
381 // this one is a directly created, freestanding MCSymbol, much like
382 // `__indirect_function_table`. However, given that the table is always
383 // identical (single element, default initialized), we declare it
384 // weak in each object, and define it here rather than in the linker.
385 //
386 // TODO: consider moving this definition elsewhere, or doing away with
387 // the table entirely (in favor of `call_ref` exclusively).
388 {
389 StringRef Name = "__funcref_call_table";
390 auto *Sym = static_cast<MCSymbolWasm *>(OutContext.lookupSymbol(Name));
391 if (Sym) {
392 if (!Sym->isFunctionTable())
393 OutContext.reportError(L: SMLoc(), Msg: "symbol is not a wasm funcref table");
394
395 // symbol is declared weak in `getOrCreateFuncrefCallTableSymbol`
396 assert(Sym->isWeak());
397 OutStreamer->emitSymbolAttribute(Symbol: Sym, Attribute: MCSA_Weak);
398
399 // Make sure we haven't already emitted it for whatever reason.
400 assert(!Sym->isDefined());
401
402 // Actually define the symbol.
403 // Confusingly enough, `emitLabel` is what "defines" a MCSymbol.
404 // Provides it a fragment, so that it `!isUndefined`
405 OutStreamer->emitLabel(Symbol: Sym);
406 // No initializer needed. Default ref.null is good
407 OutStreamer->addBlankLine();
408 }
409 }
410
411 DenseSet<MCSymbol *> InvokeSymbols;
412 for (const auto &F : M) {
413 if (F.isIntrinsic())
414 continue;
415
416 // Emit function type info for all functions. This will emit duplicate
417 // information for defined functions (which already have function type
418 // info emitted alongside their definition), but this is necessary in
419 // order to enable the single-pass WebAssemblyAsmTypeCheck to succeed.
420 SmallVector<MVT, 4> Results;
421 SmallVector<MVT, 4> Params;
422 computeSignatureVTs(Ty: F.getFunctionType(), TargetFunc: &F, ContextFunc: F, TM, Params, Results);
423 // At this point these MCSymbols may or may not have been created already
424 // and thus also contain a signature, but we need to get the signature
425 // anyway here in case it is an invoke that has not yet been created. We
426 // will discard it later if it turns out not to be necessary.
427 auto Signature = signatureFromMVTs(Ctx&: OutContext, Results, Params);
428 bool InvokeDetected = false;
429 auto *Sym = getMCSymbolForFunction(F: &F, Sig: Signature, InvokeDetected);
430
431 // Multiple functions can be mapped to the same invoke symbol. For
432 // example, two IR functions '__invoke_void_i8*' and '__invoke_void_i32'
433 // are both mapped to '__invoke_vi'. We keep them in a set once we emit an
434 // Emscripten EH symbol so we don't emit the same symbol twice.
435 if (InvokeDetected && !InvokeSymbols.insert(V: Sym).second)
436 continue;
437
438 Sym->setType(wasm::WASM_SYMBOL_TYPE_FUNCTION);
439 if (!Sym->getSignature()) {
440 Sym->setSignature(Signature);
441 }
442
443 getTargetStreamer()->emitFunctionType(Sym);
444
445 if (F.hasFnAttribute(Kind: "wasm-import-module")) {
446 StringRef Name =
447 F.getFnAttribute(Kind: "wasm-import-module").getValueAsString();
448 Sym->setImportModule(OutContext.allocateString(s: Name));
449 getTargetStreamer()->emitImportModule(Sym, ImportModule: Name);
450 }
451 if (F.hasFnAttribute(Kind: "wasm-import-name")) {
452 // If this is a converted Emscripten EH/SjLj symbol, we shouldn't use
453 // the original function name but the converted symbol name.
454 StringRef Name =
455 InvokeDetected
456 ? Sym->getName()
457 : F.getFnAttribute(Kind: "wasm-import-name").getValueAsString();
458 Sym->setImportName(OutContext.allocateString(s: Name));
459 getTargetStreamer()->emitImportName(Sym, ImportName: Name);
460 }
461
462 if (F.hasFnAttribute(Kind: "wasm-export-name")) {
463 auto *Sym = static_cast<MCSymbolWasm *>(getSymbol(GV: &F));
464 StringRef Name = F.getFnAttribute(Kind: "wasm-export-name").getValueAsString();
465 Sym->setExportName(OutContext.allocateString(s: Name));
466 getTargetStreamer()->emitExportName(Sym, ExportName: Name);
467 }
468 }
469}
470
471void WebAssemblyAsmPrinter::emitEndOfAsmFile(Module &M) {
472 // This is required to emit external declarations (like .functypes) when
473 // no functions are defined in the compilation unit and therefore,
474 // emitDecls() is not called until now.
475 emitDecls(M);
476
477 // When a function's address is taken, a TABLE_INDEX relocation is emitted
478 // against the function symbol at the use site. However the relocation
479 // doesn't explicitly refer to the table. In the future we may want to
480 // define a new kind of reloc against both the function and the table, so
481 // that the linker can see that the function symbol keeps the table alive,
482 // but for now manually mark the table as live.
483 for (const auto &F : M) {
484 if (!F.isIntrinsic() && F.hasAddressTaken()) {
485 MCSymbolWasm *FunctionTable =
486 WebAssembly::getOrCreateFunctionTableSymbol(Ctx&: OutContext, Subtarget);
487 OutStreamer->emitSymbolAttribute(Symbol: FunctionTable, Attribute: MCSA_NoDeadStrip);
488 break;
489 }
490 }
491
492 for (const auto &G : M.globals()) {
493 if (!G.hasInitializer() && G.hasExternalLinkage() &&
494 !WebAssembly::isWasmVarAddressSpace(AS: G.getAddressSpace()) &&
495 G.getValueType()->isSized()) {
496 uint16_t Size = G.getGlobalSize(DL: M.getDataLayout());
497 OutStreamer->emitELFSize(Symbol: getSymbol(GV: &G),
498 Value: MCConstantExpr::create(Value: Size, Ctx&: OutContext));
499 }
500 }
501
502 if (const NamedMDNode *Named = M.getNamedMetadata(Name: "wasm.custom_sections")) {
503 for (const Metadata *MD : Named->operands()) {
504 const auto *Tuple = dyn_cast<MDTuple>(Val: MD);
505 if (!Tuple || Tuple->getNumOperands() != 2)
506 continue;
507 const MDString *Name = dyn_cast<MDString>(Val: Tuple->getOperand(I: 0));
508 const MDString *Contents = dyn_cast<MDString>(Val: Tuple->getOperand(I: 1));
509 if (!Name || !Contents)
510 continue;
511
512 OutStreamer->pushSection();
513 std::string SectionName = (".custom_section." + Name->getString()).str();
514 MCSectionWasm *MySection =
515 OutContext.getWasmSection(Section: SectionName, K: SectionKind::getMetadata());
516 OutStreamer->switchSection(Section: MySection);
517 OutStreamer->emitBytes(Data: Contents->getString());
518 OutStreamer->popSection();
519 }
520 }
521
522 EmitProducerInfo(M);
523 EmitTargetFeatures(M);
524 EmitFunctionAttributes(M);
525}
526
527void WebAssemblyAsmPrinter::EmitProducerInfo(Module &M) {
528 llvm::SmallVector<std::pair<std::string, std::string>, 4> Languages;
529 if (const NamedMDNode *Debug = M.getNamedMetadata(Name: "llvm.dbg.cu")) {
530 llvm::SmallSet<StringRef, 4> SeenLanguages;
531 for (size_t I = 0, E = Debug->getNumOperands(); I < E; ++I) {
532 const auto *CU = cast<DICompileUnit>(Val: Debug->getOperand(i: I));
533 StringRef Language =
534 dwarf::LanguageString(Language: CU->getSourceLanguage().getUnversionedName());
535
536 Language.consume_front(Prefix: "DW_LANG_");
537 if (SeenLanguages.insert(V: Language).second)
538 Languages.emplace_back(Args: Language.str(), Args: "");
539 }
540 }
541
542 llvm::SmallVector<std::pair<std::string, std::string>, 4> Tools;
543 if (const NamedMDNode *Ident = M.getNamedMetadata(Name: "llvm.ident")) {
544 llvm::SmallSet<StringRef, 4> SeenTools;
545 for (size_t I = 0, E = Ident->getNumOperands(); I < E; ++I) {
546 const auto *S = cast<MDString>(Val: Ident->getOperand(i: I)->getOperand(I: 0));
547 std::pair<StringRef, StringRef> Field = S->getString().split(Separator: "version");
548 StringRef Name = Field.first.trim();
549 StringRef Version = Field.second.trim();
550 if (SeenTools.insert(V: Name).second)
551 Tools.emplace_back(Args: Name.str(), Args: Version.str());
552 }
553 }
554
555 int FieldCount = int(!Languages.empty()) + int(!Tools.empty());
556 if (FieldCount != 0) {
557 MCSectionWasm *Producers = OutContext.getWasmSection(
558 Section: ".custom_section.producers", K: SectionKind::getMetadata());
559 OutStreamer->pushSection();
560 OutStreamer->switchSection(Section: Producers);
561 OutStreamer->emitULEB128IntValue(Value: FieldCount);
562 for (auto &Producers : {std::make_pair(x: "language", y: &Languages),
563 std::make_pair(x: "processed-by", y: &Tools)}) {
564 if (Producers.second->empty())
565 continue;
566 OutStreamer->emitULEB128IntValue(Value: strlen(s: Producers.first));
567 OutStreamer->emitBytes(Data: Producers.first);
568 OutStreamer->emitULEB128IntValue(Value: Producers.second->size());
569 for (auto &Producer : *Producers.second) {
570 OutStreamer->emitULEB128IntValue(Value: Producer.first.size());
571 OutStreamer->emitBytes(Data: Producer.first);
572 OutStreamer->emitULEB128IntValue(Value: Producer.second.size());
573 OutStreamer->emitBytes(Data: Producer.second);
574 }
575 }
576 OutStreamer->popSection();
577 }
578}
579
580void WebAssemblyAsmPrinter::EmitTargetFeatures(Module &M) {
581 struct FeatureEntry {
582 uint8_t Prefix;
583 std::string Name;
584 };
585
586 // Read target features and linkage policies from module metadata
587 SmallVector<FeatureEntry, 4> EmittedFeatures;
588 auto EmitFeature = [&](std::string Feature) {
589 std::string MDKey = (StringRef("wasm-feature-") + Feature).str();
590 Metadata *Policy = M.getModuleFlag(Key: MDKey);
591 if (Policy == nullptr)
592 return;
593
594 FeatureEntry Entry;
595 Entry.Prefix = 0;
596 Entry.Name = Feature;
597
598 if (auto *MD = cast<ConstantAsMetadata>(Val: Policy))
599 if (auto *I = cast<ConstantInt>(Val: MD->getValue()))
600 Entry.Prefix = I->getZExtValue();
601
602 // Silently ignore invalid metadata
603 if (Entry.Prefix != wasm::WASM_FEATURE_PREFIX_USED &&
604 Entry.Prefix != wasm::WASM_FEATURE_PREFIX_DISALLOWED)
605 return;
606
607 EmittedFeatures.push_back(Elt: Entry);
608 };
609
610 // If we never compiled a single function, Subtarget is null.
611 if (!Subtarget) {
612 Subtarget = static_cast<WebAssemblyTargetMachine &>(TM).getSubtargetImpl(
613 CPU: TM.getTargetCPU(), FS: TM.getTargetFeatureString(), ABIName: TM.getTargetABIName(M));
614 }
615 for (const SubtargetFeatureKV &KV : Subtarget->getAllProcessorFeatures()) {
616 EmitFeature(KV.key());
617 }
618 // This pseudo-feature tells the linker whether shared memory would be safe
619 EmitFeature("shared-mem");
620
621 // This is an "architecture", not a "feature", but we emit it as such for
622 // the benefit of tools like Binaryen and consistency with other producers.
623 if (Subtarget->hasAddr64()) {
624 // Can't use EmitFeature since "wasm-feature-memory64" is not a module
625 // flag.
626 EmittedFeatures.push_back(Elt: {.Prefix: wasm::WASM_FEATURE_PREFIX_USED, .Name: "memory64"});
627 }
628
629 if (EmittedFeatures.size() == 0)
630 return;
631
632 // Emit features and linkage policies into the "target_features" section
633 MCSectionWasm *FeaturesSection = OutContext.getWasmSection(
634 Section: ".custom_section.target_features", K: SectionKind::getMetadata());
635 OutStreamer->pushSection();
636 OutStreamer->switchSection(Section: FeaturesSection);
637
638 OutStreamer->emitULEB128IntValue(Value: EmittedFeatures.size());
639 for (auto &F : EmittedFeatures) {
640 OutStreamer->emitIntValue(Value: F.Prefix, Size: 1);
641 OutStreamer->emitULEB128IntValue(Value: F.Name.size());
642 OutStreamer->emitBytes(Data: F.Name);
643 }
644
645 OutStreamer->popSection();
646}
647
648void WebAssemblyAsmPrinter::EmitFunctionAttributes(Module &M) {
649 auto V = M.getNamedGlobal(Name: "llvm.global.annotations");
650 if (!V)
651 return;
652
653 // Group all the custom attributes by name.
654 MapVector<StringRef, SmallVector<MCSymbol *, 4>> CustomSections;
655 const ConstantArray *CA = cast<ConstantArray>(Val: V->getOperand(i_nocapture: 0));
656 for (Value *Op : CA->operands()) {
657 auto *CS = cast<ConstantStruct>(Val: Op);
658 // The first field is a pointer to the annotated variable.
659 Value *AnnotatedVar = CS->getOperand(i_nocapture: 0)->stripPointerCasts();
660 // Only annotated functions are supported for now.
661 if (!isa<Function>(Val: AnnotatedVar))
662 continue;
663 auto *F = cast<Function>(Val: AnnotatedVar);
664
665 // The second field is a pointer to a global annotation string.
666 auto *GV = cast<GlobalVariable>(Val: CS->getOperand(i_nocapture: 1)->stripPointerCasts());
667 StringRef AnnotationString;
668 getConstantStringInfo(V: GV, Str&: AnnotationString);
669 auto *Sym = static_cast<MCSymbolWasm *>(getSymbol(GV: F));
670 CustomSections[AnnotationString].push_back(Elt: Sym);
671 }
672
673 // Emit a custom section for each unique attribute.
674 for (const auto &[Name, Symbols] : CustomSections) {
675 MCSectionWasm *CustomSection = OutContext.getWasmSection(
676 Section: ".custom_section.llvm.func_attr.annotate." + Name, K: SectionKind::getMetadata());
677 OutStreamer->pushSection();
678 OutStreamer->switchSection(Section: CustomSection);
679
680 for (auto &Sym : Symbols) {
681 OutStreamer->emitValue(
682 Value: MCSymbolRefExpr::create(Symbol: Sym, specifier: WebAssembly::S_FUNCINDEX, Ctx&: OutContext),
683 Size: 4);
684 }
685 OutStreamer->popSection();
686 }
687}
688
689void WebAssemblyAsmPrinter::emitConstantPool() {
690 emitDecls(M: *MMI->getModule());
691 assert(MF->getConstantPool()->getConstants().empty() &&
692 "WebAssembly disables constant pools");
693}
694
695void WebAssemblyAsmPrinter::emitJumpTableInfo() {
696 // Nothing to do; jump tables are incorporated into the instruction stream.
697}
698
699void WebAssemblyAsmPrinter::emitFunctionBodyStart() {
700 const Function &F = MF->getFunction();
701 SmallVector<MVT, 1> ResultVTs;
702 SmallVector<MVT, 4> ParamVTs;
703 computeSignatureVTs(Ty: F.getFunctionType(), TargetFunc: &F, ContextFunc: F, TM, Params&: ParamVTs, Results&: ResultVTs);
704
705 auto Signature = signatureFromMVTs(Ctx&: OutContext, Results: ResultVTs, Params: ParamVTs);
706 auto *WasmSym = static_cast<MCSymbolWasm *>(CurrentFnSym);
707 WasmSym->setSignature(Signature);
708 WasmSym->setType(wasm::WASM_SYMBOL_TYPE_FUNCTION);
709
710 getTargetStreamer()->emitFunctionType(Sym: WasmSym);
711
712 // Emit the function index.
713 if (MDNode *Idx = F.getMetadata(Kind: "wasm.index")) {
714 assert(Idx->getNumOperands() == 1);
715
716 getTargetStreamer()->emitIndIdx(Value: AsmPrinter::lowerConstant(
717 CV: cast<ConstantAsMetadata>(Val: Idx->getOperand(I: 0))->getValue()));
718 }
719
720 SmallVector<wasm::ValType, 16> Locals;
721 valTypesFromMVTs(In: MFI->getLocals(), Out&: Locals);
722 getTargetStreamer()->emitLocal(Types: Locals);
723
724 AsmPrinter::emitFunctionBodyStart();
725}
726
727void WebAssemblyAsmPrinter::emitInstruction(const MachineInstr *MI) {
728 LLVM_DEBUG(dbgs() << "EmitInstruction: " << *MI << '\n');
729 WebAssembly_MC::verifyInstructionPredicates(Opcode: MI->getOpcode(),
730 Features: Subtarget->getFeatureBits());
731
732 switch (MI->getOpcode()) {
733 case WebAssembly::ARGUMENT_i32:
734 case WebAssembly::ARGUMENT_i32_S:
735 case WebAssembly::ARGUMENT_i64:
736 case WebAssembly::ARGUMENT_i64_S:
737 case WebAssembly::ARGUMENT_f32:
738 case WebAssembly::ARGUMENT_f32_S:
739 case WebAssembly::ARGUMENT_f64:
740 case WebAssembly::ARGUMENT_f64_S:
741 case WebAssembly::ARGUMENT_v16i8:
742 case WebAssembly::ARGUMENT_v16i8_S:
743 case WebAssembly::ARGUMENT_v8i16:
744 case WebAssembly::ARGUMENT_v8i16_S:
745 case WebAssembly::ARGUMENT_v4i32:
746 case WebAssembly::ARGUMENT_v4i32_S:
747 case WebAssembly::ARGUMENT_v2i64:
748 case WebAssembly::ARGUMENT_v2i64_S:
749 case WebAssembly::ARGUMENT_v4f32:
750 case WebAssembly::ARGUMENT_v4f32_S:
751 case WebAssembly::ARGUMENT_v2f64:
752 case WebAssembly::ARGUMENT_v2f64_S:
753 case WebAssembly::ARGUMENT_v8f16:
754 case WebAssembly::ARGUMENT_v8f16_S:
755 case WebAssembly::ARGUMENT_externref:
756 case WebAssembly::ARGUMENT_externref_S:
757 case WebAssembly::ARGUMENT_funcref:
758 case WebAssembly::ARGUMENT_funcref_S:
759 case WebAssembly::ARGUMENT_exnref:
760 case WebAssembly::ARGUMENT_exnref_S:
761 // These represent values which are live into the function entry, so there's
762 // no instruction to emit.
763 break;
764 case WebAssembly::FALLTHROUGH_RETURN: {
765 // These instructions represent the implicit return at the end of a
766 // function body.
767 if (isVerbose()) {
768 OutStreamer->AddComment(T: "fallthrough-return");
769 OutStreamer->addBlankLine();
770 }
771 break;
772 }
773 case WebAssembly::COMPILER_FENCE:
774 // This is a compiler barrier that prevents instruction reordering during
775 // backend compilation, and should not be emitted.
776 break;
777 case WebAssembly::CATCH:
778 case WebAssembly::CATCH_S:
779 case WebAssembly::CATCH_REF:
780 case WebAssembly::CATCH_REF_S:
781 case WebAssembly::CATCH_ALL:
782 case WebAssembly::CATCH_ALL_S:
783 case WebAssembly::CATCH_ALL_REF:
784 case WebAssembly::CATCH_ALL_REF_S:
785 // These are pseudo instructions to represent catch clauses in try_table
786 // instruction to simulate block return values.
787 break;
788 default: {
789 WebAssemblyMCInstLower MCInstLowering(OutContext, *this);
790 MCInst TmpInst;
791 MCInstLowering.lower(MI, OutMI&: TmpInst);
792 EmitToStreamer(S&: *OutStreamer, Inst: TmpInst);
793 break;
794 }
795 }
796}
797
798bool WebAssemblyAsmPrinter::PrintAsmOperand(const MachineInstr *MI,
799 unsigned OpNo,
800 const char *ExtraCode,
801 raw_ostream &OS) {
802 // First try the generic code, which knows about modifiers like 'c' and 'n'.
803 if (!AsmPrinter::PrintAsmOperand(MI, OpNo, ExtraCode, OS))
804 return false;
805
806 if (!ExtraCode) {
807 const MachineOperand &MO = MI->getOperand(i: OpNo);
808 switch (MO.getType()) {
809 case MachineOperand::MO_Immediate:
810 OS << MO.getImm();
811 return false;
812 case MachineOperand::MO_Register:
813 // FIXME: only opcode that still contains registers, as required by
814 // MachineInstr::getDebugVariable().
815 assert(MI->getOpcode() == WebAssembly::INLINEASM);
816 OS << regToString(MO);
817 return false;
818 case MachineOperand::MO_GlobalAddress:
819 PrintSymbolOperand(MO, OS);
820 return false;
821 case MachineOperand::MO_ExternalSymbol:
822 GetExternalSymbolSymbol(Sym: MO.getSymbolName())->print(OS, MAI);
823 printOffset(Offset: MO.getOffset(), OS);
824 return false;
825 case MachineOperand::MO_MachineBasicBlock:
826 MO.getMBB()->getSymbol()->print(OS, MAI);
827 return false;
828 default:
829 break;
830 }
831 }
832
833 return true;
834}
835
836bool WebAssemblyAsmPrinter::PrintAsmMemoryOperand(const MachineInstr *MI,
837 unsigned OpNo,
838 const char *ExtraCode,
839 raw_ostream &OS) {
840 // The current approach to inline asm is that "r" constraints are expressed
841 // as local indices, rather than values on the operand stack. This simplifies
842 // using "r" as it eliminates the need to push and pop the values in a
843 // particular order, however it also makes it impossible to have an "m"
844 // constraint. So we don't support it.
845
846 return AsmPrinter::PrintAsmMemoryOperand(MI, OpNo, ExtraCode, OS);
847}
848
849char WebAssemblyAsmPrinter::ID = 0;
850
851INITIALIZE_PASS(WebAssemblyAsmPrinter, "webassembly-asm-printer",
852 "WebAssembly Assembly Printer", false, false)
853
854// Force static initialization.
855extern "C" LLVM_ABI LLVM_EXTERNAL_VISIBILITY void
856LLVMInitializeWebAssemblyAsmPrinter() {
857 RegisterAsmPrinter<WebAssemblyAsmPrinter> X(getTheWebAssemblyTarget32());
858 RegisterAsmPrinter<WebAssemblyAsmPrinter> Y(getTheWebAssemblyTarget64());
859}
860
861PreservedAnalyses
862WebAssemblyAsmPrinterBeginPass::run(Module &M, ModuleAnalysisManager &MAM) {
863 WebAssemblyAsmPrinter &AsmPrinter = static_cast<WebAssemblyAsmPrinter &>(
864 MAM.getResult<AsmPrinterAnalysis>(IR&: M).getPrinter());
865 setupModuleAsmPrinter(M, MAM, AsmPrinter);
866 AsmPrinter.doInitialization(M);
867 return PreservedAnalyses::all();
868}
869
870PreservedAnalyses
871WebAssemblyAsmPrinterPass::run(MachineFunction &MF,
872 MachineFunctionAnalysisManager &MFAM) {
873 WebAssemblyAsmPrinter &AsmPrinter = static_cast<WebAssemblyAsmPrinter &>(
874 MFAM.getResult<ModuleAnalysisManagerMachineFunctionProxy>(IR&: MF)
875 .getCachedResult<AsmPrinterAnalysis>(IR&: *MF.getFunction().getParent())
876 ->getPrinter());
877 setupMachineFunctionAsmPrinter(MFAM, MF, AsmPrinter);
878 AsmPrinter.runOnMachineFunction(MF);
879 return PreservedAnalyses::all();
880}
881
882PreservedAnalyses
883WebAssemblyAsmPrinterEndPass::run(Module &M, ModuleAnalysisManager &MAM) {
884 WebAssemblyAsmPrinter &AsmPrinter = static_cast<WebAssemblyAsmPrinter &>(
885 MAM.getResult<AsmPrinterAnalysis>(IR&: M).getPrinter());
886 setupModuleAsmPrinter(M, MAM, AsmPrinter);
887 AsmPrinter.doFinalization(M);
888 return PreservedAnalyses::all();
889}
890