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);
314a5a3659dSAndy Wingo   void writeElemSection(const MCSymbolWasm *IndirectFunctionTable,
315a5a3659dSAndy Wingo                         ArrayRef<uint32_t> TableElems);
316fef8de66SThomas Lively   void writeDataCountSection();
317e49584a3SSam Clegg   uint32_t writeCodeSection(const MCAssembler &Asm, const MCAsmLayout &Layout,
318457fb0b4SSam Clegg                             ArrayRef<WasmFunction> Functions);
319e49584a3SSam Clegg   uint32_t writeDataSection(const MCAsmLayout &Layout);
320da419bdbSHeejin Ahn   void writeEventSection(ArrayRef<wasm::WasmEventType> Events);
3210a6c4d8dSSam Clegg   void writeGlobalSection(ArrayRef<wasm::WasmGlobal> Globals);
322388fb67bSPaulo Matos   void writeTableSection(ArrayRef<wasm::WasmTable> Tables);
3236f08c84aSSam Clegg   void writeRelocSection(uint32_t SectionIndex, StringRef Name,
324f77dc2a8SSam Clegg                          std::vector<WasmRelocationEntry> &Relocations);
32531a2c809SSam Clegg   void writeLinkingMetaDataSection(
32686b4a09aSSam Clegg       ArrayRef<wasm::WasmSymbolInfo> SymbolInfos,
327ea7caceeSSam Clegg       ArrayRef<std::pair<uint16_t, uint32_t>> InitFuncs,
328ea7caceeSSam Clegg       const std::map<StringRef, std::vector<WasmComdatEntry>> &Comdats);
329cbda16ebSThomas Lively   void writeCustomSection(WasmCustomSection &CustomSection,
330cbda16ebSThomas Lively                           const MCAssembler &Asm, const MCAsmLayout &Layout);
3316a31a0d6SSam Clegg   void writeCustomRelocSections();
332acd7d2b0SSam Clegg 
3337ee758d6SSam Clegg   uint64_t getProvisionalValue(const WasmRelocationEntry &RelEntry,
3347ee758d6SSam Clegg                                const MCAsmLayout &Layout);
335acd7d2b0SSam Clegg   void applyRelocations(ArrayRef<WasmRelocationEntry> Relocations,
3367ee758d6SSam Clegg                         uint64_t ContentsOffset, const MCAsmLayout &Layout);
337acd7d2b0SSam Clegg 
338acd7d2b0SSam Clegg   uint32_t getRelocationIndexValue(const WasmRelocationEntry &RelEntry);
3395e3d33a7SSam Clegg   uint32_t getFunctionType(const MCSymbolWasm &Symbol);
340da419bdbSHeejin Ahn   uint32_t getEventType(const MCSymbolWasm &Symbol);
34138b12f5eSHeejin Ahn   void registerFunctionType(const MCSymbolWasm &Symbol);
34238b12f5eSHeejin Ahn   void registerEventType(const MCSymbolWasm &Symbol);
34318eafb6cSDan Gohman };
3449e15f359SSam Clegg 
34518eafb6cSDan Gohman } // end anonymous namespace
34618eafb6cSDan Gohman 
347d934cb88SDan Gohman // Write out a section header and a patchable section size field.
348d934cb88SDan Gohman void WasmObjectWriter::startSection(SectionBookkeeping &Section,
3492322a937SSam Clegg                                     unsigned SectionId) {
350d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "startSection " << SectionId << "\n");
3510ff28fa6SDerek Schuff   W->OS << char(SectionId);
352d934cb88SDan Gohman 
3530ff28fa6SDerek Schuff   Section.SizeOffset = W->OS.tell();
354d934cb88SDan Gohman 
355d934cb88SDan Gohman   // The section size. We don't know the size yet, so reserve enough space
356d934cb88SDan Gohman   // for any 32-bit value; we'll patch it later.
3570ff28fa6SDerek Schuff   encodeULEB128(0, W->OS, 5);
358d934cb88SDan Gohman 
359d934cb88SDan Gohman   // The position where the section starts, for measuring its size.
3600ff28fa6SDerek Schuff   Section.ContentsOffset = W->OS.tell();
3610ff28fa6SDerek Schuff   Section.PayloadOffset = W->OS.tell();
3626f08c84aSSam Clegg   Section.Index = SectionCount++;
363d934cb88SDan Gohman }
3642322a937SSam Clegg 
3652322a937SSam Clegg void WasmObjectWriter::startCustomSection(SectionBookkeeping &Section,
3662322a937SSam Clegg                                           StringRef Name) {
367d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "startCustomSection " << Name << "\n");
3682322a937SSam Clegg   startSection(Section, wasm::WASM_SEC_CUSTOM);
3696a31a0d6SSam Clegg 
3706a31a0d6SSam Clegg   // The position where the section header ends, for measuring its size.
3710ff28fa6SDerek Schuff   Section.PayloadOffset = W->OS.tell();
3726a31a0d6SSam Clegg 
3732322a937SSam Clegg   // Custom sections in wasm also have a string identifier.
3742322a937SSam Clegg   writeString(Name);
3756a31a0d6SSam Clegg 
3766a31a0d6SSam Clegg   // The position where the custom section starts.
3770ff28fa6SDerek Schuff   Section.ContentsOffset = W->OS.tell();
378d934cb88SDan Gohman }
379d934cb88SDan Gohman 
380d934cb88SDan Gohman // Now that the section is complete and we know how big it is, patch up the
381d934cb88SDan Gohman // section size field at the start of the section.
382d934cb88SDan Gohman void WasmObjectWriter::endSection(SectionBookkeeping &Section) {
3830ff28fa6SDerek Schuff   uint64_t Size = W->OS.tell();
384c0affde8SSam Clegg   // /dev/null doesn't support seek/tell and can report offset of 0.
385c0affde8SSam Clegg   // Simply skip this patching in that case.
386c0affde8SSam Clegg   if (!Size)
387c0affde8SSam Clegg     return;
388c0affde8SSam Clegg 
389c0affde8SSam Clegg   Size -= Section.PayloadOffset;
390d934cb88SDan Gohman   if (uint32_t(Size) != Size)
391d934cb88SDan Gohman     report_fatal_error("section size does not fit in a uint32_t");
392d934cb88SDan Gohman 
393d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "endSection size=" << Size << "\n");
394d934cb88SDan Gohman 
395d934cb88SDan Gohman   // Write the final section size to the payload_len field, which follows
396d934cb88SDan Gohman   // the section id byte.
3970ff28fa6SDerek Schuff   writePatchableLEB<5>(static_cast<raw_pwrite_stream &>(W->OS), Size,
398f17b149dSPeter Collingbourne                        Section.SizeOffset);
399d934cb88SDan Gohman }
400d934cb88SDan Gohman 
40118eafb6cSDan Gohman // Emit the Wasm header.
40218eafb6cSDan Gohman void WasmObjectWriter::writeHeader(const MCAssembler &Asm) {
4030ff28fa6SDerek Schuff   W->OS.write(wasm::WasmMagic, sizeof(wasm::WasmMagic));
4040ff28fa6SDerek Schuff   W->write<uint32_t>(wasm::WasmVersion);
40518eafb6cSDan Gohman }
40618eafb6cSDan Gohman 
40718eafb6cSDan Gohman void WasmObjectWriter::executePostLayoutBinding(MCAssembler &Asm,
40818eafb6cSDan Gohman                                                 const MCAsmLayout &Layout) {
4092632ba6aSAndy Wingo   // Some compilation units require the indirect function table to be present
4102632ba6aSAndy Wingo   // but don't explicitly reference it.  This is the case for call_indirect
4112632ba6aSAndy Wingo   // without the reference-types feature, and also function bitcasts in all
4122632ba6aSAndy Wingo   // cases.  In those cases the __indirect_function_table has the
4132632ba6aSAndy Wingo   // WASM_SYMBOL_NO_STRIP attribute.  Here we make sure this symbol makes it to
4142632ba6aSAndy Wingo   // the assembler, if needed.
4152632ba6aSAndy Wingo   if (auto *Sym = Asm.getContext().lookupSymbol("__indirect_function_table")) {
4162632ba6aSAndy Wingo     const auto *WasmSym = static_cast<const MCSymbolWasm *>(Sym);
4172632ba6aSAndy Wingo     if (WasmSym->isNoStrip())
41896ef4f30SSam Clegg       Asm.registerSymbol(*Sym);
4192632ba6aSAndy Wingo   }
42096ef4f30SSam Clegg 
4216ccb59b3SSam Clegg   // Build a map of sections to the function that defines them, for use
4226ccb59b3SSam Clegg   // in recordRelocation.
4236ccb59b3SSam Clegg   for (const MCSymbol &S : Asm.symbols()) {
4246ccb59b3SSam Clegg     const auto &WS = static_cast<const MCSymbolWasm &>(S);
4256ccb59b3SSam Clegg     if (WS.isDefined() && WS.isFunction() && !WS.isVariable()) {
4266ccb59b3SSam Clegg       const auto &Sec = static_cast<const MCSectionWasm &>(S.getSection());
4276ccb59b3SSam Clegg       auto Pair = SectionFunctions.insert(std::make_pair(&Sec, &S));
4286ccb59b3SSam Clegg       if (!Pair.second)
4296ccb59b3SSam Clegg         report_fatal_error("section already has a defining function: " +
4307d1ff446SFangrui Song                            Sec.getName());
4316ccb59b3SSam Clegg     }
4326ccb59b3SSam Clegg   }
43318eafb6cSDan Gohman }
43418eafb6cSDan Gohman 
43518eafb6cSDan Gohman void WasmObjectWriter::recordRelocation(MCAssembler &Asm,
43618eafb6cSDan Gohman                                         const MCAsmLayout &Layout,
43718eafb6cSDan Gohman                                         const MCFragment *Fragment,
43818eafb6cSDan Gohman                                         const MCFixup &Fixup, MCValue Target,
439ceecfe5bSRafael Espindola                                         uint64_t &FixedValue) {
440ecc5e808SSam Clegg   // The WebAssembly backend should never generate FKF_IsPCRel fixups
441e828ce1bSFangrui Song   assert(!(Asm.getBackend().getFixupKindInfo(Fixup.getKind()).Flags &
442ecc5e808SSam Clegg            MCFixupKindInfo::FKF_IsPCRel));
443ecc5e808SSam Clegg 
444fe6414b0SSam Clegg   const auto &FixupSection = cast<MCSectionWasm>(*Fragment->getParent());
445d934cb88SDan Gohman   uint64_t C = Target.getConstant();
446d934cb88SDan Gohman   uint64_t FixupOffset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
447d934cb88SDan Gohman   MCContext &Ctx = Asm.getContext();
448aa0c571aSYuta Saito   bool IsLocRel = false;
449d934cb88SDan Gohman 
450d934cb88SDan Gohman   if (const MCSymbolRefExpr *RefB = Target.getSymB()) {
451aa0c571aSYuta Saito 
452ecc5e808SSam Clegg     const auto &SymB = cast<MCSymbolWasm>(RefB->getSymbol());
453aa0c571aSYuta Saito 
454aa0c571aSYuta Saito     if (FixupSection.getKind().isText()) {
455aa0c571aSYuta Saito       Ctx.reportError(Fixup.getLoc(),
456d934cb88SDan Gohman                       Twine("symbol '") + SymB.getName() +
457aa0c571aSYuta Saito                           "' unsupported subtraction expression used in "
458aa0c571aSYuta Saito                           "relocation in code section.");
459d934cb88SDan Gohman       return;
460d934cb88SDan Gohman     }
461d934cb88SDan Gohman 
462aa0c571aSYuta Saito     if (SymB.isUndefined()) {
463aa0c571aSYuta Saito       Ctx.reportError(Fixup.getLoc(),
464aa0c571aSYuta Saito                       Twine("symbol '") + SymB.getName() +
465aa0c571aSYuta Saito                           "' can not be undefined in a subtraction expression");
466aa0c571aSYuta Saito       return;
467aa0c571aSYuta Saito     }
468aa0c571aSYuta Saito     const MCSection &SecB = SymB.getSection();
469aa0c571aSYuta Saito     if (&SecB != &FixupSection) {
470aa0c571aSYuta Saito       Ctx.reportError(Fixup.getLoc(),
471aa0c571aSYuta Saito                       Twine("symbol '") + SymB.getName() +
472aa0c571aSYuta Saito                           "' can not be placed in a different section");
473aa0c571aSYuta Saito       return;
474aa0c571aSYuta Saito     }
475aa0c571aSYuta Saito     IsLocRel = true;
476aa0c571aSYuta Saito     C += FixupOffset - Layout.getSymbolOffset(SymB);
477aa0c571aSYuta Saito   }
478aa0c571aSYuta Saito 
479d934cb88SDan Gohman   // We either rejected the fixup or folded B into C at this point.
480d934cb88SDan Gohman   const MCSymbolRefExpr *RefA = Target.getSymA();
481ecc5e808SSam Clegg   const auto *SymA = cast<MCSymbolWasm>(&RefA->getSymbol());
482d934cb88SDan Gohman 
4833ea1c62cSSam Clegg   // The .init_array isn't translated as data, so don't do relocations in it.
4847d1ff446SFangrui Song   if (FixupSection.getName().startswith(".init_array")) {
4853ea1c62cSSam Clegg     SymA->setUsedInInitArray();
4863ea1c62cSSam Clegg     return;
4873ea1c62cSSam Clegg   }
4883ea1c62cSSam Clegg 
489ecc5e808SSam Clegg   if (SymA->isVariable()) {
490d934cb88SDan Gohman     const MCExpr *Expr = SymA->getVariableValue();
4917ee758d6SSam Clegg     if (const auto *Inner = dyn_cast<MCSymbolRefExpr>(Expr))
4926ad8f190SSam Clegg       if (Inner->getKind() == MCSymbolRefExpr::VK_WEAKREF)
4936ad8f190SSam Clegg         llvm_unreachable("weakref used in reloc not yet implemented");
494d934cb88SDan Gohman   }
495d934cb88SDan Gohman 
496d934cb88SDan Gohman   // Put any constant offset in an addend. Offsets can be negative, and
497d934cb88SDan Gohman   // LLVM expects wrapping, in contrast to wasm's immediates which can't
498d934cb88SDan Gohman   // be negative and don't wrap.
499d934cb88SDan Gohman   FixedValue = 0;
500d934cb88SDan Gohman 
501aa0c571aSYuta Saito   unsigned Type = TargetObjectWriter->getRelocType(Target, Fixup, IsLocRel);
5029d24fb7fSSam Clegg 
5034d57fbd0SSam Clegg   // Absolute offset within a section or a function.
5044d57fbd0SSam Clegg   // Currently only supported for for metadata sections.
5054d57fbd0SSam Clegg   // See: test/MC/WebAssembly/blockaddress.ll
506d1152a26SSam Clegg   if (Type == wasm::R_WASM_FUNCTION_OFFSET_I32 ||
50716f02431SWouter van Oortmerssen       Type == wasm::R_WASM_FUNCTION_OFFSET_I64 ||
508d1152a26SSam Clegg       Type == wasm::R_WASM_SECTION_OFFSET_I32) {
5094d57fbd0SSam Clegg     if (!FixupSection.getKind().isMetadata())
5104d57fbd0SSam Clegg       report_fatal_error("relocations for function or section offsets are "
5114d57fbd0SSam Clegg                          "only supported in metadata sections");
5124d57fbd0SSam Clegg 
5134d57fbd0SSam Clegg     const MCSymbol *SectionSymbol = nullptr;
5144d57fbd0SSam Clegg     const MCSection &SecA = SymA->getSection();
5155e5b2cb1SWouter van Oortmerssen     if (SecA.getKind().isText()) {
5165e5b2cb1SWouter van Oortmerssen       auto SecSymIt = SectionFunctions.find(&SecA);
5175e5b2cb1SWouter van Oortmerssen       if (SecSymIt == SectionFunctions.end())
5185e5b2cb1SWouter van Oortmerssen         report_fatal_error("section doesn\'t have defining symbol");
5195e5b2cb1SWouter van Oortmerssen       SectionSymbol = SecSymIt->second;
5205e5b2cb1SWouter van Oortmerssen     } else {
5214d57fbd0SSam Clegg       SectionSymbol = SecA.getBeginSymbol();
5225e5b2cb1SWouter van Oortmerssen     }
5234d57fbd0SSam Clegg     if (!SectionSymbol)
5244d57fbd0SSam Clegg       report_fatal_error("section symbol is required for relocation");
5254d57fbd0SSam Clegg 
5264d57fbd0SSam Clegg     C += Layout.getSymbolOffset(*SymA);
5274d57fbd0SSam Clegg     SymA = cast<MCSymbolWasm>(SectionSymbol);
5284d57fbd0SSam Clegg   }
5294d57fbd0SSam Clegg 
530feac819eSAndy Wingo   if (Type == wasm::R_WASM_TABLE_INDEX_REL_SLEB ||
531feac819eSAndy Wingo       Type == wasm::R_WASM_TABLE_INDEX_SLEB ||
532feac819eSAndy Wingo       Type == wasm::R_WASM_TABLE_INDEX_SLEB64 ||
533feac819eSAndy Wingo       Type == wasm::R_WASM_TABLE_INDEX_I32 ||
534feac819eSAndy Wingo       Type == wasm::R_WASM_TABLE_INDEX_I64) {
535feac819eSAndy Wingo     // TABLE_INDEX relocs implicitly use the default indirect function table.
5362632ba6aSAndy Wingo     // We require the function table to have already been defined.
537feac819eSAndy Wingo     auto TableName = "__indirect_function_table";
538feac819eSAndy Wingo     MCSymbolWasm *Sym = cast_or_null<MCSymbolWasm>(Ctx.lookupSymbol(TableName));
5392632ba6aSAndy Wingo     if (!Sym || !Sym->isFunctionTable()) {
540feac819eSAndy Wingo       Ctx.reportError(
541feac819eSAndy Wingo           Fixup.getLoc(),
542feac819eSAndy Wingo           "symbol '__indirect_function_table' is not a function table");
543feac819eSAndy Wingo     } else {
5442632ba6aSAndy Wingo       // Ensure that __indirect_function_table reaches the output.
5452632ba6aSAndy Wingo       Sym->setNoStrip();
5467dc98adbSAndy Wingo       Asm.registerSymbol(*Sym);
547861dbe1aSAndy Wingo     }
5482632ba6aSAndy Wingo   }
549feac819eSAndy Wingo 
550d1152a26SSam Clegg   // Relocation other than R_WASM_TYPE_INDEX_LEB are required to be
5514d57fbd0SSam Clegg   // against a named symbol.
552d1152a26SSam Clegg   if (Type != wasm::R_WASM_TYPE_INDEX_LEB) {
5534d57fbd0SSam Clegg     if (SymA->getName().empty())
5544d57fbd0SSam Clegg       report_fatal_error("relocations against un-named temporaries are not yet "
5554d57fbd0SSam Clegg                          "supported by wasm");
5564d57fbd0SSam Clegg 
5574d57fbd0SSam Clegg     SymA->setUsedInReloc();
5584d57fbd0SSam Clegg   }
559ae03c1e7SSam Clegg 
560492f7529SSam Clegg   if (RefA->getKind() == MCSymbolRefExpr::VK_GOT)
561492f7529SSam Clegg     SymA->setUsedInGOT();
562492f7529SSam Clegg 
563d934cb88SDan Gohman   WasmRelocationEntry Rec(FixupOffset, SymA, C, Type, &FixupSection);
564d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "WasmReloc: " << Rec << "\n");
565d934cb88SDan Gohman 
5666a31a0d6SSam Clegg   if (FixupSection.isWasmData()) {
567d934cb88SDan Gohman     DataRelocations.push_back(Rec);
5686a31a0d6SSam Clegg   } else if (FixupSection.getKind().isText()) {
56912fd3da9SSam Clegg     CodeRelocations.push_back(Rec);
5706a31a0d6SSam Clegg   } else if (FixupSection.getKind().isMetadata()) {
5716a31a0d6SSam Clegg     CustomSectionsRelocations[&FixupSection].push_back(Rec);
5726a31a0d6SSam Clegg   } else {
57312fd3da9SSam Clegg     llvm_unreachable("unexpected section type");
574d934cb88SDan Gohman   }
5756a31a0d6SSam Clegg }
576d934cb88SDan Gohman 
577d934cb88SDan Gohman // Compute a value to write into the code at the location covered
57860ec3034SSam Clegg // by RelEntry. This value isn't used by the static linker; it just serves
57960ec3034SSam Clegg // to make the object format more readable and more likely to be directly
58060ec3034SSam Clegg // useable.
5813b29376eSWouter van Oortmerssen uint64_t
5827ee758d6SSam Clegg WasmObjectWriter::getProvisionalValue(const WasmRelocationEntry &RelEntry,
5837ee758d6SSam Clegg                                       const MCAsmLayout &Layout) {
58448139ebcSWouter van Oortmerssen   if ((RelEntry.Type == wasm::R_WASM_GLOBAL_INDEX_LEB ||
58548139ebcSWouter van Oortmerssen        RelEntry.Type == wasm::R_WASM_GLOBAL_INDEX_I32) &&
58648139ebcSWouter van Oortmerssen       !RelEntry.Symbol->isGlobal()) {
587492f7529SSam Clegg     assert(GOTIndices.count(RelEntry.Symbol) > 0 && "symbol not found in GOT index space");
588492f7529SSam Clegg     return GOTIndices[RelEntry.Symbol];
589492f7529SSam Clegg   }
590492f7529SSam Clegg 
59160ec3034SSam Clegg   switch (RelEntry.Type) {
5922a7cac93SSam Clegg   case wasm::R_WASM_TABLE_INDEX_REL_SLEB:
593d1152a26SSam Clegg   case wasm::R_WASM_TABLE_INDEX_SLEB:
594cc1b9b68SWouter van Oortmerssen   case wasm::R_WASM_TABLE_INDEX_SLEB64:
595cc1b9b68SWouter van Oortmerssen   case wasm::R_WASM_TABLE_INDEX_I32:
596cc1b9b68SWouter van Oortmerssen   case wasm::R_WASM_TABLE_INDEX_I64: {
597f9edbe95SSam Clegg     // Provisional value is table address of the resolved symbol itself
5987ee758d6SSam Clegg     const MCSymbolWasm *Base =
5997ee758d6SSam Clegg         cast<MCSymbolWasm>(Layout.getBaseSymbol(*RelEntry.Symbol));
6007ee758d6SSam Clegg     assert(Base->isFunction());
60181443ac1SSam Clegg     if (RelEntry.Type == wasm::R_WASM_TABLE_INDEX_REL_SLEB)
6027ee758d6SSam Clegg       return TableIndices[Base] - InitialTableOffset;
60381443ac1SSam Clegg     else
6047ee758d6SSam Clegg       return TableIndices[Base];
605f9edbe95SSam Clegg   }
606d1152a26SSam Clegg   case wasm::R_WASM_TYPE_INDEX_LEB:
6076c899ba6SSam Clegg     // Provisional value is same as the index
60860ec3034SSam Clegg     return getRelocationIndexValue(RelEntry);
609d1152a26SSam Clegg   case wasm::R_WASM_FUNCTION_INDEX_LEB:
610d1152a26SSam Clegg   case wasm::R_WASM_GLOBAL_INDEX_LEB:
61148139ebcSWouter van Oortmerssen   case wasm::R_WASM_GLOBAL_INDEX_I32:
612d1152a26SSam Clegg   case wasm::R_WASM_EVENT_INDEX_LEB:
61369e2797eSPaulo Matos   case wasm::R_WASM_TABLE_NUMBER_LEB:
614da419bdbSHeejin Ahn     // Provisional value is function/global/event Wasm index
615492f7529SSam Clegg     assert(WasmIndices.count(RelEntry.Symbol) > 0 && "symbol not found in wasm index space");
6166c899ba6SSam Clegg     return WasmIndices[RelEntry.Symbol];
617d1152a26SSam Clegg   case wasm::R_WASM_FUNCTION_OFFSET_I32:
61816f02431SWouter van Oortmerssen   case wasm::R_WASM_FUNCTION_OFFSET_I64:
619d1152a26SSam Clegg   case wasm::R_WASM_SECTION_OFFSET_I32: {
6206a31a0d6SSam Clegg     const auto &Section =
6216a31a0d6SSam Clegg         static_cast<const MCSectionWasm &>(RelEntry.Symbol->getSection());
6226a31a0d6SSam Clegg     return Section.getSectionOffset() + RelEntry.Addend;
6236a31a0d6SSam Clegg   }
624d1152a26SSam Clegg   case wasm::R_WASM_MEMORY_ADDR_LEB:
6253b29376eSWouter van Oortmerssen   case wasm::R_WASM_MEMORY_ADDR_LEB64:
6263b29376eSWouter van Oortmerssen   case wasm::R_WASM_MEMORY_ADDR_SLEB:
6273b29376eSWouter van Oortmerssen   case wasm::R_WASM_MEMORY_ADDR_SLEB64:
6282a7cac93SSam Clegg   case wasm::R_WASM_MEMORY_ADDR_REL_SLEB:
6293b29376eSWouter van Oortmerssen   case wasm::R_WASM_MEMORY_ADDR_REL_SLEB64:
6303b29376eSWouter van Oortmerssen   case wasm::R_WASM_MEMORY_ADDR_I32:
631a28a4662SSam Clegg   case wasm::R_WASM_MEMORY_ADDR_I64:
632aa0c571aSYuta Saito   case wasm::R_WASM_MEMORY_ADDR_TLS_SLEB:
633aa0c571aSYuta Saito   case wasm::R_WASM_MEMORY_ADDR_LOCREL_I32: {
6349c7b5808SDominic Chen     // Provisional value is address of the global plus the offset
635270ed1b3SSam Clegg     // For undefined symbols, use zero
63601a48535SSam Clegg     if (!RelEntry.Symbol->isDefined())
637270ed1b3SSam Clegg       return 0;
63801a48535SSam Clegg     const wasm::WasmDataReference &SymRef = DataLocations[RelEntry.Symbol];
63901a48535SSam Clegg     const WasmDataSegment &Segment = DataSegments[SymRef.Segment];
640d934cb88SDan Gohman     // Ignore overflow. LLVM allows address arithmetic to silently wrap.
64101a48535SSam Clegg     return Segment.Offset + SymRef.Offset + RelEntry.Addend;
64260ec3034SSam Clegg   }
64360ec3034SSam Clegg   default:
64460ec3034SSam Clegg     llvm_unreachable("invalid relocation type");
64560ec3034SSam Clegg   }
646d934cb88SDan Gohman }
647d934cb88SDan Gohman 
648759631c7SSam Clegg static void addData(SmallVectorImpl<char> &DataBytes,
64963ebb813SSam Clegg                     MCSectionWasm &DataSection) {
6507d1ff446SFangrui Song   LLVM_DEBUG(errs() << "addData: " << DataSection.getName() << "\n");
651759631c7SSam Clegg 
65263ebb813SSam Clegg   DataBytes.resize(alignTo(DataBytes.size(), DataSection.getAlignment()));
65363ebb813SSam Clegg 
654759631c7SSam Clegg   for (const MCFragment &Frag : DataSection) {
655759631c7SSam Clegg     if (Frag.hasInstructions())
656759631c7SSam Clegg       report_fatal_error("only data supported in data sections");
657759631c7SSam Clegg 
658759631c7SSam Clegg     if (auto *Align = dyn_cast<MCAlignFragment>(&Frag)) {
659759631c7SSam Clegg       if (Align->getValueSize() != 1)
660759631c7SSam Clegg         report_fatal_error("only byte values supported for alignment");
661759631c7SSam Clegg       // If nops are requested, use zeros, as this is the data section.
662759631c7SSam Clegg       uint8_t Value = Align->hasEmitNops() ? 0 : Align->getValue();
663f208f631SHeejin Ahn       uint64_t Size =
664f208f631SHeejin Ahn           std::min<uint64_t>(alignTo(DataBytes.size(), Align->getAlignment()),
665f208f631SHeejin Ahn                              DataBytes.size() + Align->getMaxBytesToEmit());
666759631c7SSam Clegg       DataBytes.resize(Size, Value);
667759631c7SSam Clegg     } else if (auto *Fill = dyn_cast<MCFillFragment>(&Frag)) {
668588fad4dSNirav Dave       int64_t NumValues;
669588fad4dSNirav Dave       if (!Fill->getNumValues().evaluateAsAbsolute(NumValues))
670d707c370SRafael Espindola         llvm_unreachable("The fill should be an assembler constant");
671588fad4dSNirav Dave       DataBytes.insert(DataBytes.end(), Fill->getValueSize() * NumValues,
672588fad4dSNirav Dave                        Fill->getValue());
67324faf859SHeejin Ahn     } else if (auto *LEB = dyn_cast<MCLEBFragment>(&Frag)) {
67424faf859SHeejin Ahn       const SmallVectorImpl<char> &Contents = LEB->getContents();
6751d0bc055SKazu Hirata       llvm::append_range(DataBytes, Contents);
676759631c7SSam Clegg     } else {
677759631c7SSam Clegg       const auto &DataFrag = cast<MCDataFragment>(Frag);
678759631c7SSam Clegg       const SmallVectorImpl<char> &Contents = DataFrag.getContents();
6791d0bc055SKazu Hirata       llvm::append_range(DataBytes, Contents);
680759631c7SSam Clegg     }
681759631c7SSam Clegg   }
682759631c7SSam Clegg 
683d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "addData -> " << DataBytes.size() << "\n");
684759631c7SSam Clegg }
685759631c7SSam Clegg 
68660ec3034SSam Clegg uint32_t
68760ec3034SSam Clegg WasmObjectWriter::getRelocationIndexValue(const WasmRelocationEntry &RelEntry) {
688d1152a26SSam Clegg   if (RelEntry.Type == wasm::R_WASM_TYPE_INDEX_LEB) {
689b7787fd0SSam Clegg     if (!TypeIndices.count(RelEntry.Symbol))
690b7787fd0SSam Clegg       report_fatal_error("symbol not found in type index space: " +
691b7787fd0SSam Clegg                          RelEntry.Symbol->getName());
692acd7d2b0SSam Clegg     return TypeIndices[RelEntry.Symbol];
693acd7d2b0SSam Clegg   }
69460ec3034SSam Clegg 
69525d8e68bSSam Clegg   return RelEntry.Symbol->getIndex();
696acd7d2b0SSam Clegg }
697acd7d2b0SSam Clegg 
698d934cb88SDan Gohman // Apply the portions of the relocation records that we can handle ourselves
699d934cb88SDan Gohman // directly.
700acd7d2b0SSam Clegg void WasmObjectWriter::applyRelocations(
7017ee758d6SSam Clegg     ArrayRef<WasmRelocationEntry> Relocations, uint64_t ContentsOffset,
7027ee758d6SSam Clegg     const MCAsmLayout &Layout) {
7030ff28fa6SDerek Schuff   auto &Stream = static_cast<raw_pwrite_stream &>(W->OS);
704d934cb88SDan Gohman   for (const WasmRelocationEntry &RelEntry : Relocations) {
705d934cb88SDan Gohman     uint64_t Offset = ContentsOffset +
706d934cb88SDan Gohman                       RelEntry.FixupSection->getSectionOffset() +
707d934cb88SDan Gohman                       RelEntry.Offset;
708d934cb88SDan Gohman 
709d34e60caSNicola Zaghen     LLVM_DEBUG(dbgs() << "applyRelocation: " << RelEntry << "\n");
7107ee758d6SSam Clegg     auto Value = getProvisionalValue(RelEntry, Layout);
71160ec3034SSam Clegg 
712acd7d2b0SSam Clegg     switch (RelEntry.Type) {
713d1152a26SSam Clegg     case wasm::R_WASM_FUNCTION_INDEX_LEB:
714d1152a26SSam Clegg     case wasm::R_WASM_TYPE_INDEX_LEB:
715d1152a26SSam Clegg     case wasm::R_WASM_GLOBAL_INDEX_LEB:
716d1152a26SSam Clegg     case wasm::R_WASM_MEMORY_ADDR_LEB:
717d1152a26SSam Clegg     case wasm::R_WASM_EVENT_INDEX_LEB:
71869e2797eSPaulo Matos     case wasm::R_WASM_TABLE_NUMBER_LEB:
7193b29376eSWouter van Oortmerssen       writePatchableLEB<5>(Stream, Value, Offset);
7203b29376eSWouter van Oortmerssen       break;
7213b29376eSWouter van Oortmerssen     case wasm::R_WASM_MEMORY_ADDR_LEB64:
7223b29376eSWouter van Oortmerssen       writePatchableLEB<10>(Stream, Value, Offset);
723d934cb88SDan Gohman       break;
724d1152a26SSam Clegg     case wasm::R_WASM_TABLE_INDEX_I32:
725d1152a26SSam Clegg     case wasm::R_WASM_MEMORY_ADDR_I32:
726d1152a26SSam Clegg     case wasm::R_WASM_FUNCTION_OFFSET_I32:
727d1152a26SSam Clegg     case wasm::R_WASM_SECTION_OFFSET_I32:
72848139ebcSWouter van Oortmerssen     case wasm::R_WASM_GLOBAL_INDEX_I32:
729aa0c571aSYuta Saito     case wasm::R_WASM_MEMORY_ADDR_LOCREL_I32:
7300a6c4d8dSSam Clegg       patchI32(Stream, Value, Offset);
731d934cb88SDan Gohman       break;
732cc1b9b68SWouter van Oortmerssen     case wasm::R_WASM_TABLE_INDEX_I64:
7333b29376eSWouter van Oortmerssen     case wasm::R_WASM_MEMORY_ADDR_I64:
73416f02431SWouter van Oortmerssen     case wasm::R_WASM_FUNCTION_OFFSET_I64:
7353b29376eSWouter van Oortmerssen       patchI64(Stream, Value, Offset);
7363b29376eSWouter van Oortmerssen       break;
737d1152a26SSam Clegg     case wasm::R_WASM_TABLE_INDEX_SLEB:
7382a7cac93SSam Clegg     case wasm::R_WASM_TABLE_INDEX_REL_SLEB:
739d1152a26SSam Clegg     case wasm::R_WASM_MEMORY_ADDR_SLEB:
7402a7cac93SSam Clegg     case wasm::R_WASM_MEMORY_ADDR_REL_SLEB:
741a28a4662SSam Clegg     case wasm::R_WASM_MEMORY_ADDR_TLS_SLEB:
7423b29376eSWouter van Oortmerssen       writePatchableSLEB<5>(Stream, Value, Offset);
7433b29376eSWouter van Oortmerssen       break;
744cc1b9b68SWouter van Oortmerssen     case wasm::R_WASM_TABLE_INDEX_SLEB64:
7453b29376eSWouter van Oortmerssen     case wasm::R_WASM_MEMORY_ADDR_SLEB64:
7463b29376eSWouter van Oortmerssen     case wasm::R_WASM_MEMORY_ADDR_REL_SLEB64:
7473b29376eSWouter van Oortmerssen       writePatchableSLEB<10>(Stream, Value, Offset);
74860ec3034SSam Clegg       break;
749d934cb88SDan Gohman     default:
7509d24fb7fSSam Clegg       llvm_unreachable("invalid relocation type");
751d934cb88SDan Gohman     }
752d934cb88SDan Gohman   }
75318eafb6cSDan Gohman }
75418eafb6cSDan Gohman 
7554c41fb5aSHeejin Ahn void WasmObjectWriter::writeTypeSection(
7564c41fb5aSHeejin Ahn     ArrayRef<wasm::WasmSignature> Signatures) {
757da419bdbSHeejin Ahn   if (Signatures.empty())
7589e15f359SSam Clegg     return;
7599e15f359SSam Clegg 
7609e15f359SSam Clegg   SectionBookkeeping Section;
7619e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_TYPE);
7629e15f359SSam Clegg 
7630ff28fa6SDerek Schuff   encodeULEB128(Signatures.size(), W->OS);
7649e15f359SSam Clegg 
7654c41fb5aSHeejin Ahn   for (const wasm::WasmSignature &Sig : Signatures) {
7660ff28fa6SDerek Schuff     W->OS << char(wasm::WASM_TYPE_FUNC);
7670ff28fa6SDerek Schuff     encodeULEB128(Sig.Params.size(), W->OS);
768da419bdbSHeejin Ahn     for (wasm::ValType Ty : Sig.Params)
7699e15f359SSam Clegg       writeValueType(Ty);
7700ff28fa6SDerek Schuff     encodeULEB128(Sig.Returns.size(), W->OS);
771da419bdbSHeejin Ahn     for (wasm::ValType Ty : Sig.Returns)
7729e15f359SSam Clegg       writeValueType(Ty);
7739e15f359SSam Clegg   }
7749e15f359SSam Clegg 
7759e15f359SSam Clegg   endSection(Section);
7769e15f359SSam Clegg }
7779e15f359SSam Clegg 
7788defa952SSam Clegg void WasmObjectWriter::writeImportSection(ArrayRef<wasm::WasmImport> Imports,
7794d135b04SWouter van Oortmerssen                                           uint64_t DataSize,
780f950b24aSSam Clegg                                           uint32_t NumElements) {
7819e15f359SSam Clegg   if (Imports.empty())
7829e15f359SSam Clegg     return;
7839e15f359SSam Clegg 
7844d135b04SWouter van Oortmerssen   uint64_t NumPages = (DataSize + wasm::WasmPageSize - 1) / wasm::WasmPageSize;
785f950b24aSSam Clegg 
7869e15f359SSam Clegg   SectionBookkeeping Section;
7879e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_IMPORT);
7889e15f359SSam Clegg 
7890ff28fa6SDerek Schuff   encodeULEB128(Imports.size(), W->OS);
7908defa952SSam Clegg   for (const wasm::WasmImport &Import : Imports) {
7918defa952SSam Clegg     writeString(Import.Module);
7928defa952SSam Clegg     writeString(Import.Field);
7930ff28fa6SDerek Schuff     W->OS << char(Import.Kind);
7949e15f359SSam Clegg 
7959e15f359SSam Clegg     switch (Import.Kind) {
7969e15f359SSam Clegg     case wasm::WASM_EXTERNAL_FUNCTION:
7970ff28fa6SDerek Schuff       encodeULEB128(Import.SigIndex, W->OS);
7989e15f359SSam Clegg       break;
7999e15f359SSam Clegg     case wasm::WASM_EXTERNAL_GLOBAL:
8000ff28fa6SDerek Schuff       W->OS << char(Import.Global.Type);
8010ff28fa6SDerek Schuff       W->OS << char(Import.Global.Mutable ? 1 : 0);
8029e15f359SSam Clegg       break;
803f950b24aSSam Clegg     case wasm::WASM_EXTERNAL_MEMORY:
8040ff28fa6SDerek Schuff       encodeULEB128(Import.Memory.Flags, W->OS);
8050ff28fa6SDerek Schuff       encodeULEB128(NumPages, W->OS); // initial
806f950b24aSSam Clegg       break;
807f950b24aSSam Clegg     case wasm::WASM_EXTERNAL_TABLE:
8080ff28fa6SDerek Schuff       W->OS << char(Import.Table.ElemType);
8090ff28fa6SDerek Schuff       encodeULEB128(0, W->OS);           // flags
8100ff28fa6SDerek Schuff       encodeULEB128(NumElements, W->OS); // initial
811f950b24aSSam Clegg       break;
812da419bdbSHeejin Ahn     case wasm::WASM_EXTERNAL_EVENT:
8130ff28fa6SDerek Schuff       encodeULEB128(Import.Event.Attribute, W->OS);
8140ff28fa6SDerek Schuff       encodeULEB128(Import.Event.SigIndex, W->OS);
815da419bdbSHeejin Ahn       break;
8169e15f359SSam Clegg     default:
8179e15f359SSam Clegg       llvm_unreachable("unsupported import kind");
8189e15f359SSam Clegg     }
8199e15f359SSam Clegg   }
8209e15f359SSam Clegg 
8219e15f359SSam Clegg   endSection(Section);
8229e15f359SSam Clegg }
8239e15f359SSam Clegg 
824457fb0b4SSam Clegg void WasmObjectWriter::writeFunctionSection(ArrayRef<WasmFunction> Functions) {
8259e15f359SSam Clegg   if (Functions.empty())
8269e15f359SSam Clegg     return;
8279e15f359SSam Clegg 
8289e15f359SSam Clegg   SectionBookkeeping Section;
8299e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_FUNCTION);
8309e15f359SSam Clegg 
8310ff28fa6SDerek Schuff   encodeULEB128(Functions.size(), W->OS);
8329e15f359SSam Clegg   for (const WasmFunction &Func : Functions)
8330ff28fa6SDerek Schuff     encodeULEB128(Func.SigIndex, W->OS);
8349e15f359SSam Clegg 
8359e15f359SSam Clegg   endSection(Section);
8369e15f359SSam Clegg }
8379e15f359SSam Clegg 
838da419bdbSHeejin Ahn void WasmObjectWriter::writeEventSection(ArrayRef<wasm::WasmEventType> Events) {
839da419bdbSHeejin Ahn   if (Events.empty())
840da419bdbSHeejin Ahn     return;
841da419bdbSHeejin Ahn 
842da419bdbSHeejin Ahn   SectionBookkeeping Section;
843da419bdbSHeejin Ahn   startSection(Section, wasm::WASM_SEC_EVENT);
844da419bdbSHeejin Ahn 
8450ff28fa6SDerek Schuff   encodeULEB128(Events.size(), W->OS);
846da419bdbSHeejin Ahn   for (const wasm::WasmEventType &Event : Events) {
8470ff28fa6SDerek Schuff     encodeULEB128(Event.Attribute, W->OS);
8480ff28fa6SDerek Schuff     encodeULEB128(Event.SigIndex, W->OS);
849da419bdbSHeejin Ahn   }
850da419bdbSHeejin Ahn 
851da419bdbSHeejin Ahn   endSection(Section);
852da419bdbSHeejin Ahn }
853da419bdbSHeejin Ahn 
8540a6c4d8dSSam Clegg void WasmObjectWriter::writeGlobalSection(ArrayRef<wasm::WasmGlobal> Globals) {
8550a6c4d8dSSam Clegg   if (Globals.empty())
8560a6c4d8dSSam Clegg     return;
8570a6c4d8dSSam Clegg 
8580a6c4d8dSSam Clegg   SectionBookkeeping Section;
8590a6c4d8dSSam Clegg   startSection(Section, wasm::WASM_SEC_GLOBAL);
8600a6c4d8dSSam Clegg 
8610ff28fa6SDerek Schuff   encodeULEB128(Globals.size(), W->OS);
8620a6c4d8dSSam Clegg   for (const wasm::WasmGlobal &Global : Globals) {
8630ff28fa6SDerek Schuff     encodeULEB128(Global.Type.Type, W->OS);
8640ff28fa6SDerek Schuff     W->OS << char(Global.Type.Mutable);
8650ff28fa6SDerek Schuff     W->OS << char(Global.InitExpr.Opcode);
8660a6c4d8dSSam Clegg     switch (Global.Type.Type) {
8670a6c4d8dSSam Clegg     case wasm::WASM_TYPE_I32:
8680ff28fa6SDerek Schuff       encodeSLEB128(0, W->OS);
8690a6c4d8dSSam Clegg       break;
8700a6c4d8dSSam Clegg     case wasm::WASM_TYPE_I64:
8710ff28fa6SDerek Schuff       encodeSLEB128(0, W->OS);
8720a6c4d8dSSam Clegg       break;
8730a6c4d8dSSam Clegg     case wasm::WASM_TYPE_F32:
8740a6c4d8dSSam Clegg       writeI32(0);
8750a6c4d8dSSam Clegg       break;
8760a6c4d8dSSam Clegg     case wasm::WASM_TYPE_F64:
8770a6c4d8dSSam Clegg       writeI64(0);
8780a6c4d8dSSam Clegg       break;
87979aad89dSSam Clegg     case wasm::WASM_TYPE_EXTERNREF:
88079aad89dSSam Clegg       writeValueType(wasm::ValType::EXTERNREF);
88179aad89dSSam Clegg       break;
8820a6c4d8dSSam Clegg     default:
8830a6c4d8dSSam Clegg       llvm_unreachable("unexpected type");
8840a6c4d8dSSam Clegg     }
8850ff28fa6SDerek Schuff     W->OS << char(wasm::WASM_OPCODE_END);
8860a6c4d8dSSam Clegg   }
8870a6c4d8dSSam Clegg 
8880a6c4d8dSSam Clegg   endSection(Section);
8890a6c4d8dSSam Clegg }
8900a6c4d8dSSam Clegg 
891388fb67bSPaulo Matos void WasmObjectWriter::writeTableSection(ArrayRef<wasm::WasmTable> Tables) {
892388fb67bSPaulo Matos   if (Tables.empty())
893388fb67bSPaulo Matos     return;
894388fb67bSPaulo Matos 
895388fb67bSPaulo Matos   SectionBookkeeping Section;
896388fb67bSPaulo Matos   startSection(Section, wasm::WASM_SEC_TABLE);
897388fb67bSPaulo Matos 
898388fb67bSPaulo Matos   encodeULEB128(Tables.size(), W->OS);
899388fb67bSPaulo Matos   for (const wasm::WasmTable &Table : Tables) {
9001933c9d4SAndy Wingo     encodeULEB128(Table.Type.ElemType, W->OS);
9011933c9d4SAndy Wingo     encodeULEB128(Table.Type.Limits.Flags, W->OS);
9029ac5620cSAndy Wingo     encodeULEB128(Table.Type.Limits.Minimum, W->OS);
9031933c9d4SAndy Wingo     if (Table.Type.Limits.Flags & wasm::WASM_LIMITS_FLAG_HAS_MAX)
9041933c9d4SAndy Wingo       encodeULEB128(Table.Type.Limits.Maximum, W->OS);
905388fb67bSPaulo Matos   }
906388fb67bSPaulo Matos   endSection(Section);
907388fb67bSPaulo Matos }
908388fb67bSPaulo Matos 
9098defa952SSam Clegg void WasmObjectWriter::writeExportSection(ArrayRef<wasm::WasmExport> Exports) {
9109e15f359SSam Clegg   if (Exports.empty())
9119e15f359SSam Clegg     return;
9129e15f359SSam Clegg 
9139e15f359SSam Clegg   SectionBookkeeping Section;
9149e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_EXPORT);
9159e15f359SSam Clegg 
9160ff28fa6SDerek Schuff   encodeULEB128(Exports.size(), W->OS);
9178defa952SSam Clegg   for (const wasm::WasmExport &Export : Exports) {
9188defa952SSam Clegg     writeString(Export.Name);
9190ff28fa6SDerek Schuff     W->OS << char(Export.Kind);
9200ff28fa6SDerek Schuff     encodeULEB128(Export.Index, W->OS);
9219e15f359SSam Clegg   }
9229e15f359SSam Clegg 
9239e15f359SSam Clegg   endSection(Section);
9249e15f359SSam Clegg }
9259e15f359SSam Clegg 
926a5a3659dSAndy Wingo void WasmObjectWriter::writeElemSection(
927a5a3659dSAndy Wingo     const MCSymbolWasm *IndirectFunctionTable, ArrayRef<uint32_t> TableElems) {
9289e15f359SSam Clegg   if (TableElems.empty())
9299e15f359SSam Clegg     return;
9309e15f359SSam Clegg 
931a5a3659dSAndy Wingo   assert(IndirectFunctionTable);
932a5a3659dSAndy Wingo 
9339e15f359SSam Clegg   SectionBookkeeping Section;
9349e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_ELEM);
9359e15f359SSam Clegg 
9360ff28fa6SDerek Schuff   encodeULEB128(1, W->OS); // number of "segments"
937a5a3659dSAndy Wingo 
938a5a3659dSAndy Wingo   assert(WasmIndices.count(IndirectFunctionTable));
939a5a3659dSAndy Wingo   uint32_t TableNumber = WasmIndices.find(IndirectFunctionTable)->second;
940a5a3659dSAndy Wingo   uint32_t Flags = 0;
941a5a3659dSAndy Wingo   if (TableNumber)
942a5a3659dSAndy Wingo     Flags |= wasm::WASM_ELEM_SEGMENT_HAS_TABLE_NUMBER;
943a5a3659dSAndy Wingo   encodeULEB128(Flags, W->OS);
944a5a3659dSAndy Wingo   if (Flags & wasm::WASM_ELEM_SEGMENT_HAS_TABLE_NUMBER)
945a5a3659dSAndy Wingo     encodeULEB128(TableNumber, W->OS); // the table number
9469e15f359SSam Clegg 
9479e15f359SSam Clegg   // init expr for starting offset
9480ff28fa6SDerek Schuff   W->OS << char(wasm::WASM_OPCODE_I32_CONST);
9490ff28fa6SDerek Schuff   encodeSLEB128(InitialTableOffset, W->OS);
9500ff28fa6SDerek Schuff   W->OS << char(wasm::WASM_OPCODE_END);
9519e15f359SSam Clegg 
952a5a3659dSAndy Wingo   if (Flags & wasm::WASM_ELEM_SEGMENT_MASK_HAS_ELEM_KIND) {
953a5a3659dSAndy Wingo     // We only write active function table initializers, for which the elem kind
954a5a3659dSAndy Wingo     // is specified to be written as 0x00 and interpreted to mean "funcref".
955a5a3659dSAndy Wingo     const uint8_t ElemKind = 0;
956a5a3659dSAndy Wingo     W->OS << ElemKind;
957a5a3659dSAndy Wingo   }
958a5a3659dSAndy Wingo 
9590ff28fa6SDerek Schuff   encodeULEB128(TableElems.size(), W->OS);
9609e15f359SSam Clegg   for (uint32_t Elem : TableElems)
9610ff28fa6SDerek Schuff     encodeULEB128(Elem, W->OS);
9629e15f359SSam Clegg 
9639e15f359SSam Clegg   endSection(Section);
9649e15f359SSam Clegg }
9659e15f359SSam Clegg 
966fef8de66SThomas Lively void WasmObjectWriter::writeDataCountSection() {
967fef8de66SThomas Lively   if (DataSegments.empty())
968fef8de66SThomas Lively     return;
969fef8de66SThomas Lively 
970fef8de66SThomas Lively   SectionBookkeeping Section;
971fef8de66SThomas Lively   startSection(Section, wasm::WASM_SEC_DATACOUNT);
9720ff28fa6SDerek Schuff   encodeULEB128(DataSegments.size(), W->OS);
973fef8de66SThomas Lively   endSection(Section);
974fef8de66SThomas Lively }
975fef8de66SThomas Lively 
976e49584a3SSam Clegg uint32_t WasmObjectWriter::writeCodeSection(const MCAssembler &Asm,
977457fb0b4SSam Clegg                                             const MCAsmLayout &Layout,
978457fb0b4SSam Clegg                                             ArrayRef<WasmFunction> Functions) {
9799e15f359SSam Clegg   if (Functions.empty())
980e49584a3SSam Clegg     return 0;
9819e15f359SSam Clegg 
9829e15f359SSam Clegg   SectionBookkeeping Section;
9839e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CODE);
9849e15f359SSam Clegg 
9850ff28fa6SDerek Schuff   encodeULEB128(Functions.size(), W->OS);
9869e15f359SSam Clegg 
9879e15f359SSam Clegg   for (const WasmFunction &Func : Functions) {
988fe6414b0SSam Clegg     auto &FuncSection = static_cast<MCSectionWasm &>(Func.Sym->getSection());
9899e15f359SSam Clegg 
9909e15f359SSam Clegg     int64_t Size = 0;
9919e15f359SSam Clegg     if (!Func.Sym->getSize()->evaluateAsAbsolute(Size, Layout))
9929e15f359SSam Clegg       report_fatal_error(".size expression must be evaluatable");
9939e15f359SSam Clegg 
9940ff28fa6SDerek Schuff     encodeULEB128(Size, W->OS);
9950ff28fa6SDerek Schuff     FuncSection.setSectionOffset(W->OS.tell() - Section.ContentsOffset);
9960ff28fa6SDerek Schuff     Asm.writeSectionData(W->OS, &FuncSection, Layout);
9979e15f359SSam Clegg   }
9989e15f359SSam Clegg 
9999e15f359SSam Clegg   // Apply fixups.
10007ee758d6SSam Clegg   applyRelocations(CodeRelocations, Section.ContentsOffset, Layout);
10019e15f359SSam Clegg 
10029e15f359SSam Clegg   endSection(Section);
1003e49584a3SSam Clegg   return Section.Index;
10049e15f359SSam Clegg }
10059e15f359SSam Clegg 
1006e49584a3SSam Clegg uint32_t WasmObjectWriter::writeDataSection(const MCAsmLayout &Layout) {
10076c899ba6SSam Clegg   if (DataSegments.empty())
1008e49584a3SSam Clegg     return 0;
10099e15f359SSam Clegg 
10109e15f359SSam Clegg   SectionBookkeeping Section;
10119e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_DATA);
10129e15f359SSam Clegg 
10130ff28fa6SDerek Schuff   encodeULEB128(DataSegments.size(), W->OS); // count
10147c395943SSam Clegg 
10156c899ba6SSam Clegg   for (const WasmDataSegment &Segment : DataSegments) {
10160ff28fa6SDerek Schuff     encodeULEB128(Segment.InitFlags, W->OS); // flags
1017831a143eSAndy Wingo     if (Segment.InitFlags & wasm::WASM_DATA_SEGMENT_HAS_MEMINDEX)
10180ff28fa6SDerek Schuff       encodeULEB128(0, W->OS); // memory index
1019831a143eSAndy Wingo     if ((Segment.InitFlags & wasm::WASM_DATA_SEGMENT_IS_PASSIVE) == 0) {
10200d9b17d0SWouter van Oortmerssen       W->OS << char(is64Bit() ? wasm::WASM_OPCODE_I64_CONST
10214d135b04SWouter van Oortmerssen                               : wasm::WASM_OPCODE_I32_CONST);
10220ff28fa6SDerek Schuff       encodeSLEB128(Segment.Offset, W->OS); // offset
10230ff28fa6SDerek Schuff       W->OS << char(wasm::WASM_OPCODE_END);
10242e150409SThomas Lively     }
10250ff28fa6SDerek Schuff     encodeULEB128(Segment.Data.size(), W->OS); // size
10260ff28fa6SDerek Schuff     Segment.Section->setSectionOffset(W->OS.tell() - Section.ContentsOffset);
10270ff28fa6SDerek Schuff     W->OS << Segment.Data; // data
10287c395943SSam Clegg   }
10299e15f359SSam Clegg 
10309e15f359SSam Clegg   // Apply fixups.
10317ee758d6SSam Clegg   applyRelocations(DataRelocations, Section.ContentsOffset, Layout);
10329e15f359SSam Clegg 
10339e15f359SSam Clegg   endSection(Section);
1034e49584a3SSam Clegg   return Section.Index;
10359e15f359SSam Clegg }
10369e15f359SSam Clegg 
10376f08c84aSSam Clegg void WasmObjectWriter::writeRelocSection(
10386f08c84aSSam Clegg     uint32_t SectionIndex, StringRef Name,
1039f77dc2a8SSam Clegg     std::vector<WasmRelocationEntry> &Relocs) {
10409e15f359SSam Clegg   // See: https://github.com/WebAssembly/tool-conventions/blob/master/Linking.md
10419e15f359SSam Clegg   // for descriptions of the reloc sections.
10429e15f359SSam Clegg 
1043f77dc2a8SSam Clegg   if (Relocs.empty())
10449e15f359SSam Clegg     return;
10459e15f359SSam Clegg 
1046f77dc2a8SSam Clegg   // First, ensure the relocations are sorted in offset order.  In general they
1047f77dc2a8SSam Clegg   // should already be sorted since `recordRelocation` is called in offset
1048f77dc2a8SSam Clegg   // order, but for the code section we combine many MC sections into single
1049f77dc2a8SSam Clegg   // wasm section, and this order is determined by the order of Asm.Symbols()
1050f77dc2a8SSam Clegg   // not the sections order.
1051efd94c56SFangrui Song   llvm::stable_sort(
1052efd94c56SFangrui Song       Relocs, [](const WasmRelocationEntry &A, const WasmRelocationEntry &B) {
1053f77dc2a8SSam Clegg         return (A.Offset + A.FixupSection->getSectionOffset()) <
1054f77dc2a8SSam Clegg                (B.Offset + B.FixupSection->getSectionOffset());
1055f77dc2a8SSam Clegg       });
1056f77dc2a8SSam Clegg 
10579e15f359SSam Clegg   SectionBookkeeping Section;
10586f08c84aSSam Clegg   startCustomSection(Section, std::string("reloc.") + Name.str());
10599e15f359SSam Clegg 
10600ff28fa6SDerek Schuff   encodeULEB128(SectionIndex, W->OS);
10610ff28fa6SDerek Schuff   encodeULEB128(Relocs.size(), W->OS);
1062f77dc2a8SSam Clegg   for (const WasmRelocationEntry &RelEntry : Relocs) {
1063f208f631SHeejin Ahn     uint64_t Offset =
1064f208f631SHeejin Ahn         RelEntry.Offset + RelEntry.FixupSection->getSectionOffset();
10656f08c84aSSam Clegg     uint32_t Index = getRelocationIndexValue(RelEntry);
10669e15f359SSam Clegg 
10670ff28fa6SDerek Schuff     W->OS << char(RelEntry.Type);
10680ff28fa6SDerek Schuff     encodeULEB128(Offset, W->OS);
10690ff28fa6SDerek Schuff     encodeULEB128(Index, W->OS);
10706f08c84aSSam Clegg     if (RelEntry.hasAddend())
10710ff28fa6SDerek Schuff       encodeSLEB128(RelEntry.Addend, W->OS);
10729e15f359SSam Clegg   }
10739e15f359SSam Clegg 
10749e15f359SSam Clegg   endSection(Section);
10759e15f359SSam Clegg }
10769e15f359SSam Clegg 
10776a31a0d6SSam Clegg void WasmObjectWriter::writeCustomRelocSections() {
10786a31a0d6SSam Clegg   for (const auto &Sec : CustomSections) {
10796a31a0d6SSam Clegg     auto &Relocations = CustomSectionsRelocations[Sec.Section];
10806a31a0d6SSam Clegg     writeRelocSection(Sec.OutputIndex, Sec.Name, Relocations);
10816a31a0d6SSam Clegg   }
10826a31a0d6SSam Clegg }
10836a31a0d6SSam Clegg 
10849e15f359SSam Clegg void WasmObjectWriter::writeLinkingMetaDataSection(
108586b4a09aSSam Clegg     ArrayRef<wasm::WasmSymbolInfo> SymbolInfos,
1086ea7caceeSSam Clegg     ArrayRef<std::pair<uint16_t, uint32_t>> InitFuncs,
1087ea7caceeSSam Clegg     const std::map<StringRef, std::vector<WasmComdatEntry>> &Comdats) {
10889e15f359SSam Clegg   SectionBookkeeping Section;
10892322a937SSam Clegg   startCustomSection(Section, "linking");
10900ff28fa6SDerek Schuff   encodeULEB128(wasm::WasmMetadataVersion, W->OS);
10919e15f359SSam Clegg 
10926bb5a41fSSam Clegg   SectionBookkeeping SubSection;
10936c899ba6SSam Clegg   if (SymbolInfos.size() != 0) {
10946c899ba6SSam Clegg     startSection(SubSection, wasm::WASM_SYMBOL_TABLE);
10950ff28fa6SDerek Schuff     encodeULEB128(SymbolInfos.size(), W->OS);
10966c899ba6SSam Clegg     for (const wasm::WasmSymbolInfo &Sym : SymbolInfos) {
10970ff28fa6SDerek Schuff       encodeULEB128(Sym.Kind, W->OS);
10980ff28fa6SDerek Schuff       encodeULEB128(Sym.Flags, W->OS);
10996c899ba6SSam Clegg       switch (Sym.Kind) {
11006c899ba6SSam Clegg       case wasm::WASM_SYMBOL_TYPE_FUNCTION:
11016c899ba6SSam Clegg       case wasm::WASM_SYMBOL_TYPE_GLOBAL:
1102da419bdbSHeejin Ahn       case wasm::WASM_SYMBOL_TYPE_EVENT:
1103388fb67bSPaulo Matos       case wasm::WASM_SYMBOL_TYPE_TABLE:
11040ff28fa6SDerek Schuff         encodeULEB128(Sym.ElementIndex, W->OS);
110529874ceaSDan Gohman         if ((Sym.Flags & wasm::WASM_SYMBOL_UNDEFINED) == 0 ||
110629874ceaSDan Gohman             (Sym.Flags & wasm::WASM_SYMBOL_EXPLICIT_NAME) != 0)
11076c899ba6SSam Clegg           writeString(Sym.Name);
11086c899ba6SSam Clegg         break;
11096c899ba6SSam Clegg       case wasm::WASM_SYMBOL_TYPE_DATA:
11106c899ba6SSam Clegg         writeString(Sym.Name);
11116c899ba6SSam Clegg         if ((Sym.Flags & wasm::WASM_SYMBOL_UNDEFINED) == 0) {
11120ff28fa6SDerek Schuff           encodeULEB128(Sym.DataRef.Segment, W->OS);
11130ff28fa6SDerek Schuff           encodeULEB128(Sym.DataRef.Offset, W->OS);
11140ff28fa6SDerek Schuff           encodeULEB128(Sym.DataRef.Size, W->OS);
11156c899ba6SSam Clegg         }
11166c899ba6SSam Clegg         break;
11176a31a0d6SSam Clegg       case wasm::WASM_SYMBOL_TYPE_SECTION: {
11186a31a0d6SSam Clegg         const uint32_t SectionIndex =
11196a31a0d6SSam Clegg             CustomSections[Sym.ElementIndex].OutputIndex;
11200ff28fa6SDerek Schuff         encodeULEB128(SectionIndex, W->OS);
11216a31a0d6SSam Clegg         break;
11226a31a0d6SSam Clegg       }
11236c899ba6SSam Clegg       default:
11246c899ba6SSam Clegg         llvm_unreachable("unexpected kind");
11256c899ba6SSam Clegg       }
1126b7787fd0SSam Clegg     }
1127b7787fd0SSam Clegg     endSection(SubSection);
1128b7787fd0SSam Clegg   }
11299e15f359SSam Clegg 
11306c899ba6SSam Clegg   if (DataSegments.size()) {
113163ebb813SSam Clegg     startSection(SubSection, wasm::WASM_SEGMENT_INFO);
11320ff28fa6SDerek Schuff     encodeULEB128(DataSegments.size(), W->OS);
11336c899ba6SSam Clegg     for (const WasmDataSegment &Segment : DataSegments) {
1134d95ed959SSam Clegg       writeString(Segment.Name);
11350ff28fa6SDerek Schuff       encodeULEB128(Segment.Alignment, W->OS);
11360ff28fa6SDerek Schuff       encodeULEB128(Segment.LinkerFlags, W->OS);
113763ebb813SSam Clegg     }
1138d95ed959SSam Clegg     endSection(SubSection);
1139d95ed959SSam Clegg   }
1140d95ed959SSam Clegg 
1141bafe6902SSam Clegg   if (!InitFuncs.empty()) {
1142bafe6902SSam Clegg     startSection(SubSection, wasm::WASM_INIT_FUNCS);
11430ff28fa6SDerek Schuff     encodeULEB128(InitFuncs.size(), W->OS);
1144bafe6902SSam Clegg     for (auto &StartFunc : InitFuncs) {
11450ff28fa6SDerek Schuff       encodeULEB128(StartFunc.first, W->OS);  // priority
11460ff28fa6SDerek Schuff       encodeULEB128(StartFunc.second, W->OS); // function index
1147bafe6902SSam Clegg     }
1148bafe6902SSam Clegg     endSection(SubSection);
1149bafe6902SSam Clegg   }
1150bafe6902SSam Clegg 
1151ea7caceeSSam Clegg   if (Comdats.size()) {
1152ea7caceeSSam Clegg     startSection(SubSection, wasm::WASM_COMDAT_INFO);
11530ff28fa6SDerek Schuff     encodeULEB128(Comdats.size(), W->OS);
1154ea7caceeSSam Clegg     for (const auto &C : Comdats) {
1155ea7caceeSSam Clegg       writeString(C.first);
11560ff28fa6SDerek Schuff       encodeULEB128(0, W->OS); // flags for future use
11570ff28fa6SDerek Schuff       encodeULEB128(C.second.size(), W->OS);
1158ea7caceeSSam Clegg       for (const WasmComdatEntry &Entry : C.second) {
11590ff28fa6SDerek Schuff         encodeULEB128(Entry.Kind, W->OS);
11600ff28fa6SDerek Schuff         encodeULEB128(Entry.Index, W->OS);
1161ea7caceeSSam Clegg       }
1162ea7caceeSSam Clegg     }
1163ea7caceeSSam Clegg     endSection(SubSection);
1164ea7caceeSSam Clegg   }
1165ea7caceeSSam Clegg 
11669e15f359SSam Clegg   endSection(Section);
11679e15f359SSam Clegg }
11689e15f359SSam Clegg 
1169cbda16ebSThomas Lively void WasmObjectWriter::writeCustomSection(WasmCustomSection &CustomSection,
1170cbda16ebSThomas Lively                                           const MCAssembler &Asm,
11716a31a0d6SSam Clegg                                           const MCAsmLayout &Layout) {
1172cfd44a2eSSam Clegg   SectionBookkeeping Section;
11736a31a0d6SSam Clegg   auto *Sec = CustomSection.Section;
11742322a937SSam Clegg   startCustomSection(Section, CustomSection.Name);
11756a31a0d6SSam Clegg 
11760ff28fa6SDerek Schuff   Sec->setSectionOffset(W->OS.tell() - Section.ContentsOffset);
11770ff28fa6SDerek Schuff   Asm.writeSectionData(W->OS, Sec, Layout);
11786a31a0d6SSam Clegg 
11796a31a0d6SSam Clegg   CustomSection.OutputContentsOffset = Section.ContentsOffset;
11806a31a0d6SSam Clegg   CustomSection.OutputIndex = Section.Index;
11816a31a0d6SSam Clegg 
1182cfd44a2eSSam Clegg   endSection(Section);
11836a31a0d6SSam Clegg 
11846a31a0d6SSam Clegg   // Apply fixups.
11854d57fbd0SSam Clegg   auto &Relocations = CustomSectionsRelocations[CustomSection.Section];
11867ee758d6SSam Clegg   applyRelocations(Relocations, CustomSection.OutputContentsOffset, Layout);
11876a31a0d6SSam Clegg }
11886a31a0d6SSam Clegg 
11895e3d33a7SSam Clegg uint32_t WasmObjectWriter::getFunctionType(const MCSymbolWasm &Symbol) {
11905e3d33a7SSam Clegg   assert(Symbol.isFunction());
11915e3d33a7SSam Clegg   assert(TypeIndices.count(&Symbol));
11925e3d33a7SSam Clegg   return TypeIndices[&Symbol];
11935e3d33a7SSam Clegg }
11945e3d33a7SSam Clegg 
1195da419bdbSHeejin Ahn uint32_t WasmObjectWriter::getEventType(const MCSymbolWasm &Symbol) {
1196da419bdbSHeejin Ahn   assert(Symbol.isEvent());
1197da419bdbSHeejin Ahn   assert(TypeIndices.count(&Symbol));
1198da419bdbSHeejin Ahn   return TypeIndices[&Symbol];
1199da419bdbSHeejin Ahn }
1200da419bdbSHeejin Ahn 
120138b12f5eSHeejin Ahn void WasmObjectWriter::registerFunctionType(const MCSymbolWasm &Symbol) {
12025e3d33a7SSam Clegg   assert(Symbol.isFunction());
12035e3d33a7SSam Clegg 
12044c41fb5aSHeejin Ahn   wasm::WasmSignature S;
12057ee758d6SSam Clegg 
12067ee758d6SSam Clegg   if (auto *Sig = Symbol.getSignature()) {
1207da419bdbSHeejin Ahn     S.Returns = Sig->Returns;
1208da419bdbSHeejin Ahn     S.Params = Sig->Params;
120977a7a380SDerek Schuff   }
12105e3d33a7SSam Clegg 
1211da419bdbSHeejin Ahn   auto Pair = SignatureIndices.insert(std::make_pair(S, Signatures.size()));
12125e3d33a7SSam Clegg   if (Pair.second)
1213da419bdbSHeejin Ahn     Signatures.push_back(S);
12145e3d33a7SSam Clegg   TypeIndices[&Symbol] = Pair.first->second;
12155e3d33a7SSam Clegg 
1216d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "registerFunctionType: " << Symbol
1217d34e60caSNicola Zaghen                     << " new:" << Pair.second << "\n");
1218d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "  -> type index: " << Pair.first->second << "\n");
12195e3d33a7SSam Clegg }
12205e3d33a7SSam Clegg 
122138b12f5eSHeejin Ahn void WasmObjectWriter::registerEventType(const MCSymbolWasm &Symbol) {
1222da419bdbSHeejin Ahn   assert(Symbol.isEvent());
1223da419bdbSHeejin Ahn 
1224da419bdbSHeejin Ahn   // TODO Currently we don't generate imported exceptions, but if we do, we
1225da419bdbSHeejin Ahn   // should have a way of infering types of imported exceptions.
12264c41fb5aSHeejin Ahn   wasm::WasmSignature S;
1227da419bdbSHeejin Ahn   if (auto *Sig = Symbol.getSignature()) {
1228da419bdbSHeejin Ahn     S.Returns = Sig->Returns;
1229da419bdbSHeejin Ahn     S.Params = Sig->Params;
1230da419bdbSHeejin Ahn   }
1231da419bdbSHeejin Ahn 
1232da419bdbSHeejin Ahn   auto Pair = SignatureIndices.insert(std::make_pair(S, Signatures.size()));
1233da419bdbSHeejin Ahn   if (Pair.second)
1234da419bdbSHeejin Ahn     Signatures.push_back(S);
1235da419bdbSHeejin Ahn   TypeIndices[&Symbol] = Pair.first->second;
1236da419bdbSHeejin Ahn 
1237da419bdbSHeejin Ahn   LLVM_DEBUG(dbgs() << "registerEventType: " << Symbol << " new:" << Pair.second
1238da419bdbSHeejin Ahn                     << "\n");
1239da419bdbSHeejin Ahn   LLVM_DEBUG(dbgs() << "  -> type index: " << Pair.first->second << "\n");
1240da419bdbSHeejin Ahn }
1241da419bdbSHeejin Ahn 
12424d57fbd0SSam Clegg static bool isInSymtab(const MCSymbolWasm &Sym) {
12433ea1c62cSSam Clegg   if (Sym.isUsedInReloc() || Sym.isUsedInInitArray())
12444d57fbd0SSam Clegg     return true;
12454d57fbd0SSam Clegg 
12464d57fbd0SSam Clegg   if (Sym.isComdat() && !Sym.isDefined())
12474d57fbd0SSam Clegg     return false;
12484d57fbd0SSam Clegg 
12493ea1c62cSSam Clegg   if (Sym.isTemporary())
12504d57fbd0SSam Clegg     return false;
12514d57fbd0SSam Clegg 
12524d57fbd0SSam Clegg   if (Sym.isSection())
12534d57fbd0SSam Clegg     return false;
12544d57fbd0SSam Clegg 
12552632ba6aSAndy Wingo   if (Sym.omitFromLinkingSection())
12562632ba6aSAndy Wingo     return false;
12572632ba6aSAndy Wingo 
12584d57fbd0SSam Clegg   return true;
12594d57fbd0SSam Clegg }
126030d314aaSSam Clegg 
12610ff28fa6SDerek Schuff void WasmObjectWriter::prepareImports(
12620ff28fa6SDerek Schuff     SmallVectorImpl<wasm::WasmImport> &Imports, MCAssembler &Asm,
126318eafb6cSDan Gohman     const MCAsmLayout &Layout) {
1264f950b24aSSam Clegg   // For now, always emit the memory import, since loads and stores are not
1265f950b24aSSam Clegg   // valid without it. In the future, we could perhaps be more clever and omit
1266f950b24aSSam Clegg   // it if there are no loads or stores.
12678defa952SSam Clegg   wasm::WasmImport MemImport;
12681ed3a046SSam Clegg   MemImport.Module = "env";
12691ed3a046SSam Clegg   MemImport.Field = "__linear_memory";
1270f950b24aSSam Clegg   MemImport.Kind = wasm::WASM_EXTERNAL_MEMORY;
1271fd0964aeSWouter van Oortmerssen   MemImport.Memory.Flags = is64Bit() ? wasm::WASM_LIMITS_FLAG_IS_64
1272fd0964aeSWouter van Oortmerssen                                      : wasm::WASM_LIMITS_FLAG_NONE;
1273f950b24aSSam Clegg   Imports.push_back(MemImport);
1274f950b24aSSam Clegg 
1275da419bdbSHeejin Ahn   // Populate SignatureIndices, and Imports and WasmIndices for undefined
1276586320c0SNicholas Wilson   // symbols.  This must be done before populating WasmIndices for defined
1277586320c0SNicholas Wilson   // symbols.
127832ce5ca0SDan Gohman   for (const MCSymbol &S : Asm.symbols()) {
127932ce5ca0SDan Gohman     const auto &WS = static_cast<const MCSymbolWasm &>(S);
128032ce5ca0SDan Gohman 
128132ce5ca0SDan Gohman     // Register types for all functions, including those with private linkage
12829f3fe42eSSam Clegg     // (because wasm always needs a type signature).
12837ee758d6SSam Clegg     if (WS.isFunction()) {
12849c7b5808SDominic Chen       const auto *BS = Layout.getBaseSymbol(S);
12859c7b5808SDominic Chen       if (!BS)
12869c7b5808SDominic Chen         report_fatal_error(Twine(S.getName()) +
12879c7b5808SDominic Chen                            ": absolute addressing not supported!");
12889c7b5808SDominic Chen       registerFunctionType(*cast<MCSymbolWasm>(BS));
12897ee758d6SSam Clegg     }
129032ce5ca0SDan Gohman 
1291da419bdbSHeejin Ahn     if (WS.isEvent())
1292da419bdbSHeejin Ahn       registerEventType(WS);
1293da419bdbSHeejin Ahn 
129432ce5ca0SDan Gohman     if (WS.isTemporary())
129532ce5ca0SDan Gohman       continue;
129632ce5ca0SDan Gohman 
129732ce5ca0SDan Gohman     // If the symbol is not defined in this translation unit, import it.
12986c899ba6SSam Clegg     if (!WS.isDefined() && !WS.isComdat()) {
12996c899ba6SSam Clegg       if (WS.isFunction()) {
13008defa952SSam Clegg         wasm::WasmImport Import;
1301f726e445SDan Gohman         Import.Module = WS.getImportModule();
1302f726e445SDan Gohman         Import.Field = WS.getImportName();
130332ce5ca0SDan Gohman         Import.Kind = wasm::WASM_EXTERNAL_FUNCTION;
13048defa952SSam Clegg         Import.SigIndex = getFunctionType(WS);
13056c899ba6SSam Clegg         Imports.push_back(Import);
1306492f7529SSam Clegg         assert(WasmIndices.count(&WS) == 0);
13076c899ba6SSam Clegg         WasmIndices[&WS] = NumFunctionImports++;
13086c899ba6SSam Clegg       } else if (WS.isGlobal()) {
130915f349f7SNicholas Wilson         if (WS.isWeak())
131015f349f7SNicholas Wilson           report_fatal_error("undefined global symbol cannot be weak");
131115f349f7SNicholas Wilson 
13126c899ba6SSam Clegg         wasm::WasmImport Import;
1313f726e445SDan Gohman         Import.Field = WS.getImportName();
131432ce5ca0SDan Gohman         Import.Kind = wasm::WASM_EXTERNAL_GLOBAL;
1315492f7529SSam Clegg         Import.Module = WS.getImportModule();
13166c899ba6SSam Clegg         Import.Global = WS.getGlobalType();
13176c899ba6SSam Clegg         Imports.push_back(Import);
1318492f7529SSam Clegg         assert(WasmIndices.count(&WS) == 0);
13196c899ba6SSam Clegg         WasmIndices[&WS] = NumGlobalImports++;
1320da419bdbSHeejin Ahn       } else if (WS.isEvent()) {
1321da419bdbSHeejin Ahn         if (WS.isWeak())
1322da419bdbSHeejin Ahn           report_fatal_error("undefined event symbol cannot be weak");
1323da419bdbSHeejin Ahn 
1324da419bdbSHeejin Ahn         wasm::WasmImport Import;
1325f726e445SDan Gohman         Import.Module = WS.getImportModule();
1326f726e445SDan Gohman         Import.Field = WS.getImportName();
1327da419bdbSHeejin Ahn         Import.Kind = wasm::WASM_EXTERNAL_EVENT;
1328da419bdbSHeejin Ahn         Import.Event.Attribute = wasm::WASM_EVENT_ATTRIBUTE_EXCEPTION;
1329da419bdbSHeejin Ahn         Import.Event.SigIndex = getEventType(WS);
1330da419bdbSHeejin Ahn         Imports.push_back(Import);
1331492f7529SSam Clegg         assert(WasmIndices.count(&WS) == 0);
1332da419bdbSHeejin Ahn         WasmIndices[&WS] = NumEventImports++;
1333feac819eSAndy Wingo       } else if (WS.isTable()) {
1334feac819eSAndy Wingo         if (WS.isWeak())
1335feac819eSAndy Wingo           report_fatal_error("undefined table symbol cannot be weak");
1336feac819eSAndy Wingo 
1337feac819eSAndy Wingo         wasm::WasmImport Import;
1338feac819eSAndy Wingo         Import.Module = WS.getImportModule();
1339feac819eSAndy Wingo         Import.Field = WS.getImportName();
1340feac819eSAndy Wingo         Import.Kind = wasm::WASM_EXTERNAL_TABLE;
1341*c9801db2SAndy Wingo         Import.Table = WS.getTableType();
1342feac819eSAndy Wingo         Imports.push_back(Import);
1343feac819eSAndy Wingo         assert(WasmIndices.count(&WS) == 0);
1344feac819eSAndy Wingo         WasmIndices[&WS] = NumTableImports++;
134532ce5ca0SDan Gohman       }
134632ce5ca0SDan Gohman     }
134732ce5ca0SDan Gohman   }
134832ce5ca0SDan Gohman 
1349492f7529SSam Clegg   // Add imports for GOT globals
1350492f7529SSam Clegg   for (const MCSymbol &S : Asm.symbols()) {
1351492f7529SSam Clegg     const auto &WS = static_cast<const MCSymbolWasm &>(S);
1352492f7529SSam Clegg     if (WS.isUsedInGOT()) {
1353492f7529SSam Clegg       wasm::WasmImport Import;
1354492f7529SSam Clegg       if (WS.isFunction())
1355492f7529SSam Clegg         Import.Module = "GOT.func";
1356492f7529SSam Clegg       else
1357492f7529SSam Clegg         Import.Module = "GOT.mem";
1358492f7529SSam Clegg       Import.Field = WS.getName();
1359492f7529SSam Clegg       Import.Kind = wasm::WASM_EXTERNAL_GLOBAL;
1360492f7529SSam Clegg       Import.Global = {wasm::WASM_TYPE_I32, true};
1361492f7529SSam Clegg       Imports.push_back(Import);
1362492f7529SSam Clegg       assert(GOTIndices.count(&WS) == 0);
1363492f7529SSam Clegg       GOTIndices[&WS] = NumGlobalImports++;
1364492f7529SSam Clegg     }
1365492f7529SSam Clegg   }
13660ff28fa6SDerek Schuff }
1367492f7529SSam Clegg 
13680ff28fa6SDerek Schuff uint64_t WasmObjectWriter::writeObject(MCAssembler &Asm,
13690ff28fa6SDerek Schuff                                        const MCAsmLayout &Layout) {
13700ff28fa6SDerek Schuff   support::endian::Writer MainWriter(*OS, support::little);
13710ff28fa6SDerek Schuff   W = &MainWriter;
13720ff28fa6SDerek Schuff   if (IsSplitDwarf) {
13730ff28fa6SDerek Schuff     uint64_t TotalSize = writeOneObject(Asm, Layout, DwoMode::NonDwoOnly);
13740ff28fa6SDerek Schuff     assert(DwoOS);
13750ff28fa6SDerek Schuff     support::endian::Writer DwoWriter(*DwoOS, support::little);
13760ff28fa6SDerek Schuff     W = &DwoWriter;
13770ff28fa6SDerek Schuff     return TotalSize + writeOneObject(Asm, Layout, DwoMode::DwoOnly);
13780ff28fa6SDerek Schuff   } else {
13790ff28fa6SDerek Schuff     return writeOneObject(Asm, Layout, DwoMode::AllSections);
13800ff28fa6SDerek Schuff   }
13810ff28fa6SDerek Schuff }
13820ff28fa6SDerek Schuff 
13830ff28fa6SDerek Schuff uint64_t WasmObjectWriter::writeOneObject(MCAssembler &Asm,
13840ff28fa6SDerek Schuff                                           const MCAsmLayout &Layout,
13850ff28fa6SDerek Schuff                                           DwoMode Mode) {
13860ff28fa6SDerek Schuff   uint64_t StartOffset = W->OS.tell();
13870ff28fa6SDerek Schuff   SectionCount = 0;
13880ff28fa6SDerek Schuff   CustomSections.clear();
13890ff28fa6SDerek Schuff 
13900ff28fa6SDerek Schuff   LLVM_DEBUG(dbgs() << "WasmObjectWriter::writeObject\n");
13910ff28fa6SDerek Schuff 
13920ff28fa6SDerek Schuff   // Collect information from the available symbols.
13930ff28fa6SDerek Schuff   SmallVector<WasmFunction, 4> Functions;
13940ff28fa6SDerek Schuff   SmallVector<uint32_t, 4> TableElems;
13950ff28fa6SDerek Schuff   SmallVector<wasm::WasmImport, 4> Imports;
13960ff28fa6SDerek Schuff   SmallVector<wasm::WasmExport, 4> Exports;
13970ff28fa6SDerek Schuff   SmallVector<wasm::WasmEventType, 1> Events;
13980ff28fa6SDerek Schuff   SmallVector<wasm::WasmGlobal, 1> Globals;
1399388fb67bSPaulo Matos   SmallVector<wasm::WasmTable, 1> Tables;
14000ff28fa6SDerek Schuff   SmallVector<wasm::WasmSymbolInfo, 4> SymbolInfos;
14010ff28fa6SDerek Schuff   SmallVector<std::pair<uint16_t, uint32_t>, 2> InitFuncs;
14020ff28fa6SDerek Schuff   std::map<StringRef, std::vector<WasmComdatEntry>> Comdats;
14030ff28fa6SDerek Schuff   uint64_t DataSize = 0;
14040ff28fa6SDerek Schuff   if (Mode != DwoMode::DwoOnly) {
14050ff28fa6SDerek Schuff     prepareImports(Imports, Asm, Layout);
14060ff28fa6SDerek Schuff   }
140730d314aaSSam Clegg 
14084d57fbd0SSam Clegg   // Populate DataSegments and CustomSections, which must be done before
14094d57fbd0SSam Clegg   // populating DataLocations.
1410759631c7SSam Clegg   for (MCSection &Sec : Asm) {
1411759631c7SSam Clegg     auto &Section = static_cast<MCSectionWasm &>(Sec);
14127d1ff446SFangrui Song     StringRef SectionName = Section.getName();
1413759631c7SSam Clegg 
14140ff28fa6SDerek Schuff     if (Mode == DwoMode::NonDwoOnly && isDwoSection(Sec))
14150ff28fa6SDerek Schuff       continue;
14160ff28fa6SDerek Schuff     if (Mode == DwoMode::DwoOnly && !isDwoSection(Sec))
14170ff28fa6SDerek Schuff       continue;
14180ff28fa6SDerek Schuff 
14198d396acaSDerek Schuff     LLVM_DEBUG(dbgs() << "Processing Section " << SectionName << "  group "
14208d396acaSDerek Schuff                       << Section.getGroup() << "\n";);
14218d396acaSDerek Schuff 
1422bafe6902SSam Clegg     // .init_array sections are handled specially elsewhere.
14234d57fbd0SSam Clegg     if (SectionName.startswith(".init_array"))
1424bafe6902SSam Clegg       continue;
1425bafe6902SSam Clegg 
14264d57fbd0SSam Clegg     // Code is handled separately
14274d57fbd0SSam Clegg     if (Section.getKind().isText())
14284d57fbd0SSam Clegg       continue;
14294d57fbd0SSam Clegg 
14304d57fbd0SSam Clegg     if (Section.isWasmData()) {
1431329e76d5SSam Clegg       uint32_t SegmentIndex = DataSegments.size();
1432759631c7SSam Clegg       DataSize = alignTo(DataSize, Section.getAlignment());
1433759631c7SSam Clegg       DataSegments.emplace_back();
1434759631c7SSam Clegg       WasmDataSegment &Segment = DataSegments.back();
14354d57fbd0SSam Clegg       Segment.Name = SectionName;
1436831a143eSAndy Wingo       Segment.InitFlags = Section.getPassive()
1437831a143eSAndy Wingo                               ? (uint32_t)wasm::WASM_DATA_SEGMENT_IS_PASSIVE
1438831a143eSAndy Wingo                               : 0;
1439759631c7SSam Clegg       Segment.Offset = DataSize;
1440759631c7SSam Clegg       Segment.Section = &Section;
144163ebb813SSam Clegg       addData(Segment.Data, Section);
144256c587adSSam Clegg       Segment.Alignment = Log2_32(Section.getAlignment());
14432e150409SThomas Lively       Segment.LinkerFlags = 0;
1444759631c7SSam Clegg       DataSize += Segment.Data.size();
14456c899ba6SSam Clegg       Section.setSegmentIndex(SegmentIndex);
1446ea7caceeSSam Clegg 
1447ea7caceeSSam Clegg       if (const MCSymbolWasm *C = Section.getGroup()) {
1448ea7caceeSSam Clegg         Comdats[C->getName()].emplace_back(
1449329e76d5SSam Clegg             WasmComdatEntry{wasm::WASM_COMDAT_DATA, SegmentIndex});
1450ea7caceeSSam Clegg       }
14514d57fbd0SSam Clegg     } else {
14524d57fbd0SSam Clegg       // Create custom sections
14534d57fbd0SSam Clegg       assert(Sec.getKind().isMetadata());
14544d57fbd0SSam Clegg 
14554d57fbd0SSam Clegg       StringRef Name = SectionName;
14564d57fbd0SSam Clegg 
14574d57fbd0SSam Clegg       // For user-defined custom sections, strip the prefix
14584d57fbd0SSam Clegg       if (Name.startswith(".custom_section."))
14594d57fbd0SSam Clegg         Name = Name.substr(strlen(".custom_section."));
14604d57fbd0SSam Clegg 
14614d57fbd0SSam Clegg       MCSymbol *Begin = Sec.getBeginSymbol();
1462fb807d4dSSam Clegg       if (Begin) {
146330d314aaSSam Clegg         assert(WasmIndices.count(cast<MCSymbolWasm>(Begin)) == 0);
14644d57fbd0SSam Clegg         WasmIndices[cast<MCSymbolWasm>(Begin)] = CustomSections.size();
1465fb807d4dSSam Clegg       }
1466cbda16ebSThomas Lively 
1467f6f4f843SThomas Lively       // Separate out the producers and target features sections
1468cbda16ebSThomas Lively       if (Name == "producers") {
14690eaee545SJonas Devlieghere         ProducersSection = std::make_unique<WasmCustomSection>(Name, &Section);
1470cbda16ebSThomas Lively         continue;
1471cbda16ebSThomas Lively       }
1472f6f4f843SThomas Lively       if (Name == "target_features") {
1473f6f4f843SThomas Lively         TargetFeaturesSection =
14740eaee545SJonas Devlieghere             std::make_unique<WasmCustomSection>(Name, &Section);
1475f6f4f843SThomas Lively         continue;
1476f6f4f843SThomas Lively       }
1477cbda16ebSThomas Lively 
14780a391060SDerek Schuff       // Custom sections can also belong to COMDAT groups. In this case the
14790a391060SDerek Schuff       // decriptor's "index" field is the section index (in the final object
14800a391060SDerek Schuff       // file), but that is not known until after layout, so it must be fixed up
14810a391060SDerek Schuff       // later
14820a391060SDerek Schuff       if (const MCSymbolWasm *C = Section.getGroup()) {
14830a391060SDerek Schuff         Comdats[C->getName()].emplace_back(
14840a391060SDerek Schuff             WasmComdatEntry{wasm::WASM_COMDAT_SECTION,
14850a391060SDerek Schuff                             static_cast<uint32_t>(CustomSections.size())});
14860a391060SDerek Schuff       }
14870a391060SDerek Schuff 
14884d57fbd0SSam Clegg       CustomSections.emplace_back(Name, &Section);
1489759631c7SSam Clegg     }
14906a31a0d6SSam Clegg   }
14916a31a0d6SSam Clegg 
149230d314aaSSam Clegg   if (Mode != DwoMode::DwoOnly) {
1493586320c0SNicholas Wilson     // Populate WasmIndices and DataLocations for defined symbols.
1494d934cb88SDan Gohman     for (const MCSymbol &S : Asm.symbols()) {
1495d934cb88SDan Gohman       // Ignore unnamed temporary symbols, which aren't ever exported, imported,
1496d934cb88SDan Gohman       // or used in relocations.
1497d934cb88SDan Gohman       if (S.isTemporary() && S.getName().empty())
1498d934cb88SDan Gohman         continue;
1499b7787fd0SSam Clegg 
1500d934cb88SDan Gohman       const auto &WS = static_cast<const MCSymbolWasm &>(S);
15015e5b2cb1SWouter van Oortmerssen       LLVM_DEBUG(dbgs()
15025e5b2cb1SWouter van Oortmerssen                  << "MCSymbol: "
15035e5b2cb1SWouter van Oortmerssen                  << toString(WS.getType().getValueOr(wasm::WASM_SYMBOL_TYPE_DATA))
15045e5b2cb1SWouter van Oortmerssen                  << " '" << S << "'"
1505d34e60caSNicola Zaghen                  << " isDefined=" << S.isDefined() << " isExternal="
1506d34e60caSNicola Zaghen                  << S.isExternal() << " isTemporary=" << S.isTemporary()
1507d34e60caSNicola Zaghen                  << " isWeak=" << WS.isWeak() << " isHidden=" << WS.isHidden()
1508b7787fd0SSam Clegg                  << " isVariable=" << WS.isVariable() << "\n");
1509b7787fd0SSam Clegg 
15105e3d33a7SSam Clegg       if (WS.isVariable())
15115e3d33a7SSam Clegg         continue;
15126c899ba6SSam Clegg       if (WS.isComdat() && !WS.isDefined())
15136c899ba6SSam Clegg         continue;
1514b7787fd0SSam Clegg 
1515d934cb88SDan Gohman       if (WS.isFunction()) {
15166c899ba6SSam Clegg         unsigned Index;
1517cd65f698SSam Clegg         if (WS.isDefined()) {
1518b7787fd0SSam Clegg           if (WS.getOffset() != 0)
1519b7787fd0SSam Clegg             report_fatal_error(
1520b7787fd0SSam Clegg                 "function sections must contain one function each");
1521b7787fd0SSam Clegg 
152218c56a07SHeejin Ahn           if (WS.getSize() == nullptr)
1523b7787fd0SSam Clegg             report_fatal_error(
1524b7787fd0SSam Clegg                 "function symbols must have a size set with .size");
1525b7787fd0SSam Clegg 
15266c899ba6SSam Clegg           // A definition. Write out the function body.
15279f3fe42eSSam Clegg           Index = NumFunctionImports + Functions.size();
1528d934cb88SDan Gohman           WasmFunction Func;
1529da419bdbSHeejin Ahn           Func.SigIndex = getFunctionType(WS);
1530d934cb88SDan Gohman           Func.Sym = &WS;
153130d314aaSSam Clegg           assert(WasmIndices.count(&WS) == 0);
15326c899ba6SSam Clegg           WasmIndices[&WS] = Index;
1533d934cb88SDan Gohman           Functions.push_back(Func);
15346c899ba6SSam Clegg 
15356c899ba6SSam Clegg           auto &Section = static_cast<MCSectionWasm &>(WS.getSection());
15366c899ba6SSam Clegg           if (const MCSymbolWasm *C = Section.getGroup()) {
15376c899ba6SSam Clegg             Comdats[C->getName()].emplace_back(
15386c899ba6SSam Clegg                 WasmComdatEntry{wasm::WASM_COMDAT_FUNCTION, Index});
15396c899ba6SSam Clegg           }
1540881d8778SSam Clegg 
1541881d8778SSam Clegg           if (WS.hasExportName()) {
1542881d8778SSam Clegg             wasm::WasmExport Export;
1543881d8778SSam Clegg             Export.Name = WS.getExportName();
1544881d8778SSam Clegg             Export.Kind = wasm::WASM_EXTERNAL_FUNCTION;
1545881d8778SSam Clegg             Export.Index = Index;
1546881d8778SSam Clegg             Exports.push_back(Export);
1547881d8778SSam Clegg           }
1548d934cb88SDan Gohman         } else {
1549d934cb88SDan Gohman           // An import; the index was assigned above.
15506c899ba6SSam Clegg           Index = WasmIndices.find(&WS)->second;
1551d934cb88SDan Gohman         }
1552d934cb88SDan Gohman 
1553d34e60caSNicola Zaghen         LLVM_DEBUG(dbgs() << "  -> function index: " << Index << "\n");
1554da419bdbSHeejin Ahn 
15556c899ba6SSam Clegg       } else if (WS.isData()) {
1556f3feb6adSWouter van Oortmerssen         if (!isInSymtab(WS))
1557c38e947eSSam Clegg           continue;
1558c38e947eSSam Clegg 
15596c899ba6SSam Clegg         if (!WS.isDefined()) {
1560d34e60caSNicola Zaghen           LLVM_DEBUG(dbgs() << "  -> segment index: -1"
1561d34e60caSNicola Zaghen                             << "\n");
1562fe6414b0SSam Clegg           continue;
15636c899ba6SSam Clegg         }
1564fe6414b0SSam Clegg 
1565d934cb88SDan Gohman         if (!WS.getSize())
1566c38e947eSSam Clegg           report_fatal_error("data symbols must have a size set with .size: " +
1567c38e947eSSam Clegg                              WS.getName());
1568d934cb88SDan Gohman 
1569d934cb88SDan Gohman         int64_t Size = 0;
1570d934cb88SDan Gohman         if (!WS.getSize()->evaluateAsAbsolute(Size, Layout))
1571d934cb88SDan Gohman           report_fatal_error(".size expression must be evaluatable");
1572d934cb88SDan Gohman 
1573759631c7SSam Clegg         auto &DataSection = static_cast<MCSectionWasm &>(WS.getSection());
1574079cba04SSam Clegg         if (!DataSection.isWasmData())
1575079cba04SSam Clegg           report_fatal_error("data symbols must live in a data section: " +
1576079cba04SSam Clegg                              WS.getName());
15777c395943SSam Clegg 
15786c899ba6SSam Clegg         // For each data symbol, export it in the symtab as a reference to the
15796c899ba6SSam Clegg         // corresponding Wasm data segment.
15806c899ba6SSam Clegg         wasm::WasmDataReference Ref = wasm::WasmDataReference{
15813b29376eSWouter van Oortmerssen             DataSection.getSegmentIndex(), Layout.getSymbolOffset(WS),
15823b29376eSWouter van Oortmerssen             static_cast<uint64_t>(Size)};
158330d314aaSSam Clegg         assert(DataLocations.count(&WS) == 0);
15846c899ba6SSam Clegg         DataLocations[&WS] = Ref;
1585d34e60caSNicola Zaghen         LLVM_DEBUG(dbgs() << "  -> segment index: " << Ref.Segment << "\n");
1586da419bdbSHeejin Ahn 
1587a165f2d6SSam Clegg       } else if (WS.isGlobal()) {
15886c899ba6SSam Clegg         // A "true" Wasm global (currently just __stack_pointer)
15890a6c4d8dSSam Clegg         if (WS.isDefined()) {
15900a6c4d8dSSam Clegg           wasm::WasmGlobal Global;
15910a6c4d8dSSam Clegg           Global.Type = WS.getGlobalType();
15920a6c4d8dSSam Clegg           Global.Index = NumGlobalImports + Globals.size();
15930a6c4d8dSSam Clegg           switch (Global.Type.Type) {
15940a6c4d8dSSam Clegg           case wasm::WASM_TYPE_I32:
15950a6c4d8dSSam Clegg             Global.InitExpr.Opcode = wasm::WASM_OPCODE_I32_CONST;
15960a6c4d8dSSam Clegg             break;
15970a6c4d8dSSam Clegg           case wasm::WASM_TYPE_I64:
15980a6c4d8dSSam Clegg             Global.InitExpr.Opcode = wasm::WASM_OPCODE_I64_CONST;
15990a6c4d8dSSam Clegg             break;
16000a6c4d8dSSam Clegg           case wasm::WASM_TYPE_F32:
16010a6c4d8dSSam Clegg             Global.InitExpr.Opcode = wasm::WASM_OPCODE_F32_CONST;
16020a6c4d8dSSam Clegg             break;
16030a6c4d8dSSam Clegg           case wasm::WASM_TYPE_F64:
16040a6c4d8dSSam Clegg             Global.InitExpr.Opcode = wasm::WASM_OPCODE_F64_CONST;
16050a6c4d8dSSam Clegg             break;
160679aad89dSSam Clegg           case wasm::WASM_TYPE_EXTERNREF:
160779aad89dSSam Clegg             Global.InitExpr.Opcode = wasm::WASM_OPCODE_REF_NULL;
160879aad89dSSam Clegg             break;
16090a6c4d8dSSam Clegg           default:
16100a6c4d8dSSam Clegg             llvm_unreachable("unexpected type");
16110a6c4d8dSSam Clegg           }
161230d314aaSSam Clegg           assert(WasmIndices.count(&WS) == 0);
16130a6c4d8dSSam Clegg           WasmIndices[&WS] = Global.Index;
16140a6c4d8dSSam Clegg           Globals.push_back(Global);
16150a6c4d8dSSam Clegg         } else {
1616545932beSEric Christopher           // An import; the index was assigned above
1617d34e60caSNicola Zaghen           LLVM_DEBUG(dbgs() << "  -> global index: "
1618d34e60caSNicola Zaghen                             << WasmIndices.find(&WS)->second << "\n");
16190a6c4d8dSSam Clegg         }
1620388fb67bSPaulo Matos       } else if (WS.isTable()) {
1621388fb67bSPaulo Matos         if (WS.isDefined()) {
1622388fb67bSPaulo Matos           wasm::WasmTable Table;
1623388fb67bSPaulo Matos           Table.Index = NumTableImports + Tables.size();
1624*c9801db2SAndy Wingo           Table.Type = WS.getTableType();
162530d314aaSSam Clegg           assert(WasmIndices.count(&WS) == 0);
1626388fb67bSPaulo Matos           WasmIndices[&WS] = Table.Index;
1627388fb67bSPaulo Matos           Tables.push_back(Table);
1628388fb67bSPaulo Matos         }
162930d314aaSSam Clegg         LLVM_DEBUG(dbgs() << " -> table index: "
163030d314aaSSam Clegg                           << WasmIndices.find(&WS)->second << "\n");
1631da419bdbSHeejin Ahn       } else if (WS.isEvent()) {
1632da419bdbSHeejin Ahn         // C++ exception symbol (__cpp_exception)
1633da419bdbSHeejin Ahn         unsigned Index;
1634da419bdbSHeejin Ahn         if (WS.isDefined()) {
1635da419bdbSHeejin Ahn           Index = NumEventImports + Events.size();
1636da419bdbSHeejin Ahn           wasm::WasmEventType Event;
1637da419bdbSHeejin Ahn           Event.SigIndex = getEventType(WS);
1638da419bdbSHeejin Ahn           Event.Attribute = wasm::WASM_EVENT_ATTRIBUTE_EXCEPTION;
163930d314aaSSam Clegg           assert(WasmIndices.count(&WS) == 0);
1640da419bdbSHeejin Ahn           WasmIndices[&WS] = Index;
1641da419bdbSHeejin Ahn           Events.push_back(Event);
1642da419bdbSHeejin Ahn         } else {
1643da419bdbSHeejin Ahn           // An import; the index was assigned above.
1644492f7529SSam Clegg           assert(WasmIndices.count(&WS) > 0);
1645da419bdbSHeejin Ahn         }
164630d314aaSSam Clegg         LLVM_DEBUG(dbgs() << "  -> event index: "
164730d314aaSSam Clegg                           << WasmIndices.find(&WS)->second << "\n");
1648da419bdbSHeejin Ahn 
1649a165f2d6SSam Clegg       } else {
1650a165f2d6SSam Clegg         assert(WS.isSection());
1651d934cb88SDan Gohman       }
1652d934cb88SDan Gohman     }
1653d934cb88SDan Gohman 
1654586320c0SNicholas Wilson     // Populate WasmIndices and DataLocations for aliased symbols.  We need to
1655586320c0SNicholas Wilson     // process these in a separate pass because we need to have processed the
1656586320c0SNicholas Wilson     // target of the alias before the alias itself and the symbols are not
1657586320c0SNicholas Wilson     // necessarily ordered in this way.
1658b7787fd0SSam Clegg     for (const MCSymbol &S : Asm.symbols()) {
1659b7787fd0SSam Clegg       if (!S.isVariable())
1660b7787fd0SSam Clegg         continue;
166131a2c809SSam Clegg 
1662cd65f698SSam Clegg       assert(S.isDefined());
1663b7787fd0SSam Clegg 
16649c7b5808SDominic Chen       const auto *BS = Layout.getBaseSymbol(S);
16659c7b5808SDominic Chen       if (!BS)
16669c7b5808SDominic Chen         report_fatal_error(Twine(S.getName()) +
16679c7b5808SDominic Chen                            ": absolute addressing not supported!");
16689c7b5808SDominic Chen       const MCSymbolWasm *Base = cast<MCSymbolWasm>(BS);
16697ee758d6SSam Clegg 
16705e3d33a7SSam Clegg       // Find the target symbol of this weak alias and export that index
1671aff1c4dfSSam Clegg       const auto &WS = static_cast<const MCSymbolWasm &>(S);
167230d314aaSSam Clegg       LLVM_DEBUG(dbgs() << WS.getName() << ": weak alias of '" << *Base
167330d314aaSSam Clegg                         << "'\n");
1674b7787fd0SSam Clegg 
16757ee758d6SSam Clegg       if (Base->isFunction()) {
16767ee758d6SSam Clegg         assert(WasmIndices.count(Base) > 0);
16777ee758d6SSam Clegg         uint32_t WasmIndex = WasmIndices.find(Base)->second;
1678492f7529SSam Clegg         assert(WasmIndices.count(&WS) == 0);
16796c899ba6SSam Clegg         WasmIndices[&WS] = WasmIndex;
1680d34e60caSNicola Zaghen         LLVM_DEBUG(dbgs() << "  -> index:" << WasmIndex << "\n");
16817ee758d6SSam Clegg       } else if (Base->isData()) {
16827ee758d6SSam Clegg         auto &DataSection = static_cast<MCSectionWasm &>(WS.getSection());
16837ee758d6SSam Clegg         uint64_t Offset = Layout.getSymbolOffset(S);
16847ee758d6SSam Clegg         int64_t Size = 0;
16857ee758d6SSam Clegg         // For data symbol alias we use the size of the base symbol as the
16867ee758d6SSam Clegg         // size of the alias.  When an offset from the base is involved this
16877ee758d6SSam Clegg         // can result in a offset + size goes past the end of the data section
16887ee758d6SSam Clegg         // which out object format doesn't support.  So we must clamp it.
16897ee758d6SSam Clegg         if (!Base->getSize()->evaluateAsAbsolute(Size, Layout))
16907ee758d6SSam Clegg           report_fatal_error(".size expression must be evaluatable");
16917ee758d6SSam Clegg         const WasmDataSegment &Segment =
16927ee758d6SSam Clegg             DataSegments[DataSection.getSegmentIndex()];
16937ee758d6SSam Clegg         Size =
16947ee758d6SSam Clegg             std::min(static_cast<uint64_t>(Size), Segment.Data.size() - Offset);
16957ee758d6SSam Clegg         wasm::WasmDataReference Ref = wasm::WasmDataReference{
16967ee758d6SSam Clegg             DataSection.getSegmentIndex(),
16977ee758d6SSam Clegg             static_cast<uint32_t>(Layout.getSymbolOffset(S)),
16987ee758d6SSam Clegg             static_cast<uint32_t>(Size)};
16996c899ba6SSam Clegg         DataLocations[&WS] = Ref;
1700d34e60caSNicola Zaghen         LLVM_DEBUG(dbgs() << "  -> index:" << Ref.Segment << "\n");
17016c899ba6SSam Clegg       } else {
1702da419bdbSHeejin Ahn         report_fatal_error("don't yet support global/event aliases");
17036c899ba6SSam Clegg       }
1704586320c0SNicholas Wilson     }
170530d314aaSSam Clegg   }
170631a2c809SSam Clegg 
1707586320c0SNicholas Wilson   // Finally, populate the symbol table itself, in its "natural" order.
1708586320c0SNicholas Wilson   for (const MCSymbol &S : Asm.symbols()) {
1709586320c0SNicholas Wilson     const auto &WS = static_cast<const MCSymbolWasm &>(S);
171025d8e68bSSam Clegg     if (!isInSymtab(WS)) {
171118c56a07SHeejin Ahn       WS.setIndex(InvalidIndex);
1712586320c0SNicholas Wilson       continue;
171325d8e68bSSam Clegg     }
1714d34e60caSNicola Zaghen     LLVM_DEBUG(dbgs() << "adding to symtab: " << WS << "\n");
1715586320c0SNicholas Wilson 
1716586320c0SNicholas Wilson     uint32_t Flags = 0;
1717586320c0SNicholas Wilson     if (WS.isWeak())
1718586320c0SNicholas Wilson       Flags |= wasm::WASM_SYMBOL_BINDING_WEAK;
1719586320c0SNicholas Wilson     if (WS.isHidden())
1720586320c0SNicholas Wilson       Flags |= wasm::WASM_SYMBOL_VISIBILITY_HIDDEN;
1721586320c0SNicholas Wilson     if (!WS.isExternal() && WS.isDefined())
1722586320c0SNicholas Wilson       Flags |= wasm::WASM_SYMBOL_BINDING_LOCAL;
1723586320c0SNicholas Wilson     if (WS.isUndefined())
1724586320c0SNicholas Wilson       Flags |= wasm::WASM_SYMBOL_UNDEFINED;
1725da84b688SDan Gohman     if (WS.isNoStrip()) {
1726da84b688SDan Gohman       Flags |= wasm::WASM_SYMBOL_NO_STRIP;
1727da84b688SDan Gohman       if (isEmscripten()) {
1728d6ef8da3SSam Clegg         Flags |= wasm::WASM_SYMBOL_EXPORTED;
1729da84b688SDan Gohman       }
1730da84b688SDan Gohman     }
1731b4f4e370SSam Clegg     if (WS.hasImportName())
173229874ceaSDan Gohman       Flags |= wasm::WASM_SYMBOL_EXPLICIT_NAME;
1733881d8778SSam Clegg     if (WS.hasExportName())
1734881d8778SSam Clegg       Flags |= wasm::WASM_SYMBOL_EXPORTED;
1735586320c0SNicholas Wilson 
1736586320c0SNicholas Wilson     wasm::WasmSymbolInfo Info;
1737586320c0SNicholas Wilson     Info.Name = WS.getName();
17385e5b2cb1SWouter van Oortmerssen     Info.Kind = WS.getType().getValueOr(wasm::WASM_SYMBOL_TYPE_DATA);
1739586320c0SNicholas Wilson     Info.Flags = Flags;
17404d57fbd0SSam Clegg     if (!WS.isData()) {
17414d57fbd0SSam Clegg       assert(WasmIndices.count(&WS) > 0);
1742586320c0SNicholas Wilson       Info.ElementIndex = WasmIndices.find(&WS)->second;
17434d57fbd0SSam Clegg     } else if (WS.isDefined()) {
17444d57fbd0SSam Clegg       assert(DataLocations.count(&WS) > 0);
1745586320c0SNicholas Wilson       Info.DataRef = DataLocations.find(&WS)->second;
17464d57fbd0SSam Clegg     }
174725d8e68bSSam Clegg     WS.setIndex(SymbolInfos.size());
1748586320c0SNicholas Wilson     SymbolInfos.emplace_back(Info);
1749b7787fd0SSam Clegg   }
1750b7787fd0SSam Clegg 
17516006e091SSam Clegg   {
17526006e091SSam Clegg     auto HandleReloc = [&](const WasmRelocationEntry &Rel) {
1753f9edbe95SSam Clegg       // Functions referenced by a relocation need to put in the table.  This is
1754f9edbe95SSam Clegg       // purely to make the object file's provisional values readable, and is
1755f9edbe95SSam Clegg       // ignored by the linker, which re-calculates the relocations itself.
1756d1152a26SSam Clegg       if (Rel.Type != wasm::R_WASM_TABLE_INDEX_I32 &&
1757cc1b9b68SWouter van Oortmerssen           Rel.Type != wasm::R_WASM_TABLE_INDEX_I64 &&
175881443ac1SSam Clegg           Rel.Type != wasm::R_WASM_TABLE_INDEX_SLEB &&
1759cc1b9b68SWouter van Oortmerssen           Rel.Type != wasm::R_WASM_TABLE_INDEX_SLEB64 &&
176081443ac1SSam Clegg           Rel.Type != wasm::R_WASM_TABLE_INDEX_REL_SLEB)
1761f9edbe95SSam Clegg         return;
1762f9edbe95SSam Clegg       assert(Rel.Symbol->isFunction());
17637ee758d6SSam Clegg       const MCSymbolWasm *Base =
17647ee758d6SSam Clegg           cast<MCSymbolWasm>(Layout.getBaseSymbol(*Rel.Symbol));
17657ee758d6SSam Clegg       uint32_t FunctionIndex = WasmIndices.find(Base)->second;
176618c56a07SHeejin Ahn       uint32_t TableIndex = TableElems.size() + InitialTableOffset;
17677ee758d6SSam Clegg       if (TableIndices.try_emplace(Base, TableIndex).second) {
17687ee758d6SSam Clegg         LLVM_DEBUG(dbgs() << "  -> adding " << Base->getName()
1769f9edbe95SSam Clegg                           << " to table: " << TableIndex << "\n");
17706c899ba6SSam Clegg         TableElems.push_back(FunctionIndex);
17717ee758d6SSam Clegg         registerFunctionType(*Base);
17726006e091SSam Clegg       }
17736006e091SSam Clegg     };
1774970d02c4SDan Gohman 
17756006e091SSam Clegg     for (const WasmRelocationEntry &RelEntry : CodeRelocations)
17766006e091SSam Clegg       HandleReloc(RelEntry);
17776006e091SSam Clegg     for (const WasmRelocationEntry &RelEntry : DataRelocations)
17786006e091SSam Clegg       HandleReloc(RelEntry);
1779d934cb88SDan Gohman   }
1780d934cb88SDan Gohman 
1781bafe6902SSam Clegg   // Translate .init_array section contents into start functions.
1782bafe6902SSam Clegg   for (const MCSection &S : Asm) {
1783bafe6902SSam Clegg     const auto &WS = static_cast<const MCSectionWasm &>(S);
17847d1ff446SFangrui Song     if (WS.getName().startswith(".fini_array"))
1785bafe6902SSam Clegg       report_fatal_error(".fini_array sections are unsupported");
17867d1ff446SFangrui Song     if (!WS.getName().startswith(".init_array"))
1787bafe6902SSam Clegg       continue;
1788bafe6902SSam Clegg     if (WS.getFragmentList().empty())
1789bafe6902SSam Clegg       continue;
1790b210c64bSSam Clegg 
1791b210c64bSSam Clegg     // init_array is expected to contain a single non-empty data fragment
1792b210c64bSSam Clegg     if (WS.getFragmentList().size() != 3)
1793bafe6902SSam Clegg       report_fatal_error("only one .init_array section fragment supported");
1794b210c64bSSam Clegg 
1795b210c64bSSam Clegg     auto IT = WS.begin();
1796b210c64bSSam Clegg     const MCFragment &EmptyFrag = *IT;
1797b210c64bSSam Clegg     if (EmptyFrag.getKind() != MCFragment::FT_Data)
1798b210c64bSSam Clegg       report_fatal_error(".init_array section should be aligned");
1799b210c64bSSam Clegg 
1800b210c64bSSam Clegg     IT = std::next(IT);
1801b210c64bSSam Clegg     const MCFragment &AlignFrag = *IT;
1802bafe6902SSam Clegg     if (AlignFrag.getKind() != MCFragment::FT_Align)
1803bafe6902SSam Clegg       report_fatal_error(".init_array section should be aligned");
1804bafe6902SSam Clegg     if (cast<MCAlignFragment>(AlignFrag).getAlignment() != (is64Bit() ? 8 : 4))
1805bafe6902SSam Clegg       report_fatal_error(".init_array section should be aligned for pointers");
1806b210c64bSSam Clegg 
1807b210c64bSSam Clegg     const MCFragment &Frag = *std::next(IT);
1808bafe6902SSam Clegg     if (Frag.hasInstructions() || Frag.getKind() != MCFragment::FT_Data)
1809bafe6902SSam Clegg       report_fatal_error("only data supported in .init_array section");
1810b210c64bSSam Clegg 
1811bafe6902SSam Clegg     uint16_t Priority = UINT16_MAX;
18124d57fbd0SSam Clegg     unsigned PrefixLength = strlen(".init_array");
18137d1ff446SFangrui Song     if (WS.getName().size() > PrefixLength) {
18147d1ff446SFangrui Song       if (WS.getName()[PrefixLength] != '.')
1815f208f631SHeejin Ahn         report_fatal_error(
1816f208f631SHeejin Ahn             ".init_array section priority should start with '.'");
18177d1ff446SFangrui Song       if (WS.getName().substr(PrefixLength + 1).getAsInteger(10, Priority))
1818bafe6902SSam Clegg         report_fatal_error("invalid .init_array section priority");
1819bafe6902SSam Clegg     }
1820bafe6902SSam Clegg     const auto &DataFrag = cast<MCDataFragment>(Frag);
1821bafe6902SSam Clegg     const SmallVectorImpl<char> &Contents = DataFrag.getContents();
1822f208f631SHeejin Ahn     for (const uint8_t *
182318c56a07SHeejin Ahn              P = (const uint8_t *)Contents.data(),
182418c56a07SHeejin Ahn             *End = (const uint8_t *)Contents.data() + Contents.size();
182518c56a07SHeejin Ahn          P != End; ++P) {
182618c56a07SHeejin Ahn       if (*P != 0)
1827bafe6902SSam Clegg         report_fatal_error("non-symbolic data in .init_array section");
1828bafe6902SSam Clegg     }
1829bafe6902SSam Clegg     for (const MCFixup &Fixup : DataFrag.getFixups()) {
1830f208f631SHeejin Ahn       assert(Fixup.getKind() ==
1831f208f631SHeejin Ahn              MCFixup::getKindForSize(is64Bit() ? 8 : 4, false));
1832bafe6902SSam Clegg       const MCExpr *Expr = Fixup.getValue();
18338fffa1dfSSam Clegg       auto *SymRef = dyn_cast<MCSymbolRefExpr>(Expr);
18348fffa1dfSSam Clegg       if (!SymRef)
1835bafe6902SSam Clegg         report_fatal_error("fixups in .init_array should be symbol references");
18368fffa1dfSSam Clegg       const auto &TargetSym = cast<const MCSymbolWasm>(SymRef->getSymbol());
18378fffa1dfSSam Clegg       if (TargetSym.getIndex() == InvalidIndex)
18383ea1c62cSSam Clegg         report_fatal_error("symbols in .init_array should exist in symtab");
18398fffa1dfSSam Clegg       if (!TargetSym.isFunction())
18408fffa1dfSSam Clegg         report_fatal_error("symbols in .init_array should be for functions");
184125d8e68bSSam Clegg       InitFuncs.push_back(
18428fffa1dfSSam Clegg           std::make_pair(Priority, TargetSym.getIndex()));
1843bafe6902SSam Clegg     }
1844bafe6902SSam Clegg   }
1845bafe6902SSam Clegg 
184618eafb6cSDan Gohman   // Write out the Wasm header.
184718eafb6cSDan Gohman   writeHeader(Asm);
184818eafb6cSDan Gohman 
18490ff28fa6SDerek Schuff   uint32_t CodeSectionIndex, DataSectionIndex;
18500ff28fa6SDerek Schuff   if (Mode != DwoMode::DwoOnly) {
1851da419bdbSHeejin Ahn     writeTypeSection(Signatures);
1852f950b24aSSam Clegg     writeImportSection(Imports, DataSize, TableElems.size());
18539e15f359SSam Clegg     writeFunctionSection(Functions);
1854d823cc7cSAndy Wingo     writeTableSection(Tables);
1855f950b24aSSam Clegg     // Skip the "memory" section; we import the memory instead.
1856da419bdbSHeejin Ahn     writeEventSection(Events);
18570a6c4d8dSSam Clegg     writeGlobalSection(Globals);
18589e15f359SSam Clegg     writeExportSection(Exports);
1859a5a3659dSAndy Wingo     const MCSymbol *IndirectFunctionTable =
1860a5a3659dSAndy Wingo         Asm.getContext().lookupSymbol("__indirect_function_table");
1861a5a3659dSAndy Wingo     writeElemSection(cast_or_null<const MCSymbolWasm>(IndirectFunctionTable),
1862a5a3659dSAndy Wingo                      TableElems);
1863fef8de66SThomas Lively     writeDataCountSection();
18640ff28fa6SDerek Schuff 
18650ff28fa6SDerek Schuff     CodeSectionIndex = writeCodeSection(Asm, Layout, Functions);
18660ff28fa6SDerek Schuff     DataSectionIndex = writeDataSection(Layout);
18670ff28fa6SDerek Schuff   }
18680ff28fa6SDerek Schuff 
18690a391060SDerek Schuff   // The Sections in the COMDAT list have placeholder indices (their index among
18700a391060SDerek Schuff   // custom sections, rather than among all sections). Fix them up here.
18710a391060SDerek Schuff   for (auto &Group : Comdats) {
18720a391060SDerek Schuff     for (auto &Entry : Group.second) {
18730a391060SDerek Schuff       if (Entry.Kind == wasm::WASM_COMDAT_SECTION) {
18740a391060SDerek Schuff         Entry.Index += SectionCount;
18750ff28fa6SDerek Schuff       }
18760a391060SDerek Schuff     }
18770a391060SDerek Schuff   }
18780a391060SDerek Schuff   for (auto &CustomSection : CustomSections)
18790a391060SDerek Schuff     writeCustomSection(CustomSection, Asm, Layout);
18800ff28fa6SDerek Schuff 
18810ff28fa6SDerek Schuff   if (Mode != DwoMode::DwoOnly) {
1882c22bfb6bSNicholas Wilson     writeLinkingMetaDataSection(SymbolInfos, InitFuncs, Comdats);
18830ff28fa6SDerek Schuff 
18846f08c84aSSam Clegg     writeRelocSection(CodeSectionIndex, "CODE", CodeRelocations);
18856f08c84aSSam Clegg     writeRelocSection(DataSectionIndex, "DATA", DataRelocations);
18860ff28fa6SDerek Schuff   }
18876a31a0d6SSam Clegg   writeCustomRelocSections();
1888cbda16ebSThomas Lively   if (ProducersSection)
1889cbda16ebSThomas Lively     writeCustomSection(*ProducersSection, Asm, Layout);
1890f6f4f843SThomas Lively   if (TargetFeaturesSection)
1891f6f4f843SThomas Lively     writeCustomSection(*TargetFeaturesSection, Asm, Layout);
1892970d02c4SDan Gohman 
1893d934cb88SDan Gohman   // TODO: Translate the .comment section to the output.
18940ff28fa6SDerek Schuff   return W->OS.tell() - StartOffset;
189518eafb6cSDan Gohman }
189618eafb6cSDan Gohman 
189760fbc7ccSLang Hames std::unique_ptr<MCObjectWriter>
18981301a878SLang Hames llvm::createWasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW,
189918eafb6cSDan Gohman                              raw_pwrite_stream &OS) {
19000eaee545SJonas Devlieghere   return std::make_unique<WasmObjectWriter>(std::move(MOTW), OS);
190118eafb6cSDan Gohman }
19020ff28fa6SDerek Schuff 
19030ff28fa6SDerek Schuff std::unique_ptr<MCObjectWriter>
19040ff28fa6SDerek Schuff llvm::createWasmDwoObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW,
19050ff28fa6SDerek Schuff                                 raw_pwrite_stream &OS,
19060ff28fa6SDerek Schuff                                 raw_pwrite_stream &DwoOS) {
19070ff28fa6SDerek Schuff   return std::make_unique<WasmObjectWriter>(std::move(MOTW), OS, DwoOS);
19080ff28fa6SDerek Schuff }
1909