118eafb6cSDan Gohman //===- lib/MC/WasmObjectWriter.cpp - Wasm File Writer ---------------------===//
218eafb6cSDan Gohman //
32946cd70SChandler Carruth // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
42946cd70SChandler Carruth // See https://llvm.org/LICENSE.txt for license information.
52946cd70SChandler Carruth // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
618eafb6cSDan Gohman //
718eafb6cSDan Gohman //===----------------------------------------------------------------------===//
818eafb6cSDan Gohman //
918eafb6cSDan Gohman // This file implements Wasm object file writer information.
1018eafb6cSDan Gohman //
1118eafb6cSDan Gohman //===----------------------------------------------------------------------===//
1218eafb6cSDan Gohman 
1318eafb6cSDan Gohman #include "llvm/ADT/STLExtras.h"
1418eafb6cSDan Gohman #include "llvm/ADT/SmallPtrSet.h"
15264b5d9eSZachary Turner #include "llvm/BinaryFormat/Wasm.h"
16b59dff4bSBenjamin Kramer #include "llvm/BinaryFormat/WasmTraits.h"
17432a3883SNico Weber #include "llvm/Config/llvm-config.h"
1818eafb6cSDan Gohman #include "llvm/MC/MCAsmBackend.h"
1918eafb6cSDan Gohman #include "llvm/MC/MCAsmLayout.h"
2018eafb6cSDan Gohman #include "llvm/MC/MCAssembler.h"
2118eafb6cSDan Gohman #include "llvm/MC/MCContext.h"
2218eafb6cSDan Gohman #include "llvm/MC/MCExpr.h"
2318eafb6cSDan Gohman #include "llvm/MC/MCFixupKindInfo.h"
2418eafb6cSDan Gohman #include "llvm/MC/MCObjectWriter.h"
2518eafb6cSDan Gohman #include "llvm/MC/MCSectionWasm.h"
2618eafb6cSDan Gohman #include "llvm/MC/MCSymbolWasm.h"
2718eafb6cSDan Gohman #include "llvm/MC/MCValue.h"
2818eafb6cSDan Gohman #include "llvm/MC/MCWasmObjectWriter.h"
29d934cb88SDan Gohman #include "llvm/Support/Casting.h"
3018eafb6cSDan Gohman #include "llvm/Support/Debug.h"
31bcd7f777SSimon Pilgrim #include "llvm/Support/EndianStream.h"
3218eafb6cSDan Gohman #include "llvm/Support/ErrorHandling.h"
33d934cb88SDan Gohman #include "llvm/Support/LEB128.h"
3418eafb6cSDan Gohman #include "llvm/Support/StringSaver.h"
3518eafb6cSDan Gohman #include <vector>
3618eafb6cSDan Gohman 
3718eafb6cSDan Gohman using namespace llvm;
3818eafb6cSDan Gohman 
395e3d33a7SSam Clegg #define DEBUG_TYPE "mc"
4018eafb6cSDan Gohman 
4118eafb6cSDan Gohman namespace {
429e15f359SSam Clegg 
43feac819eSAndy Wingo // When we create the indirect function table we start at 1, so that there is
44feac819eSAndy Wingo // and empty slot at 0 and therefore calling a null function pointer will trap.
4518c56a07SHeejin Ahn static const uint32_t InitialTableOffset = 1;
4630e1bbc1SSam Clegg 
47d934cb88SDan Gohman // For patching purposes, we need to remember where each section starts, both
48d934cb88SDan Gohman // for patching up the section size field, and for patching up references to
49d934cb88SDan Gohman // locations within the section.
50d934cb88SDan Gohman struct SectionBookkeeping {
51d934cb88SDan Gohman   // Where the size of the section is written.
52d934cb88SDan Gohman   uint64_t SizeOffset;
536a31a0d6SSam Clegg   // Where the section header ends (without custom section name).
546a31a0d6SSam Clegg   uint64_t PayloadOffset;
556a31a0d6SSam Clegg   // Where the contents of the section starts.
56d934cb88SDan Gohman   uint64_t ContentsOffset;
576f08c84aSSam Clegg   uint32_t Index;
58d934cb88SDan Gohman };
59d934cb88SDan Gohman 
607c395943SSam Clegg // A wasm data segment.  A wasm binary contains only a single data section
617c395943SSam Clegg // but that can contain many segments, each with their own virtual location
627c395943SSam Clegg // in memory.  Each MCSection data created by llvm is modeled as its own
637c395943SSam Clegg // wasm data segment.
647c395943SSam Clegg struct WasmDataSegment {
657c395943SSam Clegg   MCSectionWasm *Section;
66d95ed959SSam Clegg   StringRef Name;
672e150409SThomas Lively   uint32_t InitFlags;
684d135b04SWouter van Oortmerssen   uint64_t Offset;
6963ebb813SSam Clegg   uint32_t Alignment;
702e150409SThomas Lively   uint32_t LinkerFlags;
717c395943SSam Clegg   SmallVector<char, 4> Data;
727c395943SSam Clegg };
737c395943SSam Clegg 
749e15f359SSam Clegg // A wasm function to be written into the function section.
759e15f359SSam Clegg struct WasmFunction {
76da419bdbSHeejin Ahn   uint32_t SigIndex;
779e15f359SSam Clegg   const MCSymbolWasm *Sym;
789e15f359SSam Clegg };
799e15f359SSam Clegg 
809e15f359SSam Clegg // A wasm global to be written into the global section.
819e15f359SSam Clegg struct WasmGlobal {
826e7f1826SSam Clegg   wasm::WasmGlobalType Type;
839e15f359SSam Clegg   uint64_t InitialValue;
849e15f359SSam Clegg };
859e15f359SSam Clegg 
86ea7caceeSSam Clegg // Information about a single item which is part of a COMDAT.  For each data
87ea7caceeSSam Clegg // segment or function which is in the COMDAT, there is a corresponding
88ea7caceeSSam Clegg // WasmComdatEntry.
89ea7caceeSSam Clegg struct WasmComdatEntry {
90ea7caceeSSam Clegg   unsigned Kind;
91ea7caceeSSam Clegg   uint32_t Index;
92ea7caceeSSam Clegg };
93ea7caceeSSam Clegg 
946dc65e91SSam Clegg // Information about a single relocation.
956dc65e91SSam Clegg struct WasmRelocationEntry {
966dc65e91SSam Clegg   uint64_t Offset;                   // Where is the relocation.
976dc65e91SSam Clegg   const MCSymbolWasm *Symbol;        // The symbol to relocate with.
986dc65e91SSam Clegg   int64_t Addend;                    // A value to add to the symbol.
996dc65e91SSam Clegg   unsigned Type;                     // The type of the relocation.
100fe6414b0SSam Clegg   const MCSectionWasm *FixupSection; // The section the relocation is targeting.
1016dc65e91SSam Clegg 
1026dc65e91SSam Clegg   WasmRelocationEntry(uint64_t Offset, const MCSymbolWasm *Symbol,
1036dc65e91SSam Clegg                       int64_t Addend, unsigned Type,
104fe6414b0SSam Clegg                       const MCSectionWasm *FixupSection)
1056dc65e91SSam Clegg       : Offset(Offset), Symbol(Symbol), Addend(Addend), Type(Type),
1066dc65e91SSam Clegg         FixupSection(FixupSection) {}
1076dc65e91SSam Clegg 
108cadcb9ebSKeno Fischer   bool hasAddend() const { return wasm::relocTypeHasAddend(Type); }
109acd7d2b0SSam Clegg 
1106dc65e91SSam Clegg   void print(raw_ostream &Out) const {
111f208f631SHeejin Ahn     Out << wasm::relocTypetoString(Type) << " Off=" << Offset
112f208f631SHeejin Ahn         << ", Sym=" << *Symbol << ", Addend=" << Addend
1137d1ff446SFangrui Song         << ", FixupSection=" << FixupSection->getName();
1146dc65e91SSam Clegg   }
115b7787fd0SSam Clegg 
116615eb470SAaron Ballman #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
117b7787fd0SSam Clegg   LLVM_DUMP_METHOD void dump() const { print(dbgs()); }
118b7787fd0SSam Clegg #endif
1196dc65e91SSam Clegg };
1206dc65e91SSam Clegg 
12118c56a07SHeejin Ahn static const uint32_t InvalidIndex = -1;
12225d8e68bSSam Clegg 
123cfd44a2eSSam Clegg struct WasmCustomSection {
124cfd44a2eSSam Clegg 
1256a31a0d6SSam Clegg   StringRef Name;
1266a31a0d6SSam Clegg   MCSectionWasm *Section;
1276a31a0d6SSam Clegg 
1286a31a0d6SSam Clegg   uint32_t OutputContentsOffset;
1296a31a0d6SSam Clegg   uint32_t OutputIndex;
1306a31a0d6SSam Clegg 
1316a31a0d6SSam Clegg   WasmCustomSection(StringRef Name, MCSectionWasm *Section)
1326a31a0d6SSam Clegg       : Name(Name), Section(Section), OutputContentsOffset(0),
13318c56a07SHeejin Ahn         OutputIndex(InvalidIndex) {}
134cfd44a2eSSam Clegg };
135cfd44a2eSSam Clegg 
1361fb8daa6SSam Clegg #if !defined(NDEBUG)
1377f055deeSSam Clegg raw_ostream &operator<<(raw_ostream &OS, const WasmRelocationEntry &Rel) {
138b7787fd0SSam Clegg   Rel.print(OS);
139b7787fd0SSam Clegg   return OS;
140b7787fd0SSam Clegg }
1411fb8daa6SSam Clegg #endif
142b7787fd0SSam Clegg 
14319e8befaSSam Clegg // Write X as an (unsigned) LEB value at offset Offset in Stream, padded
14419e8befaSSam Clegg // to allow patching.
1453b29376eSWouter van Oortmerssen template <int W>
1463b29376eSWouter van Oortmerssen void writePatchableLEB(raw_pwrite_stream &Stream, uint64_t X, uint64_t Offset) {
1473b29376eSWouter van Oortmerssen   uint8_t Buffer[W];
1483b29376eSWouter van Oortmerssen   unsigned SizeLen = encodeULEB128(X, Buffer, W);
1493b29376eSWouter van Oortmerssen   assert(SizeLen == W);
15019e8befaSSam Clegg   Stream.pwrite((char *)Buffer, SizeLen, Offset);
15119e8befaSSam Clegg }
15219e8befaSSam Clegg 
15319e8befaSSam Clegg // Write X as an signed LEB value at offset Offset in Stream, padded
15419e8befaSSam Clegg // to allow patching.
1553b29376eSWouter van Oortmerssen template <int W>
1563b29376eSWouter van Oortmerssen void writePatchableSLEB(raw_pwrite_stream &Stream, int64_t X, uint64_t Offset) {
1573b29376eSWouter van Oortmerssen   uint8_t Buffer[W];
1583b29376eSWouter van Oortmerssen   unsigned SizeLen = encodeSLEB128(X, Buffer, W);
1593b29376eSWouter van Oortmerssen   assert(SizeLen == W);
16019e8befaSSam Clegg   Stream.pwrite((char *)Buffer, SizeLen, Offset);
16119e8befaSSam Clegg }
16219e8befaSSam Clegg 
16319e8befaSSam Clegg // Write X as a plain integer value at offset Offset in Stream.
1640a6c4d8dSSam Clegg static void patchI32(raw_pwrite_stream &Stream, uint32_t X, uint64_t Offset) {
16519e8befaSSam Clegg   uint8_t Buffer[4];
16619e8befaSSam Clegg   support::endian::write32le(Buffer, X);
16719e8befaSSam Clegg   Stream.pwrite((char *)Buffer, sizeof(Buffer), Offset);
16819e8befaSSam Clegg }
16919e8befaSSam Clegg 
1703b29376eSWouter van Oortmerssen static void patchI64(raw_pwrite_stream &Stream, uint64_t X, uint64_t Offset) {
1713b29376eSWouter van Oortmerssen   uint8_t Buffer[8];
1723b29376eSWouter van Oortmerssen   support::endian::write64le(Buffer, X);
1733b29376eSWouter van Oortmerssen   Stream.pwrite((char *)Buffer, sizeof(Buffer), Offset);
1743b29376eSWouter van Oortmerssen }
1753b29376eSWouter van Oortmerssen 
1760ff28fa6SDerek Schuff bool isDwoSection(const MCSection &Sec) {
1770ff28fa6SDerek Schuff   return Sec.getName().endswith(".dwo");
1780ff28fa6SDerek Schuff }
1790ff28fa6SDerek Schuff 
18018eafb6cSDan Gohman class WasmObjectWriter : public MCObjectWriter {
1810ff28fa6SDerek Schuff   support::endian::Writer *W;
182f17b149dSPeter Collingbourne 
18318eafb6cSDan Gohman   /// The target specific Wasm writer instance.
18418eafb6cSDan Gohman   std::unique_ptr<MCWasmObjectTargetWriter> TargetObjectWriter;
18518eafb6cSDan Gohman 
186d934cb88SDan Gohman   // Relocations for fixing up references in the code section.
187d934cb88SDan Gohman   std::vector<WasmRelocationEntry> CodeRelocations;
188d934cb88SDan Gohman   // Relocations for fixing up references in the data section.
189d934cb88SDan Gohman   std::vector<WasmRelocationEntry> DataRelocations;
190d934cb88SDan Gohman 
191d934cb88SDan Gohman   // Index values to use for fixing up call_indirect type indices.
192acd7d2b0SSam Clegg   // Maps function symbols to the index of the type of the function
193acd7d2b0SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> TypeIndices;
194d99f6078SSam Clegg   // Maps function symbols to the table element index space. Used
195d99f6078SSam Clegg   // for TABLE_INDEX relocation types (i.e. address taken functions).
196f9edbe95SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> TableIndices;
197388fb67bSPaulo Matos   // Maps function/global/table symbols to the
198388fb67bSPaulo Matos   // function/global/table/event/section index space.
1996c899ba6SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> WasmIndices;
200492f7529SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> GOTIndices;
2016c899ba6SSam Clegg   // Maps data symbols to the Wasm segment and offset/size with the segment.
2026c899ba6SSam Clegg   DenseMap<const MCSymbolWasm *, wasm::WasmDataReference> DataLocations;
2036a31a0d6SSam Clegg 
2046a31a0d6SSam Clegg   // Stores output data (index, relocations, content offset) for custom
2056a31a0d6SSam Clegg   // section.
2066a31a0d6SSam Clegg   std::vector<WasmCustomSection> CustomSections;
207cbda16ebSThomas Lively   std::unique_ptr<WasmCustomSection> ProducersSection;
208f6f4f843SThomas Lively   std::unique_ptr<WasmCustomSection> TargetFeaturesSection;
2096a31a0d6SSam Clegg   // Relocations for fixing up references in the custom sections.
2106a31a0d6SSam Clegg   DenseMap<const MCSectionWasm *, std::vector<WasmRelocationEntry>>
2116a31a0d6SSam Clegg       CustomSectionsRelocations;
212acd7d2b0SSam Clegg 
213c0d41195SSam Clegg   // Map from section to defining function symbol.
2146ccb59b3SSam Clegg   DenseMap<const MCSection *, const MCSymbol *> SectionFunctions;
2156ccb59b3SSam Clegg 
2164c41fb5aSHeejin Ahn   DenseMap<wasm::WasmSignature, uint32_t> SignatureIndices;
2174c41fb5aSHeejin Ahn   SmallVector<wasm::WasmSignature, 4> Signatures;
2186c899ba6SSam Clegg   SmallVector<WasmDataSegment, 4> DataSegments;
2199f3fe42eSSam Clegg   unsigned NumFunctionImports = 0;
2207c395943SSam Clegg   unsigned NumGlobalImports = 0;
221feac819eSAndy Wingo   unsigned NumTableImports = 0;
222da419bdbSHeejin Ahn   unsigned NumEventImports = 0;
2237e1c3345SChandler Carruth   uint32_t SectionCount = 0;
224d934cb88SDan Gohman 
2250ff28fa6SDerek Schuff   enum class DwoMode {
2260ff28fa6SDerek Schuff     AllSections,
2270ff28fa6SDerek Schuff     NonDwoOnly,
2280ff28fa6SDerek Schuff     DwoOnly,
2290ff28fa6SDerek Schuff   };
2300ff28fa6SDerek Schuff   bool IsSplitDwarf = false;
2310ff28fa6SDerek Schuff   raw_pwrite_stream *OS = nullptr;
2320ff28fa6SDerek Schuff   raw_pwrite_stream *DwoOS = nullptr;
2330ff28fa6SDerek Schuff 
2340ff28fa6SDerek Schuff   // TargetObjectWriter wranppers.
23518eafb6cSDan Gohman   bool is64Bit() const { return TargetObjectWriter->is64Bit(); }
236da84b688SDan Gohman   bool isEmscripten() const { return TargetObjectWriter->isEmscripten(); }
23718eafb6cSDan Gohman 
2382322a937SSam Clegg   void startSection(SectionBookkeeping &Section, unsigned SectionId);
2392322a937SSam Clegg   void startCustomSection(SectionBookkeeping &Section, StringRef Name);
240d934cb88SDan Gohman   void endSection(SectionBookkeeping &Section);
241d934cb88SDan Gohman 
24218eafb6cSDan Gohman public:
2431301a878SLang Hames   WasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW,
2440ff28fa6SDerek Schuff                    raw_pwrite_stream &OS_)
2450ff28fa6SDerek Schuff       : TargetObjectWriter(std::move(MOTW)), OS(&OS_) {}
2460ff28fa6SDerek Schuff 
2470ff28fa6SDerek Schuff   WasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW,
2480ff28fa6SDerek Schuff                    raw_pwrite_stream &OS_, raw_pwrite_stream &DwoOS_)
2490ff28fa6SDerek Schuff       : TargetObjectWriter(std::move(MOTW)), IsSplitDwarf(true), OS(&OS_),
2500ff28fa6SDerek Schuff         DwoOS(&DwoOS_) {}
25118eafb6cSDan Gohman 
2520917c9e4SDan Gohman private:
253acd7d2b0SSam Clegg   void reset() override {
254acd7d2b0SSam Clegg     CodeRelocations.clear();
255acd7d2b0SSam Clegg     DataRelocations.clear();
256acd7d2b0SSam Clegg     TypeIndices.clear();
2576c899ba6SSam Clegg     WasmIndices.clear();
258492f7529SSam Clegg     GOTIndices.clear();
259f9edbe95SSam Clegg     TableIndices.clear();
2606c899ba6SSam Clegg     DataLocations.clear();
261cbda16ebSThomas Lively     CustomSections.clear();
262cbda16ebSThomas Lively     ProducersSection.reset();
263f6f4f843SThomas Lively     TargetFeaturesSection.reset();
2646a31a0d6SSam Clegg     CustomSectionsRelocations.clear();
265da419bdbSHeejin Ahn     SignatureIndices.clear();
266da419bdbSHeejin Ahn     Signatures.clear();
2676c899ba6SSam Clegg     DataSegments.clear();
2686ccb59b3SSam Clegg     SectionFunctions.clear();
2699f3fe42eSSam Clegg     NumFunctionImports = 0;
2707c395943SSam Clegg     NumGlobalImports = 0;
271feac819eSAndy Wingo     NumTableImports = 0;
272105bdc25SSam Clegg     MCObjectWriter::reset();
273acd7d2b0SSam Clegg   }
274acd7d2b0SSam Clegg 
27518eafb6cSDan Gohman   void writeHeader(const MCAssembler &Asm);
27618eafb6cSDan Gohman 
27718eafb6cSDan Gohman   void recordRelocation(MCAssembler &Asm, const MCAsmLayout &Layout,
27818eafb6cSDan Gohman                         const MCFragment *Fragment, const MCFixup &Fixup,
279ceecfe5bSRafael Espindola                         MCValue Target, uint64_t &FixedValue) override;
28018eafb6cSDan Gohman 
28118eafb6cSDan Gohman   void executePostLayoutBinding(MCAssembler &Asm,
28218eafb6cSDan Gohman                                 const MCAsmLayout &Layout) override;
2830ff28fa6SDerek Schuff   void prepareImports(SmallVectorImpl<wasm::WasmImport> &Imports,
2840ff28fa6SDerek Schuff                       MCAssembler &Asm, const MCAsmLayout &Layout);
285438390faSPeter Collingbourne   uint64_t writeObject(MCAssembler &Asm, const MCAsmLayout &Layout) override;
2869e15f359SSam Clegg 
2870ff28fa6SDerek Schuff   uint64_t writeOneObject(MCAssembler &Asm, const MCAsmLayout &Layout,
2880ff28fa6SDerek Schuff                           DwoMode Mode);
2890ff28fa6SDerek Schuff 
290b7787fd0SSam Clegg   void writeString(const StringRef Str) {
2910ff28fa6SDerek Schuff     encodeULEB128(Str.size(), W->OS);
2920ff28fa6SDerek Schuff     W->OS << Str;
293b7787fd0SSam Clegg   }
294b7787fd0SSam Clegg 
2950a6c4d8dSSam Clegg   void writeI32(int32_t val) {
2960a6c4d8dSSam Clegg     char Buffer[4];
2970a6c4d8dSSam Clegg     support::endian::write32le(Buffer, val);
2980ff28fa6SDerek Schuff     W->OS.write(Buffer, sizeof(Buffer));
2990a6c4d8dSSam Clegg   }
3000a6c4d8dSSam Clegg 
3010a6c4d8dSSam Clegg   void writeI64(int64_t val) {
3020a6c4d8dSSam Clegg     char Buffer[8];
3030a6c4d8dSSam Clegg     support::endian::write64le(Buffer, val);
3040ff28fa6SDerek Schuff     W->OS.write(Buffer, sizeof(Buffer));
3050a6c4d8dSSam Clegg   }
3060a6c4d8dSSam Clegg 
3070ff28fa6SDerek Schuff   void writeValueType(wasm::ValType Ty) { W->OS << static_cast<char>(Ty); }
3089e15f359SSam Clegg 
3094c41fb5aSHeejin Ahn   void writeTypeSection(ArrayRef<wasm::WasmSignature> Signatures);
3104d135b04SWouter van Oortmerssen   void writeImportSection(ArrayRef<wasm::WasmImport> Imports, uint64_t DataSize,
311f950b24aSSam Clegg                           uint32_t NumElements);
312457fb0b4SSam Clegg   void writeFunctionSection(ArrayRef<WasmFunction> Functions);
3138defa952SSam Clegg   void writeExportSection(ArrayRef<wasm::WasmExport> Exports);
314457fb0b4SSam Clegg   void writeElemSection(ArrayRef<uint32_t> TableElems);
315fef8de66SThomas Lively   void writeDataCountSection();
316e49584a3SSam Clegg   uint32_t writeCodeSection(const MCAssembler &Asm, const MCAsmLayout &Layout,
317457fb0b4SSam Clegg                             ArrayRef<WasmFunction> Functions);
318e49584a3SSam Clegg   uint32_t writeDataSection(const MCAsmLayout &Layout);
319da419bdbSHeejin Ahn   void writeEventSection(ArrayRef<wasm::WasmEventType> Events);
3200a6c4d8dSSam Clegg   void writeGlobalSection(ArrayRef<wasm::WasmGlobal> Globals);
321388fb67bSPaulo Matos   void writeTableSection(ArrayRef<wasm::WasmTable> Tables);
3226f08c84aSSam Clegg   void writeRelocSection(uint32_t SectionIndex, StringRef Name,
323f77dc2a8SSam Clegg                          std::vector<WasmRelocationEntry> &Relocations);
32431a2c809SSam Clegg   void writeLinkingMetaDataSection(
32586b4a09aSSam Clegg       ArrayRef<wasm::WasmSymbolInfo> SymbolInfos,
326ea7caceeSSam Clegg       ArrayRef<std::pair<uint16_t, uint32_t>> InitFuncs,
327ea7caceeSSam Clegg       const std::map<StringRef, std::vector<WasmComdatEntry>> &Comdats);
328cbda16ebSThomas Lively   void writeCustomSection(WasmCustomSection &CustomSection,
329cbda16ebSThomas Lively                           const MCAssembler &Asm, const MCAsmLayout &Layout);
3306a31a0d6SSam Clegg   void writeCustomRelocSections();
331acd7d2b0SSam Clegg 
3327ee758d6SSam Clegg   uint64_t getProvisionalValue(const WasmRelocationEntry &RelEntry,
3337ee758d6SSam Clegg                                const MCAsmLayout &Layout);
334acd7d2b0SSam Clegg   void applyRelocations(ArrayRef<WasmRelocationEntry> Relocations,
3357ee758d6SSam Clegg                         uint64_t ContentsOffset, const MCAsmLayout &Layout);
336acd7d2b0SSam Clegg 
337acd7d2b0SSam Clegg   uint32_t getRelocationIndexValue(const WasmRelocationEntry &RelEntry);
3385e3d33a7SSam Clegg   uint32_t getFunctionType(const MCSymbolWasm &Symbol);
339da419bdbSHeejin Ahn   uint32_t getEventType(const MCSymbolWasm &Symbol);
34038b12f5eSHeejin Ahn   void registerFunctionType(const MCSymbolWasm &Symbol);
34138b12f5eSHeejin Ahn   void registerEventType(const MCSymbolWasm &Symbol);
34218eafb6cSDan Gohman };
3439e15f359SSam Clegg 
34418eafb6cSDan Gohman } // end anonymous namespace
34518eafb6cSDan Gohman 
346d934cb88SDan Gohman // Write out a section header and a patchable section size field.
347d934cb88SDan Gohman void WasmObjectWriter::startSection(SectionBookkeeping &Section,
3482322a937SSam Clegg                                     unsigned SectionId) {
349d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "startSection " << SectionId << "\n");
3500ff28fa6SDerek Schuff   W->OS << char(SectionId);
351d934cb88SDan Gohman 
3520ff28fa6SDerek Schuff   Section.SizeOffset = W->OS.tell();
353d934cb88SDan Gohman 
354d934cb88SDan Gohman   // The section size. We don't know the size yet, so reserve enough space
355d934cb88SDan Gohman   // for any 32-bit value; we'll patch it later.
3560ff28fa6SDerek Schuff   encodeULEB128(0, W->OS, 5);
357d934cb88SDan Gohman 
358d934cb88SDan Gohman   // The position where the section starts, for measuring its size.
3590ff28fa6SDerek Schuff   Section.ContentsOffset = W->OS.tell();
3600ff28fa6SDerek Schuff   Section.PayloadOffset = W->OS.tell();
3616f08c84aSSam Clegg   Section.Index = SectionCount++;
362d934cb88SDan Gohman }
3632322a937SSam Clegg 
3642322a937SSam Clegg void WasmObjectWriter::startCustomSection(SectionBookkeeping &Section,
3652322a937SSam Clegg                                           StringRef Name) {
366d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "startCustomSection " << Name << "\n");
3672322a937SSam Clegg   startSection(Section, wasm::WASM_SEC_CUSTOM);
3686a31a0d6SSam Clegg 
3696a31a0d6SSam Clegg   // The position where the section header ends, for measuring its size.
3700ff28fa6SDerek Schuff   Section.PayloadOffset = W->OS.tell();
3716a31a0d6SSam Clegg 
3722322a937SSam Clegg   // Custom sections in wasm also have a string identifier.
3732322a937SSam Clegg   writeString(Name);
3746a31a0d6SSam Clegg 
3756a31a0d6SSam Clegg   // The position where the custom section starts.
3760ff28fa6SDerek Schuff   Section.ContentsOffset = W->OS.tell();
377d934cb88SDan Gohman }
378d934cb88SDan Gohman 
379d934cb88SDan Gohman // Now that the section is complete and we know how big it is, patch up the
380d934cb88SDan Gohman // section size field at the start of the section.
381d934cb88SDan Gohman void WasmObjectWriter::endSection(SectionBookkeeping &Section) {
3820ff28fa6SDerek Schuff   uint64_t Size = W->OS.tell();
383c0affde8SSam Clegg   // /dev/null doesn't support seek/tell and can report offset of 0.
384c0affde8SSam Clegg   // Simply skip this patching in that case.
385c0affde8SSam Clegg   if (!Size)
386c0affde8SSam Clegg     return;
387c0affde8SSam Clegg 
388c0affde8SSam Clegg   Size -= Section.PayloadOffset;
389d934cb88SDan Gohman   if (uint32_t(Size) != Size)
390d934cb88SDan Gohman     report_fatal_error("section size does not fit in a uint32_t");
391d934cb88SDan Gohman 
392d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "endSection size=" << Size << "\n");
393d934cb88SDan Gohman 
394d934cb88SDan Gohman   // Write the final section size to the payload_len field, which follows
395d934cb88SDan Gohman   // the section id byte.
3960ff28fa6SDerek Schuff   writePatchableLEB<5>(static_cast<raw_pwrite_stream &>(W->OS), Size,
397f17b149dSPeter Collingbourne                        Section.SizeOffset);
398d934cb88SDan Gohman }
399d934cb88SDan Gohman 
40018eafb6cSDan Gohman // Emit the Wasm header.
40118eafb6cSDan Gohman void WasmObjectWriter::writeHeader(const MCAssembler &Asm) {
4020ff28fa6SDerek Schuff   W->OS.write(wasm::WasmMagic, sizeof(wasm::WasmMagic));
4030ff28fa6SDerek Schuff   W->write<uint32_t>(wasm::WasmVersion);
40418eafb6cSDan Gohman }
40518eafb6cSDan Gohman 
40618eafb6cSDan Gohman void WasmObjectWriter::executePostLayoutBinding(MCAssembler &Asm,
40718eafb6cSDan Gohman                                                 const MCAsmLayout &Layout) {
40896ef4f30SSam Clegg   // As a stopgap measure until call_indirect instructions start explicitly
40996ef4f30SSam Clegg   // referencing the indirect function table via TABLE_NUMBER relocs, ensure
41096ef4f30SSam Clegg   // that the indirect function table import makes it to the output if anything
41196ef4f30SSam Clegg   // in the compilation unit has caused it to be present.
41296ef4f30SSam Clegg   if (auto *Sym = Asm.getContext().lookupSymbol("__indirect_function_table"))
41396ef4f30SSam Clegg     Asm.registerSymbol(*Sym);
41496ef4f30SSam Clegg 
4156ccb59b3SSam Clegg   // Build a map of sections to the function that defines them, for use
4166ccb59b3SSam Clegg   // in recordRelocation.
4176ccb59b3SSam Clegg   for (const MCSymbol &S : Asm.symbols()) {
4186ccb59b3SSam Clegg     const auto &WS = static_cast<const MCSymbolWasm &>(S);
4196ccb59b3SSam Clegg     if (WS.isDefined() && WS.isFunction() && !WS.isVariable()) {
4206ccb59b3SSam Clegg       const auto &Sec = static_cast<const MCSectionWasm &>(S.getSection());
4216ccb59b3SSam Clegg       auto Pair = SectionFunctions.insert(std::make_pair(&Sec, &S));
4226ccb59b3SSam Clegg       if (!Pair.second)
4236ccb59b3SSam Clegg         report_fatal_error("section already has a defining function: " +
4247d1ff446SFangrui Song                            Sec.getName());
4256ccb59b3SSam Clegg     }
4266ccb59b3SSam Clegg   }
42718eafb6cSDan Gohman }
42818eafb6cSDan Gohman 
42918eafb6cSDan Gohman void WasmObjectWriter::recordRelocation(MCAssembler &Asm,
43018eafb6cSDan Gohman                                         const MCAsmLayout &Layout,
43118eafb6cSDan Gohman                                         const MCFragment *Fragment,
43218eafb6cSDan Gohman                                         const MCFixup &Fixup, MCValue Target,
433ceecfe5bSRafael Espindola                                         uint64_t &FixedValue) {
434ecc5e808SSam Clegg   // The WebAssembly backend should never generate FKF_IsPCRel fixups
435e828ce1bSFangrui Song   assert(!(Asm.getBackend().getFixupKindInfo(Fixup.getKind()).Flags &
436ecc5e808SSam Clegg            MCFixupKindInfo::FKF_IsPCRel));
437ecc5e808SSam Clegg 
438fe6414b0SSam Clegg   const auto &FixupSection = cast<MCSectionWasm>(*Fragment->getParent());
439d934cb88SDan Gohman   uint64_t C = Target.getConstant();
440d934cb88SDan Gohman   uint64_t FixupOffset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
441d934cb88SDan Gohman   MCContext &Ctx = Asm.getContext();
442d934cb88SDan Gohman 
443d934cb88SDan Gohman   if (const MCSymbolRefExpr *RefB = Target.getSymB()) {
444ecc5e808SSam Clegg     // To get here the A - B expression must have failed evaluateAsRelocatable.
445ecc5e808SSam Clegg     // This means either A or B must be undefined and in WebAssembly we can't
446ecc5e808SSam Clegg     // support either of those cases.
447ecc5e808SSam Clegg     const auto &SymB = cast<MCSymbolWasm>(RefB->getSymbol());
448d934cb88SDan Gohman     Ctx.reportError(
449d934cb88SDan Gohman         Fixup.getLoc(),
450d934cb88SDan Gohman         Twine("symbol '") + SymB.getName() +
451ecc5e808SSam Clegg             "': unsupported subtraction expression used in relocation.");
452d934cb88SDan Gohman     return;
453d934cb88SDan Gohman   }
454d934cb88SDan Gohman 
455d934cb88SDan Gohman   // We either rejected the fixup or folded B into C at this point.
456d934cb88SDan Gohman   const MCSymbolRefExpr *RefA = Target.getSymA();
457ecc5e808SSam Clegg   const auto *SymA = cast<MCSymbolWasm>(&RefA->getSymbol());
458d934cb88SDan Gohman 
4593ea1c62cSSam Clegg   // The .init_array isn't translated as data, so don't do relocations in it.
4607d1ff446SFangrui Song   if (FixupSection.getName().startswith(".init_array")) {
4613ea1c62cSSam Clegg     SymA->setUsedInInitArray();
4623ea1c62cSSam Clegg     return;
4633ea1c62cSSam Clegg   }
4643ea1c62cSSam Clegg 
465ecc5e808SSam Clegg   if (SymA->isVariable()) {
466d934cb88SDan Gohman     const MCExpr *Expr = SymA->getVariableValue();
4677ee758d6SSam Clegg     if (const auto *Inner = dyn_cast<MCSymbolRefExpr>(Expr))
4686ad8f190SSam Clegg       if (Inner->getKind() == MCSymbolRefExpr::VK_WEAKREF)
4696ad8f190SSam Clegg         llvm_unreachable("weakref used in reloc not yet implemented");
470d934cb88SDan Gohman   }
471d934cb88SDan Gohman 
472d934cb88SDan Gohman   // Put any constant offset in an addend. Offsets can be negative, and
473d934cb88SDan Gohman   // LLVM expects wrapping, in contrast to wasm's immediates which can't
474d934cb88SDan Gohman   // be negative and don't wrap.
475d934cb88SDan Gohman   FixedValue = 0;
476d934cb88SDan Gohman 
477a5e175c6SSam Clegg   unsigned Type = TargetObjectWriter->getRelocType(Target, Fixup);
4789d24fb7fSSam Clegg 
4794d57fbd0SSam Clegg   // Absolute offset within a section or a function.
4804d57fbd0SSam Clegg   // Currently only supported for for metadata sections.
4814d57fbd0SSam Clegg   // See: test/MC/WebAssembly/blockaddress.ll
482d1152a26SSam Clegg   if (Type == wasm::R_WASM_FUNCTION_OFFSET_I32 ||
48316f02431SWouter van Oortmerssen       Type == wasm::R_WASM_FUNCTION_OFFSET_I64 ||
484d1152a26SSam Clegg       Type == wasm::R_WASM_SECTION_OFFSET_I32) {
4854d57fbd0SSam Clegg     if (!FixupSection.getKind().isMetadata())
4864d57fbd0SSam Clegg       report_fatal_error("relocations for function or section offsets are "
4874d57fbd0SSam Clegg                          "only supported in metadata sections");
4884d57fbd0SSam Clegg 
4894d57fbd0SSam Clegg     const MCSymbol *SectionSymbol = nullptr;
4904d57fbd0SSam Clegg     const MCSection &SecA = SymA->getSection();
491*5e5b2cb1SWouter van Oortmerssen     if (SecA.getKind().isText()) {
492*5e5b2cb1SWouter van Oortmerssen       auto SecSymIt = SectionFunctions.find(&SecA);
493*5e5b2cb1SWouter van Oortmerssen       if (SecSymIt == SectionFunctions.end())
494*5e5b2cb1SWouter van Oortmerssen         report_fatal_error("section doesn\'t have defining symbol");
495*5e5b2cb1SWouter van Oortmerssen       SectionSymbol = SecSymIt->second;
496*5e5b2cb1SWouter van Oortmerssen     } else {
4974d57fbd0SSam Clegg       SectionSymbol = SecA.getBeginSymbol();
498*5e5b2cb1SWouter van Oortmerssen     }
4994d57fbd0SSam Clegg     if (!SectionSymbol)
5004d57fbd0SSam Clegg       report_fatal_error("section symbol is required for relocation");
5014d57fbd0SSam Clegg 
5024d57fbd0SSam Clegg     C += Layout.getSymbolOffset(*SymA);
5034d57fbd0SSam Clegg     SymA = cast<MCSymbolWasm>(SectionSymbol);
5044d57fbd0SSam Clegg   }
5054d57fbd0SSam Clegg 
506feac819eSAndy Wingo   if (Type == wasm::R_WASM_TABLE_INDEX_REL_SLEB ||
507feac819eSAndy Wingo       Type == wasm::R_WASM_TABLE_INDEX_SLEB ||
508feac819eSAndy Wingo       Type == wasm::R_WASM_TABLE_INDEX_SLEB64 ||
509feac819eSAndy Wingo       Type == wasm::R_WASM_TABLE_INDEX_I32 ||
510feac819eSAndy Wingo       Type == wasm::R_WASM_TABLE_INDEX_I64) {
511feac819eSAndy Wingo     // TABLE_INDEX relocs implicitly use the default indirect function table.
512feac819eSAndy Wingo     auto TableName = "__indirect_function_table";
513feac819eSAndy Wingo     MCSymbolWasm *Sym = cast_or_null<MCSymbolWasm>(Ctx.lookupSymbol(TableName));
514feac819eSAndy Wingo     if (Sym) {
515feac819eSAndy Wingo       if (!Sym->isFunctionTable())
516feac819eSAndy Wingo         Ctx.reportError(
517feac819eSAndy Wingo             Fixup.getLoc(),
518feac819eSAndy Wingo             "symbol '__indirect_function_table' is not a function table");
519feac819eSAndy Wingo     } else {
520feac819eSAndy Wingo       Sym = cast<MCSymbolWasm>(Ctx.getOrCreateSymbol(TableName));
521feac819eSAndy Wingo       Sym->setFunctionTable();
522feac819eSAndy Wingo       // The default function table is synthesized by the linker.
523feac819eSAndy Wingo       Sym->setUndefined();
524feac819eSAndy Wingo     }
525feac819eSAndy Wingo     Sym->setUsedInReloc();
526feac819eSAndy Wingo     Asm.registerSymbol(*Sym);
527feac819eSAndy Wingo   }
528feac819eSAndy Wingo 
529d1152a26SSam Clegg   // Relocation other than R_WASM_TYPE_INDEX_LEB are required to be
5304d57fbd0SSam Clegg   // against a named symbol.
531d1152a26SSam Clegg   if (Type != wasm::R_WASM_TYPE_INDEX_LEB) {
5324d57fbd0SSam Clegg     if (SymA->getName().empty())
5334d57fbd0SSam Clegg       report_fatal_error("relocations against un-named temporaries are not yet "
5344d57fbd0SSam Clegg                          "supported by wasm");
5354d57fbd0SSam Clegg 
5364d57fbd0SSam Clegg     SymA->setUsedInReloc();
5374d57fbd0SSam Clegg   }
538ae03c1e7SSam Clegg 
539492f7529SSam Clegg   if (RefA->getKind() == MCSymbolRefExpr::VK_GOT)
540492f7529SSam Clegg     SymA->setUsedInGOT();
541492f7529SSam Clegg 
542d934cb88SDan Gohman   WasmRelocationEntry Rec(FixupOffset, SymA, C, Type, &FixupSection);
543d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "WasmReloc: " << Rec << "\n");
544d934cb88SDan Gohman 
5456a31a0d6SSam Clegg   if (FixupSection.isWasmData()) {
546d934cb88SDan Gohman     DataRelocations.push_back(Rec);
5476a31a0d6SSam Clegg   } else if (FixupSection.getKind().isText()) {
54812fd3da9SSam Clegg     CodeRelocations.push_back(Rec);
5496a31a0d6SSam Clegg   } else if (FixupSection.getKind().isMetadata()) {
5506a31a0d6SSam Clegg     CustomSectionsRelocations[&FixupSection].push_back(Rec);
5516a31a0d6SSam Clegg   } else {
55212fd3da9SSam Clegg     llvm_unreachable("unexpected section type");
553d934cb88SDan Gohman   }
5546a31a0d6SSam Clegg }
555d934cb88SDan Gohman 
556d934cb88SDan Gohman // Compute a value to write into the code at the location covered
55760ec3034SSam Clegg // by RelEntry. This value isn't used by the static linker; it just serves
55860ec3034SSam Clegg // to make the object format more readable and more likely to be directly
55960ec3034SSam Clegg // useable.
5603b29376eSWouter van Oortmerssen uint64_t
5617ee758d6SSam Clegg WasmObjectWriter::getProvisionalValue(const WasmRelocationEntry &RelEntry,
5627ee758d6SSam Clegg                                       const MCAsmLayout &Layout) {
56348139ebcSWouter van Oortmerssen   if ((RelEntry.Type == wasm::R_WASM_GLOBAL_INDEX_LEB ||
56448139ebcSWouter van Oortmerssen        RelEntry.Type == wasm::R_WASM_GLOBAL_INDEX_I32) &&
56548139ebcSWouter van Oortmerssen       !RelEntry.Symbol->isGlobal()) {
566492f7529SSam Clegg     assert(GOTIndices.count(RelEntry.Symbol) > 0 && "symbol not found in GOT index space");
567492f7529SSam Clegg     return GOTIndices[RelEntry.Symbol];
568492f7529SSam Clegg   }
569492f7529SSam Clegg 
57060ec3034SSam Clegg   switch (RelEntry.Type) {
5712a7cac93SSam Clegg   case wasm::R_WASM_TABLE_INDEX_REL_SLEB:
572d1152a26SSam Clegg   case wasm::R_WASM_TABLE_INDEX_SLEB:
573cc1b9b68SWouter van Oortmerssen   case wasm::R_WASM_TABLE_INDEX_SLEB64:
574cc1b9b68SWouter van Oortmerssen   case wasm::R_WASM_TABLE_INDEX_I32:
575cc1b9b68SWouter van Oortmerssen   case wasm::R_WASM_TABLE_INDEX_I64: {
576f9edbe95SSam Clegg     // Provisional value is table address of the resolved symbol itself
5777ee758d6SSam Clegg     const MCSymbolWasm *Base =
5787ee758d6SSam Clegg         cast<MCSymbolWasm>(Layout.getBaseSymbol(*RelEntry.Symbol));
5797ee758d6SSam Clegg     assert(Base->isFunction());
58081443ac1SSam Clegg     if (RelEntry.Type == wasm::R_WASM_TABLE_INDEX_REL_SLEB)
5817ee758d6SSam Clegg       return TableIndices[Base] - InitialTableOffset;
58281443ac1SSam Clegg     else
5837ee758d6SSam Clegg       return TableIndices[Base];
584f9edbe95SSam Clegg   }
585d1152a26SSam Clegg   case wasm::R_WASM_TYPE_INDEX_LEB:
5866c899ba6SSam Clegg     // Provisional value is same as the index
58760ec3034SSam Clegg     return getRelocationIndexValue(RelEntry);
588d1152a26SSam Clegg   case wasm::R_WASM_FUNCTION_INDEX_LEB:
589d1152a26SSam Clegg   case wasm::R_WASM_GLOBAL_INDEX_LEB:
59048139ebcSWouter van Oortmerssen   case wasm::R_WASM_GLOBAL_INDEX_I32:
591d1152a26SSam Clegg   case wasm::R_WASM_EVENT_INDEX_LEB:
59269e2797eSPaulo Matos   case wasm::R_WASM_TABLE_NUMBER_LEB:
593da419bdbSHeejin Ahn     // Provisional value is function/global/event Wasm index
594492f7529SSam Clegg     assert(WasmIndices.count(RelEntry.Symbol) > 0 && "symbol not found in wasm index space");
5956c899ba6SSam Clegg     return WasmIndices[RelEntry.Symbol];
596d1152a26SSam Clegg   case wasm::R_WASM_FUNCTION_OFFSET_I32:
59716f02431SWouter van Oortmerssen   case wasm::R_WASM_FUNCTION_OFFSET_I64:
598d1152a26SSam Clegg   case wasm::R_WASM_SECTION_OFFSET_I32: {
5996a31a0d6SSam Clegg     const auto &Section =
6006a31a0d6SSam Clegg         static_cast<const MCSectionWasm &>(RelEntry.Symbol->getSection());
6016a31a0d6SSam Clegg     return Section.getSectionOffset() + RelEntry.Addend;
6026a31a0d6SSam Clegg   }
603d1152a26SSam Clegg   case wasm::R_WASM_MEMORY_ADDR_LEB:
6043b29376eSWouter van Oortmerssen   case wasm::R_WASM_MEMORY_ADDR_LEB64:
6053b29376eSWouter van Oortmerssen   case wasm::R_WASM_MEMORY_ADDR_SLEB:
6063b29376eSWouter van Oortmerssen   case wasm::R_WASM_MEMORY_ADDR_SLEB64:
6072a7cac93SSam Clegg   case wasm::R_WASM_MEMORY_ADDR_REL_SLEB:
6083b29376eSWouter van Oortmerssen   case wasm::R_WASM_MEMORY_ADDR_REL_SLEB64:
6093b29376eSWouter van Oortmerssen   case wasm::R_WASM_MEMORY_ADDR_I32:
610a28a4662SSam Clegg   case wasm::R_WASM_MEMORY_ADDR_I64:
611a28a4662SSam Clegg   case wasm::R_WASM_MEMORY_ADDR_TLS_SLEB: {
6129c7b5808SDominic Chen     // Provisional value is address of the global plus the offset
6137ee758d6SSam Clegg     const MCSymbolWasm *Base =
6147ee758d6SSam Clegg         cast<MCSymbolWasm>(Layout.getBaseSymbol(*RelEntry.Symbol));
615270ed1b3SSam Clegg     // For undefined symbols, use zero
6167ee758d6SSam Clegg     if (!Base->isDefined())
617270ed1b3SSam Clegg       return 0;
6189c7b5808SDominic Chen     const wasm::WasmDataReference &BaseRef = DataLocations[Base],
6199c7b5808SDominic Chen                                   &SymRef = DataLocations[RelEntry.Symbol];
6209c7b5808SDominic Chen     const WasmDataSegment &Segment = DataSegments[BaseRef.Segment];
621d934cb88SDan Gohman     // Ignore overflow. LLVM allows address arithmetic to silently wrap.
6229c7b5808SDominic Chen     return Segment.Offset + BaseRef.Offset + SymRef.Offset + RelEntry.Addend;
62360ec3034SSam Clegg   }
62460ec3034SSam Clegg   default:
62560ec3034SSam Clegg     llvm_unreachable("invalid relocation type");
62660ec3034SSam Clegg   }
627d934cb88SDan Gohman }
628d934cb88SDan Gohman 
629759631c7SSam Clegg static void addData(SmallVectorImpl<char> &DataBytes,
63063ebb813SSam Clegg                     MCSectionWasm &DataSection) {
6317d1ff446SFangrui Song   LLVM_DEBUG(errs() << "addData: " << DataSection.getName() << "\n");
632759631c7SSam Clegg 
63363ebb813SSam Clegg   DataBytes.resize(alignTo(DataBytes.size(), DataSection.getAlignment()));
63463ebb813SSam Clegg 
635759631c7SSam Clegg   for (const MCFragment &Frag : DataSection) {
636759631c7SSam Clegg     if (Frag.hasInstructions())
637759631c7SSam Clegg       report_fatal_error("only data supported in data sections");
638759631c7SSam Clegg 
639759631c7SSam Clegg     if (auto *Align = dyn_cast<MCAlignFragment>(&Frag)) {
640759631c7SSam Clegg       if (Align->getValueSize() != 1)
641759631c7SSam Clegg         report_fatal_error("only byte values supported for alignment");
642759631c7SSam Clegg       // If nops are requested, use zeros, as this is the data section.
643759631c7SSam Clegg       uint8_t Value = Align->hasEmitNops() ? 0 : Align->getValue();
644f208f631SHeejin Ahn       uint64_t Size =
645f208f631SHeejin Ahn           std::min<uint64_t>(alignTo(DataBytes.size(), Align->getAlignment()),
646f208f631SHeejin Ahn                              DataBytes.size() + Align->getMaxBytesToEmit());
647759631c7SSam Clegg       DataBytes.resize(Size, Value);
648759631c7SSam Clegg     } else if (auto *Fill = dyn_cast<MCFillFragment>(&Frag)) {
649588fad4dSNirav Dave       int64_t NumValues;
650588fad4dSNirav Dave       if (!Fill->getNumValues().evaluateAsAbsolute(NumValues))
651d707c370SRafael Espindola         llvm_unreachable("The fill should be an assembler constant");
652588fad4dSNirav Dave       DataBytes.insert(DataBytes.end(), Fill->getValueSize() * NumValues,
653588fad4dSNirav Dave                        Fill->getValue());
65424faf859SHeejin Ahn     } else if (auto *LEB = dyn_cast<MCLEBFragment>(&Frag)) {
65524faf859SHeejin Ahn       const SmallVectorImpl<char> &Contents = LEB->getContents();
6561d0bc055SKazu Hirata       llvm::append_range(DataBytes, Contents);
657759631c7SSam Clegg     } else {
658759631c7SSam Clegg       const auto &DataFrag = cast<MCDataFragment>(Frag);
659759631c7SSam Clegg       const SmallVectorImpl<char> &Contents = DataFrag.getContents();
6601d0bc055SKazu Hirata       llvm::append_range(DataBytes, Contents);
661759631c7SSam Clegg     }
662759631c7SSam Clegg   }
663759631c7SSam Clegg 
664d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "addData -> " << DataBytes.size() << "\n");
665759631c7SSam Clegg }
666759631c7SSam Clegg 
66760ec3034SSam Clegg uint32_t
66860ec3034SSam Clegg WasmObjectWriter::getRelocationIndexValue(const WasmRelocationEntry &RelEntry) {
669d1152a26SSam Clegg   if (RelEntry.Type == wasm::R_WASM_TYPE_INDEX_LEB) {
670b7787fd0SSam Clegg     if (!TypeIndices.count(RelEntry.Symbol))
671b7787fd0SSam Clegg       report_fatal_error("symbol not found in type index space: " +
672b7787fd0SSam Clegg                          RelEntry.Symbol->getName());
673acd7d2b0SSam Clegg     return TypeIndices[RelEntry.Symbol];
674acd7d2b0SSam Clegg   }
67560ec3034SSam Clegg 
67625d8e68bSSam Clegg   return RelEntry.Symbol->getIndex();
677acd7d2b0SSam Clegg }
678acd7d2b0SSam Clegg 
679d934cb88SDan Gohman // Apply the portions of the relocation records that we can handle ourselves
680d934cb88SDan Gohman // directly.
681acd7d2b0SSam Clegg void WasmObjectWriter::applyRelocations(
6827ee758d6SSam Clegg     ArrayRef<WasmRelocationEntry> Relocations, uint64_t ContentsOffset,
6837ee758d6SSam Clegg     const MCAsmLayout &Layout) {
6840ff28fa6SDerek Schuff   auto &Stream = static_cast<raw_pwrite_stream &>(W->OS);
685d934cb88SDan Gohman   for (const WasmRelocationEntry &RelEntry : Relocations) {
686d934cb88SDan Gohman     uint64_t Offset = ContentsOffset +
687d934cb88SDan Gohman                       RelEntry.FixupSection->getSectionOffset() +
688d934cb88SDan Gohman                       RelEntry.Offset;
689d934cb88SDan Gohman 
690d34e60caSNicola Zaghen     LLVM_DEBUG(dbgs() << "applyRelocation: " << RelEntry << "\n");
6917ee758d6SSam Clegg     auto Value = getProvisionalValue(RelEntry, Layout);
69260ec3034SSam Clegg 
693acd7d2b0SSam Clegg     switch (RelEntry.Type) {
694d1152a26SSam Clegg     case wasm::R_WASM_FUNCTION_INDEX_LEB:
695d1152a26SSam Clegg     case wasm::R_WASM_TYPE_INDEX_LEB:
696d1152a26SSam Clegg     case wasm::R_WASM_GLOBAL_INDEX_LEB:
697d1152a26SSam Clegg     case wasm::R_WASM_MEMORY_ADDR_LEB:
698d1152a26SSam Clegg     case wasm::R_WASM_EVENT_INDEX_LEB:
69969e2797eSPaulo Matos     case wasm::R_WASM_TABLE_NUMBER_LEB:
7003b29376eSWouter van Oortmerssen       writePatchableLEB<5>(Stream, Value, Offset);
7013b29376eSWouter van Oortmerssen       break;
7023b29376eSWouter van Oortmerssen     case wasm::R_WASM_MEMORY_ADDR_LEB64:
7033b29376eSWouter van Oortmerssen       writePatchableLEB<10>(Stream, Value, Offset);
704d934cb88SDan Gohman       break;
705d1152a26SSam Clegg     case wasm::R_WASM_TABLE_INDEX_I32:
706d1152a26SSam Clegg     case wasm::R_WASM_MEMORY_ADDR_I32:
707d1152a26SSam Clegg     case wasm::R_WASM_FUNCTION_OFFSET_I32:
708d1152a26SSam Clegg     case wasm::R_WASM_SECTION_OFFSET_I32:
70948139ebcSWouter van Oortmerssen     case wasm::R_WASM_GLOBAL_INDEX_I32:
7100a6c4d8dSSam Clegg       patchI32(Stream, Value, Offset);
711d934cb88SDan Gohman       break;
712cc1b9b68SWouter van Oortmerssen     case wasm::R_WASM_TABLE_INDEX_I64:
7133b29376eSWouter van Oortmerssen     case wasm::R_WASM_MEMORY_ADDR_I64:
71416f02431SWouter van Oortmerssen     case wasm::R_WASM_FUNCTION_OFFSET_I64:
7153b29376eSWouter van Oortmerssen       patchI64(Stream, Value, Offset);
7163b29376eSWouter van Oortmerssen       break;
717d1152a26SSam Clegg     case wasm::R_WASM_TABLE_INDEX_SLEB:
7182a7cac93SSam Clegg     case wasm::R_WASM_TABLE_INDEX_REL_SLEB:
719d1152a26SSam Clegg     case wasm::R_WASM_MEMORY_ADDR_SLEB:
7202a7cac93SSam Clegg     case wasm::R_WASM_MEMORY_ADDR_REL_SLEB:
721a28a4662SSam Clegg     case wasm::R_WASM_MEMORY_ADDR_TLS_SLEB:
7223b29376eSWouter van Oortmerssen       writePatchableSLEB<5>(Stream, Value, Offset);
7233b29376eSWouter van Oortmerssen       break;
724cc1b9b68SWouter van Oortmerssen     case wasm::R_WASM_TABLE_INDEX_SLEB64:
7253b29376eSWouter van Oortmerssen     case wasm::R_WASM_MEMORY_ADDR_SLEB64:
7263b29376eSWouter van Oortmerssen     case wasm::R_WASM_MEMORY_ADDR_REL_SLEB64:
7273b29376eSWouter van Oortmerssen       writePatchableSLEB<10>(Stream, Value, Offset);
72860ec3034SSam Clegg       break;
729d934cb88SDan Gohman     default:
7309d24fb7fSSam Clegg       llvm_unreachable("invalid relocation type");
731d934cb88SDan Gohman     }
732d934cb88SDan Gohman   }
73318eafb6cSDan Gohman }
73418eafb6cSDan Gohman 
7354c41fb5aSHeejin Ahn void WasmObjectWriter::writeTypeSection(
7364c41fb5aSHeejin Ahn     ArrayRef<wasm::WasmSignature> Signatures) {
737da419bdbSHeejin Ahn   if (Signatures.empty())
7389e15f359SSam Clegg     return;
7399e15f359SSam Clegg 
7409e15f359SSam Clegg   SectionBookkeeping Section;
7419e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_TYPE);
7429e15f359SSam Clegg 
7430ff28fa6SDerek Schuff   encodeULEB128(Signatures.size(), W->OS);
7449e15f359SSam Clegg 
7454c41fb5aSHeejin Ahn   for (const wasm::WasmSignature &Sig : Signatures) {
7460ff28fa6SDerek Schuff     W->OS << char(wasm::WASM_TYPE_FUNC);
7470ff28fa6SDerek Schuff     encodeULEB128(Sig.Params.size(), W->OS);
748da419bdbSHeejin Ahn     for (wasm::ValType Ty : Sig.Params)
7499e15f359SSam Clegg       writeValueType(Ty);
7500ff28fa6SDerek Schuff     encodeULEB128(Sig.Returns.size(), W->OS);
751da419bdbSHeejin Ahn     for (wasm::ValType Ty : Sig.Returns)
7529e15f359SSam Clegg       writeValueType(Ty);
7539e15f359SSam Clegg   }
7549e15f359SSam Clegg 
7559e15f359SSam Clegg   endSection(Section);
7569e15f359SSam Clegg }
7579e15f359SSam Clegg 
7588defa952SSam Clegg void WasmObjectWriter::writeImportSection(ArrayRef<wasm::WasmImport> Imports,
7594d135b04SWouter van Oortmerssen                                           uint64_t DataSize,
760f950b24aSSam Clegg                                           uint32_t NumElements) {
7619e15f359SSam Clegg   if (Imports.empty())
7629e15f359SSam Clegg     return;
7639e15f359SSam Clegg 
7644d135b04SWouter van Oortmerssen   uint64_t NumPages = (DataSize + wasm::WasmPageSize - 1) / wasm::WasmPageSize;
765f950b24aSSam Clegg 
7669e15f359SSam Clegg   SectionBookkeeping Section;
7679e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_IMPORT);
7689e15f359SSam Clegg 
7690ff28fa6SDerek Schuff   encodeULEB128(Imports.size(), W->OS);
7708defa952SSam Clegg   for (const wasm::WasmImport &Import : Imports) {
7718defa952SSam Clegg     writeString(Import.Module);
7728defa952SSam Clegg     writeString(Import.Field);
7730ff28fa6SDerek Schuff     W->OS << char(Import.Kind);
7749e15f359SSam Clegg 
7759e15f359SSam Clegg     switch (Import.Kind) {
7769e15f359SSam Clegg     case wasm::WASM_EXTERNAL_FUNCTION:
7770ff28fa6SDerek Schuff       encodeULEB128(Import.SigIndex, W->OS);
7789e15f359SSam Clegg       break;
7799e15f359SSam Clegg     case wasm::WASM_EXTERNAL_GLOBAL:
7800ff28fa6SDerek Schuff       W->OS << char(Import.Global.Type);
7810ff28fa6SDerek Schuff       W->OS << char(Import.Global.Mutable ? 1 : 0);
7829e15f359SSam Clegg       break;
783f950b24aSSam Clegg     case wasm::WASM_EXTERNAL_MEMORY:
7840ff28fa6SDerek Schuff       encodeULEB128(Import.Memory.Flags, W->OS);
7850ff28fa6SDerek Schuff       encodeULEB128(NumPages, W->OS); // initial
786f950b24aSSam Clegg       break;
787f950b24aSSam Clegg     case wasm::WASM_EXTERNAL_TABLE:
7880ff28fa6SDerek Schuff       W->OS << char(Import.Table.ElemType);
7890ff28fa6SDerek Schuff       encodeULEB128(0, W->OS);           // flags
7900ff28fa6SDerek Schuff       encodeULEB128(NumElements, W->OS); // initial
791f950b24aSSam Clegg       break;
792da419bdbSHeejin Ahn     case wasm::WASM_EXTERNAL_EVENT:
7930ff28fa6SDerek Schuff       encodeULEB128(Import.Event.Attribute, W->OS);
7940ff28fa6SDerek Schuff       encodeULEB128(Import.Event.SigIndex, W->OS);
795da419bdbSHeejin Ahn       break;
7969e15f359SSam Clegg     default:
7979e15f359SSam Clegg       llvm_unreachable("unsupported import kind");
7989e15f359SSam Clegg     }
7999e15f359SSam Clegg   }
8009e15f359SSam Clegg 
8019e15f359SSam Clegg   endSection(Section);
8029e15f359SSam Clegg }
8039e15f359SSam Clegg 
804457fb0b4SSam Clegg void WasmObjectWriter::writeFunctionSection(ArrayRef<WasmFunction> Functions) {
8059e15f359SSam Clegg   if (Functions.empty())
8069e15f359SSam Clegg     return;
8079e15f359SSam Clegg 
8089e15f359SSam Clegg   SectionBookkeeping Section;
8099e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_FUNCTION);
8109e15f359SSam Clegg 
8110ff28fa6SDerek Schuff   encodeULEB128(Functions.size(), W->OS);
8129e15f359SSam Clegg   for (const WasmFunction &Func : Functions)
8130ff28fa6SDerek Schuff     encodeULEB128(Func.SigIndex, W->OS);
8149e15f359SSam Clegg 
8159e15f359SSam Clegg   endSection(Section);
8169e15f359SSam Clegg }
8179e15f359SSam Clegg 
818da419bdbSHeejin Ahn void WasmObjectWriter::writeEventSection(ArrayRef<wasm::WasmEventType> Events) {
819da419bdbSHeejin Ahn   if (Events.empty())
820da419bdbSHeejin Ahn     return;
821da419bdbSHeejin Ahn 
822da419bdbSHeejin Ahn   SectionBookkeeping Section;
823da419bdbSHeejin Ahn   startSection(Section, wasm::WASM_SEC_EVENT);
824da419bdbSHeejin Ahn 
8250ff28fa6SDerek Schuff   encodeULEB128(Events.size(), W->OS);
826da419bdbSHeejin Ahn   for (const wasm::WasmEventType &Event : Events) {
8270ff28fa6SDerek Schuff     encodeULEB128(Event.Attribute, W->OS);
8280ff28fa6SDerek Schuff     encodeULEB128(Event.SigIndex, W->OS);
829da419bdbSHeejin Ahn   }
830da419bdbSHeejin Ahn 
831da419bdbSHeejin Ahn   endSection(Section);
832da419bdbSHeejin Ahn }
833da419bdbSHeejin Ahn 
8340a6c4d8dSSam Clegg void WasmObjectWriter::writeGlobalSection(ArrayRef<wasm::WasmGlobal> Globals) {
8350a6c4d8dSSam Clegg   if (Globals.empty())
8360a6c4d8dSSam Clegg     return;
8370a6c4d8dSSam Clegg 
8380a6c4d8dSSam Clegg   SectionBookkeeping Section;
8390a6c4d8dSSam Clegg   startSection(Section, wasm::WASM_SEC_GLOBAL);
8400a6c4d8dSSam Clegg 
8410ff28fa6SDerek Schuff   encodeULEB128(Globals.size(), W->OS);
8420a6c4d8dSSam Clegg   for (const wasm::WasmGlobal &Global : Globals) {
8430ff28fa6SDerek Schuff     encodeULEB128(Global.Type.Type, W->OS);
8440ff28fa6SDerek Schuff     W->OS << char(Global.Type.Mutable);
8450ff28fa6SDerek Schuff     W->OS << char(Global.InitExpr.Opcode);
8460a6c4d8dSSam Clegg     switch (Global.Type.Type) {
8470a6c4d8dSSam Clegg     case wasm::WASM_TYPE_I32:
8480ff28fa6SDerek Schuff       encodeSLEB128(0, W->OS);
8490a6c4d8dSSam Clegg       break;
8500a6c4d8dSSam Clegg     case wasm::WASM_TYPE_I64:
8510ff28fa6SDerek Schuff       encodeSLEB128(0, W->OS);
8520a6c4d8dSSam Clegg       break;
8530a6c4d8dSSam Clegg     case wasm::WASM_TYPE_F32:
8540a6c4d8dSSam Clegg       writeI32(0);
8550a6c4d8dSSam Clegg       break;
8560a6c4d8dSSam Clegg     case wasm::WASM_TYPE_F64:
8570a6c4d8dSSam Clegg       writeI64(0);
8580a6c4d8dSSam Clegg       break;
85979aad89dSSam Clegg     case wasm::WASM_TYPE_EXTERNREF:
86079aad89dSSam Clegg       writeValueType(wasm::ValType::EXTERNREF);
86179aad89dSSam Clegg       break;
8620a6c4d8dSSam Clegg     default:
8630a6c4d8dSSam Clegg       llvm_unreachable("unexpected type");
8640a6c4d8dSSam Clegg     }
8650ff28fa6SDerek Schuff     W->OS << char(wasm::WASM_OPCODE_END);
8660a6c4d8dSSam Clegg   }
8670a6c4d8dSSam Clegg 
8680a6c4d8dSSam Clegg   endSection(Section);
8690a6c4d8dSSam Clegg }
8700a6c4d8dSSam Clegg 
871388fb67bSPaulo Matos void WasmObjectWriter::writeTableSection(ArrayRef<wasm::WasmTable> Tables) {
872388fb67bSPaulo Matos   if (Tables.empty())
873388fb67bSPaulo Matos     return;
874388fb67bSPaulo Matos 
875388fb67bSPaulo Matos   SectionBookkeeping Section;
876388fb67bSPaulo Matos   startSection(Section, wasm::WASM_SEC_TABLE);
877388fb67bSPaulo Matos 
878388fb67bSPaulo Matos   encodeULEB128(Tables.size(), W->OS);
879388fb67bSPaulo Matos   for (const wasm::WasmTable &Table : Tables) {
8801933c9d4SAndy Wingo     encodeULEB128(Table.Type.ElemType, W->OS);
8811933c9d4SAndy Wingo     encodeULEB128(Table.Type.Limits.Flags, W->OS);
8821933c9d4SAndy Wingo     encodeULEB128(Table.Type.Limits.Initial, W->OS);
8831933c9d4SAndy Wingo     if (Table.Type.Limits.Flags & wasm::WASM_LIMITS_FLAG_HAS_MAX)
8841933c9d4SAndy Wingo       encodeULEB128(Table.Type.Limits.Maximum, W->OS);
885388fb67bSPaulo Matos   }
886388fb67bSPaulo Matos   endSection(Section);
887388fb67bSPaulo Matos }
888388fb67bSPaulo Matos 
8898defa952SSam Clegg void WasmObjectWriter::writeExportSection(ArrayRef<wasm::WasmExport> Exports) {
8909e15f359SSam Clegg   if (Exports.empty())
8919e15f359SSam Clegg     return;
8929e15f359SSam Clegg 
8939e15f359SSam Clegg   SectionBookkeeping Section;
8949e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_EXPORT);
8959e15f359SSam Clegg 
8960ff28fa6SDerek Schuff   encodeULEB128(Exports.size(), W->OS);
8978defa952SSam Clegg   for (const wasm::WasmExport &Export : Exports) {
8988defa952SSam Clegg     writeString(Export.Name);
8990ff28fa6SDerek Schuff     W->OS << char(Export.Kind);
9000ff28fa6SDerek Schuff     encodeULEB128(Export.Index, W->OS);
9019e15f359SSam Clegg   }
9029e15f359SSam Clegg 
9039e15f359SSam Clegg   endSection(Section);
9049e15f359SSam Clegg }
9059e15f359SSam Clegg 
906457fb0b4SSam Clegg void WasmObjectWriter::writeElemSection(ArrayRef<uint32_t> TableElems) {
9079e15f359SSam Clegg   if (TableElems.empty())
9089e15f359SSam Clegg     return;
9099e15f359SSam Clegg 
9109e15f359SSam Clegg   SectionBookkeeping Section;
9119e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_ELEM);
9129e15f359SSam Clegg 
9130ff28fa6SDerek Schuff   encodeULEB128(1, W->OS); // number of "segments"
9140ff28fa6SDerek Schuff   encodeULEB128(0, W->OS); // the table index
9159e15f359SSam Clegg 
9169e15f359SSam Clegg   // init expr for starting offset
9170ff28fa6SDerek Schuff   W->OS << char(wasm::WASM_OPCODE_I32_CONST);
9180ff28fa6SDerek Schuff   encodeSLEB128(InitialTableOffset, W->OS);
9190ff28fa6SDerek Schuff   W->OS << char(wasm::WASM_OPCODE_END);
9209e15f359SSam Clegg 
9210ff28fa6SDerek Schuff   encodeULEB128(TableElems.size(), W->OS);
9229e15f359SSam Clegg   for (uint32_t Elem : TableElems)
9230ff28fa6SDerek Schuff     encodeULEB128(Elem, W->OS);
9249e15f359SSam Clegg 
9259e15f359SSam Clegg   endSection(Section);
9269e15f359SSam Clegg }
9279e15f359SSam Clegg 
928fef8de66SThomas Lively void WasmObjectWriter::writeDataCountSection() {
929fef8de66SThomas Lively   if (DataSegments.empty())
930fef8de66SThomas Lively     return;
931fef8de66SThomas Lively 
932fef8de66SThomas Lively   SectionBookkeeping Section;
933fef8de66SThomas Lively   startSection(Section, wasm::WASM_SEC_DATACOUNT);
9340ff28fa6SDerek Schuff   encodeULEB128(DataSegments.size(), W->OS);
935fef8de66SThomas Lively   endSection(Section);
936fef8de66SThomas Lively }
937fef8de66SThomas Lively 
938e49584a3SSam Clegg uint32_t WasmObjectWriter::writeCodeSection(const MCAssembler &Asm,
939457fb0b4SSam Clegg                                             const MCAsmLayout &Layout,
940457fb0b4SSam Clegg                                             ArrayRef<WasmFunction> Functions) {
9419e15f359SSam Clegg   if (Functions.empty())
942e49584a3SSam Clegg     return 0;
9439e15f359SSam Clegg 
9449e15f359SSam Clegg   SectionBookkeeping Section;
9459e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CODE);
9469e15f359SSam Clegg 
9470ff28fa6SDerek Schuff   encodeULEB128(Functions.size(), W->OS);
9489e15f359SSam Clegg 
9499e15f359SSam Clegg   for (const WasmFunction &Func : Functions) {
950fe6414b0SSam Clegg     auto &FuncSection = static_cast<MCSectionWasm &>(Func.Sym->getSection());
9519e15f359SSam Clegg 
9529e15f359SSam Clegg     int64_t Size = 0;
9539e15f359SSam Clegg     if (!Func.Sym->getSize()->evaluateAsAbsolute(Size, Layout))
9549e15f359SSam Clegg       report_fatal_error(".size expression must be evaluatable");
9559e15f359SSam Clegg 
9560ff28fa6SDerek Schuff     encodeULEB128(Size, W->OS);
9570ff28fa6SDerek Schuff     FuncSection.setSectionOffset(W->OS.tell() - Section.ContentsOffset);
9580ff28fa6SDerek Schuff     Asm.writeSectionData(W->OS, &FuncSection, Layout);
9599e15f359SSam Clegg   }
9609e15f359SSam Clegg 
9619e15f359SSam Clegg   // Apply fixups.
9627ee758d6SSam Clegg   applyRelocations(CodeRelocations, Section.ContentsOffset, Layout);
9639e15f359SSam Clegg 
9649e15f359SSam Clegg   endSection(Section);
965e49584a3SSam Clegg   return Section.Index;
9669e15f359SSam Clegg }
9679e15f359SSam Clegg 
968e49584a3SSam Clegg uint32_t WasmObjectWriter::writeDataSection(const MCAsmLayout &Layout) {
9696c899ba6SSam Clegg   if (DataSegments.empty())
970e49584a3SSam Clegg     return 0;
9719e15f359SSam Clegg 
9729e15f359SSam Clegg   SectionBookkeeping Section;
9739e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_DATA);
9749e15f359SSam Clegg 
9750ff28fa6SDerek Schuff   encodeULEB128(DataSegments.size(), W->OS); // count
9767c395943SSam Clegg 
9776c899ba6SSam Clegg   for (const WasmDataSegment &Segment : DataSegments) {
9780ff28fa6SDerek Schuff     encodeULEB128(Segment.InitFlags, W->OS); // flags
979831a143eSAndy Wingo     if (Segment.InitFlags & wasm::WASM_DATA_SEGMENT_HAS_MEMINDEX)
9800ff28fa6SDerek Schuff       encodeULEB128(0, W->OS); // memory index
981831a143eSAndy Wingo     if ((Segment.InitFlags & wasm::WASM_DATA_SEGMENT_IS_PASSIVE) == 0) {
9820d9b17d0SWouter van Oortmerssen       W->OS << char(is64Bit() ? wasm::WASM_OPCODE_I64_CONST
9834d135b04SWouter van Oortmerssen                               : wasm::WASM_OPCODE_I32_CONST);
9840ff28fa6SDerek Schuff       encodeSLEB128(Segment.Offset, W->OS); // offset
9850ff28fa6SDerek Schuff       W->OS << char(wasm::WASM_OPCODE_END);
9862e150409SThomas Lively     }
9870ff28fa6SDerek Schuff     encodeULEB128(Segment.Data.size(), W->OS); // size
9880ff28fa6SDerek Schuff     Segment.Section->setSectionOffset(W->OS.tell() - Section.ContentsOffset);
9890ff28fa6SDerek Schuff     W->OS << Segment.Data; // data
9907c395943SSam Clegg   }
9919e15f359SSam Clegg 
9929e15f359SSam Clegg   // Apply fixups.
9937ee758d6SSam Clegg   applyRelocations(DataRelocations, Section.ContentsOffset, Layout);
9949e15f359SSam Clegg 
9959e15f359SSam Clegg   endSection(Section);
996e49584a3SSam Clegg   return Section.Index;
9979e15f359SSam Clegg }
9989e15f359SSam Clegg 
9996f08c84aSSam Clegg void WasmObjectWriter::writeRelocSection(
10006f08c84aSSam Clegg     uint32_t SectionIndex, StringRef Name,
1001f77dc2a8SSam Clegg     std::vector<WasmRelocationEntry> &Relocs) {
10029e15f359SSam Clegg   // See: https://github.com/WebAssembly/tool-conventions/blob/master/Linking.md
10039e15f359SSam Clegg   // for descriptions of the reloc sections.
10049e15f359SSam Clegg 
1005f77dc2a8SSam Clegg   if (Relocs.empty())
10069e15f359SSam Clegg     return;
10079e15f359SSam Clegg 
1008f77dc2a8SSam Clegg   // First, ensure the relocations are sorted in offset order.  In general they
1009f77dc2a8SSam Clegg   // should already be sorted since `recordRelocation` is called in offset
1010f77dc2a8SSam Clegg   // order, but for the code section we combine many MC sections into single
1011f77dc2a8SSam Clegg   // wasm section, and this order is determined by the order of Asm.Symbols()
1012f77dc2a8SSam Clegg   // not the sections order.
1013efd94c56SFangrui Song   llvm::stable_sort(
1014efd94c56SFangrui Song       Relocs, [](const WasmRelocationEntry &A, const WasmRelocationEntry &B) {
1015f77dc2a8SSam Clegg         return (A.Offset + A.FixupSection->getSectionOffset()) <
1016f77dc2a8SSam Clegg                (B.Offset + B.FixupSection->getSectionOffset());
1017f77dc2a8SSam Clegg       });
1018f77dc2a8SSam Clegg 
10199e15f359SSam Clegg   SectionBookkeeping Section;
10206f08c84aSSam Clegg   startCustomSection(Section, std::string("reloc.") + Name.str());
10219e15f359SSam Clegg 
10220ff28fa6SDerek Schuff   encodeULEB128(SectionIndex, W->OS);
10230ff28fa6SDerek Schuff   encodeULEB128(Relocs.size(), W->OS);
1024f77dc2a8SSam Clegg   for (const WasmRelocationEntry &RelEntry : Relocs) {
1025f208f631SHeejin Ahn     uint64_t Offset =
1026f208f631SHeejin Ahn         RelEntry.Offset + RelEntry.FixupSection->getSectionOffset();
10276f08c84aSSam Clegg     uint32_t Index = getRelocationIndexValue(RelEntry);
10289e15f359SSam Clegg 
10290ff28fa6SDerek Schuff     W->OS << char(RelEntry.Type);
10300ff28fa6SDerek Schuff     encodeULEB128(Offset, W->OS);
10310ff28fa6SDerek Schuff     encodeULEB128(Index, W->OS);
10326f08c84aSSam Clegg     if (RelEntry.hasAddend())
10330ff28fa6SDerek Schuff       encodeSLEB128(RelEntry.Addend, W->OS);
10349e15f359SSam Clegg   }
10359e15f359SSam Clegg 
10369e15f359SSam Clegg   endSection(Section);
10379e15f359SSam Clegg }
10389e15f359SSam Clegg 
10396a31a0d6SSam Clegg void WasmObjectWriter::writeCustomRelocSections() {
10406a31a0d6SSam Clegg   for (const auto &Sec : CustomSections) {
10416a31a0d6SSam Clegg     auto &Relocations = CustomSectionsRelocations[Sec.Section];
10426a31a0d6SSam Clegg     writeRelocSection(Sec.OutputIndex, Sec.Name, Relocations);
10436a31a0d6SSam Clegg   }
10446a31a0d6SSam Clegg }
10456a31a0d6SSam Clegg 
10469e15f359SSam Clegg void WasmObjectWriter::writeLinkingMetaDataSection(
104786b4a09aSSam Clegg     ArrayRef<wasm::WasmSymbolInfo> SymbolInfos,
1048ea7caceeSSam Clegg     ArrayRef<std::pair<uint16_t, uint32_t>> InitFuncs,
1049ea7caceeSSam Clegg     const std::map<StringRef, std::vector<WasmComdatEntry>> &Comdats) {
10509e15f359SSam Clegg   SectionBookkeeping Section;
10512322a937SSam Clegg   startCustomSection(Section, "linking");
10520ff28fa6SDerek Schuff   encodeULEB128(wasm::WasmMetadataVersion, W->OS);
10539e15f359SSam Clegg 
10546bb5a41fSSam Clegg   SectionBookkeeping SubSection;
10556c899ba6SSam Clegg   if (SymbolInfos.size() != 0) {
10566c899ba6SSam Clegg     startSection(SubSection, wasm::WASM_SYMBOL_TABLE);
10570ff28fa6SDerek Schuff     encodeULEB128(SymbolInfos.size(), W->OS);
10586c899ba6SSam Clegg     for (const wasm::WasmSymbolInfo &Sym : SymbolInfos) {
10590ff28fa6SDerek Schuff       encodeULEB128(Sym.Kind, W->OS);
10600ff28fa6SDerek Schuff       encodeULEB128(Sym.Flags, W->OS);
10616c899ba6SSam Clegg       switch (Sym.Kind) {
10626c899ba6SSam Clegg       case wasm::WASM_SYMBOL_TYPE_FUNCTION:
10636c899ba6SSam Clegg       case wasm::WASM_SYMBOL_TYPE_GLOBAL:
1064da419bdbSHeejin Ahn       case wasm::WASM_SYMBOL_TYPE_EVENT:
1065388fb67bSPaulo Matos       case wasm::WASM_SYMBOL_TYPE_TABLE:
10660ff28fa6SDerek Schuff         encodeULEB128(Sym.ElementIndex, W->OS);
106729874ceaSDan Gohman         if ((Sym.Flags & wasm::WASM_SYMBOL_UNDEFINED) == 0 ||
106829874ceaSDan Gohman             (Sym.Flags & wasm::WASM_SYMBOL_EXPLICIT_NAME) != 0)
10696c899ba6SSam Clegg           writeString(Sym.Name);
10706c899ba6SSam Clegg         break;
10716c899ba6SSam Clegg       case wasm::WASM_SYMBOL_TYPE_DATA:
10726c899ba6SSam Clegg         writeString(Sym.Name);
10736c899ba6SSam Clegg         if ((Sym.Flags & wasm::WASM_SYMBOL_UNDEFINED) == 0) {
10740ff28fa6SDerek Schuff           encodeULEB128(Sym.DataRef.Segment, W->OS);
10750ff28fa6SDerek Schuff           encodeULEB128(Sym.DataRef.Offset, W->OS);
10760ff28fa6SDerek Schuff           encodeULEB128(Sym.DataRef.Size, W->OS);
10776c899ba6SSam Clegg         }
10786c899ba6SSam Clegg         break;
10796a31a0d6SSam Clegg       case wasm::WASM_SYMBOL_TYPE_SECTION: {
10806a31a0d6SSam Clegg         const uint32_t SectionIndex =
10816a31a0d6SSam Clegg             CustomSections[Sym.ElementIndex].OutputIndex;
10820ff28fa6SDerek Schuff         encodeULEB128(SectionIndex, W->OS);
10836a31a0d6SSam Clegg         break;
10846a31a0d6SSam Clegg       }
10856c899ba6SSam Clegg       default:
10866c899ba6SSam Clegg         llvm_unreachable("unexpected kind");
10876c899ba6SSam Clegg       }
1088b7787fd0SSam Clegg     }
1089b7787fd0SSam Clegg     endSection(SubSection);
1090b7787fd0SSam Clegg   }
10919e15f359SSam Clegg 
10926c899ba6SSam Clegg   if (DataSegments.size()) {
109363ebb813SSam Clegg     startSection(SubSection, wasm::WASM_SEGMENT_INFO);
10940ff28fa6SDerek Schuff     encodeULEB128(DataSegments.size(), W->OS);
10956c899ba6SSam Clegg     for (const WasmDataSegment &Segment : DataSegments) {
1096d95ed959SSam Clegg       writeString(Segment.Name);
10970ff28fa6SDerek Schuff       encodeULEB128(Segment.Alignment, W->OS);
10980ff28fa6SDerek Schuff       encodeULEB128(Segment.LinkerFlags, W->OS);
109963ebb813SSam Clegg     }
1100d95ed959SSam Clegg     endSection(SubSection);
1101d95ed959SSam Clegg   }
1102d95ed959SSam Clegg 
1103bafe6902SSam Clegg   if (!InitFuncs.empty()) {
1104bafe6902SSam Clegg     startSection(SubSection, wasm::WASM_INIT_FUNCS);
11050ff28fa6SDerek Schuff     encodeULEB128(InitFuncs.size(), W->OS);
1106bafe6902SSam Clegg     for (auto &StartFunc : InitFuncs) {
11070ff28fa6SDerek Schuff       encodeULEB128(StartFunc.first, W->OS);  // priority
11080ff28fa6SDerek Schuff       encodeULEB128(StartFunc.second, W->OS); // function index
1109bafe6902SSam Clegg     }
1110bafe6902SSam Clegg     endSection(SubSection);
1111bafe6902SSam Clegg   }
1112bafe6902SSam Clegg 
1113ea7caceeSSam Clegg   if (Comdats.size()) {
1114ea7caceeSSam Clegg     startSection(SubSection, wasm::WASM_COMDAT_INFO);
11150ff28fa6SDerek Schuff     encodeULEB128(Comdats.size(), W->OS);
1116ea7caceeSSam Clegg     for (const auto &C : Comdats) {
1117ea7caceeSSam Clegg       writeString(C.first);
11180ff28fa6SDerek Schuff       encodeULEB128(0, W->OS); // flags for future use
11190ff28fa6SDerek Schuff       encodeULEB128(C.second.size(), W->OS);
1120ea7caceeSSam Clegg       for (const WasmComdatEntry &Entry : C.second) {
11210ff28fa6SDerek Schuff         encodeULEB128(Entry.Kind, W->OS);
11220ff28fa6SDerek Schuff         encodeULEB128(Entry.Index, W->OS);
1123ea7caceeSSam Clegg       }
1124ea7caceeSSam Clegg     }
1125ea7caceeSSam Clegg     endSection(SubSection);
1126ea7caceeSSam Clegg   }
1127ea7caceeSSam Clegg 
11289e15f359SSam Clegg   endSection(Section);
11299e15f359SSam Clegg }
11309e15f359SSam Clegg 
1131cbda16ebSThomas Lively void WasmObjectWriter::writeCustomSection(WasmCustomSection &CustomSection,
1132cbda16ebSThomas Lively                                           const MCAssembler &Asm,
11336a31a0d6SSam Clegg                                           const MCAsmLayout &Layout) {
1134cfd44a2eSSam Clegg   SectionBookkeeping Section;
11356a31a0d6SSam Clegg   auto *Sec = CustomSection.Section;
11362322a937SSam Clegg   startCustomSection(Section, CustomSection.Name);
11376a31a0d6SSam Clegg 
11380ff28fa6SDerek Schuff   Sec->setSectionOffset(W->OS.tell() - Section.ContentsOffset);
11390ff28fa6SDerek Schuff   Asm.writeSectionData(W->OS, Sec, Layout);
11406a31a0d6SSam Clegg 
11416a31a0d6SSam Clegg   CustomSection.OutputContentsOffset = Section.ContentsOffset;
11426a31a0d6SSam Clegg   CustomSection.OutputIndex = Section.Index;
11436a31a0d6SSam Clegg 
1144cfd44a2eSSam Clegg   endSection(Section);
11456a31a0d6SSam Clegg 
11466a31a0d6SSam Clegg   // Apply fixups.
11474d57fbd0SSam Clegg   auto &Relocations = CustomSectionsRelocations[CustomSection.Section];
11487ee758d6SSam Clegg   applyRelocations(Relocations, CustomSection.OutputContentsOffset, Layout);
11496a31a0d6SSam Clegg }
11506a31a0d6SSam Clegg 
11515e3d33a7SSam Clegg uint32_t WasmObjectWriter::getFunctionType(const MCSymbolWasm &Symbol) {
11525e3d33a7SSam Clegg   assert(Symbol.isFunction());
11535e3d33a7SSam Clegg   assert(TypeIndices.count(&Symbol));
11545e3d33a7SSam Clegg   return TypeIndices[&Symbol];
11555e3d33a7SSam Clegg }
11565e3d33a7SSam Clegg 
1157da419bdbSHeejin Ahn uint32_t WasmObjectWriter::getEventType(const MCSymbolWasm &Symbol) {
1158da419bdbSHeejin Ahn   assert(Symbol.isEvent());
1159da419bdbSHeejin Ahn   assert(TypeIndices.count(&Symbol));
1160da419bdbSHeejin Ahn   return TypeIndices[&Symbol];
1161da419bdbSHeejin Ahn }
1162da419bdbSHeejin Ahn 
116338b12f5eSHeejin Ahn void WasmObjectWriter::registerFunctionType(const MCSymbolWasm &Symbol) {
11645e3d33a7SSam Clegg   assert(Symbol.isFunction());
11655e3d33a7SSam Clegg 
11664c41fb5aSHeejin Ahn   wasm::WasmSignature S;
11677ee758d6SSam Clegg 
11687ee758d6SSam Clegg   if (auto *Sig = Symbol.getSignature()) {
1169da419bdbSHeejin Ahn     S.Returns = Sig->Returns;
1170da419bdbSHeejin Ahn     S.Params = Sig->Params;
117177a7a380SDerek Schuff   }
11725e3d33a7SSam Clegg 
1173da419bdbSHeejin Ahn   auto Pair = SignatureIndices.insert(std::make_pair(S, Signatures.size()));
11745e3d33a7SSam Clegg   if (Pair.second)
1175da419bdbSHeejin Ahn     Signatures.push_back(S);
11765e3d33a7SSam Clegg   TypeIndices[&Symbol] = Pair.first->second;
11775e3d33a7SSam Clegg 
1178d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "registerFunctionType: " << Symbol
1179d34e60caSNicola Zaghen                     << " new:" << Pair.second << "\n");
1180d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "  -> type index: " << Pair.first->second << "\n");
11815e3d33a7SSam Clegg }
11825e3d33a7SSam Clegg 
118338b12f5eSHeejin Ahn void WasmObjectWriter::registerEventType(const MCSymbolWasm &Symbol) {
1184da419bdbSHeejin Ahn   assert(Symbol.isEvent());
1185da419bdbSHeejin Ahn 
1186da419bdbSHeejin Ahn   // TODO Currently we don't generate imported exceptions, but if we do, we
1187da419bdbSHeejin Ahn   // should have a way of infering types of imported exceptions.
11884c41fb5aSHeejin Ahn   wasm::WasmSignature S;
1189da419bdbSHeejin Ahn   if (auto *Sig = Symbol.getSignature()) {
1190da419bdbSHeejin Ahn     S.Returns = Sig->Returns;
1191da419bdbSHeejin Ahn     S.Params = Sig->Params;
1192da419bdbSHeejin Ahn   }
1193da419bdbSHeejin Ahn 
1194da419bdbSHeejin Ahn   auto Pair = SignatureIndices.insert(std::make_pair(S, Signatures.size()));
1195da419bdbSHeejin Ahn   if (Pair.second)
1196da419bdbSHeejin Ahn     Signatures.push_back(S);
1197da419bdbSHeejin Ahn   TypeIndices[&Symbol] = Pair.first->second;
1198da419bdbSHeejin Ahn 
1199da419bdbSHeejin Ahn   LLVM_DEBUG(dbgs() << "registerEventType: " << Symbol << " new:" << Pair.second
1200da419bdbSHeejin Ahn                     << "\n");
1201da419bdbSHeejin Ahn   LLVM_DEBUG(dbgs() << "  -> type index: " << Pair.first->second << "\n");
1202da419bdbSHeejin Ahn }
1203da419bdbSHeejin Ahn 
12044d57fbd0SSam Clegg static bool isInSymtab(const MCSymbolWasm &Sym) {
12053ea1c62cSSam Clegg   if (Sym.isUsedInReloc() || Sym.isUsedInInitArray())
12064d57fbd0SSam Clegg     return true;
12074d57fbd0SSam Clegg 
12084d57fbd0SSam Clegg   if (Sym.isComdat() && !Sym.isDefined())
12094d57fbd0SSam Clegg     return false;
12104d57fbd0SSam Clegg 
12113ea1c62cSSam Clegg   if (Sym.isTemporary())
12124d57fbd0SSam Clegg     return false;
12134d57fbd0SSam Clegg 
12144d57fbd0SSam Clegg   if (Sym.isSection())
12154d57fbd0SSam Clegg     return false;
12164d57fbd0SSam Clegg 
12174d57fbd0SSam Clegg   return true;
12184d57fbd0SSam Clegg }
121930d314aaSSam Clegg 
12200ff28fa6SDerek Schuff void WasmObjectWriter::prepareImports(
12210ff28fa6SDerek Schuff     SmallVectorImpl<wasm::WasmImport> &Imports, MCAssembler &Asm,
122218eafb6cSDan Gohman     const MCAsmLayout &Layout) {
1223f950b24aSSam Clegg   // For now, always emit the memory import, since loads and stores are not
1224f950b24aSSam Clegg   // valid without it. In the future, we could perhaps be more clever and omit
1225f950b24aSSam Clegg   // it if there are no loads or stores.
12268defa952SSam Clegg   wasm::WasmImport MemImport;
12271ed3a046SSam Clegg   MemImport.Module = "env";
12281ed3a046SSam Clegg   MemImport.Field = "__linear_memory";
1229f950b24aSSam Clegg   MemImport.Kind = wasm::WASM_EXTERNAL_MEMORY;
1230fd0964aeSWouter van Oortmerssen   MemImport.Memory.Flags = is64Bit() ? wasm::WASM_LIMITS_FLAG_IS_64
1231fd0964aeSWouter van Oortmerssen                                      : wasm::WASM_LIMITS_FLAG_NONE;
1232f950b24aSSam Clegg   Imports.push_back(MemImport);
1233f950b24aSSam Clegg 
1234da419bdbSHeejin Ahn   // Populate SignatureIndices, and Imports and WasmIndices for undefined
1235586320c0SNicholas Wilson   // symbols.  This must be done before populating WasmIndices for defined
1236586320c0SNicholas Wilson   // symbols.
123732ce5ca0SDan Gohman   for (const MCSymbol &S : Asm.symbols()) {
123832ce5ca0SDan Gohman     const auto &WS = static_cast<const MCSymbolWasm &>(S);
123932ce5ca0SDan Gohman 
124032ce5ca0SDan Gohman     // Register types for all functions, including those with private linkage
12419f3fe42eSSam Clegg     // (because wasm always needs a type signature).
12427ee758d6SSam Clegg     if (WS.isFunction()) {
12439c7b5808SDominic Chen       const auto *BS = Layout.getBaseSymbol(S);
12449c7b5808SDominic Chen       if (!BS)
12459c7b5808SDominic Chen         report_fatal_error(Twine(S.getName()) +
12469c7b5808SDominic Chen                            ": absolute addressing not supported!");
12479c7b5808SDominic Chen       registerFunctionType(*cast<MCSymbolWasm>(BS));
12487ee758d6SSam Clegg     }
124932ce5ca0SDan Gohman 
1250da419bdbSHeejin Ahn     if (WS.isEvent())
1251da419bdbSHeejin Ahn       registerEventType(WS);
1252da419bdbSHeejin Ahn 
125332ce5ca0SDan Gohman     if (WS.isTemporary())
125432ce5ca0SDan Gohman       continue;
125532ce5ca0SDan Gohman 
125632ce5ca0SDan Gohman     // If the symbol is not defined in this translation unit, import it.
12576c899ba6SSam Clegg     if (!WS.isDefined() && !WS.isComdat()) {
12586c899ba6SSam Clegg       if (WS.isFunction()) {
12598defa952SSam Clegg         wasm::WasmImport Import;
1260f726e445SDan Gohman         Import.Module = WS.getImportModule();
1261f726e445SDan Gohman         Import.Field = WS.getImportName();
126232ce5ca0SDan Gohman         Import.Kind = wasm::WASM_EXTERNAL_FUNCTION;
12638defa952SSam Clegg         Import.SigIndex = getFunctionType(WS);
12646c899ba6SSam Clegg         Imports.push_back(Import);
1265492f7529SSam Clegg         assert(WasmIndices.count(&WS) == 0);
12666c899ba6SSam Clegg         WasmIndices[&WS] = NumFunctionImports++;
12676c899ba6SSam Clegg       } else if (WS.isGlobal()) {
126815f349f7SNicholas Wilson         if (WS.isWeak())
126915f349f7SNicholas Wilson           report_fatal_error("undefined global symbol cannot be weak");
127015f349f7SNicholas Wilson 
12716c899ba6SSam Clegg         wasm::WasmImport Import;
1272f726e445SDan Gohman         Import.Field = WS.getImportName();
127332ce5ca0SDan Gohman         Import.Kind = wasm::WASM_EXTERNAL_GLOBAL;
1274492f7529SSam Clegg         Import.Module = WS.getImportModule();
12756c899ba6SSam Clegg         Import.Global = WS.getGlobalType();
12766c899ba6SSam Clegg         Imports.push_back(Import);
1277492f7529SSam Clegg         assert(WasmIndices.count(&WS) == 0);
12786c899ba6SSam Clegg         WasmIndices[&WS] = NumGlobalImports++;
1279da419bdbSHeejin Ahn       } else if (WS.isEvent()) {
1280da419bdbSHeejin Ahn         if (WS.isWeak())
1281da419bdbSHeejin Ahn           report_fatal_error("undefined event symbol cannot be weak");
1282da419bdbSHeejin Ahn 
1283da419bdbSHeejin Ahn         wasm::WasmImport Import;
1284f726e445SDan Gohman         Import.Module = WS.getImportModule();
1285f726e445SDan Gohman         Import.Field = WS.getImportName();
1286da419bdbSHeejin Ahn         Import.Kind = wasm::WASM_EXTERNAL_EVENT;
1287da419bdbSHeejin Ahn         Import.Event.Attribute = wasm::WASM_EVENT_ATTRIBUTE_EXCEPTION;
1288da419bdbSHeejin Ahn         Import.Event.SigIndex = getEventType(WS);
1289da419bdbSHeejin Ahn         Imports.push_back(Import);
1290492f7529SSam Clegg         assert(WasmIndices.count(&WS) == 0);
1291da419bdbSHeejin Ahn         WasmIndices[&WS] = NumEventImports++;
1292feac819eSAndy Wingo       } else if (WS.isTable()) {
1293feac819eSAndy Wingo         if (WS.isWeak())
1294feac819eSAndy Wingo           report_fatal_error("undefined table symbol cannot be weak");
1295feac819eSAndy Wingo 
1296feac819eSAndy Wingo         wasm::WasmImport Import;
1297feac819eSAndy Wingo         Import.Module = WS.getImportModule();
1298feac819eSAndy Wingo         Import.Field = WS.getImportName();
1299feac819eSAndy Wingo         Import.Kind = wasm::WASM_EXTERNAL_TABLE;
1300feac819eSAndy Wingo         wasm::ValType ElemType = WS.getTableType();
1301feac819eSAndy Wingo         Import.Table.ElemType = uint8_t(ElemType);
1302feac819eSAndy Wingo         // FIXME: Extend table type to include limits? For now we don't specify
1303feac819eSAndy Wingo         // a min or max which does not place any restrictions on the size of the
1304feac819eSAndy Wingo         // imported table.
1305feac819eSAndy Wingo         Import.Table.Limits = {wasm::WASM_LIMITS_FLAG_NONE, 0, 0};
1306feac819eSAndy Wingo         Imports.push_back(Import);
1307feac819eSAndy Wingo         assert(WasmIndices.count(&WS) == 0);
1308feac819eSAndy Wingo         WasmIndices[&WS] = NumTableImports++;
130932ce5ca0SDan Gohman       }
131032ce5ca0SDan Gohman     }
131132ce5ca0SDan Gohman   }
131232ce5ca0SDan Gohman 
1313492f7529SSam Clegg   // Add imports for GOT globals
1314492f7529SSam Clegg   for (const MCSymbol &S : Asm.symbols()) {
1315492f7529SSam Clegg     const auto &WS = static_cast<const MCSymbolWasm &>(S);
1316492f7529SSam Clegg     if (WS.isUsedInGOT()) {
1317492f7529SSam Clegg       wasm::WasmImport Import;
1318492f7529SSam Clegg       if (WS.isFunction())
1319492f7529SSam Clegg         Import.Module = "GOT.func";
1320492f7529SSam Clegg       else
1321492f7529SSam Clegg         Import.Module = "GOT.mem";
1322492f7529SSam Clegg       Import.Field = WS.getName();
1323492f7529SSam Clegg       Import.Kind = wasm::WASM_EXTERNAL_GLOBAL;
1324492f7529SSam Clegg       Import.Global = {wasm::WASM_TYPE_I32, true};
1325492f7529SSam Clegg       Imports.push_back(Import);
1326492f7529SSam Clegg       assert(GOTIndices.count(&WS) == 0);
1327492f7529SSam Clegg       GOTIndices[&WS] = NumGlobalImports++;
1328492f7529SSam Clegg     }
1329492f7529SSam Clegg   }
13300ff28fa6SDerek Schuff }
1331492f7529SSam Clegg 
13320ff28fa6SDerek Schuff uint64_t WasmObjectWriter::writeObject(MCAssembler &Asm,
13330ff28fa6SDerek Schuff                                        const MCAsmLayout &Layout) {
13340ff28fa6SDerek Schuff   support::endian::Writer MainWriter(*OS, support::little);
13350ff28fa6SDerek Schuff   W = &MainWriter;
13360ff28fa6SDerek Schuff   if (IsSplitDwarf) {
13370ff28fa6SDerek Schuff     uint64_t TotalSize = writeOneObject(Asm, Layout, DwoMode::NonDwoOnly);
13380ff28fa6SDerek Schuff     assert(DwoOS);
13390ff28fa6SDerek Schuff     support::endian::Writer DwoWriter(*DwoOS, support::little);
13400ff28fa6SDerek Schuff     W = &DwoWriter;
13410ff28fa6SDerek Schuff     return TotalSize + writeOneObject(Asm, Layout, DwoMode::DwoOnly);
13420ff28fa6SDerek Schuff   } else {
13430ff28fa6SDerek Schuff     return writeOneObject(Asm, Layout, DwoMode::AllSections);
13440ff28fa6SDerek Schuff   }
13450ff28fa6SDerek Schuff }
13460ff28fa6SDerek Schuff 
13470ff28fa6SDerek Schuff uint64_t WasmObjectWriter::writeOneObject(MCAssembler &Asm,
13480ff28fa6SDerek Schuff                                           const MCAsmLayout &Layout,
13490ff28fa6SDerek Schuff                                           DwoMode Mode) {
13500ff28fa6SDerek Schuff   uint64_t StartOffset = W->OS.tell();
13510ff28fa6SDerek Schuff   SectionCount = 0;
13520ff28fa6SDerek Schuff   CustomSections.clear();
13530ff28fa6SDerek Schuff 
13540ff28fa6SDerek Schuff   LLVM_DEBUG(dbgs() << "WasmObjectWriter::writeObject\n");
13550ff28fa6SDerek Schuff 
13560ff28fa6SDerek Schuff   // Collect information from the available symbols.
13570ff28fa6SDerek Schuff   SmallVector<WasmFunction, 4> Functions;
13580ff28fa6SDerek Schuff   SmallVector<uint32_t, 4> TableElems;
13590ff28fa6SDerek Schuff   SmallVector<wasm::WasmImport, 4> Imports;
13600ff28fa6SDerek Schuff   SmallVector<wasm::WasmExport, 4> Exports;
13610ff28fa6SDerek Schuff   SmallVector<wasm::WasmEventType, 1> Events;
13620ff28fa6SDerek Schuff   SmallVector<wasm::WasmGlobal, 1> Globals;
1363388fb67bSPaulo Matos   SmallVector<wasm::WasmTable, 1> Tables;
13640ff28fa6SDerek Schuff   SmallVector<wasm::WasmSymbolInfo, 4> SymbolInfos;
13650ff28fa6SDerek Schuff   SmallVector<std::pair<uint16_t, uint32_t>, 2> InitFuncs;
13660ff28fa6SDerek Schuff   std::map<StringRef, std::vector<WasmComdatEntry>> Comdats;
13670ff28fa6SDerek Schuff   uint64_t DataSize = 0;
13680ff28fa6SDerek Schuff   if (Mode != DwoMode::DwoOnly) {
13690ff28fa6SDerek Schuff     prepareImports(Imports, Asm, Layout);
13700ff28fa6SDerek Schuff   }
137130d314aaSSam Clegg 
13724d57fbd0SSam Clegg   // Populate DataSegments and CustomSections, which must be done before
13734d57fbd0SSam Clegg   // populating DataLocations.
1374759631c7SSam Clegg   for (MCSection &Sec : Asm) {
1375759631c7SSam Clegg     auto &Section = static_cast<MCSectionWasm &>(Sec);
13767d1ff446SFangrui Song     StringRef SectionName = Section.getName();
1377759631c7SSam Clegg 
13780ff28fa6SDerek Schuff     if (Mode == DwoMode::NonDwoOnly && isDwoSection(Sec))
13790ff28fa6SDerek Schuff       continue;
13800ff28fa6SDerek Schuff     if (Mode == DwoMode::DwoOnly && !isDwoSection(Sec))
13810ff28fa6SDerek Schuff       continue;
13820ff28fa6SDerek Schuff 
13838d396acaSDerek Schuff     LLVM_DEBUG(dbgs() << "Processing Section " << SectionName << "  group "
13848d396acaSDerek Schuff                       << Section.getGroup() << "\n";);
13858d396acaSDerek Schuff 
1386bafe6902SSam Clegg     // .init_array sections are handled specially elsewhere.
13874d57fbd0SSam Clegg     if (SectionName.startswith(".init_array"))
1388bafe6902SSam Clegg       continue;
1389bafe6902SSam Clegg 
13904d57fbd0SSam Clegg     // Code is handled separately
13914d57fbd0SSam Clegg     if (Section.getKind().isText())
13924d57fbd0SSam Clegg       continue;
13934d57fbd0SSam Clegg 
13944d57fbd0SSam Clegg     if (Section.isWasmData()) {
1395329e76d5SSam Clegg       uint32_t SegmentIndex = DataSegments.size();
1396759631c7SSam Clegg       DataSize = alignTo(DataSize, Section.getAlignment());
1397759631c7SSam Clegg       DataSegments.emplace_back();
1398759631c7SSam Clegg       WasmDataSegment &Segment = DataSegments.back();
13994d57fbd0SSam Clegg       Segment.Name = SectionName;
1400831a143eSAndy Wingo       Segment.InitFlags = Section.getPassive()
1401831a143eSAndy Wingo                               ? (uint32_t)wasm::WASM_DATA_SEGMENT_IS_PASSIVE
1402831a143eSAndy Wingo                               : 0;
1403759631c7SSam Clegg       Segment.Offset = DataSize;
1404759631c7SSam Clegg       Segment.Section = &Section;
140563ebb813SSam Clegg       addData(Segment.Data, Section);
140656c587adSSam Clegg       Segment.Alignment = Log2_32(Section.getAlignment());
14072e150409SThomas Lively       Segment.LinkerFlags = 0;
1408759631c7SSam Clegg       DataSize += Segment.Data.size();
14096c899ba6SSam Clegg       Section.setSegmentIndex(SegmentIndex);
1410ea7caceeSSam Clegg 
1411ea7caceeSSam Clegg       if (const MCSymbolWasm *C = Section.getGroup()) {
1412ea7caceeSSam Clegg         Comdats[C->getName()].emplace_back(
1413329e76d5SSam Clegg             WasmComdatEntry{wasm::WASM_COMDAT_DATA, SegmentIndex});
1414ea7caceeSSam Clegg       }
14154d57fbd0SSam Clegg     } else {
14164d57fbd0SSam Clegg       // Create custom sections
14174d57fbd0SSam Clegg       assert(Sec.getKind().isMetadata());
14184d57fbd0SSam Clegg 
14194d57fbd0SSam Clegg       StringRef Name = SectionName;
14204d57fbd0SSam Clegg 
14214d57fbd0SSam Clegg       // For user-defined custom sections, strip the prefix
14224d57fbd0SSam Clegg       if (Name.startswith(".custom_section."))
14234d57fbd0SSam Clegg         Name = Name.substr(strlen(".custom_section."));
14244d57fbd0SSam Clegg 
14254d57fbd0SSam Clegg       MCSymbol *Begin = Sec.getBeginSymbol();
1426fb807d4dSSam Clegg       if (Begin) {
142730d314aaSSam Clegg         assert(WasmIndices.count(cast<MCSymbolWasm>(Begin)) == 0);
14284d57fbd0SSam Clegg         WasmIndices[cast<MCSymbolWasm>(Begin)] = CustomSections.size();
1429fb807d4dSSam Clegg       }
1430cbda16ebSThomas Lively 
1431f6f4f843SThomas Lively       // Separate out the producers and target features sections
1432cbda16ebSThomas Lively       if (Name == "producers") {
14330eaee545SJonas Devlieghere         ProducersSection = std::make_unique<WasmCustomSection>(Name, &Section);
1434cbda16ebSThomas Lively         continue;
1435cbda16ebSThomas Lively       }
1436f6f4f843SThomas Lively       if (Name == "target_features") {
1437f6f4f843SThomas Lively         TargetFeaturesSection =
14380eaee545SJonas Devlieghere             std::make_unique<WasmCustomSection>(Name, &Section);
1439f6f4f843SThomas Lively         continue;
1440f6f4f843SThomas Lively       }
1441cbda16ebSThomas Lively 
14420a391060SDerek Schuff       // Custom sections can also belong to COMDAT groups. In this case the
14430a391060SDerek Schuff       // decriptor's "index" field is the section index (in the final object
14440a391060SDerek Schuff       // file), but that is not known until after layout, so it must be fixed up
14450a391060SDerek Schuff       // later
14460a391060SDerek Schuff       if (const MCSymbolWasm *C = Section.getGroup()) {
14470a391060SDerek Schuff         Comdats[C->getName()].emplace_back(
14480a391060SDerek Schuff             WasmComdatEntry{wasm::WASM_COMDAT_SECTION,
14490a391060SDerek Schuff                             static_cast<uint32_t>(CustomSections.size())});
14500a391060SDerek Schuff       }
14510a391060SDerek Schuff 
14524d57fbd0SSam Clegg       CustomSections.emplace_back(Name, &Section);
1453759631c7SSam Clegg     }
14546a31a0d6SSam Clegg   }
14556a31a0d6SSam Clegg 
145630d314aaSSam Clegg   if (Mode != DwoMode::DwoOnly) {
1457586320c0SNicholas Wilson     // Populate WasmIndices and DataLocations for defined symbols.
1458d934cb88SDan Gohman     for (const MCSymbol &S : Asm.symbols()) {
1459d934cb88SDan Gohman       // Ignore unnamed temporary symbols, which aren't ever exported, imported,
1460d934cb88SDan Gohman       // or used in relocations.
1461d934cb88SDan Gohman       if (S.isTemporary() && S.getName().empty())
1462d934cb88SDan Gohman         continue;
1463b7787fd0SSam Clegg 
1464d934cb88SDan Gohman       const auto &WS = static_cast<const MCSymbolWasm &>(S);
1465*5e5b2cb1SWouter van Oortmerssen       LLVM_DEBUG(dbgs()
1466*5e5b2cb1SWouter van Oortmerssen                  << "MCSymbol: "
1467*5e5b2cb1SWouter van Oortmerssen                  << toString(WS.getType().getValueOr(wasm::WASM_SYMBOL_TYPE_DATA))
1468*5e5b2cb1SWouter van Oortmerssen                  << " '" << S << "'"
1469d34e60caSNicola Zaghen                  << " isDefined=" << S.isDefined() << " isExternal="
1470d34e60caSNicola Zaghen                  << S.isExternal() << " isTemporary=" << S.isTemporary()
1471d34e60caSNicola Zaghen                  << " isWeak=" << WS.isWeak() << " isHidden=" << WS.isHidden()
1472b7787fd0SSam Clegg                  << " isVariable=" << WS.isVariable() << "\n");
1473b7787fd0SSam Clegg 
14745e3d33a7SSam Clegg       if (WS.isVariable())
14755e3d33a7SSam Clegg         continue;
14766c899ba6SSam Clegg       if (WS.isComdat() && !WS.isDefined())
14776c899ba6SSam Clegg         continue;
1478b7787fd0SSam Clegg 
1479d934cb88SDan Gohman       if (WS.isFunction()) {
14806c899ba6SSam Clegg         unsigned Index;
1481cd65f698SSam Clegg         if (WS.isDefined()) {
1482b7787fd0SSam Clegg           if (WS.getOffset() != 0)
1483b7787fd0SSam Clegg             report_fatal_error(
1484b7787fd0SSam Clegg                 "function sections must contain one function each");
1485b7787fd0SSam Clegg 
148618c56a07SHeejin Ahn           if (WS.getSize() == nullptr)
1487b7787fd0SSam Clegg             report_fatal_error(
1488b7787fd0SSam Clegg                 "function symbols must have a size set with .size");
1489b7787fd0SSam Clegg 
14906c899ba6SSam Clegg           // A definition. Write out the function body.
14919f3fe42eSSam Clegg           Index = NumFunctionImports + Functions.size();
1492d934cb88SDan Gohman           WasmFunction Func;
1493da419bdbSHeejin Ahn           Func.SigIndex = getFunctionType(WS);
1494d934cb88SDan Gohman           Func.Sym = &WS;
149530d314aaSSam Clegg           assert(WasmIndices.count(&WS) == 0);
14966c899ba6SSam Clegg           WasmIndices[&WS] = Index;
1497d934cb88SDan Gohman           Functions.push_back(Func);
14986c899ba6SSam Clegg 
14996c899ba6SSam Clegg           auto &Section = static_cast<MCSectionWasm &>(WS.getSection());
15006c899ba6SSam Clegg           if (const MCSymbolWasm *C = Section.getGroup()) {
15016c899ba6SSam Clegg             Comdats[C->getName()].emplace_back(
15026c899ba6SSam Clegg                 WasmComdatEntry{wasm::WASM_COMDAT_FUNCTION, Index});
15036c899ba6SSam Clegg           }
1504881d8778SSam Clegg 
1505881d8778SSam Clegg           if (WS.hasExportName()) {
1506881d8778SSam Clegg             wasm::WasmExport Export;
1507881d8778SSam Clegg             Export.Name = WS.getExportName();
1508881d8778SSam Clegg             Export.Kind = wasm::WASM_EXTERNAL_FUNCTION;
1509881d8778SSam Clegg             Export.Index = Index;
1510881d8778SSam Clegg             Exports.push_back(Export);
1511881d8778SSam Clegg           }
1512d934cb88SDan Gohman         } else {
1513d934cb88SDan Gohman           // An import; the index was assigned above.
15146c899ba6SSam Clegg           Index = WasmIndices.find(&WS)->second;
1515d934cb88SDan Gohman         }
1516d934cb88SDan Gohman 
1517d34e60caSNicola Zaghen         LLVM_DEBUG(dbgs() << "  -> function index: " << Index << "\n");
1518da419bdbSHeejin Ahn 
15196c899ba6SSam Clegg       } else if (WS.isData()) {
1520f3feb6adSWouter van Oortmerssen         if (!isInSymtab(WS))
1521c38e947eSSam Clegg           continue;
1522c38e947eSSam Clegg 
15236c899ba6SSam Clegg         if (!WS.isDefined()) {
1524d34e60caSNicola Zaghen           LLVM_DEBUG(dbgs() << "  -> segment index: -1"
1525d34e60caSNicola Zaghen                             << "\n");
1526fe6414b0SSam Clegg           continue;
15276c899ba6SSam Clegg         }
1528fe6414b0SSam Clegg 
1529d934cb88SDan Gohman         if (!WS.getSize())
1530c38e947eSSam Clegg           report_fatal_error("data symbols must have a size set with .size: " +
1531c38e947eSSam Clegg                              WS.getName());
1532d934cb88SDan Gohman 
1533d934cb88SDan Gohman         int64_t Size = 0;
1534d934cb88SDan Gohman         if (!WS.getSize()->evaluateAsAbsolute(Size, Layout))
1535d934cb88SDan Gohman           report_fatal_error(".size expression must be evaluatable");
1536d934cb88SDan Gohman 
1537759631c7SSam Clegg         auto &DataSection = static_cast<MCSectionWasm &>(WS.getSection());
1538079cba04SSam Clegg         if (!DataSection.isWasmData())
1539079cba04SSam Clegg           report_fatal_error("data symbols must live in a data section: " +
1540079cba04SSam Clegg                              WS.getName());
15417c395943SSam Clegg 
15426c899ba6SSam Clegg         // For each data symbol, export it in the symtab as a reference to the
15436c899ba6SSam Clegg         // corresponding Wasm data segment.
15446c899ba6SSam Clegg         wasm::WasmDataReference Ref = wasm::WasmDataReference{
15453b29376eSWouter van Oortmerssen             DataSection.getSegmentIndex(), Layout.getSymbolOffset(WS),
15463b29376eSWouter van Oortmerssen             static_cast<uint64_t>(Size)};
154730d314aaSSam Clegg         assert(DataLocations.count(&WS) == 0);
15486c899ba6SSam Clegg         DataLocations[&WS] = Ref;
1549d34e60caSNicola Zaghen         LLVM_DEBUG(dbgs() << "  -> segment index: " << Ref.Segment << "\n");
1550da419bdbSHeejin Ahn 
1551a165f2d6SSam Clegg       } else if (WS.isGlobal()) {
15526c899ba6SSam Clegg         // A "true" Wasm global (currently just __stack_pointer)
15530a6c4d8dSSam Clegg         if (WS.isDefined()) {
15540a6c4d8dSSam Clegg           wasm::WasmGlobal Global;
15550a6c4d8dSSam Clegg           Global.Type = WS.getGlobalType();
15560a6c4d8dSSam Clegg           Global.Index = NumGlobalImports + Globals.size();
15570a6c4d8dSSam Clegg           switch (Global.Type.Type) {
15580a6c4d8dSSam Clegg           case wasm::WASM_TYPE_I32:
15590a6c4d8dSSam Clegg             Global.InitExpr.Opcode = wasm::WASM_OPCODE_I32_CONST;
15600a6c4d8dSSam Clegg             break;
15610a6c4d8dSSam Clegg           case wasm::WASM_TYPE_I64:
15620a6c4d8dSSam Clegg             Global.InitExpr.Opcode = wasm::WASM_OPCODE_I64_CONST;
15630a6c4d8dSSam Clegg             break;
15640a6c4d8dSSam Clegg           case wasm::WASM_TYPE_F32:
15650a6c4d8dSSam Clegg             Global.InitExpr.Opcode = wasm::WASM_OPCODE_F32_CONST;
15660a6c4d8dSSam Clegg             break;
15670a6c4d8dSSam Clegg           case wasm::WASM_TYPE_F64:
15680a6c4d8dSSam Clegg             Global.InitExpr.Opcode = wasm::WASM_OPCODE_F64_CONST;
15690a6c4d8dSSam Clegg             break;
157079aad89dSSam Clegg           case wasm::WASM_TYPE_EXTERNREF:
157179aad89dSSam Clegg             Global.InitExpr.Opcode = wasm::WASM_OPCODE_REF_NULL;
157279aad89dSSam Clegg             break;
15730a6c4d8dSSam Clegg           default:
15740a6c4d8dSSam Clegg             llvm_unreachable("unexpected type");
15750a6c4d8dSSam Clegg           }
157630d314aaSSam Clegg           assert(WasmIndices.count(&WS) == 0);
15770a6c4d8dSSam Clegg           WasmIndices[&WS] = Global.Index;
15780a6c4d8dSSam Clegg           Globals.push_back(Global);
15790a6c4d8dSSam Clegg         } else {
1580545932beSEric Christopher           // An import; the index was assigned above
1581d34e60caSNicola Zaghen           LLVM_DEBUG(dbgs() << "  -> global index: "
1582d34e60caSNicola Zaghen                             << WasmIndices.find(&WS)->second << "\n");
15830a6c4d8dSSam Clegg         }
1584388fb67bSPaulo Matos       } else if (WS.isTable()) {
1585388fb67bSPaulo Matos         if (WS.isDefined()) {
1586388fb67bSPaulo Matos           wasm::WasmTable Table;
1587388fb67bSPaulo Matos           Table.Index = NumTableImports + Tables.size();
15881933c9d4SAndy Wingo           Table.Type.ElemType = static_cast<uint8_t>(WS.getTableType());
1589388fb67bSPaulo Matos           // FIXME: Work on custom limits is ongoing
15901933c9d4SAndy Wingo           Table.Type.Limits = {wasm::WASM_LIMITS_FLAG_NONE, 0, 0};
159130d314aaSSam Clegg           assert(WasmIndices.count(&WS) == 0);
1592388fb67bSPaulo Matos           WasmIndices[&WS] = Table.Index;
1593388fb67bSPaulo Matos           Tables.push_back(Table);
1594388fb67bSPaulo Matos         }
159530d314aaSSam Clegg         LLVM_DEBUG(dbgs() << " -> table index: "
159630d314aaSSam Clegg                           << WasmIndices.find(&WS)->second << "\n");
1597da419bdbSHeejin Ahn       } else if (WS.isEvent()) {
1598da419bdbSHeejin Ahn         // C++ exception symbol (__cpp_exception)
1599da419bdbSHeejin Ahn         unsigned Index;
1600da419bdbSHeejin Ahn         if (WS.isDefined()) {
1601da419bdbSHeejin Ahn           Index = NumEventImports + Events.size();
1602da419bdbSHeejin Ahn           wasm::WasmEventType Event;
1603da419bdbSHeejin Ahn           Event.SigIndex = getEventType(WS);
1604da419bdbSHeejin Ahn           Event.Attribute = wasm::WASM_EVENT_ATTRIBUTE_EXCEPTION;
160530d314aaSSam Clegg           assert(WasmIndices.count(&WS) == 0);
1606da419bdbSHeejin Ahn           WasmIndices[&WS] = Index;
1607da419bdbSHeejin Ahn           Events.push_back(Event);
1608da419bdbSHeejin Ahn         } else {
1609da419bdbSHeejin Ahn           // An import; the index was assigned above.
1610492f7529SSam Clegg           assert(WasmIndices.count(&WS) > 0);
1611da419bdbSHeejin Ahn         }
161230d314aaSSam Clegg         LLVM_DEBUG(dbgs() << "  -> event index: "
161330d314aaSSam Clegg                           << WasmIndices.find(&WS)->second << "\n");
1614da419bdbSHeejin Ahn 
1615a165f2d6SSam Clegg       } else {
1616a165f2d6SSam Clegg         assert(WS.isSection());
1617d934cb88SDan Gohman       }
1618d934cb88SDan Gohman     }
1619d934cb88SDan Gohman 
1620586320c0SNicholas Wilson     // Populate WasmIndices and DataLocations for aliased symbols.  We need to
1621586320c0SNicholas Wilson     // process these in a separate pass because we need to have processed the
1622586320c0SNicholas Wilson     // target of the alias before the alias itself and the symbols are not
1623586320c0SNicholas Wilson     // necessarily ordered in this way.
1624b7787fd0SSam Clegg     for (const MCSymbol &S : Asm.symbols()) {
1625b7787fd0SSam Clegg       if (!S.isVariable())
1626b7787fd0SSam Clegg         continue;
162731a2c809SSam Clegg 
1628cd65f698SSam Clegg       assert(S.isDefined());
1629b7787fd0SSam Clegg 
16309c7b5808SDominic Chen       const auto *BS = Layout.getBaseSymbol(S);
16319c7b5808SDominic Chen       if (!BS)
16329c7b5808SDominic Chen         report_fatal_error(Twine(S.getName()) +
16339c7b5808SDominic Chen                            ": absolute addressing not supported!");
16349c7b5808SDominic Chen       const MCSymbolWasm *Base = cast<MCSymbolWasm>(BS);
16357ee758d6SSam Clegg 
16365e3d33a7SSam Clegg       // Find the target symbol of this weak alias and export that index
1637aff1c4dfSSam Clegg       const auto &WS = static_cast<const MCSymbolWasm &>(S);
163830d314aaSSam Clegg       LLVM_DEBUG(dbgs() << WS.getName() << ": weak alias of '" << *Base
163930d314aaSSam Clegg                         << "'\n");
1640b7787fd0SSam Clegg 
16417ee758d6SSam Clegg       if (Base->isFunction()) {
16427ee758d6SSam Clegg         assert(WasmIndices.count(Base) > 0);
16437ee758d6SSam Clegg         uint32_t WasmIndex = WasmIndices.find(Base)->second;
1644492f7529SSam Clegg         assert(WasmIndices.count(&WS) == 0);
16456c899ba6SSam Clegg         WasmIndices[&WS] = WasmIndex;
1646d34e60caSNicola Zaghen         LLVM_DEBUG(dbgs() << "  -> index:" << WasmIndex << "\n");
16477ee758d6SSam Clegg       } else if (Base->isData()) {
16487ee758d6SSam Clegg         auto &DataSection = static_cast<MCSectionWasm &>(WS.getSection());
16497ee758d6SSam Clegg         uint64_t Offset = Layout.getSymbolOffset(S);
16507ee758d6SSam Clegg         int64_t Size = 0;
16517ee758d6SSam Clegg         // For data symbol alias we use the size of the base symbol as the
16527ee758d6SSam Clegg         // size of the alias.  When an offset from the base is involved this
16537ee758d6SSam Clegg         // can result in a offset + size goes past the end of the data section
16547ee758d6SSam Clegg         // which out object format doesn't support.  So we must clamp it.
16557ee758d6SSam Clegg         if (!Base->getSize()->evaluateAsAbsolute(Size, Layout))
16567ee758d6SSam Clegg           report_fatal_error(".size expression must be evaluatable");
16577ee758d6SSam Clegg         const WasmDataSegment &Segment =
16587ee758d6SSam Clegg             DataSegments[DataSection.getSegmentIndex()];
16597ee758d6SSam Clegg         Size =
16607ee758d6SSam Clegg             std::min(static_cast<uint64_t>(Size), Segment.Data.size() - Offset);
16617ee758d6SSam Clegg         wasm::WasmDataReference Ref = wasm::WasmDataReference{
16627ee758d6SSam Clegg             DataSection.getSegmentIndex(),
16637ee758d6SSam Clegg             static_cast<uint32_t>(Layout.getSymbolOffset(S)),
16647ee758d6SSam Clegg             static_cast<uint32_t>(Size)};
16656c899ba6SSam Clegg         DataLocations[&WS] = Ref;
1666d34e60caSNicola Zaghen         LLVM_DEBUG(dbgs() << "  -> index:" << Ref.Segment << "\n");
16676c899ba6SSam Clegg       } else {
1668da419bdbSHeejin Ahn         report_fatal_error("don't yet support global/event aliases");
16696c899ba6SSam Clegg       }
1670586320c0SNicholas Wilson     }
167130d314aaSSam Clegg   }
167231a2c809SSam Clegg 
1673586320c0SNicholas Wilson   // Finally, populate the symbol table itself, in its "natural" order.
1674586320c0SNicholas Wilson   for (const MCSymbol &S : Asm.symbols()) {
1675586320c0SNicholas Wilson     const auto &WS = static_cast<const MCSymbolWasm &>(S);
167625d8e68bSSam Clegg     if (!isInSymtab(WS)) {
167718c56a07SHeejin Ahn       WS.setIndex(InvalidIndex);
1678586320c0SNicholas Wilson       continue;
167925d8e68bSSam Clegg     }
1680d705c2fbSSam Clegg     if (WS.isTable() && WS.getName() == "__indirect_function_table") {
1681d705c2fbSSam Clegg       // For the moment, don't emit table symbols -- wasm-ld can't handle them.
1682d705c2fbSSam Clegg       continue;
1683d705c2fbSSam Clegg     }
1684d34e60caSNicola Zaghen     LLVM_DEBUG(dbgs() << "adding to symtab: " << WS << "\n");
1685586320c0SNicholas Wilson 
1686586320c0SNicholas Wilson     uint32_t Flags = 0;
1687586320c0SNicholas Wilson     if (WS.isWeak())
1688586320c0SNicholas Wilson       Flags |= wasm::WASM_SYMBOL_BINDING_WEAK;
1689586320c0SNicholas Wilson     if (WS.isHidden())
1690586320c0SNicholas Wilson       Flags |= wasm::WASM_SYMBOL_VISIBILITY_HIDDEN;
1691586320c0SNicholas Wilson     if (!WS.isExternal() && WS.isDefined())
1692586320c0SNicholas Wilson       Flags |= wasm::WASM_SYMBOL_BINDING_LOCAL;
1693586320c0SNicholas Wilson     if (WS.isUndefined())
1694586320c0SNicholas Wilson       Flags |= wasm::WASM_SYMBOL_UNDEFINED;
1695da84b688SDan Gohman     if (WS.isNoStrip()) {
1696da84b688SDan Gohman       Flags |= wasm::WASM_SYMBOL_NO_STRIP;
1697da84b688SDan Gohman       if (isEmscripten()) {
1698d6ef8da3SSam Clegg         Flags |= wasm::WASM_SYMBOL_EXPORTED;
1699da84b688SDan Gohman       }
1700da84b688SDan Gohman     }
1701b4f4e370SSam Clegg     if (WS.hasImportName())
170229874ceaSDan Gohman       Flags |= wasm::WASM_SYMBOL_EXPLICIT_NAME;
1703881d8778SSam Clegg     if (WS.hasExportName())
1704881d8778SSam Clegg       Flags |= wasm::WASM_SYMBOL_EXPORTED;
1705586320c0SNicholas Wilson 
1706586320c0SNicholas Wilson     wasm::WasmSymbolInfo Info;
1707586320c0SNicholas Wilson     Info.Name = WS.getName();
1708*5e5b2cb1SWouter van Oortmerssen     Info.Kind = WS.getType().getValueOr(wasm::WASM_SYMBOL_TYPE_DATA);
1709586320c0SNicholas Wilson     Info.Flags = Flags;
17104d57fbd0SSam Clegg     if (!WS.isData()) {
17114d57fbd0SSam Clegg       assert(WasmIndices.count(&WS) > 0);
1712586320c0SNicholas Wilson       Info.ElementIndex = WasmIndices.find(&WS)->second;
17134d57fbd0SSam Clegg     } else if (WS.isDefined()) {
17144d57fbd0SSam Clegg       assert(DataLocations.count(&WS) > 0);
1715586320c0SNicholas Wilson       Info.DataRef = DataLocations.find(&WS)->second;
17164d57fbd0SSam Clegg     }
171725d8e68bSSam Clegg     WS.setIndex(SymbolInfos.size());
1718586320c0SNicholas Wilson     SymbolInfos.emplace_back(Info);
1719b7787fd0SSam Clegg   }
1720b7787fd0SSam Clegg 
17216006e091SSam Clegg   {
17226006e091SSam Clegg     auto HandleReloc = [&](const WasmRelocationEntry &Rel) {
1723f9edbe95SSam Clegg       // Functions referenced by a relocation need to put in the table.  This is
1724f9edbe95SSam Clegg       // purely to make the object file's provisional values readable, and is
1725f9edbe95SSam Clegg       // ignored by the linker, which re-calculates the relocations itself.
1726d1152a26SSam Clegg       if (Rel.Type != wasm::R_WASM_TABLE_INDEX_I32 &&
1727cc1b9b68SWouter van Oortmerssen           Rel.Type != wasm::R_WASM_TABLE_INDEX_I64 &&
172881443ac1SSam Clegg           Rel.Type != wasm::R_WASM_TABLE_INDEX_SLEB &&
1729cc1b9b68SWouter van Oortmerssen           Rel.Type != wasm::R_WASM_TABLE_INDEX_SLEB64 &&
173081443ac1SSam Clegg           Rel.Type != wasm::R_WASM_TABLE_INDEX_REL_SLEB)
1731f9edbe95SSam Clegg         return;
1732f9edbe95SSam Clegg       assert(Rel.Symbol->isFunction());
17337ee758d6SSam Clegg       const MCSymbolWasm *Base =
17347ee758d6SSam Clegg           cast<MCSymbolWasm>(Layout.getBaseSymbol(*Rel.Symbol));
17357ee758d6SSam Clegg       uint32_t FunctionIndex = WasmIndices.find(Base)->second;
173618c56a07SHeejin Ahn       uint32_t TableIndex = TableElems.size() + InitialTableOffset;
17377ee758d6SSam Clegg       if (TableIndices.try_emplace(Base, TableIndex).second) {
17387ee758d6SSam Clegg         LLVM_DEBUG(dbgs() << "  -> adding " << Base->getName()
1739f9edbe95SSam Clegg                           << " to table: " << TableIndex << "\n");
17406c899ba6SSam Clegg         TableElems.push_back(FunctionIndex);
17417ee758d6SSam Clegg         registerFunctionType(*Base);
17426006e091SSam Clegg       }
17436006e091SSam Clegg     };
1744970d02c4SDan Gohman 
17456006e091SSam Clegg     for (const WasmRelocationEntry &RelEntry : CodeRelocations)
17466006e091SSam Clegg       HandleReloc(RelEntry);
17476006e091SSam Clegg     for (const WasmRelocationEntry &RelEntry : DataRelocations)
17486006e091SSam Clegg       HandleReloc(RelEntry);
1749d934cb88SDan Gohman   }
1750d934cb88SDan Gohman 
1751bafe6902SSam Clegg   // Translate .init_array section contents into start functions.
1752bafe6902SSam Clegg   for (const MCSection &S : Asm) {
1753bafe6902SSam Clegg     const auto &WS = static_cast<const MCSectionWasm &>(S);
17547d1ff446SFangrui Song     if (WS.getName().startswith(".fini_array"))
1755bafe6902SSam Clegg       report_fatal_error(".fini_array sections are unsupported");
17567d1ff446SFangrui Song     if (!WS.getName().startswith(".init_array"))
1757bafe6902SSam Clegg       continue;
1758bafe6902SSam Clegg     if (WS.getFragmentList().empty())
1759bafe6902SSam Clegg       continue;
1760b210c64bSSam Clegg 
1761b210c64bSSam Clegg     // init_array is expected to contain a single non-empty data fragment
1762b210c64bSSam Clegg     if (WS.getFragmentList().size() != 3)
1763bafe6902SSam Clegg       report_fatal_error("only one .init_array section fragment supported");
1764b210c64bSSam Clegg 
1765b210c64bSSam Clegg     auto IT = WS.begin();
1766b210c64bSSam Clegg     const MCFragment &EmptyFrag = *IT;
1767b210c64bSSam Clegg     if (EmptyFrag.getKind() != MCFragment::FT_Data)
1768b210c64bSSam Clegg       report_fatal_error(".init_array section should be aligned");
1769b210c64bSSam Clegg 
1770b210c64bSSam Clegg     IT = std::next(IT);
1771b210c64bSSam Clegg     const MCFragment &AlignFrag = *IT;
1772bafe6902SSam Clegg     if (AlignFrag.getKind() != MCFragment::FT_Align)
1773bafe6902SSam Clegg       report_fatal_error(".init_array section should be aligned");
1774bafe6902SSam Clegg     if (cast<MCAlignFragment>(AlignFrag).getAlignment() != (is64Bit() ? 8 : 4))
1775bafe6902SSam Clegg       report_fatal_error(".init_array section should be aligned for pointers");
1776b210c64bSSam Clegg 
1777b210c64bSSam Clegg     const MCFragment &Frag = *std::next(IT);
1778bafe6902SSam Clegg     if (Frag.hasInstructions() || Frag.getKind() != MCFragment::FT_Data)
1779bafe6902SSam Clegg       report_fatal_error("only data supported in .init_array section");
1780b210c64bSSam Clegg 
1781bafe6902SSam Clegg     uint16_t Priority = UINT16_MAX;
17824d57fbd0SSam Clegg     unsigned PrefixLength = strlen(".init_array");
17837d1ff446SFangrui Song     if (WS.getName().size() > PrefixLength) {
17847d1ff446SFangrui Song       if (WS.getName()[PrefixLength] != '.')
1785f208f631SHeejin Ahn         report_fatal_error(
1786f208f631SHeejin Ahn             ".init_array section priority should start with '.'");
17877d1ff446SFangrui Song       if (WS.getName().substr(PrefixLength + 1).getAsInteger(10, Priority))
1788bafe6902SSam Clegg         report_fatal_error("invalid .init_array section priority");
1789bafe6902SSam Clegg     }
1790bafe6902SSam Clegg     const auto &DataFrag = cast<MCDataFragment>(Frag);
1791bafe6902SSam Clegg     const SmallVectorImpl<char> &Contents = DataFrag.getContents();
1792f208f631SHeejin Ahn     for (const uint8_t *
179318c56a07SHeejin Ahn              P = (const uint8_t *)Contents.data(),
179418c56a07SHeejin Ahn             *End = (const uint8_t *)Contents.data() + Contents.size();
179518c56a07SHeejin Ahn          P != End; ++P) {
179618c56a07SHeejin Ahn       if (*P != 0)
1797bafe6902SSam Clegg         report_fatal_error("non-symbolic data in .init_array section");
1798bafe6902SSam Clegg     }
1799bafe6902SSam Clegg     for (const MCFixup &Fixup : DataFrag.getFixups()) {
1800f208f631SHeejin Ahn       assert(Fixup.getKind() ==
1801f208f631SHeejin Ahn              MCFixup::getKindForSize(is64Bit() ? 8 : 4, false));
1802bafe6902SSam Clegg       const MCExpr *Expr = Fixup.getValue();
18038fffa1dfSSam Clegg       auto *SymRef = dyn_cast<MCSymbolRefExpr>(Expr);
18048fffa1dfSSam Clegg       if (!SymRef)
1805bafe6902SSam Clegg         report_fatal_error("fixups in .init_array should be symbol references");
18068fffa1dfSSam Clegg       const auto &TargetSym = cast<const MCSymbolWasm>(SymRef->getSymbol());
18078fffa1dfSSam Clegg       if (TargetSym.getIndex() == InvalidIndex)
18083ea1c62cSSam Clegg         report_fatal_error("symbols in .init_array should exist in symtab");
18098fffa1dfSSam Clegg       if (!TargetSym.isFunction())
18108fffa1dfSSam Clegg         report_fatal_error("symbols in .init_array should be for functions");
181125d8e68bSSam Clegg       InitFuncs.push_back(
18128fffa1dfSSam Clegg           std::make_pair(Priority, TargetSym.getIndex()));
1813bafe6902SSam Clegg     }
1814bafe6902SSam Clegg   }
1815bafe6902SSam Clegg 
181618eafb6cSDan Gohman   // Write out the Wasm header.
181718eafb6cSDan Gohman   writeHeader(Asm);
181818eafb6cSDan Gohman 
18190ff28fa6SDerek Schuff   uint32_t CodeSectionIndex, DataSectionIndex;
18200ff28fa6SDerek Schuff   if (Mode != DwoMode::DwoOnly) {
1821da419bdbSHeejin Ahn     writeTypeSection(Signatures);
1822f950b24aSSam Clegg     writeImportSection(Imports, DataSize, TableElems.size());
18239e15f359SSam Clegg     writeFunctionSection(Functions);
1824d823cc7cSAndy Wingo     writeTableSection(Tables);
1825f950b24aSSam Clegg     // Skip the "memory" section; we import the memory instead.
1826da419bdbSHeejin Ahn     writeEventSection(Events);
18270a6c4d8dSSam Clegg     writeGlobalSection(Globals);
18289e15f359SSam Clegg     writeExportSection(Exports);
18299e15f359SSam Clegg     writeElemSection(TableElems);
1830fef8de66SThomas Lively     writeDataCountSection();
18310ff28fa6SDerek Schuff 
18320ff28fa6SDerek Schuff     CodeSectionIndex = writeCodeSection(Asm, Layout, Functions);
18330ff28fa6SDerek Schuff     DataSectionIndex = writeDataSection(Layout);
18340ff28fa6SDerek Schuff   }
18350ff28fa6SDerek Schuff 
18360a391060SDerek Schuff   // The Sections in the COMDAT list have placeholder indices (their index among
18370a391060SDerek Schuff   // custom sections, rather than among all sections). Fix them up here.
18380a391060SDerek Schuff   for (auto &Group : Comdats) {
18390a391060SDerek Schuff     for (auto &Entry : Group.second) {
18400a391060SDerek Schuff       if (Entry.Kind == wasm::WASM_COMDAT_SECTION) {
18410a391060SDerek Schuff         Entry.Index += SectionCount;
18420ff28fa6SDerek Schuff       }
18430a391060SDerek Schuff     }
18440a391060SDerek Schuff   }
18450a391060SDerek Schuff   for (auto &CustomSection : CustomSections)
18460a391060SDerek Schuff     writeCustomSection(CustomSection, Asm, Layout);
18470ff28fa6SDerek Schuff 
18480ff28fa6SDerek Schuff   if (Mode != DwoMode::DwoOnly) {
1849c22bfb6bSNicholas Wilson     writeLinkingMetaDataSection(SymbolInfos, InitFuncs, Comdats);
18500ff28fa6SDerek Schuff 
18516f08c84aSSam Clegg     writeRelocSection(CodeSectionIndex, "CODE", CodeRelocations);
18526f08c84aSSam Clegg     writeRelocSection(DataSectionIndex, "DATA", DataRelocations);
18530ff28fa6SDerek Schuff   }
18546a31a0d6SSam Clegg   writeCustomRelocSections();
1855cbda16ebSThomas Lively   if (ProducersSection)
1856cbda16ebSThomas Lively     writeCustomSection(*ProducersSection, Asm, Layout);
1857f6f4f843SThomas Lively   if (TargetFeaturesSection)
1858f6f4f843SThomas Lively     writeCustomSection(*TargetFeaturesSection, Asm, Layout);
1859970d02c4SDan Gohman 
1860d934cb88SDan Gohman   // TODO: Translate the .comment section to the output.
18610ff28fa6SDerek Schuff   return W->OS.tell() - StartOffset;
186218eafb6cSDan Gohman }
186318eafb6cSDan Gohman 
186460fbc7ccSLang Hames std::unique_ptr<MCObjectWriter>
18651301a878SLang Hames llvm::createWasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW,
186618eafb6cSDan Gohman                              raw_pwrite_stream &OS) {
18670eaee545SJonas Devlieghere   return std::make_unique<WasmObjectWriter>(std::move(MOTW), OS);
186818eafb6cSDan Gohman }
18690ff28fa6SDerek Schuff 
18700ff28fa6SDerek Schuff std::unique_ptr<MCObjectWriter>
18710ff28fa6SDerek Schuff llvm::createWasmDwoObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW,
18720ff28fa6SDerek Schuff                                 raw_pwrite_stream &OS,
18730ff28fa6SDerek Schuff                                 raw_pwrite_stream &DwoOS) {
18740ff28fa6SDerek Schuff   return std::make_unique<WasmObjectWriter>(std::move(MOTW), OS, DwoOS);
18750ff28fa6SDerek Schuff }
1876