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 4130e1bbc1SSam Clegg // Went we ceate the indirect function table we start at 1, so that there is 4230e1bbc1SSam Clegg // and emtpy slot at 0 and therefore calling a null function pointer will trap. 4330e1bbc1SSam Clegg static const uint32_t kInitialTableOffset = 1; 4430e1bbc1SSam Clegg 45d934cb88SDan Gohman // For patching purposes, we need to remember where each section starts, both 46d934cb88SDan Gohman // for patching up the section size field, and for patching up references to 47d934cb88SDan Gohman // locations within the section. 48d934cb88SDan Gohman struct SectionBookkeeping { 49d934cb88SDan Gohman // Where the size of the section is written. 50d934cb88SDan Gohman uint64_t SizeOffset; 51d934cb88SDan Gohman // Where the contents of the section starts (after the header). 52d934cb88SDan Gohman uint64_t ContentsOffset; 53d934cb88SDan Gohman }; 54d934cb88SDan Gohman 559e15f359SSam Clegg // The signature of a wasm function, in a struct capable of being used as a 569e15f359SSam Clegg // DenseMap key. 579e15f359SSam Clegg struct WasmFunctionType { 589e15f359SSam Clegg // Support empty and tombstone instances, needed by DenseMap. 599e15f359SSam Clegg enum { Plain, Empty, Tombstone } State; 609e15f359SSam Clegg 619e15f359SSam Clegg // The return types of the function. 629e15f359SSam Clegg SmallVector<wasm::ValType, 1> Returns; 639e15f359SSam Clegg 649e15f359SSam Clegg // The parameter types of the function. 659e15f359SSam Clegg SmallVector<wasm::ValType, 4> Params; 669e15f359SSam Clegg 679e15f359SSam Clegg WasmFunctionType() : State(Plain) {} 689e15f359SSam Clegg 699e15f359SSam Clegg bool operator==(const WasmFunctionType &Other) const { 709e15f359SSam Clegg return State == Other.State && Returns == Other.Returns && 719e15f359SSam Clegg Params == Other.Params; 729e15f359SSam Clegg } 739e15f359SSam Clegg }; 749e15f359SSam Clegg 759e15f359SSam Clegg // Traits for using WasmFunctionType in a DenseMap. 769e15f359SSam Clegg struct WasmFunctionTypeDenseMapInfo { 779e15f359SSam Clegg static WasmFunctionType getEmptyKey() { 789e15f359SSam Clegg WasmFunctionType FuncTy; 799e15f359SSam Clegg FuncTy.State = WasmFunctionType::Empty; 809e15f359SSam Clegg return FuncTy; 819e15f359SSam Clegg } 829e15f359SSam Clegg static WasmFunctionType getTombstoneKey() { 839e15f359SSam Clegg WasmFunctionType FuncTy; 849e15f359SSam Clegg FuncTy.State = WasmFunctionType::Tombstone; 859e15f359SSam Clegg return FuncTy; 869e15f359SSam Clegg } 879e15f359SSam Clegg static unsigned getHashValue(const WasmFunctionType &FuncTy) { 889e15f359SSam Clegg uintptr_t Value = FuncTy.State; 899e15f359SSam Clegg for (wasm::ValType Ret : FuncTy.Returns) 909e15f359SSam Clegg Value += DenseMapInfo<int32_t>::getHashValue(int32_t(Ret)); 919e15f359SSam Clegg for (wasm::ValType Param : FuncTy.Params) 929e15f359SSam Clegg Value += DenseMapInfo<int32_t>::getHashValue(int32_t(Param)); 939e15f359SSam Clegg return Value; 949e15f359SSam Clegg } 959e15f359SSam Clegg static bool isEqual(const WasmFunctionType &LHS, 969e15f359SSam Clegg const WasmFunctionType &RHS) { 979e15f359SSam Clegg return LHS == RHS; 989e15f359SSam Clegg } 999e15f359SSam Clegg }; 1009e15f359SSam Clegg 1017c395943SSam Clegg // A wasm data segment. A wasm binary contains only a single data section 1027c395943SSam Clegg // but that can contain many segments, each with their own virtual location 1037c395943SSam Clegg // in memory. Each MCSection data created by llvm is modeled as its own 1047c395943SSam Clegg // wasm data segment. 1057c395943SSam Clegg struct WasmDataSegment { 1067c395943SSam Clegg MCSectionWasm *Section; 107d95ed959SSam Clegg StringRef Name; 1087c395943SSam Clegg uint32_t Offset; 10963ebb813SSam Clegg uint32_t Alignment; 11063ebb813SSam Clegg uint32_t Flags; 1117c395943SSam Clegg SmallVector<char, 4> Data; 1127c395943SSam Clegg }; 1137c395943SSam Clegg 1149e15f359SSam Clegg // A wasm function to be written into the function section. 1159e15f359SSam Clegg struct WasmFunction { 1169e15f359SSam Clegg int32_t Type; 1179e15f359SSam Clegg const MCSymbolWasm *Sym; 1189e15f359SSam Clegg }; 1199e15f359SSam Clegg 1209e15f359SSam Clegg // A wasm global to be written into the global section. 1219e15f359SSam Clegg struct WasmGlobal { 1226e7f1826SSam Clegg wasm::WasmGlobalType Type; 1239e15f359SSam Clegg uint64_t InitialValue; 1249e15f359SSam Clegg }; 1259e15f359SSam Clegg 126ea7caceeSSam Clegg // Information about a single item which is part of a COMDAT. For each data 127ea7caceeSSam Clegg // segment or function which is in the COMDAT, there is a corresponding 128ea7caceeSSam Clegg // WasmComdatEntry. 129ea7caceeSSam Clegg struct WasmComdatEntry { 130ea7caceeSSam Clegg unsigned Kind; 131ea7caceeSSam Clegg uint32_t Index; 132ea7caceeSSam Clegg }; 133ea7caceeSSam Clegg 1346dc65e91SSam Clegg // Information about a single relocation. 1356dc65e91SSam Clegg struct WasmRelocationEntry { 1366dc65e91SSam Clegg uint64_t Offset; // Where is the relocation. 1376dc65e91SSam Clegg const MCSymbolWasm *Symbol; // The symbol to relocate with. 1386dc65e91SSam Clegg int64_t Addend; // A value to add to the symbol. 1396dc65e91SSam Clegg unsigned Type; // The type of the relocation. 140fe6414b0SSam Clegg const MCSectionWasm *FixupSection;// The section the relocation is targeting. 1416dc65e91SSam Clegg 1426dc65e91SSam Clegg WasmRelocationEntry(uint64_t Offset, const MCSymbolWasm *Symbol, 1436dc65e91SSam Clegg int64_t Addend, unsigned Type, 144fe6414b0SSam Clegg const MCSectionWasm *FixupSection) 1456dc65e91SSam Clegg : Offset(Offset), Symbol(Symbol), Addend(Addend), Type(Type), 1466dc65e91SSam Clegg FixupSection(FixupSection) {} 1476dc65e91SSam Clegg 148acd7d2b0SSam Clegg bool hasAddend() const { 149acd7d2b0SSam Clegg switch (Type) { 15013a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB: 15113a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB: 15213a2e899SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32: 153acd7d2b0SSam Clegg return true; 154acd7d2b0SSam Clegg default: 155acd7d2b0SSam Clegg return false; 156acd7d2b0SSam Clegg } 157acd7d2b0SSam Clegg } 158acd7d2b0SSam Clegg 1596dc65e91SSam Clegg void print(raw_ostream &Out) const { 1609bf73c07SSam Clegg Out << "Off=" << Offset << ", Sym=" << *Symbol << ", Addend=" << Addend 161759631c7SSam Clegg << ", Type=" << Type 162759631c7SSam Clegg << ", FixupSection=" << FixupSection->getSectionName(); 1636dc65e91SSam Clegg } 164b7787fd0SSam Clegg 165615eb470SAaron Ballman #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP) 166b7787fd0SSam Clegg LLVM_DUMP_METHOD void dump() const { print(dbgs()); } 167b7787fd0SSam Clegg #endif 1686dc65e91SSam Clegg }; 1696dc65e91SSam Clegg 1701fb8daa6SSam Clegg #if !defined(NDEBUG) 1717f055deeSSam Clegg raw_ostream &operator<<(raw_ostream &OS, const WasmRelocationEntry &Rel) { 172b7787fd0SSam Clegg Rel.print(OS); 173b7787fd0SSam Clegg return OS; 174b7787fd0SSam Clegg } 1751fb8daa6SSam Clegg #endif 176b7787fd0SSam Clegg 17718eafb6cSDan Gohman class WasmObjectWriter : public MCObjectWriter { 17818eafb6cSDan Gohman /// The target specific Wasm writer instance. 17918eafb6cSDan Gohman std::unique_ptr<MCWasmObjectTargetWriter> TargetObjectWriter; 18018eafb6cSDan Gohman 181d934cb88SDan Gohman // Relocations for fixing up references in the code section. 182d934cb88SDan Gohman std::vector<WasmRelocationEntry> CodeRelocations; 183d934cb88SDan Gohman 184d934cb88SDan Gohman // Relocations for fixing up references in the data section. 185d934cb88SDan Gohman std::vector<WasmRelocationEntry> DataRelocations; 186d934cb88SDan Gohman 187d934cb88SDan Gohman // Index values to use for fixing up call_indirect type indices. 188acd7d2b0SSam Clegg // Maps function symbols to the index of the type of the function 189acd7d2b0SSam Clegg DenseMap<const MCSymbolWasm *, uint32_t> TypeIndices; 190d99f6078SSam Clegg // Maps function symbols to the table element index space. Used 191d99f6078SSam Clegg // for TABLE_INDEX relocation types (i.e. address taken functions). 192f9edbe95SSam Clegg DenseMap<const MCSymbolWasm *, uint32_t> TableIndices; 193d99f6078SSam Clegg // Maps function/global symbols to the function/global index space. 194acd7d2b0SSam Clegg DenseMap<const MCSymbolWasm *, uint32_t> SymbolIndices; 195acd7d2b0SSam Clegg 196acd7d2b0SSam Clegg DenseMap<WasmFunctionType, int32_t, WasmFunctionTypeDenseMapInfo> 197acd7d2b0SSam Clegg FunctionTypeIndices; 1985e3d33a7SSam Clegg SmallVector<WasmFunctionType, 4> FunctionTypes; 1997c395943SSam Clegg SmallVector<WasmGlobal, 4> Globals; 2009f3fe42eSSam Clegg unsigned NumFunctionImports = 0; 2017c395943SSam Clegg unsigned NumGlobalImports = 0; 202d934cb88SDan Gohman 20318eafb6cSDan Gohman // TargetObjectWriter wrappers. 20418eafb6cSDan Gohman bool is64Bit() const { return TargetObjectWriter->is64Bit(); } 205ae03c1e7SSam Clegg unsigned getRelocType(const MCValue &Target, const MCFixup &Fixup) const { 206ae03c1e7SSam Clegg return TargetObjectWriter->getRelocType(Target, Fixup); 20718eafb6cSDan Gohman } 20818eafb6cSDan Gohman 209d934cb88SDan Gohman void startSection(SectionBookkeeping &Section, unsigned SectionId, 210d934cb88SDan Gohman const char *Name = nullptr); 211d934cb88SDan Gohman void endSection(SectionBookkeeping &Section); 212d934cb88SDan Gohman 21318eafb6cSDan Gohman public: 2141301a878SLang Hames WasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW, 2151301a878SLang Hames raw_pwrite_stream &OS) 2161301a878SLang Hames : MCObjectWriter(OS, /*IsLittleEndian=*/true), 2171301a878SLang Hames TargetObjectWriter(std::move(MOTW)) {} 21818eafb6cSDan Gohman 21918eafb6cSDan Gohman ~WasmObjectWriter() override; 22018eafb6cSDan Gohman 2210917c9e4SDan Gohman private: 222acd7d2b0SSam Clegg void reset() override { 223acd7d2b0SSam Clegg CodeRelocations.clear(); 224acd7d2b0SSam Clegg DataRelocations.clear(); 225acd7d2b0SSam Clegg TypeIndices.clear(); 226acd7d2b0SSam Clegg SymbolIndices.clear(); 227f9edbe95SSam Clegg TableIndices.clear(); 228acd7d2b0SSam Clegg FunctionTypeIndices.clear(); 2295e3d33a7SSam Clegg FunctionTypes.clear(); 2307c395943SSam Clegg Globals.clear(); 231acd7d2b0SSam Clegg MCObjectWriter::reset(); 2329f3fe42eSSam Clegg NumFunctionImports = 0; 2337c395943SSam Clegg NumGlobalImports = 0; 234acd7d2b0SSam Clegg } 235acd7d2b0SSam Clegg 23618eafb6cSDan Gohman void writeHeader(const MCAssembler &Asm); 23718eafb6cSDan Gohman 23818eafb6cSDan Gohman void recordRelocation(MCAssembler &Asm, const MCAsmLayout &Layout, 23918eafb6cSDan Gohman const MCFragment *Fragment, const MCFixup &Fixup, 240ceecfe5bSRafael Espindola MCValue Target, uint64_t &FixedValue) override; 24118eafb6cSDan Gohman 24218eafb6cSDan Gohman void executePostLayoutBinding(MCAssembler &Asm, 24318eafb6cSDan Gohman const MCAsmLayout &Layout) override; 24418eafb6cSDan Gohman 24518eafb6cSDan Gohman void writeObject(MCAssembler &Asm, const MCAsmLayout &Layout) override; 2469e15f359SSam Clegg 247b7787fd0SSam Clegg void writeString(const StringRef Str) { 248b7787fd0SSam Clegg encodeULEB128(Str.size(), getStream()); 249b7787fd0SSam Clegg writeBytes(Str); 250b7787fd0SSam Clegg } 251b7787fd0SSam Clegg 2529e15f359SSam Clegg void writeValueType(wasm::ValType Ty) { 2539e15f359SSam Clegg encodeSLEB128(int32_t(Ty), getStream()); 2549e15f359SSam Clegg } 2559e15f359SSam Clegg 256457fb0b4SSam Clegg void writeTypeSection(ArrayRef<WasmFunctionType> FunctionTypes); 2578defa952SSam Clegg void writeImportSection(ArrayRef<wasm::WasmImport> Imports, uint32_t DataSize, 258f950b24aSSam Clegg uint32_t NumElements); 259457fb0b4SSam Clegg void writeFunctionSection(ArrayRef<WasmFunction> Functions); 2607c395943SSam Clegg void writeGlobalSection(); 2618defa952SSam Clegg void writeExportSection(ArrayRef<wasm::WasmExport> Exports); 262457fb0b4SSam Clegg void writeElemSection(ArrayRef<uint32_t> TableElems); 2639e15f359SSam Clegg void writeCodeSection(const MCAssembler &Asm, const MCAsmLayout &Layout, 264457fb0b4SSam Clegg ArrayRef<WasmFunction> Functions); 265457fb0b4SSam Clegg void writeDataSection(ArrayRef<WasmDataSegment> Segments); 266acd7d2b0SSam Clegg void writeCodeRelocSection(); 2677c395943SSam Clegg void writeDataRelocSection(); 26831a2c809SSam Clegg void writeLinkingMetaDataSection( 26931a2c809SSam Clegg ArrayRef<WasmDataSegment> Segments, uint32_t DataSize, 270ea7caceeSSam Clegg ArrayRef<std::pair<StringRef, uint32_t>> SymbolFlags, 271ea7caceeSSam Clegg ArrayRef<std::pair<uint16_t, uint32_t>> InitFuncs, 272ea7caceeSSam Clegg const std::map<StringRef, std::vector<WasmComdatEntry>>& Comdats); 273acd7d2b0SSam Clegg 2747c395943SSam Clegg uint32_t getProvisionalValue(const WasmRelocationEntry &RelEntry); 275acd7d2b0SSam Clegg void applyRelocations(ArrayRef<WasmRelocationEntry> Relocations, 276acd7d2b0SSam Clegg uint64_t ContentsOffset); 277acd7d2b0SSam Clegg 2787c395943SSam Clegg void writeRelocations(ArrayRef<WasmRelocationEntry> Relocations); 279acd7d2b0SSam Clegg uint32_t getRelocationIndexValue(const WasmRelocationEntry &RelEntry); 2805e3d33a7SSam Clegg uint32_t getFunctionType(const MCSymbolWasm& Symbol); 2815e3d33a7SSam Clegg uint32_t registerFunctionType(const MCSymbolWasm& Symbol); 28218eafb6cSDan Gohman }; 2839e15f359SSam Clegg 28418eafb6cSDan Gohman } // end anonymous namespace 28518eafb6cSDan Gohman 28618eafb6cSDan Gohman WasmObjectWriter::~WasmObjectWriter() {} 28718eafb6cSDan Gohman 288d934cb88SDan Gohman // Write out a section header and a patchable section size field. 289d934cb88SDan Gohman void WasmObjectWriter::startSection(SectionBookkeeping &Section, 290d934cb88SDan Gohman unsigned SectionId, 291d934cb88SDan Gohman const char *Name) { 292d934cb88SDan Gohman assert((Name != nullptr) == (SectionId == wasm::WASM_SEC_CUSTOM) && 293d934cb88SDan Gohman "Only custom sections can have names"); 294d934cb88SDan Gohman 295b7787fd0SSam Clegg DEBUG(dbgs() << "startSection " << SectionId << ": " << Name << "\n"); 296e2688c43SDerek Schuff encodeULEB128(SectionId, getStream()); 297d934cb88SDan Gohman 298d934cb88SDan Gohman Section.SizeOffset = getStream().tell(); 299d934cb88SDan Gohman 300d934cb88SDan Gohman // The section size. We don't know the size yet, so reserve enough space 301d934cb88SDan Gohman // for any 32-bit value; we'll patch it later. 302d934cb88SDan Gohman encodeULEB128(UINT32_MAX, getStream()); 303d934cb88SDan Gohman 304d934cb88SDan Gohman // The position where the section starts, for measuring its size. 305d934cb88SDan Gohman Section.ContentsOffset = getStream().tell(); 306d934cb88SDan Gohman 307d934cb88SDan Gohman // Custom sections in wasm also have a string identifier. 308d934cb88SDan Gohman if (SectionId == wasm::WASM_SEC_CUSTOM) { 309b7787fd0SSam Clegg assert(Name); 310b7787fd0SSam Clegg writeString(StringRef(Name)); 311d934cb88SDan Gohman } 312d934cb88SDan Gohman } 313d934cb88SDan Gohman 314d934cb88SDan Gohman // Now that the section is complete and we know how big it is, patch up the 315d934cb88SDan Gohman // section size field at the start of the section. 316d934cb88SDan Gohman void WasmObjectWriter::endSection(SectionBookkeeping &Section) { 317d934cb88SDan Gohman uint64_t Size = getStream().tell() - Section.ContentsOffset; 318d934cb88SDan Gohman if (uint32_t(Size) != Size) 319d934cb88SDan Gohman report_fatal_error("section size does not fit in a uint32_t"); 320d934cb88SDan Gohman 321b7787fd0SSam Clegg DEBUG(dbgs() << "endSection size=" << Size << "\n"); 322d934cb88SDan Gohman 323d934cb88SDan Gohman // Write the final section size to the payload_len field, which follows 324d934cb88SDan Gohman // the section id byte. 325d934cb88SDan Gohman uint8_t Buffer[16]; 32666a99e41SSam Clegg unsigned SizeLen = encodeULEB128(Size, Buffer, 5); 327d934cb88SDan Gohman assert(SizeLen == 5); 328d934cb88SDan Gohman getStream().pwrite((char *)Buffer, SizeLen, Section.SizeOffset); 329d934cb88SDan Gohman } 330d934cb88SDan Gohman 33118eafb6cSDan Gohman // Emit the Wasm header. 33218eafb6cSDan Gohman void WasmObjectWriter::writeHeader(const MCAssembler &Asm) { 3337ea5adffSDan Gohman writeBytes(StringRef(wasm::WasmMagic, sizeof(wasm::WasmMagic))); 3347ea5adffSDan Gohman writeLE32(wasm::WasmVersion); 33518eafb6cSDan Gohman } 33618eafb6cSDan Gohman 33718eafb6cSDan Gohman void WasmObjectWriter::executePostLayoutBinding(MCAssembler &Asm, 33818eafb6cSDan Gohman const MCAsmLayout &Layout) { 33918eafb6cSDan Gohman } 34018eafb6cSDan Gohman 34118eafb6cSDan Gohman void WasmObjectWriter::recordRelocation(MCAssembler &Asm, 34218eafb6cSDan Gohman const MCAsmLayout &Layout, 34318eafb6cSDan Gohman const MCFragment *Fragment, 34418eafb6cSDan Gohman const MCFixup &Fixup, MCValue Target, 345ceecfe5bSRafael Espindola uint64_t &FixedValue) { 346ceecfe5bSRafael Espindola MCAsmBackend &Backend = Asm.getBackend(); 347ceecfe5bSRafael Espindola bool IsPCRel = Backend.getFixupKindInfo(Fixup.getKind()).Flags & 348ceecfe5bSRafael Espindola MCFixupKindInfo::FKF_IsPCRel; 349fe6414b0SSam Clegg const auto &FixupSection = cast<MCSectionWasm>(*Fragment->getParent()); 350d934cb88SDan Gohman uint64_t C = Target.getConstant(); 351d934cb88SDan Gohman uint64_t FixupOffset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset(); 352d934cb88SDan Gohman MCContext &Ctx = Asm.getContext(); 353d934cb88SDan Gohman 354bafe6902SSam Clegg // The .init_array isn't translated as data, so don't do relocations in it. 355bafe6902SSam Clegg if (FixupSection.getSectionName().startswith(".init_array")) 356bafe6902SSam Clegg return; 357bafe6902SSam Clegg 358*b7a5469cSSam Clegg // TODO(sbc): Add support for debug sections. 359*b7a5469cSSam Clegg if (FixupSection.getKind().isMetadata()) 360*b7a5469cSSam Clegg return; 361*b7a5469cSSam Clegg 362d934cb88SDan Gohman if (const MCSymbolRefExpr *RefB = Target.getSymB()) { 363d934cb88SDan Gohman assert(RefB->getKind() == MCSymbolRefExpr::VK_None && 364d934cb88SDan Gohman "Should not have constructed this"); 365d934cb88SDan Gohman 366d934cb88SDan Gohman // Let A, B and C being the components of Target and R be the location of 367d934cb88SDan Gohman // the fixup. If the fixup is not pcrel, we want to compute (A - B + C). 368d934cb88SDan Gohman // If it is pcrel, we want to compute (A - B + C - R). 369d934cb88SDan Gohman 370d934cb88SDan Gohman // In general, Wasm has no relocations for -B. It can only represent (A + C) 371d934cb88SDan Gohman // or (A + C - R). If B = R + K and the relocation is not pcrel, we can 372d934cb88SDan Gohman // replace B to implement it: (A - R - K + C) 373d934cb88SDan Gohman if (IsPCRel) { 374d934cb88SDan Gohman Ctx.reportError( 375d934cb88SDan Gohman Fixup.getLoc(), 376d934cb88SDan Gohman "No relocation available to represent this relative expression"); 377d934cb88SDan Gohman return; 378d934cb88SDan Gohman } 379d934cb88SDan Gohman 380d934cb88SDan Gohman const auto &SymB = cast<MCSymbolWasm>(RefB->getSymbol()); 381d934cb88SDan Gohman 382d934cb88SDan Gohman if (SymB.isUndefined()) { 383d934cb88SDan Gohman Ctx.reportError(Fixup.getLoc(), 384d934cb88SDan Gohman Twine("symbol '") + SymB.getName() + 385d934cb88SDan Gohman "' can not be undefined in a subtraction expression"); 386d934cb88SDan Gohman return; 387d934cb88SDan Gohman } 388d934cb88SDan Gohman 389d934cb88SDan Gohman assert(!SymB.isAbsolute() && "Should have been folded"); 390d934cb88SDan Gohman const MCSection &SecB = SymB.getSection(); 391d934cb88SDan Gohman if (&SecB != &FixupSection) { 392d934cb88SDan Gohman Ctx.reportError(Fixup.getLoc(), 393d934cb88SDan Gohman "Cannot represent a difference across sections"); 394d934cb88SDan Gohman return; 395d934cb88SDan Gohman } 396d934cb88SDan Gohman 397d934cb88SDan Gohman uint64_t SymBOffset = Layout.getSymbolOffset(SymB); 398d934cb88SDan Gohman uint64_t K = SymBOffset - FixupOffset; 399d934cb88SDan Gohman IsPCRel = true; 400d934cb88SDan Gohman C -= K; 401d934cb88SDan Gohman } 402d934cb88SDan Gohman 403d934cb88SDan Gohman // We either rejected the fixup or folded B into C at this point. 404d934cb88SDan Gohman const MCSymbolRefExpr *RefA = Target.getSymA(); 405d934cb88SDan Gohman const auto *SymA = RefA ? cast<MCSymbolWasm>(&RefA->getSymbol()) : nullptr; 406d934cb88SDan Gohman 407d934cb88SDan Gohman if (SymA && SymA->isVariable()) { 408d934cb88SDan Gohman const MCExpr *Expr = SymA->getVariableValue(); 4096ad8f190SSam Clegg const auto *Inner = cast<MCSymbolRefExpr>(Expr); 4106ad8f190SSam Clegg if (Inner->getKind() == MCSymbolRefExpr::VK_WEAKREF) 4116ad8f190SSam Clegg llvm_unreachable("weakref used in reloc not yet implemented"); 412d934cb88SDan Gohman } 413d934cb88SDan Gohman 414d934cb88SDan Gohman // Put any constant offset in an addend. Offsets can be negative, and 415d934cb88SDan Gohman // LLVM expects wrapping, in contrast to wasm's immediates which can't 416d934cb88SDan Gohman // be negative and don't wrap. 417d934cb88SDan Gohman FixedValue = 0; 418d934cb88SDan Gohman 4196ad8f190SSam Clegg if (SymA) 420d934cb88SDan Gohman SymA->setUsedInReloc(); 421d934cb88SDan Gohman 422ae03c1e7SSam Clegg assert(!IsPCRel); 4239d24fb7fSSam Clegg assert(SymA); 4249d24fb7fSSam Clegg 425ae03c1e7SSam Clegg unsigned Type = getRelocType(Target, Fixup); 426ae03c1e7SSam Clegg 427d934cb88SDan Gohman WasmRelocationEntry Rec(FixupOffset, SymA, C, Type, &FixupSection); 428b7787fd0SSam Clegg DEBUG(dbgs() << "WasmReloc: " << Rec << "\n"); 429d934cb88SDan Gohman 430*b7a5469cSSam Clegg // Relocation other than R_WEBASSEMBLY_TYPE_INDEX_LEB are currently required 431*b7a5469cSSam Clegg // to be against a named symbol. 432*b7a5469cSSam Clegg // TODO(sbc): Add support for relocations against unnamed temporaries such 433*b7a5469cSSam Clegg // as those generated by llvm's `blockaddress`. 434*b7a5469cSSam Clegg // See: test/MC/WebAssembly/blockaddress.ll 435*b7a5469cSSam Clegg if (SymA->getName().empty() && Type != wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB) 436*b7a5469cSSam Clegg report_fatal_error("relocations against un-named temporaries are not yet " 437*b7a5469cSSam Clegg "supported by wasm"); 438*b7a5469cSSam Clegg 43912fd3da9SSam Clegg if (FixupSection.isWasmData()) 440d934cb88SDan Gohman DataRelocations.push_back(Rec); 44112fd3da9SSam Clegg else if (FixupSection.getKind().isText()) 44212fd3da9SSam Clegg CodeRelocations.push_back(Rec); 443*b7a5469cSSam Clegg else 44412fd3da9SSam Clegg llvm_unreachable("unexpected section type"); 445d934cb88SDan Gohman } 446d934cb88SDan Gohman 447d934cb88SDan Gohman // Write X as an (unsigned) LEB value at offset Offset in Stream, padded 448d934cb88SDan Gohman // to allow patching. 449d934cb88SDan Gohman static void 450d934cb88SDan Gohman WritePatchableLEB(raw_pwrite_stream &Stream, uint32_t X, uint64_t Offset) { 451d934cb88SDan Gohman uint8_t Buffer[5]; 45266a99e41SSam Clegg unsigned SizeLen = encodeULEB128(X, Buffer, 5); 453d934cb88SDan Gohman assert(SizeLen == 5); 454d934cb88SDan Gohman Stream.pwrite((char *)Buffer, SizeLen, Offset); 455d934cb88SDan Gohman } 456d934cb88SDan Gohman 457d934cb88SDan Gohman // Write X as an signed LEB value at offset Offset in Stream, padded 458d934cb88SDan Gohman // to allow patching. 459d934cb88SDan Gohman static void 460d934cb88SDan Gohman WritePatchableSLEB(raw_pwrite_stream &Stream, int32_t X, uint64_t Offset) { 461d934cb88SDan Gohman uint8_t Buffer[5]; 46266a99e41SSam Clegg unsigned SizeLen = encodeSLEB128(X, Buffer, 5); 463d934cb88SDan Gohman assert(SizeLen == 5); 464d934cb88SDan Gohman Stream.pwrite((char *)Buffer, SizeLen, Offset); 465d934cb88SDan Gohman } 466d934cb88SDan Gohman 467d934cb88SDan Gohman // Write X as a plain integer value at offset Offset in Stream. 468d934cb88SDan Gohman static void WriteI32(raw_pwrite_stream &Stream, uint32_t X, uint64_t Offset) { 469d934cb88SDan Gohman uint8_t Buffer[4]; 470d934cb88SDan Gohman support::endian::write32le(Buffer, X); 471d934cb88SDan Gohman Stream.pwrite((char *)Buffer, sizeof(Buffer), Offset); 472d934cb88SDan Gohman } 473d934cb88SDan Gohman 474aff1c4dfSSam Clegg static const MCSymbolWasm* ResolveSymbol(const MCSymbolWasm& Symbol) { 475aff1c4dfSSam Clegg if (Symbol.isVariable()) { 476aff1c4dfSSam Clegg const MCExpr *Expr = Symbol.getVariableValue(); 477aff1c4dfSSam Clegg auto *Inner = cast<MCSymbolRefExpr>(Expr); 478aff1c4dfSSam Clegg return cast<MCSymbolWasm>(&Inner->getSymbol()); 479aff1c4dfSSam Clegg } 480aff1c4dfSSam Clegg return &Symbol; 481aff1c4dfSSam Clegg } 482aff1c4dfSSam Clegg 483d934cb88SDan Gohman // Compute a value to write into the code at the location covered 48460ec3034SSam Clegg // by RelEntry. This value isn't used by the static linker; it just serves 48560ec3034SSam Clegg // to make the object format more readable and more likely to be directly 48660ec3034SSam Clegg // useable. 4877c395943SSam Clegg uint32_t 4887c395943SSam Clegg WasmObjectWriter::getProvisionalValue(const WasmRelocationEntry &RelEntry) { 48960ec3034SSam Clegg switch (RelEntry.Type) { 49060ec3034SSam Clegg case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB: 491f9edbe95SSam Clegg case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32: { 492f9edbe95SSam Clegg // Provisional value is table address of the resolved symbol itself 493f9edbe95SSam Clegg const MCSymbolWasm *Sym = ResolveSymbol(*RelEntry.Symbol); 494f9edbe95SSam Clegg assert(Sym->isFunction()); 495f9edbe95SSam Clegg return TableIndices[Sym]; 496f9edbe95SSam Clegg } 49760ec3034SSam Clegg case wasm::R_WEBASSEMBLY_FUNCTION_INDEX_LEB: 49860ec3034SSam Clegg case wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB: 49960ec3034SSam Clegg case wasm::R_WEBASSEMBLY_GLOBAL_INDEX_LEB: 500f9edbe95SSam Clegg // Provisional value is function/type/global index itself 50160ec3034SSam Clegg return getRelocationIndexValue(RelEntry); 50260ec3034SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB: 50360ec3034SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32: 50460ec3034SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB: { 505f9edbe95SSam Clegg // Provisional value is address of the global 50660ec3034SSam Clegg const MCSymbolWasm *Sym = ResolveSymbol(*RelEntry.Symbol); 507270ed1b3SSam Clegg // For undefined symbols, use zero 508cd65f698SSam Clegg if (!Sym->isDefined()) 509270ed1b3SSam Clegg return 0; 510d934cb88SDan Gohman 511*b7a5469cSSam Clegg if (!SymbolIndices.count(Sym)) 512*b7a5469cSSam Clegg report_fatal_error("symbol not found in function/global index space: " + 513*b7a5469cSSam Clegg Sym->getName()); 5147c395943SSam Clegg uint32_t GlobalIndex = SymbolIndices[Sym]; 5157c395943SSam Clegg const WasmGlobal& Global = Globals[GlobalIndex - NumGlobalImports]; 5167c395943SSam Clegg uint64_t Address = Global.InitialValue + RelEntry.Addend; 517d934cb88SDan Gohman 518d934cb88SDan Gohman // Ignore overflow. LLVM allows address arithmetic to silently wrap. 51960ec3034SSam Clegg return Address; 52060ec3034SSam Clegg } 52160ec3034SSam Clegg default: 52260ec3034SSam Clegg llvm_unreachable("invalid relocation type"); 52360ec3034SSam Clegg } 524d934cb88SDan Gohman } 525d934cb88SDan Gohman 526759631c7SSam Clegg static void addData(SmallVectorImpl<char> &DataBytes, 52763ebb813SSam Clegg MCSectionWasm &DataSection) { 528759631c7SSam Clegg DEBUG(errs() << "addData: " << DataSection.getSectionName() << "\n"); 529759631c7SSam Clegg 53063ebb813SSam Clegg DataBytes.resize(alignTo(DataBytes.size(), DataSection.getAlignment())); 53163ebb813SSam Clegg 532c55d13f4SSam Clegg size_t LastFragmentSize = 0; 533759631c7SSam Clegg for (const MCFragment &Frag : DataSection) { 534759631c7SSam Clegg if (Frag.hasInstructions()) 535759631c7SSam Clegg report_fatal_error("only data supported in data sections"); 536759631c7SSam Clegg 537759631c7SSam Clegg if (auto *Align = dyn_cast<MCAlignFragment>(&Frag)) { 538759631c7SSam Clegg if (Align->getValueSize() != 1) 539759631c7SSam Clegg report_fatal_error("only byte values supported for alignment"); 540759631c7SSam Clegg // If nops are requested, use zeros, as this is the data section. 541759631c7SSam Clegg uint8_t Value = Align->hasEmitNops() ? 0 : Align->getValue(); 542759631c7SSam Clegg uint64_t Size = std::min<uint64_t>(alignTo(DataBytes.size(), 543759631c7SSam Clegg Align->getAlignment()), 544759631c7SSam Clegg DataBytes.size() + 545759631c7SSam Clegg Align->getMaxBytesToEmit()); 546759631c7SSam Clegg DataBytes.resize(Size, Value); 547759631c7SSam Clegg } else if (auto *Fill = dyn_cast<MCFillFragment>(&Frag)) { 548d707c370SRafael Espindola int64_t Size; 549d707c370SRafael Espindola if (!Fill->getSize().evaluateAsAbsolute(Size)) 550d707c370SRafael Espindola llvm_unreachable("The fill should be an assembler constant"); 551d707c370SRafael Espindola DataBytes.insert(DataBytes.end(), Size, Fill->getValue()); 552759631c7SSam Clegg } else { 553759631c7SSam Clegg const auto &DataFrag = cast<MCDataFragment>(Frag); 554759631c7SSam Clegg const SmallVectorImpl<char> &Contents = DataFrag.getContents(); 555759631c7SSam Clegg 556759631c7SSam Clegg DataBytes.insert(DataBytes.end(), Contents.begin(), Contents.end()); 557c55d13f4SSam Clegg LastFragmentSize = Contents.size(); 558759631c7SSam Clegg } 559759631c7SSam Clegg } 560759631c7SSam Clegg 561c55d13f4SSam Clegg // Don't allow empty segments, or segments that end with zero-sized 562c55d13f4SSam Clegg // fragment, otherwise the linker cannot map symbols to a unique 563c55d13f4SSam Clegg // data segment. This can be triggered by zero-sized structs 564c55d13f4SSam Clegg // See: test/MC/WebAssembly/bss.ll 565c55d13f4SSam Clegg if (LastFragmentSize == 0) 566c55d13f4SSam Clegg DataBytes.resize(DataBytes.size() + 1); 567759631c7SSam Clegg DEBUG(dbgs() << "addData -> " << DataBytes.size() << "\n"); 568759631c7SSam Clegg } 569759631c7SSam Clegg 57060ec3034SSam Clegg uint32_t 57160ec3034SSam Clegg WasmObjectWriter::getRelocationIndexValue(const WasmRelocationEntry &RelEntry) { 57260ec3034SSam Clegg if (RelEntry.Type == wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB) { 573b7787fd0SSam Clegg if (!TypeIndices.count(RelEntry.Symbol)) 574b7787fd0SSam Clegg report_fatal_error("symbol not found in type index space: " + 575b7787fd0SSam Clegg RelEntry.Symbol->getName()); 576acd7d2b0SSam Clegg return TypeIndices[RelEntry.Symbol]; 577acd7d2b0SSam Clegg } 57860ec3034SSam Clegg 57960ec3034SSam Clegg if (!SymbolIndices.count(RelEntry.Symbol)) 58060ec3034SSam Clegg report_fatal_error("symbol not found in function/global index space: " + 58160ec3034SSam Clegg RelEntry.Symbol->getName()); 58260ec3034SSam Clegg return SymbolIndices[RelEntry.Symbol]; 583acd7d2b0SSam Clegg } 584acd7d2b0SSam Clegg 585d934cb88SDan Gohman // Apply the portions of the relocation records that we can handle ourselves 586d934cb88SDan Gohman // directly. 587acd7d2b0SSam Clegg void WasmObjectWriter::applyRelocations( 588acd7d2b0SSam Clegg ArrayRef<WasmRelocationEntry> Relocations, uint64_t ContentsOffset) { 589acd7d2b0SSam Clegg raw_pwrite_stream &Stream = getStream(); 590d934cb88SDan Gohman for (const WasmRelocationEntry &RelEntry : Relocations) { 591d934cb88SDan Gohman uint64_t Offset = ContentsOffset + 592d934cb88SDan Gohman RelEntry.FixupSection->getSectionOffset() + 593d934cb88SDan Gohman RelEntry.Offset; 594d934cb88SDan Gohman 595b7787fd0SSam Clegg DEBUG(dbgs() << "applyRelocation: " << RelEntry << "\n"); 59660ec3034SSam Clegg uint32_t Value = getProvisionalValue(RelEntry); 59760ec3034SSam Clegg 598acd7d2b0SSam Clegg switch (RelEntry.Type) { 599acd7d2b0SSam Clegg case wasm::R_WEBASSEMBLY_FUNCTION_INDEX_LEB: 6009d24fb7fSSam Clegg case wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB: 60160ec3034SSam Clegg case wasm::R_WEBASSEMBLY_GLOBAL_INDEX_LEB: 60260ec3034SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB: 603d934cb88SDan Gohman WritePatchableLEB(Stream, Value, Offset); 604d934cb88SDan Gohman break; 60560ec3034SSam Clegg case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32: 60660ec3034SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32: 607d934cb88SDan Gohman WriteI32(Stream, Value, Offset); 608d934cb88SDan Gohman break; 60960ec3034SSam Clegg case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB: 61060ec3034SSam Clegg case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB: 61160ec3034SSam Clegg WritePatchableSLEB(Stream, Value, Offset); 61260ec3034SSam Clegg break; 613d934cb88SDan Gohman default: 6149d24fb7fSSam Clegg llvm_unreachable("invalid relocation type"); 615d934cb88SDan Gohman } 616d934cb88SDan Gohman } 61718eafb6cSDan Gohman } 61818eafb6cSDan Gohman 619acd7d2b0SSam Clegg // Write out the portions of the relocation records that the linker will 620970d02c4SDan Gohman // need to handle. 621acd7d2b0SSam Clegg void WasmObjectWriter::writeRelocations( 6227c395943SSam Clegg ArrayRef<WasmRelocationEntry> Relocations) { 623acd7d2b0SSam Clegg raw_pwrite_stream &Stream = getStream(); 624acd7d2b0SSam Clegg for (const WasmRelocationEntry& RelEntry : Relocations) { 625970d02c4SDan Gohman 626acd7d2b0SSam Clegg uint64_t Offset = RelEntry.Offset + 6277c395943SSam Clegg RelEntry.FixupSection->getSectionOffset(); 628acd7d2b0SSam Clegg uint32_t Index = getRelocationIndexValue(RelEntry); 629970d02c4SDan Gohman 630acd7d2b0SSam Clegg encodeULEB128(RelEntry.Type, Stream); 631970d02c4SDan Gohman encodeULEB128(Offset, Stream); 632acd7d2b0SSam Clegg encodeULEB128(Index, Stream); 633acd7d2b0SSam Clegg if (RelEntry.hasAddend()) 634acd7d2b0SSam Clegg encodeSLEB128(RelEntry.Addend, Stream); 635970d02c4SDan Gohman } 636970d02c4SDan Gohman } 637970d02c4SDan Gohman 6389e15f359SSam Clegg void WasmObjectWriter::writeTypeSection( 639457fb0b4SSam Clegg ArrayRef<WasmFunctionType> FunctionTypes) { 6409e15f359SSam Clegg if (FunctionTypes.empty()) 6419e15f359SSam Clegg return; 6429e15f359SSam Clegg 6439e15f359SSam Clegg SectionBookkeeping Section; 6449e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_TYPE); 6459e15f359SSam Clegg 6469e15f359SSam Clegg encodeULEB128(FunctionTypes.size(), getStream()); 6479e15f359SSam Clegg 6489e15f359SSam Clegg for (const WasmFunctionType &FuncTy : FunctionTypes) { 6499e15f359SSam Clegg encodeSLEB128(wasm::WASM_TYPE_FUNC, getStream()); 6509e15f359SSam Clegg encodeULEB128(FuncTy.Params.size(), getStream()); 6519e15f359SSam Clegg for (wasm::ValType Ty : FuncTy.Params) 6529e15f359SSam Clegg writeValueType(Ty); 6539e15f359SSam Clegg encodeULEB128(FuncTy.Returns.size(), getStream()); 6549e15f359SSam Clegg for (wasm::ValType Ty : FuncTy.Returns) 6559e15f359SSam Clegg writeValueType(Ty); 6569e15f359SSam Clegg } 6579e15f359SSam Clegg 6589e15f359SSam Clegg endSection(Section); 6599e15f359SSam Clegg } 6609e15f359SSam Clegg 6618defa952SSam Clegg void WasmObjectWriter::writeImportSection(ArrayRef<wasm::WasmImport> Imports, 662f950b24aSSam Clegg uint32_t DataSize, 663f950b24aSSam Clegg uint32_t NumElements) { 6649e15f359SSam Clegg if (Imports.empty()) 6659e15f359SSam Clegg return; 6669e15f359SSam Clegg 667f950b24aSSam Clegg uint32_t NumPages = (DataSize + wasm::WasmPageSize - 1) / wasm::WasmPageSize; 668f950b24aSSam Clegg 6699e15f359SSam Clegg SectionBookkeeping Section; 6709e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_IMPORT); 6719e15f359SSam Clegg 6729e15f359SSam Clegg encodeULEB128(Imports.size(), getStream()); 6738defa952SSam Clegg for (const wasm::WasmImport &Import : Imports) { 6748defa952SSam Clegg writeString(Import.Module); 6758defa952SSam Clegg writeString(Import.Field); 6769e15f359SSam Clegg encodeULEB128(Import.Kind, getStream()); 6779e15f359SSam Clegg 6789e15f359SSam Clegg switch (Import.Kind) { 6799e15f359SSam Clegg case wasm::WASM_EXTERNAL_FUNCTION: 6808defa952SSam Clegg encodeULEB128(Import.SigIndex, getStream()); 6819e15f359SSam Clegg break; 6829e15f359SSam Clegg case wasm::WASM_EXTERNAL_GLOBAL: 6838defa952SSam Clegg encodeSLEB128(Import.Global.Type, getStream()); 6848defa952SSam Clegg encodeULEB128(uint32_t(Import.Global.Mutable), getStream()); 6859e15f359SSam Clegg break; 686f950b24aSSam Clegg case wasm::WASM_EXTERNAL_MEMORY: 687f950b24aSSam Clegg encodeULEB128(0, getStream()); // flags 688f950b24aSSam Clegg encodeULEB128(NumPages, getStream()); // initial 689f950b24aSSam Clegg break; 690f950b24aSSam Clegg case wasm::WASM_EXTERNAL_TABLE: 6918defa952SSam Clegg encodeSLEB128(Import.Table.ElemType, getStream()); 692f950b24aSSam Clegg encodeULEB128(0, getStream()); // flags 693f950b24aSSam Clegg encodeULEB128(NumElements, getStream()); // initial 694f950b24aSSam Clegg break; 6959e15f359SSam Clegg default: 6969e15f359SSam Clegg llvm_unreachable("unsupported import kind"); 6979e15f359SSam Clegg } 6989e15f359SSam Clegg } 6999e15f359SSam Clegg 7009e15f359SSam Clegg endSection(Section); 7019e15f359SSam Clegg } 7029e15f359SSam Clegg 703457fb0b4SSam Clegg void WasmObjectWriter::writeFunctionSection(ArrayRef<WasmFunction> Functions) { 7049e15f359SSam Clegg if (Functions.empty()) 7059e15f359SSam Clegg return; 7069e15f359SSam Clegg 7079e15f359SSam Clegg SectionBookkeeping Section; 7089e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_FUNCTION); 7099e15f359SSam Clegg 7109e15f359SSam Clegg encodeULEB128(Functions.size(), getStream()); 7119e15f359SSam Clegg for (const WasmFunction &Func : Functions) 7129e15f359SSam Clegg encodeULEB128(Func.Type, getStream()); 7139e15f359SSam Clegg 7149e15f359SSam Clegg endSection(Section); 7159e15f359SSam Clegg } 7169e15f359SSam Clegg 7177c395943SSam Clegg void WasmObjectWriter::writeGlobalSection() { 7189e15f359SSam Clegg if (Globals.empty()) 7199e15f359SSam Clegg return; 7209e15f359SSam Clegg 7219e15f359SSam Clegg SectionBookkeeping Section; 7229e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_GLOBAL); 7239e15f359SSam Clegg 7249e15f359SSam Clegg encodeULEB128(Globals.size(), getStream()); 7259e15f359SSam Clegg for (const WasmGlobal &Global : Globals) { 7266e7f1826SSam Clegg writeValueType(static_cast<wasm::ValType>(Global.Type.Type)); 7276e7f1826SSam Clegg write8(Global.Type.Mutable); 7289e15f359SSam Clegg 7299e15f359SSam Clegg write8(wasm::WASM_OPCODE_I32_CONST); 7306e7f1826SSam Clegg encodeSLEB128(Global.InitialValue, getStream()); 7319e15f359SSam Clegg write8(wasm::WASM_OPCODE_END); 7329e15f359SSam Clegg } 7339e15f359SSam Clegg 7349e15f359SSam Clegg endSection(Section); 7359e15f359SSam Clegg } 7369e15f359SSam Clegg 7378defa952SSam Clegg void WasmObjectWriter::writeExportSection(ArrayRef<wasm::WasmExport> Exports) { 7389e15f359SSam Clegg if (Exports.empty()) 7399e15f359SSam Clegg return; 7409e15f359SSam Clegg 7419e15f359SSam Clegg SectionBookkeeping Section; 7429e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_EXPORT); 7439e15f359SSam Clegg 7449e15f359SSam Clegg encodeULEB128(Exports.size(), getStream()); 7458defa952SSam Clegg for (const wasm::WasmExport &Export : Exports) { 7468defa952SSam Clegg writeString(Export.Name); 7479e15f359SSam Clegg encodeSLEB128(Export.Kind, getStream()); 7489e15f359SSam Clegg encodeULEB128(Export.Index, getStream()); 7499e15f359SSam Clegg } 7509e15f359SSam Clegg 7519e15f359SSam Clegg endSection(Section); 7529e15f359SSam Clegg } 7539e15f359SSam Clegg 754457fb0b4SSam Clegg void WasmObjectWriter::writeElemSection(ArrayRef<uint32_t> TableElems) { 7559e15f359SSam Clegg if (TableElems.empty()) 7569e15f359SSam Clegg return; 7579e15f359SSam Clegg 7589e15f359SSam Clegg SectionBookkeeping Section; 7599e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_ELEM); 7609e15f359SSam Clegg 7619e15f359SSam Clegg encodeULEB128(1, getStream()); // number of "segments" 7629e15f359SSam Clegg encodeULEB128(0, getStream()); // the table index 7639e15f359SSam Clegg 7649e15f359SSam Clegg // init expr for starting offset 7659e15f359SSam Clegg write8(wasm::WASM_OPCODE_I32_CONST); 76630e1bbc1SSam Clegg encodeSLEB128(kInitialTableOffset, getStream()); 7679e15f359SSam Clegg write8(wasm::WASM_OPCODE_END); 7689e15f359SSam Clegg 7699e15f359SSam Clegg encodeULEB128(TableElems.size(), getStream()); 7709e15f359SSam Clegg for (uint32_t Elem : TableElems) 7719e15f359SSam Clegg encodeULEB128(Elem, getStream()); 7729e15f359SSam Clegg 7739e15f359SSam Clegg endSection(Section); 7749e15f359SSam Clegg } 7759e15f359SSam Clegg 776457fb0b4SSam Clegg void WasmObjectWriter::writeCodeSection(const MCAssembler &Asm, 777457fb0b4SSam Clegg const MCAsmLayout &Layout, 778457fb0b4SSam Clegg ArrayRef<WasmFunction> Functions) { 7799e15f359SSam Clegg if (Functions.empty()) 7809e15f359SSam Clegg return; 7819e15f359SSam Clegg 7829e15f359SSam Clegg SectionBookkeeping Section; 7839e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_CODE); 7849e15f359SSam Clegg 7859e15f359SSam Clegg encodeULEB128(Functions.size(), getStream()); 7869e15f359SSam Clegg 7879e15f359SSam Clegg for (const WasmFunction &Func : Functions) { 788fe6414b0SSam Clegg auto &FuncSection = static_cast<MCSectionWasm &>(Func.Sym->getSection()); 7899e15f359SSam Clegg 7909e15f359SSam Clegg int64_t Size = 0; 7919e15f359SSam Clegg if (!Func.Sym->getSize()->evaluateAsAbsolute(Size, Layout)) 7929e15f359SSam Clegg report_fatal_error(".size expression must be evaluatable"); 7939e15f359SSam Clegg 7949e15f359SSam Clegg encodeULEB128(Size, getStream()); 795fe6414b0SSam Clegg FuncSection.setSectionOffset(getStream().tell() - Section.ContentsOffset); 7969e15f359SSam Clegg Asm.writeSectionData(&FuncSection, Layout); 7979e15f359SSam Clegg } 7989e15f359SSam Clegg 7999e15f359SSam Clegg // Apply fixups. 800acd7d2b0SSam Clegg applyRelocations(CodeRelocations, Section.ContentsOffset); 8019e15f359SSam Clegg 8029e15f359SSam Clegg endSection(Section); 8039e15f359SSam Clegg } 8049e15f359SSam Clegg 805457fb0b4SSam Clegg void WasmObjectWriter::writeDataSection(ArrayRef<WasmDataSegment> Segments) { 8067c395943SSam Clegg if (Segments.empty()) 8077c395943SSam Clegg return; 8089e15f359SSam Clegg 8099e15f359SSam Clegg SectionBookkeeping Section; 8109e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_DATA); 8119e15f359SSam Clegg 8127c395943SSam Clegg encodeULEB128(Segments.size(), getStream()); // count 8137c395943SSam Clegg 8147c395943SSam Clegg for (const WasmDataSegment & Segment : Segments) { 8159e15f359SSam Clegg encodeULEB128(0, getStream()); // memory index 8169e15f359SSam Clegg write8(wasm::WASM_OPCODE_I32_CONST); 8177c395943SSam Clegg encodeSLEB128(Segment.Offset, getStream()); // offset 8189e15f359SSam Clegg write8(wasm::WASM_OPCODE_END); 8197c395943SSam Clegg encodeULEB128(Segment.Data.size(), getStream()); // size 8207c395943SSam Clegg Segment.Section->setSectionOffset(getStream().tell() - Section.ContentsOffset); 8217c395943SSam Clegg writeBytes(Segment.Data); // data 8227c395943SSam Clegg } 8239e15f359SSam Clegg 8249e15f359SSam Clegg // Apply fixups. 8257c395943SSam Clegg applyRelocations(DataRelocations, Section.ContentsOffset); 8269e15f359SSam Clegg 8279e15f359SSam Clegg endSection(Section); 8289e15f359SSam Clegg } 8299e15f359SSam Clegg 830acd7d2b0SSam Clegg void WasmObjectWriter::writeCodeRelocSection() { 8319e15f359SSam Clegg // See: https://github.com/WebAssembly/tool-conventions/blob/master/Linking.md 8329e15f359SSam Clegg // for descriptions of the reloc sections. 8339e15f359SSam Clegg 8349e15f359SSam Clegg if (CodeRelocations.empty()) 8359e15f359SSam Clegg return; 8369e15f359SSam Clegg 8379e15f359SSam Clegg SectionBookkeeping Section; 8389e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_CUSTOM, "reloc.CODE"); 8399e15f359SSam Clegg 8409e15f359SSam Clegg encodeULEB128(wasm::WASM_SEC_CODE, getStream()); 841acd7d2b0SSam Clegg encodeULEB128(CodeRelocations.size(), getStream()); 8429e15f359SSam Clegg 8437c395943SSam Clegg writeRelocations(CodeRelocations); 8449e15f359SSam Clegg 8459e15f359SSam Clegg endSection(Section); 8469e15f359SSam Clegg } 8479e15f359SSam Clegg 8487c395943SSam Clegg void WasmObjectWriter::writeDataRelocSection() { 8499e15f359SSam Clegg // See: https://github.com/WebAssembly/tool-conventions/blob/master/Linking.md 8509e15f359SSam Clegg // for descriptions of the reloc sections. 8519e15f359SSam Clegg 8529e15f359SSam Clegg if (DataRelocations.empty()) 8539e15f359SSam Clegg return; 8549e15f359SSam Clegg 8559e15f359SSam Clegg SectionBookkeeping Section; 8569e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_CUSTOM, "reloc.DATA"); 8579e15f359SSam Clegg 8589e15f359SSam Clegg encodeULEB128(wasm::WASM_SEC_DATA, getStream()); 8599e15f359SSam Clegg encodeULEB128(DataRelocations.size(), getStream()); 8609e15f359SSam Clegg 8617c395943SSam Clegg writeRelocations(DataRelocations); 8629e15f359SSam Clegg 8639e15f359SSam Clegg endSection(Section); 8649e15f359SSam Clegg } 8659e15f359SSam Clegg 8669e15f359SSam Clegg void WasmObjectWriter::writeLinkingMetaDataSection( 867d95ed959SSam Clegg ArrayRef<WasmDataSegment> Segments, uint32_t DataSize, 868ea7caceeSSam Clegg ArrayRef<std::pair<StringRef, uint32_t>> SymbolFlags, 869ea7caceeSSam Clegg ArrayRef<std::pair<uint16_t, uint32_t>> InitFuncs, 870ea7caceeSSam Clegg const std::map<StringRef, std::vector<WasmComdatEntry>>& Comdats) { 8719e15f359SSam Clegg SectionBookkeeping Section; 8729e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_CUSTOM, "linking"); 873b7787fd0SSam Clegg SectionBookkeeping SubSection; 8749e15f359SSam Clegg 87531a2c809SSam Clegg if (SymbolFlags.size() != 0) { 876b7787fd0SSam Clegg startSection(SubSection, wasm::WASM_SYMBOL_INFO); 87731a2c809SSam Clegg encodeULEB128(SymbolFlags.size(), getStream()); 87831a2c809SSam Clegg for (auto Pair: SymbolFlags) { 87931a2c809SSam Clegg writeString(Pair.first); 88031a2c809SSam Clegg encodeULEB128(Pair.second, getStream()); 881b7787fd0SSam Clegg } 882b7787fd0SSam Clegg endSection(SubSection); 883b7787fd0SSam Clegg } 8849e15f359SSam Clegg 8859e1ade93SSam Clegg if (DataSize > 0) { 8869e1ade93SSam Clegg startSection(SubSection, wasm::WASM_DATA_SIZE); 8879e1ade93SSam Clegg encodeULEB128(DataSize, getStream()); 8889e1ade93SSam Clegg endSection(SubSection); 8899e1ade93SSam Clegg } 8909e1ade93SSam Clegg 891d95ed959SSam Clegg if (Segments.size()) { 89263ebb813SSam Clegg startSection(SubSection, wasm::WASM_SEGMENT_INFO); 893d95ed959SSam Clegg encodeULEB128(Segments.size(), getStream()); 89463ebb813SSam Clegg for (const WasmDataSegment &Segment : Segments) { 895d95ed959SSam Clegg writeString(Segment.Name); 89663ebb813SSam Clegg encodeULEB128(Segment.Alignment, getStream()); 89763ebb813SSam Clegg encodeULEB128(Segment.Flags, getStream()); 89863ebb813SSam Clegg } 899d95ed959SSam Clegg endSection(SubSection); 900d95ed959SSam Clegg } 901d95ed959SSam Clegg 902bafe6902SSam Clegg if (!InitFuncs.empty()) { 903bafe6902SSam Clegg startSection(SubSection, wasm::WASM_INIT_FUNCS); 904bafe6902SSam Clegg encodeULEB128(InitFuncs.size(), getStream()); 905bafe6902SSam Clegg for (auto &StartFunc : InitFuncs) { 906bafe6902SSam Clegg encodeULEB128(StartFunc.first, getStream()); // priority 907bafe6902SSam Clegg encodeULEB128(StartFunc.second, getStream()); // function index 908bafe6902SSam Clegg } 909bafe6902SSam Clegg endSection(SubSection); 910bafe6902SSam Clegg } 911bafe6902SSam Clegg 912ea7caceeSSam Clegg if (Comdats.size()) { 913ea7caceeSSam Clegg startSection(SubSection, wasm::WASM_COMDAT_INFO); 914ea7caceeSSam Clegg encodeULEB128(Comdats.size(), getStream()); 915ea7caceeSSam Clegg for (const auto &C : Comdats) { 916ea7caceeSSam Clegg writeString(C.first); 917ea7caceeSSam Clegg encodeULEB128(0, getStream()); // flags for future use 918ea7caceeSSam Clegg encodeULEB128(C.second.size(), getStream()); 919ea7caceeSSam Clegg for (const WasmComdatEntry &Entry : C.second) { 920ea7caceeSSam Clegg encodeULEB128(Entry.Kind, getStream()); 921ea7caceeSSam Clegg encodeULEB128(Entry.Index, getStream()); 922ea7caceeSSam Clegg } 923ea7caceeSSam Clegg } 924ea7caceeSSam Clegg endSection(SubSection); 925ea7caceeSSam Clegg } 926ea7caceeSSam Clegg 9279e15f359SSam Clegg endSection(Section); 9289e15f359SSam Clegg } 9299e15f359SSam Clegg 9305e3d33a7SSam Clegg uint32_t WasmObjectWriter::getFunctionType(const MCSymbolWasm& Symbol) { 9315e3d33a7SSam Clegg assert(Symbol.isFunction()); 9325e3d33a7SSam Clegg assert(TypeIndices.count(&Symbol)); 9335e3d33a7SSam Clegg return TypeIndices[&Symbol]; 9345e3d33a7SSam Clegg } 9355e3d33a7SSam Clegg 9365e3d33a7SSam Clegg uint32_t WasmObjectWriter::registerFunctionType(const MCSymbolWasm& Symbol) { 9375e3d33a7SSam Clegg assert(Symbol.isFunction()); 9385e3d33a7SSam Clegg 9395e3d33a7SSam Clegg WasmFunctionType F; 940aff1c4dfSSam Clegg const MCSymbolWasm* ResolvedSym = ResolveSymbol(Symbol); 9415e3d33a7SSam Clegg F.Returns = ResolvedSym->getReturns(); 9425e3d33a7SSam Clegg F.Params = ResolvedSym->getParams(); 9435e3d33a7SSam Clegg 9445e3d33a7SSam Clegg auto Pair = 9455e3d33a7SSam Clegg FunctionTypeIndices.insert(std::make_pair(F, FunctionTypes.size())); 9465e3d33a7SSam Clegg if (Pair.second) 9475e3d33a7SSam Clegg FunctionTypes.push_back(F); 9485e3d33a7SSam Clegg TypeIndices[&Symbol] = Pair.first->second; 9495e3d33a7SSam Clegg 9505e3d33a7SSam Clegg DEBUG(dbgs() << "registerFunctionType: " << Symbol << " new:" << Pair.second << "\n"); 9515e3d33a7SSam Clegg DEBUG(dbgs() << " -> type index: " << Pair.first->second << "\n"); 9525e3d33a7SSam Clegg return Pair.first->second; 9535e3d33a7SSam Clegg } 9545e3d33a7SSam Clegg 95518eafb6cSDan Gohman void WasmObjectWriter::writeObject(MCAssembler &Asm, 95618eafb6cSDan Gohman const MCAsmLayout &Layout) { 957b7787fd0SSam Clegg DEBUG(dbgs() << "WasmObjectWriter::writeObject\n"); 95882607f56SDan Gohman MCContext &Ctx = Asm.getContext(); 9596e7f1826SSam Clegg int32_t PtrType = is64Bit() ? wasm::WASM_TYPE_I64 : wasm::WASM_TYPE_I32; 960d934cb88SDan Gohman 961d934cb88SDan Gohman // Collect information from the available symbols. 962d934cb88SDan Gohman SmallVector<WasmFunction, 4> Functions; 963d934cb88SDan Gohman SmallVector<uint32_t, 4> TableElems; 9648defa952SSam Clegg SmallVector<wasm::WasmImport, 4> Imports; 9658defa952SSam Clegg SmallVector<wasm::WasmExport, 4> Exports; 96631a2c809SSam Clegg SmallVector<std::pair<StringRef, uint32_t>, 4> SymbolFlags; 967bafe6902SSam Clegg SmallVector<std::pair<uint16_t, uint32_t>, 2> InitFuncs; 968ea7caceeSSam Clegg std::map<StringRef, std::vector<WasmComdatEntry>> Comdats; 9697c395943SSam Clegg SmallVector<WasmDataSegment, 4> DataSegments; 9707c395943SSam Clegg uint32_t DataSize = 0; 971d934cb88SDan Gohman 972f950b24aSSam Clegg // For now, always emit the memory import, since loads and stores are not 973f950b24aSSam Clegg // valid without it. In the future, we could perhaps be more clever and omit 974f950b24aSSam Clegg // it if there are no loads or stores. 975f950b24aSSam Clegg MCSymbolWasm *MemorySym = 976f950b24aSSam Clegg cast<MCSymbolWasm>(Ctx.getOrCreateSymbol("__linear_memory")); 9778defa952SSam Clegg wasm::WasmImport MemImport; 9788defa952SSam Clegg MemImport.Module = MemorySym->getModuleName(); 9798defa952SSam Clegg MemImport.Field = MemorySym->getName(); 980f950b24aSSam Clegg MemImport.Kind = wasm::WASM_EXTERNAL_MEMORY; 981f950b24aSSam Clegg Imports.push_back(MemImport); 982f950b24aSSam Clegg 983f950b24aSSam Clegg // For now, always emit the table section, since indirect calls are not 984f950b24aSSam Clegg // valid without it. In the future, we could perhaps be more clever and omit 985f950b24aSSam Clegg // it if there are no indirect calls. 986f950b24aSSam Clegg MCSymbolWasm *TableSym = 987f950b24aSSam Clegg cast<MCSymbolWasm>(Ctx.getOrCreateSymbol("__indirect_function_table")); 9888defa952SSam Clegg wasm::WasmImport TableImport; 9898defa952SSam Clegg TableImport.Module = TableSym->getModuleName(); 9908defa952SSam Clegg TableImport.Field = TableSym->getName(); 991f950b24aSSam Clegg TableImport.Kind = wasm::WASM_EXTERNAL_TABLE; 9928defa952SSam Clegg TableImport.Table.ElemType = wasm::WASM_TYPE_ANYFUNC; 993f950b24aSSam Clegg Imports.push_back(TableImport); 994f950b24aSSam Clegg 99532ce5ca0SDan Gohman // Populate FunctionTypeIndices and Imports. 99632ce5ca0SDan Gohman for (const MCSymbol &S : Asm.symbols()) { 99732ce5ca0SDan Gohman const auto &WS = static_cast<const MCSymbolWasm &>(S); 99832ce5ca0SDan Gohman 99932ce5ca0SDan Gohman // Register types for all functions, including those with private linkage 10009f3fe42eSSam Clegg // (because wasm always needs a type signature). 100132ce5ca0SDan Gohman if (WS.isFunction()) 100232ce5ca0SDan Gohman registerFunctionType(WS); 100332ce5ca0SDan Gohman 100432ce5ca0SDan Gohman if (WS.isTemporary()) 100532ce5ca0SDan Gohman continue; 100632ce5ca0SDan Gohman 100732ce5ca0SDan Gohman // If the symbol is not defined in this translation unit, import it. 1008cd65f698SSam Clegg if ((!WS.isDefined() && !WS.isComdat()) || 1009d423f0d2SSam Clegg WS.isVariable()) { 10108defa952SSam Clegg wasm::WasmImport Import; 10118defa952SSam Clegg Import.Module = WS.getModuleName(); 10128defa952SSam Clegg Import.Field = WS.getName(); 101332ce5ca0SDan Gohman 101432ce5ca0SDan Gohman if (WS.isFunction()) { 101532ce5ca0SDan Gohman Import.Kind = wasm::WASM_EXTERNAL_FUNCTION; 10168defa952SSam Clegg Import.SigIndex = getFunctionType(WS); 10179f3fe42eSSam Clegg SymbolIndices[&WS] = NumFunctionImports; 10189f3fe42eSSam Clegg ++NumFunctionImports; 101932ce5ca0SDan Gohman } else { 102032ce5ca0SDan Gohman Import.Kind = wasm::WASM_EXTERNAL_GLOBAL; 10218defa952SSam Clegg Import.Global.Type = PtrType; 102283b16226SDan Gohman // If this global is the stack pointer, make it mutable. 1023ad19047dSDan Gohman if (WS.getName() == "__stack_pointer") 10248defa952SSam Clegg Import.Global.Mutable = true; 10258defa952SSam Clegg else 10268defa952SSam Clegg Import.Global.Mutable = false; 102732ce5ca0SDan Gohman 10288defa952SSam Clegg SymbolIndices[&WS] = NumGlobalImports; 102932ce5ca0SDan Gohman ++NumGlobalImports; 103032ce5ca0SDan Gohman } 103132ce5ca0SDan Gohman 103232ce5ca0SDan Gohman Imports.push_back(Import); 103332ce5ca0SDan Gohman } 103432ce5ca0SDan Gohman } 103532ce5ca0SDan Gohman 1036759631c7SSam Clegg for (MCSection &Sec : Asm) { 1037759631c7SSam Clegg auto &Section = static_cast<MCSectionWasm &>(Sec); 103812fd3da9SSam Clegg if (!Section.isWasmData()) 1039759631c7SSam Clegg continue; 1040759631c7SSam Clegg 1041bafe6902SSam Clegg // .init_array sections are handled specially elsewhere. 1042bafe6902SSam Clegg if (cast<MCSectionWasm>(Sec).getSectionName().startswith(".init_array")) 1043bafe6902SSam Clegg continue; 1044bafe6902SSam Clegg 1045329e76d5SSam Clegg uint32_t SegmentIndex = DataSegments.size(); 1046759631c7SSam Clegg DataSize = alignTo(DataSize, Section.getAlignment()); 1047759631c7SSam Clegg DataSegments.emplace_back(); 1048759631c7SSam Clegg WasmDataSegment &Segment = DataSegments.back(); 1049d95ed959SSam Clegg Segment.Name = Section.getSectionName(); 1050759631c7SSam Clegg Segment.Offset = DataSize; 1051759631c7SSam Clegg Segment.Section = &Section; 105263ebb813SSam Clegg addData(Segment.Data, Section); 105363ebb813SSam Clegg Segment.Alignment = Section.getAlignment(); 105463ebb813SSam Clegg Segment.Flags = 0; 1055759631c7SSam Clegg DataSize += Segment.Data.size(); 1056759631c7SSam Clegg Section.setMemoryOffset(Segment.Offset); 1057ea7caceeSSam Clegg 1058ea7caceeSSam Clegg if (const MCSymbolWasm *C = Section.getGroup()) { 1059ea7caceeSSam Clegg Comdats[C->getName()].emplace_back( 1060329e76d5SSam Clegg WasmComdatEntry{wasm::WASM_COMDAT_DATA, SegmentIndex}); 1061ea7caceeSSam Clegg } 1062759631c7SSam Clegg } 1063759631c7SSam Clegg 1064b7787fd0SSam Clegg // Handle regular defined and undefined symbols. 1065d934cb88SDan Gohman for (const MCSymbol &S : Asm.symbols()) { 1066d934cb88SDan Gohman // Ignore unnamed temporary symbols, which aren't ever exported, imported, 1067d934cb88SDan Gohman // or used in relocations. 1068d934cb88SDan Gohman if (S.isTemporary() && S.getName().empty()) 1069d934cb88SDan Gohman continue; 1070b7787fd0SSam Clegg 1071d934cb88SDan Gohman const auto &WS = static_cast<const MCSymbolWasm &>(S); 1072b7787fd0SSam Clegg DEBUG(dbgs() << "MCSymbol: '" << S << "'" 1073329e76d5SSam Clegg << " isDefined=" << S.isDefined() 1074329e76d5SSam Clegg << " isExternal=" << S.isExternal() 1075329e76d5SSam Clegg << " isTemporary=" << S.isTemporary() 1076b7787fd0SSam Clegg << " isFunction=" << WS.isFunction() 1077b7787fd0SSam Clegg << " isWeak=" << WS.isWeak() 1078a2b35dacSSam Clegg << " isHidden=" << WS.isHidden() 1079b7787fd0SSam Clegg << " isVariable=" << WS.isVariable() << "\n"); 1080b7787fd0SSam Clegg 1081a2b35dacSSam Clegg if (WS.isWeak() || WS.isHidden()) { 1082a2b35dacSSam Clegg uint32_t Flags = (WS.isWeak() ? wasm::WASM_SYMBOL_BINDING_WEAK : 0) | 1083a2b35dacSSam Clegg (WS.isHidden() ? wasm::WASM_SYMBOL_VISIBILITY_HIDDEN : 0); 1084a2b35dacSSam Clegg SymbolFlags.emplace_back(WS.getName(), Flags); 1085a2b35dacSSam Clegg } 1086b7787fd0SSam Clegg 10875e3d33a7SSam Clegg if (WS.isVariable()) 10885e3d33a7SSam Clegg continue; 10895e3d33a7SSam Clegg 1090d934cb88SDan Gohman unsigned Index; 1091b7787fd0SSam Clegg 1092d934cb88SDan Gohman if (WS.isFunction()) { 1093cd65f698SSam Clegg if (WS.isDefined()) { 1094b7787fd0SSam Clegg if (WS.getOffset() != 0) 1095b7787fd0SSam Clegg report_fatal_error( 1096b7787fd0SSam Clegg "function sections must contain one function each"); 1097b7787fd0SSam Clegg 1098b7787fd0SSam Clegg if (WS.getSize() == 0) 1099b7787fd0SSam Clegg report_fatal_error( 1100b7787fd0SSam Clegg "function symbols must have a size set with .size"); 1101b7787fd0SSam Clegg 1102d934cb88SDan Gohman // A definition. Take the next available index. 11039f3fe42eSSam Clegg Index = NumFunctionImports + Functions.size(); 1104d934cb88SDan Gohman 1105d934cb88SDan Gohman // Prepare the function. 1106d934cb88SDan Gohman WasmFunction Func; 11075e3d33a7SSam Clegg Func.Type = getFunctionType(WS); 1108d934cb88SDan Gohman Func.Sym = &WS; 1109d934cb88SDan Gohman SymbolIndices[&WS] = Index; 1110d934cb88SDan Gohman Functions.push_back(Func); 1111d934cb88SDan Gohman } else { 1112d934cb88SDan Gohman // An import; the index was assigned above. 1113d934cb88SDan Gohman Index = SymbolIndices.find(&WS)->second; 1114d934cb88SDan Gohman } 1115d934cb88SDan Gohman 11165e3d33a7SSam Clegg DEBUG(dbgs() << " -> function index: " << Index << "\n"); 1117d934cb88SDan Gohman } else { 1118c38e947eSSam Clegg if (WS.isTemporary() && !WS.getSize()) 1119c38e947eSSam Clegg continue; 1120c38e947eSSam Clegg 1121cd65f698SSam Clegg if (!WS.isDefined()) 1122fe6414b0SSam Clegg continue; 1123fe6414b0SSam Clegg 1124d934cb88SDan Gohman if (!WS.getSize()) 1125c38e947eSSam Clegg report_fatal_error("data symbols must have a size set with .size: " + 1126c38e947eSSam Clegg WS.getName()); 1127d934cb88SDan Gohman 1128d934cb88SDan Gohman int64_t Size = 0; 1129d934cb88SDan Gohman if (!WS.getSize()->evaluateAsAbsolute(Size, Layout)) 1130d934cb88SDan Gohman report_fatal_error(".size expression must be evaluatable"); 1131d934cb88SDan Gohman 11327c395943SSam Clegg // For each global, prepare a corresponding wasm global holding its 11337c395943SSam Clegg // address. For externals these will also be named exports. 11347c395943SSam Clegg Index = NumGlobalImports + Globals.size(); 1135759631c7SSam Clegg auto &DataSection = static_cast<MCSectionWasm &>(WS.getSection()); 1136ea7caceeSSam Clegg assert(DataSection.isWasmData()); 11377c395943SSam Clegg 11387c395943SSam Clegg WasmGlobal Global; 11396e7f1826SSam Clegg Global.Type.Type = PtrType; 11406e7f1826SSam Clegg Global.Type.Mutable = false; 1141759631c7SSam Clegg Global.InitialValue = DataSection.getMemoryOffset() + Layout.getSymbolOffset(WS); 11427c395943SSam Clegg SymbolIndices[&WS] = Index; 11437c395943SSam Clegg DEBUG(dbgs() << " -> global index: " << Index << "\n"); 11447c395943SSam Clegg Globals.push_back(Global); 1145d934cb88SDan Gohman } 1146d934cb88SDan Gohman 1147d934cb88SDan Gohman // If the symbol is visible outside this translation unit, export it. 1148cd65f698SSam Clegg if (WS.isDefined()) { 11498defa952SSam Clegg wasm::WasmExport Export; 11508defa952SSam Clegg Export.Name = WS.getName(); 1151d934cb88SDan Gohman Export.Index = Index; 1152d934cb88SDan Gohman if (WS.isFunction()) 1153d934cb88SDan Gohman Export.Kind = wasm::WASM_EXTERNAL_FUNCTION; 1154d934cb88SDan Gohman else 1155d934cb88SDan Gohman Export.Kind = wasm::WASM_EXTERNAL_GLOBAL; 11565e3d33a7SSam Clegg DEBUG(dbgs() << " -> export " << Exports.size() << "\n"); 1157d934cb88SDan Gohman Exports.push_back(Export); 1158ea7caceeSSam Clegg 115931a2c809SSam Clegg if (!WS.isExternal()) 116031a2c809SSam Clegg SymbolFlags.emplace_back(WS.getName(), wasm::WASM_SYMBOL_BINDING_LOCAL); 1161ea7caceeSSam Clegg 1162ea7caceeSSam Clegg if (WS.isFunction()) { 1163cd65f698SSam Clegg auto &Section = static_cast<MCSectionWasm &>(WS.getSection()); 1164ea7caceeSSam Clegg if (const MCSymbolWasm *C = Section.getGroup()) 1165ea7caceeSSam Clegg Comdats[C->getName()].emplace_back( 1166ea7caceeSSam Clegg WasmComdatEntry{wasm::WASM_COMDAT_FUNCTION, Index}); 1167ea7caceeSSam Clegg } 1168d934cb88SDan Gohman } 1169d934cb88SDan Gohman } 1170d934cb88SDan Gohman 11715e3d33a7SSam Clegg // Handle weak aliases. We need to process these in a separate pass because 11725e3d33a7SSam Clegg // we need to have processed the target of the alias before the alias itself 11735e3d33a7SSam Clegg // and the symbols are not necessarily ordered in this way. 1174b7787fd0SSam Clegg for (const MCSymbol &S : Asm.symbols()) { 1175b7787fd0SSam Clegg if (!S.isVariable()) 1176b7787fd0SSam Clegg continue; 117731a2c809SSam Clegg 1178cd65f698SSam Clegg assert(S.isDefined()); 1179b7787fd0SSam Clegg 11805e3d33a7SSam Clegg // Find the target symbol of this weak alias and export that index 1181aff1c4dfSSam Clegg const auto &WS = static_cast<const MCSymbolWasm &>(S); 1182aff1c4dfSSam Clegg const MCSymbolWasm *ResolvedSym = ResolveSymbol(WS); 11835e3d33a7SSam Clegg DEBUG(dbgs() << WS.getName() << ": weak alias of '" << *ResolvedSym << "'\n"); 11845e3d33a7SSam Clegg assert(SymbolIndices.count(ResolvedSym) > 0); 1185b7787fd0SSam Clegg uint32_t Index = SymbolIndices.find(ResolvedSym)->second; 11865e3d33a7SSam Clegg DEBUG(dbgs() << " -> index:" << Index << "\n"); 1187b7787fd0SSam Clegg 11888defa952SSam Clegg wasm::WasmExport Export; 11898defa952SSam Clegg Export.Name = WS.getName(); 1190b7787fd0SSam Clegg Export.Index = Index; 1191b7787fd0SSam Clegg if (WS.isFunction()) 1192b7787fd0SSam Clegg Export.Kind = wasm::WASM_EXTERNAL_FUNCTION; 1193b7787fd0SSam Clegg else 1194b7787fd0SSam Clegg Export.Kind = wasm::WASM_EXTERNAL_GLOBAL; 11955e3d33a7SSam Clegg DEBUG(dbgs() << " -> export " << Exports.size() << "\n"); 1196b7787fd0SSam Clegg Exports.push_back(Export); 119731a2c809SSam Clegg 119831a2c809SSam Clegg if (!WS.isExternal()) 119931a2c809SSam Clegg SymbolFlags.emplace_back(WS.getName(), wasm::WASM_SYMBOL_BINDING_LOCAL); 1200b7787fd0SSam Clegg } 1201b7787fd0SSam Clegg 12026006e091SSam Clegg { 12036006e091SSam Clegg auto HandleReloc = [&](const WasmRelocationEntry &Rel) { 1204f9edbe95SSam Clegg // Functions referenced by a relocation need to put in the table. This is 1205f9edbe95SSam Clegg // purely to make the object file's provisional values readable, and is 1206f9edbe95SSam Clegg // ignored by the linker, which re-calculates the relocations itself. 1207f9edbe95SSam Clegg if (Rel.Type != wasm::R_WEBASSEMBLY_TABLE_INDEX_I32 && 1208f9edbe95SSam Clegg Rel.Type != wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB) 1209f9edbe95SSam Clegg return; 1210f9edbe95SSam Clegg assert(Rel.Symbol->isFunction()); 1211f9edbe95SSam Clegg const MCSymbolWasm &WS = *ResolveSymbol(*Rel.Symbol); 1212f9edbe95SSam Clegg uint32_t SymbolIndex = SymbolIndices.find(&WS)->second; 1213f9edbe95SSam Clegg uint32_t TableIndex = TableElems.size() + kInitialTableOffset; 1214f9edbe95SSam Clegg if (TableIndices.try_emplace(&WS, TableIndex).second) { 1215329e76d5SSam Clegg DEBUG(dbgs() << " -> adding " << WS.getName() 1216f9edbe95SSam Clegg << " to table: " << TableIndex << "\n"); 1217f9edbe95SSam Clegg TableElems.push_back(SymbolIndex); 12186006e091SSam Clegg registerFunctionType(WS); 12196006e091SSam Clegg } 12206006e091SSam Clegg }; 1221970d02c4SDan Gohman 12226006e091SSam Clegg for (const WasmRelocationEntry &RelEntry : CodeRelocations) 12236006e091SSam Clegg HandleReloc(RelEntry); 12246006e091SSam Clegg for (const WasmRelocationEntry &RelEntry : DataRelocations) 12256006e091SSam Clegg HandleReloc(RelEntry); 1226d934cb88SDan Gohman } 1227d934cb88SDan Gohman 1228bafe6902SSam Clegg // Translate .init_array section contents into start functions. 1229bafe6902SSam Clegg for (const MCSection &S : Asm) { 1230bafe6902SSam Clegg const auto &WS = static_cast<const MCSectionWasm &>(S); 1231bafe6902SSam Clegg if (WS.getSectionName().startswith(".fini_array")) 1232bafe6902SSam Clegg report_fatal_error(".fini_array sections are unsupported"); 1233bafe6902SSam Clegg if (!WS.getSectionName().startswith(".init_array")) 1234bafe6902SSam Clegg continue; 1235bafe6902SSam Clegg if (WS.getFragmentList().empty()) 1236bafe6902SSam Clegg continue; 1237bafe6902SSam Clegg if (WS.getFragmentList().size() != 2) 1238bafe6902SSam Clegg report_fatal_error("only one .init_array section fragment supported"); 1239bafe6902SSam Clegg const MCFragment &AlignFrag = *WS.begin(); 1240bafe6902SSam Clegg if (AlignFrag.getKind() != MCFragment::FT_Align) 1241bafe6902SSam Clegg report_fatal_error(".init_array section should be aligned"); 1242bafe6902SSam Clegg if (cast<MCAlignFragment>(AlignFrag).getAlignment() != (is64Bit() ? 8 : 4)) 1243bafe6902SSam Clegg report_fatal_error(".init_array section should be aligned for pointers"); 1244bafe6902SSam Clegg const MCFragment &Frag = *std::next(WS.begin()); 1245bafe6902SSam Clegg if (Frag.hasInstructions() || Frag.getKind() != MCFragment::FT_Data) 1246bafe6902SSam Clegg report_fatal_error("only data supported in .init_array section"); 1247bafe6902SSam Clegg uint16_t Priority = UINT16_MAX; 1248bafe6902SSam Clegg if (WS.getSectionName().size() != 11) { 1249bafe6902SSam Clegg if (WS.getSectionName()[11] != '.') 1250bafe6902SSam Clegg report_fatal_error(".init_array section priority should start with '.'"); 1251bafe6902SSam Clegg if (WS.getSectionName().substr(12).getAsInteger(10, Priority)) 1252bafe6902SSam Clegg report_fatal_error("invalid .init_array section priority"); 1253bafe6902SSam Clegg } 1254bafe6902SSam Clegg const auto &DataFrag = cast<MCDataFragment>(Frag); 1255bafe6902SSam Clegg const SmallVectorImpl<char> &Contents = DataFrag.getContents(); 1256bafe6902SSam Clegg for (const uint8_t *p = (const uint8_t *)Contents.data(), 1257bafe6902SSam Clegg *end = (const uint8_t *)Contents.data() + Contents.size(); 1258bafe6902SSam Clegg p != end; ++p) { 1259bafe6902SSam Clegg if (*p != 0) 1260bafe6902SSam Clegg report_fatal_error("non-symbolic data in .init_array section"); 1261bafe6902SSam Clegg } 1262bafe6902SSam Clegg for (const MCFixup &Fixup : DataFrag.getFixups()) { 1263bafe6902SSam Clegg assert(Fixup.getKind() == MCFixup::getKindForSize(is64Bit() ? 8 : 4, false)); 1264bafe6902SSam Clegg const MCExpr *Expr = Fixup.getValue(); 1265bafe6902SSam Clegg auto *Sym = dyn_cast<MCSymbolRefExpr>(Expr); 1266bafe6902SSam Clegg if (!Sym) 1267bafe6902SSam Clegg report_fatal_error("fixups in .init_array should be symbol references"); 1268bafe6902SSam Clegg if (Sym->getKind() != MCSymbolRefExpr::VK_WebAssembly_FUNCTION) 1269bafe6902SSam Clegg report_fatal_error("symbols in .init_array should be for functions"); 1270bafe6902SSam Clegg auto I = SymbolIndices.find(cast<MCSymbolWasm>(&Sym->getSymbol())); 1271bafe6902SSam Clegg if (I == SymbolIndices.end()) 1272bafe6902SSam Clegg report_fatal_error("symbols in .init_array should be defined"); 1273bafe6902SSam Clegg uint32_t Index = I->second; 1274bafe6902SSam Clegg InitFuncs.push_back(std::make_pair(Priority, Index)); 1275bafe6902SSam Clegg } 1276bafe6902SSam Clegg } 1277bafe6902SSam Clegg 127818eafb6cSDan Gohman // Write out the Wasm header. 127918eafb6cSDan Gohman writeHeader(Asm); 128018eafb6cSDan Gohman 12819e15f359SSam Clegg writeTypeSection(FunctionTypes); 1282f950b24aSSam Clegg writeImportSection(Imports, DataSize, TableElems.size()); 12839e15f359SSam Clegg writeFunctionSection(Functions); 1284f950b24aSSam Clegg // Skip the "table" section; we import the table instead. 1285f950b24aSSam Clegg // Skip the "memory" section; we import the memory instead. 12867c395943SSam Clegg writeGlobalSection(); 12879e15f359SSam Clegg writeExportSection(Exports); 12889e15f359SSam Clegg writeElemSection(TableElems); 1289acd7d2b0SSam Clegg writeCodeSection(Asm, Layout, Functions); 12907c395943SSam Clegg writeDataSection(DataSegments); 1291acd7d2b0SSam Clegg writeCodeRelocSection(); 12927c395943SSam Clegg writeDataRelocSection(); 1293bafe6902SSam Clegg writeLinkingMetaDataSection(DataSegments, DataSize, SymbolFlags, 1294ea7caceeSSam Clegg InitFuncs, Comdats); 1295970d02c4SDan Gohman 1296d934cb88SDan Gohman // TODO: Translate the .comment section to the output. 1297d934cb88SDan Gohman // TODO: Translate debug sections to the output. 129818eafb6cSDan Gohman } 129918eafb6cSDan Gohman 130060fbc7ccSLang Hames std::unique_ptr<MCObjectWriter> 13011301a878SLang Hames llvm::createWasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW, 130218eafb6cSDan Gohman raw_pwrite_stream &OS) { 13030917c9e4SDan Gohman return llvm::make_unique<WasmObjectWriter>(std::move(MOTW), OS); 130418eafb6cSDan Gohman } 1305