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/MCAsmLayout.h" 1918eafb6cSDan Gohman #include "llvm/MC/MCAssembler.h" 2018eafb6cSDan Gohman #include "llvm/MC/MCContext.h" 2118eafb6cSDan Gohman #include "llvm/MC/MCExpr.h" 2218eafb6cSDan Gohman #include "llvm/MC/MCFixupKindInfo.h" 2318eafb6cSDan Gohman #include "llvm/MC/MCObjectWriter.h" 2418eafb6cSDan Gohman #include "llvm/MC/MCSectionWasm.h" 2518eafb6cSDan Gohman #include "llvm/MC/MCSymbolWasm.h" 2618eafb6cSDan Gohman #include "llvm/MC/MCValue.h" 2718eafb6cSDan Gohman #include "llvm/MC/MCWasmObjectWriter.h" 28d934cb88SDan Gohman #include "llvm/Support/Casting.h" 2918eafb6cSDan Gohman #include "llvm/Support/Debug.h" 3018eafb6cSDan Gohman #include "llvm/Support/ErrorHandling.h" 31d934cb88SDan Gohman #include "llvm/Support/LEB128.h" 3218eafb6cSDan Gohman #include "llvm/Support/StringSaver.h" 3318eafb6cSDan Gohman #include <vector> 3418eafb6cSDan Gohman 3518eafb6cSDan Gohman using namespace llvm; 3618eafb6cSDan Gohman 375e3d33a7SSam Clegg #define DEBUG_TYPE "mc" 3818eafb6cSDan Gohman 3918eafb6cSDan Gohman namespace { 409e15f359SSam Clegg 41d934cb88SDan Gohman // For patching purposes, we need to remember where each section starts, both 42d934cb88SDan Gohman // for patching up the section size field, and for patching up references to 43d934cb88SDan Gohman // locations within the section. 44d934cb88SDan Gohman struct SectionBookkeeping { 45d934cb88SDan Gohman // Where the size of the section is written. 46d934cb88SDan Gohman uint64_t SizeOffset; 47d934cb88SDan Gohman // Where the contents of the section starts (after the header). 48d934cb88SDan Gohman uint64_t ContentsOffset; 49d934cb88SDan Gohman }; 50d934cb88SDan Gohman 519e15f359SSam Clegg // The signature of a wasm function, in a struct capable of being used as a 529e15f359SSam Clegg // DenseMap key. 539e15f359SSam Clegg struct WasmFunctionType { 549e15f359SSam Clegg // Support empty and tombstone instances, needed by DenseMap. 559e15f359SSam Clegg enum { Plain, Empty, Tombstone } State; 569e15f359SSam Clegg 579e15f359SSam Clegg // The return types of the function. 589e15f359SSam Clegg SmallVector<wasm::ValType, 1> Returns; 599e15f359SSam Clegg 609e15f359SSam Clegg // The parameter types of the function. 619e15f359SSam Clegg SmallVector<wasm::ValType, 4> Params; 629e15f359SSam Clegg 639e15f359SSam Clegg WasmFunctionType() : State(Plain) {} 649e15f359SSam Clegg 659e15f359SSam Clegg bool operator==(const WasmFunctionType &Other) const { 669e15f359SSam Clegg return State == Other.State && Returns == Other.Returns && 679e15f359SSam Clegg Params == Other.Params; 689e15f359SSam Clegg } 699e15f359SSam Clegg }; 709e15f359SSam Clegg 719e15f359SSam Clegg // Traits for using WasmFunctionType in a DenseMap. 729e15f359SSam Clegg struct WasmFunctionTypeDenseMapInfo { 739e15f359SSam Clegg static WasmFunctionType getEmptyKey() { 749e15f359SSam Clegg WasmFunctionType FuncTy; 759e15f359SSam Clegg FuncTy.State = WasmFunctionType::Empty; 769e15f359SSam Clegg return FuncTy; 779e15f359SSam Clegg } 789e15f359SSam Clegg static WasmFunctionType getTombstoneKey() { 799e15f359SSam Clegg WasmFunctionType FuncTy; 809e15f359SSam Clegg FuncTy.State = WasmFunctionType::Tombstone; 819e15f359SSam Clegg return FuncTy; 829e15f359SSam Clegg } 839e15f359SSam Clegg static unsigned getHashValue(const WasmFunctionType &FuncTy) { 849e15f359SSam Clegg uintptr_t Value = FuncTy.State; 859e15f359SSam Clegg for (wasm::ValType Ret : FuncTy.Returns) 869e15f359SSam Clegg Value += DenseMapInfo<int32_t>::getHashValue(int32_t(Ret)); 879e15f359SSam Clegg for (wasm::ValType Param : FuncTy.Params) 889e15f359SSam Clegg Value += DenseMapInfo<int32_t>::getHashValue(int32_t(Param)); 899e15f359SSam Clegg return Value; 909e15f359SSam Clegg } 919e15f359SSam Clegg static bool isEqual(const WasmFunctionType &LHS, 929e15f359SSam Clegg const WasmFunctionType &RHS) { 939e15f359SSam Clegg return LHS == RHS; 949e15f359SSam Clegg } 959e15f359SSam Clegg }; 969e15f359SSam Clegg 977c395943SSam Clegg // A wasm data segment. A wasm binary contains only a single data section 987c395943SSam Clegg // but that can contain many segments, each with their own virtual location 997c395943SSam Clegg // in memory. Each MCSection data created by llvm is modeled as its own 1007c395943SSam Clegg // wasm data segment. 1017c395943SSam Clegg struct WasmDataSegment { 1027c395943SSam Clegg MCSectionWasm *Section; 103d95ed959SSam Clegg StringRef Name; 1047c395943SSam Clegg uint32_t Offset; 10563ebb813SSam Clegg uint32_t Alignment; 10663ebb813SSam Clegg uint32_t Flags; 1077c395943SSam Clegg SmallVector<char, 4> Data; 1087c395943SSam Clegg }; 1097c395943SSam Clegg 1109e15f359SSam Clegg // A wasm import to be written into the import section. 1119e15f359SSam Clegg struct WasmImport { 1129e15f359SSam Clegg StringRef ModuleName; 1139e15f359SSam Clegg StringRef FieldName; 1149e15f359SSam Clegg unsigned Kind; 1159e15f359SSam Clegg int32_t Type; 11632ce5ca0SDan Gohman bool IsMutable; 1179e15f359SSam Clegg }; 1189e15f359SSam Clegg 1199e15f359SSam Clegg // A wasm function to be written into the function section. 1209e15f359SSam Clegg struct WasmFunction { 1219e15f359SSam Clegg int32_t Type; 1229e15f359SSam Clegg const MCSymbolWasm *Sym; 1239e15f359SSam Clegg }; 1249e15f359SSam Clegg 1259e15f359SSam Clegg // A wasm export to be written into the export section. 1269e15f359SSam Clegg struct WasmExport { 1279e15f359SSam Clegg StringRef FieldName; 1289e15f359SSam Clegg unsigned Kind; 1299e15f359SSam Clegg uint32_t Index; 1309e15f359SSam Clegg }; 1319e15f359SSam Clegg 1329e15f359SSam Clegg // A wasm global to be written into the global section. 1339e15f359SSam Clegg struct WasmGlobal { 1349e15f359SSam Clegg wasm::ValType Type; 1359e15f359SSam Clegg bool IsMutable; 1369e15f359SSam Clegg bool HasImport; 1379e15f359SSam Clegg uint64_t InitialValue; 1389e15f359SSam Clegg uint32_t ImportIndex; 1399e15f359SSam Clegg }; 1409e15f359SSam Clegg 1416dc65e91SSam Clegg // Information about a single relocation. 1426dc65e91SSam Clegg struct WasmRelocationEntry { 1436dc65e91SSam Clegg uint64_t Offset; // Where is the relocation. 1446dc65e91SSam Clegg const MCSymbolWasm *Symbol; // The symbol to relocate with. 1456dc65e91SSam Clegg int64_t Addend; // A value to add to the symbol. 1466dc65e91SSam Clegg unsigned Type; // The type of the relocation. 147fe6414b0SSam Clegg const MCSectionWasm *FixupSection;// The section the relocation is targeting. 1486dc65e91SSam Clegg 1496dc65e91SSam Clegg WasmRelocationEntry(uint64_t Offset, const MCSymbolWasm *Symbol, 1506dc65e91SSam Clegg int64_t Addend, unsigned Type, 151fe6414b0SSam Clegg const MCSectionWasm *FixupSection) 1526dc65e91SSam Clegg : Offset(Offset), Symbol(Symbol), Addend(Addend), Type(Type), 1536dc65e91SSam Clegg FixupSection(FixupSection) {} 1546dc65e91SSam Clegg 155acd7d2b0SSam Clegg bool hasAddend() const { 156acd7d2b0SSam Clegg switch (Type) { 15713a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB: 15813a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB: 15913a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32: 160acd7d2b0SSam Clegg return true; 161acd7d2b0SSam Clegg default: 162acd7d2b0SSam Clegg return false; 163acd7d2b0SSam Clegg } 164acd7d2b0SSam Clegg } 165acd7d2b0SSam Clegg 1666dc65e91SSam Clegg void print(raw_ostream &Out) const { 1679bf73c07SSam Clegg Out << "Off=" << Offset << ", Sym=" << *Symbol << ", Addend=" << Addend 168759631c7SSam Clegg << ", Type=" << Type 169759631c7SSam Clegg << ", FixupSection=" << FixupSection->getSectionName(); 1706dc65e91SSam Clegg } 171b7787fd0SSam Clegg 172615eb470SAaron Ballman #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP) 173b7787fd0SSam Clegg LLVM_DUMP_METHOD void dump() const { print(dbgs()); } 174b7787fd0SSam Clegg #endif 1756dc65e91SSam Clegg }; 1766dc65e91SSam Clegg 1771fb8daa6SSam Clegg #if !defined(NDEBUG) 1787f055deeSSam Clegg raw_ostream &operator<<(raw_ostream &OS, const WasmRelocationEntry &Rel) { 179b7787fd0SSam Clegg Rel.print(OS); 180b7787fd0SSam Clegg return OS; 181b7787fd0SSam Clegg } 1821fb8daa6SSam Clegg #endif 183b7787fd0SSam Clegg 18418eafb6cSDan Gohman class WasmObjectWriter : public MCObjectWriter { 18518eafb6cSDan Gohman /// Helper struct for containing some precomputed information on symbols. 18618eafb6cSDan Gohman struct WasmSymbolData { 18718eafb6cSDan Gohman const MCSymbolWasm *Symbol; 18818eafb6cSDan Gohman StringRef Name; 18918eafb6cSDan Gohman 19018eafb6cSDan Gohman // Support lexicographic sorting. 19118eafb6cSDan Gohman bool operator<(const WasmSymbolData &RHS) const { return Name < RHS.Name; } 19218eafb6cSDan Gohman }; 19318eafb6cSDan Gohman 19418eafb6cSDan Gohman /// The target specific Wasm writer instance. 19518eafb6cSDan Gohman std::unique_ptr<MCWasmObjectTargetWriter> TargetObjectWriter; 19618eafb6cSDan Gohman 197d934cb88SDan Gohman // Relocations for fixing up references in the code section. 198d934cb88SDan Gohman std::vector<WasmRelocationEntry> CodeRelocations; 199d934cb88SDan Gohman 200d934cb88SDan Gohman // Relocations for fixing up references in the data section. 201d934cb88SDan Gohman std::vector<WasmRelocationEntry> DataRelocations; 202d934cb88SDan Gohman 203d934cb88SDan Gohman // Index values to use for fixing up call_indirect type indices. 204acd7d2b0SSam Clegg // Maps function symbols to the index of the type of the function 205acd7d2b0SSam Clegg DenseMap<const MCSymbolWasm *, uint32_t> TypeIndices; 206d99f6078SSam Clegg // Maps function symbols to the table element index space. Used 207d99f6078SSam Clegg // for TABLE_INDEX relocation types (i.e. address taken functions). 208d99f6078SSam Clegg DenseMap<const MCSymbolWasm *, uint32_t> IndirectSymbolIndices; 209d99f6078SSam Clegg // Maps function/global symbols to the function/global index space. 210acd7d2b0SSam Clegg DenseMap<const MCSymbolWasm *, uint32_t> SymbolIndices; 211acd7d2b0SSam Clegg 212acd7d2b0SSam Clegg DenseMap<WasmFunctionType, int32_t, WasmFunctionTypeDenseMapInfo> 213acd7d2b0SSam Clegg FunctionTypeIndices; 2145e3d33a7SSam Clegg SmallVector<WasmFunctionType, 4> FunctionTypes; 2157c395943SSam Clegg SmallVector<WasmGlobal, 4> Globals; 2167c395943SSam Clegg unsigned NumGlobalImports = 0; 217d934cb88SDan Gohman 21818eafb6cSDan Gohman // TargetObjectWriter wrappers. 21918eafb6cSDan Gohman bool is64Bit() const { return TargetObjectWriter->is64Bit(); } 220ae03c1e7SSam Clegg unsigned getRelocType(const MCValue &Target, const MCFixup &Fixup) const { 221ae03c1e7SSam Clegg return TargetObjectWriter->getRelocType(Target, Fixup); 22218eafb6cSDan Gohman } 22318eafb6cSDan Gohman 224d934cb88SDan Gohman void startSection(SectionBookkeeping &Section, unsigned SectionId, 225d934cb88SDan Gohman const char *Name = nullptr); 226d934cb88SDan Gohman void endSection(SectionBookkeeping &Section); 227d934cb88SDan Gohman 22818eafb6cSDan Gohman public: 2291301a878SLang Hames WasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW, 2301301a878SLang Hames raw_pwrite_stream &OS) 2311301a878SLang Hames : MCObjectWriter(OS, /*IsLittleEndian=*/true), 2321301a878SLang Hames TargetObjectWriter(std::move(MOTW)) {} 23318eafb6cSDan Gohman 234d934cb88SDan Gohman private: 23518eafb6cSDan Gohman ~WasmObjectWriter() override; 23618eafb6cSDan Gohman 237acd7d2b0SSam Clegg void reset() override { 238acd7d2b0SSam Clegg CodeRelocations.clear(); 239acd7d2b0SSam Clegg DataRelocations.clear(); 240acd7d2b0SSam Clegg TypeIndices.clear(); 241acd7d2b0SSam Clegg SymbolIndices.clear(); 242d99f6078SSam Clegg IndirectSymbolIndices.clear(); 243acd7d2b0SSam Clegg FunctionTypeIndices.clear(); 2445e3d33a7SSam Clegg FunctionTypes.clear(); 2457c395943SSam Clegg Globals.clear(); 246acd7d2b0SSam Clegg MCObjectWriter::reset(); 2477c395943SSam Clegg NumGlobalImports = 0; 248acd7d2b0SSam Clegg } 249acd7d2b0SSam Clegg 25018eafb6cSDan Gohman void writeHeader(const MCAssembler &Asm); 25118eafb6cSDan Gohman 25218eafb6cSDan Gohman void recordRelocation(MCAssembler &Asm, const MCAsmLayout &Layout, 25318eafb6cSDan Gohman const MCFragment *Fragment, const MCFixup &Fixup, 254ceecfe5bSRafael Espindola MCValue Target, uint64_t &FixedValue) override; 25518eafb6cSDan Gohman 25618eafb6cSDan Gohman void executePostLayoutBinding(MCAssembler &Asm, 25718eafb6cSDan Gohman const MCAsmLayout &Layout) override; 25818eafb6cSDan Gohman 25918eafb6cSDan Gohman void writeObject(MCAssembler &Asm, const MCAsmLayout &Layout) override; 2609e15f359SSam Clegg 261b7787fd0SSam Clegg void writeString(const StringRef Str) { 262b7787fd0SSam Clegg encodeULEB128(Str.size(), getStream()); 263b7787fd0SSam Clegg writeBytes(Str); 264b7787fd0SSam Clegg } 265b7787fd0SSam Clegg 2669e15f359SSam Clegg void writeValueType(wasm::ValType Ty) { 2679e15f359SSam Clegg encodeSLEB128(int32_t(Ty), getStream()); 2689e15f359SSam Clegg } 2699e15f359SSam Clegg 270457fb0b4SSam Clegg void writeTypeSection(ArrayRef<WasmFunctionType> FunctionTypes); 271f950b24aSSam Clegg void writeImportSection(ArrayRef<WasmImport> Imports, uint32_t DataSize, 272f950b24aSSam Clegg uint32_t NumElements); 273457fb0b4SSam Clegg void writeFunctionSection(ArrayRef<WasmFunction> Functions); 2747c395943SSam Clegg void writeGlobalSection(); 275457fb0b4SSam Clegg void writeExportSection(ArrayRef<WasmExport> Exports); 276457fb0b4SSam Clegg void writeElemSection(ArrayRef<uint32_t> TableElems); 2779e15f359SSam Clegg void writeCodeSection(const MCAssembler &Asm, const MCAsmLayout &Layout, 278457fb0b4SSam Clegg ArrayRef<WasmFunction> Functions); 279457fb0b4SSam Clegg void writeDataSection(ArrayRef<WasmDataSegment> Segments); 280457fb0b4SSam Clegg void writeNameSection(ArrayRef<WasmFunction> Functions, 281457fb0b4SSam Clegg ArrayRef<WasmImport> Imports, 2829e15f359SSam Clegg uint32_t NumFuncImports); 283acd7d2b0SSam Clegg void writeCodeRelocSection(); 2847c395943SSam Clegg void writeDataRelocSection(); 28531a2c809SSam Clegg void writeLinkingMetaDataSection( 28631a2c809SSam Clegg ArrayRef<WasmDataSegment> Segments, uint32_t DataSize, 287bafe6902SSam Clegg const SmallVector<std::pair<StringRef, uint32_t>, 4> &SymbolFlags, 288bafe6902SSam Clegg const SmallVector<std::pair<uint16_t, uint32_t>, 2> &InitFuncs); 289acd7d2b0SSam Clegg 2907c395943SSam Clegg uint32_t getProvisionalValue(const WasmRelocationEntry &RelEntry); 291acd7d2b0SSam Clegg void applyRelocations(ArrayRef<WasmRelocationEntry> Relocations, 292acd7d2b0SSam Clegg uint64_t ContentsOffset); 293acd7d2b0SSam Clegg 2947c395943SSam Clegg void writeRelocations(ArrayRef<WasmRelocationEntry> Relocations); 295acd7d2b0SSam Clegg uint32_t getRelocationIndexValue(const WasmRelocationEntry &RelEntry); 2965e3d33a7SSam Clegg uint32_t getFunctionType(const MCSymbolWasm& Symbol); 2975e3d33a7SSam Clegg uint32_t registerFunctionType(const MCSymbolWasm& Symbol); 29818eafb6cSDan Gohman }; 2999e15f359SSam Clegg 30018eafb6cSDan Gohman } // end anonymous namespace 30118eafb6cSDan Gohman 30218eafb6cSDan Gohman WasmObjectWriter::~WasmObjectWriter() {} 30318eafb6cSDan Gohman 304d934cb88SDan Gohman // Write out a section header and a patchable section size field. 305d934cb88SDan Gohman void WasmObjectWriter::startSection(SectionBookkeeping &Section, 306d934cb88SDan Gohman unsigned SectionId, 307d934cb88SDan Gohman const char *Name) { 308d934cb88SDan Gohman assert((Name != nullptr) == (SectionId == wasm::WASM_SEC_CUSTOM) && 309d934cb88SDan Gohman "Only custom sections can have names"); 310d934cb88SDan Gohman 311b7787fd0SSam Clegg DEBUG(dbgs() << "startSection " << SectionId << ": " << Name << "\n"); 312e2688c43SDerek Schuff encodeULEB128(SectionId, getStream()); 313d934cb88SDan Gohman 314d934cb88SDan Gohman Section.SizeOffset = getStream().tell(); 315d934cb88SDan Gohman 316d934cb88SDan Gohman // The section size. We don't know the size yet, so reserve enough space 317d934cb88SDan Gohman // for any 32-bit value; we'll patch it later. 318d934cb88SDan Gohman encodeULEB128(UINT32_MAX, getStream()); 319d934cb88SDan Gohman 320d934cb88SDan Gohman // The position where the section starts, for measuring its size. 321d934cb88SDan Gohman Section.ContentsOffset = getStream().tell(); 322d934cb88SDan Gohman 323d934cb88SDan Gohman // Custom sections in wasm also have a string identifier. 324d934cb88SDan Gohman if (SectionId == wasm::WASM_SEC_CUSTOM) { 325b7787fd0SSam Clegg assert(Name); 326b7787fd0SSam Clegg writeString(StringRef(Name)); 327d934cb88SDan Gohman } 328d934cb88SDan Gohman } 329d934cb88SDan Gohman 330d934cb88SDan Gohman // Now that the section is complete and we know how big it is, patch up the 331d934cb88SDan Gohman // section size field at the start of the section. 332d934cb88SDan Gohman void WasmObjectWriter::endSection(SectionBookkeeping &Section) { 333d934cb88SDan Gohman uint64_t Size = getStream().tell() - Section.ContentsOffset; 334d934cb88SDan Gohman if (uint32_t(Size) != Size) 335d934cb88SDan Gohman report_fatal_error("section size does not fit in a uint32_t"); 336d934cb88SDan Gohman 337b7787fd0SSam Clegg DEBUG(dbgs() << "endSection size=" << Size << "\n"); 338d934cb88SDan Gohman 339d934cb88SDan Gohman // Write the final section size to the payload_len field, which follows 340d934cb88SDan Gohman // the section id byte. 341d934cb88SDan Gohman uint8_t Buffer[16]; 34266a99e41SSam Clegg unsigned SizeLen = encodeULEB128(Size, Buffer, 5); 343d934cb88SDan Gohman assert(SizeLen == 5); 344d934cb88SDan Gohman getStream().pwrite((char *)Buffer, SizeLen, Section.SizeOffset); 345d934cb88SDan Gohman } 346d934cb88SDan Gohman 34718eafb6cSDan Gohman // Emit the Wasm header. 34818eafb6cSDan Gohman void WasmObjectWriter::writeHeader(const MCAssembler &Asm) { 3497ea5adffSDan Gohman writeBytes(StringRef(wasm::WasmMagic, sizeof(wasm::WasmMagic))); 3507ea5adffSDan Gohman writeLE32(wasm::WasmVersion); 35118eafb6cSDan Gohman } 35218eafb6cSDan Gohman 35318eafb6cSDan Gohman void WasmObjectWriter::executePostLayoutBinding(MCAssembler &Asm, 35418eafb6cSDan Gohman const MCAsmLayout &Layout) { 35518eafb6cSDan Gohman } 35618eafb6cSDan Gohman 35718eafb6cSDan Gohman void WasmObjectWriter::recordRelocation(MCAssembler &Asm, 35818eafb6cSDan Gohman const MCAsmLayout &Layout, 35918eafb6cSDan Gohman const MCFragment *Fragment, 36018eafb6cSDan Gohman const MCFixup &Fixup, MCValue Target, 361ceecfe5bSRafael Espindola uint64_t &FixedValue) { 362ceecfe5bSRafael Espindola MCAsmBackend &Backend = Asm.getBackend(); 363ceecfe5bSRafael Espindola bool IsPCRel = Backend.getFixupKindInfo(Fixup.getKind()).Flags & 364ceecfe5bSRafael Espindola MCFixupKindInfo::FKF_IsPCRel; 365fe6414b0SSam Clegg const auto &FixupSection = cast<MCSectionWasm>(*Fragment->getParent()); 366d934cb88SDan Gohman uint64_t C = Target.getConstant(); 367d934cb88SDan Gohman uint64_t FixupOffset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset(); 368d934cb88SDan Gohman MCContext &Ctx = Asm.getContext(); 369d934cb88SDan Gohman 370bafe6902SSam Clegg // The .init_array isn't translated as data, so don't do relocations in it. 371bafe6902SSam Clegg if (FixupSection.getSectionName().startswith(".init_array")) 372bafe6902SSam Clegg return; 373bafe6902SSam Clegg 374d934cb88SDan Gohman if (const MCSymbolRefExpr *RefB = Target.getSymB()) { 375d934cb88SDan Gohman assert(RefB->getKind() == MCSymbolRefExpr::VK_None && 376d934cb88SDan Gohman "Should not have constructed this"); 377d934cb88SDan Gohman 378d934cb88SDan Gohman // Let A, B and C being the components of Target and R be the location of 379d934cb88SDan Gohman // the fixup. If the fixup is not pcrel, we want to compute (A - B + C). 380d934cb88SDan Gohman // If it is pcrel, we want to compute (A - B + C - R). 381d934cb88SDan Gohman 382d934cb88SDan Gohman // In general, Wasm has no relocations for -B. It can only represent (A + C) 383d934cb88SDan Gohman // or (A + C - R). If B = R + K and the relocation is not pcrel, we can 384d934cb88SDan Gohman // replace B to implement it: (A - R - K + C) 385d934cb88SDan Gohman if (IsPCRel) { 386d934cb88SDan Gohman Ctx.reportError( 387d934cb88SDan Gohman Fixup.getLoc(), 388d934cb88SDan Gohman "No relocation available to represent this relative expression"); 389d934cb88SDan Gohman return; 390d934cb88SDan Gohman } 391d934cb88SDan Gohman 392d934cb88SDan Gohman const auto &SymB = cast<MCSymbolWasm>(RefB->getSymbol()); 393d934cb88SDan Gohman 394d934cb88SDan Gohman if (SymB.isUndefined()) { 395d934cb88SDan Gohman Ctx.reportError(Fixup.getLoc(), 396d934cb88SDan Gohman Twine("symbol '") + SymB.getName() + 397d934cb88SDan Gohman "' can not be undefined in a subtraction expression"); 398d934cb88SDan Gohman return; 399d934cb88SDan Gohman } 400d934cb88SDan Gohman 401d934cb88SDan Gohman assert(!SymB.isAbsolute() && "Should have been folded"); 402d934cb88SDan Gohman const MCSection &SecB = SymB.getSection(); 403d934cb88SDan Gohman if (&SecB != &FixupSection) { 404d934cb88SDan Gohman Ctx.reportError(Fixup.getLoc(), 405d934cb88SDan Gohman "Cannot represent a difference across sections"); 406d934cb88SDan Gohman return; 407d934cb88SDan Gohman } 408d934cb88SDan Gohman 409d934cb88SDan Gohman uint64_t SymBOffset = Layout.getSymbolOffset(SymB); 410d934cb88SDan Gohman uint64_t K = SymBOffset - FixupOffset; 411d934cb88SDan Gohman IsPCRel = true; 412d934cb88SDan Gohman C -= K; 413d934cb88SDan Gohman } 414d934cb88SDan Gohman 415d934cb88SDan Gohman // We either rejected the fixup or folded B into C at this point. 416d934cb88SDan Gohman const MCSymbolRefExpr *RefA = Target.getSymA(); 417d934cb88SDan Gohman const auto *SymA = RefA ? cast<MCSymbolWasm>(&RefA->getSymbol()) : nullptr; 418d934cb88SDan Gohman 419d934cb88SDan Gohman if (SymA && SymA->isVariable()) { 420d934cb88SDan Gohman const MCExpr *Expr = SymA->getVariableValue(); 4216ad8f190SSam Clegg const auto *Inner = cast<MCSymbolRefExpr>(Expr); 4226ad8f190SSam Clegg if (Inner->getKind() == MCSymbolRefExpr::VK_WEAKREF) 4236ad8f190SSam Clegg llvm_unreachable("weakref used in reloc not yet implemented"); 424d934cb88SDan Gohman } 425d934cb88SDan Gohman 426d934cb88SDan Gohman // Put any constant offset in an addend. Offsets can be negative, and 427d934cb88SDan Gohman // LLVM expects wrapping, in contrast to wasm's immediates which can't 428d934cb88SDan Gohman // be negative and don't wrap. 429d934cb88SDan Gohman FixedValue = 0; 430d934cb88SDan Gohman 4316ad8f190SSam Clegg if (SymA) 432d934cb88SDan Gohman SymA->setUsedInReloc(); 433d934cb88SDan Gohman 434ae03c1e7SSam Clegg assert(!IsPCRel); 4359d24fb7fSSam Clegg assert(SymA); 4369d24fb7fSSam Clegg 437ae03c1e7SSam Clegg unsigned Type = getRelocType(Target, Fixup); 438ae03c1e7SSam Clegg 439d934cb88SDan Gohman WasmRelocationEntry Rec(FixupOffset, SymA, C, Type, &FixupSection); 440b7787fd0SSam Clegg DEBUG(dbgs() << "WasmReloc: " << Rec << "\n"); 441d934cb88SDan Gohman 44212fd3da9SSam Clegg if (FixupSection.isWasmData()) 443d934cb88SDan Gohman DataRelocations.push_back(Rec); 44412fd3da9SSam Clegg else if (FixupSection.getKind().isText()) 44512fd3da9SSam Clegg CodeRelocations.push_back(Rec); 44612fd3da9SSam Clegg else if (!FixupSection.getKind().isMetadata()) 44712fd3da9SSam Clegg // TODO(sbc): Add support for debug sections. 44812fd3da9SSam Clegg llvm_unreachable("unexpected section type"); 449d934cb88SDan Gohman } 450d934cb88SDan Gohman 451d934cb88SDan Gohman // Write X as an (unsigned) LEB value at offset Offset in Stream, padded 452d934cb88SDan Gohman // to allow patching. 453d934cb88SDan Gohman static void 454d934cb88SDan Gohman WritePatchableLEB(raw_pwrite_stream &Stream, uint32_t X, uint64_t Offset) { 455d934cb88SDan Gohman uint8_t Buffer[5]; 45666a99e41SSam Clegg unsigned SizeLen = encodeULEB128(X, Buffer, 5); 457d934cb88SDan Gohman assert(SizeLen == 5); 458d934cb88SDan Gohman Stream.pwrite((char *)Buffer, SizeLen, Offset); 459d934cb88SDan Gohman } 460d934cb88SDan Gohman 461d934cb88SDan Gohman // Write X as an signed LEB value at offset Offset in Stream, padded 462d934cb88SDan Gohman // to allow patching. 463d934cb88SDan Gohman static void 464d934cb88SDan Gohman WritePatchableSLEB(raw_pwrite_stream &Stream, int32_t X, uint64_t Offset) { 465d934cb88SDan Gohman uint8_t Buffer[5]; 46666a99e41SSam Clegg unsigned SizeLen = encodeSLEB128(X, Buffer, 5); 467d934cb88SDan Gohman assert(SizeLen == 5); 468d934cb88SDan Gohman Stream.pwrite((char *)Buffer, SizeLen, Offset); 469d934cb88SDan Gohman } 470d934cb88SDan Gohman 471d934cb88SDan Gohman // Write X as a plain integer value at offset Offset in Stream. 472d934cb88SDan Gohman static void WriteI32(raw_pwrite_stream &Stream, uint32_t X, uint64_t Offset) { 473d934cb88SDan Gohman uint8_t Buffer[4]; 474d934cb88SDan Gohman support::endian::write32le(Buffer, X); 475d934cb88SDan Gohman Stream.pwrite((char *)Buffer, sizeof(Buffer), Offset); 476d934cb88SDan Gohman } 477d934cb88SDan Gohman 478aff1c4dfSSam Clegg static const MCSymbolWasm* ResolveSymbol(const MCSymbolWasm& Symbol) { 479aff1c4dfSSam Clegg if (Symbol.isVariable()) { 480aff1c4dfSSam Clegg const MCExpr *Expr = Symbol.getVariableValue(); 481aff1c4dfSSam Clegg auto *Inner = cast<MCSymbolRefExpr>(Expr); 482aff1c4dfSSam Clegg return cast<MCSymbolWasm>(&Inner->getSymbol()); 483aff1c4dfSSam Clegg } 484aff1c4dfSSam Clegg return &Symbol; 485aff1c4dfSSam Clegg } 486aff1c4dfSSam Clegg 487d934cb88SDan Gohman // Compute a value to write into the code at the location covered 488d934cb88SDan Gohman // by RelEntry. This value isn't used by the static linker, since 489d934cb88SDan Gohman // we have addends; it just serves to make the code more readable 490d934cb88SDan Gohman // and to make standalone wasm modules directly usable. 4917c395943SSam Clegg uint32_t 4927c395943SSam Clegg WasmObjectWriter::getProvisionalValue(const WasmRelocationEntry &RelEntry) { 493aff1c4dfSSam Clegg const MCSymbolWasm *Sym = ResolveSymbol(*RelEntry.Symbol); 494d934cb88SDan Gohman 495*270ed1b3SSam Clegg // For undefined symbols, use zero 496b7787fd0SSam Clegg if (!Sym->isDefined(/*SetUsed=*/false)) 497*270ed1b3SSam Clegg return 0; 498d934cb88SDan Gohman 4997c395943SSam Clegg uint32_t GlobalIndex = SymbolIndices[Sym]; 5007c395943SSam Clegg const WasmGlobal& Global = Globals[GlobalIndex - NumGlobalImports]; 5017c395943SSam Clegg uint64_t Address = Global.InitialValue + RelEntry.Addend; 502d934cb88SDan Gohman 503d934cb88SDan Gohman // Ignore overflow. LLVM allows address arithmetic to silently wrap. 504d934cb88SDan Gohman uint32_t Value = Address; 505d934cb88SDan Gohman 506d934cb88SDan Gohman return Value; 507d934cb88SDan Gohman } 508d934cb88SDan Gohman 509759631c7SSam Clegg static void addData(SmallVectorImpl<char> &DataBytes, 51063ebb813SSam Clegg MCSectionWasm &DataSection) { 511759631c7SSam Clegg DEBUG(errs() << "addData: " << DataSection.getSectionName() << "\n"); 512759631c7SSam Clegg 51363ebb813SSam Clegg DataBytes.resize(alignTo(DataBytes.size(), DataSection.getAlignment())); 51463ebb813SSam Clegg 515c55d13f4SSam Clegg size_t LastFragmentSize = 0; 516759631c7SSam Clegg for (const MCFragment &Frag : DataSection) { 517759631c7SSam Clegg if (Frag.hasInstructions()) 518759631c7SSam Clegg report_fatal_error("only data supported in data sections"); 519759631c7SSam Clegg 520759631c7SSam Clegg if (auto *Align = dyn_cast<MCAlignFragment>(&Frag)) { 521759631c7SSam Clegg if (Align->getValueSize() != 1) 522759631c7SSam Clegg report_fatal_error("only byte values supported for alignment"); 523759631c7SSam Clegg // If nops are requested, use zeros, as this is the data section. 524759631c7SSam Clegg uint8_t Value = Align->hasEmitNops() ? 0 : Align->getValue(); 525759631c7SSam Clegg uint64_t Size = std::min<uint64_t>(alignTo(DataBytes.size(), 526759631c7SSam Clegg Align->getAlignment()), 527759631c7SSam Clegg DataBytes.size() + 528759631c7SSam Clegg Align->getMaxBytesToEmit()); 529759631c7SSam Clegg DataBytes.resize(Size, Value); 530759631c7SSam Clegg } else if (auto *Fill = dyn_cast<MCFillFragment>(&Frag)) { 531759631c7SSam Clegg DataBytes.insert(DataBytes.end(), Fill->getSize(), Fill->getValue()); 532759631c7SSam Clegg } else { 533759631c7SSam Clegg const auto &DataFrag = cast<MCDataFragment>(Frag); 534759631c7SSam Clegg const SmallVectorImpl<char> &Contents = DataFrag.getContents(); 535759631c7SSam Clegg 536759631c7SSam Clegg DataBytes.insert(DataBytes.end(), Contents.begin(), Contents.end()); 537c55d13f4SSam Clegg LastFragmentSize = Contents.size(); 538759631c7SSam Clegg } 539759631c7SSam Clegg } 540759631c7SSam Clegg 541c55d13f4SSam Clegg // Don't allow empty segments, or segments that end with zero-sized 542c55d13f4SSam Clegg // fragment, otherwise the linker cannot map symbols to a unique 543c55d13f4SSam Clegg // data segment. This can be triggered by zero-sized structs 544c55d13f4SSam Clegg // See: test/MC/WebAssembly/bss.ll 545c55d13f4SSam Clegg if (LastFragmentSize == 0) 546c55d13f4SSam Clegg DataBytes.resize(DataBytes.size() + 1); 547759631c7SSam Clegg DEBUG(dbgs() << "addData -> " << DataBytes.size() << "\n"); 548759631c7SSam Clegg } 549759631c7SSam Clegg 550acd7d2b0SSam Clegg uint32_t WasmObjectWriter::getRelocationIndexValue( 551acd7d2b0SSam Clegg const WasmRelocationEntry &RelEntry) { 552acd7d2b0SSam Clegg switch (RelEntry.Type) { 553acd7d2b0SSam Clegg case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB: 554acd7d2b0SSam Clegg case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32: 555b7787fd0SSam Clegg if (!IndirectSymbolIndices.count(RelEntry.Symbol)) 5566006e091SSam Clegg report_fatal_error("symbol not found in table index space: " + 557b7787fd0SSam Clegg RelEntry.Symbol->getName()); 558d99f6078SSam Clegg return IndirectSymbolIndices[RelEntry.Symbol]; 559d99f6078SSam Clegg case wasm::R_WEBASSEMBLY_FUNCTION_INDEX_LEB: 5609d24fb7fSSam Clegg case wasm::R_WEBASSEMBLY_GLOBAL_INDEX_LEB: 56113a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB: 56213a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB: 56313a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32: 564b7787fd0SSam Clegg if (!SymbolIndices.count(RelEntry.Symbol)) 5656006e091SSam Clegg report_fatal_error("symbol not found in function/global index space: " + 566b7787fd0SSam Clegg RelEntry.Symbol->getName()); 567acd7d2b0SSam Clegg return SymbolIndices[RelEntry.Symbol]; 568acd7d2b0SSam Clegg case wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB: 569b7787fd0SSam Clegg if (!TypeIndices.count(RelEntry.Symbol)) 570b7787fd0SSam Clegg report_fatal_error("symbol not found in type index space: " + 571b7787fd0SSam Clegg RelEntry.Symbol->getName()); 572acd7d2b0SSam Clegg return TypeIndices[RelEntry.Symbol]; 573acd7d2b0SSam Clegg default: 574acd7d2b0SSam Clegg llvm_unreachable("invalid relocation type"); 575acd7d2b0SSam Clegg } 576acd7d2b0SSam Clegg } 577acd7d2b0SSam Clegg 578d934cb88SDan Gohman // Apply the portions of the relocation records that we can handle ourselves 579d934cb88SDan Gohman // directly. 580acd7d2b0SSam Clegg void WasmObjectWriter::applyRelocations( 581acd7d2b0SSam Clegg ArrayRef<WasmRelocationEntry> Relocations, uint64_t ContentsOffset) { 582acd7d2b0SSam Clegg raw_pwrite_stream &Stream = getStream(); 583d934cb88SDan Gohman for (const WasmRelocationEntry &RelEntry : Relocations) { 584d934cb88SDan Gohman uint64_t Offset = ContentsOffset + 585d934cb88SDan Gohman RelEntry.FixupSection->getSectionOffset() + 586d934cb88SDan Gohman RelEntry.Offset; 587d934cb88SDan Gohman 588b7787fd0SSam Clegg DEBUG(dbgs() << "applyRelocation: " << RelEntry << "\n"); 589acd7d2b0SSam Clegg switch (RelEntry.Type) { 590acd7d2b0SSam Clegg case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB: 591acd7d2b0SSam Clegg case wasm::R_WEBASSEMBLY_FUNCTION_INDEX_LEB: 5929d24fb7fSSam Clegg case wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB: 5939d24fb7fSSam Clegg case wasm::R_WEBASSEMBLY_GLOBAL_INDEX_LEB: { 594acd7d2b0SSam Clegg uint32_t Index = getRelocationIndexValue(RelEntry); 595acd7d2b0SSam Clegg WritePatchableSLEB(Stream, Index, Offset); 596d934cb88SDan Gohman break; 597d934cb88SDan Gohman } 598acd7d2b0SSam Clegg case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32: { 599acd7d2b0SSam Clegg uint32_t Index = getRelocationIndexValue(RelEntry); 600acd7d2b0SSam Clegg WriteI32(Stream, Index, Offset); 601d934cb88SDan Gohman break; 602d934cb88SDan Gohman } 60313a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB: { 6047c395943SSam Clegg uint32_t Value = getProvisionalValue(RelEntry); 605d934cb88SDan Gohman WritePatchableSLEB(Stream, Value, Offset); 606d934cb88SDan Gohman break; 607d934cb88SDan Gohman } 60813a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB: { 6097c395943SSam Clegg uint32_t Value = getProvisionalValue(RelEntry); 610d934cb88SDan Gohman WritePatchableLEB(Stream, Value, Offset); 611d934cb88SDan Gohman break; 612d934cb88SDan Gohman } 61313a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32: { 6147c395943SSam Clegg uint32_t Value = getProvisionalValue(RelEntry); 615d934cb88SDan Gohman WriteI32(Stream, Value, Offset); 616d934cb88SDan Gohman break; 617d934cb88SDan Gohman } 618d934cb88SDan Gohman default: 6199d24fb7fSSam Clegg llvm_unreachable("invalid relocation type"); 620d934cb88SDan Gohman } 621d934cb88SDan Gohman } 62218eafb6cSDan Gohman } 62318eafb6cSDan Gohman 624acd7d2b0SSam Clegg // Write out the portions of the relocation records that the linker will 625970d02c4SDan Gohman // need to handle. 626acd7d2b0SSam Clegg void WasmObjectWriter::writeRelocations( 6277c395943SSam Clegg ArrayRef<WasmRelocationEntry> Relocations) { 628acd7d2b0SSam Clegg raw_pwrite_stream &Stream = getStream(); 629acd7d2b0SSam Clegg for (const WasmRelocationEntry& RelEntry : Relocations) { 630970d02c4SDan Gohman 631acd7d2b0SSam Clegg uint64_t Offset = RelEntry.Offset + 6327c395943SSam Clegg RelEntry.FixupSection->getSectionOffset(); 633acd7d2b0SSam Clegg uint32_t Index = getRelocationIndexValue(RelEntry); 634970d02c4SDan Gohman 635acd7d2b0SSam Clegg encodeULEB128(RelEntry.Type, Stream); 636970d02c4SDan Gohman encodeULEB128(Offset, Stream); 637acd7d2b0SSam Clegg encodeULEB128(Index, Stream); 638acd7d2b0SSam Clegg if (RelEntry.hasAddend()) 639acd7d2b0SSam Clegg encodeSLEB128(RelEntry.Addend, Stream); 640970d02c4SDan Gohman } 641970d02c4SDan Gohman } 642970d02c4SDan Gohman 6439e15f359SSam Clegg void WasmObjectWriter::writeTypeSection( 644457fb0b4SSam Clegg ArrayRef<WasmFunctionType> FunctionTypes) { 6459e15f359SSam Clegg if (FunctionTypes.empty()) 6469e15f359SSam Clegg return; 6479e15f359SSam Clegg 6489e15f359SSam Clegg SectionBookkeeping Section; 6499e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_TYPE); 6509e15f359SSam Clegg 6519e15f359SSam Clegg encodeULEB128(FunctionTypes.size(), getStream()); 6529e15f359SSam Clegg 6539e15f359SSam Clegg for (const WasmFunctionType &FuncTy : FunctionTypes) { 6549e15f359SSam Clegg encodeSLEB128(wasm::WASM_TYPE_FUNC, getStream()); 6559e15f359SSam Clegg encodeULEB128(FuncTy.Params.size(), getStream()); 6569e15f359SSam Clegg for (wasm::ValType Ty : FuncTy.Params) 6579e15f359SSam Clegg writeValueType(Ty); 6589e15f359SSam Clegg encodeULEB128(FuncTy.Returns.size(), getStream()); 6599e15f359SSam Clegg for (wasm::ValType Ty : FuncTy.Returns) 6609e15f359SSam Clegg writeValueType(Ty); 6619e15f359SSam Clegg } 6629e15f359SSam Clegg 6639e15f359SSam Clegg endSection(Section); 6649e15f359SSam Clegg } 6659e15f359SSam Clegg 666f950b24aSSam Clegg void WasmObjectWriter::writeImportSection(ArrayRef<WasmImport> Imports, 667f950b24aSSam Clegg uint32_t DataSize, 668f950b24aSSam Clegg uint32_t NumElements) { 6699e15f359SSam Clegg if (Imports.empty()) 6709e15f359SSam Clegg return; 6719e15f359SSam Clegg 672f950b24aSSam Clegg uint32_t NumPages = (DataSize + wasm::WasmPageSize - 1) / wasm::WasmPageSize; 673f950b24aSSam Clegg 6749e15f359SSam Clegg SectionBookkeeping Section; 6759e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_IMPORT); 6769e15f359SSam Clegg 6779e15f359SSam Clegg encodeULEB128(Imports.size(), getStream()); 6789e15f359SSam Clegg for (const WasmImport &Import : Imports) { 679b7787fd0SSam Clegg writeString(Import.ModuleName); 680b7787fd0SSam Clegg writeString(Import.FieldName); 6819e15f359SSam Clegg 6829e15f359SSam Clegg encodeULEB128(Import.Kind, getStream()); 6839e15f359SSam Clegg 6849e15f359SSam Clegg switch (Import.Kind) { 6859e15f359SSam Clegg case wasm::WASM_EXTERNAL_FUNCTION: 6869e15f359SSam Clegg encodeULEB128(Import.Type, getStream()); 6879e15f359SSam Clegg break; 6889e15f359SSam Clegg case wasm::WASM_EXTERNAL_GLOBAL: 6899e15f359SSam Clegg encodeSLEB128(int32_t(Import.Type), getStream()); 69032ce5ca0SDan Gohman encodeULEB128(int32_t(Import.IsMutable), getStream()); 6919e15f359SSam Clegg break; 692f950b24aSSam Clegg case wasm::WASM_EXTERNAL_MEMORY: 693f950b24aSSam Clegg encodeULEB128(0, getStream()); // flags 694f950b24aSSam Clegg encodeULEB128(NumPages, getStream()); // initial 695f950b24aSSam Clegg break; 696f950b24aSSam Clegg case wasm::WASM_EXTERNAL_TABLE: 697f950b24aSSam Clegg encodeSLEB128(int32_t(Import.Type), getStream()); 698f950b24aSSam Clegg encodeULEB128(0, getStream()); // flags 699f950b24aSSam Clegg encodeULEB128(NumElements, getStream()); // initial 700f950b24aSSam Clegg break; 7019e15f359SSam Clegg default: 7029e15f359SSam Clegg llvm_unreachable("unsupported import kind"); 7039e15f359SSam Clegg } 7049e15f359SSam Clegg } 7059e15f359SSam Clegg 7069e15f359SSam Clegg endSection(Section); 7079e15f359SSam Clegg } 7089e15f359SSam Clegg 709457fb0b4SSam Clegg void WasmObjectWriter::writeFunctionSection(ArrayRef<WasmFunction> Functions) { 7109e15f359SSam Clegg if (Functions.empty()) 7119e15f359SSam Clegg return; 7129e15f359SSam Clegg 7139e15f359SSam Clegg SectionBookkeeping Section; 7149e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_FUNCTION); 7159e15f359SSam Clegg 7169e15f359SSam Clegg encodeULEB128(Functions.size(), getStream()); 7179e15f359SSam Clegg for (const WasmFunction &Func : Functions) 7189e15f359SSam Clegg encodeULEB128(Func.Type, getStream()); 7199e15f359SSam Clegg 7209e15f359SSam Clegg endSection(Section); 7219e15f359SSam Clegg } 7229e15f359SSam Clegg 7237c395943SSam Clegg void WasmObjectWriter::writeGlobalSection() { 7249e15f359SSam Clegg if (Globals.empty()) 7259e15f359SSam Clegg return; 7269e15f359SSam Clegg 7279e15f359SSam Clegg SectionBookkeeping Section; 7289e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_GLOBAL); 7299e15f359SSam Clegg 7309e15f359SSam Clegg encodeULEB128(Globals.size(), getStream()); 7319e15f359SSam Clegg for (const WasmGlobal &Global : Globals) { 7329e15f359SSam Clegg writeValueType(Global.Type); 7339e15f359SSam Clegg write8(Global.IsMutable); 7349e15f359SSam Clegg 7359e15f359SSam Clegg if (Global.HasImport) { 7369e15f359SSam Clegg assert(Global.InitialValue == 0); 7379e15f359SSam Clegg write8(wasm::WASM_OPCODE_GET_GLOBAL); 7389e15f359SSam Clegg encodeULEB128(Global.ImportIndex, getStream()); 7399e15f359SSam Clegg } else { 7409e15f359SSam Clegg assert(Global.ImportIndex == 0); 7419e15f359SSam Clegg write8(wasm::WASM_OPCODE_I32_CONST); 7429e15f359SSam Clegg encodeSLEB128(Global.InitialValue, getStream()); // offset 7439e15f359SSam Clegg } 7449e15f359SSam Clegg write8(wasm::WASM_OPCODE_END); 7459e15f359SSam Clegg } 7469e15f359SSam Clegg 7479e15f359SSam Clegg endSection(Section); 7489e15f359SSam Clegg } 7499e15f359SSam Clegg 750457fb0b4SSam Clegg void WasmObjectWriter::writeExportSection(ArrayRef<WasmExport> Exports) { 7519e15f359SSam Clegg if (Exports.empty()) 7529e15f359SSam Clegg return; 7539e15f359SSam Clegg 7549e15f359SSam Clegg SectionBookkeeping Section; 7559e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_EXPORT); 7569e15f359SSam Clegg 7579e15f359SSam Clegg encodeULEB128(Exports.size(), getStream()); 7589e15f359SSam Clegg for (const WasmExport &Export : Exports) { 759b7787fd0SSam Clegg writeString(Export.FieldName); 7609e15f359SSam Clegg encodeSLEB128(Export.Kind, getStream()); 7619e15f359SSam Clegg encodeULEB128(Export.Index, getStream()); 7629e15f359SSam Clegg } 7639e15f359SSam Clegg 7649e15f359SSam Clegg endSection(Section); 7659e15f359SSam Clegg } 7669e15f359SSam Clegg 767457fb0b4SSam Clegg void WasmObjectWriter::writeElemSection(ArrayRef<uint32_t> TableElems) { 7689e15f359SSam Clegg if (TableElems.empty()) 7699e15f359SSam Clegg return; 7709e15f359SSam Clegg 7719e15f359SSam Clegg SectionBookkeeping Section; 7729e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_ELEM); 7739e15f359SSam Clegg 7749e15f359SSam Clegg encodeULEB128(1, getStream()); // number of "segments" 7759e15f359SSam Clegg encodeULEB128(0, getStream()); // the table index 7769e15f359SSam Clegg 7779e15f359SSam Clegg // init expr for starting offset 7789e15f359SSam Clegg write8(wasm::WASM_OPCODE_I32_CONST); 7799e15f359SSam Clegg encodeSLEB128(0, getStream()); 7809e15f359SSam Clegg write8(wasm::WASM_OPCODE_END); 7819e15f359SSam Clegg 7829e15f359SSam Clegg encodeULEB128(TableElems.size(), getStream()); 7839e15f359SSam Clegg for (uint32_t Elem : TableElems) 7849e15f359SSam Clegg encodeULEB128(Elem, getStream()); 7859e15f359SSam Clegg 7869e15f359SSam Clegg endSection(Section); 7879e15f359SSam Clegg } 7889e15f359SSam Clegg 789457fb0b4SSam Clegg void WasmObjectWriter::writeCodeSection(const MCAssembler &Asm, 790457fb0b4SSam Clegg const MCAsmLayout &Layout, 791457fb0b4SSam Clegg ArrayRef<WasmFunction> Functions) { 7929e15f359SSam Clegg if (Functions.empty()) 7939e15f359SSam Clegg return; 7949e15f359SSam Clegg 7959e15f359SSam Clegg SectionBookkeeping Section; 7969e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_CODE); 7979e15f359SSam Clegg 7989e15f359SSam Clegg encodeULEB128(Functions.size(), getStream()); 7999e15f359SSam Clegg 8009e15f359SSam Clegg for (const WasmFunction &Func : Functions) { 801fe6414b0SSam Clegg auto &FuncSection = static_cast<MCSectionWasm &>(Func.Sym->getSection()); 8029e15f359SSam Clegg 8039e15f359SSam Clegg int64_t Size = 0; 8049e15f359SSam Clegg if (!Func.Sym->getSize()->evaluateAsAbsolute(Size, Layout)) 8059e15f359SSam Clegg report_fatal_error(".size expression must be evaluatable"); 8069e15f359SSam Clegg 8079e15f359SSam Clegg encodeULEB128(Size, getStream()); 808fe6414b0SSam Clegg FuncSection.setSectionOffset(getStream().tell() - Section.ContentsOffset); 8099e15f359SSam Clegg Asm.writeSectionData(&FuncSection, Layout); 8109e15f359SSam Clegg } 8119e15f359SSam Clegg 8129e15f359SSam Clegg // Apply fixups. 813acd7d2b0SSam Clegg applyRelocations(CodeRelocations, Section.ContentsOffset); 8149e15f359SSam Clegg 8159e15f359SSam Clegg endSection(Section); 8169e15f359SSam Clegg } 8179e15f359SSam Clegg 818457fb0b4SSam Clegg void WasmObjectWriter::writeDataSection(ArrayRef<WasmDataSegment> Segments) { 8197c395943SSam Clegg if (Segments.empty()) 8207c395943SSam Clegg return; 8219e15f359SSam Clegg 8229e15f359SSam Clegg SectionBookkeeping Section; 8239e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_DATA); 8249e15f359SSam Clegg 8257c395943SSam Clegg encodeULEB128(Segments.size(), getStream()); // count 8267c395943SSam Clegg 8277c395943SSam Clegg for (const WasmDataSegment & Segment : Segments) { 8289e15f359SSam Clegg encodeULEB128(0, getStream()); // memory index 8299e15f359SSam Clegg write8(wasm::WASM_OPCODE_I32_CONST); 8307c395943SSam Clegg encodeSLEB128(Segment.Offset, getStream()); // offset 8319e15f359SSam Clegg write8(wasm::WASM_OPCODE_END); 8327c395943SSam Clegg encodeULEB128(Segment.Data.size(), getStream()); // size 8337c395943SSam Clegg Segment.Section->setSectionOffset(getStream().tell() - Section.ContentsOffset); 8347c395943SSam Clegg writeBytes(Segment.Data); // data 8357c395943SSam Clegg } 8369e15f359SSam Clegg 8379e15f359SSam Clegg // Apply fixups. 8387c395943SSam Clegg applyRelocations(DataRelocations, Section.ContentsOffset); 8399e15f359SSam Clegg 8409e15f359SSam Clegg endSection(Section); 8419e15f359SSam Clegg } 8429e15f359SSam Clegg 8439e15f359SSam Clegg void WasmObjectWriter::writeNameSection( 844457fb0b4SSam Clegg ArrayRef<WasmFunction> Functions, 845457fb0b4SSam Clegg ArrayRef<WasmImport> Imports, 8469e15f359SSam Clegg unsigned NumFuncImports) { 8479e15f359SSam Clegg uint32_t TotalFunctions = NumFuncImports + Functions.size(); 8489e15f359SSam Clegg if (TotalFunctions == 0) 8499e15f359SSam Clegg return; 8509e15f359SSam Clegg 8519e15f359SSam Clegg SectionBookkeeping Section; 8529e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_CUSTOM, "name"); 8539e15f359SSam Clegg SectionBookkeeping SubSection; 8549e15f359SSam Clegg startSection(SubSection, wasm::WASM_NAMES_FUNCTION); 8559e15f359SSam Clegg 8569e15f359SSam Clegg encodeULEB128(TotalFunctions, getStream()); 8579e15f359SSam Clegg uint32_t Index = 0; 8589e15f359SSam Clegg for (const WasmImport &Import : Imports) { 8599e15f359SSam Clegg if (Import.Kind == wasm::WASM_EXTERNAL_FUNCTION) { 8609e15f359SSam Clegg encodeULEB128(Index, getStream()); 861b7787fd0SSam Clegg writeString(Import.FieldName); 8629e15f359SSam Clegg ++Index; 8639e15f359SSam Clegg } 8649e15f359SSam Clegg } 8659e15f359SSam Clegg for (const WasmFunction &Func : Functions) { 8669e15f359SSam Clegg encodeULEB128(Index, getStream()); 867b7787fd0SSam Clegg writeString(Func.Sym->getName()); 8689e15f359SSam Clegg ++Index; 8699e15f359SSam Clegg } 8709e15f359SSam Clegg 8719e15f359SSam Clegg endSection(SubSection); 8729e15f359SSam Clegg endSection(Section); 8739e15f359SSam Clegg } 8749e15f359SSam Clegg 875acd7d2b0SSam Clegg void WasmObjectWriter::writeCodeRelocSection() { 8769e15f359SSam Clegg // See: https://github.com/WebAssembly/tool-conventions/blob/master/Linking.md 8779e15f359SSam Clegg // for descriptions of the reloc sections. 8789e15f359SSam Clegg 8799e15f359SSam Clegg if (CodeRelocations.empty()) 8809e15f359SSam Clegg return; 8819e15f359SSam Clegg 8829e15f359SSam Clegg SectionBookkeeping Section; 8839e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_CUSTOM, "reloc.CODE"); 8849e15f359SSam Clegg 8859e15f359SSam Clegg encodeULEB128(wasm::WASM_SEC_CODE, getStream()); 886acd7d2b0SSam Clegg encodeULEB128(CodeRelocations.size(), getStream()); 8879e15f359SSam Clegg 8887c395943SSam Clegg writeRelocations(CodeRelocations); 8899e15f359SSam Clegg 8909e15f359SSam Clegg endSection(Section); 8919e15f359SSam Clegg } 8929e15f359SSam Clegg 8937c395943SSam Clegg void WasmObjectWriter::writeDataRelocSection() { 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 (DataRelocations.empty()) 8989e15f359SSam Clegg return; 8999e15f359SSam Clegg 9009e15f359SSam Clegg SectionBookkeeping Section; 9019e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_CUSTOM, "reloc.DATA"); 9029e15f359SSam Clegg 9039e15f359SSam Clegg encodeULEB128(wasm::WASM_SEC_DATA, getStream()); 9049e15f359SSam Clegg encodeULEB128(DataRelocations.size(), getStream()); 9059e15f359SSam Clegg 9067c395943SSam Clegg writeRelocations(DataRelocations); 9079e15f359SSam Clegg 9089e15f359SSam Clegg endSection(Section); 9099e15f359SSam Clegg } 9109e15f359SSam Clegg 9119e15f359SSam Clegg void WasmObjectWriter::writeLinkingMetaDataSection( 912d95ed959SSam Clegg ArrayRef<WasmDataSegment> Segments, uint32_t DataSize, 913bafe6902SSam Clegg const SmallVector<std::pair<StringRef, uint32_t>, 4> &SymbolFlags, 914bafe6902SSam Clegg const SmallVector<std::pair<uint16_t, uint32_t>, 2> &InitFuncs) { 9159e15f359SSam Clegg SectionBookkeeping Section; 9169e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_CUSTOM, "linking"); 917b7787fd0SSam Clegg SectionBookkeeping SubSection; 9189e15f359SSam Clegg 91931a2c809SSam Clegg if (SymbolFlags.size() != 0) { 920b7787fd0SSam Clegg startSection(SubSection, wasm::WASM_SYMBOL_INFO); 92131a2c809SSam Clegg encodeULEB128(SymbolFlags.size(), getStream()); 92231a2c809SSam Clegg for (auto Pair: SymbolFlags) { 92331a2c809SSam Clegg writeString(Pair.first); 92431a2c809SSam Clegg encodeULEB128(Pair.second, getStream()); 925b7787fd0SSam Clegg } 926b7787fd0SSam Clegg endSection(SubSection); 927b7787fd0SSam Clegg } 9289e15f359SSam Clegg 9299e1ade93SSam Clegg if (DataSize > 0) { 9309e1ade93SSam Clegg startSection(SubSection, wasm::WASM_DATA_SIZE); 9319e1ade93SSam Clegg encodeULEB128(DataSize, getStream()); 9329e1ade93SSam Clegg endSection(SubSection); 9339e1ade93SSam Clegg } 9349e1ade93SSam Clegg 935d95ed959SSam Clegg if (Segments.size()) { 93663ebb813SSam Clegg startSection(SubSection, wasm::WASM_SEGMENT_INFO); 937d95ed959SSam Clegg encodeULEB128(Segments.size(), getStream()); 93863ebb813SSam Clegg for (const WasmDataSegment &Segment : Segments) { 939d95ed959SSam Clegg writeString(Segment.Name); 94063ebb813SSam Clegg encodeULEB128(Segment.Alignment, getStream()); 94163ebb813SSam Clegg encodeULEB128(Segment.Flags, getStream()); 94263ebb813SSam Clegg } 943d95ed959SSam Clegg endSection(SubSection); 944d95ed959SSam Clegg } 945d95ed959SSam Clegg 946bafe6902SSam Clegg if (!InitFuncs.empty()) { 947bafe6902SSam Clegg startSection(SubSection, wasm::WASM_INIT_FUNCS); 948bafe6902SSam Clegg encodeULEB128(InitFuncs.size(), getStream()); 949bafe6902SSam Clegg for (auto &StartFunc : InitFuncs) { 950bafe6902SSam Clegg encodeULEB128(StartFunc.first, getStream()); // priority 951bafe6902SSam Clegg encodeULEB128(StartFunc.second, getStream()); // function index 952bafe6902SSam Clegg } 953bafe6902SSam Clegg endSection(SubSection); 954bafe6902SSam Clegg } 955bafe6902SSam Clegg 9569e15f359SSam Clegg endSection(Section); 9579e15f359SSam Clegg } 9589e15f359SSam Clegg 9595e3d33a7SSam Clegg uint32_t WasmObjectWriter::getFunctionType(const MCSymbolWasm& Symbol) { 9605e3d33a7SSam Clegg assert(Symbol.isFunction()); 9615e3d33a7SSam Clegg assert(TypeIndices.count(&Symbol)); 9625e3d33a7SSam Clegg return TypeIndices[&Symbol]; 9635e3d33a7SSam Clegg } 9645e3d33a7SSam Clegg 9655e3d33a7SSam Clegg uint32_t WasmObjectWriter::registerFunctionType(const MCSymbolWasm& Symbol) { 9665e3d33a7SSam Clegg assert(Symbol.isFunction()); 9675e3d33a7SSam Clegg 9685e3d33a7SSam Clegg WasmFunctionType F; 969aff1c4dfSSam Clegg const MCSymbolWasm* ResolvedSym = ResolveSymbol(Symbol); 9705e3d33a7SSam Clegg F.Returns = ResolvedSym->getReturns(); 9715e3d33a7SSam Clegg F.Params = ResolvedSym->getParams(); 9725e3d33a7SSam Clegg 9735e3d33a7SSam Clegg auto Pair = 9745e3d33a7SSam Clegg FunctionTypeIndices.insert(std::make_pair(F, FunctionTypes.size())); 9755e3d33a7SSam Clegg if (Pair.second) 9765e3d33a7SSam Clegg FunctionTypes.push_back(F); 9775e3d33a7SSam Clegg TypeIndices[&Symbol] = Pair.first->second; 9785e3d33a7SSam Clegg 9795e3d33a7SSam Clegg DEBUG(dbgs() << "registerFunctionType: " << Symbol << " new:" << Pair.second << "\n"); 9805e3d33a7SSam Clegg DEBUG(dbgs() << " -> type index: " << Pair.first->second << "\n"); 9815e3d33a7SSam Clegg return Pair.first->second; 9825e3d33a7SSam Clegg } 9835e3d33a7SSam Clegg 98418eafb6cSDan Gohman void WasmObjectWriter::writeObject(MCAssembler &Asm, 98518eafb6cSDan Gohman const MCAsmLayout &Layout) { 986b7787fd0SSam Clegg DEBUG(dbgs() << "WasmObjectWriter::writeObject\n"); 98782607f56SDan Gohman MCContext &Ctx = Asm.getContext(); 988b879539aSDerek Schuff wasm::ValType PtrType = is64Bit() ? wasm::ValType::I64 : wasm::ValType::I32; 989d934cb88SDan Gohman 990d934cb88SDan Gohman // Collect information from the available symbols. 991d934cb88SDan Gohman SmallVector<WasmFunction, 4> Functions; 992d934cb88SDan Gohman SmallVector<uint32_t, 4> TableElems; 993d934cb88SDan Gohman SmallVector<WasmImport, 4> Imports; 994d934cb88SDan Gohman SmallVector<WasmExport, 4> Exports; 99531a2c809SSam Clegg SmallVector<std::pair<StringRef, uint32_t>, 4> SymbolFlags; 996bafe6902SSam Clegg SmallVector<std::pair<uint16_t, uint32_t>, 2> InitFuncs; 997d934cb88SDan Gohman unsigned NumFuncImports = 0; 9987c395943SSam Clegg SmallVector<WasmDataSegment, 4> DataSegments; 9997c395943SSam Clegg uint32_t DataSize = 0; 1000d934cb88SDan Gohman 100182607f56SDan Gohman // In the special .global_variables section, we've encoded global 100282607f56SDan Gohman // variables used by the function. Translate them into the Globals 100382607f56SDan Gohman // list. 100412fd3da9SSam Clegg MCSectionWasm *GlobalVars = 100512fd3da9SSam Clegg Ctx.getWasmSection(".global_variables", SectionKind::getMetadata()); 100682607f56SDan Gohman if (!GlobalVars->getFragmentList().empty()) { 100782607f56SDan Gohman if (GlobalVars->getFragmentList().size() != 1) 100882607f56SDan Gohman report_fatal_error("only one .global_variables fragment supported"); 100982607f56SDan Gohman const MCFragment &Frag = *GlobalVars->begin(); 101082607f56SDan Gohman if (Frag.hasInstructions() || Frag.getKind() != MCFragment::FT_Data) 101182607f56SDan Gohman report_fatal_error("only data supported in .global_variables"); 1012fe6414b0SSam Clegg const auto &DataFrag = cast<MCDataFragment>(Frag); 101382607f56SDan Gohman if (!DataFrag.getFixups().empty()) 101482607f56SDan Gohman report_fatal_error("fixups not supported in .global_variables"); 101582607f56SDan Gohman const SmallVectorImpl<char> &Contents = DataFrag.getContents(); 1016970d02c4SDan Gohman for (const uint8_t *p = (const uint8_t *)Contents.data(), 1017970d02c4SDan Gohman *end = (const uint8_t *)Contents.data() + Contents.size(); 1018970d02c4SDan Gohman p != end; ) { 101982607f56SDan Gohman WasmGlobal G; 1020970d02c4SDan Gohman if (end - p < 3) 1021970d02c4SDan Gohman report_fatal_error("truncated global variable encoding"); 1022970d02c4SDan Gohman G.Type = wasm::ValType(int8_t(*p++)); 1023970d02c4SDan Gohman G.IsMutable = bool(*p++); 1024970d02c4SDan Gohman G.HasImport = bool(*p++); 1025970d02c4SDan Gohman if (G.HasImport) { 102682607f56SDan Gohman G.InitialValue = 0; 1027970d02c4SDan Gohman 1028970d02c4SDan Gohman WasmImport Import; 1029970d02c4SDan Gohman Import.ModuleName = (const char *)p; 1030970d02c4SDan Gohman const uint8_t *nul = (const uint8_t *)memchr(p, '\0', end - p); 1031970d02c4SDan Gohman if (!nul) 1032970d02c4SDan Gohman report_fatal_error("global module name must be nul-terminated"); 1033970d02c4SDan Gohman p = nul + 1; 1034970d02c4SDan Gohman nul = (const uint8_t *)memchr(p, '\0', end - p); 1035970d02c4SDan Gohman if (!nul) 1036970d02c4SDan Gohman report_fatal_error("global base name must be nul-terminated"); 1037970d02c4SDan Gohman Import.FieldName = (const char *)p; 1038970d02c4SDan Gohman p = nul + 1; 1039970d02c4SDan Gohman 1040970d02c4SDan Gohman Import.Kind = wasm::WASM_EXTERNAL_GLOBAL; 1041970d02c4SDan Gohman Import.Type = int32_t(G.Type); 1042970d02c4SDan Gohman 1043970d02c4SDan Gohman G.ImportIndex = NumGlobalImports; 1044970d02c4SDan Gohman ++NumGlobalImports; 1045970d02c4SDan Gohman 1046970d02c4SDan Gohman Imports.push_back(Import); 1047970d02c4SDan Gohman } else { 1048970d02c4SDan Gohman unsigned n; 1049970d02c4SDan Gohman G.InitialValue = decodeSLEB128(p, &n); 1050970d02c4SDan Gohman G.ImportIndex = 0; 1051c8da0c0bSSimon Pilgrim if ((ptrdiff_t)n > end - p) 1052970d02c4SDan Gohman report_fatal_error("global initial value must be valid SLEB128"); 1053970d02c4SDan Gohman p += n; 1054970d02c4SDan Gohman } 105582607f56SDan Gohman Globals.push_back(G); 105682607f56SDan Gohman } 105782607f56SDan Gohman } 105882607f56SDan Gohman 1059f950b24aSSam Clegg // For now, always emit the memory import, since loads and stores are not 1060f950b24aSSam Clegg // valid without it. In the future, we could perhaps be more clever and omit 1061f950b24aSSam Clegg // it if there are no loads or stores. 1062f950b24aSSam Clegg MCSymbolWasm *MemorySym = 1063f950b24aSSam Clegg cast<MCSymbolWasm>(Ctx.getOrCreateSymbol("__linear_memory")); 1064f950b24aSSam Clegg WasmImport MemImport; 1065f950b24aSSam Clegg MemImport.ModuleName = MemorySym->getModuleName(); 1066f950b24aSSam Clegg MemImport.FieldName = MemorySym->getName(); 1067f950b24aSSam Clegg MemImport.Kind = wasm::WASM_EXTERNAL_MEMORY; 1068f950b24aSSam Clegg Imports.push_back(MemImport); 1069f950b24aSSam Clegg 1070f950b24aSSam Clegg // For now, always emit the table section, since indirect calls are not 1071f950b24aSSam Clegg // valid without it. In the future, we could perhaps be more clever and omit 1072f950b24aSSam Clegg // it if there are no indirect calls. 1073f950b24aSSam Clegg MCSymbolWasm *TableSym = 1074f950b24aSSam Clegg cast<MCSymbolWasm>(Ctx.getOrCreateSymbol("__indirect_function_table")); 1075f950b24aSSam Clegg WasmImport TableImport; 1076f950b24aSSam Clegg TableImport.ModuleName = TableSym->getModuleName(); 1077f950b24aSSam Clegg TableImport.FieldName = TableSym->getName(); 1078f950b24aSSam Clegg TableImport.Kind = wasm::WASM_EXTERNAL_TABLE; 1079f950b24aSSam Clegg TableImport.Type = wasm::WASM_TYPE_ANYFUNC; 1080f950b24aSSam Clegg Imports.push_back(TableImport); 1081f950b24aSSam Clegg 108232ce5ca0SDan Gohman // Populate FunctionTypeIndices and Imports. 108332ce5ca0SDan Gohman for (const MCSymbol &S : Asm.symbols()) { 108432ce5ca0SDan Gohman const auto &WS = static_cast<const MCSymbolWasm &>(S); 108532ce5ca0SDan Gohman 108632ce5ca0SDan Gohman // Register types for all functions, including those with private linkage 108732ce5ca0SDan Gohman // (making them 108832ce5ca0SDan Gohman // because wasm always needs a type signature. 108932ce5ca0SDan Gohman if (WS.isFunction()) 109032ce5ca0SDan Gohman registerFunctionType(WS); 109132ce5ca0SDan Gohman 109232ce5ca0SDan Gohman if (WS.isTemporary()) 109332ce5ca0SDan Gohman continue; 109432ce5ca0SDan Gohman 109532ce5ca0SDan Gohman // If the symbol is not defined in this translation unit, import it. 1096b6a42984SSam Clegg if (!WS.isDefined(/*SetUsed=*/false) || WS.isVariable()) { 109732ce5ca0SDan Gohman WasmImport Import; 109832ce5ca0SDan Gohman Import.ModuleName = WS.getModuleName(); 109932ce5ca0SDan Gohman Import.FieldName = WS.getName(); 110032ce5ca0SDan Gohman 110132ce5ca0SDan Gohman if (WS.isFunction()) { 110232ce5ca0SDan Gohman Import.Kind = wasm::WASM_EXTERNAL_FUNCTION; 110332ce5ca0SDan Gohman Import.Type = getFunctionType(WS); 110432ce5ca0SDan Gohman SymbolIndices[&WS] = NumFuncImports; 110532ce5ca0SDan Gohman ++NumFuncImports; 110632ce5ca0SDan Gohman } else { 110732ce5ca0SDan Gohman Import.Kind = wasm::WASM_EXTERNAL_GLOBAL; 110832ce5ca0SDan Gohman Import.Type = int32_t(PtrType); 110932ce5ca0SDan Gohman Import.IsMutable = false; 111032ce5ca0SDan Gohman SymbolIndices[&WS] = NumGlobalImports; 111132ce5ca0SDan Gohman 111283b16226SDan Gohman // If this global is the stack pointer, make it mutable. 1113ad19047dSDan Gohman if (WS.getName() == "__stack_pointer") 111432ce5ca0SDan Gohman Import.IsMutable = true; 111532ce5ca0SDan Gohman 111632ce5ca0SDan Gohman ++NumGlobalImports; 111732ce5ca0SDan Gohman } 111832ce5ca0SDan Gohman 111932ce5ca0SDan Gohman Imports.push_back(Import); 112032ce5ca0SDan Gohman } 112132ce5ca0SDan Gohman } 112232ce5ca0SDan Gohman 1123759631c7SSam Clegg for (MCSection &Sec : Asm) { 1124759631c7SSam Clegg auto &Section = static_cast<MCSectionWasm &>(Sec); 112512fd3da9SSam Clegg if (!Section.isWasmData()) 1126759631c7SSam Clegg continue; 1127759631c7SSam Clegg 1128bafe6902SSam Clegg // .init_array sections are handled specially elsewhere. 1129bafe6902SSam Clegg if (cast<MCSectionWasm>(Sec).getSectionName().startswith(".init_array")) 1130bafe6902SSam Clegg continue; 1131bafe6902SSam Clegg 1132759631c7SSam Clegg DataSize = alignTo(DataSize, Section.getAlignment()); 1133759631c7SSam Clegg DataSegments.emplace_back(); 1134759631c7SSam Clegg WasmDataSegment &Segment = DataSegments.back(); 1135d95ed959SSam Clegg Segment.Name = Section.getSectionName(); 1136759631c7SSam Clegg Segment.Offset = DataSize; 1137759631c7SSam Clegg Segment.Section = &Section; 113863ebb813SSam Clegg addData(Segment.Data, Section); 113963ebb813SSam Clegg Segment.Alignment = Section.getAlignment(); 114063ebb813SSam Clegg Segment.Flags = 0; 1141759631c7SSam Clegg DataSize += Segment.Data.size(); 1142759631c7SSam Clegg Section.setMemoryOffset(Segment.Offset); 1143759631c7SSam Clegg } 1144759631c7SSam Clegg 1145b7787fd0SSam Clegg // Handle regular defined and undefined symbols. 1146d934cb88SDan Gohman for (const MCSymbol &S : Asm.symbols()) { 1147d934cb88SDan Gohman // Ignore unnamed temporary symbols, which aren't ever exported, imported, 1148d934cb88SDan Gohman // or used in relocations. 1149d934cb88SDan Gohman if (S.isTemporary() && S.getName().empty()) 1150d934cb88SDan Gohman continue; 1151b7787fd0SSam Clegg 1152d934cb88SDan Gohman const auto &WS = static_cast<const MCSymbolWasm &>(S); 1153b7787fd0SSam Clegg DEBUG(dbgs() << "MCSymbol: '" << S << "'" 1154b7787fd0SSam Clegg << " isDefined=" << S.isDefined() << " isExternal=" 1155b7787fd0SSam Clegg << S.isExternal() << " isTemporary=" << S.isTemporary() 1156b7787fd0SSam Clegg << " isFunction=" << WS.isFunction() 1157b7787fd0SSam Clegg << " isWeak=" << WS.isWeak() 1158a2b35dacSSam Clegg << " isHidden=" << WS.isHidden() 1159b7787fd0SSam Clegg << " isVariable=" << WS.isVariable() << "\n"); 1160b7787fd0SSam Clegg 1161a2b35dacSSam Clegg if (WS.isWeak() || WS.isHidden()) { 1162a2b35dacSSam Clegg uint32_t Flags = (WS.isWeak() ? wasm::WASM_SYMBOL_BINDING_WEAK : 0) | 1163a2b35dacSSam Clegg (WS.isHidden() ? wasm::WASM_SYMBOL_VISIBILITY_HIDDEN : 0); 1164a2b35dacSSam Clegg SymbolFlags.emplace_back(WS.getName(), Flags); 1165a2b35dacSSam Clegg } 1166b7787fd0SSam Clegg 11675e3d33a7SSam Clegg if (WS.isVariable()) 11685e3d33a7SSam Clegg continue; 11695e3d33a7SSam Clegg 1170d934cb88SDan Gohman unsigned Index; 1171b7787fd0SSam Clegg 1172d934cb88SDan Gohman if (WS.isFunction()) { 1173d934cb88SDan Gohman if (WS.isDefined(/*SetUsed=*/false)) { 1174b7787fd0SSam Clegg if (WS.getOffset() != 0) 1175b7787fd0SSam Clegg report_fatal_error( 1176b7787fd0SSam Clegg "function sections must contain one function each"); 1177b7787fd0SSam Clegg 1178b7787fd0SSam Clegg if (WS.getSize() == 0) 1179b7787fd0SSam Clegg report_fatal_error( 1180b7787fd0SSam Clegg "function symbols must have a size set with .size"); 1181b7787fd0SSam Clegg 1182d934cb88SDan Gohman // A definition. Take the next available index. 1183d934cb88SDan Gohman Index = NumFuncImports + Functions.size(); 1184d934cb88SDan Gohman 1185d934cb88SDan Gohman // Prepare the function. 1186d934cb88SDan Gohman WasmFunction Func; 11875e3d33a7SSam Clegg Func.Type = getFunctionType(WS); 1188d934cb88SDan Gohman Func.Sym = &WS; 1189d934cb88SDan Gohman SymbolIndices[&WS] = Index; 1190d934cb88SDan Gohman Functions.push_back(Func); 1191d934cb88SDan Gohman } else { 1192d934cb88SDan Gohman // An import; the index was assigned above. 1193d934cb88SDan Gohman Index = SymbolIndices.find(&WS)->second; 1194d934cb88SDan Gohman } 1195d934cb88SDan Gohman 11965e3d33a7SSam Clegg DEBUG(dbgs() << " -> function index: " << Index << "\n"); 1197d934cb88SDan Gohman } else { 1198c38e947eSSam Clegg if (WS.isTemporary() && !WS.getSize()) 1199c38e947eSSam Clegg continue; 1200c38e947eSSam Clegg 1201fe6414b0SSam Clegg if (!WS.isDefined(/*SetUsed=*/false)) 1202fe6414b0SSam Clegg continue; 1203fe6414b0SSam Clegg 1204d934cb88SDan Gohman if (!WS.getSize()) 1205c38e947eSSam Clegg report_fatal_error("data symbols must have a size set with .size: " + 1206c38e947eSSam Clegg WS.getName()); 1207d934cb88SDan Gohman 1208d934cb88SDan Gohman int64_t Size = 0; 1209d934cb88SDan Gohman if (!WS.getSize()->evaluateAsAbsolute(Size, Layout)) 1210d934cb88SDan Gohman report_fatal_error(".size expression must be evaluatable"); 1211d934cb88SDan Gohman 12127c395943SSam Clegg // For each global, prepare a corresponding wasm global holding its 12137c395943SSam Clegg // address. For externals these will also be named exports. 12147c395943SSam Clegg Index = NumGlobalImports + Globals.size(); 1215759631c7SSam Clegg auto &DataSection = static_cast<MCSectionWasm &>(WS.getSection()); 12167c395943SSam Clegg 12177c395943SSam Clegg WasmGlobal Global; 12187c395943SSam Clegg Global.Type = PtrType; 12197c395943SSam Clegg Global.IsMutable = false; 12207c395943SSam Clegg Global.HasImport = false; 1221759631c7SSam Clegg Global.InitialValue = DataSection.getMemoryOffset() + Layout.getSymbolOffset(WS); 12227c395943SSam Clegg Global.ImportIndex = 0; 12237c395943SSam Clegg SymbolIndices[&WS] = Index; 12247c395943SSam Clegg DEBUG(dbgs() << " -> global index: " << Index << "\n"); 12257c395943SSam Clegg Globals.push_back(Global); 1226d934cb88SDan Gohman } 1227d934cb88SDan Gohman 1228d934cb88SDan Gohman // If the symbol is visible outside this translation unit, export it. 122931a2c809SSam Clegg if (WS.isDefined(/*SetUsed=*/false)) { 1230d934cb88SDan Gohman WasmExport Export; 1231d934cb88SDan Gohman Export.FieldName = WS.getName(); 1232d934cb88SDan Gohman Export.Index = Index; 1233d934cb88SDan Gohman if (WS.isFunction()) 1234d934cb88SDan Gohman Export.Kind = wasm::WASM_EXTERNAL_FUNCTION; 1235d934cb88SDan Gohman else 1236d934cb88SDan Gohman Export.Kind = wasm::WASM_EXTERNAL_GLOBAL; 12375e3d33a7SSam Clegg DEBUG(dbgs() << " -> export " << Exports.size() << "\n"); 1238d934cb88SDan Gohman Exports.push_back(Export); 123931a2c809SSam Clegg if (!WS.isExternal()) 124031a2c809SSam Clegg SymbolFlags.emplace_back(WS.getName(), wasm::WASM_SYMBOL_BINDING_LOCAL); 1241d934cb88SDan Gohman } 1242d934cb88SDan Gohman } 1243d934cb88SDan Gohman 12445e3d33a7SSam Clegg // Handle weak aliases. We need to process these in a separate pass because 12455e3d33a7SSam Clegg // we need to have processed the target of the alias before the alias itself 12465e3d33a7SSam Clegg // and the symbols are not necessarily ordered in this way. 1247b7787fd0SSam Clegg for (const MCSymbol &S : Asm.symbols()) { 1248b7787fd0SSam Clegg if (!S.isVariable()) 1249b7787fd0SSam Clegg continue; 125031a2c809SSam Clegg 1251b7787fd0SSam Clegg assert(S.isDefined(/*SetUsed=*/false)); 1252b7787fd0SSam Clegg 12535e3d33a7SSam Clegg // Find the target symbol of this weak alias and export that index 1254aff1c4dfSSam Clegg const auto &WS = static_cast<const MCSymbolWasm &>(S); 1255aff1c4dfSSam Clegg const MCSymbolWasm *ResolvedSym = ResolveSymbol(WS); 12565e3d33a7SSam Clegg DEBUG(dbgs() << WS.getName() << ": weak alias of '" << *ResolvedSym << "'\n"); 12575e3d33a7SSam Clegg assert(SymbolIndices.count(ResolvedSym) > 0); 1258b7787fd0SSam Clegg uint32_t Index = SymbolIndices.find(ResolvedSym)->second; 12595e3d33a7SSam Clegg DEBUG(dbgs() << " -> index:" << Index << "\n"); 1260b7787fd0SSam Clegg 1261b7787fd0SSam Clegg WasmExport Export; 1262b7787fd0SSam Clegg Export.FieldName = WS.getName(); 1263b7787fd0SSam Clegg Export.Index = Index; 1264b7787fd0SSam Clegg if (WS.isFunction()) 1265b7787fd0SSam Clegg Export.Kind = wasm::WASM_EXTERNAL_FUNCTION; 1266b7787fd0SSam Clegg else 1267b7787fd0SSam Clegg Export.Kind = wasm::WASM_EXTERNAL_GLOBAL; 12685e3d33a7SSam Clegg DEBUG(dbgs() << " -> export " << Exports.size() << "\n"); 1269b7787fd0SSam Clegg Exports.push_back(Export); 127031a2c809SSam Clegg 127131a2c809SSam Clegg if (!WS.isExternal()) 127231a2c809SSam Clegg SymbolFlags.emplace_back(WS.getName(), wasm::WASM_SYMBOL_BINDING_LOCAL); 1273b7787fd0SSam Clegg } 1274b7787fd0SSam Clegg 12756006e091SSam Clegg { 12766006e091SSam Clegg auto HandleReloc = [&](const WasmRelocationEntry &Rel) { 12776006e091SSam Clegg // Functions referenced by a relocation need to prepared to be called 12786006e091SSam Clegg // indirectly. 12796006e091SSam Clegg const MCSymbolWasm& WS = *Rel.Symbol; 12806006e091SSam Clegg if (WS.isFunction() && IndirectSymbolIndices.count(&WS) == 0) { 12816006e091SSam Clegg switch (Rel.Type) { 12826006e091SSam Clegg case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32: 12836006e091SSam Clegg case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB: 12846006e091SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32: 12856006e091SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB: { 12866006e091SSam Clegg uint32_t Index = SymbolIndices.find(&WS)->second; 12876006e091SSam Clegg IndirectSymbolIndices[&WS] = TableElems.size(); 12886006e091SSam Clegg DEBUG(dbgs() << " -> adding to table: " << TableElems.size() << "\n"); 12896006e091SSam Clegg TableElems.push_back(Index); 12906006e091SSam Clegg registerFunctionType(WS); 12916006e091SSam Clegg break; 12926006e091SSam Clegg } 12936006e091SSam Clegg default: 12946006e091SSam Clegg break; 12956006e091SSam Clegg } 12966006e091SSam Clegg } 12976006e091SSam Clegg }; 1298970d02c4SDan Gohman 12996006e091SSam Clegg for (const WasmRelocationEntry &RelEntry : CodeRelocations) 13006006e091SSam Clegg HandleReloc(RelEntry); 13016006e091SSam Clegg for (const WasmRelocationEntry &RelEntry : DataRelocations) 13026006e091SSam Clegg HandleReloc(RelEntry); 1303d934cb88SDan Gohman } 1304d934cb88SDan Gohman 1305bafe6902SSam Clegg // Translate .init_array section contents into start functions. 1306bafe6902SSam Clegg for (const MCSection &S : Asm) { 1307bafe6902SSam Clegg const auto &WS = static_cast<const MCSectionWasm &>(S); 1308bafe6902SSam Clegg if (WS.getSectionName().startswith(".fini_array")) 1309bafe6902SSam Clegg report_fatal_error(".fini_array sections are unsupported"); 1310bafe6902SSam Clegg if (!WS.getSectionName().startswith(".init_array")) 1311bafe6902SSam Clegg continue; 1312bafe6902SSam Clegg if (WS.getFragmentList().empty()) 1313bafe6902SSam Clegg continue; 1314bafe6902SSam Clegg if (WS.getFragmentList().size() != 2) 1315bafe6902SSam Clegg report_fatal_error("only one .init_array section fragment supported"); 1316bafe6902SSam Clegg const MCFragment &AlignFrag = *WS.begin(); 1317bafe6902SSam Clegg if (AlignFrag.getKind() != MCFragment::FT_Align) 1318bafe6902SSam Clegg report_fatal_error(".init_array section should be aligned"); 1319bafe6902SSam Clegg if (cast<MCAlignFragment>(AlignFrag).getAlignment() != (is64Bit() ? 8 : 4)) 1320bafe6902SSam Clegg report_fatal_error(".init_array section should be aligned for pointers"); 1321bafe6902SSam Clegg const MCFragment &Frag = *std::next(WS.begin()); 1322bafe6902SSam Clegg if (Frag.hasInstructions() || Frag.getKind() != MCFragment::FT_Data) 1323bafe6902SSam Clegg report_fatal_error("only data supported in .init_array section"); 1324bafe6902SSam Clegg uint16_t Priority = UINT16_MAX; 1325bafe6902SSam Clegg if (WS.getSectionName().size() != 11) { 1326bafe6902SSam Clegg if (WS.getSectionName()[11] != '.') 1327bafe6902SSam Clegg report_fatal_error(".init_array section priority should start with '.'"); 1328bafe6902SSam Clegg if (WS.getSectionName().substr(12).getAsInteger(10, Priority)) 1329bafe6902SSam Clegg report_fatal_error("invalid .init_array section priority"); 1330bafe6902SSam Clegg } 1331bafe6902SSam Clegg const auto &DataFrag = cast<MCDataFragment>(Frag); 1332bafe6902SSam Clegg const SmallVectorImpl<char> &Contents = DataFrag.getContents(); 1333bafe6902SSam Clegg for (const uint8_t *p = (const uint8_t *)Contents.data(), 1334bafe6902SSam Clegg *end = (const uint8_t *)Contents.data() + Contents.size(); 1335bafe6902SSam Clegg p != end; ++p) { 1336bafe6902SSam Clegg if (*p != 0) 1337bafe6902SSam Clegg report_fatal_error("non-symbolic data in .init_array section"); 1338bafe6902SSam Clegg } 1339bafe6902SSam Clegg for (const MCFixup &Fixup : DataFrag.getFixups()) { 1340bafe6902SSam Clegg assert(Fixup.getKind() == MCFixup::getKindForSize(is64Bit() ? 8 : 4, false)); 1341bafe6902SSam Clegg const MCExpr *Expr = Fixup.getValue(); 1342bafe6902SSam Clegg auto *Sym = dyn_cast<MCSymbolRefExpr>(Expr); 1343bafe6902SSam Clegg if (!Sym) 1344bafe6902SSam Clegg report_fatal_error("fixups in .init_array should be symbol references"); 1345bafe6902SSam Clegg if (Sym->getKind() != MCSymbolRefExpr::VK_WebAssembly_FUNCTION) 1346bafe6902SSam Clegg report_fatal_error("symbols in .init_array should be for functions"); 1347bafe6902SSam Clegg auto I = SymbolIndices.find(cast<MCSymbolWasm>(&Sym->getSymbol())); 1348bafe6902SSam Clegg if (I == SymbolIndices.end()) 1349bafe6902SSam Clegg report_fatal_error("symbols in .init_array should be defined"); 1350bafe6902SSam Clegg uint32_t Index = I->second; 1351bafe6902SSam Clegg InitFuncs.push_back(std::make_pair(Priority, Index)); 1352bafe6902SSam Clegg } 1353bafe6902SSam Clegg } 1354bafe6902SSam Clegg 135518eafb6cSDan Gohman // Write out the Wasm header. 135618eafb6cSDan Gohman writeHeader(Asm); 135718eafb6cSDan Gohman 13589e15f359SSam Clegg writeTypeSection(FunctionTypes); 1359f950b24aSSam Clegg writeImportSection(Imports, DataSize, TableElems.size()); 13609e15f359SSam Clegg writeFunctionSection(Functions); 1361f950b24aSSam Clegg // Skip the "table" section; we import the table instead. 1362f950b24aSSam Clegg // Skip the "memory" section; we import the memory instead. 13637c395943SSam Clegg writeGlobalSection(); 13649e15f359SSam Clegg writeExportSection(Exports); 13659e15f359SSam Clegg writeElemSection(TableElems); 1366acd7d2b0SSam Clegg writeCodeSection(Asm, Layout, Functions); 13677c395943SSam Clegg writeDataSection(DataSegments); 13689e15f359SSam Clegg writeNameSection(Functions, Imports, NumFuncImports); 1369acd7d2b0SSam Clegg writeCodeRelocSection(); 13707c395943SSam Clegg writeDataRelocSection(); 1371bafe6902SSam Clegg writeLinkingMetaDataSection(DataSegments, DataSize, SymbolFlags, 1372bafe6902SSam Clegg InitFuncs); 1373970d02c4SDan Gohman 1374d934cb88SDan Gohman // TODO: Translate the .comment section to the output. 1375d934cb88SDan Gohman // TODO: Translate debug sections to the output. 137618eafb6cSDan Gohman } 137718eafb6cSDan Gohman 137860fbc7ccSLang Hames std::unique_ptr<MCObjectWriter> 13791301a878SLang Hames llvm::createWasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW, 138018eafb6cSDan Gohman raw_pwrite_stream &OS) { 138160fbc7ccSLang Hames // FIXME: Can't use make_unique<WasmObjectWriter>(...) as WasmObjectWriter's 138260fbc7ccSLang Hames // destructor is private. Is that necessary? 138360fbc7ccSLang Hames return std::unique_ptr<MCObjectWriter>( 138460fbc7ccSLang Hames new WasmObjectWriter(std::move(MOTW), OS)); 138518eafb6cSDan Gohman } 1386