10b57cec5SDimitry Andric //===-- WasmDumper.cpp - Wasm-specific object file dumper -----------------===//
20b57cec5SDimitry Andric //
30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60b57cec5SDimitry Andric //
70b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
80b57cec5SDimitry Andric //
90b57cec5SDimitry Andric // This file implements the Wasm-specific dumper for llvm-readobj.
100b57cec5SDimitry Andric //
110b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
120b57cec5SDimitry Andric
130b57cec5SDimitry Andric #include "ObjDumper.h"
140b57cec5SDimitry Andric #include "llvm-readobj.h"
150b57cec5SDimitry Andric #include "llvm/Object/Wasm.h"
160b57cec5SDimitry Andric #include "llvm/Support/ScopedPrinter.h"
170b57cec5SDimitry Andric
180b57cec5SDimitry Andric using namespace llvm;
190b57cec5SDimitry Andric using namespace object;
200b57cec5SDimitry Andric
210b57cec5SDimitry Andric namespace {
220b57cec5SDimitry Andric
23349cc55cSDimitry Andric const EnumEntry<unsigned> WasmSymbolTypes[] = {
240b57cec5SDimitry Andric #define ENUM_ENTRY(X) \
250b57cec5SDimitry Andric { #X, wasm::WASM_SYMBOL_TYPE_##X }
260b57cec5SDimitry Andric ENUM_ENTRY(FUNCTION), ENUM_ENTRY(DATA), ENUM_ENTRY(GLOBAL),
27fe6060f1SDimitry Andric ENUM_ENTRY(SECTION), ENUM_ENTRY(TAG), ENUM_ENTRY(TABLE),
280b57cec5SDimitry Andric #undef ENUM_ENTRY
290b57cec5SDimitry Andric };
300b57cec5SDimitry Andric
31349cc55cSDimitry Andric const EnumEntry<uint32_t> WasmSectionTypes[] = {
320b57cec5SDimitry Andric #define ENUM_ENTRY(X) \
330b57cec5SDimitry Andric { #X, wasm::WASM_SEC_##X }
340b57cec5SDimitry Andric ENUM_ENTRY(CUSTOM), ENUM_ENTRY(TYPE), ENUM_ENTRY(IMPORT),
350b57cec5SDimitry Andric ENUM_ENTRY(FUNCTION), ENUM_ENTRY(TABLE), ENUM_ENTRY(MEMORY),
36fe6060f1SDimitry Andric ENUM_ENTRY(GLOBAL), ENUM_ENTRY(TAG), ENUM_ENTRY(EXPORT),
370b57cec5SDimitry Andric ENUM_ENTRY(START), ENUM_ENTRY(ELEM), ENUM_ENTRY(CODE),
380b57cec5SDimitry Andric ENUM_ENTRY(DATA), ENUM_ENTRY(DATACOUNT),
390b57cec5SDimitry Andric #undef ENUM_ENTRY
400b57cec5SDimitry Andric };
410b57cec5SDimitry Andric
42349cc55cSDimitry Andric const EnumEntry<unsigned> WasmSymbolFlags[] = {
430b57cec5SDimitry Andric #define ENUM_ENTRY(X) \
440b57cec5SDimitry Andric { #X, wasm::WASM_SYMBOL_##X }
450b57cec5SDimitry Andric ENUM_ENTRY(BINDING_GLOBAL),
460b57cec5SDimitry Andric ENUM_ENTRY(BINDING_WEAK),
470b57cec5SDimitry Andric ENUM_ENTRY(BINDING_LOCAL),
480b57cec5SDimitry Andric ENUM_ENTRY(VISIBILITY_DEFAULT),
490b57cec5SDimitry Andric ENUM_ENTRY(VISIBILITY_HIDDEN),
500b57cec5SDimitry Andric ENUM_ENTRY(UNDEFINED),
510b57cec5SDimitry Andric ENUM_ENTRY(EXPORTED),
520b57cec5SDimitry Andric ENUM_ENTRY(EXPLICIT_NAME),
538bcb0991SDimitry Andric ENUM_ENTRY(NO_STRIP),
540b57cec5SDimitry Andric #undef ENUM_ENTRY
550b57cec5SDimitry Andric };
560b57cec5SDimitry Andric
570b57cec5SDimitry Andric class WasmDumper : public ObjDumper {
580b57cec5SDimitry Andric public:
WasmDumper(const WasmObjectFile * Obj,ScopedPrinter & Writer)590b57cec5SDimitry Andric WasmDumper(const WasmObjectFile *Obj, ScopedPrinter &Writer)
60e8d8bef9SDimitry Andric : ObjDumper(Writer, Obj->getFileName()), Obj(Obj) {}
610b57cec5SDimitry Andric
620b57cec5SDimitry Andric void printFileHeaders() override;
630b57cec5SDimitry Andric void printSectionHeaders() override;
640b57cec5SDimitry Andric void printRelocations() override;
printUnwindInfo()650b57cec5SDimitry Andric void printUnwindInfo() override { llvm_unreachable("unimplemented"); }
printStackMap() const660b57cec5SDimitry Andric void printStackMap() const override { llvm_unreachable("unimplemented"); }
670b57cec5SDimitry Andric
680b57cec5SDimitry Andric protected:
690b57cec5SDimitry Andric void printSymbol(const SymbolRef &Sym);
700b57cec5SDimitry Andric void printRelocation(const SectionRef &Section, const RelocationRef &Reloc);
710b57cec5SDimitry Andric
720b57cec5SDimitry Andric private:
73*5f757f3fSDimitry Andric void printSymbols(bool ExtraSymInfo) override;
printDynamicSymbols()740b57cec5SDimitry Andric void printDynamicSymbols() override { llvm_unreachable("unimplemented"); }
750b57cec5SDimitry Andric
760b57cec5SDimitry Andric const WasmObjectFile *Obj;
770b57cec5SDimitry Andric };
780b57cec5SDimitry Andric
printFileHeaders()790b57cec5SDimitry Andric void WasmDumper::printFileHeaders() {
800b57cec5SDimitry Andric W.printHex("Version", Obj->getHeader().Version);
810b57cec5SDimitry Andric }
820b57cec5SDimitry Andric
printRelocation(const SectionRef & Section,const RelocationRef & Reloc)830b57cec5SDimitry Andric void WasmDumper::printRelocation(const SectionRef &Section,
840b57cec5SDimitry Andric const RelocationRef &Reloc) {
850b57cec5SDimitry Andric SmallString<64> RelocTypeName;
860b57cec5SDimitry Andric uint64_t RelocType = Reloc.getType();
870b57cec5SDimitry Andric Reloc.getTypeName(RelocTypeName);
880b57cec5SDimitry Andric const wasm::WasmRelocation &WasmReloc = Obj->getWasmRelocation(Reloc);
890b57cec5SDimitry Andric
900b57cec5SDimitry Andric StringRef SymName;
910b57cec5SDimitry Andric symbol_iterator SI = Reloc.getSymbol();
920b57cec5SDimitry Andric if (SI != Obj->symbol_end())
938bcb0991SDimitry Andric SymName = unwrapOrError(Obj->getFileName(), SI->getName());
940b57cec5SDimitry Andric
955ffd83dbSDimitry Andric bool HasAddend = wasm::relocTypeHasAddend(static_cast<uint32_t>(RelocType));
965ffd83dbSDimitry Andric
970b57cec5SDimitry Andric if (opts::ExpandRelocs) {
980b57cec5SDimitry Andric DictScope Group(W, "Relocation");
990b57cec5SDimitry Andric W.printNumber("Type", RelocTypeName, RelocType);
1000b57cec5SDimitry Andric W.printHex("Offset", Reloc.getOffset());
1010b57cec5SDimitry Andric if (!SymName.empty())
1020b57cec5SDimitry Andric W.printString("Symbol", SymName);
1030b57cec5SDimitry Andric else
1040b57cec5SDimitry Andric W.printHex("Index", WasmReloc.Index);
1050b57cec5SDimitry Andric if (HasAddend)
1060b57cec5SDimitry Andric W.printNumber("Addend", WasmReloc.Addend);
1070b57cec5SDimitry Andric } else {
1080b57cec5SDimitry Andric raw_ostream &OS = W.startLine();
1090b57cec5SDimitry Andric OS << W.hex(Reloc.getOffset()) << " " << RelocTypeName << " ";
1100b57cec5SDimitry Andric if (!SymName.empty())
1110b57cec5SDimitry Andric OS << SymName;
1120b57cec5SDimitry Andric else
1130b57cec5SDimitry Andric OS << WasmReloc.Index;
1140b57cec5SDimitry Andric if (HasAddend)
1150b57cec5SDimitry Andric OS << " " << WasmReloc.Addend;
1160b57cec5SDimitry Andric OS << "\n";
1170b57cec5SDimitry Andric }
1180b57cec5SDimitry Andric }
1190b57cec5SDimitry Andric
printRelocations()1200b57cec5SDimitry Andric void WasmDumper::printRelocations() {
1210b57cec5SDimitry Andric ListScope D(W, "Relocations");
1220b57cec5SDimitry Andric
1230b57cec5SDimitry Andric int SectionNumber = 0;
1240b57cec5SDimitry Andric for (const SectionRef &Section : Obj->sections()) {
1250b57cec5SDimitry Andric bool PrintedGroup = false;
1268bcb0991SDimitry Andric StringRef Name = unwrapOrError(Obj->getFileName(), Section.getName());
1278bcb0991SDimitry Andric
1280b57cec5SDimitry Andric ++SectionNumber;
1290b57cec5SDimitry Andric
1300b57cec5SDimitry Andric for (const RelocationRef &Reloc : Section.relocations()) {
1310b57cec5SDimitry Andric if (!PrintedGroup) {
1320b57cec5SDimitry Andric W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
1330b57cec5SDimitry Andric W.indent();
1340b57cec5SDimitry Andric PrintedGroup = true;
1350b57cec5SDimitry Andric }
1360b57cec5SDimitry Andric
1370b57cec5SDimitry Andric printRelocation(Section, Reloc);
1380b57cec5SDimitry Andric }
1390b57cec5SDimitry Andric
1400b57cec5SDimitry Andric if (PrintedGroup) {
1410b57cec5SDimitry Andric W.unindent();
1420b57cec5SDimitry Andric W.startLine() << "}\n";
1430b57cec5SDimitry Andric }
1440b57cec5SDimitry Andric }
1450b57cec5SDimitry Andric }
1460b57cec5SDimitry Andric
printSymbols(bool)147*5f757f3fSDimitry Andric void WasmDumper::printSymbols(bool /*ExtraSymInfo*/) {
1480b57cec5SDimitry Andric ListScope Group(W, "Symbols");
1490b57cec5SDimitry Andric
1500b57cec5SDimitry Andric for (const SymbolRef &Symbol : Obj->symbols())
1510b57cec5SDimitry Andric printSymbol(Symbol);
1520b57cec5SDimitry Andric }
1530b57cec5SDimitry Andric
printSectionHeaders()1540b57cec5SDimitry Andric void WasmDumper::printSectionHeaders() {
1550b57cec5SDimitry Andric ListScope Group(W, "Sections");
1560b57cec5SDimitry Andric for (const SectionRef &Section : Obj->sections()) {
1570b57cec5SDimitry Andric const WasmSection &WasmSec = Obj->getWasmSection(Section);
1580b57cec5SDimitry Andric DictScope SectionD(W, "Section");
159bdd1243dSDimitry Andric W.printEnum("Type", WasmSec.Type, ArrayRef(WasmSectionTypes));
1600b57cec5SDimitry Andric W.printNumber("Size", static_cast<uint64_t>(WasmSec.Content.size()));
1610b57cec5SDimitry Andric W.printNumber("Offset", WasmSec.Offset);
1620b57cec5SDimitry Andric switch (WasmSec.Type) {
1630b57cec5SDimitry Andric case wasm::WASM_SEC_CUSTOM:
1640b57cec5SDimitry Andric W.printString("Name", WasmSec.Name);
1650b57cec5SDimitry Andric if (WasmSec.Name == "linking") {
1660b57cec5SDimitry Andric const wasm::WasmLinkingData &LinkingData = Obj->linkingData();
1670b57cec5SDimitry Andric if (!LinkingData.InitFunctions.empty()) {
1680b57cec5SDimitry Andric ListScope Group(W, "InitFunctions");
1690b57cec5SDimitry Andric for (const wasm::WasmInitFunc &F : LinkingData.InitFunctions)
1700b57cec5SDimitry Andric W.startLine() << F.Symbol << " (priority=" << F.Priority << ")\n";
1710b57cec5SDimitry Andric }
1720b57cec5SDimitry Andric }
1730b57cec5SDimitry Andric break;
1740b57cec5SDimitry Andric case wasm::WASM_SEC_DATA: {
1750b57cec5SDimitry Andric ListScope Group(W, "Segments");
1760b57cec5SDimitry Andric for (const WasmSegment &Segment : Obj->dataSegments()) {
1770b57cec5SDimitry Andric const wasm::WasmDataSegment &Seg = Segment.Data;
1780b57cec5SDimitry Andric DictScope Group(W, "Segment");
1790b57cec5SDimitry Andric if (!Seg.Name.empty())
1800b57cec5SDimitry Andric W.printString("Name", Seg.Name);
1810b57cec5SDimitry Andric W.printNumber("Size", static_cast<uint64_t>(Seg.Content.size()));
18281ad6265SDimitry Andric if (Seg.Offset.Extended)
18381ad6265SDimitry Andric llvm_unreachable("extended const exprs not supported");
18481ad6265SDimitry Andric else if (Seg.Offset.Inst.Opcode == wasm::WASM_OPCODE_I32_CONST)
18581ad6265SDimitry Andric W.printNumber("Offset", Seg.Offset.Inst.Value.Int32);
18681ad6265SDimitry Andric else if (Seg.Offset.Inst.Opcode == wasm::WASM_OPCODE_I64_CONST)
18781ad6265SDimitry Andric W.printNumber("Offset", Seg.Offset.Inst.Value.Int64);
18881ad6265SDimitry Andric else if (Seg.Offset.Inst.Opcode == wasm::WASM_OPCODE_GLOBAL_GET) {
1891fd87a68SDimitry Andric ListScope Group(W, "Offset");
19081ad6265SDimitry Andric W.printNumber("Global", Seg.Offset.Inst.Value.Global);
1911fd87a68SDimitry Andric } else
1925ffd83dbSDimitry Andric llvm_unreachable("unknown init expr opcode");
1930b57cec5SDimitry Andric }
1940b57cec5SDimitry Andric break;
1950b57cec5SDimitry Andric }
1960b57cec5SDimitry Andric case wasm::WASM_SEC_MEMORY:
1970b57cec5SDimitry Andric ListScope Group(W, "Memories");
1980b57cec5SDimitry Andric for (const wasm::WasmLimits &Memory : Obj->memories()) {
1990b57cec5SDimitry Andric DictScope Group(W, "Memory");
200fe6060f1SDimitry Andric W.printNumber("MinPages", Memory.Minimum);
2010b57cec5SDimitry Andric if (Memory.Flags & wasm::WASM_LIMITS_FLAG_HAS_MAX) {
2020b57cec5SDimitry Andric W.printNumber("MaxPages", WasmSec.Offset);
2030b57cec5SDimitry Andric }
2040b57cec5SDimitry Andric }
2050b57cec5SDimitry Andric break;
2060b57cec5SDimitry Andric }
2070b57cec5SDimitry Andric
2080b57cec5SDimitry Andric if (opts::SectionRelocations) {
2090b57cec5SDimitry Andric ListScope D(W, "Relocations");
2100b57cec5SDimitry Andric for (const RelocationRef &Reloc : Section.relocations())
2110b57cec5SDimitry Andric printRelocation(Section, Reloc);
2120b57cec5SDimitry Andric }
2130b57cec5SDimitry Andric
2140b57cec5SDimitry Andric if (opts::SectionData) {
2150b57cec5SDimitry Andric W.printBinaryBlock("SectionData", WasmSec.Content);
2160b57cec5SDimitry Andric }
2170b57cec5SDimitry Andric }
2180b57cec5SDimitry Andric }
2190b57cec5SDimitry Andric
printSymbol(const SymbolRef & Sym)2200b57cec5SDimitry Andric void WasmDumper::printSymbol(const SymbolRef &Sym) {
2210b57cec5SDimitry Andric DictScope D(W, "Symbol");
2220b57cec5SDimitry Andric WasmSymbol Symbol = Obj->getWasmSymbol(Sym.getRawDataRefImpl());
2230b57cec5SDimitry Andric W.printString("Name", Symbol.Info.Name);
224bdd1243dSDimitry Andric W.printEnum("Type", Symbol.Info.Kind, ArrayRef(WasmSymbolTypes));
225bdd1243dSDimitry Andric W.printFlags("Flags", Symbol.Info.Flags, ArrayRef(WasmSymbolFlags));
2260b57cec5SDimitry Andric
2270b57cec5SDimitry Andric if (Symbol.Info.Flags & wasm::WASM_SYMBOL_UNDEFINED) {
2285ffd83dbSDimitry Andric if (Symbol.Info.ImportName) {
2295ffd83dbSDimitry Andric W.printString("ImportName", *Symbol.Info.ImportName);
2305ffd83dbSDimitry Andric }
2315ffd83dbSDimitry Andric if (Symbol.Info.ImportModule) {
2325ffd83dbSDimitry Andric W.printString("ImportModule", *Symbol.Info.ImportModule);
2335ffd83dbSDimitry Andric }
2340b57cec5SDimitry Andric }
2350b57cec5SDimitry Andric if (Symbol.Info.Kind != wasm::WASM_SYMBOL_TYPE_DATA) {
2360b57cec5SDimitry Andric W.printHex("ElementIndex", Symbol.Info.ElementIndex);
2370b57cec5SDimitry Andric } else if (!(Symbol.Info.Flags & wasm::WASM_SYMBOL_UNDEFINED)) {
2380b57cec5SDimitry Andric W.printHex("Offset", Symbol.Info.DataRef.Offset);
2390b57cec5SDimitry Andric W.printHex("Segment", Symbol.Info.DataRef.Segment);
2400b57cec5SDimitry Andric W.printHex("Size", Symbol.Info.DataRef.Size);
2410b57cec5SDimitry Andric }
2420b57cec5SDimitry Andric }
2430b57cec5SDimitry Andric
2440b57cec5SDimitry Andric } // namespace
2450b57cec5SDimitry Andric
2460b57cec5SDimitry Andric namespace llvm {
2470b57cec5SDimitry Andric
createWasmDumper(const object::WasmObjectFile & Obj,ScopedPrinter & Writer)248e8d8bef9SDimitry Andric std::unique_ptr<ObjDumper> createWasmDumper(const object::WasmObjectFile &Obj,
249e8d8bef9SDimitry Andric ScopedPrinter &Writer) {
250e8d8bef9SDimitry Andric return std::make_unique<WasmDumper>(&Obj, Writer);
2510b57cec5SDimitry Andric }
2520b57cec5SDimitry Andric
2530b57cec5SDimitry Andric } // namespace llvm
254