118eafb6cSDan Gohman //===- lib/MC/WasmObjectWriter.cpp - Wasm File Writer ---------------------===// 218eafb6cSDan Gohman // 318eafb6cSDan Gohman // The LLVM Compiler Infrastructure 418eafb6cSDan Gohman // 518eafb6cSDan Gohman // This file is distributed under the University of Illinois Open Source 618eafb6cSDan Gohman // License. See LICENSE.TXT for details. 718eafb6cSDan Gohman // 818eafb6cSDan Gohman //===----------------------------------------------------------------------===// 918eafb6cSDan Gohman // 1018eafb6cSDan Gohman // This file implements Wasm object file writer information. 1118eafb6cSDan Gohman // 1218eafb6cSDan Gohman //===----------------------------------------------------------------------===// 1318eafb6cSDan Gohman 1418eafb6cSDan Gohman #include "llvm/ADT/STLExtras.h" 1518eafb6cSDan Gohman #include "llvm/ADT/SmallPtrSet.h" 16264b5d9eSZachary Turner #include "llvm/BinaryFormat/Wasm.h" 1718eafb6cSDan Gohman #include "llvm/MC/MCAsmBackend.h" 1818eafb6cSDan Gohman #include "llvm/MC/MCAsmInfo.h" 1918eafb6cSDan Gohman #include "llvm/MC/MCAsmLayout.h" 2018eafb6cSDan Gohman #include "llvm/MC/MCAssembler.h" 2118eafb6cSDan Gohman #include "llvm/MC/MCContext.h" 2218eafb6cSDan Gohman #include "llvm/MC/MCExpr.h" 2318eafb6cSDan Gohman #include "llvm/MC/MCFixupKindInfo.h" 2418eafb6cSDan Gohman #include "llvm/MC/MCObjectFileInfo.h" 2518eafb6cSDan Gohman #include "llvm/MC/MCObjectWriter.h" 2618eafb6cSDan Gohman #include "llvm/MC/MCSectionWasm.h" 2718eafb6cSDan Gohman #include "llvm/MC/MCSymbolWasm.h" 2818eafb6cSDan Gohman #include "llvm/MC/MCValue.h" 2918eafb6cSDan Gohman #include "llvm/MC/MCWasmObjectWriter.h" 30d934cb88SDan Gohman #include "llvm/Support/Casting.h" 3118eafb6cSDan Gohman #include "llvm/Support/Debug.h" 3218eafb6cSDan Gohman #include "llvm/Support/ErrorHandling.h" 33d934cb88SDan Gohman #include "llvm/Support/LEB128.h" 3418eafb6cSDan Gohman #include "llvm/Support/StringSaver.h" 3518eafb6cSDan Gohman #include <vector> 3618eafb6cSDan Gohman 3718eafb6cSDan Gohman using namespace llvm; 3818eafb6cSDan Gohman 395e3d33a7SSam Clegg #define DEBUG_TYPE "mc" 4018eafb6cSDan Gohman 4118eafb6cSDan Gohman namespace { 429e15f359SSam Clegg 43d934cb88SDan Gohman // For patching purposes, we need to remember where each section starts, both 44d934cb88SDan Gohman // for patching up the section size field, and for patching up references to 45d934cb88SDan Gohman // locations within the section. 46d934cb88SDan Gohman struct SectionBookkeeping { 47d934cb88SDan Gohman // Where the size of the section is written. 48d934cb88SDan Gohman uint64_t SizeOffset; 49d934cb88SDan Gohman // Where the contents of the section starts (after the header). 50d934cb88SDan Gohman uint64_t ContentsOffset; 51d934cb88SDan Gohman }; 52d934cb88SDan Gohman 539e15f359SSam Clegg // The signature of a wasm function, in a struct capable of being used as a 549e15f359SSam Clegg // DenseMap key. 559e15f359SSam Clegg struct WasmFunctionType { 569e15f359SSam Clegg // Support empty and tombstone instances, needed by DenseMap. 579e15f359SSam Clegg enum { Plain, Empty, Tombstone } State; 589e15f359SSam Clegg 599e15f359SSam Clegg // The return types of the function. 609e15f359SSam Clegg SmallVector<wasm::ValType, 1> Returns; 619e15f359SSam Clegg 629e15f359SSam Clegg // The parameter types of the function. 639e15f359SSam Clegg SmallVector<wasm::ValType, 4> Params; 649e15f359SSam Clegg 659e15f359SSam Clegg WasmFunctionType() : State(Plain) {} 669e15f359SSam Clegg 679e15f359SSam Clegg bool operator==(const WasmFunctionType &Other) const { 689e15f359SSam Clegg return State == Other.State && Returns == Other.Returns && 699e15f359SSam Clegg Params == Other.Params; 709e15f359SSam Clegg } 719e15f359SSam Clegg }; 729e15f359SSam Clegg 739e15f359SSam Clegg // Traits for using WasmFunctionType in a DenseMap. 749e15f359SSam Clegg struct WasmFunctionTypeDenseMapInfo { 759e15f359SSam Clegg static WasmFunctionType getEmptyKey() { 769e15f359SSam Clegg WasmFunctionType FuncTy; 779e15f359SSam Clegg FuncTy.State = WasmFunctionType::Empty; 789e15f359SSam Clegg return FuncTy; 799e15f359SSam Clegg } 809e15f359SSam Clegg static WasmFunctionType getTombstoneKey() { 819e15f359SSam Clegg WasmFunctionType FuncTy; 829e15f359SSam Clegg FuncTy.State = WasmFunctionType::Tombstone; 839e15f359SSam Clegg return FuncTy; 849e15f359SSam Clegg } 859e15f359SSam Clegg static unsigned getHashValue(const WasmFunctionType &FuncTy) { 869e15f359SSam Clegg uintptr_t Value = FuncTy.State; 879e15f359SSam Clegg for (wasm::ValType Ret : FuncTy.Returns) 889e15f359SSam Clegg Value += DenseMapInfo<int32_t>::getHashValue(int32_t(Ret)); 899e15f359SSam Clegg for (wasm::ValType Param : FuncTy.Params) 909e15f359SSam Clegg Value += DenseMapInfo<int32_t>::getHashValue(int32_t(Param)); 919e15f359SSam Clegg return Value; 929e15f359SSam Clegg } 939e15f359SSam Clegg static bool isEqual(const WasmFunctionType &LHS, 949e15f359SSam Clegg const WasmFunctionType &RHS) { 959e15f359SSam Clegg return LHS == RHS; 969e15f359SSam Clegg } 979e15f359SSam Clegg }; 989e15f359SSam Clegg 997c395943SSam Clegg // A wasm data segment. A wasm binary contains only a single data section 1007c395943SSam Clegg // but that can contain many segments, each with their own virtual location 1017c395943SSam Clegg // in memory. Each MCSection data created by llvm is modeled as its own 1027c395943SSam Clegg // wasm data segment. 1037c395943SSam Clegg struct WasmDataSegment { 1047c395943SSam Clegg MCSectionWasm *Section; 105d95ed959SSam Clegg StringRef Name; 1067c395943SSam Clegg uint32_t Offset; 10763ebb813SSam Clegg uint32_t Alignment; 10863ebb813SSam Clegg uint32_t Flags; 1097c395943SSam Clegg SmallVector<char, 4> Data; 1107c395943SSam Clegg }; 1117c395943SSam Clegg 1129e15f359SSam Clegg // A wasm import to be written into the import section. 1139e15f359SSam Clegg struct WasmImport { 1149e15f359SSam Clegg StringRef ModuleName; 1159e15f359SSam Clegg StringRef FieldName; 1169e15f359SSam Clegg unsigned Kind; 1179e15f359SSam Clegg int32_t Type; 1189e15f359SSam Clegg }; 1199e15f359SSam Clegg 1209e15f359SSam Clegg // A wasm function to be written into the function section. 1219e15f359SSam Clegg struct WasmFunction { 1229e15f359SSam Clegg int32_t Type; 1239e15f359SSam Clegg const MCSymbolWasm *Sym; 1249e15f359SSam Clegg }; 1259e15f359SSam Clegg 1269e15f359SSam Clegg // A wasm export to be written into the export section. 1279e15f359SSam Clegg struct WasmExport { 1289e15f359SSam Clegg StringRef FieldName; 1299e15f359SSam Clegg unsigned Kind; 1309e15f359SSam Clegg uint32_t Index; 1319e15f359SSam Clegg }; 1329e15f359SSam Clegg 1339e15f359SSam Clegg // A wasm global to be written into the global section. 1349e15f359SSam Clegg struct WasmGlobal { 1359e15f359SSam Clegg wasm::ValType Type; 1369e15f359SSam Clegg bool IsMutable; 1379e15f359SSam Clegg bool HasImport; 1389e15f359SSam Clegg uint64_t InitialValue; 1399e15f359SSam Clegg uint32_t ImportIndex; 1409e15f359SSam Clegg }; 1419e15f359SSam Clegg 1426dc65e91SSam Clegg // Information about a single relocation. 1436dc65e91SSam Clegg struct WasmRelocationEntry { 1446dc65e91SSam Clegg uint64_t Offset; // Where is the relocation. 1456dc65e91SSam Clegg const MCSymbolWasm *Symbol; // The symbol to relocate with. 1466dc65e91SSam Clegg int64_t Addend; // A value to add to the symbol. 1476dc65e91SSam Clegg unsigned Type; // The type of the relocation. 148fe6414b0SSam Clegg const MCSectionWasm *FixupSection;// The section the relocation is targeting. 1496dc65e91SSam Clegg 1506dc65e91SSam Clegg WasmRelocationEntry(uint64_t Offset, const MCSymbolWasm *Symbol, 1516dc65e91SSam Clegg int64_t Addend, unsigned Type, 152fe6414b0SSam Clegg const MCSectionWasm *FixupSection) 1536dc65e91SSam Clegg : Offset(Offset), Symbol(Symbol), Addend(Addend), Type(Type), 1546dc65e91SSam Clegg FixupSection(FixupSection) {} 1556dc65e91SSam Clegg 156acd7d2b0SSam Clegg bool hasAddend() const { 157acd7d2b0SSam Clegg switch (Type) { 15813a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB: 15913a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB: 16013a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32: 161acd7d2b0SSam Clegg return true; 162acd7d2b0SSam Clegg default: 163acd7d2b0SSam Clegg return false; 164acd7d2b0SSam Clegg } 165acd7d2b0SSam Clegg } 166acd7d2b0SSam Clegg 1676dc65e91SSam Clegg void print(raw_ostream &Out) const { 1689bf73c07SSam Clegg Out << "Off=" << Offset << ", Sym=" << *Symbol << ", Addend=" << Addend 169759631c7SSam Clegg << ", Type=" << Type 170759631c7SSam Clegg << ", FixupSection=" << FixupSection->getSectionName(); 1716dc65e91SSam Clegg } 172b7787fd0SSam Clegg 173615eb470SAaron Ballman #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP) 174b7787fd0SSam Clegg LLVM_DUMP_METHOD void dump() const { print(dbgs()); } 175b7787fd0SSam Clegg #endif 1766dc65e91SSam Clegg }; 1776dc65e91SSam Clegg 1781fb8daa6SSam Clegg #if !defined(NDEBUG) 1797f055deeSSam Clegg raw_ostream &operator<<(raw_ostream &OS, const WasmRelocationEntry &Rel) { 180b7787fd0SSam Clegg Rel.print(OS); 181b7787fd0SSam Clegg return OS; 182b7787fd0SSam Clegg } 1831fb8daa6SSam Clegg #endif 184b7787fd0SSam Clegg 18518eafb6cSDan Gohman class WasmObjectWriter : public MCObjectWriter { 18618eafb6cSDan Gohman /// Helper struct for containing some precomputed information on symbols. 18718eafb6cSDan Gohman struct WasmSymbolData { 18818eafb6cSDan Gohman const MCSymbolWasm *Symbol; 18918eafb6cSDan Gohman StringRef Name; 19018eafb6cSDan Gohman 19118eafb6cSDan Gohman // Support lexicographic sorting. 19218eafb6cSDan Gohman bool operator<(const WasmSymbolData &RHS) const { return Name < RHS.Name; } 19318eafb6cSDan Gohman }; 19418eafb6cSDan Gohman 19518eafb6cSDan Gohman /// The target specific Wasm writer instance. 19618eafb6cSDan Gohman std::unique_ptr<MCWasmObjectTargetWriter> TargetObjectWriter; 19718eafb6cSDan Gohman 198d934cb88SDan Gohman // Relocations for fixing up references in the code section. 199d934cb88SDan Gohman std::vector<WasmRelocationEntry> CodeRelocations; 200d934cb88SDan Gohman 201d934cb88SDan Gohman // Relocations for fixing up references in the data section. 202d934cb88SDan Gohman std::vector<WasmRelocationEntry> DataRelocations; 203d934cb88SDan Gohman 204d934cb88SDan Gohman // Index values to use for fixing up call_indirect type indices. 205acd7d2b0SSam Clegg // Maps function symbols to the index of the type of the function 206acd7d2b0SSam Clegg DenseMap<const MCSymbolWasm *, uint32_t> TypeIndices; 207d99f6078SSam Clegg // Maps function symbols to the table element index space. Used 208d99f6078SSam Clegg // for TABLE_INDEX relocation types (i.e. address taken functions). 209d99f6078SSam Clegg DenseMap<const MCSymbolWasm *, uint32_t> IndirectSymbolIndices; 210d99f6078SSam Clegg // Maps function/global symbols to the function/global index space. 211acd7d2b0SSam Clegg DenseMap<const MCSymbolWasm *, uint32_t> SymbolIndices; 212acd7d2b0SSam Clegg 213acd7d2b0SSam Clegg DenseMap<WasmFunctionType, int32_t, WasmFunctionTypeDenseMapInfo> 214acd7d2b0SSam Clegg FunctionTypeIndices; 2155e3d33a7SSam Clegg SmallVector<WasmFunctionType, 4> FunctionTypes; 2167c395943SSam Clegg SmallVector<WasmGlobal, 4> Globals; 2177c395943SSam Clegg unsigned NumGlobalImports = 0; 218d934cb88SDan Gohman 21918eafb6cSDan Gohman // TargetObjectWriter wrappers. 22018eafb6cSDan Gohman bool is64Bit() const { return TargetObjectWriter->is64Bit(); } 221ae03c1e7SSam Clegg unsigned getRelocType(const MCValue &Target, const MCFixup &Fixup) const { 222ae03c1e7SSam Clegg return TargetObjectWriter->getRelocType(Target, Fixup); 22318eafb6cSDan Gohman } 22418eafb6cSDan Gohman 225d934cb88SDan Gohman void startSection(SectionBookkeeping &Section, unsigned SectionId, 226d934cb88SDan Gohman const char *Name = nullptr); 227d934cb88SDan Gohman void endSection(SectionBookkeeping &Section); 228d934cb88SDan Gohman 22918eafb6cSDan Gohman public: 2301301a878SLang Hames WasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW, 2311301a878SLang Hames raw_pwrite_stream &OS) 2321301a878SLang Hames : MCObjectWriter(OS, /*IsLittleEndian=*/true), 2331301a878SLang Hames TargetObjectWriter(std::move(MOTW)) {} 23418eafb6cSDan Gohman 235d934cb88SDan Gohman private: 23618eafb6cSDan Gohman ~WasmObjectWriter() override; 23718eafb6cSDan Gohman 238acd7d2b0SSam Clegg void reset() override { 239acd7d2b0SSam Clegg CodeRelocations.clear(); 240acd7d2b0SSam Clegg DataRelocations.clear(); 241acd7d2b0SSam Clegg TypeIndices.clear(); 242acd7d2b0SSam Clegg SymbolIndices.clear(); 243d99f6078SSam Clegg IndirectSymbolIndices.clear(); 244acd7d2b0SSam Clegg FunctionTypeIndices.clear(); 2455e3d33a7SSam Clegg FunctionTypes.clear(); 2467c395943SSam Clegg Globals.clear(); 247acd7d2b0SSam Clegg MCObjectWriter::reset(); 2487c395943SSam Clegg NumGlobalImports = 0; 249acd7d2b0SSam Clegg } 250acd7d2b0SSam Clegg 25118eafb6cSDan Gohman void writeHeader(const MCAssembler &Asm); 25218eafb6cSDan Gohman 25318eafb6cSDan Gohman void recordRelocation(MCAssembler &Asm, const MCAsmLayout &Layout, 25418eafb6cSDan Gohman const MCFragment *Fragment, const MCFixup &Fixup, 255ceecfe5bSRafael Espindola MCValue Target, uint64_t &FixedValue) override; 25618eafb6cSDan Gohman 25718eafb6cSDan Gohman void executePostLayoutBinding(MCAssembler &Asm, 25818eafb6cSDan Gohman const MCAsmLayout &Layout) override; 25918eafb6cSDan Gohman 26018eafb6cSDan Gohman void writeObject(MCAssembler &Asm, const MCAsmLayout &Layout) override; 2619e15f359SSam Clegg 262b7787fd0SSam Clegg void writeString(const StringRef Str) { 263b7787fd0SSam Clegg encodeULEB128(Str.size(), getStream()); 264b7787fd0SSam Clegg writeBytes(Str); 265b7787fd0SSam Clegg } 266b7787fd0SSam Clegg 2679e15f359SSam Clegg void writeValueType(wasm::ValType Ty) { 2689e15f359SSam Clegg encodeSLEB128(int32_t(Ty), getStream()); 2699e15f359SSam Clegg } 2709e15f359SSam Clegg 271457fb0b4SSam Clegg void writeTypeSection(ArrayRef<WasmFunctionType> FunctionTypes); 272457fb0b4SSam Clegg void writeImportSection(ArrayRef<WasmImport> Imports); 273457fb0b4SSam Clegg void writeFunctionSection(ArrayRef<WasmFunction> Functions); 274d99f6078SSam Clegg void writeTableSection(uint32_t NumElements); 2757c395943SSam Clegg void writeMemorySection(uint32_t DataSize); 2767c395943SSam Clegg void writeGlobalSection(); 277457fb0b4SSam Clegg void writeExportSection(ArrayRef<WasmExport> Exports); 278457fb0b4SSam Clegg void writeElemSection(ArrayRef<uint32_t> TableElems); 2799e15f359SSam Clegg void writeCodeSection(const MCAssembler &Asm, const MCAsmLayout &Layout, 280457fb0b4SSam Clegg ArrayRef<WasmFunction> Functions); 281457fb0b4SSam Clegg void writeDataSection(ArrayRef<WasmDataSegment> Segments); 282457fb0b4SSam Clegg void writeNameSection(ArrayRef<WasmFunction> Functions, 283457fb0b4SSam Clegg ArrayRef<WasmImport> Imports, 2849e15f359SSam Clegg uint32_t NumFuncImports); 285acd7d2b0SSam Clegg void writeCodeRelocSection(); 2867c395943SSam Clegg void writeDataRelocSection(); 28731a2c809SSam Clegg void writeLinkingMetaDataSection( 28831a2c809SSam Clegg ArrayRef<WasmDataSegment> Segments, uint32_t DataSize, 28931a2c809SSam Clegg SmallVector<std::pair<StringRef, uint32_t>, 4> SymbolFlags, 290*c2c99771SDan Gohman Optional<uint32_t> StackPointerGlobal); 291acd7d2b0SSam Clegg 2927c395943SSam Clegg uint32_t getProvisionalValue(const WasmRelocationEntry &RelEntry); 293acd7d2b0SSam Clegg void applyRelocations(ArrayRef<WasmRelocationEntry> Relocations, 294acd7d2b0SSam Clegg uint64_t ContentsOffset); 295acd7d2b0SSam Clegg 2967c395943SSam Clegg void writeRelocations(ArrayRef<WasmRelocationEntry> Relocations); 297acd7d2b0SSam Clegg uint32_t getRelocationIndexValue(const WasmRelocationEntry &RelEntry); 2985e3d33a7SSam Clegg uint32_t getFunctionType(const MCSymbolWasm& Symbol); 2995e3d33a7SSam Clegg uint32_t registerFunctionType(const MCSymbolWasm& Symbol); 30018eafb6cSDan Gohman }; 3019e15f359SSam Clegg 30218eafb6cSDan Gohman } // end anonymous namespace 30318eafb6cSDan Gohman 30418eafb6cSDan Gohman WasmObjectWriter::~WasmObjectWriter() {} 30518eafb6cSDan Gohman 306d934cb88SDan Gohman // Write out a section header and a patchable section size field. 307d934cb88SDan Gohman void WasmObjectWriter::startSection(SectionBookkeeping &Section, 308d934cb88SDan Gohman unsigned SectionId, 309d934cb88SDan Gohman const char *Name) { 310d934cb88SDan Gohman assert((Name != nullptr) == (SectionId == wasm::WASM_SEC_CUSTOM) && 311d934cb88SDan Gohman "Only custom sections can have names"); 312d934cb88SDan Gohman 313b7787fd0SSam Clegg DEBUG(dbgs() << "startSection " << SectionId << ": " << Name << "\n"); 314e2688c43SDerek Schuff encodeULEB128(SectionId, getStream()); 315d934cb88SDan Gohman 316d934cb88SDan Gohman Section.SizeOffset = getStream().tell(); 317d934cb88SDan Gohman 318d934cb88SDan Gohman // The section size. We don't know the size yet, so reserve enough space 319d934cb88SDan Gohman // for any 32-bit value; we'll patch it later. 320d934cb88SDan Gohman encodeULEB128(UINT32_MAX, getStream()); 321d934cb88SDan Gohman 322d934cb88SDan Gohman // The position where the section starts, for measuring its size. 323d934cb88SDan Gohman Section.ContentsOffset = getStream().tell(); 324d934cb88SDan Gohman 325d934cb88SDan Gohman // Custom sections in wasm also have a string identifier. 326d934cb88SDan Gohman if (SectionId == wasm::WASM_SEC_CUSTOM) { 327b7787fd0SSam Clegg assert(Name); 328b7787fd0SSam Clegg writeString(StringRef(Name)); 329d934cb88SDan Gohman } 330d934cb88SDan Gohman } 331d934cb88SDan Gohman 332d934cb88SDan Gohman // Now that the section is complete and we know how big it is, patch up the 333d934cb88SDan Gohman // section size field at the start of the section. 334d934cb88SDan Gohman void WasmObjectWriter::endSection(SectionBookkeeping &Section) { 335d934cb88SDan Gohman uint64_t Size = getStream().tell() - Section.ContentsOffset; 336d934cb88SDan Gohman if (uint32_t(Size) != Size) 337d934cb88SDan Gohman report_fatal_error("section size does not fit in a uint32_t"); 338d934cb88SDan Gohman 339b7787fd0SSam Clegg DEBUG(dbgs() << "endSection size=" << Size << "\n"); 340d934cb88SDan Gohman 341d934cb88SDan Gohman // Write the final section size to the payload_len field, which follows 342d934cb88SDan Gohman // the section id byte. 343d934cb88SDan Gohman uint8_t Buffer[16]; 34466a99e41SSam Clegg unsigned SizeLen = encodeULEB128(Size, Buffer, 5); 345d934cb88SDan Gohman assert(SizeLen == 5); 346d934cb88SDan Gohman getStream().pwrite((char *)Buffer, SizeLen, Section.SizeOffset); 347d934cb88SDan Gohman } 348d934cb88SDan Gohman 34918eafb6cSDan Gohman // Emit the Wasm header. 35018eafb6cSDan Gohman void WasmObjectWriter::writeHeader(const MCAssembler &Asm) { 3517ea5adffSDan Gohman writeBytes(StringRef(wasm::WasmMagic, sizeof(wasm::WasmMagic))); 3527ea5adffSDan Gohman writeLE32(wasm::WasmVersion); 35318eafb6cSDan Gohman } 35418eafb6cSDan Gohman 35518eafb6cSDan Gohman void WasmObjectWriter::executePostLayoutBinding(MCAssembler &Asm, 35618eafb6cSDan Gohman const MCAsmLayout &Layout) { 35718eafb6cSDan Gohman } 35818eafb6cSDan Gohman 35918eafb6cSDan Gohman void WasmObjectWriter::recordRelocation(MCAssembler &Asm, 36018eafb6cSDan Gohman const MCAsmLayout &Layout, 36118eafb6cSDan Gohman const MCFragment *Fragment, 36218eafb6cSDan Gohman const MCFixup &Fixup, MCValue Target, 363ceecfe5bSRafael Espindola uint64_t &FixedValue) { 364ceecfe5bSRafael Espindola MCAsmBackend &Backend = Asm.getBackend(); 365ceecfe5bSRafael Espindola bool IsPCRel = Backend.getFixupKindInfo(Fixup.getKind()).Flags & 366ceecfe5bSRafael Espindola MCFixupKindInfo::FKF_IsPCRel; 367fe6414b0SSam Clegg const auto &FixupSection = cast<MCSectionWasm>(*Fragment->getParent()); 368d934cb88SDan Gohman uint64_t C = Target.getConstant(); 369d934cb88SDan Gohman uint64_t FixupOffset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset(); 370d934cb88SDan Gohman MCContext &Ctx = Asm.getContext(); 371d934cb88SDan Gohman 372d934cb88SDan Gohman if (const MCSymbolRefExpr *RefB = Target.getSymB()) { 373d934cb88SDan Gohman assert(RefB->getKind() == MCSymbolRefExpr::VK_None && 374d934cb88SDan Gohman "Should not have constructed this"); 375d934cb88SDan Gohman 376d934cb88SDan Gohman // Let A, B and C being the components of Target and R be the location of 377d934cb88SDan Gohman // the fixup. If the fixup is not pcrel, we want to compute (A - B + C). 378d934cb88SDan Gohman // If it is pcrel, we want to compute (A - B + C - R). 379d934cb88SDan Gohman 380d934cb88SDan Gohman // In general, Wasm has no relocations for -B. It can only represent (A + C) 381d934cb88SDan Gohman // or (A + C - R). If B = R + K and the relocation is not pcrel, we can 382d934cb88SDan Gohman // replace B to implement it: (A - R - K + C) 383d934cb88SDan Gohman if (IsPCRel) { 384d934cb88SDan Gohman Ctx.reportError( 385d934cb88SDan Gohman Fixup.getLoc(), 386d934cb88SDan Gohman "No relocation available to represent this relative expression"); 387d934cb88SDan Gohman return; 388d934cb88SDan Gohman } 389d934cb88SDan Gohman 390d934cb88SDan Gohman const auto &SymB = cast<MCSymbolWasm>(RefB->getSymbol()); 391d934cb88SDan Gohman 392d934cb88SDan Gohman if (SymB.isUndefined()) { 393d934cb88SDan Gohman Ctx.reportError(Fixup.getLoc(), 394d934cb88SDan Gohman Twine("symbol '") + SymB.getName() + 395d934cb88SDan Gohman "' can not be undefined in a subtraction expression"); 396d934cb88SDan Gohman return; 397d934cb88SDan Gohman } 398d934cb88SDan Gohman 399d934cb88SDan Gohman assert(!SymB.isAbsolute() && "Should have been folded"); 400d934cb88SDan Gohman const MCSection &SecB = SymB.getSection(); 401d934cb88SDan Gohman if (&SecB != &FixupSection) { 402d934cb88SDan Gohman Ctx.reportError(Fixup.getLoc(), 403d934cb88SDan Gohman "Cannot represent a difference across sections"); 404d934cb88SDan Gohman return; 405d934cb88SDan Gohman } 406d934cb88SDan Gohman 407d934cb88SDan Gohman uint64_t SymBOffset = Layout.getSymbolOffset(SymB); 408d934cb88SDan Gohman uint64_t K = SymBOffset - FixupOffset; 409d934cb88SDan Gohman IsPCRel = true; 410d934cb88SDan Gohman C -= K; 411d934cb88SDan Gohman } 412d934cb88SDan Gohman 413d934cb88SDan Gohman // We either rejected the fixup or folded B into C at this point. 414d934cb88SDan Gohman const MCSymbolRefExpr *RefA = Target.getSymA(); 415d934cb88SDan Gohman const auto *SymA = RefA ? cast<MCSymbolWasm>(&RefA->getSymbol()) : nullptr; 416d934cb88SDan Gohman 417d934cb88SDan Gohman if (SymA && SymA->isVariable()) { 418d934cb88SDan Gohman const MCExpr *Expr = SymA->getVariableValue(); 4196ad8f190SSam Clegg const auto *Inner = cast<MCSymbolRefExpr>(Expr); 4206ad8f190SSam Clegg if (Inner->getKind() == MCSymbolRefExpr::VK_WEAKREF) 4216ad8f190SSam Clegg llvm_unreachable("weakref used in reloc not yet implemented"); 422d934cb88SDan Gohman } 423d934cb88SDan Gohman 424d934cb88SDan Gohman // Put any constant offset in an addend. Offsets can be negative, and 425d934cb88SDan Gohman // LLVM expects wrapping, in contrast to wasm's immediates which can't 426d934cb88SDan Gohman // be negative and don't wrap. 427d934cb88SDan Gohman FixedValue = 0; 428d934cb88SDan Gohman 4296ad8f190SSam Clegg if (SymA) 430d934cb88SDan Gohman SymA->setUsedInReloc(); 431d934cb88SDan Gohman 432ae03c1e7SSam Clegg assert(!IsPCRel); 4339d24fb7fSSam Clegg assert(SymA); 4349d24fb7fSSam Clegg 435ae03c1e7SSam Clegg unsigned Type = getRelocType(Target, Fixup); 436ae03c1e7SSam Clegg 437d934cb88SDan Gohman WasmRelocationEntry Rec(FixupOffset, SymA, C, Type, &FixupSection); 438b7787fd0SSam Clegg DEBUG(dbgs() << "WasmReloc: " << Rec << "\n"); 439d934cb88SDan Gohman 44012fd3da9SSam Clegg if (FixupSection.isWasmData()) 441d934cb88SDan Gohman DataRelocations.push_back(Rec); 44212fd3da9SSam Clegg else if (FixupSection.getKind().isText()) 44312fd3da9SSam Clegg CodeRelocations.push_back(Rec); 44412fd3da9SSam Clegg else if (!FixupSection.getKind().isMetadata()) 44512fd3da9SSam Clegg // TODO(sbc): Add support for debug sections. 44612fd3da9SSam Clegg llvm_unreachable("unexpected section type"); 447d934cb88SDan Gohman } 448d934cb88SDan Gohman 449d934cb88SDan Gohman // Write X as an (unsigned) LEB value at offset Offset in Stream, padded 450d934cb88SDan Gohman // to allow patching. 451d934cb88SDan Gohman static void 452d934cb88SDan Gohman WritePatchableLEB(raw_pwrite_stream &Stream, uint32_t X, uint64_t Offset) { 453d934cb88SDan Gohman uint8_t Buffer[5]; 45466a99e41SSam Clegg unsigned SizeLen = encodeULEB128(X, Buffer, 5); 455d934cb88SDan Gohman assert(SizeLen == 5); 456d934cb88SDan Gohman Stream.pwrite((char *)Buffer, SizeLen, Offset); 457d934cb88SDan Gohman } 458d934cb88SDan Gohman 459d934cb88SDan Gohman // Write X as an signed LEB value at offset Offset in Stream, padded 460d934cb88SDan Gohman // to allow patching. 461d934cb88SDan Gohman static void 462d934cb88SDan Gohman WritePatchableSLEB(raw_pwrite_stream &Stream, int32_t X, uint64_t Offset) { 463d934cb88SDan Gohman uint8_t Buffer[5]; 46466a99e41SSam Clegg unsigned SizeLen = encodeSLEB128(X, Buffer, 5); 465d934cb88SDan Gohman assert(SizeLen == 5); 466d934cb88SDan Gohman Stream.pwrite((char *)Buffer, SizeLen, Offset); 467d934cb88SDan Gohman } 468d934cb88SDan Gohman 469d934cb88SDan Gohman // Write X as a plain integer value at offset Offset in Stream. 470d934cb88SDan Gohman static void WriteI32(raw_pwrite_stream &Stream, uint32_t X, uint64_t Offset) { 471d934cb88SDan Gohman uint8_t Buffer[4]; 472d934cb88SDan Gohman support::endian::write32le(Buffer, X); 473d934cb88SDan Gohman Stream.pwrite((char *)Buffer, sizeof(Buffer), Offset); 474d934cb88SDan Gohman } 475d934cb88SDan Gohman 476aff1c4dfSSam Clegg static const MCSymbolWasm* ResolveSymbol(const MCSymbolWasm& Symbol) { 477aff1c4dfSSam Clegg if (Symbol.isVariable()) { 478aff1c4dfSSam Clegg const MCExpr *Expr = Symbol.getVariableValue(); 479aff1c4dfSSam Clegg auto *Inner = cast<MCSymbolRefExpr>(Expr); 480aff1c4dfSSam Clegg return cast<MCSymbolWasm>(&Inner->getSymbol()); 481aff1c4dfSSam Clegg } 482aff1c4dfSSam Clegg return &Symbol; 483aff1c4dfSSam Clegg } 484aff1c4dfSSam Clegg 485d934cb88SDan Gohman // Compute a value to write into the code at the location covered 486d934cb88SDan Gohman // by RelEntry. This value isn't used by the static linker, since 487d934cb88SDan Gohman // we have addends; it just serves to make the code more readable 488d934cb88SDan Gohman // and to make standalone wasm modules directly usable. 4897c395943SSam Clegg uint32_t 4907c395943SSam Clegg WasmObjectWriter::getProvisionalValue(const WasmRelocationEntry &RelEntry) { 491aff1c4dfSSam Clegg const MCSymbolWasm *Sym = ResolveSymbol(*RelEntry.Symbol); 492d934cb88SDan Gohman 493d934cb88SDan Gohman // For undefined symbols, use a hopefully invalid value. 494b7787fd0SSam Clegg if (!Sym->isDefined(/*SetUsed=*/false)) 495d934cb88SDan Gohman return UINT32_MAX; 496d934cb88SDan Gohman 4977c395943SSam Clegg uint32_t GlobalIndex = SymbolIndices[Sym]; 4987c395943SSam Clegg const WasmGlobal& Global = Globals[GlobalIndex - NumGlobalImports]; 4997c395943SSam Clegg uint64_t Address = Global.InitialValue + RelEntry.Addend; 500d934cb88SDan Gohman 501d934cb88SDan Gohman // Ignore overflow. LLVM allows address arithmetic to silently wrap. 502d934cb88SDan Gohman uint32_t Value = Address; 503d934cb88SDan Gohman 504d934cb88SDan Gohman return Value; 505d934cb88SDan Gohman } 506d934cb88SDan Gohman 507759631c7SSam Clegg static void addData(SmallVectorImpl<char> &DataBytes, 50863ebb813SSam Clegg MCSectionWasm &DataSection) { 509759631c7SSam Clegg DEBUG(errs() << "addData: " << DataSection.getSectionName() << "\n"); 510759631c7SSam Clegg 51163ebb813SSam Clegg DataBytes.resize(alignTo(DataBytes.size(), DataSection.getAlignment())); 51263ebb813SSam Clegg 513c55d13f4SSam Clegg size_t LastFragmentSize = 0; 514759631c7SSam Clegg for (const MCFragment &Frag : DataSection) { 515759631c7SSam Clegg if (Frag.hasInstructions()) 516759631c7SSam Clegg report_fatal_error("only data supported in data sections"); 517759631c7SSam Clegg 518759631c7SSam Clegg if (auto *Align = dyn_cast<MCAlignFragment>(&Frag)) { 519759631c7SSam Clegg if (Align->getValueSize() != 1) 520759631c7SSam Clegg report_fatal_error("only byte values supported for alignment"); 521759631c7SSam Clegg // If nops are requested, use zeros, as this is the data section. 522759631c7SSam Clegg uint8_t Value = Align->hasEmitNops() ? 0 : Align->getValue(); 523759631c7SSam Clegg uint64_t Size = std::min<uint64_t>(alignTo(DataBytes.size(), 524759631c7SSam Clegg Align->getAlignment()), 525759631c7SSam Clegg DataBytes.size() + 526759631c7SSam Clegg Align->getMaxBytesToEmit()); 527759631c7SSam Clegg DataBytes.resize(Size, Value); 528759631c7SSam Clegg } else if (auto *Fill = dyn_cast<MCFillFragment>(&Frag)) { 529759631c7SSam Clegg DataBytes.insert(DataBytes.end(), Fill->getSize(), Fill->getValue()); 530759631c7SSam Clegg } else { 531759631c7SSam Clegg const auto &DataFrag = cast<MCDataFragment>(Frag); 532759631c7SSam Clegg const SmallVectorImpl<char> &Contents = DataFrag.getContents(); 533759631c7SSam Clegg 534759631c7SSam Clegg DataBytes.insert(DataBytes.end(), Contents.begin(), Contents.end()); 535c55d13f4SSam Clegg LastFragmentSize = Contents.size(); 536759631c7SSam Clegg } 537759631c7SSam Clegg } 538759631c7SSam Clegg 539c55d13f4SSam Clegg // Don't allow empty segments, or segments that end with zero-sized 540c55d13f4SSam Clegg // fragment, otherwise the linker cannot map symbols to a unique 541c55d13f4SSam Clegg // data segment. This can be triggered by zero-sized structs 542c55d13f4SSam Clegg // See: test/MC/WebAssembly/bss.ll 543c55d13f4SSam Clegg if (LastFragmentSize == 0) 544c55d13f4SSam Clegg DataBytes.resize(DataBytes.size() + 1); 545759631c7SSam Clegg DEBUG(dbgs() << "addData -> " << DataBytes.size() << "\n"); 546759631c7SSam Clegg } 547759631c7SSam Clegg 548acd7d2b0SSam Clegg uint32_t WasmObjectWriter::getRelocationIndexValue( 549acd7d2b0SSam Clegg const WasmRelocationEntry &RelEntry) { 550acd7d2b0SSam Clegg switch (RelEntry.Type) { 551acd7d2b0SSam Clegg case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB: 552acd7d2b0SSam Clegg case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32: 553b7787fd0SSam Clegg if (!IndirectSymbolIndices.count(RelEntry.Symbol)) 554b7787fd0SSam Clegg report_fatal_error("symbol not found table index space: " + 555b7787fd0SSam Clegg RelEntry.Symbol->getName()); 556d99f6078SSam Clegg return IndirectSymbolIndices[RelEntry.Symbol]; 557d99f6078SSam Clegg case wasm::R_WEBASSEMBLY_FUNCTION_INDEX_LEB: 5589d24fb7fSSam Clegg case wasm::R_WEBASSEMBLY_GLOBAL_INDEX_LEB: 55913a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB: 56013a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB: 56113a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32: 562b7787fd0SSam Clegg if (!SymbolIndices.count(RelEntry.Symbol)) 563b7787fd0SSam Clegg report_fatal_error("symbol not found function/global index space: " + 564b7787fd0SSam Clegg RelEntry.Symbol->getName()); 565acd7d2b0SSam Clegg return SymbolIndices[RelEntry.Symbol]; 566acd7d2b0SSam Clegg case wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB: 567b7787fd0SSam Clegg if (!TypeIndices.count(RelEntry.Symbol)) 568b7787fd0SSam Clegg report_fatal_error("symbol not found in type index space: " + 569b7787fd0SSam Clegg RelEntry.Symbol->getName()); 570acd7d2b0SSam Clegg return TypeIndices[RelEntry.Symbol]; 571acd7d2b0SSam Clegg default: 572acd7d2b0SSam Clegg llvm_unreachable("invalid relocation type"); 573acd7d2b0SSam Clegg } 574acd7d2b0SSam Clegg } 575acd7d2b0SSam Clegg 576d934cb88SDan Gohman // Apply the portions of the relocation records that we can handle ourselves 577d934cb88SDan Gohman // directly. 578acd7d2b0SSam Clegg void WasmObjectWriter::applyRelocations( 579acd7d2b0SSam Clegg ArrayRef<WasmRelocationEntry> Relocations, uint64_t ContentsOffset) { 580acd7d2b0SSam Clegg raw_pwrite_stream &Stream = getStream(); 581d934cb88SDan Gohman for (const WasmRelocationEntry &RelEntry : Relocations) { 582d934cb88SDan Gohman uint64_t Offset = ContentsOffset + 583d934cb88SDan Gohman RelEntry.FixupSection->getSectionOffset() + 584d934cb88SDan Gohman RelEntry.Offset; 585d934cb88SDan Gohman 586b7787fd0SSam Clegg DEBUG(dbgs() << "applyRelocation: " << RelEntry << "\n"); 587acd7d2b0SSam Clegg switch (RelEntry.Type) { 588acd7d2b0SSam Clegg case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB: 589acd7d2b0SSam Clegg case wasm::R_WEBASSEMBLY_FUNCTION_INDEX_LEB: 5909d24fb7fSSam Clegg case wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB: 5919d24fb7fSSam Clegg case wasm::R_WEBASSEMBLY_GLOBAL_INDEX_LEB: { 592acd7d2b0SSam Clegg uint32_t Index = getRelocationIndexValue(RelEntry); 593acd7d2b0SSam Clegg WritePatchableSLEB(Stream, Index, Offset); 594d934cb88SDan Gohman break; 595d934cb88SDan Gohman } 596acd7d2b0SSam Clegg case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32: { 597acd7d2b0SSam Clegg uint32_t Index = getRelocationIndexValue(RelEntry); 598acd7d2b0SSam Clegg WriteI32(Stream, Index, Offset); 599d934cb88SDan Gohman break; 600d934cb88SDan Gohman } 60113a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB: { 6027c395943SSam Clegg uint32_t Value = getProvisionalValue(RelEntry); 603d934cb88SDan Gohman WritePatchableSLEB(Stream, Value, Offset); 604d934cb88SDan Gohman break; 605d934cb88SDan Gohman } 60613a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB: { 6077c395943SSam Clegg uint32_t Value = getProvisionalValue(RelEntry); 608d934cb88SDan Gohman WritePatchableLEB(Stream, Value, Offset); 609d934cb88SDan Gohman break; 610d934cb88SDan Gohman } 61113a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32: { 6127c395943SSam Clegg uint32_t Value = getProvisionalValue(RelEntry); 613d934cb88SDan Gohman WriteI32(Stream, Value, Offset); 614d934cb88SDan Gohman break; 615d934cb88SDan Gohman } 616d934cb88SDan Gohman default: 6179d24fb7fSSam Clegg llvm_unreachable("invalid relocation type"); 618d934cb88SDan Gohman } 619d934cb88SDan Gohman } 62018eafb6cSDan Gohman } 62118eafb6cSDan Gohman 622acd7d2b0SSam Clegg // Write out the portions of the relocation records that the linker will 623970d02c4SDan Gohman // need to handle. 624acd7d2b0SSam Clegg void WasmObjectWriter::writeRelocations( 6257c395943SSam Clegg ArrayRef<WasmRelocationEntry> Relocations) { 626acd7d2b0SSam Clegg raw_pwrite_stream &Stream = getStream(); 627acd7d2b0SSam Clegg for (const WasmRelocationEntry& RelEntry : Relocations) { 628970d02c4SDan Gohman 629acd7d2b0SSam Clegg uint64_t Offset = RelEntry.Offset + 6307c395943SSam Clegg RelEntry.FixupSection->getSectionOffset(); 631acd7d2b0SSam Clegg uint32_t Index = getRelocationIndexValue(RelEntry); 632970d02c4SDan Gohman 633acd7d2b0SSam Clegg encodeULEB128(RelEntry.Type, Stream); 634970d02c4SDan Gohman encodeULEB128(Offset, Stream); 635acd7d2b0SSam Clegg encodeULEB128(Index, Stream); 636acd7d2b0SSam Clegg if (RelEntry.hasAddend()) 637acd7d2b0SSam Clegg encodeSLEB128(RelEntry.Addend, Stream); 638970d02c4SDan Gohman } 639970d02c4SDan Gohman } 640970d02c4SDan Gohman 6419e15f359SSam Clegg void WasmObjectWriter::writeTypeSection( 642457fb0b4SSam Clegg ArrayRef<WasmFunctionType> FunctionTypes) { 6439e15f359SSam Clegg if (FunctionTypes.empty()) 6449e15f359SSam Clegg return; 6459e15f359SSam Clegg 6469e15f359SSam Clegg SectionBookkeeping Section; 6479e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_TYPE); 6489e15f359SSam Clegg 6499e15f359SSam Clegg encodeULEB128(FunctionTypes.size(), getStream()); 6509e15f359SSam Clegg 6519e15f359SSam Clegg for (const WasmFunctionType &FuncTy : FunctionTypes) { 6529e15f359SSam Clegg encodeSLEB128(wasm::WASM_TYPE_FUNC, getStream()); 6539e15f359SSam Clegg encodeULEB128(FuncTy.Params.size(), getStream()); 6549e15f359SSam Clegg for (wasm::ValType Ty : FuncTy.Params) 6559e15f359SSam Clegg writeValueType(Ty); 6569e15f359SSam Clegg encodeULEB128(FuncTy.Returns.size(), getStream()); 6579e15f359SSam Clegg for (wasm::ValType Ty : FuncTy.Returns) 6589e15f359SSam Clegg writeValueType(Ty); 6599e15f359SSam Clegg } 6609e15f359SSam Clegg 6619e15f359SSam Clegg endSection(Section); 6629e15f359SSam Clegg } 6639e15f359SSam Clegg 664457fb0b4SSam Clegg void WasmObjectWriter::writeImportSection(ArrayRef<WasmImport> Imports) { 6659e15f359SSam Clegg if (Imports.empty()) 6669e15f359SSam Clegg return; 6679e15f359SSam Clegg 6689e15f359SSam Clegg SectionBookkeeping Section; 6699e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_IMPORT); 6709e15f359SSam Clegg 6719e15f359SSam Clegg encodeULEB128(Imports.size(), getStream()); 6729e15f359SSam Clegg for (const WasmImport &Import : Imports) { 673b7787fd0SSam Clegg writeString(Import.ModuleName); 674b7787fd0SSam Clegg writeString(Import.FieldName); 6759e15f359SSam Clegg 6769e15f359SSam Clegg encodeULEB128(Import.Kind, getStream()); 6779e15f359SSam Clegg 6789e15f359SSam Clegg switch (Import.Kind) { 6799e15f359SSam Clegg case wasm::WASM_EXTERNAL_FUNCTION: 6809e15f359SSam Clegg encodeULEB128(Import.Type, getStream()); 6819e15f359SSam Clegg break; 6829e15f359SSam Clegg case wasm::WASM_EXTERNAL_GLOBAL: 6839e15f359SSam Clegg encodeSLEB128(int32_t(Import.Type), getStream()); 6849e15f359SSam Clegg encodeULEB128(0, getStream()); // mutability 6859e15f359SSam Clegg break; 6869e15f359SSam Clegg default: 6879e15f359SSam Clegg llvm_unreachable("unsupported import kind"); 6889e15f359SSam Clegg } 6899e15f359SSam Clegg } 6909e15f359SSam Clegg 6919e15f359SSam Clegg endSection(Section); 6929e15f359SSam Clegg } 6939e15f359SSam Clegg 694457fb0b4SSam Clegg void WasmObjectWriter::writeFunctionSection(ArrayRef<WasmFunction> Functions) { 6959e15f359SSam Clegg if (Functions.empty()) 6969e15f359SSam Clegg return; 6979e15f359SSam Clegg 6989e15f359SSam Clegg SectionBookkeeping Section; 6999e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_FUNCTION); 7009e15f359SSam Clegg 7019e15f359SSam Clegg encodeULEB128(Functions.size(), getStream()); 7029e15f359SSam Clegg for (const WasmFunction &Func : Functions) 7039e15f359SSam Clegg encodeULEB128(Func.Type, getStream()); 7049e15f359SSam Clegg 7059e15f359SSam Clegg endSection(Section); 7069e15f359SSam Clegg } 7079e15f359SSam Clegg 708d99f6078SSam Clegg void WasmObjectWriter::writeTableSection(uint32_t NumElements) { 7099e15f359SSam Clegg // For now, always emit the table section, since indirect calls are not 7109e15f359SSam Clegg // valid without it. In the future, we could perhaps be more clever and omit 7119e15f359SSam Clegg // it if there are no indirect calls. 712d99f6078SSam Clegg 7139e15f359SSam Clegg SectionBookkeeping Section; 7149e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_TABLE); 7159e15f359SSam Clegg 716d99f6078SSam Clegg encodeULEB128(1, getStream()); // The number of tables. 717d99f6078SSam Clegg // Fixed to 1 for now. 718d99f6078SSam Clegg encodeSLEB128(wasm::WASM_TYPE_ANYFUNC, getStream()); // Type of table 7199e15f359SSam Clegg encodeULEB128(0, getStream()); // flags 720d99f6078SSam Clegg encodeULEB128(NumElements, getStream()); // initial 7219e15f359SSam Clegg 7229e15f359SSam Clegg endSection(Section); 7239e15f359SSam Clegg } 7249e15f359SSam Clegg 7257c395943SSam Clegg void WasmObjectWriter::writeMemorySection(uint32_t DataSize) { 7269e15f359SSam Clegg // For now, always emit the memory section, since loads and stores are not 7279e15f359SSam Clegg // valid without it. In the future, we could perhaps be more clever and omit 7289e15f359SSam Clegg // it if there are no loads or stores. 7299e15f359SSam Clegg SectionBookkeeping Section; 7307c395943SSam Clegg uint32_t NumPages = (DataSize + wasm::WasmPageSize - 1) / wasm::WasmPageSize; 7319e15f359SSam Clegg 7329e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_MEMORY); 7339e15f359SSam Clegg encodeULEB128(1, getStream()); // number of memory spaces 7349e15f359SSam Clegg 7359e15f359SSam Clegg encodeULEB128(0, getStream()); // flags 7369e15f359SSam Clegg encodeULEB128(NumPages, getStream()); // initial 7379e15f359SSam Clegg 7389e15f359SSam Clegg endSection(Section); 7399e15f359SSam Clegg } 7409e15f359SSam Clegg 7417c395943SSam Clegg void WasmObjectWriter::writeGlobalSection() { 7429e15f359SSam Clegg if (Globals.empty()) 7439e15f359SSam Clegg return; 7449e15f359SSam Clegg 7459e15f359SSam Clegg SectionBookkeeping Section; 7469e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_GLOBAL); 7479e15f359SSam Clegg 7489e15f359SSam Clegg encodeULEB128(Globals.size(), getStream()); 7499e15f359SSam Clegg for (const WasmGlobal &Global : Globals) { 7509e15f359SSam Clegg writeValueType(Global.Type); 7519e15f359SSam Clegg write8(Global.IsMutable); 7529e15f359SSam Clegg 7539e15f359SSam Clegg if (Global.HasImport) { 7549e15f359SSam Clegg assert(Global.InitialValue == 0); 7559e15f359SSam Clegg write8(wasm::WASM_OPCODE_GET_GLOBAL); 7569e15f359SSam Clegg encodeULEB128(Global.ImportIndex, getStream()); 7579e15f359SSam Clegg } else { 7589e15f359SSam Clegg assert(Global.ImportIndex == 0); 7599e15f359SSam Clegg write8(wasm::WASM_OPCODE_I32_CONST); 7609e15f359SSam Clegg encodeSLEB128(Global.InitialValue, getStream()); // offset 7619e15f359SSam Clegg } 7629e15f359SSam Clegg write8(wasm::WASM_OPCODE_END); 7639e15f359SSam Clegg } 7649e15f359SSam Clegg 7659e15f359SSam Clegg endSection(Section); 7669e15f359SSam Clegg } 7679e15f359SSam Clegg 768457fb0b4SSam Clegg void WasmObjectWriter::writeExportSection(ArrayRef<WasmExport> Exports) { 7699e15f359SSam Clegg if (Exports.empty()) 7709e15f359SSam Clegg return; 7719e15f359SSam Clegg 7729e15f359SSam Clegg SectionBookkeeping Section; 7739e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_EXPORT); 7749e15f359SSam Clegg 7759e15f359SSam Clegg encodeULEB128(Exports.size(), getStream()); 7769e15f359SSam Clegg for (const WasmExport &Export : Exports) { 777b7787fd0SSam Clegg writeString(Export.FieldName); 7789e15f359SSam Clegg encodeSLEB128(Export.Kind, getStream()); 7799e15f359SSam Clegg encodeULEB128(Export.Index, getStream()); 7809e15f359SSam Clegg } 7819e15f359SSam Clegg 7829e15f359SSam Clegg endSection(Section); 7839e15f359SSam Clegg } 7849e15f359SSam Clegg 785457fb0b4SSam Clegg void WasmObjectWriter::writeElemSection(ArrayRef<uint32_t> TableElems) { 7869e15f359SSam Clegg if (TableElems.empty()) 7879e15f359SSam Clegg return; 7889e15f359SSam Clegg 7899e15f359SSam Clegg SectionBookkeeping Section; 7909e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_ELEM); 7919e15f359SSam Clegg 7929e15f359SSam Clegg encodeULEB128(1, getStream()); // number of "segments" 7939e15f359SSam Clegg encodeULEB128(0, getStream()); // the table index 7949e15f359SSam Clegg 7959e15f359SSam Clegg // init expr for starting offset 7969e15f359SSam Clegg write8(wasm::WASM_OPCODE_I32_CONST); 7979e15f359SSam Clegg encodeSLEB128(0, getStream()); 7989e15f359SSam Clegg write8(wasm::WASM_OPCODE_END); 7999e15f359SSam Clegg 8009e15f359SSam Clegg encodeULEB128(TableElems.size(), getStream()); 8019e15f359SSam Clegg for (uint32_t Elem : TableElems) 8029e15f359SSam Clegg encodeULEB128(Elem, getStream()); 8039e15f359SSam Clegg 8049e15f359SSam Clegg endSection(Section); 8059e15f359SSam Clegg } 8069e15f359SSam Clegg 807457fb0b4SSam Clegg void WasmObjectWriter::writeCodeSection(const MCAssembler &Asm, 808457fb0b4SSam Clegg const MCAsmLayout &Layout, 809457fb0b4SSam Clegg ArrayRef<WasmFunction> Functions) { 8109e15f359SSam Clegg if (Functions.empty()) 8119e15f359SSam Clegg return; 8129e15f359SSam Clegg 8139e15f359SSam Clegg SectionBookkeeping Section; 8149e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_CODE); 8159e15f359SSam Clegg 8169e15f359SSam Clegg encodeULEB128(Functions.size(), getStream()); 8179e15f359SSam Clegg 8189e15f359SSam Clegg for (const WasmFunction &Func : Functions) { 819fe6414b0SSam Clegg auto &FuncSection = static_cast<MCSectionWasm &>(Func.Sym->getSection()); 8209e15f359SSam Clegg 8219e15f359SSam Clegg int64_t Size = 0; 8229e15f359SSam Clegg if (!Func.Sym->getSize()->evaluateAsAbsolute(Size, Layout)) 8239e15f359SSam Clegg report_fatal_error(".size expression must be evaluatable"); 8249e15f359SSam Clegg 8259e15f359SSam Clegg encodeULEB128(Size, getStream()); 826fe6414b0SSam Clegg FuncSection.setSectionOffset(getStream().tell() - Section.ContentsOffset); 8279e15f359SSam Clegg Asm.writeSectionData(&FuncSection, Layout); 8289e15f359SSam Clegg } 8299e15f359SSam Clegg 8309e15f359SSam Clegg // Apply fixups. 831acd7d2b0SSam Clegg applyRelocations(CodeRelocations, Section.ContentsOffset); 8329e15f359SSam Clegg 8339e15f359SSam Clegg endSection(Section); 8349e15f359SSam Clegg } 8359e15f359SSam Clegg 836457fb0b4SSam Clegg void WasmObjectWriter::writeDataSection(ArrayRef<WasmDataSegment> Segments) { 8377c395943SSam Clegg if (Segments.empty()) 8387c395943SSam Clegg return; 8399e15f359SSam Clegg 8409e15f359SSam Clegg SectionBookkeeping Section; 8419e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_DATA); 8429e15f359SSam Clegg 8437c395943SSam Clegg encodeULEB128(Segments.size(), getStream()); // count 8447c395943SSam Clegg 8457c395943SSam Clegg for (const WasmDataSegment & Segment : Segments) { 8469e15f359SSam Clegg encodeULEB128(0, getStream()); // memory index 8479e15f359SSam Clegg write8(wasm::WASM_OPCODE_I32_CONST); 8487c395943SSam Clegg encodeSLEB128(Segment.Offset, getStream()); // offset 8499e15f359SSam Clegg write8(wasm::WASM_OPCODE_END); 8507c395943SSam Clegg encodeULEB128(Segment.Data.size(), getStream()); // size 8517c395943SSam Clegg Segment.Section->setSectionOffset(getStream().tell() - Section.ContentsOffset); 8527c395943SSam Clegg writeBytes(Segment.Data); // data 8537c395943SSam Clegg } 8549e15f359SSam Clegg 8559e15f359SSam Clegg // Apply fixups. 8567c395943SSam Clegg applyRelocations(DataRelocations, Section.ContentsOffset); 8579e15f359SSam Clegg 8589e15f359SSam Clegg endSection(Section); 8599e15f359SSam Clegg } 8609e15f359SSam Clegg 8619e15f359SSam Clegg void WasmObjectWriter::writeNameSection( 862457fb0b4SSam Clegg ArrayRef<WasmFunction> Functions, 863457fb0b4SSam Clegg ArrayRef<WasmImport> Imports, 8649e15f359SSam Clegg unsigned NumFuncImports) { 8659e15f359SSam Clegg uint32_t TotalFunctions = NumFuncImports + Functions.size(); 8669e15f359SSam Clegg if (TotalFunctions == 0) 8679e15f359SSam Clegg return; 8689e15f359SSam Clegg 8699e15f359SSam Clegg SectionBookkeeping Section; 8709e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_CUSTOM, "name"); 8719e15f359SSam Clegg SectionBookkeeping SubSection; 8729e15f359SSam Clegg startSection(SubSection, wasm::WASM_NAMES_FUNCTION); 8739e15f359SSam Clegg 8749e15f359SSam Clegg encodeULEB128(TotalFunctions, getStream()); 8759e15f359SSam Clegg uint32_t Index = 0; 8769e15f359SSam Clegg for (const WasmImport &Import : Imports) { 8779e15f359SSam Clegg if (Import.Kind == wasm::WASM_EXTERNAL_FUNCTION) { 8789e15f359SSam Clegg encodeULEB128(Index, getStream()); 879b7787fd0SSam Clegg writeString(Import.FieldName); 8809e15f359SSam Clegg ++Index; 8819e15f359SSam Clegg } 8829e15f359SSam Clegg } 8839e15f359SSam Clegg for (const WasmFunction &Func : Functions) { 8849e15f359SSam Clegg encodeULEB128(Index, getStream()); 885b7787fd0SSam Clegg writeString(Func.Sym->getName()); 8869e15f359SSam Clegg ++Index; 8879e15f359SSam Clegg } 8889e15f359SSam Clegg 8899e15f359SSam Clegg endSection(SubSection); 8909e15f359SSam Clegg endSection(Section); 8919e15f359SSam Clegg } 8929e15f359SSam Clegg 893acd7d2b0SSam Clegg void WasmObjectWriter::writeCodeRelocSection() { 8949e15f359SSam Clegg // See: https://github.com/WebAssembly/tool-conventions/blob/master/Linking.md 8959e15f359SSam Clegg // for descriptions of the reloc sections. 8969e15f359SSam Clegg 8979e15f359SSam Clegg if (CodeRelocations.empty()) 8989e15f359SSam Clegg return; 8999e15f359SSam Clegg 9009e15f359SSam Clegg SectionBookkeeping Section; 9019e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_CUSTOM, "reloc.CODE"); 9029e15f359SSam Clegg 9039e15f359SSam Clegg encodeULEB128(wasm::WASM_SEC_CODE, getStream()); 904acd7d2b0SSam Clegg encodeULEB128(CodeRelocations.size(), getStream()); 9059e15f359SSam Clegg 9067c395943SSam Clegg writeRelocations(CodeRelocations); 9079e15f359SSam Clegg 9089e15f359SSam Clegg endSection(Section); 9099e15f359SSam Clegg } 9109e15f359SSam Clegg 9117c395943SSam Clegg void WasmObjectWriter::writeDataRelocSection() { 9129e15f359SSam Clegg // See: https://github.com/WebAssembly/tool-conventions/blob/master/Linking.md 9139e15f359SSam Clegg // for descriptions of the reloc sections. 9149e15f359SSam Clegg 9159e15f359SSam Clegg if (DataRelocations.empty()) 9169e15f359SSam Clegg return; 9179e15f359SSam Clegg 9189e15f359SSam Clegg SectionBookkeeping Section; 9199e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_CUSTOM, "reloc.DATA"); 9209e15f359SSam Clegg 9219e15f359SSam Clegg encodeULEB128(wasm::WASM_SEC_DATA, getStream()); 9229e15f359SSam Clegg encodeULEB128(DataRelocations.size(), getStream()); 9239e15f359SSam Clegg 9247c395943SSam Clegg writeRelocations(DataRelocations); 9259e15f359SSam Clegg 9269e15f359SSam Clegg endSection(Section); 9279e15f359SSam Clegg } 9289e15f359SSam Clegg 9299e15f359SSam Clegg void WasmObjectWriter::writeLinkingMetaDataSection( 930d95ed959SSam Clegg ArrayRef<WasmDataSegment> Segments, uint32_t DataSize, 93131a2c809SSam Clegg SmallVector<std::pair<StringRef, uint32_t>, 4> SymbolFlags, 932*c2c99771SDan Gohman Optional<uint32_t> StackPointerGlobal) { 9339e15f359SSam Clegg SectionBookkeeping Section; 9349e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_CUSTOM, "linking"); 935b7787fd0SSam Clegg SectionBookkeeping SubSection; 9369e15f359SSam Clegg 937*c2c99771SDan Gohman if (StackPointerGlobal.hasValue()) { 938b7787fd0SSam Clegg startSection(SubSection, wasm::WASM_STACK_POINTER); 939*c2c99771SDan Gohman encodeULEB128(StackPointerGlobal.getValue(), getStream()); // id 940b7787fd0SSam Clegg endSection(SubSection); 941b7787fd0SSam Clegg } 942b7787fd0SSam Clegg 94331a2c809SSam Clegg if (SymbolFlags.size() != 0) { 944b7787fd0SSam Clegg startSection(SubSection, wasm::WASM_SYMBOL_INFO); 94531a2c809SSam Clegg encodeULEB128(SymbolFlags.size(), getStream()); 94631a2c809SSam Clegg for (auto Pair: SymbolFlags) { 94731a2c809SSam Clegg writeString(Pair.first); 94831a2c809SSam Clegg encodeULEB128(Pair.second, getStream()); 949b7787fd0SSam Clegg } 950b7787fd0SSam Clegg endSection(SubSection); 951b7787fd0SSam Clegg } 9529e15f359SSam Clegg 9539e1ade93SSam Clegg if (DataSize > 0) { 9549e1ade93SSam Clegg startSection(SubSection, wasm::WASM_DATA_SIZE); 9559e1ade93SSam Clegg encodeULEB128(DataSize, getStream()); 9569e1ade93SSam Clegg endSection(SubSection); 9579e1ade93SSam Clegg } 9589e1ade93SSam Clegg 959d95ed959SSam Clegg if (Segments.size()) { 96063ebb813SSam Clegg startSection(SubSection, wasm::WASM_SEGMENT_INFO); 961d95ed959SSam Clegg encodeULEB128(Segments.size(), getStream()); 96263ebb813SSam Clegg for (const WasmDataSegment &Segment : Segments) { 963d95ed959SSam Clegg writeString(Segment.Name); 96463ebb813SSam Clegg encodeULEB128(Segment.Alignment, getStream()); 96563ebb813SSam Clegg encodeULEB128(Segment.Flags, getStream()); 96663ebb813SSam Clegg } 967d95ed959SSam Clegg endSection(SubSection); 968d95ed959SSam Clegg } 969d95ed959SSam Clegg 9709e15f359SSam Clegg endSection(Section); 9719e15f359SSam Clegg } 9729e15f359SSam Clegg 9735e3d33a7SSam Clegg uint32_t WasmObjectWriter::getFunctionType(const MCSymbolWasm& Symbol) { 9745e3d33a7SSam Clegg assert(Symbol.isFunction()); 9755e3d33a7SSam Clegg assert(TypeIndices.count(&Symbol)); 9765e3d33a7SSam Clegg return TypeIndices[&Symbol]; 9775e3d33a7SSam Clegg } 9785e3d33a7SSam Clegg 9795e3d33a7SSam Clegg uint32_t WasmObjectWriter::registerFunctionType(const MCSymbolWasm& Symbol) { 9805e3d33a7SSam Clegg assert(Symbol.isFunction()); 9815e3d33a7SSam Clegg 9825e3d33a7SSam Clegg WasmFunctionType F; 983aff1c4dfSSam Clegg const MCSymbolWasm* ResolvedSym = ResolveSymbol(Symbol); 9845e3d33a7SSam Clegg F.Returns = ResolvedSym->getReturns(); 9855e3d33a7SSam Clegg F.Params = ResolvedSym->getParams(); 9865e3d33a7SSam Clegg 9875e3d33a7SSam Clegg auto Pair = 9885e3d33a7SSam Clegg FunctionTypeIndices.insert(std::make_pair(F, FunctionTypes.size())); 9895e3d33a7SSam Clegg if (Pair.second) 9905e3d33a7SSam Clegg FunctionTypes.push_back(F); 9915e3d33a7SSam Clegg TypeIndices[&Symbol] = Pair.first->second; 9925e3d33a7SSam Clegg 9935e3d33a7SSam Clegg DEBUG(dbgs() << "registerFunctionType: " << Symbol << " new:" << Pair.second << "\n"); 9945e3d33a7SSam Clegg DEBUG(dbgs() << " -> type index: " << Pair.first->second << "\n"); 9955e3d33a7SSam Clegg return Pair.first->second; 9965e3d33a7SSam Clegg } 9975e3d33a7SSam Clegg 99818eafb6cSDan Gohman void WasmObjectWriter::writeObject(MCAssembler &Asm, 99918eafb6cSDan Gohman const MCAsmLayout &Layout) { 1000b7787fd0SSam Clegg DEBUG(dbgs() << "WasmObjectWriter::writeObject\n"); 100182607f56SDan Gohman MCContext &Ctx = Asm.getContext(); 1002b879539aSDerek Schuff wasm::ValType PtrType = is64Bit() ? wasm::ValType::I64 : wasm::ValType::I32; 1003d934cb88SDan Gohman 1004d934cb88SDan Gohman // Collect information from the available symbols. 1005d934cb88SDan Gohman SmallVector<WasmFunction, 4> Functions; 1006d934cb88SDan Gohman SmallVector<uint32_t, 4> TableElems; 1007d934cb88SDan Gohman SmallVector<WasmImport, 4> Imports; 1008d934cb88SDan Gohman SmallVector<WasmExport, 4> Exports; 100931a2c809SSam Clegg SmallVector<std::pair<StringRef, uint32_t>, 4> SymbolFlags; 1010d934cb88SDan Gohman SmallPtrSet<const MCSymbolWasm *, 4> IsAddressTaken; 1011d934cb88SDan Gohman unsigned NumFuncImports = 0; 10127c395943SSam Clegg SmallVector<WasmDataSegment, 4> DataSegments; 1013*c2c99771SDan Gohman Optional<StringRef> StackPointerGlobalName; 1014*c2c99771SDan Gohman Optional<uint32_t> StackPointerGlobal; 10157c395943SSam Clegg uint32_t DataSize = 0; 1016d934cb88SDan Gohman 1017d934cb88SDan Gohman // Populate the IsAddressTaken set. 1018b7787fd0SSam Clegg for (const WasmRelocationEntry &RelEntry : CodeRelocations) { 1019d934cb88SDan Gohman switch (RelEntry.Type) { 1020d934cb88SDan Gohman case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB: 102113a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB: 1022d934cb88SDan Gohman IsAddressTaken.insert(RelEntry.Symbol); 1023d934cb88SDan Gohman break; 1024d934cb88SDan Gohman default: 1025d934cb88SDan Gohman break; 1026d934cb88SDan Gohman } 1027d934cb88SDan Gohman } 1028b7787fd0SSam Clegg for (const WasmRelocationEntry &RelEntry : DataRelocations) { 1029d934cb88SDan Gohman switch (RelEntry.Type) { 1030d934cb88SDan Gohman case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32: 103113a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32: 1032d934cb88SDan Gohman IsAddressTaken.insert(RelEntry.Symbol); 1033d934cb88SDan Gohman break; 1034d934cb88SDan Gohman default: 1035d934cb88SDan Gohman break; 1036d934cb88SDan Gohman } 1037d934cb88SDan Gohman } 1038d934cb88SDan Gohman 10397c395943SSam Clegg // Populate FunctionTypeIndices and Imports. 1040d934cb88SDan Gohman for (const MCSymbol &S : Asm.symbols()) { 10415e3d33a7SSam Clegg const auto &WS = static_cast<const MCSymbolWasm &>(S); 10425e3d33a7SSam Clegg 10432803bfafSDan Gohman // Register types for all functions, including those with private linkage 10442803bfafSDan Gohman // (making them 10452803bfafSDan Gohman // because wasm always needs a type signature. 10465e3d33a7SSam Clegg if (WS.isFunction()) 10475e3d33a7SSam Clegg registerFunctionType(WS); 1048d934cb88SDan Gohman 10492803bfafSDan Gohman if (WS.isTemporary()) 10502803bfafSDan Gohman continue; 10512803bfafSDan Gohman 1052d934cb88SDan Gohman // If the symbol is not defined in this translation unit, import it. 1053ba9fa9fdSSam Clegg if (!WS.isDefined(/*SetUsed=*/false)) { 1054d934cb88SDan Gohman WasmImport Import; 1055d934cb88SDan Gohman Import.ModuleName = WS.getModuleName(); 1056d934cb88SDan Gohman Import.FieldName = WS.getName(); 1057d934cb88SDan Gohman 1058d934cb88SDan Gohman if (WS.isFunction()) { 1059d934cb88SDan Gohman Import.Kind = wasm::WASM_EXTERNAL_FUNCTION; 10605e3d33a7SSam Clegg Import.Type = getFunctionType(WS); 1061d934cb88SDan Gohman SymbolIndices[&WS] = NumFuncImports; 1062d934cb88SDan Gohman ++NumFuncImports; 1063d934cb88SDan Gohman } else { 1064d934cb88SDan Gohman Import.Kind = wasm::WASM_EXTERNAL_GLOBAL; 10655e3d33a7SSam Clegg Import.Type = int32_t(PtrType); 1066d934cb88SDan Gohman SymbolIndices[&WS] = NumGlobalImports; 1067d934cb88SDan Gohman ++NumGlobalImports; 1068d934cb88SDan Gohman } 1069d934cb88SDan Gohman 1070d934cb88SDan Gohman Imports.push_back(Import); 1071d934cb88SDan Gohman } 1072d934cb88SDan Gohman } 1073d934cb88SDan Gohman 107482607f56SDan Gohman // In the special .global_variables section, we've encoded global 107582607f56SDan Gohman // variables used by the function. Translate them into the Globals 107682607f56SDan Gohman // list. 107712fd3da9SSam Clegg MCSectionWasm *GlobalVars = 107812fd3da9SSam Clegg Ctx.getWasmSection(".global_variables", SectionKind::getMetadata()); 107982607f56SDan Gohman if (!GlobalVars->getFragmentList().empty()) { 108082607f56SDan Gohman if (GlobalVars->getFragmentList().size() != 1) 108182607f56SDan Gohman report_fatal_error("only one .global_variables fragment supported"); 108282607f56SDan Gohman const MCFragment &Frag = *GlobalVars->begin(); 108382607f56SDan Gohman if (Frag.hasInstructions() || Frag.getKind() != MCFragment::FT_Data) 108482607f56SDan Gohman report_fatal_error("only data supported in .global_variables"); 1085fe6414b0SSam Clegg const auto &DataFrag = cast<MCDataFragment>(Frag); 108682607f56SDan Gohman if (!DataFrag.getFixups().empty()) 108782607f56SDan Gohman report_fatal_error("fixups not supported in .global_variables"); 108882607f56SDan Gohman const SmallVectorImpl<char> &Contents = DataFrag.getContents(); 1089970d02c4SDan Gohman for (const uint8_t *p = (const uint8_t *)Contents.data(), 1090970d02c4SDan Gohman *end = (const uint8_t *)Contents.data() + Contents.size(); 1091970d02c4SDan Gohman p != end; ) { 109282607f56SDan Gohman WasmGlobal G; 1093970d02c4SDan Gohman if (end - p < 3) 1094970d02c4SDan Gohman report_fatal_error("truncated global variable encoding"); 1095970d02c4SDan Gohman G.Type = wasm::ValType(int8_t(*p++)); 1096970d02c4SDan Gohman G.IsMutable = bool(*p++); 1097970d02c4SDan Gohman G.HasImport = bool(*p++); 1098970d02c4SDan Gohman if (G.HasImport) { 109982607f56SDan Gohman G.InitialValue = 0; 1100970d02c4SDan Gohman 1101970d02c4SDan Gohman WasmImport Import; 1102970d02c4SDan Gohman Import.ModuleName = (const char *)p; 1103970d02c4SDan Gohman const uint8_t *nul = (const uint8_t *)memchr(p, '\0', end - p); 1104970d02c4SDan Gohman if (!nul) 1105970d02c4SDan Gohman report_fatal_error("global module name must be nul-terminated"); 1106970d02c4SDan Gohman p = nul + 1; 1107970d02c4SDan Gohman nul = (const uint8_t *)memchr(p, '\0', end - p); 1108970d02c4SDan Gohman if (!nul) 1109970d02c4SDan Gohman report_fatal_error("global base name must be nul-terminated"); 1110970d02c4SDan Gohman Import.FieldName = (const char *)p; 1111970d02c4SDan Gohman p = nul + 1; 1112970d02c4SDan Gohman 1113970d02c4SDan Gohman Import.Kind = wasm::WASM_EXTERNAL_GLOBAL; 1114970d02c4SDan Gohman Import.Type = int32_t(G.Type); 1115970d02c4SDan Gohman 1116970d02c4SDan Gohman G.ImportIndex = NumGlobalImports; 1117970d02c4SDan Gohman ++NumGlobalImports; 1118970d02c4SDan Gohman 1119970d02c4SDan Gohman Imports.push_back(Import); 1120970d02c4SDan Gohman } else { 1121970d02c4SDan Gohman unsigned n; 1122970d02c4SDan Gohman G.InitialValue = decodeSLEB128(p, &n); 1123970d02c4SDan Gohman G.ImportIndex = 0; 1124c8da0c0bSSimon Pilgrim if ((ptrdiff_t)n > end - p) 1125970d02c4SDan Gohman report_fatal_error("global initial value must be valid SLEB128"); 1126970d02c4SDan Gohman p += n; 1127970d02c4SDan Gohman } 112882607f56SDan Gohman Globals.push_back(G); 112982607f56SDan Gohman } 113082607f56SDan Gohman } 113182607f56SDan Gohman 1132970d02c4SDan Gohman // In the special .stack_pointer section, we've encoded the stack pointer 1133970d02c4SDan Gohman // index. 113412fd3da9SSam Clegg MCSectionWasm *StackPtr = 113512fd3da9SSam Clegg Ctx.getWasmSection(".stack_pointer", SectionKind::getMetadata()); 1136970d02c4SDan Gohman if (!StackPtr->getFragmentList().empty()) { 1137970d02c4SDan Gohman if (StackPtr->getFragmentList().size() != 1) 1138970d02c4SDan Gohman report_fatal_error("only one .stack_pointer fragment supported"); 1139970d02c4SDan Gohman const MCFragment &Frag = *StackPtr->begin(); 1140970d02c4SDan Gohman if (Frag.hasInstructions() || Frag.getKind() != MCFragment::FT_Data) 1141970d02c4SDan Gohman report_fatal_error("only data supported in .stack_pointer"); 1142fe6414b0SSam Clegg const auto &DataFrag = cast<MCDataFragment>(Frag); 1143970d02c4SDan Gohman if (!DataFrag.getFixups().empty()) 1144970d02c4SDan Gohman report_fatal_error("fixups not supported in .stack_pointer"); 1145970d02c4SDan Gohman const SmallVectorImpl<char> &Contents = DataFrag.getContents(); 1146*c2c99771SDan Gohman StackPointerGlobalName = StringRef(Contents.data(), Contents.size()); 1147970d02c4SDan Gohman } 1148970d02c4SDan Gohman 1149759631c7SSam Clegg for (MCSection &Sec : Asm) { 1150759631c7SSam Clegg auto &Section = static_cast<MCSectionWasm &>(Sec); 115112fd3da9SSam Clegg if (!Section.isWasmData()) 1152759631c7SSam Clegg continue; 1153759631c7SSam Clegg 1154759631c7SSam Clegg DataSize = alignTo(DataSize, Section.getAlignment()); 1155759631c7SSam Clegg DataSegments.emplace_back(); 1156759631c7SSam Clegg WasmDataSegment &Segment = DataSegments.back(); 1157d95ed959SSam Clegg Segment.Name = Section.getSectionName(); 1158759631c7SSam Clegg Segment.Offset = DataSize; 1159759631c7SSam Clegg Segment.Section = &Section; 116063ebb813SSam Clegg addData(Segment.Data, Section); 116163ebb813SSam Clegg Segment.Alignment = Section.getAlignment(); 116263ebb813SSam Clegg Segment.Flags = 0; 1163759631c7SSam Clegg DataSize += Segment.Data.size(); 1164759631c7SSam Clegg Section.setMemoryOffset(Segment.Offset); 1165759631c7SSam Clegg } 1166759631c7SSam Clegg 1167b7787fd0SSam Clegg // Handle regular defined and undefined symbols. 1168d934cb88SDan Gohman for (const MCSymbol &S : Asm.symbols()) { 1169d934cb88SDan Gohman // Ignore unnamed temporary symbols, which aren't ever exported, imported, 1170d934cb88SDan Gohman // or used in relocations. 1171d934cb88SDan Gohman if (S.isTemporary() && S.getName().empty()) 1172d934cb88SDan Gohman continue; 1173b7787fd0SSam Clegg 1174d934cb88SDan Gohman const auto &WS = static_cast<const MCSymbolWasm &>(S); 1175b7787fd0SSam Clegg DEBUG(dbgs() << "MCSymbol: '" << S << "'" 1176b7787fd0SSam Clegg << " isDefined=" << S.isDefined() << " isExternal=" 1177b7787fd0SSam Clegg << S.isExternal() << " isTemporary=" << S.isTemporary() 1178b7787fd0SSam Clegg << " isFunction=" << WS.isFunction() 1179b7787fd0SSam Clegg << " isWeak=" << WS.isWeak() 1180a2b35dacSSam Clegg << " isHidden=" << WS.isHidden() 1181b7787fd0SSam Clegg << " isVariable=" << WS.isVariable() << "\n"); 1182b7787fd0SSam Clegg 1183a2b35dacSSam Clegg if (WS.isWeak() || WS.isHidden()) { 1184a2b35dacSSam Clegg uint32_t Flags = (WS.isWeak() ? wasm::WASM_SYMBOL_BINDING_WEAK : 0) | 1185a2b35dacSSam Clegg (WS.isHidden() ? wasm::WASM_SYMBOL_VISIBILITY_HIDDEN : 0); 1186a2b35dacSSam Clegg SymbolFlags.emplace_back(WS.getName(), Flags); 1187a2b35dacSSam Clegg } 1188b7787fd0SSam Clegg 11895e3d33a7SSam Clegg if (WS.isVariable()) 11905e3d33a7SSam Clegg continue; 11915e3d33a7SSam Clegg 1192d934cb88SDan Gohman unsigned Index; 1193b7787fd0SSam Clegg 1194d934cb88SDan Gohman if (WS.isFunction()) { 1195d934cb88SDan Gohman if (WS.isDefined(/*SetUsed=*/false)) { 1196b7787fd0SSam Clegg if (WS.getOffset() != 0) 1197b7787fd0SSam Clegg report_fatal_error( 1198b7787fd0SSam Clegg "function sections must contain one function each"); 1199b7787fd0SSam Clegg 1200b7787fd0SSam Clegg if (WS.getSize() == 0) 1201b7787fd0SSam Clegg report_fatal_error( 1202b7787fd0SSam Clegg "function symbols must have a size set with .size"); 1203b7787fd0SSam Clegg 1204d934cb88SDan Gohman // A definition. Take the next available index. 1205d934cb88SDan Gohman Index = NumFuncImports + Functions.size(); 1206d934cb88SDan Gohman 1207d934cb88SDan Gohman // Prepare the function. 1208d934cb88SDan Gohman WasmFunction Func; 12095e3d33a7SSam Clegg Func.Type = getFunctionType(WS); 1210d934cb88SDan Gohman Func.Sym = &WS; 1211d934cb88SDan Gohman SymbolIndices[&WS] = Index; 1212d934cb88SDan Gohman Functions.push_back(Func); 1213d934cb88SDan Gohman } else { 1214d934cb88SDan Gohman // An import; the index was assigned above. 1215d934cb88SDan Gohman Index = SymbolIndices.find(&WS)->second; 1216d934cb88SDan Gohman } 1217d934cb88SDan Gohman 12185e3d33a7SSam Clegg DEBUG(dbgs() << " -> function index: " << Index << "\n"); 12195e3d33a7SSam Clegg 1220d934cb88SDan Gohman // If needed, prepare the function to be called indirectly. 12215e3d33a7SSam Clegg if (IsAddressTaken.count(&WS) != 0) { 1222d99f6078SSam Clegg IndirectSymbolIndices[&WS] = TableElems.size(); 12235e3d33a7SSam Clegg DEBUG(dbgs() << " -> adding to table: " << TableElems.size() << "\n"); 1224d934cb88SDan Gohman TableElems.push_back(Index); 1225d99f6078SSam Clegg } 1226d934cb88SDan Gohman } else { 1227c38e947eSSam Clegg if (WS.isTemporary() && !WS.getSize()) 1228c38e947eSSam Clegg continue; 1229c38e947eSSam Clegg 1230fe6414b0SSam Clegg if (!WS.isDefined(/*SetUsed=*/false)) 1231fe6414b0SSam Clegg continue; 1232fe6414b0SSam Clegg 1233d934cb88SDan Gohman if (!WS.getSize()) 1234c38e947eSSam Clegg report_fatal_error("data symbols must have a size set with .size: " + 1235c38e947eSSam Clegg WS.getName()); 1236d934cb88SDan Gohman 1237d934cb88SDan Gohman int64_t Size = 0; 1238d934cb88SDan Gohman if (!WS.getSize()->evaluateAsAbsolute(Size, Layout)) 1239d934cb88SDan Gohman report_fatal_error(".size expression must be evaluatable"); 1240d934cb88SDan Gohman 12417c395943SSam Clegg // For each global, prepare a corresponding wasm global holding its 12427c395943SSam Clegg // address. For externals these will also be named exports. 12437c395943SSam Clegg Index = NumGlobalImports + Globals.size(); 1244759631c7SSam Clegg auto &DataSection = static_cast<MCSectionWasm &>(WS.getSection()); 12457c395943SSam Clegg 12467c395943SSam Clegg WasmGlobal Global; 12477c395943SSam Clegg Global.Type = PtrType; 12487c395943SSam Clegg Global.IsMutable = false; 12497c395943SSam Clegg Global.HasImport = false; 1250759631c7SSam Clegg Global.InitialValue = DataSection.getMemoryOffset() + Layout.getSymbolOffset(WS); 12517c395943SSam Clegg Global.ImportIndex = 0; 12527c395943SSam Clegg SymbolIndices[&WS] = Index; 12537c395943SSam Clegg DEBUG(dbgs() << " -> global index: " << Index << "\n"); 12547c395943SSam Clegg Globals.push_back(Global); 1255*c2c99771SDan Gohman 1256*c2c99771SDan Gohman if (StackPointerGlobalName.hasValue() && 1257*c2c99771SDan Gohman WS.getName() == StackPointerGlobalName.getValue()) 1258*c2c99771SDan Gohman StackPointerGlobal = Index; 1259d934cb88SDan Gohman } 1260d934cb88SDan Gohman 1261d934cb88SDan Gohman // If the symbol is visible outside this translation unit, export it. 126231a2c809SSam Clegg if (WS.isDefined(/*SetUsed=*/false)) { 1263d934cb88SDan Gohman WasmExport Export; 1264d934cb88SDan Gohman Export.FieldName = WS.getName(); 1265d934cb88SDan Gohman Export.Index = Index; 1266d934cb88SDan Gohman if (WS.isFunction()) 1267d934cb88SDan Gohman Export.Kind = wasm::WASM_EXTERNAL_FUNCTION; 1268d934cb88SDan Gohman else 1269d934cb88SDan Gohman Export.Kind = wasm::WASM_EXTERNAL_GLOBAL; 12705e3d33a7SSam Clegg DEBUG(dbgs() << " -> export " << Exports.size() << "\n"); 1271d934cb88SDan Gohman Exports.push_back(Export); 127231a2c809SSam Clegg if (!WS.isExternal()) 127331a2c809SSam Clegg SymbolFlags.emplace_back(WS.getName(), wasm::WASM_SYMBOL_BINDING_LOCAL); 1274d934cb88SDan Gohman } 1275d934cb88SDan Gohman } 1276d934cb88SDan Gohman 12775e3d33a7SSam Clegg // Handle weak aliases. We need to process these in a separate pass because 12785e3d33a7SSam Clegg // we need to have processed the target of the alias before the alias itself 12795e3d33a7SSam Clegg // and the symbols are not necessarily ordered in this way. 1280b7787fd0SSam Clegg for (const MCSymbol &S : Asm.symbols()) { 1281b7787fd0SSam Clegg if (!S.isVariable()) 1282b7787fd0SSam Clegg continue; 128331a2c809SSam Clegg 1284b7787fd0SSam Clegg assert(S.isDefined(/*SetUsed=*/false)); 1285b7787fd0SSam Clegg 12865e3d33a7SSam Clegg // Find the target symbol of this weak alias and export that index 1287aff1c4dfSSam Clegg const auto &WS = static_cast<const MCSymbolWasm &>(S); 1288aff1c4dfSSam Clegg const MCSymbolWasm *ResolvedSym = ResolveSymbol(WS); 12895e3d33a7SSam Clegg DEBUG(dbgs() << WS.getName() << ": weak alias of '" << *ResolvedSym << "'\n"); 12905e3d33a7SSam Clegg assert(SymbolIndices.count(ResolvedSym) > 0); 1291b7787fd0SSam Clegg uint32_t Index = SymbolIndices.find(ResolvedSym)->second; 12925e3d33a7SSam Clegg DEBUG(dbgs() << " -> index:" << Index << "\n"); 1293b7787fd0SSam Clegg 1294ba9fa9fdSSam Clegg SymbolIndices[&WS] = Index; 1295b7787fd0SSam Clegg WasmExport Export; 1296b7787fd0SSam Clegg Export.FieldName = WS.getName(); 1297b7787fd0SSam Clegg Export.Index = Index; 1298b7787fd0SSam Clegg if (WS.isFunction()) 1299b7787fd0SSam Clegg Export.Kind = wasm::WASM_EXTERNAL_FUNCTION; 1300b7787fd0SSam Clegg else 1301b7787fd0SSam Clegg Export.Kind = wasm::WASM_EXTERNAL_GLOBAL; 13025e3d33a7SSam Clegg DEBUG(dbgs() << " -> export " << Exports.size() << "\n"); 1303b7787fd0SSam Clegg Exports.push_back(Export); 130431a2c809SSam Clegg 130531a2c809SSam Clegg if (!WS.isExternal()) 130631a2c809SSam Clegg SymbolFlags.emplace_back(WS.getName(), wasm::WASM_SYMBOL_BINDING_LOCAL); 1307b7787fd0SSam Clegg } 1308b7787fd0SSam Clegg 1309d934cb88SDan Gohman // Add types for indirect function calls. 1310acd7d2b0SSam Clegg for (const WasmRelocationEntry &Fixup : CodeRelocations) { 1311acd7d2b0SSam Clegg if (Fixup.Type != wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB) 1312acd7d2b0SSam Clegg continue; 1313970d02c4SDan Gohman 13145e3d33a7SSam Clegg registerFunctionType(*Fixup.Symbol); 1315d934cb88SDan Gohman } 1316d934cb88SDan Gohman 131718eafb6cSDan Gohman // Write out the Wasm header. 131818eafb6cSDan Gohman writeHeader(Asm); 131918eafb6cSDan Gohman 13209e15f359SSam Clegg writeTypeSection(FunctionTypes); 13219e15f359SSam Clegg writeImportSection(Imports); 13229e15f359SSam Clegg writeFunctionSection(Functions); 1323d99f6078SSam Clegg writeTableSection(TableElems.size()); 13247c395943SSam Clegg writeMemorySection(DataSize); 13257c395943SSam Clegg writeGlobalSection(); 13269e15f359SSam Clegg writeExportSection(Exports); 13279e15f359SSam Clegg // TODO: Start Section 13289e15f359SSam Clegg writeElemSection(TableElems); 1329acd7d2b0SSam Clegg writeCodeSection(Asm, Layout, Functions); 13307c395943SSam Clegg writeDataSection(DataSegments); 13319e15f359SSam Clegg writeNameSection(Functions, Imports, NumFuncImports); 1332acd7d2b0SSam Clegg writeCodeRelocSection(); 13337c395943SSam Clegg writeDataRelocSection(); 133463ebb813SSam Clegg writeLinkingMetaDataSection(DataSegments, DataSize, SymbolFlags, 1335*c2c99771SDan Gohman StackPointerGlobal); 1336970d02c4SDan Gohman 1337d934cb88SDan Gohman // TODO: Translate the .comment section to the output. 1338d934cb88SDan Gohman // TODO: Translate debug sections to the output. 133918eafb6cSDan Gohman } 134018eafb6cSDan Gohman 134160fbc7ccSLang Hames std::unique_ptr<MCObjectWriter> 13421301a878SLang Hames llvm::createWasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW, 134318eafb6cSDan Gohman raw_pwrite_stream &OS) { 134460fbc7ccSLang Hames // FIXME: Can't use make_unique<WasmObjectWriter>(...) as WasmObjectWriter's 134560fbc7ccSLang Hames // destructor is private. Is that necessary? 134660fbc7ccSLang Hames return std::unique_ptr<MCObjectWriter>( 134760fbc7ccSLang Hames new WasmObjectWriter(std::move(MOTW), OS)); 134818eafb6cSDan Gohman } 1349