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"
16432a3883SNico Weber #include "llvm/Config/llvm-config.h"
1718eafb6cSDan Gohman #include "llvm/MC/MCAsmBackend.h"
1818eafb6cSDan Gohman #include "llvm/MC/MCAsmLayout.h"
1918eafb6cSDan Gohman #include "llvm/MC/MCAssembler.h"
2018eafb6cSDan Gohman #include "llvm/MC/MCContext.h"
2118eafb6cSDan Gohman #include "llvm/MC/MCExpr.h"
2218eafb6cSDan Gohman #include "llvm/MC/MCFixupKindInfo.h"
2318eafb6cSDan Gohman #include "llvm/MC/MCObjectWriter.h"
2418eafb6cSDan Gohman #include "llvm/MC/MCSectionWasm.h"
2518eafb6cSDan Gohman #include "llvm/MC/MCSymbolWasm.h"
2618eafb6cSDan Gohman #include "llvm/MC/MCValue.h"
2718eafb6cSDan Gohman #include "llvm/MC/MCWasmObjectWriter.h"
28d934cb88SDan Gohman #include "llvm/Support/Casting.h"
2918eafb6cSDan Gohman #include "llvm/Support/Debug.h"
3018eafb6cSDan Gohman #include "llvm/Support/ErrorHandling.h"
31d934cb88SDan Gohman #include "llvm/Support/LEB128.h"
3218eafb6cSDan Gohman #include "llvm/Support/StringSaver.h"
3318eafb6cSDan Gohman #include <vector>
3418eafb6cSDan Gohman 
3518eafb6cSDan Gohman using namespace llvm;
3618eafb6cSDan Gohman 
375e3d33a7SSam Clegg #define DEBUG_TYPE "mc"
3818eafb6cSDan Gohman 
3918eafb6cSDan Gohman namespace {
409e15f359SSam Clegg 
4130e1bbc1SSam Clegg // Went we ceate the indirect function table we start at 1, so that there is
4230e1bbc1SSam Clegg // and emtpy slot at 0 and therefore calling a null function pointer will trap.
4318c56a07SHeejin Ahn static const uint32_t InitialTableOffset = 1;
4430e1bbc1SSam Clegg 
45d934cb88SDan Gohman // For patching purposes, we need to remember where each section starts, both
46d934cb88SDan Gohman // for patching up the section size field, and for patching up references to
47d934cb88SDan Gohman // locations within the section.
48d934cb88SDan Gohman struct SectionBookkeeping {
49d934cb88SDan Gohman   // Where the size of the section is written.
50d934cb88SDan Gohman   uint64_t SizeOffset;
516a31a0d6SSam Clegg   // Where the section header ends (without custom section name).
526a31a0d6SSam Clegg   uint64_t PayloadOffset;
536a31a0d6SSam Clegg   // Where the contents of the section starts.
54d934cb88SDan Gohman   uint64_t ContentsOffset;
556f08c84aSSam Clegg   uint32_t Index;
56d934cb88SDan Gohman };
57d934cb88SDan Gohman 
58da419bdbSHeejin Ahn // The signature of a wasm function or event, in a struct capable of being used
59da419bdbSHeejin Ahn // as a DenseMap key.
60da419bdbSHeejin Ahn // TODO: Consider using wasm::WasmSignature directly instead.
61da419bdbSHeejin Ahn struct WasmSignature {
629e15f359SSam Clegg   // Support empty and tombstone instances, needed by DenseMap.
6318c56a07SHeejin Ahn   enum { Plain, Empty, Tombstone } State = Plain;
649e15f359SSam Clegg 
659e15f359SSam Clegg   // The return types of the function.
669e15f359SSam Clegg   SmallVector<wasm::ValType, 1> Returns;
679e15f359SSam Clegg 
689e15f359SSam Clegg   // The parameter types of the function.
699e15f359SSam Clegg   SmallVector<wasm::ValType, 4> Params;
709e15f359SSam Clegg 
71da419bdbSHeejin Ahn   bool operator==(const WasmSignature &Other) const {
729e15f359SSam Clegg     return State == Other.State && Returns == Other.Returns &&
739e15f359SSam Clegg            Params == Other.Params;
749e15f359SSam Clegg   }
759e15f359SSam Clegg };
769e15f359SSam Clegg 
77da419bdbSHeejin Ahn // Traits for using WasmSignature in a DenseMap.
78da419bdbSHeejin Ahn struct WasmSignatureDenseMapInfo {
79da419bdbSHeejin Ahn   static WasmSignature getEmptyKey() {
80da419bdbSHeejin Ahn     WasmSignature Sig;
81da419bdbSHeejin Ahn     Sig.State = WasmSignature::Empty;
82da419bdbSHeejin Ahn     return Sig;
839e15f359SSam Clegg   }
84da419bdbSHeejin Ahn   static WasmSignature getTombstoneKey() {
85da419bdbSHeejin Ahn     WasmSignature Sig;
86da419bdbSHeejin Ahn     Sig.State = WasmSignature::Tombstone;
87da419bdbSHeejin Ahn     return Sig;
889e15f359SSam Clegg   }
89da419bdbSHeejin Ahn   static unsigned getHashValue(const WasmSignature &Sig) {
90da419bdbSHeejin Ahn     uintptr_t Value = Sig.State;
91da419bdbSHeejin Ahn     for (wasm::ValType Ret : Sig.Returns)
924808914aSHeejin Ahn       Value += DenseMapInfo<uint32_t>::getHashValue(uint32_t(Ret));
93da419bdbSHeejin Ahn     for (wasm::ValType Param : Sig.Params)
944808914aSHeejin Ahn       Value += DenseMapInfo<uint32_t>::getHashValue(uint32_t(Param));
959e15f359SSam Clegg     return Value;
969e15f359SSam Clegg   }
97da419bdbSHeejin Ahn   static bool isEqual(const WasmSignature &LHS, const WasmSignature &RHS) {
989e15f359SSam Clegg     return LHS == RHS;
999e15f359SSam Clegg   }
1009e15f359SSam Clegg };
1019e15f359SSam Clegg 
1027c395943SSam Clegg // A wasm data segment.  A wasm binary contains only a single data section
1037c395943SSam Clegg // but that can contain many segments, each with their own virtual location
1047c395943SSam Clegg // in memory.  Each MCSection data created by llvm is modeled as its own
1057c395943SSam Clegg // wasm data segment.
1067c395943SSam Clegg struct WasmDataSegment {
1077c395943SSam Clegg   MCSectionWasm *Section;
108d95ed959SSam Clegg   StringRef Name;
1092e150409SThomas Lively   uint32_t InitFlags;
1107c395943SSam Clegg   uint32_t Offset;
11163ebb813SSam Clegg   uint32_t Alignment;
1122e150409SThomas Lively   uint32_t LinkerFlags;
1137c395943SSam Clegg   SmallVector<char, 4> Data;
1147c395943SSam Clegg };
1157c395943SSam Clegg 
1169e15f359SSam Clegg // A wasm function to be written into the function section.
1179e15f359SSam Clegg struct WasmFunction {
118da419bdbSHeejin Ahn   uint32_t SigIndex;
1199e15f359SSam Clegg   const MCSymbolWasm *Sym;
1209e15f359SSam Clegg };
1219e15f359SSam Clegg 
1229e15f359SSam Clegg // A wasm global to be written into the global section.
1239e15f359SSam Clegg struct WasmGlobal {
1246e7f1826SSam Clegg   wasm::WasmGlobalType Type;
1259e15f359SSam Clegg   uint64_t InitialValue;
1269e15f359SSam Clegg };
1279e15f359SSam Clegg 
128ea7caceeSSam Clegg // Information about a single item which is part of a COMDAT.  For each data
129ea7caceeSSam Clegg // segment or function which is in the COMDAT, there is a corresponding
130ea7caceeSSam Clegg // WasmComdatEntry.
131ea7caceeSSam Clegg struct WasmComdatEntry {
132ea7caceeSSam Clegg   unsigned Kind;
133ea7caceeSSam Clegg   uint32_t Index;
134ea7caceeSSam Clegg };
135ea7caceeSSam Clegg 
1366dc65e91SSam Clegg // Information about a single relocation.
1376dc65e91SSam Clegg struct WasmRelocationEntry {
1386dc65e91SSam Clegg   uint64_t Offset;                   // Where is the relocation.
1396dc65e91SSam Clegg   const MCSymbolWasm *Symbol;        // The symbol to relocate with.
1406dc65e91SSam Clegg   int64_t Addend;                    // A value to add to the symbol.
1416dc65e91SSam Clegg   unsigned Type;                     // The type of the relocation.
142fe6414b0SSam Clegg   const MCSectionWasm *FixupSection; // The section the relocation is targeting.
1436dc65e91SSam Clegg 
1446dc65e91SSam Clegg   WasmRelocationEntry(uint64_t Offset, const MCSymbolWasm *Symbol,
1456dc65e91SSam Clegg                       int64_t Addend, unsigned Type,
146fe6414b0SSam Clegg                       const MCSectionWasm *FixupSection)
1476dc65e91SSam Clegg       : Offset(Offset), Symbol(Symbol), Addend(Addend), Type(Type),
1486dc65e91SSam Clegg         FixupSection(FixupSection) {}
1496dc65e91SSam Clegg 
150cadcb9ebSKeno Fischer   bool hasAddend() const { return wasm::relocTypeHasAddend(Type); }
151acd7d2b0SSam Clegg 
1526dc65e91SSam Clegg   void print(raw_ostream &Out) const {
153f208f631SHeejin Ahn     Out << wasm::relocTypetoString(Type) << " Off=" << Offset
154f208f631SHeejin Ahn         << ", Sym=" << *Symbol << ", Addend=" << Addend
155759631c7SSam Clegg         << ", FixupSection=" << FixupSection->getSectionName();
1566dc65e91SSam Clegg   }
157b7787fd0SSam Clegg 
158615eb470SAaron Ballman #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
159b7787fd0SSam Clegg   LLVM_DUMP_METHOD void dump() const { print(dbgs()); }
160b7787fd0SSam Clegg #endif
1616dc65e91SSam Clegg };
1626dc65e91SSam Clegg 
16318c56a07SHeejin Ahn static const uint32_t InvalidIndex = -1;
16425d8e68bSSam Clegg 
165cfd44a2eSSam Clegg struct WasmCustomSection {
166cfd44a2eSSam Clegg 
1676a31a0d6SSam Clegg   StringRef Name;
1686a31a0d6SSam Clegg   MCSectionWasm *Section;
1696a31a0d6SSam Clegg 
1706a31a0d6SSam Clegg   uint32_t OutputContentsOffset;
1716a31a0d6SSam Clegg   uint32_t OutputIndex;
1726a31a0d6SSam Clegg 
1736a31a0d6SSam Clegg   WasmCustomSection(StringRef Name, MCSectionWasm *Section)
1746a31a0d6SSam Clegg       : Name(Name), Section(Section), OutputContentsOffset(0),
17518c56a07SHeejin Ahn         OutputIndex(InvalidIndex) {}
176cfd44a2eSSam Clegg };
177cfd44a2eSSam Clegg 
1781fb8daa6SSam Clegg #if !defined(NDEBUG)
1797f055deeSSam Clegg raw_ostream &operator<<(raw_ostream &OS, const WasmRelocationEntry &Rel) {
180b7787fd0SSam Clegg   Rel.print(OS);
181b7787fd0SSam Clegg   return OS;
182b7787fd0SSam Clegg }
1831fb8daa6SSam Clegg #endif
184b7787fd0SSam Clegg 
18519e8befaSSam Clegg // Write X as an (unsigned) LEB value at offset Offset in Stream, padded
18619e8befaSSam Clegg // to allow patching.
18718c56a07SHeejin Ahn static void writePatchableLEB(raw_pwrite_stream &Stream, uint32_t X,
18819e8befaSSam Clegg                               uint64_t Offset) {
18919e8befaSSam Clegg   uint8_t Buffer[5];
19019e8befaSSam Clegg   unsigned SizeLen = encodeULEB128(X, Buffer, 5);
19119e8befaSSam Clegg   assert(SizeLen == 5);
19219e8befaSSam Clegg   Stream.pwrite((char *)Buffer, SizeLen, Offset);
19319e8befaSSam Clegg }
19419e8befaSSam Clegg 
19519e8befaSSam Clegg // Write X as an signed LEB value at offset Offset in Stream, padded
19619e8befaSSam Clegg // to allow patching.
19718c56a07SHeejin Ahn static void writePatchableSLEB(raw_pwrite_stream &Stream, int32_t X,
19819e8befaSSam Clegg                                uint64_t Offset) {
19919e8befaSSam Clegg   uint8_t Buffer[5];
20019e8befaSSam Clegg   unsigned SizeLen = encodeSLEB128(X, Buffer, 5);
20119e8befaSSam Clegg   assert(SizeLen == 5);
20219e8befaSSam Clegg   Stream.pwrite((char *)Buffer, SizeLen, Offset);
20319e8befaSSam Clegg }
20419e8befaSSam Clegg 
20519e8befaSSam Clegg // Write X as a plain integer value at offset Offset in Stream.
20618c56a07SHeejin Ahn static void writeI32(raw_pwrite_stream &Stream, uint32_t X, uint64_t Offset) {
20719e8befaSSam Clegg   uint8_t Buffer[4];
20819e8befaSSam Clegg   support::endian::write32le(Buffer, X);
20919e8befaSSam Clegg   Stream.pwrite((char *)Buffer, sizeof(Buffer), Offset);
21019e8befaSSam Clegg }
21119e8befaSSam Clegg 
21218eafb6cSDan Gohman class WasmObjectWriter : public MCObjectWriter {
213f17b149dSPeter Collingbourne   support::endian::Writer W;
214f17b149dSPeter Collingbourne 
21518eafb6cSDan Gohman   /// The target specific Wasm writer instance.
21618eafb6cSDan Gohman   std::unique_ptr<MCWasmObjectTargetWriter> TargetObjectWriter;
21718eafb6cSDan Gohman 
218d934cb88SDan Gohman   // Relocations for fixing up references in the code section.
219d934cb88SDan Gohman   std::vector<WasmRelocationEntry> CodeRelocations;
2206f08c84aSSam Clegg   uint32_t CodeSectionIndex;
221d934cb88SDan Gohman 
222d934cb88SDan Gohman   // Relocations for fixing up references in the data section.
223d934cb88SDan Gohman   std::vector<WasmRelocationEntry> DataRelocations;
2246f08c84aSSam Clegg   uint32_t DataSectionIndex;
225d934cb88SDan Gohman 
226d934cb88SDan Gohman   // Index values to use for fixing up call_indirect type indices.
227acd7d2b0SSam Clegg   // Maps function symbols to the index of the type of the function
228acd7d2b0SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> TypeIndices;
229d99f6078SSam Clegg   // Maps function symbols to the table element index space. Used
230d99f6078SSam Clegg   // for TABLE_INDEX relocation types (i.e. address taken functions).
231f9edbe95SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> TableIndices;
232da419bdbSHeejin Ahn   // Maps function/global symbols to the function/global/event/section index
233da419bdbSHeejin Ahn   // space.
2346c899ba6SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> WasmIndices;
235492f7529SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> GOTIndices;
2366c899ba6SSam Clegg   // Maps data symbols to the Wasm segment and offset/size with the segment.
2376c899ba6SSam Clegg   DenseMap<const MCSymbolWasm *, wasm::WasmDataReference> DataLocations;
2386a31a0d6SSam Clegg 
2396a31a0d6SSam Clegg   // Stores output data (index, relocations, content offset) for custom
2406a31a0d6SSam Clegg   // section.
2416a31a0d6SSam Clegg   std::vector<WasmCustomSection> CustomSections;
242cbda16ebSThomas Lively   std::unique_ptr<WasmCustomSection> ProducersSection;
243f6f4f843SThomas Lively   std::unique_ptr<WasmCustomSection> TargetFeaturesSection;
2446a31a0d6SSam Clegg   // Relocations for fixing up references in the custom sections.
2456a31a0d6SSam Clegg   DenseMap<const MCSectionWasm *, std::vector<WasmRelocationEntry>>
2466a31a0d6SSam Clegg       CustomSectionsRelocations;
247acd7d2b0SSam Clegg 
248c0d41195SSam Clegg   // Map from section to defining function symbol.
2496ccb59b3SSam Clegg   DenseMap<const MCSection *, const MCSymbol *> SectionFunctions;
2506ccb59b3SSam Clegg 
251da419bdbSHeejin Ahn   DenseMap<WasmSignature, uint32_t, WasmSignatureDenseMapInfo> SignatureIndices;
252da419bdbSHeejin Ahn   SmallVector<WasmSignature, 4> Signatures;
2536c899ba6SSam Clegg   SmallVector<WasmDataSegment, 4> DataSegments;
2549f3fe42eSSam Clegg   unsigned NumFunctionImports = 0;
2557c395943SSam Clegg   unsigned NumGlobalImports = 0;
256da419bdbSHeejin Ahn   unsigned NumEventImports = 0;
2577e1c3345SChandler Carruth   uint32_t SectionCount = 0;
258d934cb88SDan Gohman 
25918eafb6cSDan Gohman   // TargetObjectWriter wrappers.
26018eafb6cSDan Gohman   bool is64Bit() const { return TargetObjectWriter->is64Bit(); }
26118eafb6cSDan Gohman 
2622322a937SSam Clegg   void startSection(SectionBookkeeping &Section, unsigned SectionId);
2632322a937SSam Clegg   void startCustomSection(SectionBookkeeping &Section, StringRef Name);
264d934cb88SDan Gohman   void endSection(SectionBookkeeping &Section);
265d934cb88SDan Gohman 
26618eafb6cSDan Gohman public:
2671301a878SLang Hames   WasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW,
2681301a878SLang Hames                    raw_pwrite_stream &OS)
26959a6fc46SPeter Collingbourne       : W(OS, support::little), TargetObjectWriter(std::move(MOTW)) {}
27018eafb6cSDan Gohman 
2710917c9e4SDan Gohman private:
272acd7d2b0SSam Clegg   void reset() override {
273acd7d2b0SSam Clegg     CodeRelocations.clear();
274acd7d2b0SSam Clegg     DataRelocations.clear();
275acd7d2b0SSam Clegg     TypeIndices.clear();
2766c899ba6SSam Clegg     WasmIndices.clear();
277492f7529SSam Clegg     GOTIndices.clear();
278f9edbe95SSam Clegg     TableIndices.clear();
2796c899ba6SSam Clegg     DataLocations.clear();
280cbda16ebSThomas Lively     CustomSections.clear();
281cbda16ebSThomas Lively     ProducersSection.reset();
282f6f4f843SThomas Lively     TargetFeaturesSection.reset();
2836a31a0d6SSam Clegg     CustomSectionsRelocations.clear();
284da419bdbSHeejin Ahn     SignatureIndices.clear();
285da419bdbSHeejin Ahn     Signatures.clear();
2866c899ba6SSam Clegg     DataSegments.clear();
2876ccb59b3SSam Clegg     SectionFunctions.clear();
2889f3fe42eSSam Clegg     NumFunctionImports = 0;
2897c395943SSam Clegg     NumGlobalImports = 0;
290105bdc25SSam Clegg     MCObjectWriter::reset();
291acd7d2b0SSam Clegg   }
292acd7d2b0SSam Clegg 
29318eafb6cSDan Gohman   void writeHeader(const MCAssembler &Asm);
29418eafb6cSDan Gohman 
29518eafb6cSDan Gohman   void recordRelocation(MCAssembler &Asm, const MCAsmLayout &Layout,
29618eafb6cSDan Gohman                         const MCFragment *Fragment, const MCFixup &Fixup,
297ceecfe5bSRafael Espindola                         MCValue Target, uint64_t &FixedValue) override;
29818eafb6cSDan Gohman 
29918eafb6cSDan Gohman   void executePostLayoutBinding(MCAssembler &Asm,
30018eafb6cSDan Gohman                                 const MCAsmLayout &Layout) override;
30118eafb6cSDan Gohman 
302438390faSPeter Collingbourne   uint64_t writeObject(MCAssembler &Asm, const MCAsmLayout &Layout) override;
3039e15f359SSam Clegg 
304b7787fd0SSam Clegg   void writeString(const StringRef Str) {
305f17b149dSPeter Collingbourne     encodeULEB128(Str.size(), W.OS);
306f17b149dSPeter Collingbourne     W.OS << Str;
307b7787fd0SSam Clegg   }
308b7787fd0SSam Clegg 
309f208f631SHeejin Ahn   void writeValueType(wasm::ValType Ty) { W.OS << static_cast<char>(Ty); }
3109e15f359SSam Clegg 
311da419bdbSHeejin Ahn   void writeTypeSection(ArrayRef<WasmSignature> Signatures);
3128defa952SSam Clegg   void writeImportSection(ArrayRef<wasm::WasmImport> Imports, uint32_t DataSize,
313f950b24aSSam Clegg                           uint32_t NumElements);
314457fb0b4SSam Clegg   void writeFunctionSection(ArrayRef<WasmFunction> Functions);
3158defa952SSam Clegg   void writeExportSection(ArrayRef<wasm::WasmExport> Exports);
316457fb0b4SSam Clegg   void writeElemSection(ArrayRef<uint32_t> TableElems);
317fef8de66SThomas Lively   void writeDataCountSection();
3189e15f359SSam Clegg   void writeCodeSection(const MCAssembler &Asm, const MCAsmLayout &Layout,
319457fb0b4SSam Clegg                         ArrayRef<WasmFunction> Functions);
3206c899ba6SSam Clegg   void writeDataSection();
321da419bdbSHeejin Ahn   void writeEventSection(ArrayRef<wasm::WasmEventType> Events);
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();
3316a31a0d6SSam Clegg   void
3326a31a0d6SSam Clegg   updateCustomSectionRelocations(const SmallVector<WasmFunction, 4> &Functions,
3336a31a0d6SSam Clegg                                  const MCAsmLayout &Layout);
334acd7d2b0SSam Clegg 
3357c395943SSam Clegg   uint32_t getProvisionalValue(const WasmRelocationEntry &RelEntry);
336acd7d2b0SSam Clegg   void applyRelocations(ArrayRef<WasmRelocationEntry> Relocations,
337acd7d2b0SSam Clegg                         uint64_t ContentsOffset);
338acd7d2b0SSam Clegg 
339acd7d2b0SSam Clegg   uint32_t getRelocationIndexValue(const WasmRelocationEntry &RelEntry);
3405e3d33a7SSam Clegg   uint32_t getFunctionType(const MCSymbolWasm &Symbol);
341da419bdbSHeejin Ahn   uint32_t getEventType(const MCSymbolWasm &Symbol);
34238b12f5eSHeejin Ahn   void registerFunctionType(const MCSymbolWasm &Symbol);
34338b12f5eSHeejin Ahn   void registerEventType(const MCSymbolWasm &Symbol);
34418eafb6cSDan Gohman };
3459e15f359SSam Clegg 
34618eafb6cSDan Gohman } // end anonymous namespace
34718eafb6cSDan Gohman 
348d934cb88SDan Gohman // Write out a section header and a patchable section size field.
349d934cb88SDan Gohman void WasmObjectWriter::startSection(SectionBookkeeping &Section,
3502322a937SSam Clegg                                     unsigned SectionId) {
351d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "startSection " << SectionId << "\n");
352f17b149dSPeter Collingbourne   W.OS << char(SectionId);
353d934cb88SDan Gohman 
354f17b149dSPeter Collingbourne   Section.SizeOffset = W.OS.tell();
355d934cb88SDan Gohman 
356d934cb88SDan Gohman   // The section size. We don't know the size yet, so reserve enough space
357d934cb88SDan Gohman   // for any 32-bit value; we'll patch it later.
35819e8befaSSam Clegg   encodeULEB128(0, W.OS, 5);
359d934cb88SDan Gohman 
360d934cb88SDan Gohman   // The position where the section starts, for measuring its size.
361f17b149dSPeter Collingbourne   Section.ContentsOffset = W.OS.tell();
362f17b149dSPeter Collingbourne   Section.PayloadOffset = W.OS.tell();
3636f08c84aSSam Clegg   Section.Index = SectionCount++;
364d934cb88SDan Gohman }
3652322a937SSam Clegg 
3662322a937SSam Clegg void WasmObjectWriter::startCustomSection(SectionBookkeeping &Section,
3672322a937SSam Clegg                                           StringRef Name) {
368d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "startCustomSection " << Name << "\n");
3692322a937SSam Clegg   startSection(Section, wasm::WASM_SEC_CUSTOM);
3706a31a0d6SSam Clegg 
3716a31a0d6SSam Clegg   // The position where the section header ends, for measuring its size.
372f17b149dSPeter Collingbourne   Section.PayloadOffset = W.OS.tell();
3736a31a0d6SSam Clegg 
3742322a937SSam Clegg   // Custom sections in wasm also have a string identifier.
3752322a937SSam Clegg   writeString(Name);
3766a31a0d6SSam Clegg 
3776a31a0d6SSam Clegg   // The position where the custom section starts.
378f17b149dSPeter Collingbourne   Section.ContentsOffset = W.OS.tell();
379d934cb88SDan Gohman }
380d934cb88SDan Gohman 
381d934cb88SDan Gohman // Now that the section is complete and we know how big it is, patch up the
382d934cb88SDan Gohman // section size field at the start of the section.
383d934cb88SDan Gohman void WasmObjectWriter::endSection(SectionBookkeeping &Section) {
384c0affde8SSam Clegg   uint64_t Size = W.OS.tell();
385c0affde8SSam Clegg   // /dev/null doesn't support seek/tell and can report offset of 0.
386c0affde8SSam Clegg   // Simply skip this patching in that case.
387c0affde8SSam Clegg   if (!Size)
388c0affde8SSam Clegg     return;
389c0affde8SSam Clegg 
390c0affde8SSam Clegg   Size -= Section.PayloadOffset;
391d934cb88SDan Gohman   if (uint32_t(Size) != Size)
392d934cb88SDan Gohman     report_fatal_error("section size does not fit in a uint32_t");
393d934cb88SDan Gohman 
394d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "endSection size=" << Size << "\n");
395d934cb88SDan Gohman 
396d934cb88SDan Gohman   // Write the final section size to the payload_len field, which follows
397d934cb88SDan Gohman   // the section id byte.
39818c56a07SHeejin Ahn   writePatchableLEB(static_cast<raw_pwrite_stream &>(W.OS), Size,
399f17b149dSPeter Collingbourne                     Section.SizeOffset);
400d934cb88SDan Gohman }
401d934cb88SDan Gohman 
40218eafb6cSDan Gohman // Emit the Wasm header.
40318eafb6cSDan Gohman void WasmObjectWriter::writeHeader(const MCAssembler &Asm) {
404f17b149dSPeter Collingbourne   W.OS.write(wasm::WasmMagic, sizeof(wasm::WasmMagic));
405f17b149dSPeter Collingbourne   W.write<uint32_t>(wasm::WasmVersion);
40618eafb6cSDan Gohman }
40718eafb6cSDan Gohman 
40818eafb6cSDan Gohman void WasmObjectWriter::executePostLayoutBinding(MCAssembler &Asm,
40918eafb6cSDan Gohman                                                 const MCAsmLayout &Layout) {
4106ccb59b3SSam Clegg   // Build a map of sections to the function that defines them, for use
4116ccb59b3SSam Clegg   // in recordRelocation.
4126ccb59b3SSam Clegg   for (const MCSymbol &S : Asm.symbols()) {
4136ccb59b3SSam Clegg     const auto &WS = static_cast<const MCSymbolWasm &>(S);
4146ccb59b3SSam Clegg     if (WS.isDefined() && WS.isFunction() && !WS.isVariable()) {
4156ccb59b3SSam Clegg       const auto &Sec = static_cast<const MCSectionWasm &>(S.getSection());
4166ccb59b3SSam Clegg       auto Pair = SectionFunctions.insert(std::make_pair(&Sec, &S));
4176ccb59b3SSam Clegg       if (!Pair.second)
4186ccb59b3SSam Clegg         report_fatal_error("section already has a defining function: " +
4196ccb59b3SSam Clegg                            Sec.getSectionName());
4206ccb59b3SSam Clegg     }
4216ccb59b3SSam Clegg   }
42218eafb6cSDan Gohman }
42318eafb6cSDan Gohman 
42418eafb6cSDan Gohman void WasmObjectWriter::recordRelocation(MCAssembler &Asm,
42518eafb6cSDan Gohman                                         const MCAsmLayout &Layout,
42618eafb6cSDan Gohman                                         const MCFragment *Fragment,
42718eafb6cSDan Gohman                                         const MCFixup &Fixup, MCValue Target,
428ceecfe5bSRafael Espindola                                         uint64_t &FixedValue) {
429ceecfe5bSRafael Espindola   MCAsmBackend &Backend = Asm.getBackend();
430ceecfe5bSRafael Espindola   bool IsPCRel = Backend.getFixupKindInfo(Fixup.getKind()).Flags &
431ceecfe5bSRafael Espindola                  MCFixupKindInfo::FKF_IsPCRel;
432fe6414b0SSam Clegg   const auto &FixupSection = cast<MCSectionWasm>(*Fragment->getParent());
433d934cb88SDan Gohman   uint64_t C = Target.getConstant();
434d934cb88SDan Gohman   uint64_t FixupOffset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
435d934cb88SDan Gohman   MCContext &Ctx = Asm.getContext();
436d934cb88SDan Gohman 
437bafe6902SSam Clegg   // The .init_array isn't translated as data, so don't do relocations in it.
438bafe6902SSam Clegg   if (FixupSection.getSectionName().startswith(".init_array"))
439bafe6902SSam Clegg     return;
440bafe6902SSam Clegg 
441d934cb88SDan Gohman   if (const MCSymbolRefExpr *RefB = Target.getSymB()) {
442d934cb88SDan Gohman     assert(RefB->getKind() == MCSymbolRefExpr::VK_None &&
443d934cb88SDan Gohman            "Should not have constructed this");
444d934cb88SDan Gohman 
445d934cb88SDan Gohman     // Let A, B and C being the components of Target and R be the location of
446d934cb88SDan Gohman     // the fixup. If the fixup is not pcrel, we want to compute (A - B + C).
447d934cb88SDan Gohman     // If it is pcrel, we want to compute (A - B + C - R).
448d934cb88SDan Gohman 
449d934cb88SDan Gohman     // In general, Wasm has no relocations for -B. It can only represent (A + C)
450d934cb88SDan Gohman     // or (A + C - R). If B = R + K and the relocation is not pcrel, we can
451d934cb88SDan Gohman     // replace B to implement it: (A - R - K + C)
452d934cb88SDan Gohman     if (IsPCRel) {
453d934cb88SDan Gohman       Ctx.reportError(
454d934cb88SDan Gohman           Fixup.getLoc(),
455d934cb88SDan Gohman           "No relocation available to represent this relative expression");
456d934cb88SDan Gohman       return;
457d934cb88SDan Gohman     }
458d934cb88SDan Gohman 
459d934cb88SDan Gohman     const auto &SymB = cast<MCSymbolWasm>(RefB->getSymbol());
460d934cb88SDan Gohman 
461d934cb88SDan Gohman     if (SymB.isUndefined()) {
462d934cb88SDan Gohman       Ctx.reportError(Fixup.getLoc(),
463d934cb88SDan Gohman                       Twine("symbol '") + SymB.getName() +
464d934cb88SDan Gohman                           "' can not be undefined in a subtraction expression");
465d934cb88SDan Gohman       return;
466d934cb88SDan Gohman     }
467d934cb88SDan Gohman 
468d934cb88SDan Gohman     assert(!SymB.isAbsolute() && "Should have been folded");
469d934cb88SDan Gohman     const MCSection &SecB = SymB.getSection();
470d934cb88SDan Gohman     if (&SecB != &FixupSection) {
471d934cb88SDan Gohman       Ctx.reportError(Fixup.getLoc(),
472d934cb88SDan Gohman                       "Cannot represent a difference across sections");
473d934cb88SDan Gohman       return;
474d934cb88SDan Gohman     }
475d934cb88SDan Gohman 
476d934cb88SDan Gohman     uint64_t SymBOffset = Layout.getSymbolOffset(SymB);
477d934cb88SDan Gohman     uint64_t K = SymBOffset - FixupOffset;
478d934cb88SDan Gohman     IsPCRel = true;
479d934cb88SDan Gohman     C -= K;
480d934cb88SDan Gohman   }
481d934cb88SDan Gohman 
482d934cb88SDan Gohman   // We either rejected the fixup or folded B into C at this point.
483d934cb88SDan Gohman   const MCSymbolRefExpr *RefA = Target.getSymA();
484d934cb88SDan Gohman   const auto *SymA = RefA ? cast<MCSymbolWasm>(&RefA->getSymbol()) : nullptr;
485d934cb88SDan Gohman 
486d934cb88SDan Gohman   if (SymA && SymA->isVariable()) {
487d934cb88SDan Gohman     const MCExpr *Expr = SymA->getVariableValue();
4886ad8f190SSam Clegg     const auto *Inner = cast<MCSymbolRefExpr>(Expr);
4896ad8f190SSam Clegg     if (Inner->getKind() == MCSymbolRefExpr::VK_WEAKREF)
4906ad8f190SSam Clegg       llvm_unreachable("weakref used in reloc not yet implemented");
491d934cb88SDan Gohman   }
492d934cb88SDan Gohman 
493d934cb88SDan Gohman   // Put any constant offset in an addend. Offsets can be negative, and
494d934cb88SDan Gohman   // LLVM expects wrapping, in contrast to wasm's immediates which can't
495d934cb88SDan Gohman   // be negative and don't wrap.
496d934cb88SDan Gohman   FixedValue = 0;
497d934cb88SDan Gohman 
498a5e175c6SSam Clegg   unsigned Type = TargetObjectWriter->getRelocType(Target, Fixup);
499ae03c1e7SSam Clegg   assert(!IsPCRel);
5009d24fb7fSSam Clegg   assert(SymA);
5019d24fb7fSSam Clegg 
5024d57fbd0SSam Clegg   // Absolute offset within a section or a function.
5034d57fbd0SSam Clegg   // Currently only supported for for metadata sections.
5044d57fbd0SSam Clegg   // See: test/MC/WebAssembly/blockaddress.ll
505d1152a26SSam Clegg   if (Type == wasm::R_WASM_FUNCTION_OFFSET_I32 ||
506d1152a26SSam Clegg       Type == wasm::R_WASM_SECTION_OFFSET_I32) {
5074d57fbd0SSam Clegg     if (!FixupSection.getKind().isMetadata())
5084d57fbd0SSam Clegg       report_fatal_error("relocations for function or section offsets are "
5094d57fbd0SSam Clegg                          "only supported in metadata sections");
5104d57fbd0SSam Clegg 
5114d57fbd0SSam Clegg     const MCSymbol *SectionSymbol = nullptr;
5124d57fbd0SSam Clegg     const MCSection &SecA = SymA->getSection();
5134d57fbd0SSam Clegg     if (SecA.getKind().isText())
5146ccb59b3SSam Clegg       SectionSymbol = SectionFunctions.find(&SecA)->second;
5154d57fbd0SSam Clegg     else
5164d57fbd0SSam Clegg       SectionSymbol = SecA.getBeginSymbol();
5174d57fbd0SSam Clegg     if (!SectionSymbol)
5184d57fbd0SSam Clegg       report_fatal_error("section symbol is required for relocation");
5194d57fbd0SSam Clegg 
5204d57fbd0SSam Clegg     C += Layout.getSymbolOffset(*SymA);
5214d57fbd0SSam Clegg     SymA = cast<MCSymbolWasm>(SectionSymbol);
5224d57fbd0SSam Clegg   }
5234d57fbd0SSam Clegg 
524d1152a26SSam Clegg   // Relocation other than R_WASM_TYPE_INDEX_LEB are required to be
5254d57fbd0SSam Clegg   // against a named symbol.
526d1152a26SSam Clegg   if (Type != wasm::R_WASM_TYPE_INDEX_LEB) {
5274d57fbd0SSam Clegg     if (SymA->getName().empty())
5284d57fbd0SSam Clegg       report_fatal_error("relocations against un-named temporaries are not yet "
5294d57fbd0SSam Clegg                          "supported by wasm");
5304d57fbd0SSam Clegg 
5314d57fbd0SSam Clegg     SymA->setUsedInReloc();
5324d57fbd0SSam Clegg   }
533ae03c1e7SSam Clegg 
534492f7529SSam Clegg   if (RefA->getKind() == MCSymbolRefExpr::VK_GOT)
535492f7529SSam Clegg     SymA->setUsedInGOT();
536492f7529SSam Clegg 
537d934cb88SDan Gohman   WasmRelocationEntry Rec(FixupOffset, SymA, C, Type, &FixupSection);
538d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "WasmReloc: " << Rec << "\n");
539d934cb88SDan Gohman 
5406a31a0d6SSam Clegg   if (FixupSection.isWasmData()) {
541d934cb88SDan Gohman     DataRelocations.push_back(Rec);
5426a31a0d6SSam Clegg   } else if (FixupSection.getKind().isText()) {
54312fd3da9SSam Clegg     CodeRelocations.push_back(Rec);
5446a31a0d6SSam Clegg   } else if (FixupSection.getKind().isMetadata()) {
5456a31a0d6SSam Clegg     CustomSectionsRelocations[&FixupSection].push_back(Rec);
5466a31a0d6SSam Clegg   } else {
54712fd3da9SSam Clegg     llvm_unreachable("unexpected section type");
548d934cb88SDan Gohman   }
5496a31a0d6SSam Clegg }
550d934cb88SDan Gohman 
55118c56a07SHeejin Ahn static const MCSymbolWasm *resolveSymbol(const MCSymbolWasm &Symbol) {
552ffba00bdSSam Clegg   const MCSymbolWasm* Ret = &Symbol;
553ffba00bdSSam Clegg   while (Ret->isVariable()) {
554ffba00bdSSam Clegg     const MCExpr *Expr = Ret->getVariableValue();
555aff1c4dfSSam Clegg     auto *Inner = cast<MCSymbolRefExpr>(Expr);
556ffba00bdSSam Clegg     Ret = cast<MCSymbolWasm>(&Inner->getSymbol());
557aff1c4dfSSam Clegg   }
558ffba00bdSSam Clegg   return Ret;
559aff1c4dfSSam Clegg }
560aff1c4dfSSam Clegg 
561d934cb88SDan Gohman // Compute a value to write into the code at the location covered
56260ec3034SSam Clegg // by RelEntry. This value isn't used by the static linker; it just serves
56360ec3034SSam Clegg // to make the object format more readable and more likely to be directly
56460ec3034SSam Clegg // useable.
5657c395943SSam Clegg uint32_t
5667c395943SSam Clegg WasmObjectWriter::getProvisionalValue(const WasmRelocationEntry &RelEntry) {
567492f7529SSam Clegg   if (RelEntry.Type == wasm::R_WASM_GLOBAL_INDEX_LEB && !RelEntry.Symbol->isGlobal()) {
568492f7529SSam Clegg     assert(GOTIndices.count(RelEntry.Symbol) > 0 && "symbol not found in GOT index space");
569492f7529SSam Clegg     return GOTIndices[RelEntry.Symbol];
570492f7529SSam Clegg   }
571492f7529SSam Clegg 
57260ec3034SSam Clegg   switch (RelEntry.Type) {
5732a7cac93SSam Clegg   case wasm::R_WASM_TABLE_INDEX_REL_SLEB:
574d1152a26SSam Clegg   case wasm::R_WASM_TABLE_INDEX_SLEB:
575d1152a26SSam Clegg   case wasm::R_WASM_TABLE_INDEX_I32: {
576f9edbe95SSam Clegg     // Provisional value is table address of the resolved symbol itself
57718c56a07SHeejin Ahn     const MCSymbolWasm *Sym = resolveSymbol(*RelEntry.Symbol);
578f9edbe95SSam Clegg     assert(Sym->isFunction());
579f9edbe95SSam Clegg     return TableIndices[Sym];
580f9edbe95SSam Clegg   }
581d1152a26SSam Clegg   case wasm::R_WASM_TYPE_INDEX_LEB:
5826c899ba6SSam Clegg     // Provisional value is same as the index
58360ec3034SSam Clegg     return getRelocationIndexValue(RelEntry);
584d1152a26SSam Clegg   case wasm::R_WASM_FUNCTION_INDEX_LEB:
585d1152a26SSam Clegg   case wasm::R_WASM_GLOBAL_INDEX_LEB:
586d1152a26SSam Clegg   case wasm::R_WASM_EVENT_INDEX_LEB:
587da419bdbSHeejin Ahn     // Provisional value is function/global/event Wasm index
588492f7529SSam Clegg     assert(WasmIndices.count(RelEntry.Symbol) > 0 && "symbol not found in wasm index space");
5896c899ba6SSam Clegg     return WasmIndices[RelEntry.Symbol];
590d1152a26SSam Clegg   case wasm::R_WASM_FUNCTION_OFFSET_I32:
591d1152a26SSam Clegg   case wasm::R_WASM_SECTION_OFFSET_I32: {
5926a31a0d6SSam Clegg     const auto &Section =
5936a31a0d6SSam Clegg         static_cast<const MCSectionWasm &>(RelEntry.Symbol->getSection());
5946a31a0d6SSam Clegg     return Section.getSectionOffset() + RelEntry.Addend;
5956a31a0d6SSam Clegg   }
596d1152a26SSam Clegg   case wasm::R_WASM_MEMORY_ADDR_LEB:
597d1152a26SSam Clegg   case wasm::R_WASM_MEMORY_ADDR_I32:
5982a7cac93SSam Clegg   case wasm::R_WASM_MEMORY_ADDR_REL_SLEB:
599d1152a26SSam Clegg   case wasm::R_WASM_MEMORY_ADDR_SLEB: {
600f9edbe95SSam Clegg     // Provisional value is address of the global
60118c56a07SHeejin Ahn     const MCSymbolWasm *Sym = resolveSymbol(*RelEntry.Symbol);
602270ed1b3SSam Clegg     // For undefined symbols, use zero
603cd65f698SSam Clegg     if (!Sym->isDefined())
604270ed1b3SSam Clegg       return 0;
6056c899ba6SSam Clegg     const wasm::WasmDataReference &Ref = DataLocations[Sym];
6066c899ba6SSam Clegg     const WasmDataSegment &Segment = DataSegments[Ref.Segment];
607d934cb88SDan Gohman     // Ignore overflow. LLVM allows address arithmetic to silently wrap.
6086c899ba6SSam Clegg     return Segment.Offset + Ref.Offset + RelEntry.Addend;
60960ec3034SSam Clegg   }
61060ec3034SSam Clegg   default:
61160ec3034SSam Clegg     llvm_unreachable("invalid relocation type");
61260ec3034SSam Clegg   }
613d934cb88SDan Gohman }
614d934cb88SDan Gohman 
615759631c7SSam Clegg static void addData(SmallVectorImpl<char> &DataBytes,
61663ebb813SSam Clegg                     MCSectionWasm &DataSection) {
617d34e60caSNicola Zaghen   LLVM_DEBUG(errs() << "addData: " << DataSection.getSectionName() << "\n");
618759631c7SSam Clegg 
61963ebb813SSam Clegg   DataBytes.resize(alignTo(DataBytes.size(), DataSection.getAlignment()));
62063ebb813SSam Clegg 
621759631c7SSam Clegg   for (const MCFragment &Frag : DataSection) {
622759631c7SSam Clegg     if (Frag.hasInstructions())
623759631c7SSam Clegg       report_fatal_error("only data supported in data sections");
624759631c7SSam Clegg 
625759631c7SSam Clegg     if (auto *Align = dyn_cast<MCAlignFragment>(&Frag)) {
626759631c7SSam Clegg       if (Align->getValueSize() != 1)
627759631c7SSam Clegg         report_fatal_error("only byte values supported for alignment");
628759631c7SSam Clegg       // If nops are requested, use zeros, as this is the data section.
629759631c7SSam Clegg       uint8_t Value = Align->hasEmitNops() ? 0 : Align->getValue();
630f208f631SHeejin Ahn       uint64_t Size =
631f208f631SHeejin Ahn           std::min<uint64_t>(alignTo(DataBytes.size(), Align->getAlignment()),
632f208f631SHeejin Ahn                              DataBytes.size() + Align->getMaxBytesToEmit());
633759631c7SSam Clegg       DataBytes.resize(Size, Value);
634759631c7SSam Clegg     } else if (auto *Fill = dyn_cast<MCFillFragment>(&Frag)) {
635588fad4dSNirav Dave       int64_t NumValues;
636588fad4dSNirav Dave       if (!Fill->getNumValues().evaluateAsAbsolute(NumValues))
637d707c370SRafael Espindola         llvm_unreachable("The fill should be an assembler constant");
638588fad4dSNirav Dave       DataBytes.insert(DataBytes.end(), Fill->getValueSize() * NumValues,
639588fad4dSNirav Dave                        Fill->getValue());
64024faf859SHeejin Ahn     } else if (auto *LEB = dyn_cast<MCLEBFragment>(&Frag)) {
64124faf859SHeejin Ahn       const SmallVectorImpl<char> &Contents = LEB->getContents();
64224faf859SHeejin Ahn       DataBytes.insert(DataBytes.end(), Contents.begin(), Contents.end());
643759631c7SSam Clegg     } else {
644759631c7SSam Clegg       const auto &DataFrag = cast<MCDataFragment>(Frag);
645759631c7SSam Clegg       const SmallVectorImpl<char> &Contents = DataFrag.getContents();
646759631c7SSam Clegg       DataBytes.insert(DataBytes.end(), Contents.begin(), Contents.end());
647759631c7SSam Clegg     }
648759631c7SSam Clegg   }
649759631c7SSam Clegg 
650d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "addData -> " << DataBytes.size() << "\n");
651759631c7SSam Clegg }
652759631c7SSam Clegg 
65360ec3034SSam Clegg uint32_t
65460ec3034SSam Clegg WasmObjectWriter::getRelocationIndexValue(const WasmRelocationEntry &RelEntry) {
655d1152a26SSam Clegg   if (RelEntry.Type == wasm::R_WASM_TYPE_INDEX_LEB) {
656b7787fd0SSam Clegg     if (!TypeIndices.count(RelEntry.Symbol))
657b7787fd0SSam Clegg       report_fatal_error("symbol not found in type index space: " +
658b7787fd0SSam Clegg                          RelEntry.Symbol->getName());
659acd7d2b0SSam Clegg     return TypeIndices[RelEntry.Symbol];
660acd7d2b0SSam Clegg   }
66160ec3034SSam Clegg 
66225d8e68bSSam Clegg   return RelEntry.Symbol->getIndex();
663acd7d2b0SSam Clegg }
664acd7d2b0SSam Clegg 
665d934cb88SDan Gohman // Apply the portions of the relocation records that we can handle ourselves
666d934cb88SDan Gohman // directly.
667acd7d2b0SSam Clegg void WasmObjectWriter::applyRelocations(
668acd7d2b0SSam Clegg     ArrayRef<WasmRelocationEntry> Relocations, uint64_t ContentsOffset) {
669f17b149dSPeter Collingbourne   auto &Stream = static_cast<raw_pwrite_stream &>(W.OS);
670d934cb88SDan Gohman   for (const WasmRelocationEntry &RelEntry : Relocations) {
671d934cb88SDan Gohman     uint64_t Offset = ContentsOffset +
672d934cb88SDan Gohman                       RelEntry.FixupSection->getSectionOffset() +
673d934cb88SDan Gohman                       RelEntry.Offset;
674d934cb88SDan Gohman 
675d34e60caSNicola Zaghen     LLVM_DEBUG(dbgs() << "applyRelocation: " << RelEntry << "\n");
67660ec3034SSam Clegg     uint32_t Value = getProvisionalValue(RelEntry);
67760ec3034SSam Clegg 
678acd7d2b0SSam Clegg     switch (RelEntry.Type) {
679d1152a26SSam Clegg     case wasm::R_WASM_FUNCTION_INDEX_LEB:
680d1152a26SSam Clegg     case wasm::R_WASM_TYPE_INDEX_LEB:
681d1152a26SSam Clegg     case wasm::R_WASM_GLOBAL_INDEX_LEB:
682d1152a26SSam Clegg     case wasm::R_WASM_MEMORY_ADDR_LEB:
683d1152a26SSam Clegg     case wasm::R_WASM_EVENT_INDEX_LEB:
68418c56a07SHeejin Ahn       writePatchableLEB(Stream, Value, Offset);
685d934cb88SDan Gohman       break;
686d1152a26SSam Clegg     case wasm::R_WASM_TABLE_INDEX_I32:
687d1152a26SSam Clegg     case wasm::R_WASM_MEMORY_ADDR_I32:
688d1152a26SSam Clegg     case wasm::R_WASM_FUNCTION_OFFSET_I32:
689d1152a26SSam Clegg     case wasm::R_WASM_SECTION_OFFSET_I32:
69018c56a07SHeejin Ahn       writeI32(Stream, Value, Offset);
691d934cb88SDan Gohman       break;
692d1152a26SSam Clegg     case wasm::R_WASM_TABLE_INDEX_SLEB:
6932a7cac93SSam Clegg     case wasm::R_WASM_TABLE_INDEX_REL_SLEB:
694d1152a26SSam Clegg     case wasm::R_WASM_MEMORY_ADDR_SLEB:
6952a7cac93SSam Clegg     case wasm::R_WASM_MEMORY_ADDR_REL_SLEB:
69618c56a07SHeejin Ahn       writePatchableSLEB(Stream, Value, Offset);
69760ec3034SSam Clegg       break;
698d934cb88SDan Gohman     default:
6999d24fb7fSSam Clegg       llvm_unreachable("invalid relocation type");
700d934cb88SDan Gohman     }
701d934cb88SDan Gohman   }
70218eafb6cSDan Gohman }
70318eafb6cSDan Gohman 
704da419bdbSHeejin Ahn void WasmObjectWriter::writeTypeSection(ArrayRef<WasmSignature> Signatures) {
705da419bdbSHeejin Ahn   if (Signatures.empty())
7069e15f359SSam Clegg     return;
7079e15f359SSam Clegg 
7089e15f359SSam Clegg   SectionBookkeeping Section;
7099e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_TYPE);
7109e15f359SSam Clegg 
711da419bdbSHeejin Ahn   encodeULEB128(Signatures.size(), W.OS);
7129e15f359SSam Clegg 
713da419bdbSHeejin Ahn   for (const WasmSignature &Sig : Signatures) {
714f17b149dSPeter Collingbourne     W.OS << char(wasm::WASM_TYPE_FUNC);
715da419bdbSHeejin Ahn     encodeULEB128(Sig.Params.size(), W.OS);
716da419bdbSHeejin Ahn     for (wasm::ValType Ty : Sig.Params)
7179e15f359SSam Clegg       writeValueType(Ty);
718da419bdbSHeejin Ahn     encodeULEB128(Sig.Returns.size(), W.OS);
719da419bdbSHeejin Ahn     for (wasm::ValType Ty : Sig.Returns)
7209e15f359SSam Clegg       writeValueType(Ty);
7219e15f359SSam Clegg   }
7229e15f359SSam Clegg 
7239e15f359SSam Clegg   endSection(Section);
7249e15f359SSam Clegg }
7259e15f359SSam Clegg 
7268defa952SSam Clegg void WasmObjectWriter::writeImportSection(ArrayRef<wasm::WasmImport> Imports,
727f950b24aSSam Clegg                                           uint32_t DataSize,
728f950b24aSSam Clegg                                           uint32_t NumElements) {
7299e15f359SSam Clegg   if (Imports.empty())
7309e15f359SSam Clegg     return;
7319e15f359SSam Clegg 
732f950b24aSSam Clegg   uint32_t NumPages = (DataSize + wasm::WasmPageSize - 1) / wasm::WasmPageSize;
733f950b24aSSam Clegg 
7349e15f359SSam Clegg   SectionBookkeeping Section;
7359e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_IMPORT);
7369e15f359SSam Clegg 
737f17b149dSPeter Collingbourne   encodeULEB128(Imports.size(), W.OS);
7388defa952SSam Clegg   for (const wasm::WasmImport &Import : Imports) {
7398defa952SSam Clegg     writeString(Import.Module);
7408defa952SSam Clegg     writeString(Import.Field);
741f17b149dSPeter Collingbourne     W.OS << char(Import.Kind);
7429e15f359SSam Clegg 
7439e15f359SSam Clegg     switch (Import.Kind) {
7449e15f359SSam Clegg     case wasm::WASM_EXTERNAL_FUNCTION:
745f17b149dSPeter Collingbourne       encodeULEB128(Import.SigIndex, W.OS);
7469e15f359SSam Clegg       break;
7479e15f359SSam Clegg     case wasm::WASM_EXTERNAL_GLOBAL:
748f17b149dSPeter Collingbourne       W.OS << char(Import.Global.Type);
749f17b149dSPeter Collingbourne       W.OS << char(Import.Global.Mutable ? 1 : 0);
7509e15f359SSam Clegg       break;
751f950b24aSSam Clegg     case wasm::WASM_EXTERNAL_MEMORY:
752f17b149dSPeter Collingbourne       encodeULEB128(0, W.OS);        // flags
753f17b149dSPeter Collingbourne       encodeULEB128(NumPages, W.OS); // initial
754f950b24aSSam Clegg       break;
755f950b24aSSam Clegg     case wasm::WASM_EXTERNAL_TABLE:
756f17b149dSPeter Collingbourne       W.OS << char(Import.Table.ElemType);
757f17b149dSPeter Collingbourne       encodeULEB128(0, W.OS);           // flags
758f17b149dSPeter Collingbourne       encodeULEB128(NumElements, W.OS); // initial
759f950b24aSSam Clegg       break;
760da419bdbSHeejin Ahn     case wasm::WASM_EXTERNAL_EVENT:
761da419bdbSHeejin Ahn       encodeULEB128(Import.Event.Attribute, W.OS);
762da419bdbSHeejin Ahn       encodeULEB128(Import.Event.SigIndex, W.OS);
763da419bdbSHeejin Ahn       break;
7649e15f359SSam Clegg     default:
7659e15f359SSam Clegg       llvm_unreachable("unsupported import kind");
7669e15f359SSam Clegg     }
7679e15f359SSam Clegg   }
7689e15f359SSam Clegg 
7699e15f359SSam Clegg   endSection(Section);
7709e15f359SSam Clegg }
7719e15f359SSam Clegg 
772457fb0b4SSam Clegg void WasmObjectWriter::writeFunctionSection(ArrayRef<WasmFunction> Functions) {
7739e15f359SSam Clegg   if (Functions.empty())
7749e15f359SSam Clegg     return;
7759e15f359SSam Clegg 
7769e15f359SSam Clegg   SectionBookkeeping Section;
7779e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_FUNCTION);
7789e15f359SSam Clegg 
779f17b149dSPeter Collingbourne   encodeULEB128(Functions.size(), W.OS);
7809e15f359SSam Clegg   for (const WasmFunction &Func : Functions)
781da419bdbSHeejin Ahn     encodeULEB128(Func.SigIndex, W.OS);
7829e15f359SSam Clegg 
7839e15f359SSam Clegg   endSection(Section);
7849e15f359SSam Clegg }
7859e15f359SSam Clegg 
786da419bdbSHeejin Ahn void WasmObjectWriter::writeEventSection(ArrayRef<wasm::WasmEventType> Events) {
787da419bdbSHeejin Ahn   if (Events.empty())
788da419bdbSHeejin Ahn     return;
789da419bdbSHeejin Ahn 
790da419bdbSHeejin Ahn   SectionBookkeeping Section;
791da419bdbSHeejin Ahn   startSection(Section, wasm::WASM_SEC_EVENT);
792da419bdbSHeejin Ahn 
793da419bdbSHeejin Ahn   encodeULEB128(Events.size(), W.OS);
794da419bdbSHeejin Ahn   for (const wasm::WasmEventType &Event : Events) {
795da419bdbSHeejin Ahn     encodeULEB128(Event.Attribute, W.OS);
796da419bdbSHeejin Ahn     encodeULEB128(Event.SigIndex, W.OS);
797da419bdbSHeejin Ahn   }
798da419bdbSHeejin Ahn 
799da419bdbSHeejin Ahn   endSection(Section);
800da419bdbSHeejin Ahn }
801da419bdbSHeejin Ahn 
8028defa952SSam Clegg void WasmObjectWriter::writeExportSection(ArrayRef<wasm::WasmExport> Exports) {
8039e15f359SSam Clegg   if (Exports.empty())
8049e15f359SSam Clegg     return;
8059e15f359SSam Clegg 
8069e15f359SSam Clegg   SectionBookkeeping Section;
8079e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_EXPORT);
8089e15f359SSam Clegg 
809f17b149dSPeter Collingbourne   encodeULEB128(Exports.size(), W.OS);
8108defa952SSam Clegg   for (const wasm::WasmExport &Export : Exports) {
8118defa952SSam Clegg     writeString(Export.Name);
812f17b149dSPeter Collingbourne     W.OS << char(Export.Kind);
813f17b149dSPeter Collingbourne     encodeULEB128(Export.Index, W.OS);
8149e15f359SSam Clegg   }
8159e15f359SSam Clegg 
8169e15f359SSam Clegg   endSection(Section);
8179e15f359SSam Clegg }
8189e15f359SSam Clegg 
819457fb0b4SSam Clegg void WasmObjectWriter::writeElemSection(ArrayRef<uint32_t> TableElems) {
8209e15f359SSam Clegg   if (TableElems.empty())
8219e15f359SSam Clegg     return;
8229e15f359SSam Clegg 
8239e15f359SSam Clegg   SectionBookkeeping Section;
8249e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_ELEM);
8259e15f359SSam Clegg 
826f17b149dSPeter Collingbourne   encodeULEB128(1, W.OS); // number of "segments"
827f17b149dSPeter Collingbourne   encodeULEB128(0, W.OS); // the table index
8289e15f359SSam Clegg 
8299e15f359SSam Clegg   // init expr for starting offset
830f17b149dSPeter Collingbourne   W.OS << char(wasm::WASM_OPCODE_I32_CONST);
83118c56a07SHeejin Ahn   encodeSLEB128(InitialTableOffset, W.OS);
832f17b149dSPeter Collingbourne   W.OS << char(wasm::WASM_OPCODE_END);
8339e15f359SSam Clegg 
834f17b149dSPeter Collingbourne   encodeULEB128(TableElems.size(), W.OS);
8359e15f359SSam Clegg   for (uint32_t Elem : TableElems)
836f17b149dSPeter Collingbourne     encodeULEB128(Elem, W.OS);
8379e15f359SSam Clegg 
8389e15f359SSam Clegg   endSection(Section);
8399e15f359SSam Clegg }
8409e15f359SSam Clegg 
841fef8de66SThomas Lively void WasmObjectWriter::writeDataCountSection() {
842fef8de66SThomas Lively   if (DataSegments.empty())
843fef8de66SThomas Lively     return;
844fef8de66SThomas Lively 
845fef8de66SThomas Lively   SectionBookkeeping Section;
846fef8de66SThomas Lively   startSection(Section, wasm::WASM_SEC_DATACOUNT);
847fef8de66SThomas Lively   encodeULEB128(DataSegments.size(), W.OS);
848fef8de66SThomas Lively   endSection(Section);
849fef8de66SThomas Lively }
850fef8de66SThomas Lively 
851457fb0b4SSam Clegg void WasmObjectWriter::writeCodeSection(const MCAssembler &Asm,
852457fb0b4SSam Clegg                                         const MCAsmLayout &Layout,
853457fb0b4SSam Clegg                                         ArrayRef<WasmFunction> Functions) {
8549e15f359SSam Clegg   if (Functions.empty())
8559e15f359SSam Clegg     return;
8569e15f359SSam Clegg 
8579e15f359SSam Clegg   SectionBookkeeping Section;
8589e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CODE);
8596f08c84aSSam Clegg   CodeSectionIndex = Section.Index;
8609e15f359SSam Clegg 
861f17b149dSPeter Collingbourne   encodeULEB128(Functions.size(), W.OS);
8629e15f359SSam Clegg 
8639e15f359SSam Clegg   for (const WasmFunction &Func : Functions) {
864fe6414b0SSam Clegg     auto &FuncSection = static_cast<MCSectionWasm &>(Func.Sym->getSection());
8659e15f359SSam Clegg 
8669e15f359SSam Clegg     int64_t Size = 0;
8679e15f359SSam Clegg     if (!Func.Sym->getSize()->evaluateAsAbsolute(Size, Layout))
8689e15f359SSam Clegg       report_fatal_error(".size expression must be evaluatable");
8699e15f359SSam Clegg 
870f17b149dSPeter Collingbourne     encodeULEB128(Size, W.OS);
871f17b149dSPeter Collingbourne     FuncSection.setSectionOffset(W.OS.tell() - Section.ContentsOffset);
872f17b149dSPeter Collingbourne     Asm.writeSectionData(W.OS, &FuncSection, Layout);
8739e15f359SSam Clegg   }
8749e15f359SSam Clegg 
8759e15f359SSam Clegg   // Apply fixups.
876acd7d2b0SSam Clegg   applyRelocations(CodeRelocations, Section.ContentsOffset);
8779e15f359SSam Clegg 
8789e15f359SSam Clegg   endSection(Section);
8799e15f359SSam Clegg }
8809e15f359SSam Clegg 
8816c899ba6SSam Clegg void WasmObjectWriter::writeDataSection() {
8826c899ba6SSam Clegg   if (DataSegments.empty())
8837c395943SSam Clegg     return;
8849e15f359SSam Clegg 
8859e15f359SSam Clegg   SectionBookkeeping Section;
8869e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_DATA);
8876f08c84aSSam Clegg   DataSectionIndex = Section.Index;
8889e15f359SSam Clegg 
889f17b149dSPeter Collingbourne   encodeULEB128(DataSegments.size(), W.OS); // count
8907c395943SSam Clegg 
8916c899ba6SSam Clegg   for (const WasmDataSegment &Segment : DataSegments) {
8922e150409SThomas Lively     encodeULEB128(Segment.InitFlags, W.OS); // flags
8932e150409SThomas Lively     if (Segment.InitFlags & wasm::WASM_SEGMENT_HAS_MEMINDEX)
894f17b149dSPeter Collingbourne       encodeULEB128(0, W.OS); // memory index
8952e150409SThomas Lively     if ((Segment.InitFlags & wasm::WASM_SEGMENT_IS_PASSIVE) == 0) {
896f17b149dSPeter Collingbourne       W.OS << char(wasm::WASM_OPCODE_I32_CONST);
897f17b149dSPeter Collingbourne       encodeSLEB128(Segment.Offset, W.OS); // offset
898f17b149dSPeter Collingbourne       W.OS << char(wasm::WASM_OPCODE_END);
8992e150409SThomas Lively     }
900f17b149dSPeter Collingbourne     encodeULEB128(Segment.Data.size(), W.OS); // size
901f17b149dSPeter Collingbourne     Segment.Section->setSectionOffset(W.OS.tell() - Section.ContentsOffset);
902f17b149dSPeter Collingbourne     W.OS << Segment.Data; // data
9037c395943SSam Clegg   }
9049e15f359SSam Clegg 
9059e15f359SSam Clegg   // Apply fixups.
9067c395943SSam Clegg   applyRelocations(DataRelocations, Section.ContentsOffset);
9079e15f359SSam Clegg 
9089e15f359SSam Clegg   endSection(Section);
9099e15f359SSam Clegg }
9109e15f359SSam Clegg 
9116f08c84aSSam Clegg void WasmObjectWriter::writeRelocSection(
9126f08c84aSSam Clegg     uint32_t SectionIndex, StringRef Name,
913f77dc2a8SSam Clegg     std::vector<WasmRelocationEntry> &Relocs) {
9149e15f359SSam Clegg   // See: https://github.com/WebAssembly/tool-conventions/blob/master/Linking.md
9159e15f359SSam Clegg   // for descriptions of the reloc sections.
9169e15f359SSam Clegg 
917f77dc2a8SSam Clegg   if (Relocs.empty())
9189e15f359SSam Clegg     return;
9199e15f359SSam Clegg 
920f77dc2a8SSam Clegg   // First, ensure the relocations are sorted in offset order.  In general they
921f77dc2a8SSam Clegg   // should already be sorted since `recordRelocation` is called in offset
922f77dc2a8SSam Clegg   // order, but for the code section we combine many MC sections into single
923f77dc2a8SSam Clegg   // wasm section, and this order is determined by the order of Asm.Symbols()
924f77dc2a8SSam Clegg   // not the sections order.
925efd94c56SFangrui Song   llvm::stable_sort(
926efd94c56SFangrui Song       Relocs, [](const WasmRelocationEntry &A, const WasmRelocationEntry &B) {
927f77dc2a8SSam Clegg         return (A.Offset + A.FixupSection->getSectionOffset()) <
928f77dc2a8SSam Clegg                (B.Offset + B.FixupSection->getSectionOffset());
929f77dc2a8SSam Clegg       });
930f77dc2a8SSam Clegg 
9319e15f359SSam Clegg   SectionBookkeeping Section;
9326f08c84aSSam Clegg   startCustomSection(Section, std::string("reloc.") + Name.str());
9339e15f359SSam Clegg 
934f17b149dSPeter Collingbourne   encodeULEB128(SectionIndex, W.OS);
935f77dc2a8SSam Clegg   encodeULEB128(Relocs.size(), W.OS);
936f77dc2a8SSam Clegg   for (const WasmRelocationEntry &RelEntry : Relocs) {
937f208f631SHeejin Ahn     uint64_t Offset =
938f208f631SHeejin Ahn         RelEntry.Offset + RelEntry.FixupSection->getSectionOffset();
9396f08c84aSSam Clegg     uint32_t Index = getRelocationIndexValue(RelEntry);
9409e15f359SSam Clegg 
941f17b149dSPeter Collingbourne     W.OS << char(RelEntry.Type);
942f17b149dSPeter Collingbourne     encodeULEB128(Offset, W.OS);
943f17b149dSPeter Collingbourne     encodeULEB128(Index, W.OS);
9446f08c84aSSam Clegg     if (RelEntry.hasAddend())
945f17b149dSPeter Collingbourne       encodeSLEB128(RelEntry.Addend, W.OS);
9469e15f359SSam Clegg   }
9479e15f359SSam Clegg 
9489e15f359SSam Clegg   endSection(Section);
9499e15f359SSam Clegg }
9509e15f359SSam Clegg 
9516a31a0d6SSam Clegg void WasmObjectWriter::writeCustomRelocSections() {
9526a31a0d6SSam Clegg   for (const auto &Sec : CustomSections) {
9536a31a0d6SSam Clegg     auto &Relocations = CustomSectionsRelocations[Sec.Section];
9546a31a0d6SSam Clegg     writeRelocSection(Sec.OutputIndex, Sec.Name, Relocations);
9556a31a0d6SSam Clegg   }
9566a31a0d6SSam Clegg }
9576a31a0d6SSam Clegg 
9589e15f359SSam Clegg void WasmObjectWriter::writeLinkingMetaDataSection(
95986b4a09aSSam Clegg     ArrayRef<wasm::WasmSymbolInfo> SymbolInfos,
960ea7caceeSSam Clegg     ArrayRef<std::pair<uint16_t, uint32_t>> InitFuncs,
961ea7caceeSSam Clegg     const std::map<StringRef, std::vector<WasmComdatEntry>> &Comdats) {
9629e15f359SSam Clegg   SectionBookkeeping Section;
9632322a937SSam Clegg   startCustomSection(Section, "linking");
964f17b149dSPeter Collingbourne   encodeULEB128(wasm::WasmMetadataVersion, W.OS);
9659e15f359SSam Clegg 
9666bb5a41fSSam Clegg   SectionBookkeeping SubSection;
9676c899ba6SSam Clegg   if (SymbolInfos.size() != 0) {
9686c899ba6SSam Clegg     startSection(SubSection, wasm::WASM_SYMBOL_TABLE);
969f17b149dSPeter Collingbourne     encodeULEB128(SymbolInfos.size(), W.OS);
9706c899ba6SSam Clegg     for (const wasm::WasmSymbolInfo &Sym : SymbolInfos) {
971f17b149dSPeter Collingbourne       encodeULEB128(Sym.Kind, W.OS);
972f17b149dSPeter Collingbourne       encodeULEB128(Sym.Flags, W.OS);
9736c899ba6SSam Clegg       switch (Sym.Kind) {
9746c899ba6SSam Clegg       case wasm::WASM_SYMBOL_TYPE_FUNCTION:
9756c899ba6SSam Clegg       case wasm::WASM_SYMBOL_TYPE_GLOBAL:
976da419bdbSHeejin Ahn       case wasm::WASM_SYMBOL_TYPE_EVENT:
977f17b149dSPeter Collingbourne         encodeULEB128(Sym.ElementIndex, W.OS);
97829874ceaSDan Gohman         if ((Sym.Flags & wasm::WASM_SYMBOL_UNDEFINED) == 0 ||
97929874ceaSDan Gohman             (Sym.Flags & wasm::WASM_SYMBOL_EXPLICIT_NAME) != 0)
9806c899ba6SSam Clegg           writeString(Sym.Name);
9816c899ba6SSam Clegg         break;
9826c899ba6SSam Clegg       case wasm::WASM_SYMBOL_TYPE_DATA:
9836c899ba6SSam Clegg         writeString(Sym.Name);
9846c899ba6SSam Clegg         if ((Sym.Flags & wasm::WASM_SYMBOL_UNDEFINED) == 0) {
985f17b149dSPeter Collingbourne           encodeULEB128(Sym.DataRef.Segment, W.OS);
986f17b149dSPeter Collingbourne           encodeULEB128(Sym.DataRef.Offset, W.OS);
987f17b149dSPeter Collingbourne           encodeULEB128(Sym.DataRef.Size, W.OS);
9886c899ba6SSam Clegg         }
9896c899ba6SSam Clegg         break;
9906a31a0d6SSam Clegg       case wasm::WASM_SYMBOL_TYPE_SECTION: {
9916a31a0d6SSam Clegg         const uint32_t SectionIndex =
9926a31a0d6SSam Clegg             CustomSections[Sym.ElementIndex].OutputIndex;
993f17b149dSPeter Collingbourne         encodeULEB128(SectionIndex, W.OS);
9946a31a0d6SSam Clegg         break;
9956a31a0d6SSam Clegg       }
9966c899ba6SSam Clegg       default:
9976c899ba6SSam Clegg         llvm_unreachable("unexpected kind");
9986c899ba6SSam Clegg       }
999b7787fd0SSam Clegg     }
1000b7787fd0SSam Clegg     endSection(SubSection);
1001b7787fd0SSam Clegg   }
10029e15f359SSam Clegg 
10036c899ba6SSam Clegg   if (DataSegments.size()) {
100463ebb813SSam Clegg     startSection(SubSection, wasm::WASM_SEGMENT_INFO);
1005f17b149dSPeter Collingbourne     encodeULEB128(DataSegments.size(), W.OS);
10066c899ba6SSam Clegg     for (const WasmDataSegment &Segment : DataSegments) {
1007d95ed959SSam Clegg       writeString(Segment.Name);
1008f17b149dSPeter Collingbourne       encodeULEB128(Segment.Alignment, W.OS);
10092e150409SThomas Lively       encodeULEB128(Segment.LinkerFlags, W.OS);
101063ebb813SSam Clegg     }
1011d95ed959SSam Clegg     endSection(SubSection);
1012d95ed959SSam Clegg   }
1013d95ed959SSam Clegg 
1014bafe6902SSam Clegg   if (!InitFuncs.empty()) {
1015bafe6902SSam Clegg     startSection(SubSection, wasm::WASM_INIT_FUNCS);
1016f17b149dSPeter Collingbourne     encodeULEB128(InitFuncs.size(), W.OS);
1017bafe6902SSam Clegg     for (auto &StartFunc : InitFuncs) {
1018f17b149dSPeter Collingbourne       encodeULEB128(StartFunc.first, W.OS);  // priority
1019f17b149dSPeter Collingbourne       encodeULEB128(StartFunc.second, W.OS); // function index
1020bafe6902SSam Clegg     }
1021bafe6902SSam Clegg     endSection(SubSection);
1022bafe6902SSam Clegg   }
1023bafe6902SSam Clegg 
1024ea7caceeSSam Clegg   if (Comdats.size()) {
1025ea7caceeSSam Clegg     startSection(SubSection, wasm::WASM_COMDAT_INFO);
1026f17b149dSPeter Collingbourne     encodeULEB128(Comdats.size(), W.OS);
1027ea7caceeSSam Clegg     for (const auto &C : Comdats) {
1028ea7caceeSSam Clegg       writeString(C.first);
1029f17b149dSPeter Collingbourne       encodeULEB128(0, W.OS); // flags for future use
1030f17b149dSPeter Collingbourne       encodeULEB128(C.second.size(), W.OS);
1031ea7caceeSSam Clegg       for (const WasmComdatEntry &Entry : C.second) {
1032f17b149dSPeter Collingbourne         encodeULEB128(Entry.Kind, W.OS);
1033f17b149dSPeter Collingbourne         encodeULEB128(Entry.Index, W.OS);
1034ea7caceeSSam Clegg       }
1035ea7caceeSSam Clegg     }
1036ea7caceeSSam Clegg     endSection(SubSection);
1037ea7caceeSSam Clegg   }
1038ea7caceeSSam Clegg 
10399e15f359SSam Clegg   endSection(Section);
10409e15f359SSam Clegg }
10419e15f359SSam Clegg 
1042cbda16ebSThomas Lively void WasmObjectWriter::writeCustomSection(WasmCustomSection &CustomSection,
1043cbda16ebSThomas Lively                                           const MCAssembler &Asm,
10446a31a0d6SSam Clegg                                           const MCAsmLayout &Layout) {
1045cfd44a2eSSam Clegg   SectionBookkeeping Section;
10466a31a0d6SSam Clegg   auto *Sec = CustomSection.Section;
10472322a937SSam Clegg   startCustomSection(Section, CustomSection.Name);
10486a31a0d6SSam Clegg 
1049f17b149dSPeter Collingbourne   Sec->setSectionOffset(W.OS.tell() - Section.ContentsOffset);
1050f17b149dSPeter Collingbourne   Asm.writeSectionData(W.OS, Sec, Layout);
10516a31a0d6SSam Clegg 
10526a31a0d6SSam Clegg   CustomSection.OutputContentsOffset = Section.ContentsOffset;
10536a31a0d6SSam Clegg   CustomSection.OutputIndex = Section.Index;
10546a31a0d6SSam Clegg 
1055cfd44a2eSSam Clegg   endSection(Section);
10566a31a0d6SSam Clegg 
10576a31a0d6SSam Clegg   // Apply fixups.
10584d57fbd0SSam Clegg   auto &Relocations = CustomSectionsRelocations[CustomSection.Section];
10594d57fbd0SSam Clegg   applyRelocations(Relocations, CustomSection.OutputContentsOffset);
10606a31a0d6SSam Clegg }
10616a31a0d6SSam Clegg 
10625e3d33a7SSam Clegg uint32_t WasmObjectWriter::getFunctionType(const MCSymbolWasm &Symbol) {
10635e3d33a7SSam Clegg   assert(Symbol.isFunction());
10645e3d33a7SSam Clegg   assert(TypeIndices.count(&Symbol));
10655e3d33a7SSam Clegg   return TypeIndices[&Symbol];
10665e3d33a7SSam Clegg }
10675e3d33a7SSam Clegg 
1068da419bdbSHeejin Ahn uint32_t WasmObjectWriter::getEventType(const MCSymbolWasm &Symbol) {
1069da419bdbSHeejin Ahn   assert(Symbol.isEvent());
1070da419bdbSHeejin Ahn   assert(TypeIndices.count(&Symbol));
1071da419bdbSHeejin Ahn   return TypeIndices[&Symbol];
1072da419bdbSHeejin Ahn }
1073da419bdbSHeejin Ahn 
107438b12f5eSHeejin Ahn void WasmObjectWriter::registerFunctionType(const MCSymbolWasm &Symbol) {
10755e3d33a7SSam Clegg   assert(Symbol.isFunction());
10765e3d33a7SSam Clegg 
1077da419bdbSHeejin Ahn   WasmSignature S;
107818c56a07SHeejin Ahn   const MCSymbolWasm *ResolvedSym = resolveSymbol(Symbol);
107977a7a380SDerek Schuff   if (auto *Sig = ResolvedSym->getSignature()) {
1080da419bdbSHeejin Ahn     S.Returns = Sig->Returns;
1081da419bdbSHeejin Ahn     S.Params = Sig->Params;
108277a7a380SDerek Schuff   }
10835e3d33a7SSam Clegg 
1084da419bdbSHeejin Ahn   auto Pair = SignatureIndices.insert(std::make_pair(S, Signatures.size()));
10855e3d33a7SSam Clegg   if (Pair.second)
1086da419bdbSHeejin Ahn     Signatures.push_back(S);
10875e3d33a7SSam Clegg   TypeIndices[&Symbol] = Pair.first->second;
10885e3d33a7SSam Clegg 
1089d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "registerFunctionType: " << Symbol
1090d34e60caSNicola Zaghen                     << " new:" << Pair.second << "\n");
1091d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "  -> type index: " << Pair.first->second << "\n");
10925e3d33a7SSam Clegg }
10935e3d33a7SSam Clegg 
109438b12f5eSHeejin Ahn void WasmObjectWriter::registerEventType(const MCSymbolWasm &Symbol) {
1095da419bdbSHeejin Ahn   assert(Symbol.isEvent());
1096da419bdbSHeejin Ahn 
1097da419bdbSHeejin Ahn   // TODO Currently we don't generate imported exceptions, but if we do, we
1098da419bdbSHeejin Ahn   // should have a way of infering types of imported exceptions.
1099da419bdbSHeejin Ahn   WasmSignature S;
1100da419bdbSHeejin Ahn   if (auto *Sig = Symbol.getSignature()) {
1101da419bdbSHeejin Ahn     S.Returns = Sig->Returns;
1102da419bdbSHeejin Ahn     S.Params = Sig->Params;
1103da419bdbSHeejin Ahn   }
1104da419bdbSHeejin Ahn 
1105da419bdbSHeejin Ahn   auto Pair = SignatureIndices.insert(std::make_pair(S, Signatures.size()));
1106da419bdbSHeejin Ahn   if (Pair.second)
1107da419bdbSHeejin Ahn     Signatures.push_back(S);
1108da419bdbSHeejin Ahn   TypeIndices[&Symbol] = Pair.first->second;
1109da419bdbSHeejin Ahn 
1110da419bdbSHeejin Ahn   LLVM_DEBUG(dbgs() << "registerEventType: " << Symbol << " new:" << Pair.second
1111da419bdbSHeejin Ahn                     << "\n");
1112da419bdbSHeejin Ahn   LLVM_DEBUG(dbgs() << "  -> type index: " << Pair.first->second << "\n");
1113da419bdbSHeejin Ahn }
1114da419bdbSHeejin Ahn 
11154d57fbd0SSam Clegg static bool isInSymtab(const MCSymbolWasm &Sym) {
11164d57fbd0SSam Clegg   if (Sym.isUsedInReloc())
11174d57fbd0SSam Clegg     return true;
11184d57fbd0SSam Clegg 
11194d57fbd0SSam Clegg   if (Sym.isComdat() && !Sym.isDefined())
11204d57fbd0SSam Clegg     return false;
11214d57fbd0SSam Clegg 
11224d57fbd0SSam Clegg   if (Sym.isTemporary() && Sym.getName().empty())
11234d57fbd0SSam Clegg     return false;
11244d57fbd0SSam Clegg 
11254d57fbd0SSam Clegg   if (Sym.isTemporary() && Sym.isData() && !Sym.getSize())
11264d57fbd0SSam Clegg     return false;
11274d57fbd0SSam Clegg 
11284d57fbd0SSam Clegg   if (Sym.isSection())
11294d57fbd0SSam Clegg     return false;
11304d57fbd0SSam Clegg 
11314d57fbd0SSam Clegg   return true;
11324d57fbd0SSam Clegg }
11334d57fbd0SSam Clegg 
1134438390faSPeter Collingbourne uint64_t WasmObjectWriter::writeObject(MCAssembler &Asm,
113518eafb6cSDan Gohman                                        const MCAsmLayout &Layout) {
1136438390faSPeter Collingbourne   uint64_t StartOffset = W.OS.tell();
1137438390faSPeter Collingbourne 
1138d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "WasmObjectWriter::writeObject\n");
1139d934cb88SDan Gohman 
1140d934cb88SDan Gohman   // Collect information from the available symbols.
1141d934cb88SDan Gohman   SmallVector<WasmFunction, 4> Functions;
1142d934cb88SDan Gohman   SmallVector<uint32_t, 4> TableElems;
11438defa952SSam Clegg   SmallVector<wasm::WasmImport, 4> Imports;
11448defa952SSam Clegg   SmallVector<wasm::WasmExport, 4> Exports;
1145da419bdbSHeejin Ahn   SmallVector<wasm::WasmEventType, 1> Events;
11466c899ba6SSam Clegg   SmallVector<wasm::WasmSymbolInfo, 4> SymbolInfos;
1147bafe6902SSam Clegg   SmallVector<std::pair<uint16_t, uint32_t>, 2> InitFuncs;
1148ea7caceeSSam Clegg   std::map<StringRef, std::vector<WasmComdatEntry>> Comdats;
11497c395943SSam Clegg   uint32_t DataSize = 0;
1150d934cb88SDan Gohman 
1151f950b24aSSam Clegg   // For now, always emit the memory import, since loads and stores are not
1152f950b24aSSam Clegg   // valid without it. In the future, we could perhaps be more clever and omit
1153f950b24aSSam Clegg   // it if there are no loads or stores.
11548defa952SSam Clegg   wasm::WasmImport MemImport;
11551ed3a046SSam Clegg   MemImport.Module = "env";
11561ed3a046SSam Clegg   MemImport.Field = "__linear_memory";
1157f950b24aSSam Clegg   MemImport.Kind = wasm::WASM_EXTERNAL_MEMORY;
1158f950b24aSSam Clegg   Imports.push_back(MemImport);
1159f950b24aSSam Clegg 
1160f950b24aSSam Clegg   // For now, always emit the table section, since indirect calls are not
1161f950b24aSSam Clegg   // valid without it. In the future, we could perhaps be more clever and omit
1162f950b24aSSam Clegg   // it if there are no indirect calls.
11638defa952SSam Clegg   wasm::WasmImport TableImport;
11641ed3a046SSam Clegg   TableImport.Module = "env";
11651ed3a046SSam Clegg   TableImport.Field = "__indirect_function_table";
1166f950b24aSSam Clegg   TableImport.Kind = wasm::WASM_EXTERNAL_TABLE;
11676a87ddacSThomas Lively   TableImport.Table.ElemType = wasm::WASM_TYPE_FUNCREF;
1168f950b24aSSam Clegg   Imports.push_back(TableImport);
1169f950b24aSSam Clegg 
1170da419bdbSHeejin Ahn   // Populate SignatureIndices, and Imports and WasmIndices for undefined
1171586320c0SNicholas Wilson   // symbols.  This must be done before populating WasmIndices for defined
1172586320c0SNicholas Wilson   // symbols.
117332ce5ca0SDan Gohman   for (const MCSymbol &S : Asm.symbols()) {
117432ce5ca0SDan Gohman     const auto &WS = static_cast<const MCSymbolWasm &>(S);
117532ce5ca0SDan Gohman 
117632ce5ca0SDan Gohman     // Register types for all functions, including those with private linkage
11779f3fe42eSSam Clegg     // (because wasm always needs a type signature).
117832ce5ca0SDan Gohman     if (WS.isFunction())
117932ce5ca0SDan Gohman       registerFunctionType(WS);
118032ce5ca0SDan Gohman 
1181da419bdbSHeejin Ahn     if (WS.isEvent())
1182da419bdbSHeejin Ahn       registerEventType(WS);
1183da419bdbSHeejin Ahn 
118432ce5ca0SDan Gohman     if (WS.isTemporary())
118532ce5ca0SDan Gohman       continue;
118632ce5ca0SDan Gohman 
118732ce5ca0SDan Gohman     // If the symbol is not defined in this translation unit, import it.
11886c899ba6SSam Clegg     if (!WS.isDefined() && !WS.isComdat()) {
11896c899ba6SSam Clegg       if (WS.isFunction()) {
11908defa952SSam Clegg         wasm::WasmImport Import;
1191f726e445SDan Gohman         Import.Module = WS.getImportModule();
1192f726e445SDan Gohman         Import.Field = WS.getImportName();
119332ce5ca0SDan Gohman         Import.Kind = wasm::WASM_EXTERNAL_FUNCTION;
11948defa952SSam Clegg         Import.SigIndex = getFunctionType(WS);
11956c899ba6SSam Clegg         Imports.push_back(Import);
1196492f7529SSam Clegg         assert(WasmIndices.count(&WS) == 0);
11976c899ba6SSam Clegg         WasmIndices[&WS] = NumFunctionImports++;
11986c899ba6SSam Clegg       } else if (WS.isGlobal()) {
119915f349f7SNicholas Wilson         if (WS.isWeak())
120015f349f7SNicholas Wilson           report_fatal_error("undefined global symbol cannot be weak");
120115f349f7SNicholas Wilson 
12026c899ba6SSam Clegg         wasm::WasmImport Import;
1203f726e445SDan Gohman         Import.Field = WS.getImportName();
120432ce5ca0SDan Gohman         Import.Kind = wasm::WASM_EXTERNAL_GLOBAL;
1205492f7529SSam Clegg         Import.Module = WS.getImportModule();
12066c899ba6SSam Clegg         Import.Global = WS.getGlobalType();
12076c899ba6SSam Clegg         Imports.push_back(Import);
1208492f7529SSam Clegg         assert(WasmIndices.count(&WS) == 0);
12096c899ba6SSam Clegg         WasmIndices[&WS] = NumGlobalImports++;
1210da419bdbSHeejin Ahn       } else if (WS.isEvent()) {
1211da419bdbSHeejin Ahn         if (WS.isWeak())
1212da419bdbSHeejin Ahn           report_fatal_error("undefined event symbol cannot be weak");
1213da419bdbSHeejin Ahn 
1214da419bdbSHeejin Ahn         wasm::WasmImport Import;
1215f726e445SDan Gohman         Import.Module = WS.getImportModule();
1216f726e445SDan Gohman         Import.Field = WS.getImportName();
1217da419bdbSHeejin Ahn         Import.Kind = wasm::WASM_EXTERNAL_EVENT;
1218da419bdbSHeejin Ahn         Import.Event.Attribute = wasm::WASM_EVENT_ATTRIBUTE_EXCEPTION;
1219da419bdbSHeejin Ahn         Import.Event.SigIndex = getEventType(WS);
1220da419bdbSHeejin Ahn         Imports.push_back(Import);
1221492f7529SSam Clegg         assert(WasmIndices.count(&WS) == 0);
1222da419bdbSHeejin Ahn         WasmIndices[&WS] = NumEventImports++;
122332ce5ca0SDan Gohman       }
122432ce5ca0SDan Gohman     }
122532ce5ca0SDan Gohman   }
122632ce5ca0SDan Gohman 
1227492f7529SSam Clegg   // Add imports for GOT globals
1228492f7529SSam Clegg   for (const MCSymbol &S : Asm.symbols()) {
1229492f7529SSam Clegg     const auto &WS = static_cast<const MCSymbolWasm &>(S);
1230492f7529SSam Clegg     if (WS.isUsedInGOT()) {
1231492f7529SSam Clegg       wasm::WasmImport Import;
1232492f7529SSam Clegg       if (WS.isFunction())
1233492f7529SSam Clegg         Import.Module = "GOT.func";
1234492f7529SSam Clegg       else
1235492f7529SSam Clegg         Import.Module = "GOT.mem";
1236492f7529SSam Clegg       Import.Field = WS.getName();
1237492f7529SSam Clegg       Import.Kind = wasm::WASM_EXTERNAL_GLOBAL;
1238492f7529SSam Clegg       Import.Global = {wasm::WASM_TYPE_I32, true};
1239492f7529SSam Clegg       Imports.push_back(Import);
1240492f7529SSam Clegg       assert(GOTIndices.count(&WS) == 0);
1241492f7529SSam Clegg       GOTIndices[&WS] = NumGlobalImports++;
1242492f7529SSam Clegg     }
1243492f7529SSam Clegg   }
1244492f7529SSam Clegg 
12454d57fbd0SSam Clegg   // Populate DataSegments and CustomSections, which must be done before
12464d57fbd0SSam Clegg   // populating DataLocations.
1247759631c7SSam Clegg   for (MCSection &Sec : Asm) {
1248759631c7SSam Clegg     auto &Section = static_cast<MCSectionWasm &>(Sec);
12494d57fbd0SSam Clegg     StringRef SectionName = Section.getSectionName();
1250759631c7SSam Clegg 
1251bafe6902SSam Clegg     // .init_array sections are handled specially elsewhere.
12524d57fbd0SSam Clegg     if (SectionName.startswith(".init_array"))
1253bafe6902SSam Clegg       continue;
1254bafe6902SSam Clegg 
12554d57fbd0SSam Clegg     // Code is handled separately
12564d57fbd0SSam Clegg     if (Section.getKind().isText())
12574d57fbd0SSam Clegg       continue;
12584d57fbd0SSam Clegg 
12594d57fbd0SSam Clegg     if (Section.isWasmData()) {
1260329e76d5SSam Clegg       uint32_t SegmentIndex = DataSegments.size();
1261759631c7SSam Clegg       DataSize = alignTo(DataSize, Section.getAlignment());
1262759631c7SSam Clegg       DataSegments.emplace_back();
1263759631c7SSam Clegg       WasmDataSegment &Segment = DataSegments.back();
12644d57fbd0SSam Clegg       Segment.Name = SectionName;
12659b49f36aSSimon Pilgrim       Segment.InitFlags =
12669b49f36aSSimon Pilgrim           Section.getPassive() ? (uint32_t)wasm::WASM_SEGMENT_IS_PASSIVE : 0;
1267759631c7SSam Clegg       Segment.Offset = DataSize;
1268759631c7SSam Clegg       Segment.Section = &Section;
126963ebb813SSam Clegg       addData(Segment.Data, Section);
127056c587adSSam Clegg       Segment.Alignment = Log2_32(Section.getAlignment());
12712e150409SThomas Lively       Segment.LinkerFlags = 0;
1272759631c7SSam Clegg       DataSize += Segment.Data.size();
12736c899ba6SSam Clegg       Section.setSegmentIndex(SegmentIndex);
1274ea7caceeSSam Clegg 
1275ea7caceeSSam Clegg       if (const MCSymbolWasm *C = Section.getGroup()) {
1276ea7caceeSSam Clegg         Comdats[C->getName()].emplace_back(
1277329e76d5SSam Clegg             WasmComdatEntry{wasm::WASM_COMDAT_DATA, SegmentIndex});
1278ea7caceeSSam Clegg       }
12794d57fbd0SSam Clegg     } else {
12804d57fbd0SSam Clegg       // Create custom sections
12814d57fbd0SSam Clegg       assert(Sec.getKind().isMetadata());
12824d57fbd0SSam Clegg 
12834d57fbd0SSam Clegg       StringRef Name = SectionName;
12844d57fbd0SSam Clegg 
12854d57fbd0SSam Clegg       // For user-defined custom sections, strip the prefix
12864d57fbd0SSam Clegg       if (Name.startswith(".custom_section."))
12874d57fbd0SSam Clegg         Name = Name.substr(strlen(".custom_section."));
12884d57fbd0SSam Clegg 
12894d57fbd0SSam Clegg       MCSymbol *Begin = Sec.getBeginSymbol();
1290fb807d4dSSam Clegg       if (Begin) {
12914d57fbd0SSam Clegg         WasmIndices[cast<MCSymbolWasm>(Begin)] = CustomSections.size();
1292b210c64bSSam Clegg         if (SectionName != Begin->getName())
1293fb807d4dSSam Clegg           report_fatal_error("section name and begin symbol should match: " +
1294b210c64bSSam Clegg                              Twine(SectionName));
1295fb807d4dSSam Clegg       }
1296cbda16ebSThomas Lively 
1297f6f4f843SThomas Lively       // Separate out the producers and target features sections
1298cbda16ebSThomas Lively       if (Name == "producers") {
1299*0eaee545SJonas Devlieghere         ProducersSection = std::make_unique<WasmCustomSection>(Name, &Section);
1300cbda16ebSThomas Lively         continue;
1301cbda16ebSThomas Lively       }
1302f6f4f843SThomas Lively       if (Name == "target_features") {
1303f6f4f843SThomas Lively         TargetFeaturesSection =
1304*0eaee545SJonas Devlieghere             std::make_unique<WasmCustomSection>(Name, &Section);
1305f6f4f843SThomas Lively         continue;
1306f6f4f843SThomas Lively       }
1307cbda16ebSThomas Lively 
13084d57fbd0SSam Clegg       CustomSections.emplace_back(Name, &Section);
1309759631c7SSam Clegg     }
13106a31a0d6SSam Clegg   }
13116a31a0d6SSam Clegg 
1312586320c0SNicholas Wilson   // Populate WasmIndices and DataLocations for defined symbols.
1313d934cb88SDan Gohman   for (const MCSymbol &S : Asm.symbols()) {
1314d934cb88SDan Gohman     // Ignore unnamed temporary symbols, which aren't ever exported, imported,
1315d934cb88SDan Gohman     // or used in relocations.
1316d934cb88SDan Gohman     if (S.isTemporary() && S.getName().empty())
1317d934cb88SDan Gohman       continue;
1318b7787fd0SSam Clegg 
1319d934cb88SDan Gohman     const auto &WS = static_cast<const MCSymbolWasm &>(S);
1320d34e60caSNicola Zaghen     LLVM_DEBUG(
1321d34e60caSNicola Zaghen         dbgs() << "MCSymbol: " << toString(WS.getType()) << " '" << S << "'"
1322d34e60caSNicola Zaghen                << " isDefined=" << S.isDefined() << " isExternal="
1323d34e60caSNicola Zaghen                << S.isExternal() << " isTemporary=" << S.isTemporary()
1324d34e60caSNicola Zaghen                << " isWeak=" << WS.isWeak() << " isHidden=" << WS.isHidden()
1325b7787fd0SSam Clegg                << " isVariable=" << WS.isVariable() << "\n");
1326b7787fd0SSam Clegg 
13275e3d33a7SSam Clegg     if (WS.isVariable())
13285e3d33a7SSam Clegg       continue;
13296c899ba6SSam Clegg     if (WS.isComdat() && !WS.isDefined())
13306c899ba6SSam Clegg       continue;
1331b7787fd0SSam Clegg 
1332d934cb88SDan Gohman     if (WS.isFunction()) {
13336c899ba6SSam Clegg       unsigned Index;
1334cd65f698SSam Clegg       if (WS.isDefined()) {
1335b7787fd0SSam Clegg         if (WS.getOffset() != 0)
1336b7787fd0SSam Clegg           report_fatal_error(
1337b7787fd0SSam Clegg               "function sections must contain one function each");
1338b7787fd0SSam Clegg 
133918c56a07SHeejin Ahn         if (WS.getSize() == nullptr)
1340b7787fd0SSam Clegg           report_fatal_error(
1341b7787fd0SSam Clegg               "function symbols must have a size set with .size");
1342b7787fd0SSam Clegg 
13436c899ba6SSam Clegg         // A definition. Write out the function body.
13449f3fe42eSSam Clegg         Index = NumFunctionImports + Functions.size();
1345d934cb88SDan Gohman         WasmFunction Func;
1346da419bdbSHeejin Ahn         Func.SigIndex = getFunctionType(WS);
1347d934cb88SDan Gohman         Func.Sym = &WS;
13486c899ba6SSam Clegg         WasmIndices[&WS] = Index;
1349d934cb88SDan Gohman         Functions.push_back(Func);
13506c899ba6SSam Clegg 
13516c899ba6SSam Clegg         auto &Section = static_cast<MCSectionWasm &>(WS.getSection());
13526c899ba6SSam Clegg         if (const MCSymbolWasm *C = Section.getGroup()) {
13536c899ba6SSam Clegg           Comdats[C->getName()].emplace_back(
13546c899ba6SSam Clegg               WasmComdatEntry{wasm::WASM_COMDAT_FUNCTION, Index});
13556c899ba6SSam Clegg         }
1356d934cb88SDan Gohman       } else {
1357d934cb88SDan Gohman         // An import; the index was assigned above.
13586c899ba6SSam Clegg         Index = WasmIndices.find(&WS)->second;
1359d934cb88SDan Gohman       }
1360d934cb88SDan Gohman 
1361d34e60caSNicola Zaghen       LLVM_DEBUG(dbgs() << "  -> function index: " << Index << "\n");
1362da419bdbSHeejin Ahn 
13636c899ba6SSam Clegg     } else if (WS.isData()) {
1364f3feb6adSWouter van Oortmerssen       if (!isInSymtab(WS))
1365c38e947eSSam Clegg         continue;
1366c38e947eSSam Clegg 
13676c899ba6SSam Clegg       if (!WS.isDefined()) {
1368d34e60caSNicola Zaghen         LLVM_DEBUG(dbgs() << "  -> segment index: -1"
1369d34e60caSNicola Zaghen                           << "\n");
1370fe6414b0SSam Clegg         continue;
13716c899ba6SSam Clegg       }
1372fe6414b0SSam Clegg 
1373d934cb88SDan Gohman       if (!WS.getSize())
1374c38e947eSSam Clegg         report_fatal_error("data symbols must have a size set with .size: " +
1375c38e947eSSam Clegg                            WS.getName());
1376d934cb88SDan Gohman 
1377d934cb88SDan Gohman       int64_t Size = 0;
1378d934cb88SDan Gohman       if (!WS.getSize()->evaluateAsAbsolute(Size, Layout))
1379d934cb88SDan Gohman         report_fatal_error(".size expression must be evaluatable");
1380d934cb88SDan Gohman 
1381759631c7SSam Clegg       auto &DataSection = static_cast<MCSectionWasm &>(WS.getSection());
1382ea7caceeSSam Clegg       assert(DataSection.isWasmData());
13837c395943SSam Clegg 
13846c899ba6SSam Clegg       // For each data symbol, export it in the symtab as a reference to the
13856c899ba6SSam Clegg       // corresponding Wasm data segment.
13866c899ba6SSam Clegg       wasm::WasmDataReference Ref = wasm::WasmDataReference{
13876c899ba6SSam Clegg           DataSection.getSegmentIndex(),
13886c899ba6SSam Clegg           static_cast<uint32_t>(Layout.getSymbolOffset(WS)),
13896c899ba6SSam Clegg           static_cast<uint32_t>(Size)};
13906c899ba6SSam Clegg       DataLocations[&WS] = Ref;
1391d34e60caSNicola Zaghen       LLVM_DEBUG(dbgs() << "  -> segment index: " << Ref.Segment << "\n");
1392da419bdbSHeejin Ahn 
1393a165f2d6SSam Clegg     } else if (WS.isGlobal()) {
13946c899ba6SSam Clegg       // A "true" Wasm global (currently just __stack_pointer)
1395545932beSEric Christopher       if (WS.isDefined())
13966c899ba6SSam Clegg         report_fatal_error("don't yet support defined globals");
13976c899ba6SSam Clegg 
1398545932beSEric Christopher       // An import; the index was assigned above
1399d34e60caSNicola Zaghen       LLVM_DEBUG(dbgs() << "  -> global index: "
1400d34e60caSNicola Zaghen                         << WasmIndices.find(&WS)->second << "\n");
1401da419bdbSHeejin Ahn 
1402da419bdbSHeejin Ahn     } else if (WS.isEvent()) {
1403da419bdbSHeejin Ahn       // C++ exception symbol (__cpp_exception)
1404da419bdbSHeejin Ahn       unsigned Index;
1405da419bdbSHeejin Ahn       if (WS.isDefined()) {
1406da419bdbSHeejin Ahn         Index = NumEventImports + Events.size();
1407da419bdbSHeejin Ahn         wasm::WasmEventType Event;
1408da419bdbSHeejin Ahn         Event.SigIndex = getEventType(WS);
1409da419bdbSHeejin Ahn         Event.Attribute = wasm::WASM_EVENT_ATTRIBUTE_EXCEPTION;
1410492f7529SSam Clegg         assert(WasmIndices.count(&WS) == 0);
1411da419bdbSHeejin Ahn         WasmIndices[&WS] = Index;
1412da419bdbSHeejin Ahn         Events.push_back(Event);
1413da419bdbSHeejin Ahn       } else {
1414da419bdbSHeejin Ahn         // An import; the index was assigned above.
1415492f7529SSam Clegg         assert(WasmIndices.count(&WS) > 0);
1416da419bdbSHeejin Ahn       }
1417da419bdbSHeejin Ahn       LLVM_DEBUG(dbgs() << "  -> event index: " << WasmIndices.find(&WS)->second
1418da419bdbSHeejin Ahn                         << "\n");
1419da419bdbSHeejin Ahn 
1420a165f2d6SSam Clegg     } else {
1421a165f2d6SSam Clegg       assert(WS.isSection());
1422d934cb88SDan Gohman     }
1423d934cb88SDan Gohman   }
1424d934cb88SDan Gohman 
1425586320c0SNicholas Wilson   // Populate WasmIndices and DataLocations for aliased symbols.  We need to
1426586320c0SNicholas Wilson   // process these in a separate pass because we need to have processed the
1427586320c0SNicholas Wilson   // target of the alias before the alias itself and the symbols are not
1428586320c0SNicholas Wilson   // necessarily ordered in this way.
1429b7787fd0SSam Clegg   for (const MCSymbol &S : Asm.symbols()) {
1430b7787fd0SSam Clegg     if (!S.isVariable())
1431b7787fd0SSam Clegg       continue;
143231a2c809SSam Clegg 
1433cd65f698SSam Clegg     assert(S.isDefined());
1434b7787fd0SSam Clegg 
14355e3d33a7SSam Clegg     // Find the target symbol of this weak alias and export that index
1436aff1c4dfSSam Clegg     const auto &WS = static_cast<const MCSymbolWasm &>(S);
143718c56a07SHeejin Ahn     const MCSymbolWasm *ResolvedSym = resolveSymbol(WS);
1438d34e60caSNicola Zaghen     LLVM_DEBUG(dbgs() << WS.getName() << ": weak alias of '" << *ResolvedSym
1439d34e60caSNicola Zaghen                       << "'\n");
1440b7787fd0SSam Clegg 
1441ffba00bdSSam Clegg     if (ResolvedSym->isFunction()) {
14426c899ba6SSam Clegg       assert(WasmIndices.count(ResolvedSym) > 0);
14436c899ba6SSam Clegg       uint32_t WasmIndex = WasmIndices.find(ResolvedSym)->second;
1444492f7529SSam Clegg       assert(WasmIndices.count(&WS) == 0);
14456c899ba6SSam Clegg       WasmIndices[&WS] = WasmIndex;
1446d34e60caSNicola Zaghen       LLVM_DEBUG(dbgs() << "  -> index:" << WasmIndex << "\n");
1447ffba00bdSSam Clegg     } else if (ResolvedSym->isData()) {
14486c899ba6SSam Clegg       assert(DataLocations.count(ResolvedSym) > 0);
14496c899ba6SSam Clegg       const wasm::WasmDataReference &Ref =
14506c899ba6SSam Clegg           DataLocations.find(ResolvedSym)->second;
14516c899ba6SSam Clegg       DataLocations[&WS] = Ref;
1452d34e60caSNicola Zaghen       LLVM_DEBUG(dbgs() << "  -> index:" << Ref.Segment << "\n");
14536c899ba6SSam Clegg     } else {
1454da419bdbSHeejin Ahn       report_fatal_error("don't yet support global/event aliases");
14556c899ba6SSam Clegg     }
1456586320c0SNicholas Wilson   }
145731a2c809SSam Clegg 
1458586320c0SNicholas Wilson   // Finally, populate the symbol table itself, in its "natural" order.
1459586320c0SNicholas Wilson   for (const MCSymbol &S : Asm.symbols()) {
1460586320c0SNicholas Wilson     const auto &WS = static_cast<const MCSymbolWasm &>(S);
146125d8e68bSSam Clegg     if (!isInSymtab(WS)) {
146218c56a07SHeejin Ahn       WS.setIndex(InvalidIndex);
1463586320c0SNicholas Wilson       continue;
146425d8e68bSSam Clegg     }
1465d34e60caSNicola Zaghen     LLVM_DEBUG(dbgs() << "adding to symtab: " << WS << "\n");
1466586320c0SNicholas Wilson 
1467586320c0SNicholas Wilson     uint32_t Flags = 0;
1468586320c0SNicholas Wilson     if (WS.isWeak())
1469586320c0SNicholas Wilson       Flags |= wasm::WASM_SYMBOL_BINDING_WEAK;
1470586320c0SNicholas Wilson     if (WS.isHidden())
1471586320c0SNicholas Wilson       Flags |= wasm::WASM_SYMBOL_VISIBILITY_HIDDEN;
1472586320c0SNicholas Wilson     if (!WS.isExternal() && WS.isDefined())
1473586320c0SNicholas Wilson       Flags |= wasm::WASM_SYMBOL_BINDING_LOCAL;
1474586320c0SNicholas Wilson     if (WS.isUndefined())
1475586320c0SNicholas Wilson       Flags |= wasm::WASM_SYMBOL_UNDEFINED;
1476d6ef8da3SSam Clegg     if (WS.isExported())
1477d6ef8da3SSam Clegg       Flags |= wasm::WASM_SYMBOL_EXPORTED;
147829874ceaSDan Gohman     if (WS.getName() != WS.getImportName())
147929874ceaSDan Gohman       Flags |= wasm::WASM_SYMBOL_EXPLICIT_NAME;
1480586320c0SNicholas Wilson 
1481586320c0SNicholas Wilson     wasm::WasmSymbolInfo Info;
1482586320c0SNicholas Wilson     Info.Name = WS.getName();
1483586320c0SNicholas Wilson     Info.Kind = WS.getType();
1484586320c0SNicholas Wilson     Info.Flags = Flags;
14854d57fbd0SSam Clegg     if (!WS.isData()) {
14864d57fbd0SSam Clegg       assert(WasmIndices.count(&WS) > 0);
1487586320c0SNicholas Wilson       Info.ElementIndex = WasmIndices.find(&WS)->second;
14884d57fbd0SSam Clegg     } else if (WS.isDefined()) {
14894d57fbd0SSam Clegg       assert(DataLocations.count(&WS) > 0);
1490586320c0SNicholas Wilson       Info.DataRef = DataLocations.find(&WS)->second;
14914d57fbd0SSam Clegg     }
149225d8e68bSSam Clegg     WS.setIndex(SymbolInfos.size());
1493586320c0SNicholas Wilson     SymbolInfos.emplace_back(Info);
1494b7787fd0SSam Clegg   }
1495b7787fd0SSam Clegg 
14966006e091SSam Clegg   {
14976006e091SSam Clegg     auto HandleReloc = [&](const WasmRelocationEntry &Rel) {
1498f9edbe95SSam Clegg       // Functions referenced by a relocation need to put in the table.  This is
1499f9edbe95SSam Clegg       // purely to make the object file's provisional values readable, and is
1500f9edbe95SSam Clegg       // ignored by the linker, which re-calculates the relocations itself.
1501d1152a26SSam Clegg       if (Rel.Type != wasm::R_WASM_TABLE_INDEX_I32 &&
1502d1152a26SSam Clegg           Rel.Type != wasm::R_WASM_TABLE_INDEX_SLEB)
1503f9edbe95SSam Clegg         return;
1504f9edbe95SSam Clegg       assert(Rel.Symbol->isFunction());
150518c56a07SHeejin Ahn       const MCSymbolWasm &WS = *resolveSymbol(*Rel.Symbol);
15066c899ba6SSam Clegg       uint32_t FunctionIndex = WasmIndices.find(&WS)->second;
150718c56a07SHeejin Ahn       uint32_t TableIndex = TableElems.size() + InitialTableOffset;
1508f9edbe95SSam Clegg       if (TableIndices.try_emplace(&WS, TableIndex).second) {
1509d34e60caSNicola Zaghen         LLVM_DEBUG(dbgs() << "  -> adding " << WS.getName()
1510f9edbe95SSam Clegg                           << " to table: " << TableIndex << "\n");
15116c899ba6SSam Clegg         TableElems.push_back(FunctionIndex);
15126006e091SSam Clegg         registerFunctionType(WS);
15136006e091SSam Clegg       }
15146006e091SSam Clegg     };
1515970d02c4SDan Gohman 
15166006e091SSam Clegg     for (const WasmRelocationEntry &RelEntry : CodeRelocations)
15176006e091SSam Clegg       HandleReloc(RelEntry);
15186006e091SSam Clegg     for (const WasmRelocationEntry &RelEntry : DataRelocations)
15196006e091SSam Clegg       HandleReloc(RelEntry);
1520d934cb88SDan Gohman   }
1521d934cb88SDan Gohman 
1522bafe6902SSam Clegg   // Translate .init_array section contents into start functions.
1523bafe6902SSam Clegg   for (const MCSection &S : Asm) {
1524bafe6902SSam Clegg     const auto &WS = static_cast<const MCSectionWasm &>(S);
1525bafe6902SSam Clegg     if (WS.getSectionName().startswith(".fini_array"))
1526bafe6902SSam Clegg       report_fatal_error(".fini_array sections are unsupported");
1527bafe6902SSam Clegg     if (!WS.getSectionName().startswith(".init_array"))
1528bafe6902SSam Clegg       continue;
1529bafe6902SSam Clegg     if (WS.getFragmentList().empty())
1530bafe6902SSam Clegg       continue;
1531b210c64bSSam Clegg 
1532b210c64bSSam Clegg     // init_array is expected to contain a single non-empty data fragment
1533b210c64bSSam Clegg     if (WS.getFragmentList().size() != 3)
1534bafe6902SSam Clegg       report_fatal_error("only one .init_array section fragment supported");
1535b210c64bSSam Clegg 
1536b210c64bSSam Clegg     auto IT = WS.begin();
1537b210c64bSSam Clegg     const MCFragment &EmptyFrag = *IT;
1538b210c64bSSam Clegg     if (EmptyFrag.getKind() != MCFragment::FT_Data)
1539b210c64bSSam Clegg       report_fatal_error(".init_array section should be aligned");
1540b210c64bSSam Clegg 
1541b210c64bSSam Clegg     IT = std::next(IT);
1542b210c64bSSam Clegg     const MCFragment &AlignFrag = *IT;
1543bafe6902SSam Clegg     if (AlignFrag.getKind() != MCFragment::FT_Align)
1544bafe6902SSam Clegg       report_fatal_error(".init_array section should be aligned");
1545bafe6902SSam Clegg     if (cast<MCAlignFragment>(AlignFrag).getAlignment() != (is64Bit() ? 8 : 4))
1546bafe6902SSam Clegg       report_fatal_error(".init_array section should be aligned for pointers");
1547b210c64bSSam Clegg 
1548b210c64bSSam Clegg     const MCFragment &Frag = *std::next(IT);
1549bafe6902SSam Clegg     if (Frag.hasInstructions() || Frag.getKind() != MCFragment::FT_Data)
1550bafe6902SSam Clegg       report_fatal_error("only data supported in .init_array section");
1551b210c64bSSam Clegg 
1552bafe6902SSam Clegg     uint16_t Priority = UINT16_MAX;
15534d57fbd0SSam Clegg     unsigned PrefixLength = strlen(".init_array");
15544d57fbd0SSam Clegg     if (WS.getSectionName().size() > PrefixLength) {
15554d57fbd0SSam Clegg       if (WS.getSectionName()[PrefixLength] != '.')
1556f208f631SHeejin Ahn         report_fatal_error(
1557f208f631SHeejin Ahn             ".init_array section priority should start with '.'");
15584d57fbd0SSam Clegg       if (WS.getSectionName()
15594d57fbd0SSam Clegg               .substr(PrefixLength + 1)
15604d57fbd0SSam Clegg               .getAsInteger(10, Priority))
1561bafe6902SSam Clegg         report_fatal_error("invalid .init_array section priority");
1562bafe6902SSam Clegg     }
1563bafe6902SSam Clegg     const auto &DataFrag = cast<MCDataFragment>(Frag);
1564bafe6902SSam Clegg     const SmallVectorImpl<char> &Contents = DataFrag.getContents();
1565f208f631SHeejin Ahn     for (const uint8_t *
156618c56a07SHeejin Ahn              P = (const uint8_t *)Contents.data(),
156718c56a07SHeejin Ahn             *End = (const uint8_t *)Contents.data() + Contents.size();
156818c56a07SHeejin Ahn          P != End; ++P) {
156918c56a07SHeejin Ahn       if (*P != 0)
1570bafe6902SSam Clegg         report_fatal_error("non-symbolic data in .init_array section");
1571bafe6902SSam Clegg     }
1572bafe6902SSam Clegg     for (const MCFixup &Fixup : DataFrag.getFixups()) {
1573f208f631SHeejin Ahn       assert(Fixup.getKind() ==
1574f208f631SHeejin Ahn              MCFixup::getKindForSize(is64Bit() ? 8 : 4, false));
1575bafe6902SSam Clegg       const MCExpr *Expr = Fixup.getValue();
15768fffa1dfSSam Clegg       auto *SymRef = dyn_cast<MCSymbolRefExpr>(Expr);
15778fffa1dfSSam Clegg       if (!SymRef)
1578bafe6902SSam Clegg         report_fatal_error("fixups in .init_array should be symbol references");
15798fffa1dfSSam Clegg       const auto &TargetSym = cast<const MCSymbolWasm>(SymRef->getSymbol());
15808fffa1dfSSam Clegg       if (TargetSym.getIndex() == InvalidIndex)
158125d8e68bSSam Clegg         report_fatal_error("symbols in .init_array should exist in symbtab");
15828fffa1dfSSam Clegg       if (!TargetSym.isFunction())
15838fffa1dfSSam Clegg         report_fatal_error("symbols in .init_array should be for functions");
158425d8e68bSSam Clegg       InitFuncs.push_back(
15858fffa1dfSSam Clegg           std::make_pair(Priority, TargetSym.getIndex()));
1586bafe6902SSam Clegg     }
1587bafe6902SSam Clegg   }
1588bafe6902SSam Clegg 
158918eafb6cSDan Gohman   // Write out the Wasm header.
159018eafb6cSDan Gohman   writeHeader(Asm);
159118eafb6cSDan Gohman 
1592da419bdbSHeejin Ahn   writeTypeSection(Signatures);
1593f950b24aSSam Clegg   writeImportSection(Imports, DataSize, TableElems.size());
15949e15f359SSam Clegg   writeFunctionSection(Functions);
1595f950b24aSSam Clegg   // Skip the "table" section; we import the table instead.
1596f950b24aSSam Clegg   // Skip the "memory" section; we import the memory instead.
1597da419bdbSHeejin Ahn   writeEventSection(Events);
15989e15f359SSam Clegg   writeExportSection(Exports);
15999e15f359SSam Clegg   writeElemSection(TableElems);
1600fef8de66SThomas Lively   writeDataCountSection();
1601acd7d2b0SSam Clegg   writeCodeSection(Asm, Layout, Functions);
16026c899ba6SSam Clegg   writeDataSection();
1603cbda16ebSThomas Lively   for (auto &CustomSection : CustomSections)
1604cbda16ebSThomas Lively     writeCustomSection(CustomSection, Asm, Layout);
1605c22bfb6bSNicholas Wilson   writeLinkingMetaDataSection(SymbolInfos, InitFuncs, Comdats);
16066f08c84aSSam Clegg   writeRelocSection(CodeSectionIndex, "CODE", CodeRelocations);
16076f08c84aSSam Clegg   writeRelocSection(DataSectionIndex, "DATA", DataRelocations);
16086a31a0d6SSam Clegg   writeCustomRelocSections();
1609cbda16ebSThomas Lively   if (ProducersSection)
1610cbda16ebSThomas Lively     writeCustomSection(*ProducersSection, Asm, Layout);
1611f6f4f843SThomas Lively   if (TargetFeaturesSection)
1612f6f4f843SThomas Lively     writeCustomSection(*TargetFeaturesSection, Asm, Layout);
1613970d02c4SDan Gohman 
1614d934cb88SDan Gohman   // TODO: Translate the .comment section to the output.
1615438390faSPeter Collingbourne   return W.OS.tell() - StartOffset;
161618eafb6cSDan Gohman }
161718eafb6cSDan Gohman 
161860fbc7ccSLang Hames std::unique_ptr<MCObjectWriter>
16191301a878SLang Hames llvm::createWasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW,
162018eafb6cSDan Gohman                              raw_pwrite_stream &OS) {
1621*0eaee545SJonas Devlieghere   return std::make_unique<WasmObjectWriter>(std::move(MOTW), OS);
162218eafb6cSDan Gohman }
1623