LLVM 23.0.0git
WebAssemblyAsmPrinter.cpp
Go to the documentation of this file.
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
22#include "WebAssembly.h"
29#include "llvm/ADT/MapVector.h"
30#include "llvm/ADT/SmallSet.h"
39#include "llvm/IR/DataLayout.h"
42#include "llvm/IR/Metadata.h"
43#include "llvm/IR/Module.h"
44#include "llvm/MC/MCContext.h"
46#include "llvm/MC/MCStreamer.h"
47#include "llvm/MC/MCSymbol.h"
51#include "llvm/Support/Debug.h"
53
54using namespace llvm;
55
56#define DEBUG_TYPE "asm-printer"
57
59
60//===----------------------------------------------------------------------===//
61// Helpers.
62//===----------------------------------------------------------------------===//
63
65 const TargetRegisterInfo *TRI = Subtarget->getRegisterInfo();
66 const TargetRegisterClass *TRC = MRI->getRegClass(RegNo);
67 for (MVT T : {MVT::i32, MVT::i64, MVT::f32, MVT::f64, MVT::v16i8, MVT::v8i16,
68 MVT::v4i32, MVT::v2i64, MVT::v4f32, MVT::v2f64, MVT::v8f16})
69 if (TRI->isTypeLegalForClass(*TRC, T))
70 return T;
71 LLVM_DEBUG(errs() << "Unknown type for register number: " << RegNo);
72 llvm_unreachable("Unknown register type");
73 return MVT::Other;
74}
75
77 Register RegNo = MO.getReg();
78 assert(RegNo.isVirtual() &&
79 "Unlowered physical register encountered during assembly printing");
80 assert(!MFI->isVRegStackified(RegNo));
81 unsigned WAReg = MFI->getWAReg(RegNo);
83 return '$' + utostr(WAReg);
84}
85
90
91// Emscripten exception handling helpers
92//
93// This converts invoke names generated by LowerEmscriptenEHSjLj to real names
94// that are expected by JavaScript glue code. The invoke names generated by
95// Emscripten JS glue code are based on their argument and return types; for
96// example, for a function that takes an i32 and returns nothing, it is
97// 'invoke_vi'. But the format of invoke generated by LowerEmscriptenEHSjLj pass
98// contains a mangled string generated from their IR types, for example,
99// "__invoke_void_%struct.mystruct*_int", because final wasm types are not
100// available in the IR pass. So we convert those names to the form that
101// Emscripten JS code expects.
102//
103// Refer to LowerEmscriptenEHSjLj pass for more details.
104
105// Returns true if the given function name is an invoke name generated by
106// LowerEmscriptenEHSjLj pass.
108 if (Name.front() == '"' && Name.back() == '"')
109 Name = Name.substr(1, Name.size() - 2);
110 return Name.starts_with("__invoke_");
111}
112
113// Returns a character that represents the given wasm value type in invoke
114// signatures.
116 switch (VT) {
118 return 'i';
120 return 'j';
122 return 'f';
124 return 'd';
126 return 'V';
128 return 'F';
130 return 'X';
132 return 'E';
133 default:
134 llvm_unreachable("Unhandled wasm::ValType enum");
135 }
136}
137
138// Given the wasm signature, generate the invoke name in the format JS glue code
139// expects.
141 assert(Sig->Returns.size() <= 1);
142 std::string Ret = "invoke_";
143 if (!Sig->Returns.empty())
144 for (auto VT : Sig->Returns)
145 Ret += getInvokeSig(VT);
146 else
147 Ret += 'v';
148 // Invokes' first argument is a pointer to the original function, so skip it
149 for (unsigned I = 1, E = Sig->Params.size(); I < E; I++)
150 Ret += getInvokeSig(Sig->Params[I]);
151 return Ret;
152}
153
154//===----------------------------------------------------------------------===//
155// WebAssemblyAsmPrinter Implementation.
156//===----------------------------------------------------------------------===//
157
159 const Function *F, wasm::WasmSignature *Sig, bool &InvokeDetected) {
160 MCSymbolWasm *WasmSym = nullptr;
161
162 const bool EnableEmEH =
164 if (EnableEmEH && isEmscriptenInvokeName(F->getName())) {
165 assert(Sig);
166 InvokeDetected = true;
167 if (Sig->Returns.size() > 1) {
168 std::string Msg =
169 "Emscripten EH/SjLj does not support multivalue returns: " +
170 std::string(F->getName()) + ": " +
173 }
174 WasmSym = static_cast<MCSymbolWasm *>(
176 } else {
177 WasmSym = static_cast<MCSymbolWasm *>(getSymbol(F));
178 }
179 return WasmSym;
180}
181
183 if (GV->hasCommonLinkage()) {
184 OutContext.reportError(SMLoc(),
185 "common symbols are not yet implemented for Wasm: " +
186 getSymbol(GV)->getName());
187 return;
188 }
189
192 return;
193 }
194
195 assert(!GV->isThreadLocal());
196 auto *Sym = static_cast<MCSymbolWasm *>(getSymbol(GV));
197 if (!Sym->getType()) {
199 Type *GlobalVT = GV->getValueType();
200 // Function-specific subtargets are not needed here: WebAssembly
201 // coalesces features before isel, so use the TargetMachine's
202 // module-wide subtarget to compute legal value types.
203 auto &WasmTM = static_cast<const WebAssemblyTargetMachine &>(TM);
204 const WebAssemblySubtarget *ST = WasmTM.getSubtargetImpl();
205 const WebAssemblyTargetLowering &TLI = *ST->getTargetLowering();
207 GV->getDataLayout(), GlobalVT, VTs);
208
209 WebAssembly::wasmSymbolSetType(Sym, GlobalVT, VTs);
210 }
211
212 emitVisibility(Sym, GV->getVisibility(), !GV->isDeclaration());
213 emitSymbolType(Sym);
214 if (GV->hasInitializer()) {
215 assert(getSymbolPreferLocal(*GV) == Sym);
216 emitLinkage(GV, Sym);
217 OutStreamer->emitLabel(Sym);
218 // TODO: Actually emit the initializer value. Otherwise the global has the
219 // default value for its type (0, ref.null, etc).
220 OutStreamer->addBlankLine();
221 }
222}
223
225 auto *WasmSym = static_cast<MCSymbolWasm *>(GetExternalSymbolSymbol(Name));
226 // May be called multiple times, so early out.
227 if (WasmSym->getType())
228 return WasmSym;
229
230 const WebAssemblySubtarget &Subtarget = getSubtarget();
231
232 // Except for certain known symbols, all symbols used by CodeGen are
233 // functions. It's OK to hardcode knowledge of specific symbols here; this
234 // method is precisely there for fetching the signatures of known
235 // Clang-provided symbols.
236 if (Name == "__stack_pointer" || Name == "__tls_base" ||
237 Name == "__memory_base" || Name == "__table_base" ||
238 Name == "__tls_size" || Name == "__tls_align") {
239 bool Mutable =
240 Name == "__stack_pointer" || Name == "__tls_base";
241 WasmSym->setType(wasm::WASM_SYMBOL_TYPE_GLOBAL);
242 WasmSym->setGlobalType(wasm::WasmGlobalType{
243 uint8_t(Subtarget.hasAddr64() ? wasm::WASM_TYPE_I64
245 Mutable});
246 return WasmSym;
247 }
248
249 if (Name.starts_with("GCC_except_table")) {
250 WasmSym->setType(wasm::WASM_SYMBOL_TYPE_DATA);
251 return WasmSym;
252 }
253
256 if (Name == "__cpp_exception" || Name == "__c_longjmp") {
257 WasmSym->setType(wasm::WASM_SYMBOL_TYPE_TAG);
258 WasmSym->setExternal(true);
259
260 // Currently both C++ exceptions and C longjmps have a single pointer type
261 // param. For C++ exceptions it is a pointer to an exception object, and for
262 // C longjmps it is pointer to a struct that contains a setjmp buffer and a
263 // longjmp return value. We may consider using multiple value parameters for
264 // longjmps later when multivalue support is ready.
265 wasm::ValType AddrType =
266 Subtarget.hasAddr64() ? wasm::ValType::I64 : wasm::ValType::I32;
267 Params.push_back(AddrType);
268 } else { // Function symbols
269 WasmSym->setType(wasm::WASM_SYMBOL_TYPE_FUNCTION);
270 WebAssembly::getLibcallSignature(Subtarget, Name, Returns, Params);
271 }
272 auto Signature = OutContext.createWasmSignature();
273 Signature->Returns = std::move(Returns);
274 Signature->Params = std::move(Params);
275 WasmSym->setSignature(Signature);
276
277 return WasmSym;
278}
279
281 std::optional<wasm::WasmSymbolType> WasmTy = Sym->getType();
282 if (!WasmTy)
283 return;
284
285 switch (*WasmTy) {
288 break;
291 break;
294 break;
295 default:
296 break; // We only handle globals, tags and tables here
297 }
298}
299
301 if (signaturesEmitted)
302 return;
303 signaturesEmitted = true;
304
305 // Normally symbols for globals get discovered as the MI gets lowered,
306 // but we need to know about them ahead of time. This will however,
307 // only find symbols that have been used. Unused symbols from globals will
308 // not be found here.
309 MachineModuleInfoWasm &MMIW = MMI->getObjFileInfo<MachineModuleInfoWasm>();
310 for (StringRef Name : MMIW.MachineSymbolsUsed) {
311 auto *WasmSym = static_cast<MCSymbolWasm *>(getOrCreateWasmSymbol(Name));
312 if (WasmSym->isFunction()) {
313 // TODO(wvo): is there any case where this overlaps with the call to
314 // emitFunctionType in the loop below?
316 }
317 }
318
319 for (auto &It : OutContext.getSymbols()) {
320 // Emit .globaltype, .tagtype, or .tabletype declarations for extern
321 // declarations, i.e. those that have only been declared (but not defined)
322 // in the current module
323 auto Sym = static_cast<MCSymbolWasm *>(It.getValue().Symbol);
324 if (Sym && !Sym->isDefined())
325 emitSymbolType(Sym);
326 }
327
328 DenseSet<MCSymbol *> InvokeSymbols;
329 for (const auto &F : M) {
330 if (F.isIntrinsic())
331 continue;
332
333 // Emit function type info for all functions. This will emit duplicate
334 // information for defined functions (which already have function type
335 // info emitted alongside their definition), but this is necessary in
336 // order to enable the single-pass WebAssemblyAsmTypeCheck to succeed.
338 SmallVector<MVT, 4> Params;
339 computeSignatureVTs(F.getFunctionType(), &F, F, TM, Params, Results);
340 // At this point these MCSymbols may or may not have been created already
341 // and thus also contain a signature, but we need to get the signature
342 // anyway here in case it is an invoke that has not yet been created. We
343 // will discard it later if it turns out not to be necessary.
344 auto Signature = signatureFromMVTs(OutContext, Results, Params);
345 bool InvokeDetected = false;
346 auto *Sym = getMCSymbolForFunction(&F, Signature, InvokeDetected);
347
348 // Multiple functions can be mapped to the same invoke symbol. For
349 // example, two IR functions '__invoke_void_i8*' and '__invoke_void_i32'
350 // are both mapped to '__invoke_vi'. We keep them in a set once we emit an
351 // Emscripten EH symbol so we don't emit the same symbol twice.
352 if (InvokeDetected && !InvokeSymbols.insert(Sym).second)
353 continue;
354
356 if (!Sym->getSignature()) {
357 Sym->setSignature(Signature);
358 }
359
361
362 if (F.hasFnAttribute("wasm-import-module")) {
363 StringRef Name =
364 F.getFnAttribute("wasm-import-module").getValueAsString();
365 Sym->setImportModule(OutContext.allocateString(Name));
367 }
368 if (F.hasFnAttribute("wasm-import-name")) {
369 // If this is a converted Emscripten EH/SjLj symbol, we shouldn't use
370 // the original function name but the converted symbol name.
371 StringRef Name =
372 InvokeDetected
373 ? Sym->getName()
374 : F.getFnAttribute("wasm-import-name").getValueAsString();
375 Sym->setImportName(OutContext.allocateString(Name));
376 getTargetStreamer()->emitImportName(Sym, Name);
377 }
378
379 if (F.hasFnAttribute("wasm-export-name")) {
380 auto *Sym = static_cast<MCSymbolWasm *>(getSymbol(&F));
381 StringRef Name = F.getFnAttribute("wasm-export-name").getValueAsString();
382 Sym->setExportName(OutContext.allocateString(Name));
383 getTargetStreamer()->emitExportName(Sym, Name);
384 }
385 }
386}
387
389 // This is required to emit external declarations (like .functypes) when
390 // no functions are defined in the compilation unit and therefore,
391 // emitDecls() is not called until now.
392 emitDecls(M);
393
394 // When a function's address is taken, a TABLE_INDEX relocation is emitted
395 // against the function symbol at the use site. However the relocation
396 // doesn't explicitly refer to the table. In the future we may want to
397 // define a new kind of reloc against both the function and the table, so
398 // that the linker can see that the function symbol keeps the table alive,
399 // but for now manually mark the table as live.
400 for (const auto &F : M) {
401 if (!F.isIntrinsic() && F.hasAddressTaken()) {
402 MCSymbolWasm *FunctionTable =
404 OutStreamer->emitSymbolAttribute(FunctionTable, MCSA_NoDeadStrip);
405 break;
406 }
407 }
408
409 for (const auto &G : M.globals()) {
410 if (!G.hasInitializer() && G.hasExternalLinkage() &&
411 !WebAssembly::isWasmVarAddressSpace(G.getAddressSpace()) &&
412 G.getValueType()->isSized()) {
413 uint16_t Size = G.getGlobalSize(M.getDataLayout());
414 OutStreamer->emitELFSize(getSymbol(&G),
416 }
417 }
418
419 if (const NamedMDNode *Named = M.getNamedMetadata("wasm.custom_sections")) {
420 for (const Metadata *MD : Named->operands()) {
421 const auto *Tuple = dyn_cast<MDTuple>(MD);
422 if (!Tuple || Tuple->getNumOperands() != 2)
423 continue;
424 const MDString *Name = dyn_cast<MDString>(Tuple->getOperand(0));
425 const MDString *Contents = dyn_cast<MDString>(Tuple->getOperand(1));
426 if (!Name || !Contents)
427 continue;
428
429 OutStreamer->pushSection();
430 std::string SectionName = (".custom_section." + Name->getString()).str();
431 MCSectionWasm *MySection =
433 OutStreamer->switchSection(MySection);
434 OutStreamer->emitBytes(Contents->getString());
435 OutStreamer->popSection();
436 }
437 }
438
442}
443
446 if (const NamedMDNode *Debug = M.getNamedMetadata("llvm.dbg.cu")) {
447 llvm::SmallSet<StringRef, 4> SeenLanguages;
448 for (size_t I = 0, E = Debug->getNumOperands(); I < E; ++I) {
449 const auto *CU = cast<DICompileUnit>(Debug->getOperand(I));
450 StringRef Language =
451 dwarf::LanguageString(CU->getSourceLanguage().getUnversionedName());
452
453 Language.consume_front("DW_LANG_");
454 if (SeenLanguages.insert(Language).second)
455 Languages.emplace_back(Language.str(), "");
456 }
457 }
458
460 if (const NamedMDNode *Ident = M.getNamedMetadata("llvm.ident")) {
462 for (size_t I = 0, E = Ident->getNumOperands(); I < E; ++I) {
463 const auto *S = cast<MDString>(Ident->getOperand(I)->getOperand(0));
464 std::pair<StringRef, StringRef> Field = S->getString().split("version");
465 StringRef Name = Field.first.trim();
466 StringRef Version = Field.second.trim();
467 if (SeenTools.insert(Name).second)
468 Tools.emplace_back(Name.str(), Version.str());
469 }
470 }
471
472 int FieldCount = int(!Languages.empty()) + int(!Tools.empty());
473 if (FieldCount != 0) {
474 MCSectionWasm *Producers = OutContext.getWasmSection(
475 ".custom_section.producers", SectionKind::getMetadata());
476 OutStreamer->pushSection();
477 OutStreamer->switchSection(Producers);
478 OutStreamer->emitULEB128IntValue(FieldCount);
479 for (auto &Producers : {std::make_pair("language", &Languages),
480 std::make_pair("processed-by", &Tools)}) {
481 if (Producers.second->empty())
482 continue;
483 OutStreamer->emitULEB128IntValue(strlen(Producers.first));
484 OutStreamer->emitBytes(Producers.first);
485 OutStreamer->emitULEB128IntValue(Producers.second->size());
486 for (auto &Producer : *Producers.second) {
487 OutStreamer->emitULEB128IntValue(Producer.first.size());
488 OutStreamer->emitBytes(Producer.first);
489 OutStreamer->emitULEB128IntValue(Producer.second.size());
490 OutStreamer->emitBytes(Producer.second);
491 }
492 }
493 OutStreamer->popSection();
494 }
495}
496
498 struct FeatureEntry {
499 uint8_t Prefix;
500 std::string Name;
501 };
502
503 // Read target features and linkage policies from module metadata
504 SmallVector<FeatureEntry, 4> EmittedFeatures;
505 auto EmitFeature = [&](std::string Feature) {
506 std::string MDKey = (StringRef("wasm-feature-") + Feature).str();
507 Metadata *Policy = M.getModuleFlag(MDKey);
508 if (Policy == nullptr)
509 return;
510
511 FeatureEntry Entry;
512 Entry.Prefix = 0;
513 Entry.Name = Feature;
514
515 if (auto *MD = cast<ConstantAsMetadata>(Policy))
516 if (auto *I = cast<ConstantInt>(MD->getValue()))
517 Entry.Prefix = I->getZExtValue();
518
519 // Silently ignore invalid metadata
520 if (Entry.Prefix != wasm::WASM_FEATURE_PREFIX_USED &&
522 return;
523
524 EmittedFeatures.push_back(Entry);
525 };
526
527 for (const SubtargetFeatureKV &KV : WebAssemblyFeatureKV) {
528 EmitFeature(KV.Key);
529 }
530 // This pseudo-feature tells the linker whether shared memory would be safe
531 EmitFeature("shared-mem");
532
533 // This is an "architecture", not a "feature", but we emit it as such for
534 // the benefit of tools like Binaryen and consistency with other producers.
535 // FIXME: Subtarget is null here, so can't Subtarget->hasAddr64() ?
536 if (M.getDataLayout().getPointerSize() == 8) {
537 // Can't use EmitFeature since "wasm-feature-memory64" is not a module
538 // flag.
539 EmittedFeatures.push_back({wasm::WASM_FEATURE_PREFIX_USED, "memory64"});
540 }
541
542 if (EmittedFeatures.size() == 0)
543 return;
544
545 // Emit features and linkage policies into the "target_features" section
546 MCSectionWasm *FeaturesSection = OutContext.getWasmSection(
547 ".custom_section.target_features", SectionKind::getMetadata());
548 OutStreamer->pushSection();
549 OutStreamer->switchSection(FeaturesSection);
550
551 OutStreamer->emitULEB128IntValue(EmittedFeatures.size());
552 for (auto &F : EmittedFeatures) {
553 OutStreamer->emitIntValue(F.Prefix, 1);
554 OutStreamer->emitULEB128IntValue(F.Name.size());
555 OutStreamer->emitBytes(F.Name);
556 }
557
558 OutStreamer->popSection();
559}
560
562 auto V = M.getNamedGlobal("llvm.global.annotations");
563 if (!V)
564 return;
565
566 // Group all the custom attributes by name.
568 const ConstantArray *CA = cast<ConstantArray>(V->getOperand(0));
569 for (Value *Op : CA->operands()) {
570 auto *CS = cast<ConstantStruct>(Op);
571 // The first field is a pointer to the annotated variable.
572 Value *AnnotatedVar = CS->getOperand(0)->stripPointerCasts();
573 // Only annotated functions are supported for now.
574 if (!isa<Function>(AnnotatedVar))
575 continue;
576 auto *F = cast<Function>(AnnotatedVar);
577
578 // The second field is a pointer to a global annotation string.
579 auto *GV = cast<GlobalVariable>(CS->getOperand(1)->stripPointerCasts());
580 StringRef AnnotationString;
581 getConstantStringInfo(GV, AnnotationString);
582 auto *Sym = static_cast<MCSymbolWasm *>(getSymbol(F));
583 CustomSections[AnnotationString].push_back(Sym);
584 }
585
586 // Emit a custom section for each unique attribute.
587 for (const auto &[Name, Symbols] : CustomSections) {
588 MCSectionWasm *CustomSection = OutContext.getWasmSection(
589 ".custom_section.llvm.func_attr.annotate." + Name, SectionKind::getMetadata());
590 OutStreamer->pushSection();
591 OutStreamer->switchSection(CustomSection);
592
593 for (auto &Sym : Symbols) {
594 OutStreamer->emitValue(
596 4);
597 }
598 OutStreamer->popSection();
599 }
600}
601
603 emitDecls(*MMI->getModule());
604 assert(MF->getConstantPool()->getConstants().empty() &&
605 "WebAssembly disables constant pools");
606}
607
609 // Nothing to do; jump tables are incorporated into the instruction stream.
610}
611
613 const Function &F = MF->getFunction();
614 SmallVector<MVT, 1> ResultVTs;
615 SmallVector<MVT, 4> ParamVTs;
616 computeSignatureVTs(F.getFunctionType(), &F, F, TM, ParamVTs, ResultVTs);
617
618 auto Signature = signatureFromMVTs(OutContext, ResultVTs, ParamVTs);
619 auto *WasmSym = static_cast<MCSymbolWasm *>(CurrentFnSym);
620 WasmSym->setSignature(Signature);
621 WasmSym->setType(wasm::WASM_SYMBOL_TYPE_FUNCTION);
622
624
625 // Emit the function index.
626 if (MDNode *Idx = F.getMetadata("wasm.index")) {
627 assert(Idx->getNumOperands() == 1);
628
630 cast<ConstantAsMetadata>(Idx->getOperand(0))->getValue()));
631 }
632
634 valTypesFromMVTs(MFI->getLocals(), Locals);
635 getTargetStreamer()->emitLocal(Locals);
636
638}
639
641 LLVM_DEBUG(dbgs() << "EmitInstruction: " << *MI << '\n');
642 WebAssembly_MC::verifyInstructionPredicates(MI->getOpcode(),
643 Subtarget->getFeatureBits());
644
645 switch (MI->getOpcode()) {
646 case WebAssembly::ARGUMENT_i32:
647 case WebAssembly::ARGUMENT_i32_S:
648 case WebAssembly::ARGUMENT_i64:
649 case WebAssembly::ARGUMENT_i64_S:
650 case WebAssembly::ARGUMENT_f32:
651 case WebAssembly::ARGUMENT_f32_S:
652 case WebAssembly::ARGUMENT_f64:
653 case WebAssembly::ARGUMENT_f64_S:
654 case WebAssembly::ARGUMENT_v16i8:
655 case WebAssembly::ARGUMENT_v16i8_S:
656 case WebAssembly::ARGUMENT_v8i16:
657 case WebAssembly::ARGUMENT_v8i16_S:
658 case WebAssembly::ARGUMENT_v4i32:
659 case WebAssembly::ARGUMENT_v4i32_S:
660 case WebAssembly::ARGUMENT_v2i64:
661 case WebAssembly::ARGUMENT_v2i64_S:
662 case WebAssembly::ARGUMENT_v4f32:
663 case WebAssembly::ARGUMENT_v4f32_S:
664 case WebAssembly::ARGUMENT_v2f64:
665 case WebAssembly::ARGUMENT_v2f64_S:
666 case WebAssembly::ARGUMENT_v8f16:
667 case WebAssembly::ARGUMENT_v8f16_S:
668 case WebAssembly::ARGUMENT_externref:
669 case WebAssembly::ARGUMENT_externref_S:
670 case WebAssembly::ARGUMENT_funcref:
671 case WebAssembly::ARGUMENT_funcref_S:
672 case WebAssembly::ARGUMENT_exnref:
673 case WebAssembly::ARGUMENT_exnref_S:
674 // These represent values which are live into the function entry, so there's
675 // no instruction to emit.
676 break;
677 case WebAssembly::FALLTHROUGH_RETURN: {
678 // These instructions represent the implicit return at the end of a
679 // function body.
680 if (isVerbose()) {
681 OutStreamer->AddComment("fallthrough-return");
682 OutStreamer->addBlankLine();
683 }
684 break;
685 }
686 case WebAssembly::COMPILER_FENCE:
687 // This is a compiler barrier that prevents instruction reordering during
688 // backend compilation, and should not be emitted.
689 break;
690 case WebAssembly::CATCH:
691 case WebAssembly::CATCH_S:
692 case WebAssembly::CATCH_REF:
693 case WebAssembly::CATCH_REF_S:
694 case WebAssembly::CATCH_ALL:
695 case WebAssembly::CATCH_ALL_S:
696 case WebAssembly::CATCH_ALL_REF:
697 case WebAssembly::CATCH_ALL_REF_S:
698 // These are pseudo instructions to represent catch clauses in try_table
699 // instruction to simulate block return values.
700 break;
701 default: {
702 WebAssemblyMCInstLower MCInstLowering(OutContext, *this);
703 MCInst TmpInst;
704 MCInstLowering.lower(MI, TmpInst);
705 EmitToStreamer(*OutStreamer, TmpInst);
706 break;
707 }
708 }
709}
710
712 unsigned OpNo,
713 const char *ExtraCode,
714 raw_ostream &OS) {
715 // First try the generic code, which knows about modifiers like 'c' and 'n'.
716 if (!AsmPrinter::PrintAsmOperand(MI, OpNo, ExtraCode, OS))
717 return false;
718
719 if (!ExtraCode) {
720 const MachineOperand &MO = MI->getOperand(OpNo);
721 switch (MO.getType()) {
723 OS << MO.getImm();
724 return false;
726 // FIXME: only opcode that still contains registers, as required by
727 // MachineInstr::getDebugVariable().
728 assert(MI->getOpcode() == WebAssembly::INLINEASM);
729 OS << regToString(MO);
730 return false;
732 PrintSymbolOperand(MO, OS);
733 return false;
736 printOffset(MO.getOffset(), OS);
737 return false;
739 MO.getMBB()->getSymbol()->print(OS, MAI);
740 return false;
741 default:
742 break;
743 }
744 }
745
746 return true;
747}
748
750 unsigned OpNo,
751 const char *ExtraCode,
752 raw_ostream &OS) {
753 // The current approach to inline asm is that "r" constraints are expressed
754 // as local indices, rather than values on the operand stack. This simplifies
755 // using "r" as it eliminates the need to push and pop the values in a
756 // particular order, however it also makes it impossible to have an "m"
757 // constraint. So we don't support it.
758
759 return AsmPrinter::PrintAsmMemoryOperand(MI, OpNo, ExtraCode, OS);
760}
761
763
764INITIALIZE_PASS(WebAssemblyAsmPrinter, "webassembly-asm-printer",
765 "WebAssembly Assmebly Printer", false, false)
766
767// Force static initialization.
769LLVMInitializeWebAssemblyAsmPrinter() {
772}
assert(UImm &&(UImm !=~static_cast< T >(0)) &&"Invalid immediate!")
Function Alias Analysis Results
#define X(NUM, ENUM, NAME)
Definition ELF.h:849
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
#define LLVM_ABI
Definition Compiler.h:213
#define LLVM_EXTERNAL_VISIBILITY
Definition Compiler.h:132
IRTranslator LLVM IR MI
Module.h This file contains the declarations for the Module class.
#define F(x, y, z)
Definition MD5.cpp:54
#define I(x, y, z)
Definition MD5.cpp:57
#define G(x, y, z)
Definition MD5.cpp:55
This file declares the MachineConstantPool class which is an abstract constant pool to keep track of ...
Register const TargetRegisterInfo * TRI
This file implements a map that provides insertion order iteration.
This file contains the declarations for metadata subclasses.
#define T
OptimizedStructLayoutField Field
#define INITIALIZE_PASS(passName, arg, name, cfg, analysis)
Definition PassSupport.h:56
static StringRef getName(Value *V)
This file defines the SmallSet class.
This file contains some functions that are useful when dealing with strings.
#define LLVM_DEBUG(...)
Definition Debug.h:114
static TableGen::Emitter::Opt Y("gen-skeleton-entry", EmitSkeleton, "Generate example skeleton entry")
static std::string getEmscriptenInvokeSymbolName(wasm::WasmSignature *Sig)
static bool isEmscriptenInvokeName(StringRef Name)
static char getInvokeSig(wasm::ValType VT)
cl::opt< bool > WasmKeepRegisters
This file contains the declaration of the WebAssemblyMCAsmInfo class.
This file declares the class to lower WebAssembly MachineInstrs to their corresponding MCInst records...
This file provides WebAssembly-specific target descriptions.
This file declares WebAssembly-specific per-machine-function information.
This file contains the WebAssembly implementation of the WebAssemblyRegisterInfo class.
This file provides signature information for runtime libcalls.
This file registers the WebAssembly target.
This file declares the WebAssembly-specific subclass of TargetMachine.
This file declares WebAssembly-specific target streamer classes.
This file contains the declaration of the WebAssembly-specific type parsing utility functions.
This file contains the declaration of the WebAssembly-specific utility functions.
This file contains the entry points for global functions defined in the LLVM WebAssembly back-end.
MCSymbol * getSymbol(const GlobalValue *GV) const
void EmitToStreamer(MCStreamer &S, const MCInst &Inst)
virtual void emitGlobalVariable(const GlobalVariable *GV)
Emit the specified global variable to the .s file.
TargetMachine & TM
Target machine description.
Definition AsmPrinter.h:94
virtual void PrintSymbolOperand(const MachineOperand &MO, raw_ostream &OS)
Print the MachineOperand as a symbol.
const MCAsmInfo * MAI
Target Asm Printer information.
Definition AsmPrinter.h:97
MachineFunction * MF
The current machine function.
Definition AsmPrinter.h:109
virtual const MCExpr * lowerConstant(const Constant *CV, const Constant *BaseCV=nullptr, uint64_t Offset=0)
Lower the specified LLVM Constant to an MCExpr.
virtual void emitFunctionBodyStart()
Targets can override this to emit stuff before the first basic block in the function.
Definition AsmPrinter.h:626
virtual void emitLinkage(const GlobalValue *GV, MCSymbol *GVSym) const
This emits linkage information about GVSym based on GV, if this is supported by the target.
void printOffset(int64_t Offset, raw_ostream &OS) const
This is just convenient handler for printing offsets.
MCSymbol * getSymbolPreferLocal(const GlobalValue &GV) const
Similar to getSymbol() but preferred for references.
MCSymbol * CurrentFnSym
The symbol for the current function.
Definition AsmPrinter.h:128
MachineModuleInfo * MMI
This is a pointer to the current MachineModuleInfo.
Definition AsmPrinter.h:112
MCContext & OutContext
This is the context for the output file that we are streaming.
Definition AsmPrinter.h:101
void emitVisibility(MCSymbol *Sym, unsigned Visibility, bool IsDefinition=true) const
This emits visibility information about symbol, if this is supported by the target.
std::unique_ptr< MCStreamer > OutStreamer
This is the MCStreamer object for the file we are generating.
Definition AsmPrinter.h:106
virtual bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo, const char *ExtraCode, raw_ostream &OS)
Print the specified operand of MI, an INLINEASM instruction, using the specified assembler variant as...
bool isVerbose() const
Return true if assembly output should contain comments.
Definition AsmPrinter.h:312
MCSymbol * GetExternalSymbolSymbol(const Twine &Sym) const
Return the MCSymbol for the specified ExternalSymbol.
@ Debug
Emit .debug_frame.
Definition AsmPrinter.h:169
virtual bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo, const char *ExtraCode, raw_ostream &OS)
Print the specified operand of MI, an INLINEASM instruction, using the specified assembler variant.
ConstantArray - Constant Array Declarations.
Definition Constants.h:576
Implements a dense probed hash-table based set.
Definition DenseSet.h:279
bool isThreadLocal() const
If the value is "Thread Local", its value isn't shared by the threads.
VisibilityTypes getVisibility() const
LLVM_ABI bool isDeclaration() const
Return true if the primary definition of this global value is outside of the current translation unit...
Definition Globals.cpp:331
unsigned getAddressSpace() const
Module * getParent()
Get the module that this global value is contained inside of...
LLVM_ABI const DataLayout & getDataLayout() const
Get the data layout of the module this global belongs to.
Definition Globals.cpp:135
bool hasCommonLinkage() const
Type * getValueType() const
bool hasInitializer() const
Definitions have initializers, declarations don't.
static LLVM_ABI const MCConstantExpr * create(int64_t Value, MCContext &Ctx, bool PrintInHex=false, unsigned SizeInBytes=0)
Definition MCExpr.cpp:212
Instances of this class represent a single low-level machine instruction.
Definition MCInst.h:188
This represents a section on wasm.
static const MCSymbolRefExpr * create(const MCSymbol *Symbol, MCContext &Ctx, SMLoc Loc=SMLoc())
Definition MCExpr.h:214
void setSignature(wasm::WasmSignature *Sig)
std::optional< wasm::WasmSymbolType > getType() const
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
Definition MCSymbol.h:42
LLVM_ABI void print(raw_ostream &OS, const MCAsmInfo *MAI) const
print - Print the value to the stream OS.
Definition MCSymbol.cpp:59
Target specific streamer interface.
Definition MCStreamer.h:94
Metadata node.
Definition Metadata.h:1080
A single uniqued string.
Definition Metadata.h:722
LLVM_ABI StringRef getString() const
Definition Metadata.cpp:632
Machine Value Type.
LLVM_ABI MCSymbol * getSymbol() const
Return the MCSymbol for this basic block.
Representation of each machine instruction.
MachineModuleInfoWasm - This is a MachineModuleInfoImpl implementation for Wasm targets.
SetVector< StringRef > MachineSymbolsUsed
MachineOperand class - Representation of each machine instruction operand.
int64_t getImm() const
MachineBasicBlock * getMBB() const
MachineOperandType getType() const
getType - Returns the MachineOperandType for this operand.
const char * getSymbolName() const
Register getReg() const
getReg - Returns the register number.
@ MO_Immediate
Immediate operand.
@ MO_GlobalAddress
Address of a global value.
@ MO_MachineBasicBlock
MachineBasicBlock reference.
@ MO_Register
Register operand.
@ MO_ExternalSymbol
Name of external global symbol.
int64_t getOffset() const
Return the offset from the symbol in this operand.
This class implements a map that also provides access to all stored values in a deterministic order.
Definition MapVector.h:36
Root of the metadata hierarchy.
Definition Metadata.h:64
A Module instance is used to store all the information related to an LLVM module.
Definition Module.h:67
LLVMContext & getContext() const
Get the global data context.
Definition Module.h:285
A tuple of MDNodes.
Definition Metadata.h:1760
Wrapper class representing virtual and physical registers.
Definition Register.h:20
constexpr bool isVirtual() const
Return true if the specified register number is in the virtual register namespace.
Definition Register.h:79
Represents a location in source code.
Definition SMLoc.h:22
static SectionKind getMetadata()
SmallSet - This maintains a set of unique values, optimizing for the case when the set is small (less...
Definition SmallSet.h:134
std::pair< const_iterator, bool > insert(const T &V)
insert - Insert an element into the set if it isn't already there.
Definition SmallSet.h:184
reference emplace_back(ArgTypes &&... Args)
void push_back(const T &Elt)
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
StringRef - Represent a constant reference to a string, i.e.
Definition StringRef.h:55
TargetRegisterInfo base class - We assume that the target defines a static array of TargetRegisterDes...
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition Twine.h:82
The instances of the Type class are immutable: once they are created, they are never changed.
Definition Type.h:46
op_range operands()
Definition User.h:267
LLVM Value Representation.
Definition Value.h:75
LLVM_ABI const Value * stripPointerCasts() const
Strip off pointer casts, all-zero GEPs and address space casts.
Definition Value.cpp:713
void emitJumpTableInfo() override
Print assembly representations of the jump tables used by the current function to the current output ...
void emitGlobalVariable(const GlobalVariable *GV) override
Emit the specified global variable to the .s file.
bool PrintAsmMemoryOperand(const MachineInstr *MI, unsigned OpNo, const char *ExtraCode, raw_ostream &OS) override
Print the specified operand of MI, an INLINEASM instruction, using the specified assembler variant as...
const WebAssemblySubtarget & getSubtarget() const
WebAssemblyTargetStreamer * getTargetStreamer()
void emitInstruction(const MachineInstr *MI) override
Targets should implement this to emit instructions.
std::string regToString(const MachineOperand &MO)
void emitSymbolType(const MCSymbolWasm *Sym)
MCSymbol * getOrCreateWasmSymbol(StringRef Name)
void emitConstantPool() override
Print to the current output stream assembly representations of the constants in the constant pool MCP...
MVT getRegType(unsigned RegNo) const
void emitFunctionBodyStart() override
Targets can override this to emit stuff before the first basic block in the function.
bool PrintAsmOperand(const MachineInstr *MI, unsigned OpNo, const char *ExtraCode, raw_ostream &OS) override
Print the specified operand of MI, an INLINEASM instruction, using the specified assembler variant.
void emitEndOfAsmFile(Module &M) override
This virtual method can be overridden by targets that want to emit something at the end of their file...
MCSymbolWasm * getMCSymbolForFunction(const Function *F, wasm::WasmSignature *Sig, bool &InvokeDetected)
This class is used to lower an MachineInstr into an MCInst.
void lower(const MachineInstr *MI, MCInst &OutMI) const
WebAssembly-specific streamer interface, to implement support WebAssembly-specific assembly directive...
virtual void emitFunctionType(const MCSymbolWasm *Sym)=0
.functype
virtual void emitLocal(ArrayRef< wasm::ValType > Types)=0
.local
virtual void emitTagType(const MCSymbolWasm *Sym)=0
.tagtype
virtual void emitExportName(const MCSymbolWasm *Sym, StringRef ExportName)=0
.export_name
virtual void emitGlobalType(const MCSymbolWasm *Sym)=0
.globaltype
virtual void emitImportModule(const MCSymbolWasm *Sym, StringRef ImportModule)=0
.import_module
virtual void emitTableType(const MCSymbolWasm *Sym)=0
.tabletype
virtual void emitImportName(const MCSymbolWasm *Sym, StringRef ImportName)=0
.import_name
virtual void emitIndIdx(const MCExpr *Value)=0
.indidx
std::pair< iterator, bool > insert(const ValueT &V)
Definition DenseSet.h:202
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition raw_ostream.h:53
LLVM_ABI StringRef LanguageString(unsigned Language)
Definition Dwarf.cpp:412
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
MCSymbolWasm * getOrCreateFunctionTableSymbol(MCContext &Ctx, const WebAssemblySubtarget *Subtarget)
Returns the __indirect_function_table, for use in call_indirect and in function bitcasts.
void wasmSymbolSetType(MCSymbolWasm *Sym, const Type *GlobalVT, ArrayRef< MVT > VTs)
Sets a Wasm Symbol Type.
static const unsigned UnusedReg
cl::opt< bool > WasmEnableEmEH
cl::opt< bool > WasmEnableEmSjLj
std::string signatureToString(const wasm::WasmSignature *Sig)
void getLibcallSignature(const WebAssemblySubtarget &Subtarget, RTLIB::Libcall LC, SmallVectorImpl< wasm::ValType > &Rets, SmallVectorImpl< wasm::ValType > &Params)
bool isWasmVarAddressSpace(unsigned AS)
@ WASM_TYPE_I64
Definition Wasm.h:57
@ WASM_TYPE_I32
Definition Wasm.h:56
@ WASM_FEATURE_PREFIX_USED
Definition Wasm.h:189
@ WASM_FEATURE_PREFIX_DISALLOWED
Definition Wasm.h:190
@ WASM_SYMBOL_TYPE_GLOBAL
Definition Wasm.h:231
@ WASM_SYMBOL_TYPE_DATA
Definition Wasm.h:230
@ WASM_SYMBOL_TYPE_TAG
Definition Wasm.h:233
@ WASM_SYMBOL_TYPE_TABLE
Definition Wasm.h:234
@ WASM_SYMBOL_TYPE_FUNCTION
Definition Wasm.h:229
This is an optimization pass for GlobalISel generic memory operations.
void computeSignatureVTs(const FunctionType *Ty, const Function *TargetFunc, const Function &ContextFunc, const TargetMachine &TM, SmallVectorImpl< MVT > &Params, SmallVectorImpl< MVT > &Results)
const SubtargetFeatureKV WebAssemblyFeatureKV[WebAssembly::NumSubtargetFeatures]
decltype(auto) dyn_cast(const From &Val)
dyn_cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:643
LLVM_ABI bool getConstantStringInfo(const Value *V, StringRef &Str, bool TrimAtNul=true)
This function computes the length of a null-terminated C string pointed to by V.
std::string utostr(uint64_t X, bool isNeg=false)
FunctionAddr VTableAddr uintptr_t uintptr_t Version
Definition InstrProf.h:334
LLVM_ABI raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition Debug.cpp:207
Target & getTheWebAssemblyTarget32()
LLVM_ABI void report_fatal_error(Error Err, bool gen_crash_diag=true)
Definition Error.cpp:163
bool isa(const From &Val)
isa<X> - Return true if the parameter to the template is an instance of one of the template type argu...
Definition Casting.h:547
LLVM_ABI raw_fd_ostream & errs()
This returns a reference to a raw_ostream for standard error.
Target & getTheWebAssemblyTarget64()
DWARFExpression::Operation Op
void valTypesFromMVTs(ArrayRef< MVT > In, SmallVectorImpl< wasm::ValType > &Out)
decltype(auto) cast(const From &Val)
cast<X> - Return the argument parameter cast to the specified type.
Definition Casting.h:559
wasm::WasmSignature * signatureFromMVTs(MCContext &Ctx, const SmallVectorImpl< MVT > &Results, const SmallVectorImpl< MVT > &Params)
void computeLegalValueVTs(const WebAssemblyTargetLowering &TLI, LLVMContext &Ctx, const DataLayout &DL, Type *Ty, SmallVectorImpl< MVT > &ValueVTs)
@ MCSA_NoDeadStrip
.no_dead_strip (MachO)
RegisterAsmPrinter - Helper template for registering a target specific assembly printer,...
Used to provide key value pairs for feature and CPU bit flags.
SmallVector< ValType, 1 > Returns
Definition Wasm.h:516
SmallVector< ValType, 4 > Params
Definition Wasm.h:517