118eafb6cSDan Gohman //===- lib/MC/WasmObjectWriter.cpp - Wasm File Writer ---------------------===// 218eafb6cSDan Gohman // 32946cd70SChandler Carruth // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 42946cd70SChandler Carruth // See https://llvm.org/LICENSE.txt for license information. 52946cd70SChandler Carruth // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 618eafb6cSDan Gohman // 718eafb6cSDan Gohman //===----------------------------------------------------------------------===// 818eafb6cSDan Gohman // 918eafb6cSDan Gohman // This file implements Wasm object file writer information. 1018eafb6cSDan Gohman // 1118eafb6cSDan Gohman //===----------------------------------------------------------------------===// 1218eafb6cSDan Gohman 1318eafb6cSDan Gohman #include "llvm/ADT/STLExtras.h" 1418eafb6cSDan Gohman #include "llvm/ADT/SmallPtrSet.h" 15264b5d9eSZachary Turner #include "llvm/BinaryFormat/Wasm.h" 16b59dff4bSBenjamin Kramer #include "llvm/BinaryFormat/WasmTraits.h" 17432a3883SNico Weber #include "llvm/Config/llvm-config.h" 1818eafb6cSDan Gohman #include "llvm/MC/MCAsmBackend.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/MCObjectWriter.h" 2518eafb6cSDan Gohman #include "llvm/MC/MCSectionWasm.h" 2618eafb6cSDan Gohman #include "llvm/MC/MCSymbolWasm.h" 2718eafb6cSDan Gohman #include "llvm/MC/MCValue.h" 2818eafb6cSDan Gohman #include "llvm/MC/MCWasmObjectWriter.h" 29d934cb88SDan Gohman #include "llvm/Support/Casting.h" 3018eafb6cSDan Gohman #include "llvm/Support/Debug.h" 31bcd7f777SSimon Pilgrim #include "llvm/Support/EndianStream.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 43feac819eSAndy Wingo // When we create the indirect function table we start at 1, so that there is 44feac819eSAndy Wingo // and empty slot at 0 and therefore calling a null function pointer will trap. 4518c56a07SHeejin Ahn static const uint32_t InitialTableOffset = 1; 4630e1bbc1SSam Clegg 47d934cb88SDan Gohman // For patching purposes, we need to remember where each section starts, both 48d934cb88SDan Gohman // for patching up the section size field, and for patching up references to 49d934cb88SDan Gohman // locations within the section. 50d934cb88SDan Gohman struct SectionBookkeeping { 51d934cb88SDan Gohman // Where the size of the section is written. 52d934cb88SDan Gohman uint64_t SizeOffset; 536a31a0d6SSam Clegg // Where the section header ends (without custom section name). 546a31a0d6SSam Clegg uint64_t PayloadOffset; 556a31a0d6SSam Clegg // Where the contents of the section starts. 56d934cb88SDan Gohman uint64_t ContentsOffset; 576f08c84aSSam Clegg uint32_t Index; 58d934cb88SDan Gohman }; 59d934cb88SDan Gohman 607c395943SSam Clegg // A wasm data segment. A wasm binary contains only a single data section 617c395943SSam Clegg // but that can contain many segments, each with their own virtual location 627c395943SSam Clegg // in memory. Each MCSection data created by llvm is modeled as its own 637c395943SSam Clegg // wasm data segment. 647c395943SSam Clegg struct WasmDataSegment { 657c395943SSam Clegg MCSectionWasm *Section; 66d95ed959SSam Clegg StringRef Name; 672e150409SThomas Lively uint32_t InitFlags; 684d135b04SWouter van Oortmerssen uint64_t Offset; 6963ebb813SSam Clegg uint32_t Alignment; 702e150409SThomas Lively uint32_t LinkerFlags; 717c395943SSam Clegg SmallVector<char, 4> Data; 727c395943SSam Clegg }; 737c395943SSam Clegg 749e15f359SSam Clegg // A wasm function to be written into the function section. 759e15f359SSam Clegg struct WasmFunction { 76da419bdbSHeejin Ahn uint32_t SigIndex; 779e15f359SSam Clegg const MCSymbolWasm *Sym; 789e15f359SSam Clegg }; 799e15f359SSam Clegg 809e15f359SSam Clegg // A wasm global to be written into the global section. 819e15f359SSam Clegg struct WasmGlobal { 826e7f1826SSam Clegg wasm::WasmGlobalType Type; 839e15f359SSam Clegg uint64_t InitialValue; 849e15f359SSam Clegg }; 859e15f359SSam Clegg 86ea7caceeSSam Clegg // Information about a single item which is part of a COMDAT. For each data 87ea7caceeSSam Clegg // segment or function which is in the COMDAT, there is a corresponding 88ea7caceeSSam Clegg // WasmComdatEntry. 89ea7caceeSSam Clegg struct WasmComdatEntry { 90ea7caceeSSam Clegg unsigned Kind; 91ea7caceeSSam Clegg uint32_t Index; 92ea7caceeSSam Clegg }; 93ea7caceeSSam Clegg 946dc65e91SSam Clegg // Information about a single relocation. 956dc65e91SSam Clegg struct WasmRelocationEntry { 966dc65e91SSam Clegg uint64_t Offset; // Where is the relocation. 976dc65e91SSam Clegg const MCSymbolWasm *Symbol; // The symbol to relocate with. 986dc65e91SSam Clegg int64_t Addend; // A value to add to the symbol. 996dc65e91SSam Clegg unsigned Type; // The type of the relocation. 100fe6414b0SSam Clegg const MCSectionWasm *FixupSection; // The section the relocation is targeting. 1016dc65e91SSam Clegg 1026dc65e91SSam Clegg WasmRelocationEntry(uint64_t Offset, const MCSymbolWasm *Symbol, 1036dc65e91SSam Clegg int64_t Addend, unsigned Type, 104fe6414b0SSam Clegg const MCSectionWasm *FixupSection) 1056dc65e91SSam Clegg : Offset(Offset), Symbol(Symbol), Addend(Addend), Type(Type), 1066dc65e91SSam Clegg FixupSection(FixupSection) {} 1076dc65e91SSam Clegg 108cadcb9ebSKeno Fischer bool hasAddend() const { return wasm::relocTypeHasAddend(Type); } 109acd7d2b0SSam Clegg 1106dc65e91SSam Clegg void print(raw_ostream &Out) const { 111f208f631SHeejin Ahn Out << wasm::relocTypetoString(Type) << " Off=" << Offset 112f208f631SHeejin Ahn << ", Sym=" << *Symbol << ", Addend=" << Addend 1137d1ff446SFangrui Song << ", FixupSection=" << FixupSection->getName(); 1146dc65e91SSam Clegg } 115b7787fd0SSam Clegg 116615eb470SAaron Ballman #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP) 117b7787fd0SSam Clegg LLVM_DUMP_METHOD void dump() const { print(dbgs()); } 118b7787fd0SSam Clegg #endif 1196dc65e91SSam Clegg }; 1206dc65e91SSam Clegg 12118c56a07SHeejin Ahn static const uint32_t InvalidIndex = -1; 12225d8e68bSSam Clegg 123cfd44a2eSSam Clegg struct WasmCustomSection { 124cfd44a2eSSam Clegg 1256a31a0d6SSam Clegg StringRef Name; 1266a31a0d6SSam Clegg MCSectionWasm *Section; 1276a31a0d6SSam Clegg 1286a31a0d6SSam Clegg uint32_t OutputContentsOffset; 1296a31a0d6SSam Clegg uint32_t OutputIndex; 1306a31a0d6SSam Clegg 1316a31a0d6SSam Clegg WasmCustomSection(StringRef Name, MCSectionWasm *Section) 1326a31a0d6SSam Clegg : Name(Name), Section(Section), OutputContentsOffset(0), 13318c56a07SHeejin Ahn OutputIndex(InvalidIndex) {} 134cfd44a2eSSam Clegg }; 135cfd44a2eSSam Clegg 1361fb8daa6SSam Clegg #if !defined(NDEBUG) 1377f055deeSSam Clegg raw_ostream &operator<<(raw_ostream &OS, const WasmRelocationEntry &Rel) { 138b7787fd0SSam Clegg Rel.print(OS); 139b7787fd0SSam Clegg return OS; 140b7787fd0SSam Clegg } 1411fb8daa6SSam Clegg #endif 142b7787fd0SSam Clegg 14319e8befaSSam Clegg // Write X as an (unsigned) LEB value at offset Offset in Stream, padded 14419e8befaSSam Clegg // to allow patching. 1453b29376eSWouter van Oortmerssen template <int W> 1463b29376eSWouter van Oortmerssen void writePatchableLEB(raw_pwrite_stream &Stream, uint64_t X, uint64_t Offset) { 1473b29376eSWouter van Oortmerssen uint8_t Buffer[W]; 1483b29376eSWouter van Oortmerssen unsigned SizeLen = encodeULEB128(X, Buffer, W); 1493b29376eSWouter van Oortmerssen assert(SizeLen == W); 15019e8befaSSam Clegg Stream.pwrite((char *)Buffer, SizeLen, Offset); 15119e8befaSSam Clegg } 15219e8befaSSam Clegg 15319e8befaSSam Clegg // Write X as an signed LEB value at offset Offset in Stream, padded 15419e8befaSSam Clegg // to allow patching. 1553b29376eSWouter van Oortmerssen template <int W> 1563b29376eSWouter van Oortmerssen void writePatchableSLEB(raw_pwrite_stream &Stream, int64_t X, uint64_t Offset) { 1573b29376eSWouter van Oortmerssen uint8_t Buffer[W]; 1583b29376eSWouter van Oortmerssen unsigned SizeLen = encodeSLEB128(X, Buffer, W); 1593b29376eSWouter van Oortmerssen assert(SizeLen == W); 16019e8befaSSam Clegg Stream.pwrite((char *)Buffer, SizeLen, Offset); 16119e8befaSSam Clegg } 16219e8befaSSam Clegg 16319e8befaSSam Clegg // Write X as a plain integer value at offset Offset in Stream. 1640a6c4d8dSSam Clegg static void patchI32(raw_pwrite_stream &Stream, uint32_t X, uint64_t Offset) { 16519e8befaSSam Clegg uint8_t Buffer[4]; 16619e8befaSSam Clegg support::endian::write32le(Buffer, X); 16719e8befaSSam Clegg Stream.pwrite((char *)Buffer, sizeof(Buffer), Offset); 16819e8befaSSam Clegg } 16919e8befaSSam Clegg 1703b29376eSWouter van Oortmerssen static void patchI64(raw_pwrite_stream &Stream, uint64_t X, uint64_t Offset) { 1713b29376eSWouter van Oortmerssen uint8_t Buffer[8]; 1723b29376eSWouter van Oortmerssen support::endian::write64le(Buffer, X); 1733b29376eSWouter van Oortmerssen Stream.pwrite((char *)Buffer, sizeof(Buffer), Offset); 1743b29376eSWouter van Oortmerssen } 1753b29376eSWouter van Oortmerssen 1760ff28fa6SDerek Schuff bool isDwoSection(const MCSection &Sec) { 1770ff28fa6SDerek Schuff return Sec.getName().endswith(".dwo"); 1780ff28fa6SDerek Schuff } 1790ff28fa6SDerek Schuff 18018eafb6cSDan Gohman class WasmObjectWriter : public MCObjectWriter { 1810ff28fa6SDerek Schuff support::endian::Writer *W; 182f17b149dSPeter Collingbourne 18318eafb6cSDan Gohman /// The target specific Wasm writer instance. 18418eafb6cSDan Gohman std::unique_ptr<MCWasmObjectTargetWriter> TargetObjectWriter; 18518eafb6cSDan Gohman 186d934cb88SDan Gohman // Relocations for fixing up references in the code section. 187d934cb88SDan Gohman std::vector<WasmRelocationEntry> CodeRelocations; 188d934cb88SDan Gohman // Relocations for fixing up references in the data section. 189d934cb88SDan Gohman std::vector<WasmRelocationEntry> DataRelocations; 190d934cb88SDan Gohman 191d934cb88SDan Gohman // Index values to use for fixing up call_indirect type indices. 192acd7d2b0SSam Clegg // Maps function symbols to the index of the type of the function 193acd7d2b0SSam Clegg DenseMap<const MCSymbolWasm *, uint32_t> TypeIndices; 194d99f6078SSam Clegg // Maps function symbols to the table element index space. Used 195d99f6078SSam Clegg // for TABLE_INDEX relocation types (i.e. address taken functions). 196f9edbe95SSam Clegg DenseMap<const MCSymbolWasm *, uint32_t> TableIndices; 197388fb67bSPaulo Matos // Maps function/global/table symbols to the 198388fb67bSPaulo Matos // function/global/table/event/section index space. 1996c899ba6SSam Clegg DenseMap<const MCSymbolWasm *, uint32_t> WasmIndices; 200492f7529SSam Clegg DenseMap<const MCSymbolWasm *, uint32_t> GOTIndices; 2016c899ba6SSam Clegg // Maps data symbols to the Wasm segment and offset/size with the segment. 2026c899ba6SSam Clegg DenseMap<const MCSymbolWasm *, wasm::WasmDataReference> DataLocations; 2036a31a0d6SSam Clegg 2046a31a0d6SSam Clegg // Stores output data (index, relocations, content offset) for custom 2056a31a0d6SSam Clegg // section. 2066a31a0d6SSam Clegg std::vector<WasmCustomSection> CustomSections; 207cbda16ebSThomas Lively std::unique_ptr<WasmCustomSection> ProducersSection; 208f6f4f843SThomas Lively std::unique_ptr<WasmCustomSection> TargetFeaturesSection; 2096a31a0d6SSam Clegg // Relocations for fixing up references in the custom sections. 2106a31a0d6SSam Clegg DenseMap<const MCSectionWasm *, std::vector<WasmRelocationEntry>> 2116a31a0d6SSam Clegg CustomSectionsRelocations; 212acd7d2b0SSam Clegg 213c0d41195SSam Clegg // Map from section to defining function symbol. 2146ccb59b3SSam Clegg DenseMap<const MCSection *, const MCSymbol *> SectionFunctions; 2156ccb59b3SSam Clegg 2164c41fb5aSHeejin Ahn DenseMap<wasm::WasmSignature, uint32_t> SignatureIndices; 2174c41fb5aSHeejin Ahn SmallVector<wasm::WasmSignature, 4> Signatures; 2186c899ba6SSam Clegg SmallVector<WasmDataSegment, 4> DataSegments; 2199f3fe42eSSam Clegg unsigned NumFunctionImports = 0; 2207c395943SSam Clegg unsigned NumGlobalImports = 0; 221feac819eSAndy Wingo unsigned NumTableImports = 0; 222da419bdbSHeejin Ahn unsigned NumEventImports = 0; 2237e1c3345SChandler Carruth uint32_t SectionCount = 0; 224d934cb88SDan Gohman 2250ff28fa6SDerek Schuff enum class DwoMode { 2260ff28fa6SDerek Schuff AllSections, 2270ff28fa6SDerek Schuff NonDwoOnly, 2280ff28fa6SDerek Schuff DwoOnly, 2290ff28fa6SDerek Schuff }; 2300ff28fa6SDerek Schuff bool IsSplitDwarf = false; 2310ff28fa6SDerek Schuff raw_pwrite_stream *OS = nullptr; 2320ff28fa6SDerek Schuff raw_pwrite_stream *DwoOS = nullptr; 2330ff28fa6SDerek Schuff 2340ff28fa6SDerek Schuff // TargetObjectWriter wranppers. 23518eafb6cSDan Gohman bool is64Bit() const { return TargetObjectWriter->is64Bit(); } 236da84b688SDan Gohman bool isEmscripten() const { return TargetObjectWriter->isEmscripten(); } 23718eafb6cSDan Gohman 2382322a937SSam Clegg void startSection(SectionBookkeeping &Section, unsigned SectionId); 2392322a937SSam Clegg void startCustomSection(SectionBookkeeping &Section, StringRef Name); 240d934cb88SDan Gohman void endSection(SectionBookkeeping &Section); 241d934cb88SDan Gohman 24218eafb6cSDan Gohman public: 2431301a878SLang Hames WasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW, 2440ff28fa6SDerek Schuff raw_pwrite_stream &OS_) 2450ff28fa6SDerek Schuff : TargetObjectWriter(std::move(MOTW)), OS(&OS_) {} 2460ff28fa6SDerek Schuff 2470ff28fa6SDerek Schuff WasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW, 2480ff28fa6SDerek Schuff raw_pwrite_stream &OS_, raw_pwrite_stream &DwoOS_) 2490ff28fa6SDerek Schuff : TargetObjectWriter(std::move(MOTW)), IsSplitDwarf(true), OS(&OS_), 2500ff28fa6SDerek Schuff DwoOS(&DwoOS_) {} 25118eafb6cSDan Gohman 2520917c9e4SDan Gohman private: 253acd7d2b0SSam Clegg void reset() override { 254acd7d2b0SSam Clegg CodeRelocations.clear(); 255acd7d2b0SSam Clegg DataRelocations.clear(); 256acd7d2b0SSam Clegg TypeIndices.clear(); 2576c899ba6SSam Clegg WasmIndices.clear(); 258492f7529SSam Clegg GOTIndices.clear(); 259f9edbe95SSam Clegg TableIndices.clear(); 2606c899ba6SSam Clegg DataLocations.clear(); 261cbda16ebSThomas Lively CustomSections.clear(); 262cbda16ebSThomas Lively ProducersSection.reset(); 263f6f4f843SThomas Lively TargetFeaturesSection.reset(); 2646a31a0d6SSam Clegg CustomSectionsRelocations.clear(); 265da419bdbSHeejin Ahn SignatureIndices.clear(); 266da419bdbSHeejin Ahn Signatures.clear(); 2676c899ba6SSam Clegg DataSegments.clear(); 2686ccb59b3SSam Clegg SectionFunctions.clear(); 2699f3fe42eSSam Clegg NumFunctionImports = 0; 2707c395943SSam Clegg NumGlobalImports = 0; 271feac819eSAndy Wingo NumTableImports = 0; 272105bdc25SSam Clegg MCObjectWriter::reset(); 273acd7d2b0SSam Clegg } 274acd7d2b0SSam Clegg 27518eafb6cSDan Gohman void writeHeader(const MCAssembler &Asm); 27618eafb6cSDan Gohman 27718eafb6cSDan Gohman void recordRelocation(MCAssembler &Asm, const MCAsmLayout &Layout, 27818eafb6cSDan Gohman const MCFragment *Fragment, const MCFixup &Fixup, 279ceecfe5bSRafael Espindola MCValue Target, uint64_t &FixedValue) override; 28018eafb6cSDan Gohman 28118eafb6cSDan Gohman void executePostLayoutBinding(MCAssembler &Asm, 28218eafb6cSDan Gohman const MCAsmLayout &Layout) override; 2830ff28fa6SDerek Schuff void prepareImports(SmallVectorImpl<wasm::WasmImport> &Imports, 2840ff28fa6SDerek Schuff MCAssembler &Asm, const MCAsmLayout &Layout); 285438390faSPeter Collingbourne uint64_t writeObject(MCAssembler &Asm, const MCAsmLayout &Layout) override; 2869e15f359SSam Clegg 2870ff28fa6SDerek Schuff uint64_t writeOneObject(MCAssembler &Asm, const MCAsmLayout &Layout, 2880ff28fa6SDerek Schuff DwoMode Mode); 2890ff28fa6SDerek Schuff 290b7787fd0SSam Clegg void writeString(const StringRef Str) { 2910ff28fa6SDerek Schuff encodeULEB128(Str.size(), W->OS); 2920ff28fa6SDerek Schuff W->OS << Str; 293b7787fd0SSam Clegg } 294b7787fd0SSam Clegg 2950a6c4d8dSSam Clegg void writeI32(int32_t val) { 2960a6c4d8dSSam Clegg char Buffer[4]; 2970a6c4d8dSSam Clegg support::endian::write32le(Buffer, val); 2980ff28fa6SDerek Schuff W->OS.write(Buffer, sizeof(Buffer)); 2990a6c4d8dSSam Clegg } 3000a6c4d8dSSam Clegg 3010a6c4d8dSSam Clegg void writeI64(int64_t val) { 3020a6c4d8dSSam Clegg char Buffer[8]; 3030a6c4d8dSSam Clegg support::endian::write64le(Buffer, val); 3040ff28fa6SDerek Schuff W->OS.write(Buffer, sizeof(Buffer)); 3050a6c4d8dSSam Clegg } 3060a6c4d8dSSam Clegg 3070ff28fa6SDerek Schuff void writeValueType(wasm::ValType Ty) { W->OS << static_cast<char>(Ty); } 3089e15f359SSam Clegg 3094c41fb5aSHeejin Ahn void writeTypeSection(ArrayRef<wasm::WasmSignature> Signatures); 3104d135b04SWouter van Oortmerssen void writeImportSection(ArrayRef<wasm::WasmImport> Imports, uint64_t DataSize, 311f950b24aSSam Clegg uint32_t NumElements); 312457fb0b4SSam Clegg void writeFunctionSection(ArrayRef<WasmFunction> Functions); 3138defa952SSam Clegg void writeExportSection(ArrayRef<wasm::WasmExport> Exports); 314457fb0b4SSam Clegg void writeElemSection(ArrayRef<uint32_t> TableElems); 315fef8de66SThomas Lively void writeDataCountSection(); 316e49584a3SSam Clegg uint32_t writeCodeSection(const MCAssembler &Asm, const MCAsmLayout &Layout, 317457fb0b4SSam Clegg ArrayRef<WasmFunction> Functions); 318e49584a3SSam Clegg uint32_t writeDataSection(const MCAsmLayout &Layout); 319da419bdbSHeejin Ahn void writeEventSection(ArrayRef<wasm::WasmEventType> Events); 3200a6c4d8dSSam Clegg void writeGlobalSection(ArrayRef<wasm::WasmGlobal> Globals); 321388fb67bSPaulo Matos void writeTableSection(ArrayRef<wasm::WasmTable> Tables); 3226f08c84aSSam Clegg void writeRelocSection(uint32_t SectionIndex, StringRef Name, 323f77dc2a8SSam Clegg std::vector<WasmRelocationEntry> &Relocations); 32431a2c809SSam Clegg void writeLinkingMetaDataSection( 32586b4a09aSSam Clegg ArrayRef<wasm::WasmSymbolInfo> SymbolInfos, 326ea7caceeSSam Clegg ArrayRef<std::pair<uint16_t, uint32_t>> InitFuncs, 327ea7caceeSSam Clegg const std::map<StringRef, std::vector<WasmComdatEntry>> &Comdats); 328cbda16ebSThomas Lively void writeCustomSection(WasmCustomSection &CustomSection, 329cbda16ebSThomas Lively const MCAssembler &Asm, const MCAsmLayout &Layout); 3306a31a0d6SSam Clegg void writeCustomRelocSections(); 331acd7d2b0SSam Clegg 3327ee758d6SSam Clegg uint64_t getProvisionalValue(const WasmRelocationEntry &RelEntry, 3337ee758d6SSam Clegg const MCAsmLayout &Layout); 334acd7d2b0SSam Clegg void applyRelocations(ArrayRef<WasmRelocationEntry> Relocations, 3357ee758d6SSam Clegg uint64_t ContentsOffset, const MCAsmLayout &Layout); 336acd7d2b0SSam Clegg 337acd7d2b0SSam Clegg uint32_t getRelocationIndexValue(const WasmRelocationEntry &RelEntry); 3385e3d33a7SSam Clegg uint32_t getFunctionType(const MCSymbolWasm &Symbol); 339da419bdbSHeejin Ahn uint32_t getEventType(const MCSymbolWasm &Symbol); 34038b12f5eSHeejin Ahn void registerFunctionType(const MCSymbolWasm &Symbol); 34138b12f5eSHeejin Ahn void registerEventType(const MCSymbolWasm &Symbol); 34218eafb6cSDan Gohman }; 3439e15f359SSam Clegg 34418eafb6cSDan Gohman } // end anonymous namespace 34518eafb6cSDan Gohman 346d934cb88SDan Gohman // Write out a section header and a patchable section size field. 347d934cb88SDan Gohman void WasmObjectWriter::startSection(SectionBookkeeping &Section, 3482322a937SSam Clegg unsigned SectionId) { 349d34e60caSNicola Zaghen LLVM_DEBUG(dbgs() << "startSection " << SectionId << "\n"); 3500ff28fa6SDerek Schuff W->OS << char(SectionId); 351d934cb88SDan Gohman 3520ff28fa6SDerek Schuff Section.SizeOffset = W->OS.tell(); 353d934cb88SDan Gohman 354d934cb88SDan Gohman // The section size. We don't know the size yet, so reserve enough space 355d934cb88SDan Gohman // for any 32-bit value; we'll patch it later. 3560ff28fa6SDerek Schuff encodeULEB128(0, W->OS, 5); 357d934cb88SDan Gohman 358d934cb88SDan Gohman // The position where the section starts, for measuring its size. 3590ff28fa6SDerek Schuff Section.ContentsOffset = W->OS.tell(); 3600ff28fa6SDerek Schuff Section.PayloadOffset = W->OS.tell(); 3616f08c84aSSam Clegg Section.Index = SectionCount++; 362d934cb88SDan Gohman } 3632322a937SSam Clegg 3642322a937SSam Clegg void WasmObjectWriter::startCustomSection(SectionBookkeeping &Section, 3652322a937SSam Clegg StringRef Name) { 366d34e60caSNicola Zaghen LLVM_DEBUG(dbgs() << "startCustomSection " << Name << "\n"); 3672322a937SSam Clegg startSection(Section, wasm::WASM_SEC_CUSTOM); 3686a31a0d6SSam Clegg 3696a31a0d6SSam Clegg // The position where the section header ends, for measuring its size. 3700ff28fa6SDerek Schuff Section.PayloadOffset = W->OS.tell(); 3716a31a0d6SSam Clegg 3722322a937SSam Clegg // Custom sections in wasm also have a string identifier. 3732322a937SSam Clegg writeString(Name); 3746a31a0d6SSam Clegg 3756a31a0d6SSam Clegg // The position where the custom section starts. 3760ff28fa6SDerek Schuff Section.ContentsOffset = W->OS.tell(); 377d934cb88SDan Gohman } 378d934cb88SDan Gohman 379d934cb88SDan Gohman // Now that the section is complete and we know how big it is, patch up the 380d934cb88SDan Gohman // section size field at the start of the section. 381d934cb88SDan Gohman void WasmObjectWriter::endSection(SectionBookkeeping &Section) { 3820ff28fa6SDerek Schuff uint64_t Size = W->OS.tell(); 383c0affde8SSam Clegg // /dev/null doesn't support seek/tell and can report offset of 0. 384c0affde8SSam Clegg // Simply skip this patching in that case. 385c0affde8SSam Clegg if (!Size) 386c0affde8SSam Clegg return; 387c0affde8SSam Clegg 388c0affde8SSam Clegg Size -= Section.PayloadOffset; 389d934cb88SDan Gohman if (uint32_t(Size) != Size) 390d934cb88SDan Gohman report_fatal_error("section size does not fit in a uint32_t"); 391d934cb88SDan Gohman 392d34e60caSNicola Zaghen LLVM_DEBUG(dbgs() << "endSection size=" << Size << "\n"); 393d934cb88SDan Gohman 394d934cb88SDan Gohman // Write the final section size to the payload_len field, which follows 395d934cb88SDan Gohman // the section id byte. 3960ff28fa6SDerek Schuff writePatchableLEB<5>(static_cast<raw_pwrite_stream &>(W->OS), Size, 397f17b149dSPeter Collingbourne Section.SizeOffset); 398d934cb88SDan Gohman } 399d934cb88SDan Gohman 40018eafb6cSDan Gohman // Emit the Wasm header. 40118eafb6cSDan Gohman void WasmObjectWriter::writeHeader(const MCAssembler &Asm) { 4020ff28fa6SDerek Schuff W->OS.write(wasm::WasmMagic, sizeof(wasm::WasmMagic)); 4030ff28fa6SDerek Schuff W->write<uint32_t>(wasm::WasmVersion); 40418eafb6cSDan Gohman } 40518eafb6cSDan Gohman 40618eafb6cSDan Gohman void WasmObjectWriter::executePostLayoutBinding(MCAssembler &Asm, 40718eafb6cSDan Gohman const MCAsmLayout &Layout) { 408*96ef4f30SSam Clegg // As a stopgap measure until call_indirect instructions start explicitly 409*96ef4f30SSam Clegg // referencing the indirect function table via TABLE_NUMBER relocs, ensure 410*96ef4f30SSam Clegg // that the indirect function table import makes it to the output if anything 411*96ef4f30SSam Clegg // in the compilation unit has caused it to be present. 412*96ef4f30SSam Clegg if (auto *Sym = Asm.getContext().lookupSymbol("__indirect_function_table")) 413*96ef4f30SSam Clegg Asm.registerSymbol(*Sym); 414*96ef4f30SSam Clegg 4156ccb59b3SSam Clegg // Build a map of sections to the function that defines them, for use 4166ccb59b3SSam Clegg // in recordRelocation. 4176ccb59b3SSam Clegg for (const MCSymbol &S : Asm.symbols()) { 4186ccb59b3SSam Clegg const auto &WS = static_cast<const MCSymbolWasm &>(S); 4196ccb59b3SSam Clegg if (WS.isDefined() && WS.isFunction() && !WS.isVariable()) { 4206ccb59b3SSam Clegg const auto &Sec = static_cast<const MCSectionWasm &>(S.getSection()); 4216ccb59b3SSam Clegg auto Pair = SectionFunctions.insert(std::make_pair(&Sec, &S)); 4226ccb59b3SSam Clegg if (!Pair.second) 4236ccb59b3SSam Clegg report_fatal_error("section already has a defining function: " + 4247d1ff446SFangrui Song Sec.getName()); 4256ccb59b3SSam Clegg } 4266ccb59b3SSam Clegg } 42718eafb6cSDan Gohman } 42818eafb6cSDan Gohman 42918eafb6cSDan Gohman void WasmObjectWriter::recordRelocation(MCAssembler &Asm, 43018eafb6cSDan Gohman const MCAsmLayout &Layout, 43118eafb6cSDan Gohman const MCFragment *Fragment, 43218eafb6cSDan Gohman const MCFixup &Fixup, MCValue Target, 433ceecfe5bSRafael Espindola uint64_t &FixedValue) { 434ecc5e808SSam Clegg // The WebAssembly backend should never generate FKF_IsPCRel fixups 435e828ce1bSFangrui Song assert(!(Asm.getBackend().getFixupKindInfo(Fixup.getKind()).Flags & 436ecc5e808SSam Clegg MCFixupKindInfo::FKF_IsPCRel)); 437ecc5e808SSam Clegg 438fe6414b0SSam Clegg const auto &FixupSection = cast<MCSectionWasm>(*Fragment->getParent()); 439d934cb88SDan Gohman uint64_t C = Target.getConstant(); 440d934cb88SDan Gohman uint64_t FixupOffset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset(); 441d934cb88SDan Gohman MCContext &Ctx = Asm.getContext(); 442d934cb88SDan Gohman 443d934cb88SDan Gohman if (const MCSymbolRefExpr *RefB = Target.getSymB()) { 444ecc5e808SSam Clegg // To get here the A - B expression must have failed evaluateAsRelocatable. 445ecc5e808SSam Clegg // This means either A or B must be undefined and in WebAssembly we can't 446ecc5e808SSam Clegg // support either of those cases. 447ecc5e808SSam Clegg const auto &SymB = cast<MCSymbolWasm>(RefB->getSymbol()); 448d934cb88SDan Gohman Ctx.reportError( 449d934cb88SDan Gohman Fixup.getLoc(), 450d934cb88SDan Gohman Twine("symbol '") + SymB.getName() + 451ecc5e808SSam Clegg "': unsupported subtraction expression used in relocation."); 452d934cb88SDan Gohman return; 453d934cb88SDan Gohman } 454d934cb88SDan Gohman 455d934cb88SDan Gohman // We either rejected the fixup or folded B into C at this point. 456d934cb88SDan Gohman const MCSymbolRefExpr *RefA = Target.getSymA(); 457ecc5e808SSam Clegg const auto *SymA = cast<MCSymbolWasm>(&RefA->getSymbol()); 458d934cb88SDan Gohman 4593ea1c62cSSam Clegg // The .init_array isn't translated as data, so don't do relocations in it. 4607d1ff446SFangrui Song if (FixupSection.getName().startswith(".init_array")) { 4613ea1c62cSSam Clegg SymA->setUsedInInitArray(); 4623ea1c62cSSam Clegg return; 4633ea1c62cSSam Clegg } 4643ea1c62cSSam Clegg 465ecc5e808SSam Clegg if (SymA->isVariable()) { 466d934cb88SDan Gohman const MCExpr *Expr = SymA->getVariableValue(); 4677ee758d6SSam Clegg if (const auto *Inner = dyn_cast<MCSymbolRefExpr>(Expr)) 4686ad8f190SSam Clegg if (Inner->getKind() == MCSymbolRefExpr::VK_WEAKREF) 4696ad8f190SSam Clegg llvm_unreachable("weakref used in reloc not yet implemented"); 470d934cb88SDan Gohman } 471d934cb88SDan Gohman 472d934cb88SDan Gohman // Put any constant offset in an addend. Offsets can be negative, and 473d934cb88SDan Gohman // LLVM expects wrapping, in contrast to wasm's immediates which can't 474d934cb88SDan Gohman // be negative and don't wrap. 475d934cb88SDan Gohman FixedValue = 0; 476d934cb88SDan Gohman 477a5e175c6SSam Clegg unsigned Type = TargetObjectWriter->getRelocType(Target, Fixup); 4789d24fb7fSSam Clegg 4794d57fbd0SSam Clegg // Absolute offset within a section or a function. 4804d57fbd0SSam Clegg // Currently only supported for for metadata sections. 4814d57fbd0SSam Clegg // See: test/MC/WebAssembly/blockaddress.ll 482d1152a26SSam Clegg if (Type == wasm::R_WASM_FUNCTION_OFFSET_I32 || 48316f02431SWouter van Oortmerssen Type == wasm::R_WASM_FUNCTION_OFFSET_I64 || 484d1152a26SSam Clegg Type == wasm::R_WASM_SECTION_OFFSET_I32) { 4854d57fbd0SSam Clegg if (!FixupSection.getKind().isMetadata()) 4864d57fbd0SSam Clegg report_fatal_error("relocations for function or section offsets are " 4874d57fbd0SSam Clegg "only supported in metadata sections"); 4884d57fbd0SSam Clegg 4894d57fbd0SSam Clegg const MCSymbol *SectionSymbol = nullptr; 4904d57fbd0SSam Clegg const MCSection &SecA = SymA->getSection(); 4914d57fbd0SSam Clegg if (SecA.getKind().isText()) 4926ccb59b3SSam Clegg SectionSymbol = SectionFunctions.find(&SecA)->second; 4934d57fbd0SSam Clegg else 4944d57fbd0SSam Clegg SectionSymbol = SecA.getBeginSymbol(); 4954d57fbd0SSam Clegg if (!SectionSymbol) 4964d57fbd0SSam Clegg report_fatal_error("section symbol is required for relocation"); 4974d57fbd0SSam Clegg 4984d57fbd0SSam Clegg C += Layout.getSymbolOffset(*SymA); 4994d57fbd0SSam Clegg SymA = cast<MCSymbolWasm>(SectionSymbol); 5004d57fbd0SSam Clegg } 5014d57fbd0SSam Clegg 502feac819eSAndy Wingo if (Type == wasm::R_WASM_TABLE_INDEX_REL_SLEB || 503feac819eSAndy Wingo Type == wasm::R_WASM_TABLE_INDEX_SLEB || 504feac819eSAndy Wingo Type == wasm::R_WASM_TABLE_INDEX_SLEB64 || 505feac819eSAndy Wingo Type == wasm::R_WASM_TABLE_INDEX_I32 || 506feac819eSAndy Wingo Type == wasm::R_WASM_TABLE_INDEX_I64) { 507feac819eSAndy Wingo // TABLE_INDEX relocs implicitly use the default indirect function table. 508feac819eSAndy Wingo auto TableName = "__indirect_function_table"; 509feac819eSAndy Wingo MCSymbolWasm *Sym = cast_or_null<MCSymbolWasm>(Ctx.lookupSymbol(TableName)); 510feac819eSAndy Wingo if (Sym) { 511feac819eSAndy Wingo if (!Sym->isFunctionTable()) 512feac819eSAndy Wingo Ctx.reportError( 513feac819eSAndy Wingo Fixup.getLoc(), 514feac819eSAndy Wingo "symbol '__indirect_function_table' is not a function table"); 515feac819eSAndy Wingo } else { 516feac819eSAndy Wingo Sym = cast<MCSymbolWasm>(Ctx.getOrCreateSymbol(TableName)); 517feac819eSAndy Wingo Sym->setFunctionTable(); 518feac819eSAndy Wingo // The default function table is synthesized by the linker. 519feac819eSAndy Wingo Sym->setUndefined(); 520feac819eSAndy Wingo } 521feac819eSAndy Wingo Sym->setUsedInReloc(); 522d8066186SAndy Wingo // Any time we have a TABLE_INDEX relocation against a function symbol, we 523d8066186SAndy Wingo // need to ensure that table itself is part of the final output too. In the 524d8066186SAndy Wingo // future we may want to define a new kind of reloc against both the 525d8066186SAndy Wingo // function and the table, so that the linker can see that the function 526d8066186SAndy Wingo // symbol keeps the table alive, but for now manually mark the table as 527d8066186SAndy Wingo // live. 528d8066186SAndy Wingo Sym->setNoStrip(); 529feac819eSAndy Wingo Asm.registerSymbol(*Sym); 530feac819eSAndy Wingo } 531feac819eSAndy Wingo 532d1152a26SSam Clegg // Relocation other than R_WASM_TYPE_INDEX_LEB are required to be 5334d57fbd0SSam Clegg // against a named symbol. 534d1152a26SSam Clegg if (Type != wasm::R_WASM_TYPE_INDEX_LEB) { 5354d57fbd0SSam Clegg if (SymA->getName().empty()) 5364d57fbd0SSam Clegg report_fatal_error("relocations against un-named temporaries are not yet " 5374d57fbd0SSam Clegg "supported by wasm"); 5384d57fbd0SSam Clegg 5394d57fbd0SSam Clegg SymA->setUsedInReloc(); 5404d57fbd0SSam Clegg } 541ae03c1e7SSam Clegg 542492f7529SSam Clegg if (RefA->getKind() == MCSymbolRefExpr::VK_GOT) 543492f7529SSam Clegg SymA->setUsedInGOT(); 544492f7529SSam Clegg 545d934cb88SDan Gohman WasmRelocationEntry Rec(FixupOffset, SymA, C, Type, &FixupSection); 546d34e60caSNicola Zaghen LLVM_DEBUG(dbgs() << "WasmReloc: " << Rec << "\n"); 547d934cb88SDan Gohman 5486a31a0d6SSam Clegg if (FixupSection.isWasmData()) { 549d934cb88SDan Gohman DataRelocations.push_back(Rec); 5506a31a0d6SSam Clegg } else if (FixupSection.getKind().isText()) { 55112fd3da9SSam Clegg CodeRelocations.push_back(Rec); 5526a31a0d6SSam Clegg } else if (FixupSection.getKind().isMetadata()) { 5536a31a0d6SSam Clegg CustomSectionsRelocations[&FixupSection].push_back(Rec); 5546a31a0d6SSam Clegg } else { 55512fd3da9SSam Clegg llvm_unreachable("unexpected section type"); 556d934cb88SDan Gohman } 5576a31a0d6SSam Clegg } 558d934cb88SDan Gohman 559d934cb88SDan Gohman // Compute a value to write into the code at the location covered 56060ec3034SSam Clegg // by RelEntry. This value isn't used by the static linker; it just serves 56160ec3034SSam Clegg // to make the object format more readable and more likely to be directly 56260ec3034SSam Clegg // useable. 5633b29376eSWouter van Oortmerssen uint64_t 5647ee758d6SSam Clegg WasmObjectWriter::getProvisionalValue(const WasmRelocationEntry &RelEntry, 5657ee758d6SSam Clegg const MCAsmLayout &Layout) { 56648139ebcSWouter van Oortmerssen if ((RelEntry.Type == wasm::R_WASM_GLOBAL_INDEX_LEB || 56748139ebcSWouter van Oortmerssen RelEntry.Type == wasm::R_WASM_GLOBAL_INDEX_I32) && 56848139ebcSWouter van Oortmerssen !RelEntry.Symbol->isGlobal()) { 569492f7529SSam Clegg assert(GOTIndices.count(RelEntry.Symbol) > 0 && "symbol not found in GOT index space"); 570492f7529SSam Clegg return GOTIndices[RelEntry.Symbol]; 571492f7529SSam Clegg } 572492f7529SSam Clegg 57360ec3034SSam Clegg switch (RelEntry.Type) { 5742a7cac93SSam Clegg case wasm::R_WASM_TABLE_INDEX_REL_SLEB: 575d1152a26SSam Clegg case wasm::R_WASM_TABLE_INDEX_SLEB: 576cc1b9b68SWouter van Oortmerssen case wasm::R_WASM_TABLE_INDEX_SLEB64: 577cc1b9b68SWouter van Oortmerssen case wasm::R_WASM_TABLE_INDEX_I32: 578cc1b9b68SWouter van Oortmerssen case wasm::R_WASM_TABLE_INDEX_I64: { 579f9edbe95SSam Clegg // Provisional value is table address of the resolved symbol itself 5807ee758d6SSam Clegg const MCSymbolWasm *Base = 5817ee758d6SSam Clegg cast<MCSymbolWasm>(Layout.getBaseSymbol(*RelEntry.Symbol)); 5827ee758d6SSam Clegg assert(Base->isFunction()); 58381443ac1SSam Clegg if (RelEntry.Type == wasm::R_WASM_TABLE_INDEX_REL_SLEB) 5847ee758d6SSam Clegg return TableIndices[Base] - InitialTableOffset; 58581443ac1SSam Clegg else 5867ee758d6SSam Clegg return TableIndices[Base]; 587f9edbe95SSam Clegg } 588d1152a26SSam Clegg case wasm::R_WASM_TYPE_INDEX_LEB: 5896c899ba6SSam Clegg // Provisional value is same as the index 59060ec3034SSam Clegg return getRelocationIndexValue(RelEntry); 591d1152a26SSam Clegg case wasm::R_WASM_FUNCTION_INDEX_LEB: 592d1152a26SSam Clegg case wasm::R_WASM_GLOBAL_INDEX_LEB: 59348139ebcSWouter van Oortmerssen case wasm::R_WASM_GLOBAL_INDEX_I32: 594d1152a26SSam Clegg case wasm::R_WASM_EVENT_INDEX_LEB: 59569e2797eSPaulo Matos case wasm::R_WASM_TABLE_NUMBER_LEB: 596da419bdbSHeejin Ahn // Provisional value is function/global/event Wasm index 597492f7529SSam Clegg assert(WasmIndices.count(RelEntry.Symbol) > 0 && "symbol not found in wasm index space"); 5986c899ba6SSam Clegg return WasmIndices[RelEntry.Symbol]; 599d1152a26SSam Clegg case wasm::R_WASM_FUNCTION_OFFSET_I32: 60016f02431SWouter van Oortmerssen case wasm::R_WASM_FUNCTION_OFFSET_I64: 601d1152a26SSam Clegg case wasm::R_WASM_SECTION_OFFSET_I32: { 6026a31a0d6SSam Clegg const auto &Section = 6036a31a0d6SSam Clegg static_cast<const MCSectionWasm &>(RelEntry.Symbol->getSection()); 6046a31a0d6SSam Clegg return Section.getSectionOffset() + RelEntry.Addend; 6056a31a0d6SSam Clegg } 606d1152a26SSam Clegg case wasm::R_WASM_MEMORY_ADDR_LEB: 6073b29376eSWouter van Oortmerssen case wasm::R_WASM_MEMORY_ADDR_LEB64: 6083b29376eSWouter van Oortmerssen case wasm::R_WASM_MEMORY_ADDR_SLEB: 6093b29376eSWouter van Oortmerssen case wasm::R_WASM_MEMORY_ADDR_SLEB64: 6102a7cac93SSam Clegg case wasm::R_WASM_MEMORY_ADDR_REL_SLEB: 6113b29376eSWouter van Oortmerssen case wasm::R_WASM_MEMORY_ADDR_REL_SLEB64: 6123b29376eSWouter van Oortmerssen case wasm::R_WASM_MEMORY_ADDR_I32: 613a28a4662SSam Clegg case wasm::R_WASM_MEMORY_ADDR_I64: 614a28a4662SSam Clegg case wasm::R_WASM_MEMORY_ADDR_TLS_SLEB: { 6159c7b5808SDominic Chen // Provisional value is address of the global plus the offset 6167ee758d6SSam Clegg const MCSymbolWasm *Base = 6177ee758d6SSam Clegg cast<MCSymbolWasm>(Layout.getBaseSymbol(*RelEntry.Symbol)); 618270ed1b3SSam Clegg // For undefined symbols, use zero 6197ee758d6SSam Clegg if (!Base->isDefined()) 620270ed1b3SSam Clegg return 0; 6219c7b5808SDominic Chen const wasm::WasmDataReference &BaseRef = DataLocations[Base], 6229c7b5808SDominic Chen &SymRef = DataLocations[RelEntry.Symbol]; 6239c7b5808SDominic Chen const WasmDataSegment &Segment = DataSegments[BaseRef.Segment]; 624d934cb88SDan Gohman // Ignore overflow. LLVM allows address arithmetic to silently wrap. 6259c7b5808SDominic Chen return Segment.Offset + BaseRef.Offset + SymRef.Offset + RelEntry.Addend; 62660ec3034SSam Clegg } 62760ec3034SSam Clegg default: 62860ec3034SSam Clegg llvm_unreachable("invalid relocation type"); 62960ec3034SSam Clegg } 630d934cb88SDan Gohman } 631d934cb88SDan Gohman 632759631c7SSam Clegg static void addData(SmallVectorImpl<char> &DataBytes, 63363ebb813SSam Clegg MCSectionWasm &DataSection) { 6347d1ff446SFangrui Song LLVM_DEBUG(errs() << "addData: " << DataSection.getName() << "\n"); 635759631c7SSam Clegg 63663ebb813SSam Clegg DataBytes.resize(alignTo(DataBytes.size(), DataSection.getAlignment())); 63763ebb813SSam Clegg 638759631c7SSam Clegg for (const MCFragment &Frag : DataSection) { 639759631c7SSam Clegg if (Frag.hasInstructions()) 640759631c7SSam Clegg report_fatal_error("only data supported in data sections"); 641759631c7SSam Clegg 642759631c7SSam Clegg if (auto *Align = dyn_cast<MCAlignFragment>(&Frag)) { 643759631c7SSam Clegg if (Align->getValueSize() != 1) 644759631c7SSam Clegg report_fatal_error("only byte values supported for alignment"); 645759631c7SSam Clegg // If nops are requested, use zeros, as this is the data section. 646759631c7SSam Clegg uint8_t Value = Align->hasEmitNops() ? 0 : Align->getValue(); 647f208f631SHeejin Ahn uint64_t Size = 648f208f631SHeejin Ahn std::min<uint64_t>(alignTo(DataBytes.size(), Align->getAlignment()), 649f208f631SHeejin Ahn DataBytes.size() + Align->getMaxBytesToEmit()); 650759631c7SSam Clegg DataBytes.resize(Size, Value); 651759631c7SSam Clegg } else if (auto *Fill = dyn_cast<MCFillFragment>(&Frag)) { 652588fad4dSNirav Dave int64_t NumValues; 653588fad4dSNirav Dave if (!Fill->getNumValues().evaluateAsAbsolute(NumValues)) 654d707c370SRafael Espindola llvm_unreachable("The fill should be an assembler constant"); 655588fad4dSNirav Dave DataBytes.insert(DataBytes.end(), Fill->getValueSize() * NumValues, 656588fad4dSNirav Dave Fill->getValue()); 65724faf859SHeejin Ahn } else if (auto *LEB = dyn_cast<MCLEBFragment>(&Frag)) { 65824faf859SHeejin Ahn const SmallVectorImpl<char> &Contents = LEB->getContents(); 6591d0bc055SKazu Hirata llvm::append_range(DataBytes, Contents); 660759631c7SSam Clegg } else { 661759631c7SSam Clegg const auto &DataFrag = cast<MCDataFragment>(Frag); 662759631c7SSam Clegg const SmallVectorImpl<char> &Contents = DataFrag.getContents(); 6631d0bc055SKazu Hirata llvm::append_range(DataBytes, Contents); 664759631c7SSam Clegg } 665759631c7SSam Clegg } 666759631c7SSam Clegg 667d34e60caSNicola Zaghen LLVM_DEBUG(dbgs() << "addData -> " << DataBytes.size() << "\n"); 668759631c7SSam Clegg } 669759631c7SSam Clegg 67060ec3034SSam Clegg uint32_t 67160ec3034SSam Clegg WasmObjectWriter::getRelocationIndexValue(const WasmRelocationEntry &RelEntry) { 672d1152a26SSam Clegg if (RelEntry.Type == wasm::R_WASM_TYPE_INDEX_LEB) { 673b7787fd0SSam Clegg if (!TypeIndices.count(RelEntry.Symbol)) 674b7787fd0SSam Clegg report_fatal_error("symbol not found in type index space: " + 675b7787fd0SSam Clegg RelEntry.Symbol->getName()); 676acd7d2b0SSam Clegg return TypeIndices[RelEntry.Symbol]; 677acd7d2b0SSam Clegg } 67860ec3034SSam Clegg 67925d8e68bSSam Clegg return RelEntry.Symbol->getIndex(); 680acd7d2b0SSam Clegg } 681acd7d2b0SSam Clegg 682d934cb88SDan Gohman // Apply the portions of the relocation records that we can handle ourselves 683d934cb88SDan Gohman // directly. 684acd7d2b0SSam Clegg void WasmObjectWriter::applyRelocations( 6857ee758d6SSam Clegg ArrayRef<WasmRelocationEntry> Relocations, uint64_t ContentsOffset, 6867ee758d6SSam Clegg const MCAsmLayout &Layout) { 6870ff28fa6SDerek Schuff auto &Stream = static_cast<raw_pwrite_stream &>(W->OS); 688d934cb88SDan Gohman for (const WasmRelocationEntry &RelEntry : Relocations) { 689d934cb88SDan Gohman uint64_t Offset = ContentsOffset + 690d934cb88SDan Gohman RelEntry.FixupSection->getSectionOffset() + 691d934cb88SDan Gohman RelEntry.Offset; 692d934cb88SDan Gohman 693d34e60caSNicola Zaghen LLVM_DEBUG(dbgs() << "applyRelocation: " << RelEntry << "\n"); 6947ee758d6SSam Clegg auto Value = getProvisionalValue(RelEntry, Layout); 69560ec3034SSam Clegg 696acd7d2b0SSam Clegg switch (RelEntry.Type) { 697d1152a26SSam Clegg case wasm::R_WASM_FUNCTION_INDEX_LEB: 698d1152a26SSam Clegg case wasm::R_WASM_TYPE_INDEX_LEB: 699d1152a26SSam Clegg case wasm::R_WASM_GLOBAL_INDEX_LEB: 700d1152a26SSam Clegg case wasm::R_WASM_MEMORY_ADDR_LEB: 701d1152a26SSam Clegg case wasm::R_WASM_EVENT_INDEX_LEB: 70269e2797eSPaulo Matos case wasm::R_WASM_TABLE_NUMBER_LEB: 7033b29376eSWouter van Oortmerssen writePatchableLEB<5>(Stream, Value, Offset); 7043b29376eSWouter van Oortmerssen break; 7053b29376eSWouter van Oortmerssen case wasm::R_WASM_MEMORY_ADDR_LEB64: 7063b29376eSWouter van Oortmerssen writePatchableLEB<10>(Stream, Value, Offset); 707d934cb88SDan Gohman break; 708d1152a26SSam Clegg case wasm::R_WASM_TABLE_INDEX_I32: 709d1152a26SSam Clegg case wasm::R_WASM_MEMORY_ADDR_I32: 710d1152a26SSam Clegg case wasm::R_WASM_FUNCTION_OFFSET_I32: 711d1152a26SSam Clegg case wasm::R_WASM_SECTION_OFFSET_I32: 71248139ebcSWouter van Oortmerssen case wasm::R_WASM_GLOBAL_INDEX_I32: 7130a6c4d8dSSam Clegg patchI32(Stream, Value, Offset); 714d934cb88SDan Gohman break; 715cc1b9b68SWouter van Oortmerssen case wasm::R_WASM_TABLE_INDEX_I64: 7163b29376eSWouter van Oortmerssen case wasm::R_WASM_MEMORY_ADDR_I64: 71716f02431SWouter van Oortmerssen case wasm::R_WASM_FUNCTION_OFFSET_I64: 7183b29376eSWouter van Oortmerssen patchI64(Stream, Value, Offset); 7193b29376eSWouter van Oortmerssen break; 720d1152a26SSam Clegg case wasm::R_WASM_TABLE_INDEX_SLEB: 7212a7cac93SSam Clegg case wasm::R_WASM_TABLE_INDEX_REL_SLEB: 722d1152a26SSam Clegg case wasm::R_WASM_MEMORY_ADDR_SLEB: 7232a7cac93SSam Clegg case wasm::R_WASM_MEMORY_ADDR_REL_SLEB: 724a28a4662SSam Clegg case wasm::R_WASM_MEMORY_ADDR_TLS_SLEB: 7253b29376eSWouter van Oortmerssen writePatchableSLEB<5>(Stream, Value, Offset); 7263b29376eSWouter van Oortmerssen break; 727cc1b9b68SWouter van Oortmerssen case wasm::R_WASM_TABLE_INDEX_SLEB64: 7283b29376eSWouter van Oortmerssen case wasm::R_WASM_MEMORY_ADDR_SLEB64: 7293b29376eSWouter van Oortmerssen case wasm::R_WASM_MEMORY_ADDR_REL_SLEB64: 7303b29376eSWouter van Oortmerssen writePatchableSLEB<10>(Stream, Value, Offset); 73160ec3034SSam Clegg break; 732d934cb88SDan Gohman default: 7339d24fb7fSSam Clegg llvm_unreachable("invalid relocation type"); 734d934cb88SDan Gohman } 735d934cb88SDan Gohman } 73618eafb6cSDan Gohman } 73718eafb6cSDan Gohman 7384c41fb5aSHeejin Ahn void WasmObjectWriter::writeTypeSection( 7394c41fb5aSHeejin Ahn ArrayRef<wasm::WasmSignature> Signatures) { 740da419bdbSHeejin Ahn if (Signatures.empty()) 7419e15f359SSam Clegg return; 7429e15f359SSam Clegg 7439e15f359SSam Clegg SectionBookkeeping Section; 7449e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_TYPE); 7459e15f359SSam Clegg 7460ff28fa6SDerek Schuff encodeULEB128(Signatures.size(), W->OS); 7479e15f359SSam Clegg 7484c41fb5aSHeejin Ahn for (const wasm::WasmSignature &Sig : Signatures) { 7490ff28fa6SDerek Schuff W->OS << char(wasm::WASM_TYPE_FUNC); 7500ff28fa6SDerek Schuff encodeULEB128(Sig.Params.size(), W->OS); 751da419bdbSHeejin Ahn for (wasm::ValType Ty : Sig.Params) 7529e15f359SSam Clegg writeValueType(Ty); 7530ff28fa6SDerek Schuff encodeULEB128(Sig.Returns.size(), W->OS); 754da419bdbSHeejin Ahn for (wasm::ValType Ty : Sig.Returns) 7559e15f359SSam Clegg writeValueType(Ty); 7569e15f359SSam Clegg } 7579e15f359SSam Clegg 7589e15f359SSam Clegg endSection(Section); 7599e15f359SSam Clegg } 7609e15f359SSam Clegg 7618defa952SSam Clegg void WasmObjectWriter::writeImportSection(ArrayRef<wasm::WasmImport> Imports, 7624d135b04SWouter van Oortmerssen uint64_t DataSize, 763f950b24aSSam Clegg uint32_t NumElements) { 7649e15f359SSam Clegg if (Imports.empty()) 7659e15f359SSam Clegg return; 7669e15f359SSam Clegg 7674d135b04SWouter van Oortmerssen uint64_t NumPages = (DataSize + wasm::WasmPageSize - 1) / wasm::WasmPageSize; 768f950b24aSSam Clegg 7699e15f359SSam Clegg SectionBookkeeping Section; 7709e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_IMPORT); 7719e15f359SSam Clegg 7720ff28fa6SDerek Schuff encodeULEB128(Imports.size(), W->OS); 7738defa952SSam Clegg for (const wasm::WasmImport &Import : Imports) { 7748defa952SSam Clegg writeString(Import.Module); 7758defa952SSam Clegg writeString(Import.Field); 7760ff28fa6SDerek Schuff W->OS << char(Import.Kind); 7779e15f359SSam Clegg 7789e15f359SSam Clegg switch (Import.Kind) { 7799e15f359SSam Clegg case wasm::WASM_EXTERNAL_FUNCTION: 7800ff28fa6SDerek Schuff encodeULEB128(Import.SigIndex, W->OS); 7819e15f359SSam Clegg break; 7829e15f359SSam Clegg case wasm::WASM_EXTERNAL_GLOBAL: 7830ff28fa6SDerek Schuff W->OS << char(Import.Global.Type); 7840ff28fa6SDerek Schuff W->OS << char(Import.Global.Mutable ? 1 : 0); 7859e15f359SSam Clegg break; 786f950b24aSSam Clegg case wasm::WASM_EXTERNAL_MEMORY: 7870ff28fa6SDerek Schuff encodeULEB128(Import.Memory.Flags, W->OS); 7880ff28fa6SDerek Schuff encodeULEB128(NumPages, W->OS); // initial 789f950b24aSSam Clegg break; 790f950b24aSSam Clegg case wasm::WASM_EXTERNAL_TABLE: 7910ff28fa6SDerek Schuff W->OS << char(Import.Table.ElemType); 7920ff28fa6SDerek Schuff encodeULEB128(0, W->OS); // flags 7930ff28fa6SDerek Schuff encodeULEB128(NumElements, W->OS); // initial 794f950b24aSSam Clegg break; 795da419bdbSHeejin Ahn case wasm::WASM_EXTERNAL_EVENT: 7960ff28fa6SDerek Schuff encodeULEB128(Import.Event.Attribute, W->OS); 7970ff28fa6SDerek Schuff encodeULEB128(Import.Event.SigIndex, W->OS); 798da419bdbSHeejin Ahn break; 7999e15f359SSam Clegg default: 8009e15f359SSam Clegg llvm_unreachable("unsupported import kind"); 8019e15f359SSam Clegg } 8029e15f359SSam Clegg } 8039e15f359SSam Clegg 8049e15f359SSam Clegg endSection(Section); 8059e15f359SSam Clegg } 8069e15f359SSam Clegg 807457fb0b4SSam Clegg void WasmObjectWriter::writeFunctionSection(ArrayRef<WasmFunction> Functions) { 8089e15f359SSam Clegg if (Functions.empty()) 8099e15f359SSam Clegg return; 8109e15f359SSam Clegg 8119e15f359SSam Clegg SectionBookkeeping Section; 8129e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_FUNCTION); 8139e15f359SSam Clegg 8140ff28fa6SDerek Schuff encodeULEB128(Functions.size(), W->OS); 8159e15f359SSam Clegg for (const WasmFunction &Func : Functions) 8160ff28fa6SDerek Schuff encodeULEB128(Func.SigIndex, W->OS); 8179e15f359SSam Clegg 8189e15f359SSam Clegg endSection(Section); 8199e15f359SSam Clegg } 8209e15f359SSam Clegg 821da419bdbSHeejin Ahn void WasmObjectWriter::writeEventSection(ArrayRef<wasm::WasmEventType> Events) { 822da419bdbSHeejin Ahn if (Events.empty()) 823da419bdbSHeejin Ahn return; 824da419bdbSHeejin Ahn 825da419bdbSHeejin Ahn SectionBookkeeping Section; 826da419bdbSHeejin Ahn startSection(Section, wasm::WASM_SEC_EVENT); 827da419bdbSHeejin Ahn 8280ff28fa6SDerek Schuff encodeULEB128(Events.size(), W->OS); 829da419bdbSHeejin Ahn for (const wasm::WasmEventType &Event : Events) { 8300ff28fa6SDerek Schuff encodeULEB128(Event.Attribute, W->OS); 8310ff28fa6SDerek Schuff encodeULEB128(Event.SigIndex, W->OS); 832da419bdbSHeejin Ahn } 833da419bdbSHeejin Ahn 834da419bdbSHeejin Ahn endSection(Section); 835da419bdbSHeejin Ahn } 836da419bdbSHeejin Ahn 8370a6c4d8dSSam Clegg void WasmObjectWriter::writeGlobalSection(ArrayRef<wasm::WasmGlobal> Globals) { 8380a6c4d8dSSam Clegg if (Globals.empty()) 8390a6c4d8dSSam Clegg return; 8400a6c4d8dSSam Clegg 8410a6c4d8dSSam Clegg SectionBookkeeping Section; 8420a6c4d8dSSam Clegg startSection(Section, wasm::WASM_SEC_GLOBAL); 8430a6c4d8dSSam Clegg 8440ff28fa6SDerek Schuff encodeULEB128(Globals.size(), W->OS); 8450a6c4d8dSSam Clegg for (const wasm::WasmGlobal &Global : Globals) { 8460ff28fa6SDerek Schuff encodeULEB128(Global.Type.Type, W->OS); 8470ff28fa6SDerek Schuff W->OS << char(Global.Type.Mutable); 8480ff28fa6SDerek Schuff W->OS << char(Global.InitExpr.Opcode); 8490a6c4d8dSSam Clegg switch (Global.Type.Type) { 8500a6c4d8dSSam Clegg case wasm::WASM_TYPE_I32: 8510ff28fa6SDerek Schuff encodeSLEB128(0, W->OS); 8520a6c4d8dSSam Clegg break; 8530a6c4d8dSSam Clegg case wasm::WASM_TYPE_I64: 8540ff28fa6SDerek Schuff encodeSLEB128(0, W->OS); 8550a6c4d8dSSam Clegg break; 8560a6c4d8dSSam Clegg case wasm::WASM_TYPE_F32: 8570a6c4d8dSSam Clegg writeI32(0); 8580a6c4d8dSSam Clegg break; 8590a6c4d8dSSam Clegg case wasm::WASM_TYPE_F64: 8600a6c4d8dSSam Clegg writeI64(0); 8610a6c4d8dSSam Clegg break; 86279aad89dSSam Clegg case wasm::WASM_TYPE_EXTERNREF: 86379aad89dSSam Clegg writeValueType(wasm::ValType::EXTERNREF); 86479aad89dSSam Clegg break; 8650a6c4d8dSSam Clegg default: 8660a6c4d8dSSam Clegg llvm_unreachable("unexpected type"); 8670a6c4d8dSSam Clegg } 8680ff28fa6SDerek Schuff W->OS << char(wasm::WASM_OPCODE_END); 8690a6c4d8dSSam Clegg } 8700a6c4d8dSSam Clegg 8710a6c4d8dSSam Clegg endSection(Section); 8720a6c4d8dSSam Clegg } 8730a6c4d8dSSam Clegg 874388fb67bSPaulo Matos void WasmObjectWriter::writeTableSection(ArrayRef<wasm::WasmTable> Tables) { 875388fb67bSPaulo Matos if (Tables.empty()) 876388fb67bSPaulo Matos return; 877388fb67bSPaulo Matos 878388fb67bSPaulo Matos SectionBookkeeping Section; 879388fb67bSPaulo Matos startSection(Section, wasm::WASM_SEC_TABLE); 880388fb67bSPaulo Matos 881388fb67bSPaulo Matos encodeULEB128(Tables.size(), W->OS); 882388fb67bSPaulo Matos for (const wasm::WasmTable &Table : Tables) { 8831933c9d4SAndy Wingo encodeULEB128(Table.Type.ElemType, W->OS); 8841933c9d4SAndy Wingo encodeULEB128(Table.Type.Limits.Flags, W->OS); 8851933c9d4SAndy Wingo encodeULEB128(Table.Type.Limits.Initial, W->OS); 8861933c9d4SAndy Wingo if (Table.Type.Limits.Flags & wasm::WASM_LIMITS_FLAG_HAS_MAX) 8871933c9d4SAndy Wingo encodeULEB128(Table.Type.Limits.Maximum, W->OS); 888388fb67bSPaulo Matos } 889388fb67bSPaulo Matos endSection(Section); 890388fb67bSPaulo Matos } 891388fb67bSPaulo Matos 8928defa952SSam Clegg void WasmObjectWriter::writeExportSection(ArrayRef<wasm::WasmExport> Exports) { 8939e15f359SSam Clegg if (Exports.empty()) 8949e15f359SSam Clegg return; 8959e15f359SSam Clegg 8969e15f359SSam Clegg SectionBookkeeping Section; 8979e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_EXPORT); 8989e15f359SSam Clegg 8990ff28fa6SDerek Schuff encodeULEB128(Exports.size(), W->OS); 9008defa952SSam Clegg for (const wasm::WasmExport &Export : Exports) { 9018defa952SSam Clegg writeString(Export.Name); 9020ff28fa6SDerek Schuff W->OS << char(Export.Kind); 9030ff28fa6SDerek Schuff encodeULEB128(Export.Index, W->OS); 9049e15f359SSam Clegg } 9059e15f359SSam Clegg 9069e15f359SSam Clegg endSection(Section); 9079e15f359SSam Clegg } 9089e15f359SSam Clegg 909457fb0b4SSam Clegg void WasmObjectWriter::writeElemSection(ArrayRef<uint32_t> TableElems) { 9109e15f359SSam Clegg if (TableElems.empty()) 9119e15f359SSam Clegg return; 9129e15f359SSam Clegg 9139e15f359SSam Clegg SectionBookkeeping Section; 9149e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_ELEM); 9159e15f359SSam Clegg 9160ff28fa6SDerek Schuff encodeULEB128(1, W->OS); // number of "segments" 9170ff28fa6SDerek Schuff encodeULEB128(0, W->OS); // the table index 9189e15f359SSam Clegg 9199e15f359SSam Clegg // init expr for starting offset 9200ff28fa6SDerek Schuff W->OS << char(wasm::WASM_OPCODE_I32_CONST); 9210ff28fa6SDerek Schuff encodeSLEB128(InitialTableOffset, W->OS); 9220ff28fa6SDerek Schuff W->OS << char(wasm::WASM_OPCODE_END); 9239e15f359SSam Clegg 9240ff28fa6SDerek Schuff encodeULEB128(TableElems.size(), W->OS); 9259e15f359SSam Clegg for (uint32_t Elem : TableElems) 9260ff28fa6SDerek Schuff encodeULEB128(Elem, W->OS); 9279e15f359SSam Clegg 9289e15f359SSam Clegg endSection(Section); 9299e15f359SSam Clegg } 9309e15f359SSam Clegg 931fef8de66SThomas Lively void WasmObjectWriter::writeDataCountSection() { 932fef8de66SThomas Lively if (DataSegments.empty()) 933fef8de66SThomas Lively return; 934fef8de66SThomas Lively 935fef8de66SThomas Lively SectionBookkeeping Section; 936fef8de66SThomas Lively startSection(Section, wasm::WASM_SEC_DATACOUNT); 9370ff28fa6SDerek Schuff encodeULEB128(DataSegments.size(), W->OS); 938fef8de66SThomas Lively endSection(Section); 939fef8de66SThomas Lively } 940fef8de66SThomas Lively 941e49584a3SSam Clegg uint32_t WasmObjectWriter::writeCodeSection(const MCAssembler &Asm, 942457fb0b4SSam Clegg const MCAsmLayout &Layout, 943457fb0b4SSam Clegg ArrayRef<WasmFunction> Functions) { 9449e15f359SSam Clegg if (Functions.empty()) 945e49584a3SSam Clegg return 0; 9469e15f359SSam Clegg 9479e15f359SSam Clegg SectionBookkeeping Section; 9489e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_CODE); 9499e15f359SSam Clegg 9500ff28fa6SDerek Schuff encodeULEB128(Functions.size(), W->OS); 9519e15f359SSam Clegg 9529e15f359SSam Clegg for (const WasmFunction &Func : Functions) { 953fe6414b0SSam Clegg auto &FuncSection = static_cast<MCSectionWasm &>(Func.Sym->getSection()); 9549e15f359SSam Clegg 9559e15f359SSam Clegg int64_t Size = 0; 9569e15f359SSam Clegg if (!Func.Sym->getSize()->evaluateAsAbsolute(Size, Layout)) 9579e15f359SSam Clegg report_fatal_error(".size expression must be evaluatable"); 9589e15f359SSam Clegg 9590ff28fa6SDerek Schuff encodeULEB128(Size, W->OS); 9600ff28fa6SDerek Schuff FuncSection.setSectionOffset(W->OS.tell() - Section.ContentsOffset); 9610ff28fa6SDerek Schuff Asm.writeSectionData(W->OS, &FuncSection, Layout); 9629e15f359SSam Clegg } 9639e15f359SSam Clegg 9649e15f359SSam Clegg // Apply fixups. 9657ee758d6SSam Clegg applyRelocations(CodeRelocations, Section.ContentsOffset, Layout); 9669e15f359SSam Clegg 9679e15f359SSam Clegg endSection(Section); 968e49584a3SSam Clegg return Section.Index; 9699e15f359SSam Clegg } 9709e15f359SSam Clegg 971e49584a3SSam Clegg uint32_t WasmObjectWriter::writeDataSection(const MCAsmLayout &Layout) { 9726c899ba6SSam Clegg if (DataSegments.empty()) 973e49584a3SSam Clegg return 0; 9749e15f359SSam Clegg 9759e15f359SSam Clegg SectionBookkeeping Section; 9769e15f359SSam Clegg startSection(Section, wasm::WASM_SEC_DATA); 9779e15f359SSam Clegg 9780ff28fa6SDerek Schuff encodeULEB128(DataSegments.size(), W->OS); // count 9797c395943SSam Clegg 9806c899ba6SSam Clegg for (const WasmDataSegment &Segment : DataSegments) { 9810ff28fa6SDerek Schuff encodeULEB128(Segment.InitFlags, W->OS); // flags 982831a143eSAndy Wingo if (Segment.InitFlags & wasm::WASM_DATA_SEGMENT_HAS_MEMINDEX) 9830ff28fa6SDerek Schuff encodeULEB128(0, W->OS); // memory index 984831a143eSAndy Wingo if ((Segment.InitFlags & wasm::WASM_DATA_SEGMENT_IS_PASSIVE) == 0) { 9850ff28fa6SDerek Schuff W->OS << char(Segment.Offset > INT32_MAX ? wasm::WASM_OPCODE_I64_CONST 9864d135b04SWouter van Oortmerssen : wasm::WASM_OPCODE_I32_CONST); 9870ff28fa6SDerek Schuff encodeSLEB128(Segment.Offset, W->OS); // offset 9880ff28fa6SDerek Schuff W->OS << char(wasm::WASM_OPCODE_END); 9892e150409SThomas Lively } 9900ff28fa6SDerek Schuff encodeULEB128(Segment.Data.size(), W->OS); // size 9910ff28fa6SDerek Schuff Segment.Section->setSectionOffset(W->OS.tell() - Section.ContentsOffset); 9920ff28fa6SDerek Schuff W->OS << Segment.Data; // data 9937c395943SSam Clegg } 9949e15f359SSam Clegg 9959e15f359SSam Clegg // Apply fixups. 9967ee758d6SSam Clegg applyRelocations(DataRelocations, Section.ContentsOffset, Layout); 9979e15f359SSam Clegg 9989e15f359SSam Clegg endSection(Section); 999e49584a3SSam Clegg return Section.Index; 10009e15f359SSam Clegg } 10019e15f359SSam Clegg 10026f08c84aSSam Clegg void WasmObjectWriter::writeRelocSection( 10036f08c84aSSam Clegg uint32_t SectionIndex, StringRef Name, 1004f77dc2a8SSam Clegg std::vector<WasmRelocationEntry> &Relocs) { 10059e15f359SSam Clegg // See: https://github.com/WebAssembly/tool-conventions/blob/master/Linking.md 10069e15f359SSam Clegg // for descriptions of the reloc sections. 10079e15f359SSam Clegg 1008f77dc2a8SSam Clegg if (Relocs.empty()) 10099e15f359SSam Clegg return; 10109e15f359SSam Clegg 1011f77dc2a8SSam Clegg // First, ensure the relocations are sorted in offset order. In general they 1012f77dc2a8SSam Clegg // should already be sorted since `recordRelocation` is called in offset 1013f77dc2a8SSam Clegg // order, but for the code section we combine many MC sections into single 1014f77dc2a8SSam Clegg // wasm section, and this order is determined by the order of Asm.Symbols() 1015f77dc2a8SSam Clegg // not the sections order. 1016efd94c56SFangrui Song llvm::stable_sort( 1017efd94c56SFangrui Song Relocs, [](const WasmRelocationEntry &A, const WasmRelocationEntry &B) { 1018f77dc2a8SSam Clegg return (A.Offset + A.FixupSection->getSectionOffset()) < 1019f77dc2a8SSam Clegg (B.Offset + B.FixupSection->getSectionOffset()); 1020f77dc2a8SSam Clegg }); 1021f77dc2a8SSam Clegg 10229e15f359SSam Clegg SectionBookkeeping Section; 10236f08c84aSSam Clegg startCustomSection(Section, std::string("reloc.") + Name.str()); 10249e15f359SSam Clegg 10250ff28fa6SDerek Schuff encodeULEB128(SectionIndex, W->OS); 10260ff28fa6SDerek Schuff encodeULEB128(Relocs.size(), W->OS); 1027f77dc2a8SSam Clegg for (const WasmRelocationEntry &RelEntry : Relocs) { 1028f208f631SHeejin Ahn uint64_t Offset = 1029f208f631SHeejin Ahn RelEntry.Offset + RelEntry.FixupSection->getSectionOffset(); 10306f08c84aSSam Clegg uint32_t Index = getRelocationIndexValue(RelEntry); 10319e15f359SSam Clegg 10320ff28fa6SDerek Schuff W->OS << char(RelEntry.Type); 10330ff28fa6SDerek Schuff encodeULEB128(Offset, W->OS); 10340ff28fa6SDerek Schuff encodeULEB128(Index, W->OS); 10356f08c84aSSam Clegg if (RelEntry.hasAddend()) 10360ff28fa6SDerek Schuff encodeSLEB128(RelEntry.Addend, W->OS); 10379e15f359SSam Clegg } 10389e15f359SSam Clegg 10399e15f359SSam Clegg endSection(Section); 10409e15f359SSam Clegg } 10419e15f359SSam Clegg 10426a31a0d6SSam Clegg void WasmObjectWriter::writeCustomRelocSections() { 10436a31a0d6SSam Clegg for (const auto &Sec : CustomSections) { 10446a31a0d6SSam Clegg auto &Relocations = CustomSectionsRelocations[Sec.Section]; 10456a31a0d6SSam Clegg writeRelocSection(Sec.OutputIndex, Sec.Name, Relocations); 10466a31a0d6SSam Clegg } 10476a31a0d6SSam Clegg } 10486a31a0d6SSam Clegg 10499e15f359SSam Clegg void WasmObjectWriter::writeLinkingMetaDataSection( 105086b4a09aSSam Clegg ArrayRef<wasm::WasmSymbolInfo> SymbolInfos, 1051ea7caceeSSam Clegg ArrayRef<std::pair<uint16_t, uint32_t>> InitFuncs, 1052ea7caceeSSam Clegg const std::map<StringRef, std::vector<WasmComdatEntry>> &Comdats) { 10539e15f359SSam Clegg SectionBookkeeping Section; 10542322a937SSam Clegg startCustomSection(Section, "linking"); 10550ff28fa6SDerek Schuff encodeULEB128(wasm::WasmMetadataVersion, W->OS); 10569e15f359SSam Clegg 10576bb5a41fSSam Clegg SectionBookkeeping SubSection; 10586c899ba6SSam Clegg if (SymbolInfos.size() != 0) { 10596c899ba6SSam Clegg startSection(SubSection, wasm::WASM_SYMBOL_TABLE); 10600ff28fa6SDerek Schuff encodeULEB128(SymbolInfos.size(), W->OS); 10616c899ba6SSam Clegg for (const wasm::WasmSymbolInfo &Sym : SymbolInfos) { 10620ff28fa6SDerek Schuff encodeULEB128(Sym.Kind, W->OS); 10630ff28fa6SDerek Schuff encodeULEB128(Sym.Flags, W->OS); 10646c899ba6SSam Clegg switch (Sym.Kind) { 10656c899ba6SSam Clegg case wasm::WASM_SYMBOL_TYPE_FUNCTION: 10666c899ba6SSam Clegg case wasm::WASM_SYMBOL_TYPE_GLOBAL: 1067da419bdbSHeejin Ahn case wasm::WASM_SYMBOL_TYPE_EVENT: 1068388fb67bSPaulo Matos case wasm::WASM_SYMBOL_TYPE_TABLE: 10690ff28fa6SDerek Schuff encodeULEB128(Sym.ElementIndex, W->OS); 107029874ceaSDan Gohman if ((Sym.Flags & wasm::WASM_SYMBOL_UNDEFINED) == 0 || 107129874ceaSDan Gohman (Sym.Flags & wasm::WASM_SYMBOL_EXPLICIT_NAME) != 0) 10726c899ba6SSam Clegg writeString(Sym.Name); 10736c899ba6SSam Clegg break; 10746c899ba6SSam Clegg case wasm::WASM_SYMBOL_TYPE_DATA: 10756c899ba6SSam Clegg writeString(Sym.Name); 10766c899ba6SSam Clegg if ((Sym.Flags & wasm::WASM_SYMBOL_UNDEFINED) == 0) { 10770ff28fa6SDerek Schuff encodeULEB128(Sym.DataRef.Segment, W->OS); 10780ff28fa6SDerek Schuff encodeULEB128(Sym.DataRef.Offset, W->OS); 10790ff28fa6SDerek Schuff encodeULEB128(Sym.DataRef.Size, W->OS); 10806c899ba6SSam Clegg } 10816c899ba6SSam Clegg break; 10826a31a0d6SSam Clegg case wasm::WASM_SYMBOL_TYPE_SECTION: { 10836a31a0d6SSam Clegg const uint32_t SectionIndex = 10846a31a0d6SSam Clegg CustomSections[Sym.ElementIndex].OutputIndex; 10850ff28fa6SDerek Schuff encodeULEB128(SectionIndex, W->OS); 10866a31a0d6SSam Clegg break; 10876a31a0d6SSam Clegg } 10886c899ba6SSam Clegg default: 10896c899ba6SSam Clegg llvm_unreachable("unexpected kind"); 10906c899ba6SSam Clegg } 1091b7787fd0SSam Clegg } 1092b7787fd0SSam Clegg endSection(SubSection); 1093b7787fd0SSam Clegg } 10949e15f359SSam Clegg 10956c899ba6SSam Clegg if (DataSegments.size()) { 109663ebb813SSam Clegg startSection(SubSection, wasm::WASM_SEGMENT_INFO); 10970ff28fa6SDerek Schuff encodeULEB128(DataSegments.size(), W->OS); 10986c899ba6SSam Clegg for (const WasmDataSegment &Segment : DataSegments) { 1099d95ed959SSam Clegg writeString(Segment.Name); 11000ff28fa6SDerek Schuff encodeULEB128(Segment.Alignment, W->OS); 11010ff28fa6SDerek Schuff encodeULEB128(Segment.LinkerFlags, W->OS); 110263ebb813SSam Clegg } 1103d95ed959SSam Clegg endSection(SubSection); 1104d95ed959SSam Clegg } 1105d95ed959SSam Clegg 1106bafe6902SSam Clegg if (!InitFuncs.empty()) { 1107bafe6902SSam Clegg startSection(SubSection, wasm::WASM_INIT_FUNCS); 11080ff28fa6SDerek Schuff encodeULEB128(InitFuncs.size(), W->OS); 1109bafe6902SSam Clegg for (auto &StartFunc : InitFuncs) { 11100ff28fa6SDerek Schuff encodeULEB128(StartFunc.first, W->OS); // priority 11110ff28fa6SDerek Schuff encodeULEB128(StartFunc.second, W->OS); // function index 1112bafe6902SSam Clegg } 1113bafe6902SSam Clegg endSection(SubSection); 1114bafe6902SSam Clegg } 1115bafe6902SSam Clegg 1116ea7caceeSSam Clegg if (Comdats.size()) { 1117ea7caceeSSam Clegg startSection(SubSection, wasm::WASM_COMDAT_INFO); 11180ff28fa6SDerek Schuff encodeULEB128(Comdats.size(), W->OS); 1119ea7caceeSSam Clegg for (const auto &C : Comdats) { 1120ea7caceeSSam Clegg writeString(C.first); 11210ff28fa6SDerek Schuff encodeULEB128(0, W->OS); // flags for future use 11220ff28fa6SDerek Schuff encodeULEB128(C.second.size(), W->OS); 1123ea7caceeSSam Clegg for (const WasmComdatEntry &Entry : C.second) { 11240ff28fa6SDerek Schuff encodeULEB128(Entry.Kind, W->OS); 11250ff28fa6SDerek Schuff encodeULEB128(Entry.Index, W->OS); 1126ea7caceeSSam Clegg } 1127ea7caceeSSam Clegg } 1128ea7caceeSSam Clegg endSection(SubSection); 1129ea7caceeSSam Clegg } 1130ea7caceeSSam Clegg 11319e15f359SSam Clegg endSection(Section); 11329e15f359SSam Clegg } 11339e15f359SSam Clegg 1134cbda16ebSThomas Lively void WasmObjectWriter::writeCustomSection(WasmCustomSection &CustomSection, 1135cbda16ebSThomas Lively const MCAssembler &Asm, 11366a31a0d6SSam Clegg const MCAsmLayout &Layout) { 1137cfd44a2eSSam Clegg SectionBookkeeping Section; 11386a31a0d6SSam Clegg auto *Sec = CustomSection.Section; 11392322a937SSam Clegg startCustomSection(Section, CustomSection.Name); 11406a31a0d6SSam Clegg 11410ff28fa6SDerek Schuff Sec->setSectionOffset(W->OS.tell() - Section.ContentsOffset); 11420ff28fa6SDerek Schuff Asm.writeSectionData(W->OS, Sec, Layout); 11436a31a0d6SSam Clegg 11446a31a0d6SSam Clegg CustomSection.OutputContentsOffset = Section.ContentsOffset; 11456a31a0d6SSam Clegg CustomSection.OutputIndex = Section.Index; 11466a31a0d6SSam Clegg 1147cfd44a2eSSam Clegg endSection(Section); 11486a31a0d6SSam Clegg 11496a31a0d6SSam Clegg // Apply fixups. 11504d57fbd0SSam Clegg auto &Relocations = CustomSectionsRelocations[CustomSection.Section]; 11517ee758d6SSam Clegg applyRelocations(Relocations, CustomSection.OutputContentsOffset, Layout); 11526a31a0d6SSam Clegg } 11536a31a0d6SSam Clegg 11545e3d33a7SSam Clegg uint32_t WasmObjectWriter::getFunctionType(const MCSymbolWasm &Symbol) { 11555e3d33a7SSam Clegg assert(Symbol.isFunction()); 11565e3d33a7SSam Clegg assert(TypeIndices.count(&Symbol)); 11575e3d33a7SSam Clegg return TypeIndices[&Symbol]; 11585e3d33a7SSam Clegg } 11595e3d33a7SSam Clegg 1160da419bdbSHeejin Ahn uint32_t WasmObjectWriter::getEventType(const MCSymbolWasm &Symbol) { 1161da419bdbSHeejin Ahn assert(Symbol.isEvent()); 1162da419bdbSHeejin Ahn assert(TypeIndices.count(&Symbol)); 1163da419bdbSHeejin Ahn return TypeIndices[&Symbol]; 1164da419bdbSHeejin Ahn } 1165da419bdbSHeejin Ahn 116638b12f5eSHeejin Ahn void WasmObjectWriter::registerFunctionType(const MCSymbolWasm &Symbol) { 11675e3d33a7SSam Clegg assert(Symbol.isFunction()); 11685e3d33a7SSam Clegg 11694c41fb5aSHeejin Ahn wasm::WasmSignature S; 11707ee758d6SSam Clegg 11717ee758d6SSam Clegg if (auto *Sig = Symbol.getSignature()) { 1172da419bdbSHeejin Ahn S.Returns = Sig->Returns; 1173da419bdbSHeejin Ahn S.Params = Sig->Params; 117477a7a380SDerek Schuff } 11755e3d33a7SSam Clegg 1176da419bdbSHeejin Ahn auto Pair = SignatureIndices.insert(std::make_pair(S, Signatures.size())); 11775e3d33a7SSam Clegg if (Pair.second) 1178da419bdbSHeejin Ahn Signatures.push_back(S); 11795e3d33a7SSam Clegg TypeIndices[&Symbol] = Pair.first->second; 11805e3d33a7SSam Clegg 1181d34e60caSNicola Zaghen LLVM_DEBUG(dbgs() << "registerFunctionType: " << Symbol 1182d34e60caSNicola Zaghen << " new:" << Pair.second << "\n"); 1183d34e60caSNicola Zaghen LLVM_DEBUG(dbgs() << " -> type index: " << Pair.first->second << "\n"); 11845e3d33a7SSam Clegg } 11855e3d33a7SSam Clegg 118638b12f5eSHeejin Ahn void WasmObjectWriter::registerEventType(const MCSymbolWasm &Symbol) { 1187da419bdbSHeejin Ahn assert(Symbol.isEvent()); 1188da419bdbSHeejin Ahn 1189da419bdbSHeejin Ahn // TODO Currently we don't generate imported exceptions, but if we do, we 1190da419bdbSHeejin Ahn // should have a way of infering types of imported exceptions. 11914c41fb5aSHeejin Ahn wasm::WasmSignature S; 1192da419bdbSHeejin Ahn if (auto *Sig = Symbol.getSignature()) { 1193da419bdbSHeejin Ahn S.Returns = Sig->Returns; 1194da419bdbSHeejin Ahn S.Params = Sig->Params; 1195da419bdbSHeejin Ahn } 1196da419bdbSHeejin Ahn 1197da419bdbSHeejin Ahn auto Pair = SignatureIndices.insert(std::make_pair(S, Signatures.size())); 1198da419bdbSHeejin Ahn if (Pair.second) 1199da419bdbSHeejin Ahn Signatures.push_back(S); 1200da419bdbSHeejin Ahn TypeIndices[&Symbol] = Pair.first->second; 1201da419bdbSHeejin Ahn 1202da419bdbSHeejin Ahn LLVM_DEBUG(dbgs() << "registerEventType: " << Symbol << " new:" << Pair.second 1203da419bdbSHeejin Ahn << "\n"); 1204da419bdbSHeejin Ahn LLVM_DEBUG(dbgs() << " -> type index: " << Pair.first->second << "\n"); 1205da419bdbSHeejin Ahn } 1206da419bdbSHeejin Ahn 12074d57fbd0SSam Clegg static bool isInSymtab(const MCSymbolWasm &Sym) { 12083ea1c62cSSam Clegg if (Sym.isUsedInReloc() || Sym.isUsedInInitArray()) 12094d57fbd0SSam Clegg return true; 12104d57fbd0SSam Clegg 12114d57fbd0SSam Clegg if (Sym.isComdat() && !Sym.isDefined()) 12124d57fbd0SSam Clegg return false; 12134d57fbd0SSam Clegg 12143ea1c62cSSam Clegg if (Sym.isTemporary()) 12154d57fbd0SSam Clegg return false; 12164d57fbd0SSam Clegg 12174d57fbd0SSam Clegg if (Sym.isSection()) 12184d57fbd0SSam Clegg return false; 12194d57fbd0SSam Clegg 12204d57fbd0SSam Clegg return true; 12214d57fbd0SSam Clegg } 122230d314aaSSam Clegg 12230ff28fa6SDerek Schuff void WasmObjectWriter::prepareImports( 12240ff28fa6SDerek Schuff SmallVectorImpl<wasm::WasmImport> &Imports, MCAssembler &Asm, 122518eafb6cSDan Gohman const MCAsmLayout &Layout) { 1226f950b24aSSam Clegg // For now, always emit the memory import, since loads and stores are not 1227f950b24aSSam Clegg // valid without it. In the future, we could perhaps be more clever and omit 1228f950b24aSSam Clegg // it if there are no loads or stores. 12298defa952SSam Clegg wasm::WasmImport MemImport; 12301ed3a046SSam Clegg MemImport.Module = "env"; 12311ed3a046SSam Clegg MemImport.Field = "__linear_memory"; 1232f950b24aSSam Clegg MemImport.Kind = wasm::WASM_EXTERNAL_MEMORY; 1233fd0964aeSWouter van Oortmerssen MemImport.Memory.Flags = is64Bit() ? wasm::WASM_LIMITS_FLAG_IS_64 1234fd0964aeSWouter van Oortmerssen : wasm::WASM_LIMITS_FLAG_NONE; 1235f950b24aSSam Clegg Imports.push_back(MemImport); 1236f950b24aSSam Clegg 1237da419bdbSHeejin Ahn // Populate SignatureIndices, and Imports and WasmIndices for undefined 1238586320c0SNicholas Wilson // symbols. This must be done before populating WasmIndices for defined 1239586320c0SNicholas Wilson // symbols. 124032ce5ca0SDan Gohman for (const MCSymbol &S : Asm.symbols()) { 124132ce5ca0SDan Gohman const auto &WS = static_cast<const MCSymbolWasm &>(S); 124232ce5ca0SDan Gohman 124332ce5ca0SDan Gohman // Register types for all functions, including those with private linkage 12449f3fe42eSSam Clegg // (because wasm always needs a type signature). 12457ee758d6SSam Clegg if (WS.isFunction()) { 12469c7b5808SDominic Chen const auto *BS = Layout.getBaseSymbol(S); 12479c7b5808SDominic Chen if (!BS) 12489c7b5808SDominic Chen report_fatal_error(Twine(S.getName()) + 12499c7b5808SDominic Chen ": absolute addressing not supported!"); 12509c7b5808SDominic Chen registerFunctionType(*cast<MCSymbolWasm>(BS)); 12517ee758d6SSam Clegg } 125232ce5ca0SDan Gohman 1253da419bdbSHeejin Ahn if (WS.isEvent()) 1254da419bdbSHeejin Ahn registerEventType(WS); 1255da419bdbSHeejin Ahn 125632ce5ca0SDan Gohman if (WS.isTemporary()) 125732ce5ca0SDan Gohman continue; 125832ce5ca0SDan Gohman 125932ce5ca0SDan Gohman // If the symbol is not defined in this translation unit, import it. 12606c899ba6SSam Clegg if (!WS.isDefined() && !WS.isComdat()) { 12616c899ba6SSam Clegg if (WS.isFunction()) { 12628defa952SSam Clegg wasm::WasmImport Import; 1263f726e445SDan Gohman Import.Module = WS.getImportModule(); 1264f726e445SDan Gohman Import.Field = WS.getImportName(); 126532ce5ca0SDan Gohman Import.Kind = wasm::WASM_EXTERNAL_FUNCTION; 12668defa952SSam Clegg Import.SigIndex = getFunctionType(WS); 12676c899ba6SSam Clegg Imports.push_back(Import); 1268492f7529SSam Clegg assert(WasmIndices.count(&WS) == 0); 12696c899ba6SSam Clegg WasmIndices[&WS] = NumFunctionImports++; 12706c899ba6SSam Clegg } else if (WS.isGlobal()) { 127115f349f7SNicholas Wilson if (WS.isWeak()) 127215f349f7SNicholas Wilson report_fatal_error("undefined global symbol cannot be weak"); 127315f349f7SNicholas Wilson 12746c899ba6SSam Clegg wasm::WasmImport Import; 1275f726e445SDan Gohman Import.Field = WS.getImportName(); 127632ce5ca0SDan Gohman Import.Kind = wasm::WASM_EXTERNAL_GLOBAL; 1277492f7529SSam Clegg Import.Module = WS.getImportModule(); 12786c899ba6SSam Clegg Import.Global = WS.getGlobalType(); 12796c899ba6SSam Clegg Imports.push_back(Import); 1280492f7529SSam Clegg assert(WasmIndices.count(&WS) == 0); 12816c899ba6SSam Clegg WasmIndices[&WS] = NumGlobalImports++; 1282da419bdbSHeejin Ahn } else if (WS.isEvent()) { 1283da419bdbSHeejin Ahn if (WS.isWeak()) 1284da419bdbSHeejin Ahn report_fatal_error("undefined event symbol cannot be weak"); 1285da419bdbSHeejin Ahn 1286da419bdbSHeejin Ahn wasm::WasmImport Import; 1287f726e445SDan Gohman Import.Module = WS.getImportModule(); 1288f726e445SDan Gohman Import.Field = WS.getImportName(); 1289da419bdbSHeejin Ahn Import.Kind = wasm::WASM_EXTERNAL_EVENT; 1290da419bdbSHeejin Ahn Import.Event.Attribute = wasm::WASM_EVENT_ATTRIBUTE_EXCEPTION; 1291da419bdbSHeejin Ahn Import.Event.SigIndex = getEventType(WS); 1292da419bdbSHeejin Ahn Imports.push_back(Import); 1293492f7529SSam Clegg assert(WasmIndices.count(&WS) == 0); 1294da419bdbSHeejin Ahn WasmIndices[&WS] = NumEventImports++; 1295feac819eSAndy Wingo } else if (WS.isTable()) { 1296feac819eSAndy Wingo if (WS.isWeak()) 1297feac819eSAndy Wingo report_fatal_error("undefined table symbol cannot be weak"); 1298feac819eSAndy Wingo 1299feac819eSAndy Wingo wasm::WasmImport Import; 1300feac819eSAndy Wingo Import.Module = WS.getImportModule(); 1301feac819eSAndy Wingo Import.Field = WS.getImportName(); 1302feac819eSAndy Wingo Import.Kind = wasm::WASM_EXTERNAL_TABLE; 1303feac819eSAndy Wingo wasm::ValType ElemType = WS.getTableType(); 1304feac819eSAndy Wingo Import.Table.ElemType = uint8_t(ElemType); 1305feac819eSAndy Wingo // FIXME: Extend table type to include limits? For now we don't specify 1306feac819eSAndy Wingo // a min or max which does not place any restrictions on the size of the 1307feac819eSAndy Wingo // imported table. 1308feac819eSAndy Wingo Import.Table.Limits = {wasm::WASM_LIMITS_FLAG_NONE, 0, 0}; 1309feac819eSAndy Wingo Imports.push_back(Import); 1310feac819eSAndy Wingo assert(WasmIndices.count(&WS) == 0); 1311feac819eSAndy Wingo WasmIndices[&WS] = NumTableImports++; 131232ce5ca0SDan Gohman } 131332ce5ca0SDan Gohman } 131432ce5ca0SDan Gohman } 131532ce5ca0SDan Gohman 1316492f7529SSam Clegg // Add imports for GOT globals 1317492f7529SSam Clegg for (const MCSymbol &S : Asm.symbols()) { 1318492f7529SSam Clegg const auto &WS = static_cast<const MCSymbolWasm &>(S); 1319492f7529SSam Clegg if (WS.isUsedInGOT()) { 1320492f7529SSam Clegg wasm::WasmImport Import; 1321492f7529SSam Clegg if (WS.isFunction()) 1322492f7529SSam Clegg Import.Module = "GOT.func"; 1323492f7529SSam Clegg else 1324492f7529SSam Clegg Import.Module = "GOT.mem"; 1325492f7529SSam Clegg Import.Field = WS.getName(); 1326492f7529SSam Clegg Import.Kind = wasm::WASM_EXTERNAL_GLOBAL; 1327492f7529SSam Clegg Import.Global = {wasm::WASM_TYPE_I32, true}; 1328492f7529SSam Clegg Imports.push_back(Import); 1329492f7529SSam Clegg assert(GOTIndices.count(&WS) == 0); 1330492f7529SSam Clegg GOTIndices[&WS] = NumGlobalImports++; 1331492f7529SSam Clegg } 1332492f7529SSam Clegg } 13330ff28fa6SDerek Schuff } 1334492f7529SSam Clegg 13350ff28fa6SDerek Schuff uint64_t WasmObjectWriter::writeObject(MCAssembler &Asm, 13360ff28fa6SDerek Schuff const MCAsmLayout &Layout) { 13370ff28fa6SDerek Schuff support::endian::Writer MainWriter(*OS, support::little); 13380ff28fa6SDerek Schuff W = &MainWriter; 13390ff28fa6SDerek Schuff if (IsSplitDwarf) { 13400ff28fa6SDerek Schuff uint64_t TotalSize = writeOneObject(Asm, Layout, DwoMode::NonDwoOnly); 13410ff28fa6SDerek Schuff assert(DwoOS); 13420ff28fa6SDerek Schuff support::endian::Writer DwoWriter(*DwoOS, support::little); 13430ff28fa6SDerek Schuff W = &DwoWriter; 13440ff28fa6SDerek Schuff return TotalSize + writeOneObject(Asm, Layout, DwoMode::DwoOnly); 13450ff28fa6SDerek Schuff } else { 13460ff28fa6SDerek Schuff return writeOneObject(Asm, Layout, DwoMode::AllSections); 13470ff28fa6SDerek Schuff } 13480ff28fa6SDerek Schuff } 13490ff28fa6SDerek Schuff 13500ff28fa6SDerek Schuff uint64_t WasmObjectWriter::writeOneObject(MCAssembler &Asm, 13510ff28fa6SDerek Schuff const MCAsmLayout &Layout, 13520ff28fa6SDerek Schuff DwoMode Mode) { 13530ff28fa6SDerek Schuff uint64_t StartOffset = W->OS.tell(); 13540ff28fa6SDerek Schuff SectionCount = 0; 13550ff28fa6SDerek Schuff CustomSections.clear(); 13560ff28fa6SDerek Schuff 13570ff28fa6SDerek Schuff LLVM_DEBUG(dbgs() << "WasmObjectWriter::writeObject\n"); 13580ff28fa6SDerek Schuff 13590ff28fa6SDerek Schuff // Collect information from the available symbols. 13600ff28fa6SDerek Schuff SmallVector<WasmFunction, 4> Functions; 13610ff28fa6SDerek Schuff SmallVector<uint32_t, 4> TableElems; 13620ff28fa6SDerek Schuff SmallVector<wasm::WasmImport, 4> Imports; 13630ff28fa6SDerek Schuff SmallVector<wasm::WasmExport, 4> Exports; 13640ff28fa6SDerek Schuff SmallVector<wasm::WasmEventType, 1> Events; 13650ff28fa6SDerek Schuff SmallVector<wasm::WasmGlobal, 1> Globals; 1366388fb67bSPaulo Matos SmallVector<wasm::WasmTable, 1> Tables; 13670ff28fa6SDerek Schuff SmallVector<wasm::WasmSymbolInfo, 4> SymbolInfos; 13680ff28fa6SDerek Schuff SmallVector<std::pair<uint16_t, uint32_t>, 2> InitFuncs; 13690ff28fa6SDerek Schuff std::map<StringRef, std::vector<WasmComdatEntry>> Comdats; 13700ff28fa6SDerek Schuff uint64_t DataSize = 0; 13710ff28fa6SDerek Schuff if (Mode != DwoMode::DwoOnly) { 13720ff28fa6SDerek Schuff prepareImports(Imports, Asm, Layout); 13730ff28fa6SDerek Schuff } 137430d314aaSSam Clegg 13754d57fbd0SSam Clegg // Populate DataSegments and CustomSections, which must be done before 13764d57fbd0SSam Clegg // populating DataLocations. 1377759631c7SSam Clegg for (MCSection &Sec : Asm) { 1378759631c7SSam Clegg auto &Section = static_cast<MCSectionWasm &>(Sec); 13797d1ff446SFangrui Song StringRef SectionName = Section.getName(); 1380759631c7SSam Clegg 13810ff28fa6SDerek Schuff if (Mode == DwoMode::NonDwoOnly && isDwoSection(Sec)) 13820ff28fa6SDerek Schuff continue; 13830ff28fa6SDerek Schuff if (Mode == DwoMode::DwoOnly && !isDwoSection(Sec)) 13840ff28fa6SDerek Schuff continue; 13850ff28fa6SDerek Schuff 13868d396acaSDerek Schuff LLVM_DEBUG(dbgs() << "Processing Section " << SectionName << " group " 13878d396acaSDerek Schuff << Section.getGroup() << "\n";); 13888d396acaSDerek Schuff 1389bafe6902SSam Clegg // .init_array sections are handled specially elsewhere. 13904d57fbd0SSam Clegg if (SectionName.startswith(".init_array")) 1391bafe6902SSam Clegg continue; 1392bafe6902SSam Clegg 13934d57fbd0SSam Clegg // Code is handled separately 13944d57fbd0SSam Clegg if (Section.getKind().isText()) 13954d57fbd0SSam Clegg continue; 13964d57fbd0SSam Clegg 13974d57fbd0SSam Clegg if (Section.isWasmData()) { 1398329e76d5SSam Clegg uint32_t SegmentIndex = DataSegments.size(); 1399759631c7SSam Clegg DataSize = alignTo(DataSize, Section.getAlignment()); 1400759631c7SSam Clegg DataSegments.emplace_back(); 1401759631c7SSam Clegg WasmDataSegment &Segment = DataSegments.back(); 14024d57fbd0SSam Clegg Segment.Name = SectionName; 1403831a143eSAndy Wingo Segment.InitFlags = Section.getPassive() 1404831a143eSAndy Wingo ? (uint32_t)wasm::WASM_DATA_SEGMENT_IS_PASSIVE 1405831a143eSAndy Wingo : 0; 1406759631c7SSam Clegg Segment.Offset = DataSize; 1407759631c7SSam Clegg Segment.Section = &Section; 140863ebb813SSam Clegg addData(Segment.Data, Section); 140956c587adSSam Clegg Segment.Alignment = Log2_32(Section.getAlignment()); 14102e150409SThomas Lively Segment.LinkerFlags = 0; 1411759631c7SSam Clegg DataSize += Segment.Data.size(); 14126c899ba6SSam Clegg Section.setSegmentIndex(SegmentIndex); 1413ea7caceeSSam Clegg 1414ea7caceeSSam Clegg if (const MCSymbolWasm *C = Section.getGroup()) { 1415ea7caceeSSam Clegg Comdats[C->getName()].emplace_back( 1416329e76d5SSam Clegg WasmComdatEntry{wasm::WASM_COMDAT_DATA, SegmentIndex}); 1417ea7caceeSSam Clegg } 14184d57fbd0SSam Clegg } else { 14194d57fbd0SSam Clegg // Create custom sections 14204d57fbd0SSam Clegg assert(Sec.getKind().isMetadata()); 14214d57fbd0SSam Clegg 14224d57fbd0SSam Clegg StringRef Name = SectionName; 14234d57fbd0SSam Clegg 14244d57fbd0SSam Clegg // For user-defined custom sections, strip the prefix 14254d57fbd0SSam Clegg if (Name.startswith(".custom_section.")) 14264d57fbd0SSam Clegg Name = Name.substr(strlen(".custom_section.")); 14274d57fbd0SSam Clegg 14284d57fbd0SSam Clegg MCSymbol *Begin = Sec.getBeginSymbol(); 1429fb807d4dSSam Clegg if (Begin) { 143030d314aaSSam Clegg assert(WasmIndices.count(cast<MCSymbolWasm>(Begin)) == 0); 14314d57fbd0SSam Clegg WasmIndices[cast<MCSymbolWasm>(Begin)] = CustomSections.size(); 1432fb807d4dSSam Clegg } 1433cbda16ebSThomas Lively 1434f6f4f843SThomas Lively // Separate out the producers and target features sections 1435cbda16ebSThomas Lively if (Name == "producers") { 14360eaee545SJonas Devlieghere ProducersSection = std::make_unique<WasmCustomSection>(Name, &Section); 1437cbda16ebSThomas Lively continue; 1438cbda16ebSThomas Lively } 1439f6f4f843SThomas Lively if (Name == "target_features") { 1440f6f4f843SThomas Lively TargetFeaturesSection = 14410eaee545SJonas Devlieghere std::make_unique<WasmCustomSection>(Name, &Section); 1442f6f4f843SThomas Lively continue; 1443f6f4f843SThomas Lively } 1444cbda16ebSThomas Lively 14450a391060SDerek Schuff // Custom sections can also belong to COMDAT groups. In this case the 14460a391060SDerek Schuff // decriptor's "index" field is the section index (in the final object 14470a391060SDerek Schuff // file), but that is not known until after layout, so it must be fixed up 14480a391060SDerek Schuff // later 14490a391060SDerek Schuff if (const MCSymbolWasm *C = Section.getGroup()) { 14500a391060SDerek Schuff Comdats[C->getName()].emplace_back( 14510a391060SDerek Schuff WasmComdatEntry{wasm::WASM_COMDAT_SECTION, 14520a391060SDerek Schuff static_cast<uint32_t>(CustomSections.size())}); 14530a391060SDerek Schuff } 14540a391060SDerek Schuff 14554d57fbd0SSam Clegg CustomSections.emplace_back(Name, &Section); 1456759631c7SSam Clegg } 14576a31a0d6SSam Clegg } 14586a31a0d6SSam Clegg 145930d314aaSSam Clegg if (Mode != DwoMode::DwoOnly) { 1460586320c0SNicholas Wilson // Populate WasmIndices and DataLocations for defined symbols. 1461d934cb88SDan Gohman for (const MCSymbol &S : Asm.symbols()) { 1462d934cb88SDan Gohman // Ignore unnamed temporary symbols, which aren't ever exported, imported, 1463d934cb88SDan Gohman // or used in relocations. 1464d934cb88SDan Gohman if (S.isTemporary() && S.getName().empty()) 1465d934cb88SDan Gohman continue; 1466b7787fd0SSam Clegg 1467d934cb88SDan Gohman const auto &WS = static_cast<const MCSymbolWasm &>(S); 1468d34e60caSNicola Zaghen LLVM_DEBUG( 1469d34e60caSNicola Zaghen dbgs() << "MCSymbol: " << toString(WS.getType()) << " '" << S << "'" 1470d34e60caSNicola Zaghen << " isDefined=" << S.isDefined() << " isExternal=" 1471d34e60caSNicola Zaghen << S.isExternal() << " isTemporary=" << S.isTemporary() 1472d34e60caSNicola Zaghen << " isWeak=" << WS.isWeak() << " isHidden=" << WS.isHidden() 1473b7787fd0SSam Clegg << " isVariable=" << WS.isVariable() << "\n"); 1474b7787fd0SSam Clegg 14755e3d33a7SSam Clegg if (WS.isVariable()) 14765e3d33a7SSam Clegg continue; 14776c899ba6SSam Clegg if (WS.isComdat() && !WS.isDefined()) 14786c899ba6SSam Clegg continue; 1479b7787fd0SSam Clegg 1480d934cb88SDan Gohman if (WS.isFunction()) { 14816c899ba6SSam Clegg unsigned Index; 1482cd65f698SSam Clegg if (WS.isDefined()) { 1483b7787fd0SSam Clegg if (WS.getOffset() != 0) 1484b7787fd0SSam Clegg report_fatal_error( 1485b7787fd0SSam Clegg "function sections must contain one function each"); 1486b7787fd0SSam Clegg 148718c56a07SHeejin Ahn if (WS.getSize() == nullptr) 1488b7787fd0SSam Clegg report_fatal_error( 1489b7787fd0SSam Clegg "function symbols must have a size set with .size"); 1490b7787fd0SSam Clegg 14916c899ba6SSam Clegg // A definition. Write out the function body. 14929f3fe42eSSam Clegg Index = NumFunctionImports + Functions.size(); 1493d934cb88SDan Gohman WasmFunction Func; 1494da419bdbSHeejin Ahn Func.SigIndex = getFunctionType(WS); 1495d934cb88SDan Gohman Func.Sym = &WS; 149630d314aaSSam Clegg assert(WasmIndices.count(&WS) == 0); 14976c899ba6SSam Clegg WasmIndices[&WS] = Index; 1498d934cb88SDan Gohman Functions.push_back(Func); 14996c899ba6SSam Clegg 15006c899ba6SSam Clegg auto &Section = static_cast<MCSectionWasm &>(WS.getSection()); 15016c899ba6SSam Clegg if (const MCSymbolWasm *C = Section.getGroup()) { 15026c899ba6SSam Clegg Comdats[C->getName()].emplace_back( 15036c899ba6SSam Clegg WasmComdatEntry{wasm::WASM_COMDAT_FUNCTION, Index}); 15046c899ba6SSam Clegg } 1505881d8778SSam Clegg 1506881d8778SSam Clegg if (WS.hasExportName()) { 1507881d8778SSam Clegg wasm::WasmExport Export; 1508881d8778SSam Clegg Export.Name = WS.getExportName(); 1509881d8778SSam Clegg Export.Kind = wasm::WASM_EXTERNAL_FUNCTION; 1510881d8778SSam Clegg Export.Index = Index; 1511881d8778SSam Clegg Exports.push_back(Export); 1512881d8778SSam Clegg } 1513d934cb88SDan Gohman } else { 1514d934cb88SDan Gohman // An import; the index was assigned above. 15156c899ba6SSam Clegg Index = WasmIndices.find(&WS)->second; 1516d934cb88SDan Gohman } 1517d934cb88SDan Gohman 1518d34e60caSNicola Zaghen LLVM_DEBUG(dbgs() << " -> function index: " << Index << "\n"); 1519da419bdbSHeejin Ahn 15206c899ba6SSam Clegg } else if (WS.isData()) { 1521f3feb6adSWouter van Oortmerssen if (!isInSymtab(WS)) 1522c38e947eSSam Clegg continue; 1523c38e947eSSam Clegg 15246c899ba6SSam Clegg if (!WS.isDefined()) { 1525d34e60caSNicola Zaghen LLVM_DEBUG(dbgs() << " -> segment index: -1" 1526d34e60caSNicola Zaghen << "\n"); 1527fe6414b0SSam Clegg continue; 15286c899ba6SSam Clegg } 1529fe6414b0SSam Clegg 1530d934cb88SDan Gohman if (!WS.getSize()) 1531c38e947eSSam Clegg report_fatal_error("data symbols must have a size set with .size: " + 1532c38e947eSSam Clegg WS.getName()); 1533d934cb88SDan Gohman 1534d934cb88SDan Gohman int64_t Size = 0; 1535d934cb88SDan Gohman if (!WS.getSize()->evaluateAsAbsolute(Size, Layout)) 1536d934cb88SDan Gohman report_fatal_error(".size expression must be evaluatable"); 1537d934cb88SDan Gohman 1538759631c7SSam Clegg auto &DataSection = static_cast<MCSectionWasm &>(WS.getSection()); 1539079cba04SSam Clegg if (!DataSection.isWasmData()) 1540079cba04SSam Clegg report_fatal_error("data symbols must live in a data section: " + 1541079cba04SSam Clegg WS.getName()); 15427c395943SSam Clegg 15436c899ba6SSam Clegg // For each data symbol, export it in the symtab as a reference to the 15446c899ba6SSam Clegg // corresponding Wasm data segment. 15456c899ba6SSam Clegg wasm::WasmDataReference Ref = wasm::WasmDataReference{ 15463b29376eSWouter van Oortmerssen DataSection.getSegmentIndex(), Layout.getSymbolOffset(WS), 15473b29376eSWouter van Oortmerssen static_cast<uint64_t>(Size)}; 154830d314aaSSam Clegg assert(DataLocations.count(&WS) == 0); 15496c899ba6SSam Clegg DataLocations[&WS] = Ref; 1550d34e60caSNicola Zaghen LLVM_DEBUG(dbgs() << " -> segment index: " << Ref.Segment << "\n"); 1551da419bdbSHeejin Ahn 1552a165f2d6SSam Clegg } else if (WS.isGlobal()) { 15536c899ba6SSam Clegg // A "true" Wasm global (currently just __stack_pointer) 15540a6c4d8dSSam Clegg if (WS.isDefined()) { 15550a6c4d8dSSam Clegg wasm::WasmGlobal Global; 15560a6c4d8dSSam Clegg Global.Type = WS.getGlobalType(); 15570a6c4d8dSSam Clegg Global.Index = NumGlobalImports + Globals.size(); 15580a6c4d8dSSam Clegg switch (Global.Type.Type) { 15590a6c4d8dSSam Clegg case wasm::WASM_TYPE_I32: 15600a6c4d8dSSam Clegg Global.InitExpr.Opcode = wasm::WASM_OPCODE_I32_CONST; 15610a6c4d8dSSam Clegg break; 15620a6c4d8dSSam Clegg case wasm::WASM_TYPE_I64: 15630a6c4d8dSSam Clegg Global.InitExpr.Opcode = wasm::WASM_OPCODE_I64_CONST; 15640a6c4d8dSSam Clegg break; 15650a6c4d8dSSam Clegg case wasm::WASM_TYPE_F32: 15660a6c4d8dSSam Clegg Global.InitExpr.Opcode = wasm::WASM_OPCODE_F32_CONST; 15670a6c4d8dSSam Clegg break; 15680a6c4d8dSSam Clegg case wasm::WASM_TYPE_F64: 15690a6c4d8dSSam Clegg Global.InitExpr.Opcode = wasm::WASM_OPCODE_F64_CONST; 15700a6c4d8dSSam Clegg break; 157179aad89dSSam Clegg case wasm::WASM_TYPE_EXTERNREF: 157279aad89dSSam Clegg Global.InitExpr.Opcode = wasm::WASM_OPCODE_REF_NULL; 157379aad89dSSam Clegg break; 15740a6c4d8dSSam Clegg default: 15750a6c4d8dSSam Clegg llvm_unreachable("unexpected type"); 15760a6c4d8dSSam Clegg } 157730d314aaSSam Clegg assert(WasmIndices.count(&WS) == 0); 15780a6c4d8dSSam Clegg WasmIndices[&WS] = Global.Index; 15790a6c4d8dSSam Clegg Globals.push_back(Global); 15800a6c4d8dSSam Clegg } else { 1581545932beSEric Christopher // An import; the index was assigned above 1582d34e60caSNicola Zaghen LLVM_DEBUG(dbgs() << " -> global index: " 1583d34e60caSNicola Zaghen << WasmIndices.find(&WS)->second << "\n"); 15840a6c4d8dSSam Clegg } 1585388fb67bSPaulo Matos } else if (WS.isTable()) { 1586388fb67bSPaulo Matos if (WS.isDefined()) { 1587388fb67bSPaulo Matos wasm::WasmTable Table; 1588388fb67bSPaulo Matos Table.Index = NumTableImports + Tables.size(); 15891933c9d4SAndy Wingo Table.Type.ElemType = static_cast<uint8_t>(WS.getTableType()); 1590388fb67bSPaulo Matos // FIXME: Work on custom limits is ongoing 15911933c9d4SAndy Wingo Table.Type.Limits = {wasm::WASM_LIMITS_FLAG_NONE, 0, 0}; 159230d314aaSSam Clegg assert(WasmIndices.count(&WS) == 0); 1593388fb67bSPaulo Matos WasmIndices[&WS] = Table.Index; 1594388fb67bSPaulo Matos Tables.push_back(Table); 1595388fb67bSPaulo Matos } 159630d314aaSSam Clegg LLVM_DEBUG(dbgs() << " -> table index: " 159730d314aaSSam Clegg << WasmIndices.find(&WS)->second << "\n"); 1598da419bdbSHeejin Ahn } else if (WS.isEvent()) { 1599da419bdbSHeejin Ahn // C++ exception symbol (__cpp_exception) 1600da419bdbSHeejin Ahn unsigned Index; 1601da419bdbSHeejin Ahn if (WS.isDefined()) { 1602da419bdbSHeejin Ahn Index = NumEventImports + Events.size(); 1603da419bdbSHeejin Ahn wasm::WasmEventType Event; 1604da419bdbSHeejin Ahn Event.SigIndex = getEventType(WS); 1605da419bdbSHeejin Ahn Event.Attribute = wasm::WASM_EVENT_ATTRIBUTE_EXCEPTION; 160630d314aaSSam Clegg assert(WasmIndices.count(&WS) == 0); 1607da419bdbSHeejin Ahn WasmIndices[&WS] = Index; 1608da419bdbSHeejin Ahn Events.push_back(Event); 1609da419bdbSHeejin Ahn } else { 1610da419bdbSHeejin Ahn // An import; the index was assigned above. 1611492f7529SSam Clegg assert(WasmIndices.count(&WS) > 0); 1612da419bdbSHeejin Ahn } 161330d314aaSSam Clegg LLVM_DEBUG(dbgs() << " -> event index: " 161430d314aaSSam Clegg << WasmIndices.find(&WS)->second << "\n"); 1615da419bdbSHeejin Ahn 1616a165f2d6SSam Clegg } else { 1617a165f2d6SSam Clegg assert(WS.isSection()); 1618d934cb88SDan Gohman } 1619d934cb88SDan Gohman } 1620d934cb88SDan Gohman 1621586320c0SNicholas Wilson // Populate WasmIndices and DataLocations for aliased symbols. We need to 1622586320c0SNicholas Wilson // process these in a separate pass because we need to have processed the 1623586320c0SNicholas Wilson // target of the alias before the alias itself and the symbols are not 1624586320c0SNicholas Wilson // necessarily ordered in this way. 1625b7787fd0SSam Clegg for (const MCSymbol &S : Asm.symbols()) { 1626b7787fd0SSam Clegg if (!S.isVariable()) 1627b7787fd0SSam Clegg continue; 162831a2c809SSam Clegg 1629cd65f698SSam Clegg assert(S.isDefined()); 1630b7787fd0SSam Clegg 16319c7b5808SDominic Chen const auto *BS = Layout.getBaseSymbol(S); 16329c7b5808SDominic Chen if (!BS) 16339c7b5808SDominic Chen report_fatal_error(Twine(S.getName()) + 16349c7b5808SDominic Chen ": absolute addressing not supported!"); 16359c7b5808SDominic Chen const MCSymbolWasm *Base = cast<MCSymbolWasm>(BS); 16367ee758d6SSam Clegg 16375e3d33a7SSam Clegg // Find the target symbol of this weak alias and export that index 1638aff1c4dfSSam Clegg const auto &WS = static_cast<const MCSymbolWasm &>(S); 163930d314aaSSam Clegg LLVM_DEBUG(dbgs() << WS.getName() << ": weak alias of '" << *Base 164030d314aaSSam Clegg << "'\n"); 1641b7787fd0SSam Clegg 16427ee758d6SSam Clegg if (Base->isFunction()) { 16437ee758d6SSam Clegg assert(WasmIndices.count(Base) > 0); 16447ee758d6SSam Clegg uint32_t WasmIndex = WasmIndices.find(Base)->second; 1645492f7529SSam Clegg assert(WasmIndices.count(&WS) == 0); 16466c899ba6SSam Clegg WasmIndices[&WS] = WasmIndex; 1647d34e60caSNicola Zaghen LLVM_DEBUG(dbgs() << " -> index:" << WasmIndex << "\n"); 16487ee758d6SSam Clegg } else if (Base->isData()) { 16497ee758d6SSam Clegg auto &DataSection = static_cast<MCSectionWasm &>(WS.getSection()); 16507ee758d6SSam Clegg uint64_t Offset = Layout.getSymbolOffset(S); 16517ee758d6SSam Clegg int64_t Size = 0; 16527ee758d6SSam Clegg // For data symbol alias we use the size of the base symbol as the 16537ee758d6SSam Clegg // size of the alias. When an offset from the base is involved this 16547ee758d6SSam Clegg // can result in a offset + size goes past the end of the data section 16557ee758d6SSam Clegg // which out object format doesn't support. So we must clamp it. 16567ee758d6SSam Clegg if (!Base->getSize()->evaluateAsAbsolute(Size, Layout)) 16577ee758d6SSam Clegg report_fatal_error(".size expression must be evaluatable"); 16587ee758d6SSam Clegg const WasmDataSegment &Segment = 16597ee758d6SSam Clegg DataSegments[DataSection.getSegmentIndex()]; 16607ee758d6SSam Clegg Size = 16617ee758d6SSam Clegg std::min(static_cast<uint64_t>(Size), Segment.Data.size() - Offset); 16627ee758d6SSam Clegg wasm::WasmDataReference Ref = wasm::WasmDataReference{ 16637ee758d6SSam Clegg DataSection.getSegmentIndex(), 16647ee758d6SSam Clegg static_cast<uint32_t>(Layout.getSymbolOffset(S)), 16657ee758d6SSam Clegg static_cast<uint32_t>(Size)}; 16666c899ba6SSam Clegg DataLocations[&WS] = Ref; 1667d34e60caSNicola Zaghen LLVM_DEBUG(dbgs() << " -> index:" << Ref.Segment << "\n"); 16686c899ba6SSam Clegg } else { 1669da419bdbSHeejin Ahn report_fatal_error("don't yet support global/event aliases"); 16706c899ba6SSam Clegg } 1671586320c0SNicholas Wilson } 167230d314aaSSam Clegg } 167331a2c809SSam Clegg 1674586320c0SNicholas Wilson // Finally, populate the symbol table itself, in its "natural" order. 1675586320c0SNicholas Wilson for (const MCSymbol &S : Asm.symbols()) { 1676586320c0SNicholas Wilson const auto &WS = static_cast<const MCSymbolWasm &>(S); 167725d8e68bSSam Clegg if (!isInSymtab(WS)) { 167818c56a07SHeejin Ahn WS.setIndex(InvalidIndex); 1679586320c0SNicholas Wilson continue; 168025d8e68bSSam Clegg } 1681d34e60caSNicola Zaghen LLVM_DEBUG(dbgs() << "adding to symtab: " << WS << "\n"); 1682586320c0SNicholas Wilson 1683586320c0SNicholas Wilson uint32_t Flags = 0; 1684586320c0SNicholas Wilson if (WS.isWeak()) 1685586320c0SNicholas Wilson Flags |= wasm::WASM_SYMBOL_BINDING_WEAK; 1686586320c0SNicholas Wilson if (WS.isHidden()) 1687586320c0SNicholas Wilson Flags |= wasm::WASM_SYMBOL_VISIBILITY_HIDDEN; 1688586320c0SNicholas Wilson if (!WS.isExternal() && WS.isDefined()) 1689586320c0SNicholas Wilson Flags |= wasm::WASM_SYMBOL_BINDING_LOCAL; 1690586320c0SNicholas Wilson if (WS.isUndefined()) 1691586320c0SNicholas Wilson Flags |= wasm::WASM_SYMBOL_UNDEFINED; 1692da84b688SDan Gohman if (WS.isNoStrip()) { 1693da84b688SDan Gohman Flags |= wasm::WASM_SYMBOL_NO_STRIP; 1694da84b688SDan Gohman if (isEmscripten()) { 1695d6ef8da3SSam Clegg Flags |= wasm::WASM_SYMBOL_EXPORTED; 1696da84b688SDan Gohman } 1697da84b688SDan Gohman } 1698b4f4e370SSam Clegg if (WS.hasImportName()) 169929874ceaSDan Gohman Flags |= wasm::WASM_SYMBOL_EXPLICIT_NAME; 1700881d8778SSam Clegg if (WS.hasExportName()) 1701881d8778SSam Clegg Flags |= wasm::WASM_SYMBOL_EXPORTED; 1702586320c0SNicholas Wilson 1703586320c0SNicholas Wilson wasm::WasmSymbolInfo Info; 1704586320c0SNicholas Wilson Info.Name = WS.getName(); 1705586320c0SNicholas Wilson Info.Kind = WS.getType(); 1706586320c0SNicholas Wilson Info.Flags = Flags; 17074d57fbd0SSam Clegg if (!WS.isData()) { 17084d57fbd0SSam Clegg assert(WasmIndices.count(&WS) > 0); 1709586320c0SNicholas Wilson Info.ElementIndex = WasmIndices.find(&WS)->second; 17104d57fbd0SSam Clegg } else if (WS.isDefined()) { 17114d57fbd0SSam Clegg assert(DataLocations.count(&WS) > 0); 1712586320c0SNicholas Wilson Info.DataRef = DataLocations.find(&WS)->second; 17134d57fbd0SSam Clegg } 171425d8e68bSSam Clegg WS.setIndex(SymbolInfos.size()); 1715586320c0SNicholas Wilson SymbolInfos.emplace_back(Info); 1716b7787fd0SSam Clegg } 1717b7787fd0SSam Clegg 17186006e091SSam Clegg { 17196006e091SSam Clegg auto HandleReloc = [&](const WasmRelocationEntry &Rel) { 1720f9edbe95SSam Clegg // Functions referenced by a relocation need to put in the table. This is 1721f9edbe95SSam Clegg // purely to make the object file's provisional values readable, and is 1722f9edbe95SSam Clegg // ignored by the linker, which re-calculates the relocations itself. 1723d1152a26SSam Clegg if (Rel.Type != wasm::R_WASM_TABLE_INDEX_I32 && 1724cc1b9b68SWouter van Oortmerssen Rel.Type != wasm::R_WASM_TABLE_INDEX_I64 && 172581443ac1SSam Clegg Rel.Type != wasm::R_WASM_TABLE_INDEX_SLEB && 1726cc1b9b68SWouter van Oortmerssen Rel.Type != wasm::R_WASM_TABLE_INDEX_SLEB64 && 172781443ac1SSam Clegg Rel.Type != wasm::R_WASM_TABLE_INDEX_REL_SLEB) 1728f9edbe95SSam Clegg return; 1729f9edbe95SSam Clegg assert(Rel.Symbol->isFunction()); 17307ee758d6SSam Clegg const MCSymbolWasm *Base = 17317ee758d6SSam Clegg cast<MCSymbolWasm>(Layout.getBaseSymbol(*Rel.Symbol)); 17327ee758d6SSam Clegg uint32_t FunctionIndex = WasmIndices.find(Base)->second; 173318c56a07SHeejin Ahn uint32_t TableIndex = TableElems.size() + InitialTableOffset; 17347ee758d6SSam Clegg if (TableIndices.try_emplace(Base, TableIndex).second) { 17357ee758d6SSam Clegg LLVM_DEBUG(dbgs() << " -> adding " << Base->getName() 1736f9edbe95SSam Clegg << " to table: " << TableIndex << "\n"); 17376c899ba6SSam Clegg TableElems.push_back(FunctionIndex); 17387ee758d6SSam Clegg registerFunctionType(*Base); 17396006e091SSam Clegg } 17406006e091SSam Clegg }; 1741970d02c4SDan Gohman 17426006e091SSam Clegg for (const WasmRelocationEntry &RelEntry : CodeRelocations) 17436006e091SSam Clegg HandleReloc(RelEntry); 17446006e091SSam Clegg for (const WasmRelocationEntry &RelEntry : DataRelocations) 17456006e091SSam Clegg HandleReloc(RelEntry); 1746d934cb88SDan Gohman } 1747d934cb88SDan Gohman 1748bafe6902SSam Clegg // Translate .init_array section contents into start functions. 1749bafe6902SSam Clegg for (const MCSection &S : Asm) { 1750bafe6902SSam Clegg const auto &WS = static_cast<const MCSectionWasm &>(S); 17517d1ff446SFangrui Song if (WS.getName().startswith(".fini_array")) 1752bafe6902SSam Clegg report_fatal_error(".fini_array sections are unsupported"); 17537d1ff446SFangrui Song if (!WS.getName().startswith(".init_array")) 1754bafe6902SSam Clegg continue; 1755bafe6902SSam Clegg if (WS.getFragmentList().empty()) 1756bafe6902SSam Clegg continue; 1757b210c64bSSam Clegg 1758b210c64bSSam Clegg // init_array is expected to contain a single non-empty data fragment 1759b210c64bSSam Clegg if (WS.getFragmentList().size() != 3) 1760bafe6902SSam Clegg report_fatal_error("only one .init_array section fragment supported"); 1761b210c64bSSam Clegg 1762b210c64bSSam Clegg auto IT = WS.begin(); 1763b210c64bSSam Clegg const MCFragment &EmptyFrag = *IT; 1764b210c64bSSam Clegg if (EmptyFrag.getKind() != MCFragment::FT_Data) 1765b210c64bSSam Clegg report_fatal_error(".init_array section should be aligned"); 1766b210c64bSSam Clegg 1767b210c64bSSam Clegg IT = std::next(IT); 1768b210c64bSSam Clegg const MCFragment &AlignFrag = *IT; 1769bafe6902SSam Clegg if (AlignFrag.getKind() != MCFragment::FT_Align) 1770bafe6902SSam Clegg report_fatal_error(".init_array section should be aligned"); 1771bafe6902SSam Clegg if (cast<MCAlignFragment>(AlignFrag).getAlignment() != (is64Bit() ? 8 : 4)) 1772bafe6902SSam Clegg report_fatal_error(".init_array section should be aligned for pointers"); 1773b210c64bSSam Clegg 1774b210c64bSSam Clegg const MCFragment &Frag = *std::next(IT); 1775bafe6902SSam Clegg if (Frag.hasInstructions() || Frag.getKind() != MCFragment::FT_Data) 1776bafe6902SSam Clegg report_fatal_error("only data supported in .init_array section"); 1777b210c64bSSam Clegg 1778bafe6902SSam Clegg uint16_t Priority = UINT16_MAX; 17794d57fbd0SSam Clegg unsigned PrefixLength = strlen(".init_array"); 17807d1ff446SFangrui Song if (WS.getName().size() > PrefixLength) { 17817d1ff446SFangrui Song if (WS.getName()[PrefixLength] != '.') 1782f208f631SHeejin Ahn report_fatal_error( 1783f208f631SHeejin Ahn ".init_array section priority should start with '.'"); 17847d1ff446SFangrui Song if (WS.getName().substr(PrefixLength + 1).getAsInteger(10, Priority)) 1785bafe6902SSam Clegg report_fatal_error("invalid .init_array section priority"); 1786bafe6902SSam Clegg } 1787bafe6902SSam Clegg const auto &DataFrag = cast<MCDataFragment>(Frag); 1788bafe6902SSam Clegg const SmallVectorImpl<char> &Contents = DataFrag.getContents(); 1789f208f631SHeejin Ahn for (const uint8_t * 179018c56a07SHeejin Ahn P = (const uint8_t *)Contents.data(), 179118c56a07SHeejin Ahn *End = (const uint8_t *)Contents.data() + Contents.size(); 179218c56a07SHeejin Ahn P != End; ++P) { 179318c56a07SHeejin Ahn if (*P != 0) 1794bafe6902SSam Clegg report_fatal_error("non-symbolic data in .init_array section"); 1795bafe6902SSam Clegg } 1796bafe6902SSam Clegg for (const MCFixup &Fixup : DataFrag.getFixups()) { 1797f208f631SHeejin Ahn assert(Fixup.getKind() == 1798f208f631SHeejin Ahn MCFixup::getKindForSize(is64Bit() ? 8 : 4, false)); 1799bafe6902SSam Clegg const MCExpr *Expr = Fixup.getValue(); 18008fffa1dfSSam Clegg auto *SymRef = dyn_cast<MCSymbolRefExpr>(Expr); 18018fffa1dfSSam Clegg if (!SymRef) 1802bafe6902SSam Clegg report_fatal_error("fixups in .init_array should be symbol references"); 18038fffa1dfSSam Clegg const auto &TargetSym = cast<const MCSymbolWasm>(SymRef->getSymbol()); 18048fffa1dfSSam Clegg if (TargetSym.getIndex() == InvalidIndex) 18053ea1c62cSSam Clegg report_fatal_error("symbols in .init_array should exist in symtab"); 18068fffa1dfSSam Clegg if (!TargetSym.isFunction()) 18078fffa1dfSSam Clegg report_fatal_error("symbols in .init_array should be for functions"); 180825d8e68bSSam Clegg InitFuncs.push_back( 18098fffa1dfSSam Clegg std::make_pair(Priority, TargetSym.getIndex())); 1810bafe6902SSam Clegg } 1811bafe6902SSam Clegg } 1812bafe6902SSam Clegg 181318eafb6cSDan Gohman // Write out the Wasm header. 181418eafb6cSDan Gohman writeHeader(Asm); 181518eafb6cSDan Gohman 18160ff28fa6SDerek Schuff uint32_t CodeSectionIndex, DataSectionIndex; 18170ff28fa6SDerek Schuff if (Mode != DwoMode::DwoOnly) { 1818da419bdbSHeejin Ahn writeTypeSection(Signatures); 1819f950b24aSSam Clegg writeImportSection(Imports, DataSize, TableElems.size()); 18209e15f359SSam Clegg writeFunctionSection(Functions); 1821d823cc7cSAndy Wingo writeTableSection(Tables); 1822f950b24aSSam Clegg // Skip the "memory" section; we import the memory instead. 1823da419bdbSHeejin Ahn writeEventSection(Events); 18240a6c4d8dSSam Clegg writeGlobalSection(Globals); 18259e15f359SSam Clegg writeExportSection(Exports); 18269e15f359SSam Clegg writeElemSection(TableElems); 1827fef8de66SThomas Lively writeDataCountSection(); 18280ff28fa6SDerek Schuff 18290ff28fa6SDerek Schuff CodeSectionIndex = writeCodeSection(Asm, Layout, Functions); 18300ff28fa6SDerek Schuff DataSectionIndex = writeDataSection(Layout); 18310ff28fa6SDerek Schuff } 18320ff28fa6SDerek Schuff 18330a391060SDerek Schuff // The Sections in the COMDAT list have placeholder indices (their index among 18340a391060SDerek Schuff // custom sections, rather than among all sections). Fix them up here. 18350a391060SDerek Schuff for (auto &Group : Comdats) { 18360a391060SDerek Schuff for (auto &Entry : Group.second) { 18370a391060SDerek Schuff if (Entry.Kind == wasm::WASM_COMDAT_SECTION) { 18380a391060SDerek Schuff Entry.Index += SectionCount; 18390ff28fa6SDerek Schuff } 18400a391060SDerek Schuff } 18410a391060SDerek Schuff } 18420a391060SDerek Schuff for (auto &CustomSection : CustomSections) 18430a391060SDerek Schuff writeCustomSection(CustomSection, Asm, Layout); 18440ff28fa6SDerek Schuff 18450ff28fa6SDerek Schuff if (Mode != DwoMode::DwoOnly) { 1846c22bfb6bSNicholas Wilson writeLinkingMetaDataSection(SymbolInfos, InitFuncs, Comdats); 18470ff28fa6SDerek Schuff 18486f08c84aSSam Clegg writeRelocSection(CodeSectionIndex, "CODE", CodeRelocations); 18496f08c84aSSam Clegg writeRelocSection(DataSectionIndex, "DATA", DataRelocations); 18500ff28fa6SDerek Schuff } 18516a31a0d6SSam Clegg writeCustomRelocSections(); 1852cbda16ebSThomas Lively if (ProducersSection) 1853cbda16ebSThomas Lively writeCustomSection(*ProducersSection, Asm, Layout); 1854f6f4f843SThomas Lively if (TargetFeaturesSection) 1855f6f4f843SThomas Lively writeCustomSection(*TargetFeaturesSection, Asm, Layout); 1856970d02c4SDan Gohman 1857d934cb88SDan Gohman // TODO: Translate the .comment section to the output. 18580ff28fa6SDerek Schuff return W->OS.tell() - StartOffset; 185918eafb6cSDan Gohman } 186018eafb6cSDan Gohman 186160fbc7ccSLang Hames std::unique_ptr<MCObjectWriter> 18621301a878SLang Hames llvm::createWasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW, 186318eafb6cSDan Gohman raw_pwrite_stream &OS) { 18640eaee545SJonas Devlieghere return std::make_unique<WasmObjectWriter>(std::move(MOTW), OS); 186518eafb6cSDan Gohman } 18660ff28fa6SDerek Schuff 18670ff28fa6SDerek Schuff std::unique_ptr<MCObjectWriter> 18680ff28fa6SDerek Schuff llvm::createWasmDwoObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW, 18690ff28fa6SDerek Schuff raw_pwrite_stream &OS, 18700ff28fa6SDerek Schuff raw_pwrite_stream &DwoOS) { 18710ff28fa6SDerek Schuff return std::make_unique<WasmObjectWriter>(std::move(MOTW), OS, DwoOS); 18720ff28fa6SDerek Schuff } 1873