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; 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; 1169e15f359SSam Clegg }; 1179e15f359SSam Clegg 1189e15f359SSam Clegg // A wasm function to be written into the function section. 1199e15f359SSam Clegg struct WasmFunction { 1209e15f359SSam Clegg int32_t Type; 1219e15f359SSam Clegg const MCSymbolWasm *Sym; 1229e15f359SSam Clegg }; 1239e15f359SSam Clegg 1249e15f359SSam Clegg // A wasm export to be written into the export section. 1259e15f359SSam Clegg struct WasmExport { 1269e15f359SSam Clegg StringRef FieldName; 1279e15f359SSam Clegg unsigned Kind; 1289e15f359SSam Clegg uint32_t Index; 1299e15f359SSam Clegg }; 1309e15f359SSam Clegg 1319e15f359SSam Clegg // A wasm global to be written into the global section. 1329e15f359SSam Clegg struct WasmGlobal { 1339e15f359SSam Clegg wasm::ValType Type; 1349e15f359SSam Clegg bool IsMutable; 1359e15f359SSam Clegg bool HasImport; 1369e15f359SSam Clegg uint64_t InitialValue; 1379e15f359SSam Clegg uint32_t ImportIndex; 1389e15f359SSam Clegg }; 1399e15f359SSam Clegg 1406dc65e91SSam Clegg // Information about a single relocation. 1416dc65e91SSam Clegg struct WasmRelocationEntry { 1426dc65e91SSam Clegg uint64_t Offset; // Where is the relocation. 1436dc65e91SSam Clegg const MCSymbolWasm *Symbol; // The symbol to relocate with. 1446dc65e91SSam Clegg int64_t Addend; // A value to add to the symbol. 1456dc65e91SSam Clegg unsigned Type; // The type of the relocation. 146fe6414b0SSam Clegg const MCSectionWasm *FixupSection;// The section the relocation is targeting. 1476dc65e91SSam Clegg 1486dc65e91SSam Clegg WasmRelocationEntry(uint64_t Offset, const MCSymbolWasm *Symbol, 1496dc65e91SSam Clegg int64_t Addend, unsigned Type, 150fe6414b0SSam Clegg const MCSectionWasm *FixupSection) 1516dc65e91SSam Clegg : Offset(Offset), Symbol(Symbol), Addend(Addend), Type(Type), 1526dc65e91SSam Clegg FixupSection(FixupSection) {} 1536dc65e91SSam Clegg 154acd7d2b0SSam Clegg bool hasAddend() const { 155acd7d2b0SSam Clegg switch (Type) { 15613a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB: 15713a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB: 15813a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32: 159acd7d2b0SSam Clegg return true; 160acd7d2b0SSam Clegg default: 161acd7d2b0SSam Clegg return false; 162acd7d2b0SSam Clegg } 163acd7d2b0SSam Clegg } 164acd7d2b0SSam Clegg 1656dc65e91SSam Clegg void print(raw_ostream &Out) const { 1669bf73c07SSam Clegg Out << "Off=" << Offset << ", Sym=" << *Symbol << ", Addend=" << Addend 167759631c7SSam Clegg << ", Type=" << Type 168759631c7SSam Clegg << ", FixupSection=" << FixupSection->getSectionName(); 1696dc65e91SSam Clegg } 170b7787fd0SSam Clegg 171b7787fd0SSam Clegg #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP) 172b7787fd0SSam Clegg LLVM_DUMP_METHOD void dump() const { print(dbgs()); } 173b7787fd0SSam Clegg #endif 1746dc65e91SSam Clegg }; 1756dc65e91SSam Clegg 1761fb8daa6SSam Clegg #if !defined(NDEBUG) 1777f055deeSSam Clegg raw_ostream &operator<<(raw_ostream &OS, const WasmRelocationEntry &Rel) { 178b7787fd0SSam Clegg Rel.print(OS); 179b7787fd0SSam Clegg return OS; 180b7787fd0SSam Clegg } 1811fb8daa6SSam Clegg #endif 182b7787fd0SSam Clegg 18318eafb6cSDan Gohman class WasmObjectWriter : public MCObjectWriter { 18418eafb6cSDan Gohman /// Helper struct for containing some precomputed information on symbols. 18518eafb6cSDan Gohman struct WasmSymbolData { 18618eafb6cSDan Gohman const MCSymbolWasm *Symbol; 18718eafb6cSDan Gohman StringRef Name; 18818eafb6cSDan Gohman 18918eafb6cSDan Gohman // Support lexicographic sorting. 19018eafb6cSDan Gohman bool operator<(const WasmSymbolData &RHS) const { return Name < RHS.Name; } 19118eafb6cSDan Gohman }; 19218eafb6cSDan Gohman 19318eafb6cSDan Gohman /// The target specific Wasm writer instance. 19418eafb6cSDan Gohman std::unique_ptr<MCWasmObjectTargetWriter> TargetObjectWriter; 19518eafb6cSDan Gohman 196d934cb88SDan Gohman // Relocations for fixing up references in the code section. 197d934cb88SDan Gohman std::vector<WasmRelocationEntry> CodeRelocations; 198d934cb88SDan Gohman 199d934cb88SDan Gohman // Relocations for fixing up references in the data section. 200d934cb88SDan Gohman std::vector<WasmRelocationEntry> DataRelocations; 201d934cb88SDan Gohman 202d934cb88SDan Gohman // Index values to use for fixing up call_indirect type indices. 203acd7d2b0SSam Clegg // Maps function symbols to the index of the type of the function 204acd7d2b0SSam Clegg DenseMap<const MCSymbolWasm *, uint32_t> TypeIndices; 205d99f6078SSam Clegg // Maps function symbols to the table element index space. Used 206d99f6078SSam Clegg // for TABLE_INDEX relocation types (i.e. address taken functions). 207d99f6078SSam Clegg DenseMap<const MCSymbolWasm *, uint32_t> IndirectSymbolIndices; 208d99f6078SSam Clegg // Maps function/global symbols to the function/global index space. 209acd7d2b0SSam Clegg DenseMap<const MCSymbolWasm *, uint32_t> SymbolIndices; 210acd7d2b0SSam Clegg 211acd7d2b0SSam Clegg DenseMap<WasmFunctionType, int32_t, WasmFunctionTypeDenseMapInfo> 212acd7d2b0SSam Clegg FunctionTypeIndices; 2135e3d33a7SSam Clegg SmallVector<WasmFunctionType, 4> FunctionTypes; 2147c395943SSam Clegg SmallVector<WasmGlobal, 4> Globals; 2157c395943SSam Clegg unsigned NumGlobalImports = 0; 216d934cb88SDan Gohman 21718eafb6cSDan Gohman // TargetObjectWriter wrappers. 21818eafb6cSDan Gohman bool is64Bit() const { return TargetObjectWriter->is64Bit(); } 219ae03c1e7SSam Clegg unsigned getRelocType(const MCValue &Target, const MCFixup &Fixup) const { 220ae03c1e7SSam Clegg return TargetObjectWriter->getRelocType(Target, Fixup); 22118eafb6cSDan Gohman } 22218eafb6cSDan Gohman 223d934cb88SDan Gohman void startSection(SectionBookkeeping &Section, unsigned SectionId, 224d934cb88SDan Gohman const char *Name = nullptr); 225d934cb88SDan Gohman void endSection(SectionBookkeeping &Section); 226d934cb88SDan Gohman 22718eafb6cSDan Gohman public: 22818eafb6cSDan Gohman WasmObjectWriter(MCWasmObjectTargetWriter *MOTW, raw_pwrite_stream &OS) 22918eafb6cSDan Gohman : MCObjectWriter(OS, /*IsLittleEndian=*/true), TargetObjectWriter(MOTW) {} 23018eafb6cSDan Gohman 231d934cb88SDan Gohman private: 23218eafb6cSDan Gohman ~WasmObjectWriter() override; 23318eafb6cSDan Gohman 234acd7d2b0SSam Clegg void reset() override { 235acd7d2b0SSam Clegg CodeRelocations.clear(); 236acd7d2b0SSam Clegg DataRelocations.clear(); 237acd7d2b0SSam Clegg TypeIndices.clear(); 238acd7d2b0SSam Clegg SymbolIndices.clear(); 239d99f6078SSam Clegg IndirectSymbolIndices.clear(); 240acd7d2b0SSam Clegg FunctionTypeIndices.clear(); 2415e3d33a7SSam Clegg FunctionTypes.clear(); 2427c395943SSam Clegg Globals.clear(); 243acd7d2b0SSam Clegg MCObjectWriter::reset(); 2447c395943SSam Clegg NumGlobalImports = 0; 245acd7d2b0SSam Clegg } 246acd7d2b0SSam Clegg 24718eafb6cSDan Gohman void writeHeader(const MCAssembler &Asm); 24818eafb6cSDan Gohman 24918eafb6cSDan Gohman void recordRelocation(MCAssembler &Asm, const MCAsmLayout &Layout, 25018eafb6cSDan Gohman const MCFragment *Fragment, const MCFixup &Fixup, 251ceecfe5bSRafael Espindola MCValue Target, uint64_t &FixedValue) override; 25218eafb6cSDan Gohman 25318eafb6cSDan Gohman void executePostLayoutBinding(MCAssembler &Asm, 25418eafb6cSDan Gohman const MCAsmLayout &Layout) override; 25518eafb6cSDan Gohman 25618eafb6cSDan Gohman void writeObject(MCAssembler &Asm, const MCAsmLayout &Layout) override; 2579e15f359SSam Clegg 258b7787fd0SSam Clegg void writeString(const StringRef Str) { 259b7787fd0SSam Clegg encodeULEB128(Str.size(), getStream()); 260b7787fd0SSam Clegg writeBytes(Str); 261b7787fd0SSam Clegg } 262b7787fd0SSam Clegg 2639e15f359SSam Clegg void writeValueType(wasm::ValType Ty) { 2649e15f359SSam Clegg encodeSLEB128(int32_t(Ty), getStream()); 2659e15f359SSam Clegg } 2669e15f359SSam Clegg 267457fb0b4SSam Clegg void writeTypeSection(ArrayRef<WasmFunctionType> FunctionTypes); 268457fb0b4SSam Clegg void writeImportSection(ArrayRef<WasmImport> Imports); 269457fb0b4SSam Clegg void writeFunctionSection(ArrayRef<WasmFunction> Functions); 270d99f6078SSam Clegg void writeTableSection(uint32_t NumElements); 2717c395943SSam Clegg void writeMemorySection(uint32_t DataSize); 2727c395943SSam Clegg void writeGlobalSection(); 273457fb0b4SSam Clegg void writeExportSection(ArrayRef<WasmExport> Exports); 274457fb0b4SSam Clegg void writeElemSection(ArrayRef<uint32_t> TableElems); 2759e15f359SSam Clegg void writeCodeSection(const MCAssembler &Asm, const MCAsmLayout &Layout, 276457fb0b4SSam Clegg ArrayRef<WasmFunction> Functions); 277457fb0b4SSam Clegg void writeDataSection(ArrayRef<WasmDataSegment> Segments); 278457fb0b4SSam Clegg void writeNameSection(ArrayRef<WasmFunction> Functions, 279457fb0b4SSam Clegg ArrayRef<WasmImport> Imports, 2809e15f359SSam Clegg uint32_t NumFuncImports); 281acd7d2b0SSam Clegg void writeCodeRelocSection(); 2827c395943SSam Clegg void writeDataRelocSection(); 283*31a2c809SSam Clegg void writeLinkingMetaDataSection( 284*31a2c809SSam Clegg ArrayRef<WasmDataSegment> Segments, uint32_t DataSize, 285*31a2c809SSam Clegg uint32_t DataAlignment, 286*31a2c809SSam Clegg SmallVector<std::pair<StringRef, uint32_t>, 4> SymbolFlags, 287*31a2c809SSam Clegg bool HasStackPointer, uint32_t StackPointerGlobal); 288acd7d2b0SSam Clegg 2897c395943SSam Clegg uint32_t getProvisionalValue(const WasmRelocationEntry &RelEntry); 290acd7d2b0SSam Clegg void applyRelocations(ArrayRef<WasmRelocationEntry> Relocations, 291acd7d2b0SSam Clegg uint64_t ContentsOffset); 292acd7d2b0SSam Clegg 2937c395943SSam Clegg void writeRelocations(ArrayRef<WasmRelocationEntry> Relocations); 294acd7d2b0SSam Clegg uint32_t getRelocationIndexValue(const WasmRelocationEntry &RelEntry); 2955e3d33a7SSam Clegg uint32_t getFunctionType(const MCSymbolWasm& Symbol); 2965e3d33a7SSam Clegg uint32_t registerFunctionType(const MCSymbolWasm& Symbol); 29718eafb6cSDan Gohman }; 2989e15f359SSam Clegg 29918eafb6cSDan Gohman } // end anonymous namespace 30018eafb6cSDan Gohman 30118eafb6cSDan Gohman WasmObjectWriter::~WasmObjectWriter() {} 30218eafb6cSDan Gohman 303d934cb88SDan Gohman // Write out a section header and a patchable section size field. 304d934cb88SDan Gohman void WasmObjectWriter::startSection(SectionBookkeeping &Section, 305d934cb88SDan Gohman unsigned SectionId, 306d934cb88SDan Gohman const char *Name) { 307d934cb88SDan Gohman assert((Name != nullptr) == (SectionId == wasm::WASM_SEC_CUSTOM) && 308d934cb88SDan Gohman "Only custom sections can have names"); 309d934cb88SDan Gohman 310b7787fd0SSam Clegg DEBUG(dbgs() << "startSection " << SectionId << ": " << Name << "\n"); 311e2688c43SDerek Schuff encodeULEB128(SectionId, getStream()); 312d934cb88SDan Gohman 313d934cb88SDan Gohman Section.SizeOffset = getStream().tell(); 314d934cb88SDan Gohman 315d934cb88SDan Gohman // The section size. We don't know the size yet, so reserve enough space 316d934cb88SDan Gohman // for any 32-bit value; we'll patch it later. 317d934cb88SDan Gohman encodeULEB128(UINT32_MAX, getStream()); 318d934cb88SDan Gohman 319d934cb88SDan Gohman // The position where the section starts, for measuring its size. 320d934cb88SDan Gohman Section.ContentsOffset = getStream().tell(); 321d934cb88SDan Gohman 322d934cb88SDan Gohman // Custom sections in wasm also have a string identifier. 323d934cb88SDan Gohman if (SectionId == wasm::WASM_SEC_CUSTOM) { 324b7787fd0SSam Clegg assert(Name); 325b7787fd0SSam Clegg writeString(StringRef(Name)); 326d934cb88SDan Gohman } 327d934cb88SDan Gohman } 328d934cb88SDan Gohman 329d934cb88SDan Gohman // Now that the section is complete and we know how big it is, patch up the 330d934cb88SDan Gohman // section size field at the start of the section. 331d934cb88SDan Gohman void WasmObjectWriter::endSection(SectionBookkeeping &Section) { 332d934cb88SDan Gohman uint64_t Size = getStream().tell() - Section.ContentsOffset; 333d934cb88SDan Gohman if (uint32_t(Size) != Size) 334d934cb88SDan Gohman report_fatal_error("section size does not fit in a uint32_t"); 335d934cb88SDan Gohman 336b7787fd0SSam Clegg DEBUG(dbgs() << "endSection size=" << Size << "\n"); 337d934cb88SDan Gohman 338d934cb88SDan Gohman // Write the final section size to the payload_len field, which follows 339d934cb88SDan Gohman // the section id byte. 340d934cb88SDan Gohman uint8_t Buffer[16]; 34166a99e41SSam Clegg unsigned SizeLen = encodeULEB128(Size, Buffer, 5); 342d934cb88SDan Gohman assert(SizeLen == 5); 343d934cb88SDan Gohman getStream().pwrite((char *)Buffer, SizeLen, Section.SizeOffset); 344d934cb88SDan Gohman } 345d934cb88SDan Gohman 34618eafb6cSDan Gohman // Emit the Wasm header. 34718eafb6cSDan Gohman void WasmObjectWriter::writeHeader(const MCAssembler &Asm) { 3487ea5adffSDan Gohman writeBytes(StringRef(wasm::WasmMagic, sizeof(wasm::WasmMagic))); 3497ea5adffSDan Gohman writeLE32(wasm::WasmVersion); 35018eafb6cSDan Gohman } 35118eafb6cSDan Gohman 35218eafb6cSDan Gohman void WasmObjectWriter::executePostLayoutBinding(MCAssembler &Asm, 35318eafb6cSDan Gohman const MCAsmLayout &Layout) { 35418eafb6cSDan Gohman } 35518eafb6cSDan Gohman 35618eafb6cSDan Gohman void WasmObjectWriter::recordRelocation(MCAssembler &Asm, 35718eafb6cSDan Gohman const MCAsmLayout &Layout, 35818eafb6cSDan Gohman const MCFragment *Fragment, 35918eafb6cSDan Gohman const MCFixup &Fixup, MCValue Target, 360ceecfe5bSRafael Espindola uint64_t &FixedValue) { 361ceecfe5bSRafael Espindola MCAsmBackend &Backend = Asm.getBackend(); 362ceecfe5bSRafael Espindola bool IsPCRel = Backend.getFixupKindInfo(Fixup.getKind()).Flags & 363ceecfe5bSRafael Espindola MCFixupKindInfo::FKF_IsPCRel; 364fe6414b0SSam Clegg const auto &FixupSection = cast<MCSectionWasm>(*Fragment->getParent()); 365d934cb88SDan Gohman uint64_t C = Target.getConstant(); 366d934cb88SDan Gohman uint64_t FixupOffset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset(); 367d934cb88SDan Gohman MCContext &Ctx = Asm.getContext(); 368d934cb88SDan Gohman 369d934cb88SDan Gohman if (const MCSymbolRefExpr *RefB = Target.getSymB()) { 370d934cb88SDan Gohman assert(RefB->getKind() == MCSymbolRefExpr::VK_None && 371d934cb88SDan Gohman "Should not have constructed this"); 372d934cb88SDan Gohman 373d934cb88SDan Gohman // Let A, B and C being the components of Target and R be the location of 374d934cb88SDan Gohman // the fixup. If the fixup is not pcrel, we want to compute (A - B + C). 375d934cb88SDan Gohman // If it is pcrel, we want to compute (A - B + C - R). 376d934cb88SDan Gohman 377d934cb88SDan Gohman // In general, Wasm has no relocations for -B. It can only represent (A + C) 378d934cb88SDan Gohman // or (A + C - R). If B = R + K and the relocation is not pcrel, we can 379d934cb88SDan Gohman // replace B to implement it: (A - R - K + C) 380d934cb88SDan Gohman if (IsPCRel) { 381d934cb88SDan Gohman Ctx.reportError( 382d934cb88SDan Gohman Fixup.getLoc(), 383d934cb88SDan Gohman "No relocation available to represent this relative expression"); 384d934cb88SDan Gohman return; 385d934cb88SDan Gohman } 386d934cb88SDan Gohman 387d934cb88SDan Gohman const auto &SymB = cast<MCSymbolWasm>(RefB->getSymbol()); 388d934cb88SDan Gohman 389d934cb88SDan Gohman if (SymB.isUndefined()) { 390d934cb88SDan Gohman Ctx.reportError(Fixup.getLoc(), 391d934cb88SDan Gohman Twine("symbol '") + SymB.getName() + 392d934cb88SDan Gohman "' can not be undefined in a subtraction expression"); 393d934cb88SDan Gohman return; 394d934cb88SDan Gohman } 395d934cb88SDan Gohman 396d934cb88SDan Gohman assert(!SymB.isAbsolute() && "Should have been folded"); 397d934cb88SDan Gohman const MCSection &SecB = SymB.getSection(); 398d934cb88SDan Gohman if (&SecB != &FixupSection) { 399d934cb88SDan Gohman Ctx.reportError(Fixup.getLoc(), 400d934cb88SDan Gohman "Cannot represent a difference across sections"); 401d934cb88SDan Gohman return; 402d934cb88SDan Gohman } 403d934cb88SDan Gohman 404d934cb88SDan Gohman uint64_t SymBOffset = Layout.getSymbolOffset(SymB); 405d934cb88SDan Gohman uint64_t K = SymBOffset - FixupOffset; 406d934cb88SDan Gohman IsPCRel = true; 407d934cb88SDan Gohman C -= K; 408d934cb88SDan Gohman } 409d934cb88SDan Gohman 410d934cb88SDan Gohman // We either rejected the fixup or folded B into C at this point. 411d934cb88SDan Gohman const MCSymbolRefExpr *RefA = Target.getSymA(); 412d934cb88SDan Gohman const auto *SymA = RefA ? cast<MCSymbolWasm>(&RefA->getSymbol()) : nullptr; 413d934cb88SDan Gohman 414d934cb88SDan Gohman if (SymA && SymA->isVariable()) { 415d934cb88SDan Gohman const MCExpr *Expr = SymA->getVariableValue(); 4166ad8f190SSam Clegg const auto *Inner = cast<MCSymbolRefExpr>(Expr); 4176ad8f190SSam Clegg if (Inner->getKind() == MCSymbolRefExpr::VK_WEAKREF) 4186ad8f190SSam Clegg llvm_unreachable("weakref used in reloc not yet implemented"); 419d934cb88SDan Gohman } 420d934cb88SDan Gohman 421d934cb88SDan Gohman // Put any constant offset in an addend. Offsets can be negative, and 422d934cb88SDan Gohman // LLVM expects wrapping, in contrast to wasm's immediates which can't 423d934cb88SDan Gohman // be negative and don't wrap. 424d934cb88SDan Gohman FixedValue = 0; 425d934cb88SDan Gohman 4266ad8f190SSam Clegg if (SymA) 427d934cb88SDan Gohman SymA->setUsedInReloc(); 428d934cb88SDan Gohman 429ae03c1e7SSam Clegg assert(!IsPCRel); 4309d24fb7fSSam Clegg assert(SymA); 4319d24fb7fSSam Clegg 432ae03c1e7SSam Clegg unsigned Type = getRelocType(Target, Fixup); 433ae03c1e7SSam Clegg 434d934cb88SDan Gohman WasmRelocationEntry Rec(FixupOffset, SymA, C, Type, &FixupSection); 435b7787fd0SSam Clegg DEBUG(dbgs() << "WasmReloc: " << Rec << "\n"); 436d934cb88SDan Gohman 437d934cb88SDan Gohman if (FixupSection.hasInstructions()) 438d934cb88SDan Gohman CodeRelocations.push_back(Rec); 439d934cb88SDan Gohman else 440d934cb88SDan Gohman DataRelocations.push_back(Rec); 441d934cb88SDan Gohman } 442d934cb88SDan Gohman 443d934cb88SDan Gohman // Write X as an (unsigned) LEB value at offset Offset in Stream, padded 444d934cb88SDan Gohman // to allow patching. 445d934cb88SDan Gohman static void 446d934cb88SDan Gohman WritePatchableLEB(raw_pwrite_stream &Stream, uint32_t X, uint64_t Offset) { 447d934cb88SDan Gohman uint8_t Buffer[5]; 44866a99e41SSam Clegg unsigned SizeLen = encodeULEB128(X, Buffer, 5); 449d934cb88SDan Gohman assert(SizeLen == 5); 450d934cb88SDan Gohman Stream.pwrite((char *)Buffer, SizeLen, Offset); 451d934cb88SDan Gohman } 452d934cb88SDan Gohman 453d934cb88SDan Gohman // Write X as an signed LEB value at offset Offset in Stream, padded 454d934cb88SDan Gohman // to allow patching. 455d934cb88SDan Gohman static void 456d934cb88SDan Gohman WritePatchableSLEB(raw_pwrite_stream &Stream, int32_t X, uint64_t Offset) { 457d934cb88SDan Gohman uint8_t Buffer[5]; 45866a99e41SSam Clegg unsigned SizeLen = encodeSLEB128(X, Buffer, 5); 459d934cb88SDan Gohman assert(SizeLen == 5); 460d934cb88SDan Gohman Stream.pwrite((char *)Buffer, SizeLen, Offset); 461d934cb88SDan Gohman } 462d934cb88SDan Gohman 463d934cb88SDan Gohman // Write X as a plain integer value at offset Offset in Stream. 464d934cb88SDan Gohman static void WriteI32(raw_pwrite_stream &Stream, uint32_t X, uint64_t Offset) { 465d934cb88SDan Gohman uint8_t Buffer[4]; 466d934cb88SDan Gohman support::endian::write32le(Buffer, X); 467d934cb88SDan Gohman Stream.pwrite((char *)Buffer, sizeof(Buffer), Offset); 468d934cb88SDan Gohman } 469d934cb88SDan Gohman 470aff1c4dfSSam Clegg static const MCSymbolWasm* ResolveSymbol(const MCSymbolWasm& Symbol) { 471aff1c4dfSSam Clegg if (Symbol.isVariable()) { 472aff1c4dfSSam Clegg const MCExpr *Expr = Symbol.getVariableValue(); 473aff1c4dfSSam Clegg auto *Inner = cast<MCSymbolRefExpr>(Expr); 474aff1c4dfSSam Clegg return cast<MCSymbolWasm>(&Inner->getSymbol()); 475aff1c4dfSSam Clegg } 476aff1c4dfSSam Clegg return &Symbol; 477aff1c4dfSSam Clegg } 478aff1c4dfSSam Clegg 479d934cb88SDan Gohman // Compute a value to write into the code at the location covered 480d934cb88SDan Gohman // by RelEntry. This value isn't used by the static linker, since 481d934cb88SDan Gohman // we have addends; it just serves to make the code more readable 482d934cb88SDan Gohman // and to make standalone wasm modules directly usable. 4837c395943SSam Clegg uint32_t 4847c395943SSam Clegg WasmObjectWriter::getProvisionalValue(const WasmRelocationEntry &RelEntry) { 485aff1c4dfSSam Clegg const MCSymbolWasm *Sym = ResolveSymbol(*RelEntry.Symbol); 486d934cb88SDan Gohman 487d934cb88SDan Gohman // For undefined symbols, use a hopefully invalid value. 488b7787fd0SSam Clegg if (!Sym->isDefined(/*SetUsed=*/false)) 489d934cb88SDan Gohman return UINT32_MAX; 490d934cb88SDan Gohman 4917c395943SSam Clegg uint32_t GlobalIndex = SymbolIndices[Sym]; 4927c395943SSam Clegg const WasmGlobal& Global = Globals[GlobalIndex - NumGlobalImports]; 4937c395943SSam Clegg uint64_t Address = Global.InitialValue + RelEntry.Addend; 494d934cb88SDan Gohman 495d934cb88SDan Gohman // Ignore overflow. LLVM allows address arithmetic to silently wrap. 496d934cb88SDan Gohman uint32_t Value = Address; 497d934cb88SDan Gohman 498d934cb88SDan Gohman return Value; 499d934cb88SDan Gohman } 500d934cb88SDan Gohman 501759631c7SSam Clegg static void addData(SmallVectorImpl<char> &DataBytes, 502759631c7SSam Clegg MCSectionWasm &DataSection, uint32_t &DataAlignment) { 503759631c7SSam Clegg DataBytes.resize(alignTo(DataBytes.size(), DataSection.getAlignment())); 504759631c7SSam Clegg DataAlignment = std::max(DataAlignment, DataSection.getAlignment()); 505759631c7SSam Clegg DEBUG(errs() << "addData: " << DataSection.getSectionName() << "\n"); 506759631c7SSam Clegg 507759631c7SSam Clegg for (const MCFragment &Frag : DataSection) { 508759631c7SSam Clegg if (Frag.hasInstructions()) 509759631c7SSam Clegg report_fatal_error("only data supported in data sections"); 510759631c7SSam Clegg 511759631c7SSam Clegg if (auto *Align = dyn_cast<MCAlignFragment>(&Frag)) { 512759631c7SSam Clegg if (Align->getValueSize() != 1) 513759631c7SSam Clegg report_fatal_error("only byte values supported for alignment"); 514759631c7SSam Clegg // If nops are requested, use zeros, as this is the data section. 515759631c7SSam Clegg uint8_t Value = Align->hasEmitNops() ? 0 : Align->getValue(); 516759631c7SSam Clegg uint64_t Size = std::min<uint64_t>(alignTo(DataBytes.size(), 517759631c7SSam Clegg Align->getAlignment()), 518759631c7SSam Clegg DataBytes.size() + 519759631c7SSam Clegg Align->getMaxBytesToEmit()); 520759631c7SSam Clegg DataBytes.resize(Size, Value); 521759631c7SSam Clegg } else if (auto *Fill = dyn_cast<MCFillFragment>(&Frag)) { 522759631c7SSam Clegg DataBytes.insert(DataBytes.end(), Fill->getSize(), Fill->getValue()); 523759631c7SSam Clegg } else { 524759631c7SSam Clegg const auto &DataFrag = cast<MCDataFragment>(Frag); 525759631c7SSam Clegg const SmallVectorImpl<char> &Contents = DataFrag.getContents(); 526759631c7SSam Clegg 527759631c7SSam Clegg DataBytes.insert(DataBytes.end(), Contents.begin(), Contents.end()); 528759631c7SSam Clegg } 529759631c7SSam Clegg } 530759631c7SSam Clegg 531759631c7SSam Clegg DEBUG(dbgs() << "addData -> " << DataBytes.size() << "\n"); 532759631c7SSam Clegg } 533759631c7SSam Clegg 534acd7d2b0SSam Clegg uint32_t WasmObjectWriter::getRelocationIndexValue( 535acd7d2b0SSam Clegg const WasmRelocationEntry &RelEntry) { 536acd7d2b0SSam Clegg switch (RelEntry.Type) { 537acd7d2b0SSam Clegg case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB: 538acd7d2b0SSam Clegg case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32: 539b7787fd0SSam Clegg if (!IndirectSymbolIndices.count(RelEntry.Symbol)) 540b7787fd0SSam Clegg report_fatal_error("symbol not found table index space: " + 541b7787fd0SSam Clegg RelEntry.Symbol->getName()); 542d99f6078SSam Clegg return IndirectSymbolIndices[RelEntry.Symbol]; 543d99f6078SSam Clegg case wasm::R_WEBASSEMBLY_FUNCTION_INDEX_LEB: 5449d24fb7fSSam Clegg case wasm::R_WEBASSEMBLY_GLOBAL_INDEX_LEB: 54513a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB: 54613a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB: 54713a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32: 548b7787fd0SSam Clegg if (!SymbolIndices.count(RelEntry.Symbol)) 549b7787fd0SSam Clegg report_fatal_error("symbol not found function/global index space: " + 550b7787fd0SSam Clegg RelEntry.Symbol->getName()); 551acd7d2b0SSam Clegg return SymbolIndices[RelEntry.Symbol]; 552acd7d2b0SSam Clegg case wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB: 553b7787fd0SSam Clegg if (!TypeIndices.count(RelEntry.Symbol)) 554b7787fd0SSam Clegg report_fatal_error("symbol not found in type index space: " + 555b7787fd0SSam Clegg RelEntry.Symbol->getName()); 556acd7d2b0SSam Clegg return TypeIndices[RelEntry.Symbol]; 557acd7d2b0SSam Clegg default: 558acd7d2b0SSam Clegg llvm_unreachable("invalid relocation type"); 559acd7d2b0SSam Clegg } 560acd7d2b0SSam Clegg } 561acd7d2b0SSam Clegg 562d934cb88SDan Gohman // Apply the portions of the relocation records that we can handle ourselves 563d934cb88SDan Gohman // directly. 564acd7d2b0SSam Clegg void WasmObjectWriter::applyRelocations( 565acd7d2b0SSam Clegg ArrayRef<WasmRelocationEntry> Relocations, uint64_t ContentsOffset) { 566acd7d2b0SSam Clegg raw_pwrite_stream &Stream = getStream(); 567d934cb88SDan Gohman for (const WasmRelocationEntry &RelEntry : Relocations) { 568d934cb88SDan Gohman uint64_t Offset = ContentsOffset + 569d934cb88SDan Gohman RelEntry.FixupSection->getSectionOffset() + 570d934cb88SDan Gohman RelEntry.Offset; 571d934cb88SDan Gohman 572b7787fd0SSam Clegg DEBUG(dbgs() << "applyRelocation: " << RelEntry << "\n"); 573acd7d2b0SSam Clegg switch (RelEntry.Type) { 574acd7d2b0SSam Clegg case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB: 575acd7d2b0SSam Clegg case wasm::R_WEBASSEMBLY_FUNCTION_INDEX_LEB: 5769d24fb7fSSam Clegg case wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB: 5779d24fb7fSSam Clegg case wasm::R_WEBASSEMBLY_GLOBAL_INDEX_LEB: { 578acd7d2b0SSam Clegg uint32_t Index = getRelocationIndexValue(RelEntry); 579acd7d2b0SSam Clegg WritePatchableSLEB(Stream, Index, Offset); 580d934cb88SDan Gohman break; 581d934cb88SDan Gohman } 582acd7d2b0SSam Clegg case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32: { 583acd7d2b0SSam Clegg uint32_t Index = getRelocationIndexValue(RelEntry); 584acd7d2b0SSam Clegg WriteI32(Stream, Index, Offset); 585d934cb88SDan Gohman break; 586d934cb88SDan Gohman } 58713a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB: { 5887c395943SSam Clegg uint32_t Value = getProvisionalValue(RelEntry); 589d934cb88SDan Gohman WritePatchableSLEB(Stream, Value, Offset); 590d934cb88SDan Gohman break; 591d934cb88SDan Gohman } 59213a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB: { 5937c395943SSam Clegg uint32_t Value = getProvisionalValue(RelEntry); 594d934cb88SDan Gohman WritePatchableLEB(Stream, Value, Offset); 595d934cb88SDan Gohman break; 596d934cb88SDan Gohman } 59713a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32: { 5987c395943SSam Clegg uint32_t Value = getProvisionalValue(RelEntry); 599d934cb88SDan Gohman WriteI32(Stream, Value, Offset); 600d934cb88SDan Gohman break; 601d934cb88SDan Gohman } 602d934cb88SDan Gohman default: 6039d24fb7fSSam Clegg llvm_unreachable("invalid relocation type"); 604d934cb88SDan Gohman } 605d934cb88SDan Gohman } 60618eafb6cSDan Gohman } 60718eafb6cSDan Gohman 608acd7d2b0SSam Clegg // Write out the portions of the relocation records that the linker will 609970d02c4SDan Gohman // need to handle. 610acd7d2b0SSam Clegg void WasmObjectWriter::writeRelocations( 6117c395943SSam Clegg ArrayRef<WasmRelocationEntry> Relocations) { 612acd7d2b0SSam Clegg raw_pwrite_stream &Stream = getStream(); 613acd7d2b0SSam Clegg for (const WasmRelocationEntry& RelEntry : Relocations) { 614970d02c4SDan Gohman 615acd7d2b0SSam Clegg uint64_t Offset = RelEntry.Offset + 6167c395943SSam Clegg RelEntry.FixupSection->getSectionOffset(); 617acd7d2b0SSam Clegg uint32_t Index = getRelocationIndexValue(RelEntry); 618970d02c4SDan Gohman 619acd7d2b0SSam Clegg encodeULEB128(RelEntry.Type, Stream); 620970d02c4SDan Gohman encodeULEB128(Offset, Stream); 621acd7d2b0SSam Clegg encodeULEB128(Index, Stream); 622acd7d2b0SSam Clegg if (RelEntry.hasAddend()) 623acd7d2b0SSam Clegg encodeSLEB128(RelEntry.Addend, Stream); 624970d02c4SDan Gohman } 625970d02c4SDan Gohman } 626970d02c4SDan Gohman 6279e15f359SSam Clegg void WasmObjectWriter::writeTypeSection( 628457fb0b4SSam Clegg ArrayRef<WasmFunctionType> FunctionTypes) { 6299e15f359SSam Clegg if (FunctionTypes.empty()) 6309e15f359SSam Clegg return; 6319e15f359SSam Clegg 6329e15f359SSam Clegg SectionBookkeeping Section; 6339e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_TYPE); 6349e15f359SSam Clegg 6359e15f359SSam Clegg encodeULEB128(FunctionTypes.size(), getStream()); 6369e15f359SSam Clegg 6379e15f359SSam Clegg for (const WasmFunctionType &FuncTy : FunctionTypes) { 6389e15f359SSam Clegg encodeSLEB128(wasm::WASM_TYPE_FUNC, getStream()); 6399e15f359SSam Clegg encodeULEB128(FuncTy.Params.size(), getStream()); 6409e15f359SSam Clegg for (wasm::ValType Ty : FuncTy.Params) 6419e15f359SSam Clegg writeValueType(Ty); 6429e15f359SSam Clegg encodeULEB128(FuncTy.Returns.size(), getStream()); 6439e15f359SSam Clegg for (wasm::ValType Ty : FuncTy.Returns) 6449e15f359SSam Clegg writeValueType(Ty); 6459e15f359SSam Clegg } 6469e15f359SSam Clegg 6479e15f359SSam Clegg endSection(Section); 6489e15f359SSam Clegg } 6499e15f359SSam Clegg 650457fb0b4SSam Clegg void WasmObjectWriter::writeImportSection(ArrayRef<WasmImport> Imports) { 6519e15f359SSam Clegg if (Imports.empty()) 6529e15f359SSam Clegg return; 6539e15f359SSam Clegg 6549e15f359SSam Clegg SectionBookkeeping Section; 6559e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_IMPORT); 6569e15f359SSam Clegg 6579e15f359SSam Clegg encodeULEB128(Imports.size(), getStream()); 6589e15f359SSam Clegg for (const WasmImport &Import : Imports) { 659b7787fd0SSam Clegg writeString(Import.ModuleName); 660b7787fd0SSam Clegg writeString(Import.FieldName); 6619e15f359SSam Clegg 6629e15f359SSam Clegg encodeULEB128(Import.Kind, getStream()); 6639e15f359SSam Clegg 6649e15f359SSam Clegg switch (Import.Kind) { 6659e15f359SSam Clegg case wasm::WASM_EXTERNAL_FUNCTION: 6669e15f359SSam Clegg encodeULEB128(Import.Type, getStream()); 6679e15f359SSam Clegg break; 6689e15f359SSam Clegg case wasm::WASM_EXTERNAL_GLOBAL: 6699e15f359SSam Clegg encodeSLEB128(int32_t(Import.Type), getStream()); 6709e15f359SSam Clegg encodeULEB128(0, getStream()); // mutability 6719e15f359SSam Clegg break; 6729e15f359SSam Clegg default: 6739e15f359SSam Clegg llvm_unreachable("unsupported import kind"); 6749e15f359SSam Clegg } 6759e15f359SSam Clegg } 6769e15f359SSam Clegg 6779e15f359SSam Clegg endSection(Section); 6789e15f359SSam Clegg } 6799e15f359SSam Clegg 680457fb0b4SSam Clegg void WasmObjectWriter::writeFunctionSection(ArrayRef<WasmFunction> Functions) { 6819e15f359SSam Clegg if (Functions.empty()) 6829e15f359SSam Clegg return; 6839e15f359SSam Clegg 6849e15f359SSam Clegg SectionBookkeeping Section; 6859e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_FUNCTION); 6869e15f359SSam Clegg 6879e15f359SSam Clegg encodeULEB128(Functions.size(), getStream()); 6889e15f359SSam Clegg for (const WasmFunction &Func : Functions) 6899e15f359SSam Clegg encodeULEB128(Func.Type, getStream()); 6909e15f359SSam Clegg 6919e15f359SSam Clegg endSection(Section); 6929e15f359SSam Clegg } 6939e15f359SSam Clegg 694d99f6078SSam Clegg void WasmObjectWriter::writeTableSection(uint32_t NumElements) { 6959e15f359SSam Clegg // For now, always emit the table section, since indirect calls are not 6969e15f359SSam Clegg // valid without it. In the future, we could perhaps be more clever and omit 6979e15f359SSam Clegg // it if there are no indirect calls. 698d99f6078SSam Clegg 6999e15f359SSam Clegg SectionBookkeeping Section; 7009e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_TABLE); 7019e15f359SSam Clegg 702d99f6078SSam Clegg encodeULEB128(1, getStream()); // The number of tables. 703d99f6078SSam Clegg // Fixed to 1 for now. 704d99f6078SSam Clegg encodeSLEB128(wasm::WASM_TYPE_ANYFUNC, getStream()); // Type of table 7059e15f359SSam Clegg encodeULEB128(0, getStream()); // flags 706d99f6078SSam Clegg encodeULEB128(NumElements, getStream()); // initial 7079e15f359SSam Clegg 7089e15f359SSam Clegg endSection(Section); 7099e15f359SSam Clegg } 7109e15f359SSam Clegg 7117c395943SSam Clegg void WasmObjectWriter::writeMemorySection(uint32_t DataSize) { 7129e15f359SSam Clegg // For now, always emit the memory section, since loads and stores are not 7139e15f359SSam Clegg // valid without it. In the future, we could perhaps be more clever and omit 7149e15f359SSam Clegg // it if there are no loads or stores. 7159e15f359SSam Clegg SectionBookkeeping Section; 7167c395943SSam Clegg uint32_t NumPages = (DataSize + wasm::WasmPageSize - 1) / wasm::WasmPageSize; 7179e15f359SSam Clegg 7189e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_MEMORY); 7199e15f359SSam Clegg encodeULEB128(1, getStream()); // number of memory spaces 7209e15f359SSam Clegg 7219e15f359SSam Clegg encodeULEB128(0, getStream()); // flags 7229e15f359SSam Clegg encodeULEB128(NumPages, getStream()); // initial 7239e15f359SSam Clegg 7249e15f359SSam Clegg endSection(Section); 7259e15f359SSam Clegg } 7269e15f359SSam Clegg 7277c395943SSam Clegg void WasmObjectWriter::writeGlobalSection() { 7289e15f359SSam Clegg if (Globals.empty()) 7299e15f359SSam Clegg return; 7309e15f359SSam Clegg 7319e15f359SSam Clegg SectionBookkeeping Section; 7329e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_GLOBAL); 7339e15f359SSam Clegg 7349e15f359SSam Clegg encodeULEB128(Globals.size(), getStream()); 7359e15f359SSam Clegg for (const WasmGlobal &Global : Globals) { 7369e15f359SSam Clegg writeValueType(Global.Type); 7379e15f359SSam Clegg write8(Global.IsMutable); 7389e15f359SSam Clegg 7399e15f359SSam Clegg if (Global.HasImport) { 7409e15f359SSam Clegg assert(Global.InitialValue == 0); 7419e15f359SSam Clegg write8(wasm::WASM_OPCODE_GET_GLOBAL); 7429e15f359SSam Clegg encodeULEB128(Global.ImportIndex, getStream()); 7439e15f359SSam Clegg } else { 7449e15f359SSam Clegg assert(Global.ImportIndex == 0); 7459e15f359SSam Clegg write8(wasm::WASM_OPCODE_I32_CONST); 7469e15f359SSam Clegg encodeSLEB128(Global.InitialValue, getStream()); // offset 7479e15f359SSam Clegg } 7489e15f359SSam Clegg write8(wasm::WASM_OPCODE_END); 7499e15f359SSam Clegg } 7509e15f359SSam Clegg 7519e15f359SSam Clegg endSection(Section); 7529e15f359SSam Clegg } 7539e15f359SSam Clegg 754457fb0b4SSam Clegg void WasmObjectWriter::writeExportSection(ArrayRef<WasmExport> Exports) { 7559e15f359SSam Clegg if (Exports.empty()) 7569e15f359SSam Clegg return; 7579e15f359SSam Clegg 7589e15f359SSam Clegg SectionBookkeeping Section; 7599e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_EXPORT); 7609e15f359SSam Clegg 7619e15f359SSam Clegg encodeULEB128(Exports.size(), getStream()); 7629e15f359SSam Clegg for (const WasmExport &Export : Exports) { 763b7787fd0SSam Clegg writeString(Export.FieldName); 7649e15f359SSam Clegg encodeSLEB128(Export.Kind, getStream()); 7659e15f359SSam Clegg encodeULEB128(Export.Index, getStream()); 7669e15f359SSam Clegg } 7679e15f359SSam Clegg 7689e15f359SSam Clegg endSection(Section); 7699e15f359SSam Clegg } 7709e15f359SSam Clegg 771457fb0b4SSam Clegg void WasmObjectWriter::writeElemSection(ArrayRef<uint32_t> TableElems) { 7729e15f359SSam Clegg if (TableElems.empty()) 7739e15f359SSam Clegg return; 7749e15f359SSam Clegg 7759e15f359SSam Clegg SectionBookkeeping Section; 7769e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_ELEM); 7779e15f359SSam Clegg 7789e15f359SSam Clegg encodeULEB128(1, getStream()); // number of "segments" 7799e15f359SSam Clegg encodeULEB128(0, getStream()); // the table index 7809e15f359SSam Clegg 7819e15f359SSam Clegg // init expr for starting offset 7829e15f359SSam Clegg write8(wasm::WASM_OPCODE_I32_CONST); 7839e15f359SSam Clegg encodeSLEB128(0, getStream()); 7849e15f359SSam Clegg write8(wasm::WASM_OPCODE_END); 7859e15f359SSam Clegg 7869e15f359SSam Clegg encodeULEB128(TableElems.size(), getStream()); 7879e15f359SSam Clegg for (uint32_t Elem : TableElems) 7889e15f359SSam Clegg encodeULEB128(Elem, getStream()); 7899e15f359SSam Clegg 7909e15f359SSam Clegg endSection(Section); 7919e15f359SSam Clegg } 7929e15f359SSam Clegg 793457fb0b4SSam Clegg void WasmObjectWriter::writeCodeSection(const MCAssembler &Asm, 794457fb0b4SSam Clegg const MCAsmLayout &Layout, 795457fb0b4SSam Clegg ArrayRef<WasmFunction> Functions) { 7969e15f359SSam Clegg if (Functions.empty()) 7979e15f359SSam Clegg return; 7989e15f359SSam Clegg 7999e15f359SSam Clegg SectionBookkeeping Section; 8009e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_CODE); 8019e15f359SSam Clegg 8029e15f359SSam Clegg encodeULEB128(Functions.size(), getStream()); 8039e15f359SSam Clegg 8049e15f359SSam Clegg for (const WasmFunction &Func : Functions) { 805fe6414b0SSam Clegg auto &FuncSection = static_cast<MCSectionWasm &>(Func.Sym->getSection()); 8069e15f359SSam Clegg 8079e15f359SSam Clegg int64_t Size = 0; 8089e15f359SSam Clegg if (!Func.Sym->getSize()->evaluateAsAbsolute(Size, Layout)) 8099e15f359SSam Clegg report_fatal_error(".size expression must be evaluatable"); 8109e15f359SSam Clegg 8119e15f359SSam Clegg encodeULEB128(Size, getStream()); 812fe6414b0SSam Clegg FuncSection.setSectionOffset(getStream().tell() - Section.ContentsOffset); 8139e15f359SSam Clegg Asm.writeSectionData(&FuncSection, Layout); 8149e15f359SSam Clegg } 8159e15f359SSam Clegg 8169e15f359SSam Clegg // Apply fixups. 817acd7d2b0SSam Clegg applyRelocations(CodeRelocations, Section.ContentsOffset); 8189e15f359SSam Clegg 8199e15f359SSam Clegg endSection(Section); 8209e15f359SSam Clegg } 8219e15f359SSam Clegg 822457fb0b4SSam Clegg void WasmObjectWriter::writeDataSection(ArrayRef<WasmDataSegment> Segments) { 8237c395943SSam Clegg if (Segments.empty()) 8247c395943SSam Clegg return; 8259e15f359SSam Clegg 8269e15f359SSam Clegg SectionBookkeeping Section; 8279e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_DATA); 8289e15f359SSam Clegg 8297c395943SSam Clegg encodeULEB128(Segments.size(), getStream()); // count 8307c395943SSam Clegg 8317c395943SSam Clegg for (const WasmDataSegment & Segment : Segments) { 8329e15f359SSam Clegg encodeULEB128(0, getStream()); // memory index 8339e15f359SSam Clegg write8(wasm::WASM_OPCODE_I32_CONST); 8347c395943SSam Clegg encodeSLEB128(Segment.Offset, getStream()); // offset 8359e15f359SSam Clegg write8(wasm::WASM_OPCODE_END); 8367c395943SSam Clegg encodeULEB128(Segment.Data.size(), getStream()); // size 8377c395943SSam Clegg Segment.Section->setSectionOffset(getStream().tell() - Section.ContentsOffset); 8387c395943SSam Clegg writeBytes(Segment.Data); // data 8397c395943SSam Clegg } 8409e15f359SSam Clegg 8419e15f359SSam Clegg // Apply fixups. 8427c395943SSam Clegg applyRelocations(DataRelocations, Section.ContentsOffset); 8439e15f359SSam Clegg 8449e15f359SSam Clegg endSection(Section); 8459e15f359SSam Clegg } 8469e15f359SSam Clegg 8479e15f359SSam Clegg void WasmObjectWriter::writeNameSection( 848457fb0b4SSam Clegg ArrayRef<WasmFunction> Functions, 849457fb0b4SSam Clegg ArrayRef<WasmImport> Imports, 8509e15f359SSam Clegg unsigned NumFuncImports) { 8519e15f359SSam Clegg uint32_t TotalFunctions = NumFuncImports + Functions.size(); 8529e15f359SSam Clegg if (TotalFunctions == 0) 8539e15f359SSam Clegg return; 8549e15f359SSam Clegg 8559e15f359SSam Clegg SectionBookkeeping Section; 8569e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_CUSTOM, "name"); 8579e15f359SSam Clegg SectionBookkeeping SubSection; 8589e15f359SSam Clegg startSection(SubSection, wasm::WASM_NAMES_FUNCTION); 8599e15f359SSam Clegg 8609e15f359SSam Clegg encodeULEB128(TotalFunctions, getStream()); 8619e15f359SSam Clegg uint32_t Index = 0; 8629e15f359SSam Clegg for (const WasmImport &Import : Imports) { 8639e15f359SSam Clegg if (Import.Kind == wasm::WASM_EXTERNAL_FUNCTION) { 8649e15f359SSam Clegg encodeULEB128(Index, getStream()); 865b7787fd0SSam Clegg writeString(Import.FieldName); 8669e15f359SSam Clegg ++Index; 8679e15f359SSam Clegg } 8689e15f359SSam Clegg } 8699e15f359SSam Clegg for (const WasmFunction &Func : Functions) { 8709e15f359SSam Clegg encodeULEB128(Index, getStream()); 871b7787fd0SSam Clegg writeString(Func.Sym->getName()); 8729e15f359SSam Clegg ++Index; 8739e15f359SSam Clegg } 8749e15f359SSam Clegg 8759e15f359SSam Clegg endSection(SubSection); 8769e15f359SSam Clegg endSection(Section); 8779e15f359SSam Clegg } 8789e15f359SSam Clegg 879acd7d2b0SSam Clegg void WasmObjectWriter::writeCodeRelocSection() { 8809e15f359SSam Clegg // See: https://github.com/WebAssembly/tool-conventions/blob/master/Linking.md 8819e15f359SSam Clegg // for descriptions of the reloc sections. 8829e15f359SSam Clegg 8839e15f359SSam Clegg if (CodeRelocations.empty()) 8849e15f359SSam Clegg return; 8859e15f359SSam Clegg 8869e15f359SSam Clegg SectionBookkeeping Section; 8879e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_CUSTOM, "reloc.CODE"); 8889e15f359SSam Clegg 8899e15f359SSam Clegg encodeULEB128(wasm::WASM_SEC_CODE, getStream()); 890acd7d2b0SSam Clegg encodeULEB128(CodeRelocations.size(), getStream()); 8919e15f359SSam Clegg 8927c395943SSam Clegg writeRelocations(CodeRelocations); 8939e15f359SSam Clegg 8949e15f359SSam Clegg endSection(Section); 8959e15f359SSam Clegg } 8969e15f359SSam Clegg 8977c395943SSam Clegg void WasmObjectWriter::writeDataRelocSection() { 8989e15f359SSam Clegg // See: https://github.com/WebAssembly/tool-conventions/blob/master/Linking.md 8999e15f359SSam Clegg // for descriptions of the reloc sections. 9009e15f359SSam Clegg 9019e15f359SSam Clegg if (DataRelocations.empty()) 9029e15f359SSam Clegg return; 9039e15f359SSam Clegg 9049e15f359SSam Clegg SectionBookkeeping Section; 9059e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_CUSTOM, "reloc.DATA"); 9069e15f359SSam Clegg 9079e15f359SSam Clegg encodeULEB128(wasm::WASM_SEC_DATA, getStream()); 9089e15f359SSam Clegg encodeULEB128(DataRelocations.size(), getStream()); 9099e15f359SSam Clegg 9107c395943SSam Clegg writeRelocations(DataRelocations); 9119e15f359SSam Clegg 9129e15f359SSam Clegg endSection(Section); 9139e15f359SSam Clegg } 9149e15f359SSam Clegg 9159e15f359SSam Clegg void WasmObjectWriter::writeLinkingMetaDataSection( 916d95ed959SSam Clegg ArrayRef<WasmDataSegment> Segments, uint32_t DataSize, 917*31a2c809SSam Clegg uint32_t DataAlignment, 918*31a2c809SSam Clegg SmallVector<std::pair<StringRef, uint32_t>, 4> SymbolFlags, 9199e1ade93SSam Clegg bool HasStackPointer, uint32_t StackPointerGlobal) { 9209e15f359SSam Clegg SectionBookkeeping Section; 9219e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_CUSTOM, "linking"); 922b7787fd0SSam Clegg SectionBookkeeping SubSection; 9239e15f359SSam Clegg 924b7787fd0SSam Clegg if (HasStackPointer) { 925b7787fd0SSam Clegg startSection(SubSection, wasm::WASM_STACK_POINTER); 9269e15f359SSam Clegg encodeULEB128(StackPointerGlobal, getStream()); // id 927b7787fd0SSam Clegg endSection(SubSection); 928b7787fd0SSam Clegg } 929b7787fd0SSam Clegg 930*31a2c809SSam Clegg if (SymbolFlags.size() != 0) { 931b7787fd0SSam Clegg startSection(SubSection, wasm::WASM_SYMBOL_INFO); 932*31a2c809SSam Clegg encodeULEB128(SymbolFlags.size(), getStream()); 933*31a2c809SSam Clegg for (auto Pair: SymbolFlags) { 934*31a2c809SSam Clegg writeString(Pair.first); 935*31a2c809SSam Clegg encodeULEB128(Pair.second, getStream()); 936b7787fd0SSam Clegg } 937b7787fd0SSam Clegg endSection(SubSection); 938b7787fd0SSam Clegg } 9399e15f359SSam Clegg 9409e1ade93SSam Clegg if (DataSize > 0) { 9419e1ade93SSam Clegg startSection(SubSection, wasm::WASM_DATA_SIZE); 9429e1ade93SSam Clegg encodeULEB128(DataSize, getStream()); 9439e1ade93SSam Clegg endSection(SubSection); 9449e1ade93SSam Clegg 9459e1ade93SSam Clegg startSection(SubSection, wasm::WASM_DATA_ALIGNMENT); 9469e1ade93SSam Clegg encodeULEB128(DataAlignment, getStream()); 9479e1ade93SSam Clegg endSection(SubSection); 9489e1ade93SSam Clegg } 9499e1ade93SSam Clegg 950d95ed959SSam Clegg if (Segments.size()) { 951d95ed959SSam Clegg startSection(SubSection, wasm::WASM_SEGMENT_NAMES); 952d95ed959SSam Clegg encodeULEB128(Segments.size(), getStream()); 953d95ed959SSam Clegg for (const WasmDataSegment &Segment : Segments) 954d95ed959SSam Clegg writeString(Segment.Name); 955d95ed959SSam Clegg endSection(SubSection); 956d95ed959SSam Clegg } 957d95ed959SSam Clegg 9589e15f359SSam Clegg endSection(Section); 9599e15f359SSam Clegg } 9609e15f359SSam Clegg 9615e3d33a7SSam Clegg uint32_t WasmObjectWriter::getFunctionType(const MCSymbolWasm& Symbol) { 9625e3d33a7SSam Clegg assert(Symbol.isFunction()); 9635e3d33a7SSam Clegg assert(TypeIndices.count(&Symbol)); 9645e3d33a7SSam Clegg return TypeIndices[&Symbol]; 9655e3d33a7SSam Clegg } 9665e3d33a7SSam Clegg 9675e3d33a7SSam Clegg uint32_t WasmObjectWriter::registerFunctionType(const MCSymbolWasm& Symbol) { 9685e3d33a7SSam Clegg assert(Symbol.isFunction()); 9695e3d33a7SSam Clegg 9705e3d33a7SSam Clegg WasmFunctionType F; 971aff1c4dfSSam Clegg const MCSymbolWasm* ResolvedSym = ResolveSymbol(Symbol); 9725e3d33a7SSam Clegg F.Returns = ResolvedSym->getReturns(); 9735e3d33a7SSam Clegg F.Params = ResolvedSym->getParams(); 9745e3d33a7SSam Clegg 9755e3d33a7SSam Clegg auto Pair = 9765e3d33a7SSam Clegg FunctionTypeIndices.insert(std::make_pair(F, FunctionTypes.size())); 9775e3d33a7SSam Clegg if (Pair.second) 9785e3d33a7SSam Clegg FunctionTypes.push_back(F); 9795e3d33a7SSam Clegg TypeIndices[&Symbol] = Pair.first->second; 9805e3d33a7SSam Clegg 9815e3d33a7SSam Clegg DEBUG(dbgs() << "registerFunctionType: " << Symbol << " new:" << Pair.second << "\n"); 9825e3d33a7SSam Clegg DEBUG(dbgs() << " -> type index: " << Pair.first->second << "\n"); 9835e3d33a7SSam Clegg return Pair.first->second; 9845e3d33a7SSam Clegg } 9855e3d33a7SSam Clegg 98618eafb6cSDan Gohman void WasmObjectWriter::writeObject(MCAssembler &Asm, 98718eafb6cSDan Gohman const MCAsmLayout &Layout) { 988b7787fd0SSam Clegg DEBUG(dbgs() << "WasmObjectWriter::writeObject\n"); 98982607f56SDan Gohman MCContext &Ctx = Asm.getContext(); 990b879539aSDerek Schuff wasm::ValType PtrType = is64Bit() ? wasm::ValType::I64 : wasm::ValType::I32; 991d934cb88SDan Gohman 992d934cb88SDan Gohman // Collect information from the available symbols. 993d934cb88SDan Gohman SmallVector<WasmFunction, 4> Functions; 994d934cb88SDan Gohman SmallVector<uint32_t, 4> TableElems; 995d934cb88SDan Gohman SmallVector<WasmImport, 4> Imports; 996d934cb88SDan Gohman SmallVector<WasmExport, 4> Exports; 997*31a2c809SSam Clegg SmallVector<std::pair<StringRef, uint32_t>, 4> SymbolFlags; 998d934cb88SDan Gohman SmallPtrSet<const MCSymbolWasm *, 4> IsAddressTaken; 999d934cb88SDan Gohman unsigned NumFuncImports = 0; 10007c395943SSam Clegg SmallVector<WasmDataSegment, 4> DataSegments; 10019e1ade93SSam Clegg uint32_t DataAlignment = 1; 1002970d02c4SDan Gohman uint32_t StackPointerGlobal = 0; 10037c395943SSam Clegg uint32_t DataSize = 0; 1004970d02c4SDan Gohman bool HasStackPointer = false; 1005d934cb88SDan Gohman 1006d934cb88SDan Gohman // Populate the IsAddressTaken set. 1007b7787fd0SSam Clegg for (const WasmRelocationEntry &RelEntry : CodeRelocations) { 1008d934cb88SDan Gohman switch (RelEntry.Type) { 1009d934cb88SDan Gohman case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB: 101013a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB: 1011d934cb88SDan Gohman IsAddressTaken.insert(RelEntry.Symbol); 1012d934cb88SDan Gohman break; 1013d934cb88SDan Gohman default: 1014d934cb88SDan Gohman break; 1015d934cb88SDan Gohman } 1016d934cb88SDan Gohman } 1017b7787fd0SSam Clegg for (const WasmRelocationEntry &RelEntry : DataRelocations) { 1018d934cb88SDan Gohman switch (RelEntry.Type) { 1019d934cb88SDan Gohman case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32: 102013a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32: 1021d934cb88SDan Gohman IsAddressTaken.insert(RelEntry.Symbol); 1022d934cb88SDan Gohman break; 1023d934cb88SDan Gohman default: 1024d934cb88SDan Gohman break; 1025d934cb88SDan Gohman } 1026d934cb88SDan Gohman } 1027d934cb88SDan Gohman 10287c395943SSam Clegg // Populate FunctionTypeIndices and Imports. 1029d934cb88SDan Gohman for (const MCSymbol &S : Asm.symbols()) { 10305e3d33a7SSam Clegg const auto &WS = static_cast<const MCSymbolWasm &>(S); 10315e3d33a7SSam Clegg 10325e3d33a7SSam Clegg if (WS.isTemporary()) 10338c4baa00SSam Clegg continue; 10348c4baa00SSam Clegg 10355e3d33a7SSam Clegg if (WS.isFunction()) 10365e3d33a7SSam Clegg registerFunctionType(WS); 1037d934cb88SDan Gohman 1038d934cb88SDan Gohman // If the symbol is not defined in this translation unit, import it. 10395e3d33a7SSam Clegg if (!WS.isDefined(/*SetUsed=*/false) || WS.isVariable()) { 1040d934cb88SDan Gohman WasmImport Import; 1041d934cb88SDan Gohman Import.ModuleName = WS.getModuleName(); 1042d934cb88SDan Gohman Import.FieldName = WS.getName(); 1043d934cb88SDan Gohman 1044d934cb88SDan Gohman if (WS.isFunction()) { 1045d934cb88SDan Gohman Import.Kind = wasm::WASM_EXTERNAL_FUNCTION; 10465e3d33a7SSam Clegg Import.Type = getFunctionType(WS); 1047d934cb88SDan Gohman SymbolIndices[&WS] = NumFuncImports; 1048d934cb88SDan Gohman ++NumFuncImports; 1049d934cb88SDan Gohman } else { 1050d934cb88SDan Gohman Import.Kind = wasm::WASM_EXTERNAL_GLOBAL; 10515e3d33a7SSam Clegg Import.Type = int32_t(PtrType); 1052d934cb88SDan Gohman SymbolIndices[&WS] = NumGlobalImports; 1053d934cb88SDan Gohman ++NumGlobalImports; 1054d934cb88SDan Gohman } 1055d934cb88SDan Gohman 1056d934cb88SDan Gohman Imports.push_back(Import); 1057d934cb88SDan Gohman } 1058d934cb88SDan Gohman } 1059d934cb88SDan Gohman 106082607f56SDan Gohman // In the special .global_variables section, we've encoded global 106182607f56SDan Gohman // variables used by the function. Translate them into the Globals 106282607f56SDan Gohman // list. 1063759631c7SSam Clegg MCSectionWasm *GlobalVars = Ctx.getWasmSection(".global_variables", wasm::WASM_SEC_DATA); 106482607f56SDan Gohman if (!GlobalVars->getFragmentList().empty()) { 106582607f56SDan Gohman if (GlobalVars->getFragmentList().size() != 1) 106682607f56SDan Gohman report_fatal_error("only one .global_variables fragment supported"); 106782607f56SDan Gohman const MCFragment &Frag = *GlobalVars->begin(); 106882607f56SDan Gohman if (Frag.hasInstructions() || Frag.getKind() != MCFragment::FT_Data) 106982607f56SDan Gohman report_fatal_error("only data supported in .global_variables"); 1070fe6414b0SSam Clegg const auto &DataFrag = cast<MCDataFragment>(Frag); 107182607f56SDan Gohman if (!DataFrag.getFixups().empty()) 107282607f56SDan Gohman report_fatal_error("fixups not supported in .global_variables"); 107382607f56SDan Gohman const SmallVectorImpl<char> &Contents = DataFrag.getContents(); 1074970d02c4SDan Gohman for (const uint8_t *p = (const uint8_t *)Contents.data(), 1075970d02c4SDan Gohman *end = (const uint8_t *)Contents.data() + Contents.size(); 1076970d02c4SDan Gohman p != end; ) { 107782607f56SDan Gohman WasmGlobal G; 1078970d02c4SDan Gohman if (end - p < 3) 1079970d02c4SDan Gohman report_fatal_error("truncated global variable encoding"); 1080970d02c4SDan Gohman G.Type = wasm::ValType(int8_t(*p++)); 1081970d02c4SDan Gohman G.IsMutable = bool(*p++); 1082970d02c4SDan Gohman G.HasImport = bool(*p++); 1083970d02c4SDan Gohman if (G.HasImport) { 108482607f56SDan Gohman G.InitialValue = 0; 1085970d02c4SDan Gohman 1086970d02c4SDan Gohman WasmImport Import; 1087970d02c4SDan Gohman Import.ModuleName = (const char *)p; 1088970d02c4SDan Gohman const uint8_t *nul = (const uint8_t *)memchr(p, '\0', end - p); 1089970d02c4SDan Gohman if (!nul) 1090970d02c4SDan Gohman report_fatal_error("global module name must be nul-terminated"); 1091970d02c4SDan Gohman p = nul + 1; 1092970d02c4SDan Gohman nul = (const uint8_t *)memchr(p, '\0', end - p); 1093970d02c4SDan Gohman if (!nul) 1094970d02c4SDan Gohman report_fatal_error("global base name must be nul-terminated"); 1095970d02c4SDan Gohman Import.FieldName = (const char *)p; 1096970d02c4SDan Gohman p = nul + 1; 1097970d02c4SDan Gohman 1098970d02c4SDan Gohman Import.Kind = wasm::WASM_EXTERNAL_GLOBAL; 1099970d02c4SDan Gohman Import.Type = int32_t(G.Type); 1100970d02c4SDan Gohman 1101970d02c4SDan Gohman G.ImportIndex = NumGlobalImports; 1102970d02c4SDan Gohman ++NumGlobalImports; 1103970d02c4SDan Gohman 1104970d02c4SDan Gohman Imports.push_back(Import); 1105970d02c4SDan Gohman } else { 1106970d02c4SDan Gohman unsigned n; 1107970d02c4SDan Gohman G.InitialValue = decodeSLEB128(p, &n); 1108970d02c4SDan Gohman G.ImportIndex = 0; 1109c8da0c0bSSimon Pilgrim if ((ptrdiff_t)n > end - p) 1110970d02c4SDan Gohman report_fatal_error("global initial value must be valid SLEB128"); 1111970d02c4SDan Gohman p += n; 1112970d02c4SDan Gohman } 111382607f56SDan Gohman Globals.push_back(G); 111482607f56SDan Gohman } 111582607f56SDan Gohman } 111682607f56SDan Gohman 1117970d02c4SDan Gohman // In the special .stack_pointer section, we've encoded the stack pointer 1118970d02c4SDan Gohman // index. 1119759631c7SSam Clegg MCSectionWasm *StackPtr = Ctx.getWasmSection(".stack_pointer", wasm::WASM_SEC_DATA); 1120970d02c4SDan Gohman if (!StackPtr->getFragmentList().empty()) { 1121970d02c4SDan Gohman if (StackPtr->getFragmentList().size() != 1) 1122970d02c4SDan Gohman report_fatal_error("only one .stack_pointer fragment supported"); 1123970d02c4SDan Gohman const MCFragment &Frag = *StackPtr->begin(); 1124970d02c4SDan Gohman if (Frag.hasInstructions() || Frag.getKind() != MCFragment::FT_Data) 1125970d02c4SDan Gohman report_fatal_error("only data supported in .stack_pointer"); 1126fe6414b0SSam Clegg const auto &DataFrag = cast<MCDataFragment>(Frag); 1127970d02c4SDan Gohman if (!DataFrag.getFixups().empty()) 1128970d02c4SDan Gohman report_fatal_error("fixups not supported in .stack_pointer"); 1129970d02c4SDan Gohman const SmallVectorImpl<char> &Contents = DataFrag.getContents(); 1130970d02c4SDan Gohman if (Contents.size() != 4) 1131970d02c4SDan Gohman report_fatal_error("only one entry supported in .stack_pointer"); 1132970d02c4SDan Gohman HasStackPointer = true; 1133970d02c4SDan Gohman StackPointerGlobal = NumGlobalImports + *(const int32_t *)Contents.data(); 1134970d02c4SDan Gohman } 1135970d02c4SDan Gohman 1136759631c7SSam Clegg for (MCSection &Sec : Asm) { 1137759631c7SSam Clegg auto &Section = static_cast<MCSectionWasm &>(Sec); 1138759631c7SSam Clegg if (Section.getType() != wasm::WASM_SEC_DATA) 1139759631c7SSam Clegg continue; 1140759631c7SSam Clegg 1141759631c7SSam Clegg DataSize = alignTo(DataSize, Section.getAlignment()); 1142759631c7SSam Clegg DataSegments.emplace_back(); 1143759631c7SSam Clegg WasmDataSegment &Segment = DataSegments.back(); 1144d95ed959SSam Clegg Segment.Name = Section.getSectionName(); 1145759631c7SSam Clegg Segment.Offset = DataSize; 1146759631c7SSam Clegg Segment.Section = &Section; 1147759631c7SSam Clegg addData(Segment.Data, Section, DataAlignment); 1148759631c7SSam Clegg DataSize += Segment.Data.size(); 1149759631c7SSam Clegg Section.setMemoryOffset(Segment.Offset); 1150759631c7SSam Clegg } 1151759631c7SSam Clegg 1152b7787fd0SSam Clegg // Handle regular defined and undefined symbols. 1153d934cb88SDan Gohman for (const MCSymbol &S : Asm.symbols()) { 1154d934cb88SDan Gohman // Ignore unnamed temporary symbols, which aren't ever exported, imported, 1155d934cb88SDan Gohman // or used in relocations. 1156d934cb88SDan Gohman if (S.isTemporary() && S.getName().empty()) 1157d934cb88SDan Gohman continue; 1158b7787fd0SSam Clegg 1159d934cb88SDan Gohman const auto &WS = static_cast<const MCSymbolWasm &>(S); 1160b7787fd0SSam Clegg DEBUG(dbgs() << "MCSymbol: '" << S << "'" 1161b7787fd0SSam Clegg << " isDefined=" << S.isDefined() << " isExternal=" 1162b7787fd0SSam Clegg << S.isExternal() << " isTemporary=" << S.isTemporary() 1163b7787fd0SSam Clegg << " isFunction=" << WS.isFunction() 1164b7787fd0SSam Clegg << " isWeak=" << WS.isWeak() 1165b7787fd0SSam Clegg << " isVariable=" << WS.isVariable() << "\n"); 1166b7787fd0SSam Clegg 1167b7787fd0SSam Clegg if (WS.isWeak()) 1168*31a2c809SSam Clegg SymbolFlags.emplace_back(WS.getName(), wasm::WASM_SYMBOL_BINDING_WEAK); 1169b7787fd0SSam Clegg 11705e3d33a7SSam Clegg if (WS.isVariable()) 11715e3d33a7SSam Clegg continue; 11725e3d33a7SSam Clegg 1173d934cb88SDan Gohman unsigned Index; 1174b7787fd0SSam Clegg 1175d934cb88SDan Gohman if (WS.isFunction()) { 1176d934cb88SDan Gohman if (WS.isDefined(/*SetUsed=*/false)) { 1177b7787fd0SSam Clegg if (WS.getOffset() != 0) 1178b7787fd0SSam Clegg report_fatal_error( 1179b7787fd0SSam Clegg "function sections must contain one function each"); 1180b7787fd0SSam Clegg 1181b7787fd0SSam Clegg if (WS.getSize() == 0) 1182b7787fd0SSam Clegg report_fatal_error( 1183b7787fd0SSam Clegg "function symbols must have a size set with .size"); 1184b7787fd0SSam Clegg 1185d934cb88SDan Gohman // A definition. Take the next available index. 1186d934cb88SDan Gohman Index = NumFuncImports + Functions.size(); 1187d934cb88SDan Gohman 1188d934cb88SDan Gohman // Prepare the function. 1189d934cb88SDan Gohman WasmFunction Func; 11905e3d33a7SSam Clegg Func.Type = getFunctionType(WS); 1191d934cb88SDan Gohman Func.Sym = &WS; 1192d934cb88SDan Gohman SymbolIndices[&WS] = Index; 1193d934cb88SDan Gohman Functions.push_back(Func); 1194d934cb88SDan Gohman } else { 1195d934cb88SDan Gohman // An import; the index was assigned above. 1196d934cb88SDan Gohman Index = SymbolIndices.find(&WS)->second; 1197d934cb88SDan Gohman } 1198d934cb88SDan Gohman 11995e3d33a7SSam Clegg DEBUG(dbgs() << " -> function index: " << Index << "\n"); 12005e3d33a7SSam Clegg 1201d934cb88SDan Gohman // If needed, prepare the function to be called indirectly. 12025e3d33a7SSam Clegg if (IsAddressTaken.count(&WS) != 0) { 1203d99f6078SSam Clegg IndirectSymbolIndices[&WS] = TableElems.size(); 12045e3d33a7SSam Clegg DEBUG(dbgs() << " -> adding to table: " << TableElems.size() << "\n"); 1205d934cb88SDan Gohman TableElems.push_back(Index); 1206d99f6078SSam Clegg } 1207d934cb88SDan Gohman } else { 1208c38e947eSSam Clegg if (WS.isTemporary() && !WS.getSize()) 1209c38e947eSSam Clegg continue; 1210c38e947eSSam Clegg 1211fe6414b0SSam Clegg if (!WS.isDefined(/*SetUsed=*/false)) 1212fe6414b0SSam Clegg continue; 1213fe6414b0SSam Clegg 1214d934cb88SDan Gohman if (!WS.getSize()) 1215c38e947eSSam Clegg report_fatal_error("data symbols must have a size set with .size: " + 1216c38e947eSSam Clegg WS.getName()); 1217d934cb88SDan Gohman 1218d934cb88SDan Gohman int64_t Size = 0; 1219d934cb88SDan Gohman if (!WS.getSize()->evaluateAsAbsolute(Size, Layout)) 1220d934cb88SDan Gohman report_fatal_error(".size expression must be evaluatable"); 1221d934cb88SDan Gohman 12227c395943SSam Clegg // For each global, prepare a corresponding wasm global holding its 12237c395943SSam Clegg // address. For externals these will also be named exports. 12247c395943SSam Clegg Index = NumGlobalImports + Globals.size(); 1225759631c7SSam Clegg auto &DataSection = static_cast<MCSectionWasm &>(WS.getSection()); 12267c395943SSam Clegg 12277c395943SSam Clegg WasmGlobal Global; 12287c395943SSam Clegg Global.Type = PtrType; 12297c395943SSam Clegg Global.IsMutable = false; 12307c395943SSam Clegg Global.HasImport = false; 1231759631c7SSam Clegg Global.InitialValue = DataSection.getMemoryOffset() + Layout.getSymbolOffset(WS); 12327c395943SSam Clegg Global.ImportIndex = 0; 12337c395943SSam Clegg SymbolIndices[&WS] = Index; 12347c395943SSam Clegg DEBUG(dbgs() << " -> global index: " << Index << "\n"); 12357c395943SSam Clegg Globals.push_back(Global); 1236d934cb88SDan Gohman } 1237d934cb88SDan Gohman 1238d934cb88SDan Gohman // If the symbol is visible outside this translation unit, export it. 1239*31a2c809SSam Clegg if (WS.isDefined(/*SetUsed=*/false)) { 1240d934cb88SDan Gohman WasmExport Export; 1241d934cb88SDan Gohman Export.FieldName = WS.getName(); 1242d934cb88SDan Gohman Export.Index = Index; 1243d934cb88SDan Gohman if (WS.isFunction()) 1244d934cb88SDan Gohman Export.Kind = wasm::WASM_EXTERNAL_FUNCTION; 1245d934cb88SDan Gohman else 1246d934cb88SDan Gohman Export.Kind = wasm::WASM_EXTERNAL_GLOBAL; 12475e3d33a7SSam Clegg DEBUG(dbgs() << " -> export " << Exports.size() << "\n"); 1248d934cb88SDan Gohman Exports.push_back(Export); 1249*31a2c809SSam Clegg if (!WS.isExternal()) 1250*31a2c809SSam Clegg SymbolFlags.emplace_back(WS.getName(), wasm::WASM_SYMBOL_BINDING_LOCAL); 1251d934cb88SDan Gohman } 1252d934cb88SDan Gohman } 1253d934cb88SDan Gohman 12545e3d33a7SSam Clegg // Handle weak aliases. We need to process these in a separate pass because 12555e3d33a7SSam Clegg // we need to have processed the target of the alias before the alias itself 12565e3d33a7SSam Clegg // and the symbols are not necessarily ordered in this way. 1257b7787fd0SSam Clegg for (const MCSymbol &S : Asm.symbols()) { 1258b7787fd0SSam Clegg if (!S.isVariable()) 1259b7787fd0SSam Clegg continue; 1260*31a2c809SSam Clegg 1261b7787fd0SSam Clegg assert(S.isDefined(/*SetUsed=*/false)); 1262b7787fd0SSam Clegg 12635e3d33a7SSam Clegg // Find the target symbol of this weak alias and export that index 1264aff1c4dfSSam Clegg const auto &WS = static_cast<const MCSymbolWasm &>(S); 1265aff1c4dfSSam Clegg const MCSymbolWasm *ResolvedSym = ResolveSymbol(WS); 12665e3d33a7SSam Clegg DEBUG(dbgs() << WS.getName() << ": weak alias of '" << *ResolvedSym << "'\n"); 12675e3d33a7SSam Clegg assert(SymbolIndices.count(ResolvedSym) > 0); 1268b7787fd0SSam Clegg uint32_t Index = SymbolIndices.find(ResolvedSym)->second; 12695e3d33a7SSam Clegg DEBUG(dbgs() << " -> index:" << Index << "\n"); 1270b7787fd0SSam Clegg 1271b7787fd0SSam Clegg WasmExport Export; 1272b7787fd0SSam Clegg Export.FieldName = WS.getName(); 1273b7787fd0SSam Clegg Export.Index = Index; 1274b7787fd0SSam Clegg if (WS.isFunction()) 1275b7787fd0SSam Clegg Export.Kind = wasm::WASM_EXTERNAL_FUNCTION; 1276b7787fd0SSam Clegg else 1277b7787fd0SSam Clegg Export.Kind = wasm::WASM_EXTERNAL_GLOBAL; 12785e3d33a7SSam Clegg DEBUG(dbgs() << " -> export " << Exports.size() << "\n"); 1279b7787fd0SSam Clegg Exports.push_back(Export); 1280*31a2c809SSam Clegg 1281*31a2c809SSam Clegg if (!WS.isExternal()) 1282*31a2c809SSam Clegg SymbolFlags.emplace_back(WS.getName(), wasm::WASM_SYMBOL_BINDING_LOCAL); 1283b7787fd0SSam Clegg } 1284b7787fd0SSam Clegg 1285d934cb88SDan Gohman // Add types for indirect function calls. 1286acd7d2b0SSam Clegg for (const WasmRelocationEntry &Fixup : CodeRelocations) { 1287acd7d2b0SSam Clegg if (Fixup.Type != wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB) 1288acd7d2b0SSam Clegg continue; 1289970d02c4SDan Gohman 12905e3d33a7SSam Clegg registerFunctionType(*Fixup.Symbol); 1291d934cb88SDan Gohman } 1292d934cb88SDan Gohman 129318eafb6cSDan Gohman // Write out the Wasm header. 129418eafb6cSDan Gohman writeHeader(Asm); 129518eafb6cSDan Gohman 12969e15f359SSam Clegg writeTypeSection(FunctionTypes); 12979e15f359SSam Clegg writeImportSection(Imports); 12989e15f359SSam Clegg writeFunctionSection(Functions); 1299d99f6078SSam Clegg writeTableSection(TableElems.size()); 13007c395943SSam Clegg writeMemorySection(DataSize); 13017c395943SSam Clegg writeGlobalSection(); 13029e15f359SSam Clegg writeExportSection(Exports); 13039e15f359SSam Clegg // TODO: Start Section 13049e15f359SSam Clegg writeElemSection(TableElems); 1305acd7d2b0SSam Clegg writeCodeSection(Asm, Layout, Functions); 13067c395943SSam Clegg writeDataSection(DataSegments); 13079e15f359SSam Clegg writeNameSection(Functions, Imports, NumFuncImports); 1308acd7d2b0SSam Clegg writeCodeRelocSection(); 13097c395943SSam Clegg writeDataRelocSection(); 1310d95ed959SSam Clegg writeLinkingMetaDataSection(DataSegments, DataSize, DataAlignment, 1311*31a2c809SSam Clegg SymbolFlags, HasStackPointer, StackPointerGlobal); 1312970d02c4SDan Gohman 1313d934cb88SDan Gohman // TODO: Translate the .comment section to the output. 1314d934cb88SDan Gohman // TODO: Translate debug sections to the output. 131518eafb6cSDan Gohman } 131618eafb6cSDan Gohman 131718eafb6cSDan Gohman MCObjectWriter *llvm::createWasmObjectWriter(MCWasmObjectTargetWriter *MOTW, 131818eafb6cSDan Gohman raw_pwrite_stream &OS) { 131918eafb6cSDan Gohman return new WasmObjectWriter(MOTW, OS); 132018eafb6cSDan Gohman } 1321