118eafb6cSDan Gohman //===- lib/MC/WasmObjectWriter.cpp - Wasm File Writer ---------------------===//
218eafb6cSDan Gohman //
318eafb6cSDan Gohman //                     The LLVM Compiler Infrastructure
418eafb6cSDan Gohman //
518eafb6cSDan Gohman // This file is distributed under the University of Illinois Open Source
618eafb6cSDan Gohman // License. See LICENSE.TXT for details.
718eafb6cSDan Gohman //
818eafb6cSDan Gohman //===----------------------------------------------------------------------===//
918eafb6cSDan Gohman //
1018eafb6cSDan Gohman // This file implements Wasm object file writer information.
1118eafb6cSDan Gohman //
1218eafb6cSDan Gohman //===----------------------------------------------------------------------===//
1318eafb6cSDan Gohman 
1418eafb6cSDan Gohman #include "llvm/ADT/STLExtras.h"
1518eafb6cSDan Gohman #include "llvm/ADT/SmallPtrSet.h"
16264b5d9eSZachary Turner #include "llvm/BinaryFormat/Wasm.h"
17432a3883SNico Weber #include "llvm/Config/llvm-config.h"
1818eafb6cSDan Gohman #include "llvm/MC/MCAsmBackend.h"
1918eafb6cSDan Gohman #include "llvm/MC/MCAsmLayout.h"
2018eafb6cSDan Gohman #include "llvm/MC/MCAssembler.h"
2118eafb6cSDan Gohman #include "llvm/MC/MCContext.h"
2218eafb6cSDan Gohman #include "llvm/MC/MCExpr.h"
2318eafb6cSDan Gohman #include "llvm/MC/MCFixupKindInfo.h"
2418eafb6cSDan Gohman #include "llvm/MC/MCObjectWriter.h"
2518eafb6cSDan Gohman #include "llvm/MC/MCSectionWasm.h"
2618eafb6cSDan Gohman #include "llvm/MC/MCSymbolWasm.h"
2718eafb6cSDan Gohman #include "llvm/MC/MCValue.h"
2818eafb6cSDan Gohman #include "llvm/MC/MCWasmObjectWriter.h"
29d934cb88SDan Gohman #include "llvm/Support/Casting.h"
3018eafb6cSDan Gohman #include "llvm/Support/Debug.h"
3118eafb6cSDan Gohman #include "llvm/Support/ErrorHandling.h"
32d934cb88SDan Gohman #include "llvm/Support/LEB128.h"
3318eafb6cSDan Gohman #include "llvm/Support/StringSaver.h"
3418eafb6cSDan Gohman #include <vector>
3518eafb6cSDan Gohman 
3618eafb6cSDan Gohman using namespace llvm;
3718eafb6cSDan Gohman 
385e3d33a7SSam Clegg #define DEBUG_TYPE "mc"
3918eafb6cSDan Gohman 
4018eafb6cSDan Gohman namespace {
419e15f359SSam Clegg 
4230e1bbc1SSam Clegg // Went we ceate the indirect function table we start at 1, so that there is
4330e1bbc1SSam Clegg // and emtpy slot at 0 and therefore calling a null function pointer will trap.
4430e1bbc1SSam Clegg static const uint32_t kInitialTableOffset = 1;
4530e1bbc1SSam Clegg 
46d934cb88SDan Gohman // For patching purposes, we need to remember where each section starts, both
47d934cb88SDan Gohman // for patching up the section size field, and for patching up references to
48d934cb88SDan Gohman // locations within the section.
49d934cb88SDan Gohman struct SectionBookkeeping {
50d934cb88SDan Gohman   // Where the size of the section is written.
51d934cb88SDan Gohman   uint64_t SizeOffset;
526a31a0d6SSam Clegg   // Where the section header ends (without custom section name).
536a31a0d6SSam Clegg   uint64_t PayloadOffset;
546a31a0d6SSam Clegg   // Where the contents of the section starts.
55d934cb88SDan Gohman   uint64_t ContentsOffset;
566f08c84aSSam Clegg   uint32_t Index;
57d934cb88SDan Gohman };
58d934cb88SDan Gohman 
59da419bdbSHeejin Ahn // The signature of a wasm function or event, in a struct capable of being used
60da419bdbSHeejin Ahn // as a DenseMap key.
61da419bdbSHeejin Ahn // TODO: Consider using wasm::WasmSignature directly instead.
62da419bdbSHeejin Ahn struct WasmSignature {
639e15f359SSam Clegg   // Support empty and tombstone instances, needed by DenseMap.
649e15f359SSam Clegg   enum { Plain, Empty, Tombstone } State;
659e15f359SSam Clegg 
669e15f359SSam Clegg   // The return types of the function.
679e15f359SSam Clegg   SmallVector<wasm::ValType, 1> Returns;
689e15f359SSam Clegg 
699e15f359SSam Clegg   // The parameter types of the function.
709e15f359SSam Clegg   SmallVector<wasm::ValType, 4> Params;
719e15f359SSam Clegg 
72da419bdbSHeejin Ahn   WasmSignature() : State(Plain) {}
739e15f359SSam Clegg 
74da419bdbSHeejin Ahn   bool operator==(const WasmSignature &Other) const {
759e15f359SSam Clegg     return State == Other.State && Returns == Other.Returns &&
769e15f359SSam Clegg            Params == Other.Params;
779e15f359SSam Clegg   }
789e15f359SSam Clegg };
799e15f359SSam Clegg 
80da419bdbSHeejin Ahn // Traits for using WasmSignature in a DenseMap.
81da419bdbSHeejin Ahn struct WasmSignatureDenseMapInfo {
82da419bdbSHeejin Ahn   static WasmSignature getEmptyKey() {
83da419bdbSHeejin Ahn     WasmSignature Sig;
84da419bdbSHeejin Ahn     Sig.State = WasmSignature::Empty;
85da419bdbSHeejin Ahn     return Sig;
869e15f359SSam Clegg   }
87da419bdbSHeejin Ahn   static WasmSignature getTombstoneKey() {
88da419bdbSHeejin Ahn     WasmSignature Sig;
89da419bdbSHeejin Ahn     Sig.State = WasmSignature::Tombstone;
90da419bdbSHeejin Ahn     return Sig;
919e15f359SSam Clegg   }
92da419bdbSHeejin Ahn   static unsigned getHashValue(const WasmSignature &Sig) {
93da419bdbSHeejin Ahn     uintptr_t Value = Sig.State;
94da419bdbSHeejin Ahn     for (wasm::ValType Ret : Sig.Returns)
954808914aSHeejin Ahn       Value += DenseMapInfo<uint32_t>::getHashValue(uint32_t(Ret));
96da419bdbSHeejin Ahn     for (wasm::ValType Param : Sig.Params)
974808914aSHeejin Ahn       Value += DenseMapInfo<uint32_t>::getHashValue(uint32_t(Param));
989e15f359SSam Clegg     return Value;
999e15f359SSam Clegg   }
100da419bdbSHeejin Ahn   static bool isEqual(const WasmSignature &LHS, const WasmSignature &RHS) {
1019e15f359SSam Clegg     return LHS == RHS;
1029e15f359SSam Clegg   }
1039e15f359SSam Clegg };
1049e15f359SSam Clegg 
1057c395943SSam Clegg // A wasm data segment.  A wasm binary contains only a single data section
1067c395943SSam Clegg // but that can contain many segments, each with their own virtual location
1077c395943SSam Clegg // in memory.  Each MCSection data created by llvm is modeled as its own
1087c395943SSam Clegg // wasm data segment.
1097c395943SSam Clegg struct WasmDataSegment {
1107c395943SSam Clegg   MCSectionWasm *Section;
111d95ed959SSam Clegg   StringRef Name;
1127c395943SSam Clegg   uint32_t Offset;
11363ebb813SSam Clegg   uint32_t Alignment;
11463ebb813SSam Clegg   uint32_t Flags;
1157c395943SSam Clegg   SmallVector<char, 4> Data;
1167c395943SSam Clegg };
1177c395943SSam Clegg 
1189e15f359SSam Clegg // A wasm function to be written into the function section.
1199e15f359SSam Clegg struct WasmFunction {
120da419bdbSHeejin Ahn   uint32_t SigIndex;
1219e15f359SSam Clegg   const MCSymbolWasm *Sym;
1229e15f359SSam Clegg };
1239e15f359SSam Clegg 
1249e15f359SSam Clegg // A wasm global to be written into the global section.
1259e15f359SSam Clegg struct WasmGlobal {
1266e7f1826SSam Clegg   wasm::WasmGlobalType Type;
1279e15f359SSam Clegg   uint64_t InitialValue;
1289e15f359SSam Clegg };
1299e15f359SSam Clegg 
130ea7caceeSSam Clegg // Information about a single item which is part of a COMDAT.  For each data
131ea7caceeSSam Clegg // segment or function which is in the COMDAT, there is a corresponding
132ea7caceeSSam Clegg // WasmComdatEntry.
133ea7caceeSSam Clegg struct WasmComdatEntry {
134ea7caceeSSam Clegg   unsigned Kind;
135ea7caceeSSam Clegg   uint32_t Index;
136ea7caceeSSam Clegg };
137ea7caceeSSam Clegg 
1386dc65e91SSam Clegg // Information about a single relocation.
1396dc65e91SSam Clegg struct WasmRelocationEntry {
1406dc65e91SSam Clegg   uint64_t Offset;                   // Where is the relocation.
1416dc65e91SSam Clegg   const MCSymbolWasm *Symbol;        // The symbol to relocate with.
1426dc65e91SSam Clegg   int64_t Addend;                    // A value to add to the symbol.
1436dc65e91SSam Clegg   unsigned Type;                     // The type of the relocation.
144fe6414b0SSam Clegg   const MCSectionWasm *FixupSection; // The section the relocation is targeting.
1456dc65e91SSam Clegg 
1466dc65e91SSam Clegg   WasmRelocationEntry(uint64_t Offset, const MCSymbolWasm *Symbol,
1476dc65e91SSam Clegg                       int64_t Addend, unsigned Type,
148fe6414b0SSam Clegg                       const MCSectionWasm *FixupSection)
1496dc65e91SSam Clegg       : Offset(Offset), Symbol(Symbol), Addend(Addend), Type(Type),
1506dc65e91SSam Clegg         FixupSection(FixupSection) {}
1516dc65e91SSam Clegg 
152acd7d2b0SSam Clegg   bool hasAddend() const {
153acd7d2b0SSam Clegg     switch (Type) {
15413a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB:
15513a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB:
15613a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32:
1576a31a0d6SSam Clegg     case wasm::R_WEBASSEMBLY_FUNCTION_OFFSET_I32:
1586a31a0d6SSam Clegg     case wasm::R_WEBASSEMBLY_SECTION_OFFSET_I32:
159acd7d2b0SSam Clegg       return true;
160acd7d2b0SSam Clegg     default:
161acd7d2b0SSam Clegg       return false;
162acd7d2b0SSam Clegg     }
163acd7d2b0SSam Clegg   }
164acd7d2b0SSam Clegg 
1656dc65e91SSam Clegg   void print(raw_ostream &Out) const {
166f208f631SHeejin Ahn     Out << wasm::relocTypetoString(Type) << " Off=" << Offset
167f208f631SHeejin Ahn         << ", Sym=" << *Symbol << ", Addend=" << Addend
168759631c7SSam Clegg         << ", FixupSection=" << FixupSection->getSectionName();
1696dc65e91SSam Clegg   }
170b7787fd0SSam Clegg 
171615eb470SAaron Ballman #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
172b7787fd0SSam Clegg   LLVM_DUMP_METHOD void dump() const { print(dbgs()); }
173b7787fd0SSam Clegg #endif
1746dc65e91SSam Clegg };
1756dc65e91SSam Clegg 
17625d8e68bSSam Clegg static const uint32_t INVALID_INDEX = -1;
17725d8e68bSSam Clegg 
178cfd44a2eSSam Clegg struct WasmCustomSection {
179cfd44a2eSSam Clegg 
1806a31a0d6SSam Clegg   StringRef Name;
1816a31a0d6SSam Clegg   MCSectionWasm *Section;
1826a31a0d6SSam Clegg 
1836a31a0d6SSam Clegg   uint32_t OutputContentsOffset;
1846a31a0d6SSam Clegg   uint32_t OutputIndex;
1856a31a0d6SSam Clegg 
1866a31a0d6SSam Clegg   WasmCustomSection(StringRef Name, MCSectionWasm *Section)
1876a31a0d6SSam Clegg       : Name(Name), Section(Section), OutputContentsOffset(0),
1886a31a0d6SSam Clegg         OutputIndex(INVALID_INDEX) {}
189cfd44a2eSSam Clegg };
190cfd44a2eSSam Clegg 
1911fb8daa6SSam Clegg #if !defined(NDEBUG)
1927f055deeSSam Clegg raw_ostream &operator<<(raw_ostream &OS, const WasmRelocationEntry &Rel) {
193b7787fd0SSam Clegg   Rel.print(OS);
194b7787fd0SSam Clegg   return OS;
195b7787fd0SSam Clegg }
1961fb8daa6SSam Clegg #endif
197b7787fd0SSam Clegg 
19818eafb6cSDan Gohman class WasmObjectWriter : public MCObjectWriter {
199f17b149dSPeter Collingbourne   support::endian::Writer W;
200f17b149dSPeter Collingbourne 
20118eafb6cSDan Gohman   /// The target specific Wasm writer instance.
20218eafb6cSDan Gohman   std::unique_ptr<MCWasmObjectTargetWriter> TargetObjectWriter;
20318eafb6cSDan Gohman 
204d934cb88SDan Gohman   // Relocations for fixing up references in the code section.
205d934cb88SDan Gohman   std::vector<WasmRelocationEntry> CodeRelocations;
2066f08c84aSSam Clegg   uint32_t CodeSectionIndex;
207d934cb88SDan Gohman 
208d934cb88SDan Gohman   // Relocations for fixing up references in the data section.
209d934cb88SDan Gohman   std::vector<WasmRelocationEntry> DataRelocations;
2106f08c84aSSam Clegg   uint32_t DataSectionIndex;
211d934cb88SDan Gohman 
212d934cb88SDan Gohman   // Index values to use for fixing up call_indirect type indices.
213acd7d2b0SSam Clegg   // Maps function symbols to the index of the type of the function
214acd7d2b0SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> TypeIndices;
215d99f6078SSam Clegg   // Maps function symbols to the table element index space. Used
216d99f6078SSam Clegg   // for TABLE_INDEX relocation types (i.e. address taken functions).
217f9edbe95SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> TableIndices;
218da419bdbSHeejin Ahn   // Maps function/global symbols to the function/global/event/section index
219da419bdbSHeejin Ahn   // space.
2206c899ba6SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> WasmIndices;
2216c899ba6SSam Clegg   // Maps data symbols to the Wasm segment and offset/size with the segment.
2226c899ba6SSam Clegg   DenseMap<const MCSymbolWasm *, wasm::WasmDataReference> DataLocations;
2236a31a0d6SSam Clegg 
2246a31a0d6SSam Clegg   // Stores output data (index, relocations, content offset) for custom
2256a31a0d6SSam Clegg   // section.
2266a31a0d6SSam Clegg   std::vector<WasmCustomSection> CustomSections;
2276a31a0d6SSam Clegg   // Relocations for fixing up references in the custom sections.
2286a31a0d6SSam Clegg   DenseMap<const MCSectionWasm *, std::vector<WasmRelocationEntry>>
2296a31a0d6SSam Clegg       CustomSectionsRelocations;
230acd7d2b0SSam Clegg 
231c0d41195SSam Clegg   // Map from section to defining function symbol.
2326ccb59b3SSam Clegg   DenseMap<const MCSection *, const MCSymbol *> SectionFunctions;
2336ccb59b3SSam Clegg 
234da419bdbSHeejin Ahn   DenseMap<WasmSignature, uint32_t, WasmSignatureDenseMapInfo> SignatureIndices;
235da419bdbSHeejin Ahn   SmallVector<WasmSignature, 4> Signatures;
2367c395943SSam Clegg   SmallVector<WasmGlobal, 4> Globals;
2376c899ba6SSam Clegg   SmallVector<WasmDataSegment, 4> DataSegments;
2389f3fe42eSSam Clegg   unsigned NumFunctionImports = 0;
2397c395943SSam Clegg   unsigned NumGlobalImports = 0;
240da419bdbSHeejin Ahn   unsigned NumEventImports = 0;
2417e1c3345SChandler Carruth   uint32_t SectionCount = 0;
242d934cb88SDan Gohman 
24318eafb6cSDan Gohman   // TargetObjectWriter wrappers.
24418eafb6cSDan Gohman   bool is64Bit() const { return TargetObjectWriter->is64Bit(); }
245ae03c1e7SSam Clegg   unsigned getRelocType(const MCValue &Target, const MCFixup &Fixup) const {
246ae03c1e7SSam Clegg     return TargetObjectWriter->getRelocType(Target, Fixup);
24718eafb6cSDan Gohman   }
24818eafb6cSDan Gohman 
2492322a937SSam Clegg   void startSection(SectionBookkeeping &Section, unsigned SectionId);
2502322a937SSam Clegg   void startCustomSection(SectionBookkeeping &Section, StringRef Name);
251d934cb88SDan Gohman   void endSection(SectionBookkeeping &Section);
252d934cb88SDan Gohman 
25318eafb6cSDan Gohman public:
2541301a878SLang Hames   WasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW,
2551301a878SLang Hames                    raw_pwrite_stream &OS)
25659a6fc46SPeter Collingbourne       : W(OS, support::little), TargetObjectWriter(std::move(MOTW)) {}
25718eafb6cSDan Gohman 
25818eafb6cSDan Gohman   ~WasmObjectWriter() override;
25918eafb6cSDan Gohman 
2600917c9e4SDan Gohman private:
261acd7d2b0SSam Clegg   void reset() override {
262acd7d2b0SSam Clegg     CodeRelocations.clear();
263acd7d2b0SSam Clegg     DataRelocations.clear();
264acd7d2b0SSam Clegg     TypeIndices.clear();
2656c899ba6SSam Clegg     WasmIndices.clear();
266f9edbe95SSam Clegg     TableIndices.clear();
2676c899ba6SSam Clegg     DataLocations.clear();
2686a31a0d6SSam Clegg     CustomSectionsRelocations.clear();
269da419bdbSHeejin Ahn     SignatureIndices.clear();
270da419bdbSHeejin Ahn     Signatures.clear();
2717c395943SSam Clegg     Globals.clear();
2726c899ba6SSam Clegg     DataSegments.clear();
2736ccb59b3SSam Clegg     SectionFunctions.clear();
2749f3fe42eSSam Clegg     NumFunctionImports = 0;
2757c395943SSam Clegg     NumGlobalImports = 0;
276105bdc25SSam Clegg     MCObjectWriter::reset();
277acd7d2b0SSam Clegg   }
278acd7d2b0SSam Clegg 
27918eafb6cSDan Gohman   void writeHeader(const MCAssembler &Asm);
28018eafb6cSDan Gohman 
28118eafb6cSDan Gohman   void recordRelocation(MCAssembler &Asm, const MCAsmLayout &Layout,
28218eafb6cSDan Gohman                         const MCFragment *Fragment, const MCFixup &Fixup,
283ceecfe5bSRafael Espindola                         MCValue Target, uint64_t &FixedValue) override;
28418eafb6cSDan Gohman 
28518eafb6cSDan Gohman   void executePostLayoutBinding(MCAssembler &Asm,
28618eafb6cSDan Gohman                                 const MCAsmLayout &Layout) override;
28718eafb6cSDan Gohman 
288438390faSPeter Collingbourne   uint64_t writeObject(MCAssembler &Asm, const MCAsmLayout &Layout) override;
2899e15f359SSam Clegg 
290b7787fd0SSam Clegg   void writeString(const StringRef Str) {
291f17b149dSPeter Collingbourne     encodeULEB128(Str.size(), W.OS);
292f17b149dSPeter Collingbourne     W.OS << Str;
293b7787fd0SSam Clegg   }
294b7787fd0SSam Clegg 
295f208f631SHeejin Ahn   void writeValueType(wasm::ValType Ty) { W.OS << static_cast<char>(Ty); }
2969e15f359SSam Clegg 
297da419bdbSHeejin Ahn   void writeTypeSection(ArrayRef<WasmSignature> Signatures);
2988defa952SSam Clegg   void writeImportSection(ArrayRef<wasm::WasmImport> Imports, uint32_t DataSize,
299f950b24aSSam Clegg                           uint32_t NumElements);
300457fb0b4SSam Clegg   void writeFunctionSection(ArrayRef<WasmFunction> Functions);
3017c395943SSam Clegg   void writeGlobalSection();
3028defa952SSam Clegg   void writeExportSection(ArrayRef<wasm::WasmExport> Exports);
303457fb0b4SSam Clegg   void writeElemSection(ArrayRef<uint32_t> TableElems);
3049e15f359SSam Clegg   void writeCodeSection(const MCAssembler &Asm, const MCAsmLayout &Layout,
305457fb0b4SSam Clegg                         ArrayRef<WasmFunction> Functions);
3066c899ba6SSam Clegg   void writeDataSection();
307da419bdbSHeejin Ahn   void writeEventSection(ArrayRef<wasm::WasmEventType> Events);
3086f08c84aSSam Clegg   void writeRelocSection(uint32_t SectionIndex, StringRef Name,
309f77dc2a8SSam Clegg                          std::vector<WasmRelocationEntry> &Relocations);
31031a2c809SSam Clegg   void writeLinkingMetaDataSection(
31186b4a09aSSam Clegg       ArrayRef<wasm::WasmSymbolInfo> SymbolInfos,
312ea7caceeSSam Clegg       ArrayRef<std::pair<uint16_t, uint32_t>> InitFuncs,
313ea7caceeSSam Clegg       const std::map<StringRef, std::vector<WasmComdatEntry>> &Comdats);
3146a31a0d6SSam Clegg   void writeCustomSections(const MCAssembler &Asm, const MCAsmLayout &Layout);
3156a31a0d6SSam Clegg   void writeCustomRelocSections();
3166a31a0d6SSam Clegg   void
3176a31a0d6SSam Clegg   updateCustomSectionRelocations(const SmallVector<WasmFunction, 4> &Functions,
3186a31a0d6SSam Clegg                                  const MCAsmLayout &Layout);
319acd7d2b0SSam Clegg 
3207c395943SSam Clegg   uint32_t getProvisionalValue(const WasmRelocationEntry &RelEntry);
321acd7d2b0SSam Clegg   void applyRelocations(ArrayRef<WasmRelocationEntry> Relocations,
322acd7d2b0SSam Clegg                         uint64_t ContentsOffset);
323acd7d2b0SSam Clegg 
324acd7d2b0SSam Clegg   uint32_t getRelocationIndexValue(const WasmRelocationEntry &RelEntry);
3255e3d33a7SSam Clegg   uint32_t getFunctionType(const MCSymbolWasm &Symbol);
326da419bdbSHeejin Ahn   uint32_t getEventType(const MCSymbolWasm &Symbol);
32738b12f5eSHeejin Ahn   void registerFunctionType(const MCSymbolWasm &Symbol);
32838b12f5eSHeejin Ahn   void registerEventType(const MCSymbolWasm &Symbol);
32918eafb6cSDan Gohman };
3309e15f359SSam Clegg 
33118eafb6cSDan Gohman } // end anonymous namespace
33218eafb6cSDan Gohman 
33318eafb6cSDan Gohman WasmObjectWriter::~WasmObjectWriter() {}
33418eafb6cSDan Gohman 
335d934cb88SDan Gohman // Write out a section header and a patchable section size field.
336d934cb88SDan Gohman void WasmObjectWriter::startSection(SectionBookkeeping &Section,
3372322a937SSam Clegg                                     unsigned SectionId) {
338d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "startSection " << SectionId << "\n");
339f17b149dSPeter Collingbourne   W.OS << char(SectionId);
340d934cb88SDan Gohman 
341f17b149dSPeter Collingbourne   Section.SizeOffset = W.OS.tell();
342d934cb88SDan Gohman 
343d934cb88SDan Gohman   // The section size. We don't know the size yet, so reserve enough space
344d934cb88SDan Gohman   // for any 32-bit value; we'll patch it later.
345f17b149dSPeter Collingbourne   encodeULEB128(UINT32_MAX, W.OS);
346d934cb88SDan Gohman 
347d934cb88SDan Gohman   // The position where the section starts, for measuring its size.
348f17b149dSPeter Collingbourne   Section.ContentsOffset = W.OS.tell();
349f17b149dSPeter Collingbourne   Section.PayloadOffset = W.OS.tell();
3506f08c84aSSam Clegg   Section.Index = SectionCount++;
351d934cb88SDan Gohman }
3522322a937SSam Clegg 
3532322a937SSam Clegg void WasmObjectWriter::startCustomSection(SectionBookkeeping &Section,
3542322a937SSam Clegg                                           StringRef Name) {
355d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "startCustomSection " << Name << "\n");
3562322a937SSam Clegg   startSection(Section, wasm::WASM_SEC_CUSTOM);
3576a31a0d6SSam Clegg 
3586a31a0d6SSam Clegg   // The position where the section header ends, for measuring its size.
359f17b149dSPeter Collingbourne   Section.PayloadOffset = W.OS.tell();
3606a31a0d6SSam Clegg 
3612322a937SSam Clegg   // Custom sections in wasm also have a string identifier.
3622322a937SSam Clegg   writeString(Name);
3636a31a0d6SSam Clegg 
3646a31a0d6SSam Clegg   // The position where the custom section starts.
365f17b149dSPeter Collingbourne   Section.ContentsOffset = W.OS.tell();
366d934cb88SDan Gohman }
367d934cb88SDan Gohman 
368d934cb88SDan Gohman // Now that the section is complete and we know how big it is, patch up the
369d934cb88SDan Gohman // section size field at the start of the section.
370d934cb88SDan Gohman void WasmObjectWriter::endSection(SectionBookkeeping &Section) {
371f17b149dSPeter Collingbourne   uint64_t Size = W.OS.tell() - Section.PayloadOffset;
372d934cb88SDan Gohman   if (uint32_t(Size) != Size)
373d934cb88SDan Gohman     report_fatal_error("section size does not fit in a uint32_t");
374d934cb88SDan Gohman 
375d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "endSection size=" << Size << "\n");
376d934cb88SDan Gohman 
377d934cb88SDan Gohman   // Write the final section size to the payload_len field, which follows
378d934cb88SDan Gohman   // the section id byte.
379d934cb88SDan Gohman   uint8_t Buffer[16];
38066a99e41SSam Clegg   unsigned SizeLen = encodeULEB128(Size, Buffer, 5);
381d934cb88SDan Gohman   assert(SizeLen == 5);
382f17b149dSPeter Collingbourne   static_cast<raw_pwrite_stream &>(W.OS).pwrite((char *)Buffer, SizeLen,
383f17b149dSPeter Collingbourne                                                 Section.SizeOffset);
384d934cb88SDan Gohman }
385d934cb88SDan Gohman 
38618eafb6cSDan Gohman // Emit the Wasm header.
38718eafb6cSDan Gohman void WasmObjectWriter::writeHeader(const MCAssembler &Asm) {
388f17b149dSPeter Collingbourne   W.OS.write(wasm::WasmMagic, sizeof(wasm::WasmMagic));
389f17b149dSPeter Collingbourne   W.write<uint32_t>(wasm::WasmVersion);
39018eafb6cSDan Gohman }
39118eafb6cSDan Gohman 
39218eafb6cSDan Gohman void WasmObjectWriter::executePostLayoutBinding(MCAssembler &Asm,
39318eafb6cSDan Gohman                                                 const MCAsmLayout &Layout) {
3946ccb59b3SSam Clegg   // Build a map of sections to the function that defines them, for use
3956ccb59b3SSam Clegg   // in recordRelocation.
3966ccb59b3SSam Clegg   for (const MCSymbol &S : Asm.symbols()) {
3976ccb59b3SSam Clegg     const auto &WS = static_cast<const MCSymbolWasm &>(S);
3986ccb59b3SSam Clegg     if (WS.isDefined() && WS.isFunction() && !WS.isVariable()) {
3996ccb59b3SSam Clegg       const auto &Sec = static_cast<const MCSectionWasm &>(S.getSection());
4006ccb59b3SSam Clegg       auto Pair = SectionFunctions.insert(std::make_pair(&Sec, &S));
4016ccb59b3SSam Clegg       if (!Pair.second)
4026ccb59b3SSam Clegg         report_fatal_error("section already has a defining function: " +
4036ccb59b3SSam Clegg                            Sec.getSectionName());
4046ccb59b3SSam Clegg     }
4056ccb59b3SSam Clegg   }
40618eafb6cSDan Gohman }
40718eafb6cSDan Gohman 
40818eafb6cSDan Gohman void WasmObjectWriter::recordRelocation(MCAssembler &Asm,
40918eafb6cSDan Gohman                                         const MCAsmLayout &Layout,
41018eafb6cSDan Gohman                                         const MCFragment *Fragment,
41118eafb6cSDan Gohman                                         const MCFixup &Fixup, MCValue Target,
412ceecfe5bSRafael Espindola                                         uint64_t &FixedValue) {
413ceecfe5bSRafael Espindola   MCAsmBackend &Backend = Asm.getBackend();
414ceecfe5bSRafael Espindola   bool IsPCRel = Backend.getFixupKindInfo(Fixup.getKind()).Flags &
415ceecfe5bSRafael Espindola                  MCFixupKindInfo::FKF_IsPCRel;
416fe6414b0SSam Clegg   const auto &FixupSection = cast<MCSectionWasm>(*Fragment->getParent());
417d934cb88SDan Gohman   uint64_t C = Target.getConstant();
418d934cb88SDan Gohman   uint64_t FixupOffset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
419d934cb88SDan Gohman   MCContext &Ctx = Asm.getContext();
420d934cb88SDan Gohman 
421bafe6902SSam Clegg   // The .init_array isn't translated as data, so don't do relocations in it.
422bafe6902SSam Clegg   if (FixupSection.getSectionName().startswith(".init_array"))
423bafe6902SSam Clegg     return;
424bafe6902SSam Clegg 
425d934cb88SDan Gohman   if (const MCSymbolRefExpr *RefB = Target.getSymB()) {
426d934cb88SDan Gohman     assert(RefB->getKind() == MCSymbolRefExpr::VK_None &&
427d934cb88SDan Gohman            "Should not have constructed this");
428d934cb88SDan Gohman 
429d934cb88SDan Gohman     // Let A, B and C being the components of Target and R be the location of
430d934cb88SDan Gohman     // the fixup. If the fixup is not pcrel, we want to compute (A - B + C).
431d934cb88SDan Gohman     // If it is pcrel, we want to compute (A - B + C - R).
432d934cb88SDan Gohman 
433d934cb88SDan Gohman     // In general, Wasm has no relocations for -B. It can only represent (A + C)
434d934cb88SDan Gohman     // or (A + C - R). If B = R + K and the relocation is not pcrel, we can
435d934cb88SDan Gohman     // replace B to implement it: (A - R - K + C)
436d934cb88SDan Gohman     if (IsPCRel) {
437d934cb88SDan Gohman       Ctx.reportError(
438d934cb88SDan Gohman           Fixup.getLoc(),
439d934cb88SDan Gohman           "No relocation available to represent this relative expression");
440d934cb88SDan Gohman       return;
441d934cb88SDan Gohman     }
442d934cb88SDan Gohman 
443d934cb88SDan Gohman     const auto &SymB = cast<MCSymbolWasm>(RefB->getSymbol());
444d934cb88SDan Gohman 
445d934cb88SDan Gohman     if (SymB.isUndefined()) {
446d934cb88SDan Gohman       Ctx.reportError(Fixup.getLoc(),
447d934cb88SDan Gohman                       Twine("symbol '") + SymB.getName() +
448d934cb88SDan Gohman                           "' can not be undefined in a subtraction expression");
449d934cb88SDan Gohman       return;
450d934cb88SDan Gohman     }
451d934cb88SDan Gohman 
452d934cb88SDan Gohman     assert(!SymB.isAbsolute() && "Should have been folded");
453d934cb88SDan Gohman     const MCSection &SecB = SymB.getSection();
454d934cb88SDan Gohman     if (&SecB != &FixupSection) {
455d934cb88SDan Gohman       Ctx.reportError(Fixup.getLoc(),
456d934cb88SDan Gohman                       "Cannot represent a difference across sections");
457d934cb88SDan Gohman       return;
458d934cb88SDan Gohman     }
459d934cb88SDan Gohman 
460d934cb88SDan Gohman     uint64_t SymBOffset = Layout.getSymbolOffset(SymB);
461d934cb88SDan Gohman     uint64_t K = SymBOffset - FixupOffset;
462d934cb88SDan Gohman     IsPCRel = true;
463d934cb88SDan Gohman     C -= K;
464d934cb88SDan Gohman   }
465d934cb88SDan Gohman 
466d934cb88SDan Gohman   // We either rejected the fixup or folded B into C at this point.
467d934cb88SDan Gohman   const MCSymbolRefExpr *RefA = Target.getSymA();
468d934cb88SDan Gohman   const auto *SymA = RefA ? cast<MCSymbolWasm>(&RefA->getSymbol()) : nullptr;
469d934cb88SDan Gohman 
470d934cb88SDan Gohman   if (SymA && SymA->isVariable()) {
471d934cb88SDan Gohman     const MCExpr *Expr = SymA->getVariableValue();
4726ad8f190SSam Clegg     const auto *Inner = cast<MCSymbolRefExpr>(Expr);
4736ad8f190SSam Clegg     if (Inner->getKind() == MCSymbolRefExpr::VK_WEAKREF)
4746ad8f190SSam Clegg       llvm_unreachable("weakref used in reloc not yet implemented");
475d934cb88SDan Gohman   }
476d934cb88SDan Gohman 
477d934cb88SDan Gohman   // Put any constant offset in an addend. Offsets can be negative, and
478d934cb88SDan Gohman   // LLVM expects wrapping, in contrast to wasm's immediates which can't
479d934cb88SDan Gohman   // be negative and don't wrap.
480d934cb88SDan Gohman   FixedValue = 0;
481d934cb88SDan Gohman 
4824d57fbd0SSam Clegg   unsigned Type = getRelocType(Target, Fixup);
483ae03c1e7SSam Clegg   assert(!IsPCRel);
4849d24fb7fSSam Clegg   assert(SymA);
4859d24fb7fSSam Clegg 
4864d57fbd0SSam Clegg   // Absolute offset within a section or a function.
4874d57fbd0SSam Clegg   // Currently only supported for for metadata sections.
4884d57fbd0SSam Clegg   // See: test/MC/WebAssembly/blockaddress.ll
4894d57fbd0SSam Clegg   if (Type == wasm::R_WEBASSEMBLY_FUNCTION_OFFSET_I32 ||
4904d57fbd0SSam Clegg       Type == wasm::R_WEBASSEMBLY_SECTION_OFFSET_I32) {
4914d57fbd0SSam Clegg     if (!FixupSection.getKind().isMetadata())
4924d57fbd0SSam Clegg       report_fatal_error("relocations for function or section offsets are "
4934d57fbd0SSam Clegg                          "only supported in metadata sections");
4944d57fbd0SSam Clegg 
4954d57fbd0SSam Clegg     const MCSymbol *SectionSymbol = nullptr;
4964d57fbd0SSam Clegg     const MCSection &SecA = SymA->getSection();
4974d57fbd0SSam Clegg     if (SecA.getKind().isText())
4986ccb59b3SSam Clegg       SectionSymbol = SectionFunctions.find(&SecA)->second;
4994d57fbd0SSam Clegg     else
5004d57fbd0SSam Clegg       SectionSymbol = SecA.getBeginSymbol();
5014d57fbd0SSam Clegg     if (!SectionSymbol)
5024d57fbd0SSam Clegg       report_fatal_error("section symbol is required for relocation");
5034d57fbd0SSam Clegg 
5044d57fbd0SSam Clegg     C += Layout.getSymbolOffset(*SymA);
5054d57fbd0SSam Clegg     SymA = cast<MCSymbolWasm>(SectionSymbol);
5064d57fbd0SSam Clegg   }
5074d57fbd0SSam Clegg 
5084d57fbd0SSam Clegg   // Relocation other than R_WEBASSEMBLY_TYPE_INDEX_LEB are required to be
5094d57fbd0SSam Clegg   // against a named symbol.
5104d57fbd0SSam Clegg   if (Type != wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB) {
5114d57fbd0SSam Clegg     if (SymA->getName().empty())
5124d57fbd0SSam Clegg       report_fatal_error("relocations against un-named temporaries are not yet "
5134d57fbd0SSam Clegg                          "supported by wasm");
5144d57fbd0SSam Clegg 
5154d57fbd0SSam Clegg     SymA->setUsedInReloc();
5164d57fbd0SSam Clegg   }
517ae03c1e7SSam Clegg 
518d934cb88SDan Gohman   WasmRelocationEntry Rec(FixupOffset, SymA, C, Type, &FixupSection);
519d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "WasmReloc: " << Rec << "\n");
520d934cb88SDan Gohman 
5216a31a0d6SSam Clegg   if (FixupSection.isWasmData()) {
522d934cb88SDan Gohman     DataRelocations.push_back(Rec);
5236a31a0d6SSam Clegg   } else if (FixupSection.getKind().isText()) {
52412fd3da9SSam Clegg     CodeRelocations.push_back(Rec);
5256a31a0d6SSam Clegg   } else if (FixupSection.getKind().isMetadata()) {
5266a31a0d6SSam Clegg     CustomSectionsRelocations[&FixupSection].push_back(Rec);
5276a31a0d6SSam Clegg   } else {
52812fd3da9SSam Clegg     llvm_unreachable("unexpected section type");
529d934cb88SDan Gohman   }
5306a31a0d6SSam Clegg }
531d934cb88SDan Gohman 
532d934cb88SDan Gohman // Write X as an (unsigned) LEB value at offset Offset in Stream, padded
533d934cb88SDan Gohman // to allow patching.
534f208f631SHeejin Ahn static void WritePatchableLEB(raw_pwrite_stream &Stream, uint32_t X,
535f208f631SHeejin Ahn                               uint64_t Offset) {
536d934cb88SDan Gohman   uint8_t Buffer[5];
53766a99e41SSam Clegg   unsigned SizeLen = encodeULEB128(X, Buffer, 5);
538d934cb88SDan Gohman   assert(SizeLen == 5);
539d934cb88SDan Gohman   Stream.pwrite((char *)Buffer, SizeLen, Offset);
540d934cb88SDan Gohman }
541d934cb88SDan Gohman 
542d934cb88SDan Gohman // Write X as an signed LEB value at offset Offset in Stream, padded
543d934cb88SDan Gohman // to allow patching.
544f208f631SHeejin Ahn static void WritePatchableSLEB(raw_pwrite_stream &Stream, int32_t X,
545f208f631SHeejin Ahn                                uint64_t Offset) {
546d934cb88SDan Gohman   uint8_t Buffer[5];
54766a99e41SSam Clegg   unsigned SizeLen = encodeSLEB128(X, Buffer, 5);
548d934cb88SDan Gohman   assert(SizeLen == 5);
549d934cb88SDan Gohman   Stream.pwrite((char *)Buffer, SizeLen, Offset);
550d934cb88SDan Gohman }
551d934cb88SDan Gohman 
552d934cb88SDan Gohman // Write X as a plain integer value at offset Offset in Stream.
553d934cb88SDan Gohman static void WriteI32(raw_pwrite_stream &Stream, uint32_t X, uint64_t Offset) {
554d934cb88SDan Gohman   uint8_t Buffer[4];
555d934cb88SDan Gohman   support::endian::write32le(Buffer, X);
556d934cb88SDan Gohman   Stream.pwrite((char *)Buffer, sizeof(Buffer), Offset);
557d934cb88SDan Gohman }
558d934cb88SDan Gohman 
559aff1c4dfSSam Clegg static const MCSymbolWasm *ResolveSymbol(const MCSymbolWasm &Symbol) {
560aff1c4dfSSam Clegg   if (Symbol.isVariable()) {
561aff1c4dfSSam Clegg     const MCExpr *Expr = Symbol.getVariableValue();
562aff1c4dfSSam Clegg     auto *Inner = cast<MCSymbolRefExpr>(Expr);
563aff1c4dfSSam Clegg     return cast<MCSymbolWasm>(&Inner->getSymbol());
564aff1c4dfSSam Clegg   }
565aff1c4dfSSam Clegg   return &Symbol;
566aff1c4dfSSam Clegg }
567aff1c4dfSSam Clegg 
568d934cb88SDan Gohman // Compute a value to write into the code at the location covered
56960ec3034SSam Clegg // by RelEntry. This value isn't used by the static linker; it just serves
57060ec3034SSam Clegg // to make the object format more readable and more likely to be directly
57160ec3034SSam Clegg // useable.
5727c395943SSam Clegg uint32_t
5737c395943SSam Clegg WasmObjectWriter::getProvisionalValue(const WasmRelocationEntry &RelEntry) {
57460ec3034SSam Clegg   switch (RelEntry.Type) {
57560ec3034SSam Clegg   case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB:
576f9edbe95SSam Clegg   case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32: {
577f9edbe95SSam Clegg     // Provisional value is table address of the resolved symbol itself
578f9edbe95SSam Clegg     const MCSymbolWasm *Sym = ResolveSymbol(*RelEntry.Symbol);
579f9edbe95SSam Clegg     assert(Sym->isFunction());
580f9edbe95SSam Clegg     return TableIndices[Sym];
581f9edbe95SSam Clegg   }
58260ec3034SSam Clegg   case wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB:
5836c899ba6SSam Clegg     // Provisional value is same as the index
58460ec3034SSam Clegg     return getRelocationIndexValue(RelEntry);
5856c899ba6SSam Clegg   case wasm::R_WEBASSEMBLY_FUNCTION_INDEX_LEB:
5866c899ba6SSam Clegg   case wasm::R_WEBASSEMBLY_GLOBAL_INDEX_LEB:
587da419bdbSHeejin Ahn   case wasm::R_WEBASSEMBLY_EVENT_INDEX_LEB:
588da419bdbSHeejin Ahn     // Provisional value is function/global/event Wasm index
5896c899ba6SSam Clegg     if (!WasmIndices.count(RelEntry.Symbol))
5906c899ba6SSam Clegg       report_fatal_error("symbol not found in wasm index space: " +
5916c899ba6SSam Clegg                          RelEntry.Symbol->getName());
5926c899ba6SSam Clegg     return WasmIndices[RelEntry.Symbol];
5934d57fbd0SSam Clegg   case wasm::R_WEBASSEMBLY_FUNCTION_OFFSET_I32:
5944d57fbd0SSam Clegg   case wasm::R_WEBASSEMBLY_SECTION_OFFSET_I32: {
5956a31a0d6SSam Clegg     const auto &Section =
5966a31a0d6SSam Clegg         static_cast<const MCSectionWasm &>(RelEntry.Symbol->getSection());
5976a31a0d6SSam Clegg     return Section.getSectionOffset() + RelEntry.Addend;
5986a31a0d6SSam Clegg   }
59960ec3034SSam Clegg   case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB:
60060ec3034SSam Clegg   case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32:
60160ec3034SSam Clegg   case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB: {
602f9edbe95SSam Clegg     // Provisional value is address of the global
60360ec3034SSam Clegg     const MCSymbolWasm *Sym = ResolveSymbol(*RelEntry.Symbol);
604270ed1b3SSam Clegg     // For undefined symbols, use zero
605cd65f698SSam Clegg     if (!Sym->isDefined())
606270ed1b3SSam Clegg       return 0;
6076c899ba6SSam Clegg     const wasm::WasmDataReference &Ref = DataLocations[Sym];
6086c899ba6SSam Clegg     const WasmDataSegment &Segment = DataSegments[Ref.Segment];
609d934cb88SDan Gohman     // Ignore overflow. LLVM allows address arithmetic to silently wrap.
6106c899ba6SSam Clegg     return Segment.Offset + Ref.Offset + RelEntry.Addend;
61160ec3034SSam Clegg   }
61260ec3034SSam Clegg   default:
61360ec3034SSam Clegg     llvm_unreachable("invalid relocation type");
61460ec3034SSam Clegg   }
615d934cb88SDan Gohman }
616d934cb88SDan Gohman 
617759631c7SSam Clegg static void addData(SmallVectorImpl<char> &DataBytes,
61863ebb813SSam Clegg                     MCSectionWasm &DataSection) {
619d34e60caSNicola Zaghen   LLVM_DEBUG(errs() << "addData: " << DataSection.getSectionName() << "\n");
620759631c7SSam Clegg 
62163ebb813SSam Clegg   DataBytes.resize(alignTo(DataBytes.size(), DataSection.getAlignment()));
62263ebb813SSam Clegg 
623759631c7SSam Clegg   for (const MCFragment &Frag : DataSection) {
624759631c7SSam Clegg     if (Frag.hasInstructions())
625759631c7SSam Clegg       report_fatal_error("only data supported in data sections");
626759631c7SSam Clegg 
627759631c7SSam Clegg     if (auto *Align = dyn_cast<MCAlignFragment>(&Frag)) {
628759631c7SSam Clegg       if (Align->getValueSize() != 1)
629759631c7SSam Clegg         report_fatal_error("only byte values supported for alignment");
630759631c7SSam Clegg       // If nops are requested, use zeros, as this is the data section.
631759631c7SSam Clegg       uint8_t Value = Align->hasEmitNops() ? 0 : Align->getValue();
632f208f631SHeejin Ahn       uint64_t Size =
633f208f631SHeejin Ahn           std::min<uint64_t>(alignTo(DataBytes.size(), Align->getAlignment()),
634f208f631SHeejin Ahn                              DataBytes.size() + Align->getMaxBytesToEmit());
635759631c7SSam Clegg       DataBytes.resize(Size, Value);
636759631c7SSam Clegg     } else if (auto *Fill = dyn_cast<MCFillFragment>(&Frag)) {
637588fad4dSNirav Dave       int64_t NumValues;
638588fad4dSNirav Dave       if (!Fill->getNumValues().evaluateAsAbsolute(NumValues))
639d707c370SRafael Espindola         llvm_unreachable("The fill should be an assembler constant");
640588fad4dSNirav Dave       DataBytes.insert(DataBytes.end(), Fill->getValueSize() * NumValues,
641588fad4dSNirav Dave                        Fill->getValue());
64224faf859SHeejin Ahn     } else if (auto *LEB = dyn_cast<MCLEBFragment>(&Frag)) {
64324faf859SHeejin Ahn       const SmallVectorImpl<char> &Contents = LEB->getContents();
64424faf859SHeejin Ahn       DataBytes.insert(DataBytes.end(), Contents.begin(), Contents.end());
645759631c7SSam Clegg     } else {
646759631c7SSam Clegg       const auto &DataFrag = cast<MCDataFragment>(Frag);
647759631c7SSam Clegg       const SmallVectorImpl<char> &Contents = DataFrag.getContents();
648759631c7SSam Clegg       DataBytes.insert(DataBytes.end(), Contents.begin(), Contents.end());
649759631c7SSam Clegg     }
650759631c7SSam Clegg   }
651759631c7SSam Clegg 
652d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "addData -> " << DataBytes.size() << "\n");
653759631c7SSam Clegg }
654759631c7SSam Clegg 
65560ec3034SSam Clegg uint32_t
65660ec3034SSam Clegg WasmObjectWriter::getRelocationIndexValue(const WasmRelocationEntry &RelEntry) {
65760ec3034SSam Clegg   if (RelEntry.Type == wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB) {
658b7787fd0SSam Clegg     if (!TypeIndices.count(RelEntry.Symbol))
659b7787fd0SSam Clegg       report_fatal_error("symbol not found in type index space: " +
660b7787fd0SSam Clegg                          RelEntry.Symbol->getName());
661acd7d2b0SSam Clegg     return TypeIndices[RelEntry.Symbol];
662acd7d2b0SSam Clegg   }
66360ec3034SSam Clegg 
66425d8e68bSSam Clegg   return RelEntry.Symbol->getIndex();
665acd7d2b0SSam Clegg }
666acd7d2b0SSam Clegg 
667d934cb88SDan Gohman // Apply the portions of the relocation records that we can handle ourselves
668d934cb88SDan Gohman // directly.
669acd7d2b0SSam Clegg void WasmObjectWriter::applyRelocations(
670acd7d2b0SSam Clegg     ArrayRef<WasmRelocationEntry> Relocations, uint64_t ContentsOffset) {
671f17b149dSPeter Collingbourne   auto &Stream = static_cast<raw_pwrite_stream &>(W.OS);
672d934cb88SDan Gohman   for (const WasmRelocationEntry &RelEntry : Relocations) {
673d934cb88SDan Gohman     uint64_t Offset = ContentsOffset +
674d934cb88SDan Gohman                       RelEntry.FixupSection->getSectionOffset() +
675d934cb88SDan Gohman                       RelEntry.Offset;
676d934cb88SDan Gohman 
677d34e60caSNicola Zaghen     LLVM_DEBUG(dbgs() << "applyRelocation: " << RelEntry << "\n");
67860ec3034SSam Clegg     uint32_t Value = getProvisionalValue(RelEntry);
67960ec3034SSam Clegg 
680acd7d2b0SSam Clegg     switch (RelEntry.Type) {
681acd7d2b0SSam Clegg     case wasm::R_WEBASSEMBLY_FUNCTION_INDEX_LEB:
6829d24fb7fSSam Clegg     case wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB:
68360ec3034SSam Clegg     case wasm::R_WEBASSEMBLY_GLOBAL_INDEX_LEB:
68460ec3034SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB:
685da419bdbSHeejin Ahn     case wasm::R_WEBASSEMBLY_EVENT_INDEX_LEB:
686d934cb88SDan Gohman       WritePatchableLEB(Stream, Value, Offset);
687d934cb88SDan Gohman       break;
68860ec3034SSam Clegg     case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32:
68960ec3034SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32:
6906a31a0d6SSam Clegg     case wasm::R_WEBASSEMBLY_FUNCTION_OFFSET_I32:
6916a31a0d6SSam Clegg     case wasm::R_WEBASSEMBLY_SECTION_OFFSET_I32:
692d934cb88SDan Gohman       WriteI32(Stream, Value, Offset);
693d934cb88SDan Gohman       break;
69460ec3034SSam Clegg     case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB:
69560ec3034SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB:
69660ec3034SSam Clegg       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 
7867c395943SSam Clegg void WasmObjectWriter::writeGlobalSection() {
7879e15f359SSam Clegg   if (Globals.empty())
7889e15f359SSam Clegg     return;
7899e15f359SSam Clegg 
7909e15f359SSam Clegg   SectionBookkeeping Section;
7919e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_GLOBAL);
7929e15f359SSam Clegg 
793f17b149dSPeter Collingbourne   encodeULEB128(Globals.size(), W.OS);
7949e15f359SSam Clegg   for (const WasmGlobal &Global : Globals) {
7956e7f1826SSam Clegg     writeValueType(static_cast<wasm::ValType>(Global.Type.Type));
796f17b149dSPeter Collingbourne     W.OS << char(Global.Type.Mutable);
7979e15f359SSam Clegg 
798f17b149dSPeter Collingbourne     W.OS << char(wasm::WASM_OPCODE_I32_CONST);
799f17b149dSPeter Collingbourne     encodeSLEB128(Global.InitialValue, W.OS);
800f17b149dSPeter Collingbourne     W.OS << char(wasm::WASM_OPCODE_END);
8019e15f359SSam Clegg   }
8029e15f359SSam Clegg 
8039e15f359SSam Clegg   endSection(Section);
8049e15f359SSam Clegg }
8059e15f359SSam Clegg 
806da419bdbSHeejin Ahn void WasmObjectWriter::writeEventSection(ArrayRef<wasm::WasmEventType> Events) {
807da419bdbSHeejin Ahn   if (Events.empty())
808da419bdbSHeejin Ahn     return;
809da419bdbSHeejin Ahn 
810da419bdbSHeejin Ahn   SectionBookkeeping Section;
811da419bdbSHeejin Ahn   startSection(Section, wasm::WASM_SEC_EVENT);
812da419bdbSHeejin Ahn 
813da419bdbSHeejin Ahn   encodeULEB128(Events.size(), W.OS);
814da419bdbSHeejin Ahn   for (const wasm::WasmEventType &Event : Events) {
815da419bdbSHeejin Ahn     encodeULEB128(Event.Attribute, W.OS);
816da419bdbSHeejin Ahn     encodeULEB128(Event.SigIndex, W.OS);
817da419bdbSHeejin Ahn   }
818da419bdbSHeejin Ahn 
819da419bdbSHeejin Ahn   endSection(Section);
820da419bdbSHeejin Ahn }
821da419bdbSHeejin Ahn 
8228defa952SSam Clegg void WasmObjectWriter::writeExportSection(ArrayRef<wasm::WasmExport> Exports) {
8239e15f359SSam Clegg   if (Exports.empty())
8249e15f359SSam Clegg     return;
8259e15f359SSam Clegg 
8269e15f359SSam Clegg   SectionBookkeeping Section;
8279e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_EXPORT);
8289e15f359SSam Clegg 
829f17b149dSPeter Collingbourne   encodeULEB128(Exports.size(), W.OS);
8308defa952SSam Clegg   for (const wasm::WasmExport &Export : Exports) {
8318defa952SSam Clegg     writeString(Export.Name);
832f17b149dSPeter Collingbourne     W.OS << char(Export.Kind);
833f17b149dSPeter Collingbourne     encodeULEB128(Export.Index, W.OS);
8349e15f359SSam Clegg   }
8359e15f359SSam Clegg 
8369e15f359SSam Clegg   endSection(Section);
8379e15f359SSam Clegg }
8389e15f359SSam Clegg 
839457fb0b4SSam Clegg void WasmObjectWriter::writeElemSection(ArrayRef<uint32_t> TableElems) {
8409e15f359SSam Clegg   if (TableElems.empty())
8419e15f359SSam Clegg     return;
8429e15f359SSam Clegg 
8439e15f359SSam Clegg   SectionBookkeeping Section;
8449e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_ELEM);
8459e15f359SSam Clegg 
846f17b149dSPeter Collingbourne   encodeULEB128(1, W.OS); // number of "segments"
847f17b149dSPeter Collingbourne   encodeULEB128(0, W.OS); // the table index
8489e15f359SSam Clegg 
8499e15f359SSam Clegg   // init expr for starting offset
850f17b149dSPeter Collingbourne   W.OS << char(wasm::WASM_OPCODE_I32_CONST);
851f17b149dSPeter Collingbourne   encodeSLEB128(kInitialTableOffset, W.OS);
852f17b149dSPeter Collingbourne   W.OS << char(wasm::WASM_OPCODE_END);
8539e15f359SSam Clegg 
854f17b149dSPeter Collingbourne   encodeULEB128(TableElems.size(), W.OS);
8559e15f359SSam Clegg   for (uint32_t Elem : TableElems)
856f17b149dSPeter Collingbourne     encodeULEB128(Elem, W.OS);
8579e15f359SSam Clegg 
8589e15f359SSam Clegg   endSection(Section);
8599e15f359SSam Clegg }
8609e15f359SSam Clegg 
861457fb0b4SSam Clegg void WasmObjectWriter::writeCodeSection(const MCAssembler &Asm,
862457fb0b4SSam Clegg                                         const MCAsmLayout &Layout,
863457fb0b4SSam Clegg                                         ArrayRef<WasmFunction> Functions) {
8649e15f359SSam Clegg   if (Functions.empty())
8659e15f359SSam Clegg     return;
8669e15f359SSam Clegg 
8679e15f359SSam Clegg   SectionBookkeeping Section;
8689e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CODE);
8696f08c84aSSam Clegg   CodeSectionIndex = Section.Index;
8709e15f359SSam Clegg 
871f17b149dSPeter Collingbourne   encodeULEB128(Functions.size(), W.OS);
8729e15f359SSam Clegg 
8739e15f359SSam Clegg   for (const WasmFunction &Func : Functions) {
874fe6414b0SSam Clegg     auto &FuncSection = static_cast<MCSectionWasm &>(Func.Sym->getSection());
8759e15f359SSam Clegg 
8769e15f359SSam Clegg     int64_t Size = 0;
8779e15f359SSam Clegg     if (!Func.Sym->getSize()->evaluateAsAbsolute(Size, Layout))
8789e15f359SSam Clegg       report_fatal_error(".size expression must be evaluatable");
8799e15f359SSam Clegg 
880f17b149dSPeter Collingbourne     encodeULEB128(Size, W.OS);
881f17b149dSPeter Collingbourne     FuncSection.setSectionOffset(W.OS.tell() - Section.ContentsOffset);
882f17b149dSPeter Collingbourne     Asm.writeSectionData(W.OS, &FuncSection, Layout);
8839e15f359SSam Clegg   }
8849e15f359SSam Clegg 
8859e15f359SSam Clegg   // Apply fixups.
886acd7d2b0SSam Clegg   applyRelocations(CodeRelocations, Section.ContentsOffset);
8879e15f359SSam Clegg 
8889e15f359SSam Clegg   endSection(Section);
8899e15f359SSam Clegg }
8909e15f359SSam Clegg 
8916c899ba6SSam Clegg void WasmObjectWriter::writeDataSection() {
8926c899ba6SSam Clegg   if (DataSegments.empty())
8937c395943SSam Clegg     return;
8949e15f359SSam Clegg 
8959e15f359SSam Clegg   SectionBookkeeping Section;
8969e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_DATA);
8976f08c84aSSam Clegg   DataSectionIndex = Section.Index;
8989e15f359SSam Clegg 
899f17b149dSPeter Collingbourne   encodeULEB128(DataSegments.size(), W.OS); // count
9007c395943SSam Clegg 
9016c899ba6SSam Clegg   for (const WasmDataSegment &Segment : DataSegments) {
902f17b149dSPeter Collingbourne     encodeULEB128(0, W.OS); // memory index
903f17b149dSPeter Collingbourne     W.OS << char(wasm::WASM_OPCODE_I32_CONST);
904f17b149dSPeter Collingbourne     encodeSLEB128(Segment.Offset, W.OS); // offset
905f17b149dSPeter Collingbourne     W.OS << char(wasm::WASM_OPCODE_END);
906f17b149dSPeter Collingbourne     encodeULEB128(Segment.Data.size(), W.OS); // size
907f17b149dSPeter Collingbourne     Segment.Section->setSectionOffset(W.OS.tell() - Section.ContentsOffset);
908f17b149dSPeter Collingbourne     W.OS << Segment.Data; // data
9097c395943SSam Clegg   }
9109e15f359SSam Clegg 
9119e15f359SSam Clegg   // Apply fixups.
9127c395943SSam Clegg   applyRelocations(DataRelocations, Section.ContentsOffset);
9139e15f359SSam Clegg 
9149e15f359SSam Clegg   endSection(Section);
9159e15f359SSam Clegg }
9169e15f359SSam Clegg 
9176f08c84aSSam Clegg void WasmObjectWriter::writeRelocSection(
9186f08c84aSSam Clegg     uint32_t SectionIndex, StringRef Name,
919f77dc2a8SSam Clegg     std::vector<WasmRelocationEntry> &Relocs) {
9209e15f359SSam Clegg   // See: https://github.com/WebAssembly/tool-conventions/blob/master/Linking.md
9219e15f359SSam Clegg   // for descriptions of the reloc sections.
9229e15f359SSam Clegg 
923f77dc2a8SSam Clegg   if (Relocs.empty())
9249e15f359SSam Clegg     return;
9259e15f359SSam Clegg 
926f77dc2a8SSam Clegg   // First, ensure the relocations are sorted in offset order.  In general they
927f77dc2a8SSam Clegg   // should already be sorted since `recordRelocation` is called in offset
928f77dc2a8SSam Clegg   // order, but for the code section we combine many MC sections into single
929f77dc2a8SSam Clegg   // wasm section, and this order is determined by the order of Asm.Symbols()
930f77dc2a8SSam Clegg   // not the sections order.
931f77dc2a8SSam Clegg   std::stable_sort(
932f77dc2a8SSam Clegg       Relocs.begin(), Relocs.end(),
933f77dc2a8SSam Clegg       [](const WasmRelocationEntry &A, const WasmRelocationEntry &B) {
934f77dc2a8SSam Clegg         return (A.Offset + A.FixupSection->getSectionOffset()) <
935f77dc2a8SSam Clegg                (B.Offset + B.FixupSection->getSectionOffset());
936f77dc2a8SSam Clegg       });
937f77dc2a8SSam Clegg 
9389e15f359SSam Clegg   SectionBookkeeping Section;
9396f08c84aSSam Clegg   startCustomSection(Section, std::string("reloc.") + Name.str());
9409e15f359SSam Clegg 
941f17b149dSPeter Collingbourne   encodeULEB128(SectionIndex, W.OS);
942f77dc2a8SSam Clegg   encodeULEB128(Relocs.size(), W.OS);
943f77dc2a8SSam Clegg   for (const WasmRelocationEntry &RelEntry : Relocs) {
944f208f631SHeejin Ahn     uint64_t Offset =
945f208f631SHeejin Ahn         RelEntry.Offset + RelEntry.FixupSection->getSectionOffset();
9466f08c84aSSam Clegg     uint32_t Index = getRelocationIndexValue(RelEntry);
9479e15f359SSam Clegg 
948f17b149dSPeter Collingbourne     W.OS << char(RelEntry.Type);
949f17b149dSPeter Collingbourne     encodeULEB128(Offset, W.OS);
950f17b149dSPeter Collingbourne     encodeULEB128(Index, W.OS);
9516f08c84aSSam Clegg     if (RelEntry.hasAddend())
952f17b149dSPeter Collingbourne       encodeSLEB128(RelEntry.Addend, W.OS);
9539e15f359SSam Clegg   }
9549e15f359SSam Clegg 
9559e15f359SSam Clegg   endSection(Section);
9569e15f359SSam Clegg }
9579e15f359SSam Clegg 
9586a31a0d6SSam Clegg void WasmObjectWriter::writeCustomRelocSections() {
9596a31a0d6SSam Clegg   for (const auto &Sec : CustomSections) {
9606a31a0d6SSam Clegg     auto &Relocations = CustomSectionsRelocations[Sec.Section];
9616a31a0d6SSam Clegg     writeRelocSection(Sec.OutputIndex, Sec.Name, Relocations);
9626a31a0d6SSam Clegg   }
9636a31a0d6SSam Clegg }
9646a31a0d6SSam Clegg 
9659e15f359SSam Clegg void WasmObjectWriter::writeLinkingMetaDataSection(
96686b4a09aSSam Clegg     ArrayRef<wasm::WasmSymbolInfo> SymbolInfos,
967ea7caceeSSam Clegg     ArrayRef<std::pair<uint16_t, uint32_t>> InitFuncs,
968ea7caceeSSam Clegg     const std::map<StringRef, std::vector<WasmComdatEntry>> &Comdats) {
9699e15f359SSam Clegg   SectionBookkeeping Section;
9702322a937SSam Clegg   startCustomSection(Section, "linking");
971f17b149dSPeter Collingbourne   encodeULEB128(wasm::WasmMetadataVersion, W.OS);
9729e15f359SSam Clegg 
9736bb5a41fSSam Clegg   SectionBookkeeping SubSection;
9746c899ba6SSam Clegg   if (SymbolInfos.size() != 0) {
9756c899ba6SSam Clegg     startSection(SubSection, wasm::WASM_SYMBOL_TABLE);
976f17b149dSPeter Collingbourne     encodeULEB128(SymbolInfos.size(), W.OS);
9776c899ba6SSam Clegg     for (const wasm::WasmSymbolInfo &Sym : SymbolInfos) {
978f17b149dSPeter Collingbourne       encodeULEB128(Sym.Kind, W.OS);
979f17b149dSPeter Collingbourne       encodeULEB128(Sym.Flags, W.OS);
9806c899ba6SSam Clegg       switch (Sym.Kind) {
9816c899ba6SSam Clegg       case wasm::WASM_SYMBOL_TYPE_FUNCTION:
9826c899ba6SSam Clegg       case wasm::WASM_SYMBOL_TYPE_GLOBAL:
983da419bdbSHeejin Ahn       case wasm::WASM_SYMBOL_TYPE_EVENT:
984f17b149dSPeter Collingbourne         encodeULEB128(Sym.ElementIndex, W.OS);
9856c899ba6SSam Clegg         if ((Sym.Flags & wasm::WASM_SYMBOL_UNDEFINED) == 0)
9866c899ba6SSam Clegg           writeString(Sym.Name);
9876c899ba6SSam Clegg         break;
9886c899ba6SSam Clegg       case wasm::WASM_SYMBOL_TYPE_DATA:
9896c899ba6SSam Clegg         writeString(Sym.Name);
9906c899ba6SSam Clegg         if ((Sym.Flags & wasm::WASM_SYMBOL_UNDEFINED) == 0) {
991f17b149dSPeter Collingbourne           encodeULEB128(Sym.DataRef.Segment, W.OS);
992f17b149dSPeter Collingbourne           encodeULEB128(Sym.DataRef.Offset, W.OS);
993f17b149dSPeter Collingbourne           encodeULEB128(Sym.DataRef.Size, W.OS);
9946c899ba6SSam Clegg         }
9956c899ba6SSam Clegg         break;
9966a31a0d6SSam Clegg       case wasm::WASM_SYMBOL_TYPE_SECTION: {
9976a31a0d6SSam Clegg         const uint32_t SectionIndex =
9986a31a0d6SSam Clegg             CustomSections[Sym.ElementIndex].OutputIndex;
999f17b149dSPeter Collingbourne         encodeULEB128(SectionIndex, W.OS);
10006a31a0d6SSam Clegg         break;
10016a31a0d6SSam Clegg       }
10026c899ba6SSam Clegg       default:
10036c899ba6SSam Clegg         llvm_unreachable("unexpected kind");
10046c899ba6SSam Clegg       }
1005b7787fd0SSam Clegg     }
1006b7787fd0SSam Clegg     endSection(SubSection);
1007b7787fd0SSam Clegg   }
10089e15f359SSam Clegg 
10096c899ba6SSam Clegg   if (DataSegments.size()) {
101063ebb813SSam Clegg     startSection(SubSection, wasm::WASM_SEGMENT_INFO);
1011f17b149dSPeter Collingbourne     encodeULEB128(DataSegments.size(), W.OS);
10126c899ba6SSam Clegg     for (const WasmDataSegment &Segment : DataSegments) {
1013d95ed959SSam Clegg       writeString(Segment.Name);
1014f17b149dSPeter Collingbourne       encodeULEB128(Segment.Alignment, W.OS);
1015f17b149dSPeter Collingbourne       encodeULEB128(Segment.Flags, W.OS);
101663ebb813SSam Clegg     }
1017d95ed959SSam Clegg     endSection(SubSection);
1018d95ed959SSam Clegg   }
1019d95ed959SSam Clegg 
1020bafe6902SSam Clegg   if (!InitFuncs.empty()) {
1021bafe6902SSam Clegg     startSection(SubSection, wasm::WASM_INIT_FUNCS);
1022f17b149dSPeter Collingbourne     encodeULEB128(InitFuncs.size(), W.OS);
1023bafe6902SSam Clegg     for (auto &StartFunc : InitFuncs) {
1024f17b149dSPeter Collingbourne       encodeULEB128(StartFunc.first, W.OS);  // priority
1025f17b149dSPeter Collingbourne       encodeULEB128(StartFunc.second, W.OS); // function index
1026bafe6902SSam Clegg     }
1027bafe6902SSam Clegg     endSection(SubSection);
1028bafe6902SSam Clegg   }
1029bafe6902SSam Clegg 
1030ea7caceeSSam Clegg   if (Comdats.size()) {
1031ea7caceeSSam Clegg     startSection(SubSection, wasm::WASM_COMDAT_INFO);
1032f17b149dSPeter Collingbourne     encodeULEB128(Comdats.size(), W.OS);
1033ea7caceeSSam Clegg     for (const auto &C : Comdats) {
1034ea7caceeSSam Clegg       writeString(C.first);
1035f17b149dSPeter Collingbourne       encodeULEB128(0, W.OS); // flags for future use
1036f17b149dSPeter Collingbourne       encodeULEB128(C.second.size(), W.OS);
1037ea7caceeSSam Clegg       for (const WasmComdatEntry &Entry : C.second) {
1038f17b149dSPeter Collingbourne         encodeULEB128(Entry.Kind, W.OS);
1039f17b149dSPeter Collingbourne         encodeULEB128(Entry.Index, W.OS);
1040ea7caceeSSam Clegg       }
1041ea7caceeSSam Clegg     }
1042ea7caceeSSam Clegg     endSection(SubSection);
1043ea7caceeSSam Clegg   }
1044ea7caceeSSam Clegg 
10459e15f359SSam Clegg   endSection(Section);
10469e15f359SSam Clegg }
10479e15f359SSam Clegg 
10486a31a0d6SSam Clegg void WasmObjectWriter::writeCustomSections(const MCAssembler &Asm,
10496a31a0d6SSam Clegg                                            const MCAsmLayout &Layout) {
10506a31a0d6SSam Clegg   for (auto &CustomSection : CustomSections) {
1051cfd44a2eSSam Clegg     SectionBookkeeping Section;
10526a31a0d6SSam Clegg     auto *Sec = CustomSection.Section;
10532322a937SSam Clegg     startCustomSection(Section, CustomSection.Name);
10546a31a0d6SSam Clegg 
1055f17b149dSPeter Collingbourne     Sec->setSectionOffset(W.OS.tell() - Section.ContentsOffset);
1056f17b149dSPeter Collingbourne     Asm.writeSectionData(W.OS, Sec, Layout);
10576a31a0d6SSam Clegg 
10586a31a0d6SSam Clegg     CustomSection.OutputContentsOffset = Section.ContentsOffset;
10596a31a0d6SSam Clegg     CustomSection.OutputIndex = Section.Index;
10606a31a0d6SSam Clegg 
1061cfd44a2eSSam Clegg     endSection(Section);
10626a31a0d6SSam Clegg 
10636a31a0d6SSam Clegg     // Apply fixups.
10644d57fbd0SSam Clegg     auto &Relocations = CustomSectionsRelocations[CustomSection.Section];
10654d57fbd0SSam Clegg     applyRelocations(Relocations, CustomSection.OutputContentsOffset);
10666a31a0d6SSam Clegg   }
10676a31a0d6SSam Clegg }
10686a31a0d6SSam Clegg 
10695e3d33a7SSam Clegg uint32_t WasmObjectWriter::getFunctionType(const MCSymbolWasm &Symbol) {
10705e3d33a7SSam Clegg   assert(Symbol.isFunction());
10715e3d33a7SSam Clegg   assert(TypeIndices.count(&Symbol));
10725e3d33a7SSam Clegg   return TypeIndices[&Symbol];
10735e3d33a7SSam Clegg }
10745e3d33a7SSam Clegg 
1075da419bdbSHeejin Ahn uint32_t WasmObjectWriter::getEventType(const MCSymbolWasm &Symbol) {
1076da419bdbSHeejin Ahn   assert(Symbol.isEvent());
1077da419bdbSHeejin Ahn   assert(TypeIndices.count(&Symbol));
1078da419bdbSHeejin Ahn   return TypeIndices[&Symbol];
1079da419bdbSHeejin Ahn }
1080da419bdbSHeejin Ahn 
108138b12f5eSHeejin Ahn void WasmObjectWriter::registerFunctionType(const MCSymbolWasm &Symbol) {
10825e3d33a7SSam Clegg   assert(Symbol.isFunction());
10835e3d33a7SSam Clegg 
1084da419bdbSHeejin Ahn   WasmSignature S;
1085aff1c4dfSSam Clegg   const MCSymbolWasm *ResolvedSym = ResolveSymbol(Symbol);
108677a7a380SDerek Schuff   if (auto *Sig = ResolvedSym->getSignature()) {
1087da419bdbSHeejin Ahn     S.Returns = Sig->Returns;
1088da419bdbSHeejin Ahn     S.Params = Sig->Params;
108977a7a380SDerek Schuff   }
10905e3d33a7SSam Clegg 
1091da419bdbSHeejin Ahn   auto Pair = SignatureIndices.insert(std::make_pair(S, Signatures.size()));
10925e3d33a7SSam Clegg   if (Pair.second)
1093da419bdbSHeejin Ahn     Signatures.push_back(S);
10945e3d33a7SSam Clegg   TypeIndices[&Symbol] = Pair.first->second;
10955e3d33a7SSam Clegg 
1096d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "registerFunctionType: " << Symbol
1097d34e60caSNicola Zaghen                     << " new:" << Pair.second << "\n");
1098d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "  -> type index: " << Pair.first->second << "\n");
10995e3d33a7SSam Clegg }
11005e3d33a7SSam Clegg 
110138b12f5eSHeejin Ahn void WasmObjectWriter::registerEventType(const MCSymbolWasm &Symbol) {
1102da419bdbSHeejin Ahn   assert(Symbol.isEvent());
1103da419bdbSHeejin Ahn 
1104da419bdbSHeejin Ahn   // TODO Currently we don't generate imported exceptions, but if we do, we
1105da419bdbSHeejin Ahn   // should have a way of infering types of imported exceptions.
1106da419bdbSHeejin Ahn   WasmSignature S;
1107da419bdbSHeejin Ahn   if (auto *Sig = Symbol.getSignature()) {
1108da419bdbSHeejin Ahn     S.Returns = Sig->Returns;
1109da419bdbSHeejin Ahn     S.Params = Sig->Params;
1110da419bdbSHeejin Ahn   }
1111da419bdbSHeejin Ahn 
1112da419bdbSHeejin Ahn   auto Pair = SignatureIndices.insert(std::make_pair(S, Signatures.size()));
1113da419bdbSHeejin Ahn   if (Pair.second)
1114da419bdbSHeejin Ahn     Signatures.push_back(S);
1115da419bdbSHeejin Ahn   TypeIndices[&Symbol] = Pair.first->second;
1116da419bdbSHeejin Ahn 
1117da419bdbSHeejin Ahn   LLVM_DEBUG(dbgs() << "registerEventType: " << Symbol << " new:" << Pair.second
1118da419bdbSHeejin Ahn                     << "\n");
1119da419bdbSHeejin Ahn   LLVM_DEBUG(dbgs() << "  -> type index: " << Pair.first->second << "\n");
1120da419bdbSHeejin Ahn }
1121da419bdbSHeejin Ahn 
11224d57fbd0SSam Clegg static bool isInSymtab(const MCSymbolWasm &Sym) {
11234d57fbd0SSam Clegg   if (Sym.isUsedInReloc())
11244d57fbd0SSam Clegg     return true;
11254d57fbd0SSam Clegg 
11264d57fbd0SSam Clegg   if (Sym.isComdat() && !Sym.isDefined())
11274d57fbd0SSam Clegg     return false;
11284d57fbd0SSam Clegg 
11294d57fbd0SSam Clegg   if (Sym.isTemporary() && Sym.getName().empty())
11304d57fbd0SSam Clegg     return false;
11314d57fbd0SSam Clegg 
11324d57fbd0SSam Clegg   if (Sym.isTemporary() && Sym.isData() && !Sym.getSize())
11334d57fbd0SSam Clegg     return false;
11344d57fbd0SSam Clegg 
11354d57fbd0SSam Clegg   if (Sym.isSection())
11364d57fbd0SSam Clegg     return false;
11374d57fbd0SSam Clegg 
11384d57fbd0SSam Clegg   return true;
11394d57fbd0SSam Clegg }
11404d57fbd0SSam Clegg 
1141438390faSPeter Collingbourne uint64_t WasmObjectWriter::writeObject(MCAssembler &Asm,
114218eafb6cSDan Gohman                                        const MCAsmLayout &Layout) {
1143438390faSPeter Collingbourne   uint64_t StartOffset = W.OS.tell();
1144438390faSPeter Collingbourne 
1145d34e60caSNicola Zaghen   LLVM_DEBUG(dbgs() << "WasmObjectWriter::writeObject\n");
114682607f56SDan Gohman   MCContext &Ctx = Asm.getContext();
1147d934cb88SDan Gohman 
1148d934cb88SDan Gohman   // Collect information from the available symbols.
1149d934cb88SDan Gohman   SmallVector<WasmFunction, 4> Functions;
1150d934cb88SDan Gohman   SmallVector<uint32_t, 4> TableElems;
11518defa952SSam Clegg   SmallVector<wasm::WasmImport, 4> Imports;
11528defa952SSam Clegg   SmallVector<wasm::WasmExport, 4> Exports;
1153da419bdbSHeejin Ahn   SmallVector<wasm::WasmEventType, 1> Events;
11546c899ba6SSam Clegg   SmallVector<wasm::WasmSymbolInfo, 4> SymbolInfos;
1155bafe6902SSam Clegg   SmallVector<std::pair<uint16_t, uint32_t>, 2> InitFuncs;
1156ea7caceeSSam Clegg   std::map<StringRef, std::vector<WasmComdatEntry>> Comdats;
11577c395943SSam Clegg   uint32_t DataSize = 0;
1158d934cb88SDan Gohman 
1159f950b24aSSam Clegg   // For now, always emit the memory import, since loads and stores are not
1160f950b24aSSam Clegg   // valid without it. In the future, we could perhaps be more clever and omit
1161f950b24aSSam Clegg   // it if there are no loads or stores.
1162f950b24aSSam Clegg   MCSymbolWasm *MemorySym =
1163f950b24aSSam Clegg       cast<MCSymbolWasm>(Ctx.getOrCreateSymbol("__linear_memory"));
11648defa952SSam Clegg   wasm::WasmImport MemImport;
11658defa952SSam Clegg   MemImport.Module = MemorySym->getModuleName();
11668defa952SSam Clegg   MemImport.Field = MemorySym->getName();
1167f950b24aSSam Clegg   MemImport.Kind = wasm::WASM_EXTERNAL_MEMORY;
1168f950b24aSSam Clegg   Imports.push_back(MemImport);
1169f950b24aSSam Clegg 
1170f950b24aSSam Clegg   // For now, always emit the table section, since indirect calls are not
1171f950b24aSSam Clegg   // valid without it. In the future, we could perhaps be more clever and omit
1172f950b24aSSam Clegg   // it if there are no indirect calls.
1173f950b24aSSam Clegg   MCSymbolWasm *TableSym =
1174f950b24aSSam Clegg       cast<MCSymbolWasm>(Ctx.getOrCreateSymbol("__indirect_function_table"));
11758defa952SSam Clegg   wasm::WasmImport TableImport;
11768defa952SSam Clegg   TableImport.Module = TableSym->getModuleName();
11778defa952SSam Clegg   TableImport.Field = TableSym->getName();
1178f950b24aSSam Clegg   TableImport.Kind = wasm::WASM_EXTERNAL_TABLE;
11796a87ddacSThomas Lively   TableImport.Table.ElemType = wasm::WASM_TYPE_FUNCREF;
1180f950b24aSSam Clegg   Imports.push_back(TableImport);
1181f950b24aSSam Clegg 
1182da419bdbSHeejin Ahn   // Populate SignatureIndices, and Imports and WasmIndices for undefined
1183586320c0SNicholas Wilson   // symbols.  This must be done before populating WasmIndices for defined
1184586320c0SNicholas Wilson   // symbols.
118532ce5ca0SDan Gohman   for (const MCSymbol &S : Asm.symbols()) {
118632ce5ca0SDan Gohman     const auto &WS = static_cast<const MCSymbolWasm &>(S);
118732ce5ca0SDan Gohman 
118832ce5ca0SDan Gohman     // Register types for all functions, including those with private linkage
11899f3fe42eSSam Clegg     // (because wasm always needs a type signature).
119032ce5ca0SDan Gohman     if (WS.isFunction())
119132ce5ca0SDan Gohman       registerFunctionType(WS);
119232ce5ca0SDan Gohman 
1193da419bdbSHeejin Ahn     if (WS.isEvent())
1194da419bdbSHeejin Ahn       registerEventType(WS);
1195da419bdbSHeejin Ahn 
119632ce5ca0SDan Gohman     if (WS.isTemporary())
119732ce5ca0SDan Gohman       continue;
119832ce5ca0SDan Gohman 
119932ce5ca0SDan Gohman     // If the symbol is not defined in this translation unit, import it.
12006c899ba6SSam Clegg     if (!WS.isDefined() && !WS.isComdat()) {
12016c899ba6SSam Clegg       if (WS.isFunction()) {
12028defa952SSam Clegg         wasm::WasmImport Import;
12038defa952SSam Clegg         Import.Module = WS.getModuleName();
12048defa952SSam Clegg         Import.Field = WS.getName();
120532ce5ca0SDan Gohman         Import.Kind = wasm::WASM_EXTERNAL_FUNCTION;
12068defa952SSam Clegg         Import.SigIndex = getFunctionType(WS);
12076c899ba6SSam Clegg         Imports.push_back(Import);
12086c899ba6SSam Clegg         WasmIndices[&WS] = NumFunctionImports++;
12096c899ba6SSam Clegg       } else if (WS.isGlobal()) {
121015f349f7SNicholas Wilson         if (WS.isWeak())
121115f349f7SNicholas Wilson           report_fatal_error("undefined global symbol cannot be weak");
121215f349f7SNicholas Wilson 
12136c899ba6SSam Clegg         wasm::WasmImport Import;
12146c899ba6SSam Clegg         Import.Module = WS.getModuleName();
12156c899ba6SSam Clegg         Import.Field = WS.getName();
121632ce5ca0SDan Gohman         Import.Kind = wasm::WASM_EXTERNAL_GLOBAL;
12176c899ba6SSam Clegg         Import.Global = WS.getGlobalType();
12186c899ba6SSam Clegg         Imports.push_back(Import);
12196c899ba6SSam Clegg         WasmIndices[&WS] = NumGlobalImports++;
1220da419bdbSHeejin Ahn       } else if (WS.isEvent()) {
1221da419bdbSHeejin Ahn         if (WS.isWeak())
1222da419bdbSHeejin Ahn           report_fatal_error("undefined event symbol cannot be weak");
1223da419bdbSHeejin Ahn 
1224da419bdbSHeejin Ahn         wasm::WasmImport Import;
1225da419bdbSHeejin Ahn         Import.Module = WS.getModuleName();
1226da419bdbSHeejin Ahn         Import.Field = WS.getName();
1227da419bdbSHeejin Ahn         Import.Kind = wasm::WASM_EXTERNAL_EVENT;
1228da419bdbSHeejin Ahn         Import.Event.Attribute = wasm::WASM_EVENT_ATTRIBUTE_EXCEPTION;
1229da419bdbSHeejin Ahn         Import.Event.SigIndex = getEventType(WS);
1230da419bdbSHeejin Ahn         Imports.push_back(Import);
1231da419bdbSHeejin Ahn         WasmIndices[&WS] = NumEventImports++;
123232ce5ca0SDan Gohman       }
123332ce5ca0SDan Gohman     }
123432ce5ca0SDan Gohman   }
123532ce5ca0SDan Gohman 
12364d57fbd0SSam Clegg   // Populate DataSegments and CustomSections, which must be done before
12374d57fbd0SSam Clegg   // populating DataLocations.
1238759631c7SSam Clegg   for (MCSection &Sec : Asm) {
1239759631c7SSam Clegg     auto &Section = static_cast<MCSectionWasm &>(Sec);
12404d57fbd0SSam Clegg     StringRef SectionName = Section.getSectionName();
1241759631c7SSam Clegg 
1242bafe6902SSam Clegg     // .init_array sections are handled specially elsewhere.
12434d57fbd0SSam Clegg     if (SectionName.startswith(".init_array"))
1244bafe6902SSam Clegg       continue;
1245bafe6902SSam Clegg 
12464d57fbd0SSam Clegg     // Code is handled separately
12474d57fbd0SSam Clegg     if (Section.getKind().isText())
12484d57fbd0SSam Clegg       continue;
12494d57fbd0SSam Clegg 
12504d57fbd0SSam Clegg     if (Section.isWasmData()) {
1251329e76d5SSam Clegg       uint32_t SegmentIndex = DataSegments.size();
1252759631c7SSam Clegg       DataSize = alignTo(DataSize, Section.getAlignment());
1253759631c7SSam Clegg       DataSegments.emplace_back();
1254759631c7SSam Clegg       WasmDataSegment &Segment = DataSegments.back();
12554d57fbd0SSam Clegg       Segment.Name = SectionName;
1256759631c7SSam Clegg       Segment.Offset = DataSize;
1257759631c7SSam Clegg       Segment.Section = &Section;
125863ebb813SSam Clegg       addData(Segment.Data, Section);
1259*56c587adSSam Clegg       Segment.Alignment = Log2_32(Section.getAlignment());
126063ebb813SSam Clegg       Segment.Flags = 0;
1261759631c7SSam Clegg       DataSize += Segment.Data.size();
12626c899ba6SSam Clegg       Section.setSegmentIndex(SegmentIndex);
1263ea7caceeSSam Clegg 
1264ea7caceeSSam Clegg       if (const MCSymbolWasm *C = Section.getGroup()) {
1265ea7caceeSSam Clegg         Comdats[C->getName()].emplace_back(
1266329e76d5SSam Clegg             WasmComdatEntry{wasm::WASM_COMDAT_DATA, SegmentIndex});
1267ea7caceeSSam Clegg       }
12684d57fbd0SSam Clegg     } else {
12694d57fbd0SSam Clegg       // Create custom sections
12704d57fbd0SSam Clegg       assert(Sec.getKind().isMetadata());
12714d57fbd0SSam Clegg 
12724d57fbd0SSam Clegg       StringRef Name = SectionName;
12734d57fbd0SSam Clegg 
12744d57fbd0SSam Clegg       // For user-defined custom sections, strip the prefix
12754d57fbd0SSam Clegg       if (Name.startswith(".custom_section."))
12764d57fbd0SSam Clegg         Name = Name.substr(strlen(".custom_section."));
12774d57fbd0SSam Clegg 
12784d57fbd0SSam Clegg       MCSymbol *Begin = Sec.getBeginSymbol();
1279fb807d4dSSam Clegg       if (Begin) {
12804d57fbd0SSam Clegg         WasmIndices[cast<MCSymbolWasm>(Begin)] = CustomSections.size();
1281b210c64bSSam Clegg         if (SectionName != Begin->getName())
1282fb807d4dSSam Clegg           report_fatal_error("section name and begin symbol should match: " +
1283b210c64bSSam Clegg                              Twine(SectionName));
1284fb807d4dSSam Clegg       }
12854d57fbd0SSam Clegg       CustomSections.emplace_back(Name, &Section);
1286759631c7SSam Clegg     }
12876a31a0d6SSam Clegg   }
12886a31a0d6SSam Clegg 
1289586320c0SNicholas Wilson   // Populate WasmIndices and DataLocations for defined symbols.
1290d934cb88SDan Gohman   for (const MCSymbol &S : Asm.symbols()) {
1291d934cb88SDan Gohman     // Ignore unnamed temporary symbols, which aren't ever exported, imported,
1292d934cb88SDan Gohman     // or used in relocations.
1293d934cb88SDan Gohman     if (S.isTemporary() && S.getName().empty())
1294d934cb88SDan Gohman       continue;
1295b7787fd0SSam Clegg 
1296d934cb88SDan Gohman     const auto &WS = static_cast<const MCSymbolWasm &>(S);
1297d34e60caSNicola Zaghen     LLVM_DEBUG(
1298d34e60caSNicola Zaghen         dbgs() << "MCSymbol: " << toString(WS.getType()) << " '" << S << "'"
1299d34e60caSNicola Zaghen                << " isDefined=" << S.isDefined() << " isExternal="
1300d34e60caSNicola Zaghen                << S.isExternal() << " isTemporary=" << S.isTemporary()
1301d34e60caSNicola Zaghen                << " isWeak=" << WS.isWeak() << " isHidden=" << WS.isHidden()
1302b7787fd0SSam Clegg                << " isVariable=" << WS.isVariable() << "\n");
1303b7787fd0SSam Clegg 
13045e3d33a7SSam Clegg     if (WS.isVariable())
13055e3d33a7SSam Clegg       continue;
13066c899ba6SSam Clegg     if (WS.isComdat() && !WS.isDefined())
13076c899ba6SSam Clegg       continue;
1308b7787fd0SSam Clegg 
1309d934cb88SDan Gohman     if (WS.isFunction()) {
13106c899ba6SSam Clegg       unsigned Index;
1311cd65f698SSam Clegg       if (WS.isDefined()) {
1312b7787fd0SSam Clegg         if (WS.getOffset() != 0)
1313b7787fd0SSam Clegg           report_fatal_error(
1314b7787fd0SSam Clegg               "function sections must contain one function each");
1315b7787fd0SSam Clegg 
1316b7787fd0SSam Clegg         if (WS.getSize() == 0)
1317b7787fd0SSam Clegg           report_fatal_error(
1318b7787fd0SSam Clegg               "function symbols must have a size set with .size");
1319b7787fd0SSam Clegg 
13206c899ba6SSam Clegg         // A definition. Write out the function body.
13219f3fe42eSSam Clegg         Index = NumFunctionImports + Functions.size();
1322d934cb88SDan Gohman         WasmFunction Func;
1323da419bdbSHeejin Ahn         Func.SigIndex = getFunctionType(WS);
1324d934cb88SDan Gohman         Func.Sym = &WS;
13256c899ba6SSam Clegg         WasmIndices[&WS] = Index;
1326d934cb88SDan Gohman         Functions.push_back(Func);
13276c899ba6SSam Clegg 
13286c899ba6SSam Clegg         auto &Section = static_cast<MCSectionWasm &>(WS.getSection());
13296c899ba6SSam Clegg         if (const MCSymbolWasm *C = Section.getGroup()) {
13306c899ba6SSam Clegg           Comdats[C->getName()].emplace_back(
13316c899ba6SSam Clegg               WasmComdatEntry{wasm::WASM_COMDAT_FUNCTION, Index});
13326c899ba6SSam Clegg         }
1333d934cb88SDan Gohman       } else {
1334d934cb88SDan Gohman         // An import; the index was assigned above.
13356c899ba6SSam Clegg         Index = WasmIndices.find(&WS)->second;
1336d934cb88SDan Gohman       }
1337d934cb88SDan Gohman 
1338d34e60caSNicola Zaghen       LLVM_DEBUG(dbgs() << "  -> function index: " << Index << "\n");
1339da419bdbSHeejin Ahn 
13406c899ba6SSam Clegg     } else if (WS.isData()) {
1341c38e947eSSam Clegg       if (WS.isTemporary() && !WS.getSize())
1342c38e947eSSam Clegg         continue;
1343c38e947eSSam Clegg 
13446c899ba6SSam Clegg       if (!WS.isDefined()) {
1345d34e60caSNicola Zaghen         LLVM_DEBUG(dbgs() << "  -> segment index: -1"
1346d34e60caSNicola Zaghen                           << "\n");
1347fe6414b0SSam Clegg         continue;
13486c899ba6SSam Clegg       }
1349fe6414b0SSam Clegg 
1350d934cb88SDan Gohman       if (!WS.getSize())
1351c38e947eSSam Clegg         report_fatal_error("data symbols must have a size set with .size: " +
1352c38e947eSSam Clegg                            WS.getName());
1353d934cb88SDan Gohman 
1354d934cb88SDan Gohman       int64_t Size = 0;
1355d934cb88SDan Gohman       if (!WS.getSize()->evaluateAsAbsolute(Size, Layout))
1356d934cb88SDan Gohman         report_fatal_error(".size expression must be evaluatable");
1357d934cb88SDan Gohman 
1358759631c7SSam Clegg       auto &DataSection = static_cast<MCSectionWasm &>(WS.getSection());
1359ea7caceeSSam Clegg       assert(DataSection.isWasmData());
13607c395943SSam Clegg 
13616c899ba6SSam Clegg       // For each data symbol, export it in the symtab as a reference to the
13626c899ba6SSam Clegg       // corresponding Wasm data segment.
13636c899ba6SSam Clegg       wasm::WasmDataReference Ref = wasm::WasmDataReference{
13646c899ba6SSam Clegg           DataSection.getSegmentIndex(),
13656c899ba6SSam Clegg           static_cast<uint32_t>(Layout.getSymbolOffset(WS)),
13666c899ba6SSam Clegg           static_cast<uint32_t>(Size)};
13676c899ba6SSam Clegg       DataLocations[&WS] = Ref;
1368d34e60caSNicola Zaghen       LLVM_DEBUG(dbgs() << "  -> segment index: " << Ref.Segment << "\n");
1369da419bdbSHeejin Ahn 
1370a165f2d6SSam Clegg     } else if (WS.isGlobal()) {
13716c899ba6SSam Clegg       // A "true" Wasm global (currently just __stack_pointer)
1372545932beSEric Christopher       if (WS.isDefined())
13736c899ba6SSam Clegg         report_fatal_error("don't yet support defined globals");
13746c899ba6SSam Clegg 
1375545932beSEric Christopher       // An import; the index was assigned above
1376d34e60caSNicola Zaghen       LLVM_DEBUG(dbgs() << "  -> global index: "
1377d34e60caSNicola Zaghen                         << WasmIndices.find(&WS)->second << "\n");
1378da419bdbSHeejin Ahn 
1379da419bdbSHeejin Ahn     } else if (WS.isEvent()) {
1380da419bdbSHeejin Ahn       // C++ exception symbol (__cpp_exception)
1381da419bdbSHeejin Ahn       unsigned Index;
1382da419bdbSHeejin Ahn       if (WS.isDefined()) {
1383da419bdbSHeejin Ahn         Index = NumEventImports + Events.size();
1384da419bdbSHeejin Ahn         wasm::WasmEventType Event;
1385da419bdbSHeejin Ahn         Event.SigIndex = getEventType(WS);
1386da419bdbSHeejin Ahn         Event.Attribute = wasm::WASM_EVENT_ATTRIBUTE_EXCEPTION;
1387da419bdbSHeejin Ahn         WasmIndices[&WS] = Index;
1388da419bdbSHeejin Ahn         Events.push_back(Event);
1389da419bdbSHeejin Ahn       } else {
1390da419bdbSHeejin Ahn         // An import; the index was assigned above.
1391da419bdbSHeejin Ahn         Index = WasmIndices.find(&WS)->second;
1392da419bdbSHeejin Ahn       }
1393da419bdbSHeejin Ahn       LLVM_DEBUG(dbgs() << "  -> event index: " << WasmIndices.find(&WS)->second
1394da419bdbSHeejin Ahn                         << "\n");
1395da419bdbSHeejin Ahn 
1396a165f2d6SSam Clegg     } else {
1397a165f2d6SSam Clegg       assert(WS.isSection());
1398d934cb88SDan Gohman     }
1399d934cb88SDan Gohman   }
1400d934cb88SDan Gohman 
1401586320c0SNicholas Wilson   // Populate WasmIndices and DataLocations for aliased symbols.  We need to
1402586320c0SNicholas Wilson   // process these in a separate pass because we need to have processed the
1403586320c0SNicholas Wilson   // target of the alias before the alias itself and the symbols are not
1404586320c0SNicholas Wilson   // necessarily ordered in this way.
1405b7787fd0SSam Clegg   for (const MCSymbol &S : Asm.symbols()) {
1406b7787fd0SSam Clegg     if (!S.isVariable())
1407b7787fd0SSam Clegg       continue;
140831a2c809SSam Clegg 
1409cd65f698SSam Clegg     assert(S.isDefined());
1410b7787fd0SSam Clegg 
14115e3d33a7SSam Clegg     // Find the target symbol of this weak alias and export that index
1412aff1c4dfSSam Clegg     const auto &WS = static_cast<const MCSymbolWasm &>(S);
1413aff1c4dfSSam Clegg     const MCSymbolWasm *ResolvedSym = ResolveSymbol(WS);
1414d34e60caSNicola Zaghen     LLVM_DEBUG(dbgs() << WS.getName() << ": weak alias of '" << *ResolvedSym
1415d34e60caSNicola Zaghen                       << "'\n");
1416b7787fd0SSam Clegg 
14176c899ba6SSam Clegg     if (WS.isFunction()) {
14186c899ba6SSam Clegg       assert(WasmIndices.count(ResolvedSym) > 0);
14196c899ba6SSam Clegg       uint32_t WasmIndex = WasmIndices.find(ResolvedSym)->second;
14206c899ba6SSam Clegg       WasmIndices[&WS] = WasmIndex;
1421d34e60caSNicola Zaghen       LLVM_DEBUG(dbgs() << "  -> index:" << WasmIndex << "\n");
14226c899ba6SSam Clegg     } else if (WS.isData()) {
14236c899ba6SSam Clegg       assert(DataLocations.count(ResolvedSym) > 0);
14246c899ba6SSam Clegg       const wasm::WasmDataReference &Ref =
14256c899ba6SSam Clegg           DataLocations.find(ResolvedSym)->second;
14266c899ba6SSam Clegg       DataLocations[&WS] = Ref;
1427d34e60caSNicola Zaghen       LLVM_DEBUG(dbgs() << "  -> index:" << Ref.Segment << "\n");
14286c899ba6SSam Clegg     } else {
1429da419bdbSHeejin Ahn       report_fatal_error("don't yet support global/event aliases");
14306c899ba6SSam Clegg     }
1431586320c0SNicholas Wilson   }
143231a2c809SSam Clegg 
1433586320c0SNicholas Wilson   // Finally, populate the symbol table itself, in its "natural" order.
1434586320c0SNicholas Wilson   for (const MCSymbol &S : Asm.symbols()) {
1435586320c0SNicholas Wilson     const auto &WS = static_cast<const MCSymbolWasm &>(S);
143625d8e68bSSam Clegg     if (!isInSymtab(WS)) {
143725d8e68bSSam Clegg       WS.setIndex(INVALID_INDEX);
1438586320c0SNicholas Wilson       continue;
143925d8e68bSSam Clegg     }
1440d34e60caSNicola Zaghen     LLVM_DEBUG(dbgs() << "adding to symtab: " << WS << "\n");
1441586320c0SNicholas Wilson 
1442586320c0SNicholas Wilson     uint32_t Flags = 0;
1443586320c0SNicholas Wilson     if (WS.isWeak())
1444586320c0SNicholas Wilson       Flags |= wasm::WASM_SYMBOL_BINDING_WEAK;
1445586320c0SNicholas Wilson     if (WS.isHidden())
1446586320c0SNicholas Wilson       Flags |= wasm::WASM_SYMBOL_VISIBILITY_HIDDEN;
1447586320c0SNicholas Wilson     if (!WS.isExternal() && WS.isDefined())
1448586320c0SNicholas Wilson       Flags |= wasm::WASM_SYMBOL_BINDING_LOCAL;
1449586320c0SNicholas Wilson     if (WS.isUndefined())
1450586320c0SNicholas Wilson       Flags |= wasm::WASM_SYMBOL_UNDEFINED;
1451586320c0SNicholas Wilson 
1452586320c0SNicholas Wilson     wasm::WasmSymbolInfo Info;
1453586320c0SNicholas Wilson     Info.Name = WS.getName();
1454586320c0SNicholas Wilson     Info.Kind = WS.getType();
1455586320c0SNicholas Wilson     Info.Flags = Flags;
14564d57fbd0SSam Clegg     if (!WS.isData()) {
14574d57fbd0SSam Clegg       assert(WasmIndices.count(&WS) > 0);
1458586320c0SNicholas Wilson       Info.ElementIndex = WasmIndices.find(&WS)->second;
14594d57fbd0SSam Clegg     } else if (WS.isDefined()) {
14604d57fbd0SSam Clegg       assert(DataLocations.count(&WS) > 0);
1461586320c0SNicholas Wilson       Info.DataRef = DataLocations.find(&WS)->second;
14624d57fbd0SSam Clegg     }
146325d8e68bSSam Clegg     WS.setIndex(SymbolInfos.size());
1464586320c0SNicholas Wilson     SymbolInfos.emplace_back(Info);
1465b7787fd0SSam Clegg   }
1466b7787fd0SSam Clegg 
14676006e091SSam Clegg   {
14686006e091SSam Clegg     auto HandleReloc = [&](const WasmRelocationEntry &Rel) {
1469f9edbe95SSam Clegg       // Functions referenced by a relocation need to put in the table.  This is
1470f9edbe95SSam Clegg       // purely to make the object file's provisional values readable, and is
1471f9edbe95SSam Clegg       // ignored by the linker, which re-calculates the relocations itself.
1472f9edbe95SSam Clegg       if (Rel.Type != wasm::R_WEBASSEMBLY_TABLE_INDEX_I32 &&
1473f9edbe95SSam Clegg           Rel.Type != wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB)
1474f9edbe95SSam Clegg         return;
1475f9edbe95SSam Clegg       assert(Rel.Symbol->isFunction());
1476f9edbe95SSam Clegg       const MCSymbolWasm &WS = *ResolveSymbol(*Rel.Symbol);
14776c899ba6SSam Clegg       uint32_t FunctionIndex = WasmIndices.find(&WS)->second;
1478f9edbe95SSam Clegg       uint32_t TableIndex = TableElems.size() + kInitialTableOffset;
1479f9edbe95SSam Clegg       if (TableIndices.try_emplace(&WS, TableIndex).second) {
1480d34e60caSNicola Zaghen         LLVM_DEBUG(dbgs() << "  -> adding " << WS.getName()
1481f9edbe95SSam Clegg                           << " to table: " << TableIndex << "\n");
14826c899ba6SSam Clegg         TableElems.push_back(FunctionIndex);
14836006e091SSam Clegg         registerFunctionType(WS);
14846006e091SSam Clegg       }
14856006e091SSam Clegg     };
1486970d02c4SDan Gohman 
14876006e091SSam Clegg     for (const WasmRelocationEntry &RelEntry : CodeRelocations)
14886006e091SSam Clegg       HandleReloc(RelEntry);
14896006e091SSam Clegg     for (const WasmRelocationEntry &RelEntry : DataRelocations)
14906006e091SSam Clegg       HandleReloc(RelEntry);
1491d934cb88SDan Gohman   }
1492d934cb88SDan Gohman 
1493bafe6902SSam Clegg   // Translate .init_array section contents into start functions.
1494bafe6902SSam Clegg   for (const MCSection &S : Asm) {
1495bafe6902SSam Clegg     const auto &WS = static_cast<const MCSectionWasm &>(S);
1496bafe6902SSam Clegg     if (WS.getSectionName().startswith(".fini_array"))
1497bafe6902SSam Clegg       report_fatal_error(".fini_array sections are unsupported");
1498bafe6902SSam Clegg     if (!WS.getSectionName().startswith(".init_array"))
1499bafe6902SSam Clegg       continue;
1500bafe6902SSam Clegg     if (WS.getFragmentList().empty())
1501bafe6902SSam Clegg       continue;
1502b210c64bSSam Clegg 
1503b210c64bSSam Clegg     // init_array is expected to contain a single non-empty data fragment
1504b210c64bSSam Clegg     if (WS.getFragmentList().size() != 3)
1505bafe6902SSam Clegg       report_fatal_error("only one .init_array section fragment supported");
1506b210c64bSSam Clegg 
1507b210c64bSSam Clegg     auto IT = WS.begin();
1508b210c64bSSam Clegg     const MCFragment &EmptyFrag = *IT;
1509b210c64bSSam Clegg     if (EmptyFrag.getKind() != MCFragment::FT_Data)
1510b210c64bSSam Clegg       report_fatal_error(".init_array section should be aligned");
1511b210c64bSSam Clegg 
1512b210c64bSSam Clegg     IT = std::next(IT);
1513b210c64bSSam Clegg     const MCFragment &AlignFrag = *IT;
1514bafe6902SSam Clegg     if (AlignFrag.getKind() != MCFragment::FT_Align)
1515bafe6902SSam Clegg       report_fatal_error(".init_array section should be aligned");
1516bafe6902SSam Clegg     if (cast<MCAlignFragment>(AlignFrag).getAlignment() != (is64Bit() ? 8 : 4))
1517bafe6902SSam Clegg       report_fatal_error(".init_array section should be aligned for pointers");
1518b210c64bSSam Clegg 
1519b210c64bSSam Clegg     const MCFragment &Frag = *std::next(IT);
1520bafe6902SSam Clegg     if (Frag.hasInstructions() || Frag.getKind() != MCFragment::FT_Data)
1521bafe6902SSam Clegg       report_fatal_error("only data supported in .init_array section");
1522b210c64bSSam Clegg 
1523bafe6902SSam Clegg     uint16_t Priority = UINT16_MAX;
15244d57fbd0SSam Clegg     unsigned PrefixLength = strlen(".init_array");
15254d57fbd0SSam Clegg     if (WS.getSectionName().size() > PrefixLength) {
15264d57fbd0SSam Clegg       if (WS.getSectionName()[PrefixLength] != '.')
1527f208f631SHeejin Ahn         report_fatal_error(
1528f208f631SHeejin Ahn             ".init_array section priority should start with '.'");
15294d57fbd0SSam Clegg       if (WS.getSectionName()
15304d57fbd0SSam Clegg               .substr(PrefixLength + 1)
15314d57fbd0SSam Clegg               .getAsInteger(10, Priority))
1532bafe6902SSam Clegg         report_fatal_error("invalid .init_array section priority");
1533bafe6902SSam Clegg     }
1534bafe6902SSam Clegg     const auto &DataFrag = cast<MCDataFragment>(Frag);
1535bafe6902SSam Clegg     const SmallVectorImpl<char> &Contents = DataFrag.getContents();
1536f208f631SHeejin Ahn     for (const uint8_t *
1537f208f631SHeejin Ahn              p = (const uint8_t *)Contents.data(),
1538bafe6902SSam Clegg             *end = (const uint8_t *)Contents.data() + Contents.size();
1539bafe6902SSam Clegg          p != end; ++p) {
1540bafe6902SSam Clegg       if (*p != 0)
1541bafe6902SSam Clegg         report_fatal_error("non-symbolic data in .init_array section");
1542bafe6902SSam Clegg     }
1543bafe6902SSam Clegg     for (const MCFixup &Fixup : DataFrag.getFixups()) {
1544f208f631SHeejin Ahn       assert(Fixup.getKind() ==
1545f208f631SHeejin Ahn              MCFixup::getKindForSize(is64Bit() ? 8 : 4, false));
1546bafe6902SSam Clegg       const MCExpr *Expr = Fixup.getValue();
1547bafe6902SSam Clegg       auto *Sym = dyn_cast<MCSymbolRefExpr>(Expr);
1548bafe6902SSam Clegg       if (!Sym)
1549bafe6902SSam Clegg         report_fatal_error("fixups in .init_array should be symbol references");
1550bafe6902SSam Clegg       if (Sym->getKind() != MCSymbolRefExpr::VK_WebAssembly_FUNCTION)
1551bafe6902SSam Clegg         report_fatal_error("symbols in .init_array should be for functions");
155225d8e68bSSam Clegg       if (Sym->getSymbol().getIndex() == INVALID_INDEX)
155325d8e68bSSam Clegg         report_fatal_error("symbols in .init_array should exist in symbtab");
155425d8e68bSSam Clegg       InitFuncs.push_back(
155525d8e68bSSam Clegg           std::make_pair(Priority, Sym->getSymbol().getIndex()));
1556bafe6902SSam Clegg     }
1557bafe6902SSam Clegg   }
1558bafe6902SSam Clegg 
155918eafb6cSDan Gohman   // Write out the Wasm header.
156018eafb6cSDan Gohman   writeHeader(Asm);
156118eafb6cSDan Gohman 
1562da419bdbSHeejin Ahn   writeTypeSection(Signatures);
1563f950b24aSSam Clegg   writeImportSection(Imports, DataSize, TableElems.size());
15649e15f359SSam Clegg   writeFunctionSection(Functions);
1565f950b24aSSam Clegg   // Skip the "table" section; we import the table instead.
1566f950b24aSSam Clegg   // Skip the "memory" section; we import the memory instead.
15677c395943SSam Clegg   writeGlobalSection();
1568da419bdbSHeejin Ahn   writeEventSection(Events);
15699e15f359SSam Clegg   writeExportSection(Exports);
15709e15f359SSam Clegg   writeElemSection(TableElems);
1571acd7d2b0SSam Clegg   writeCodeSection(Asm, Layout, Functions);
15726c899ba6SSam Clegg   writeDataSection();
15736a31a0d6SSam Clegg   writeCustomSections(Asm, Layout);
1574c22bfb6bSNicholas Wilson   writeLinkingMetaDataSection(SymbolInfos, InitFuncs, Comdats);
15756f08c84aSSam Clegg   writeRelocSection(CodeSectionIndex, "CODE", CodeRelocations);
15766f08c84aSSam Clegg   writeRelocSection(DataSectionIndex, "DATA", DataRelocations);
15776a31a0d6SSam Clegg   writeCustomRelocSections();
1578970d02c4SDan Gohman 
1579d934cb88SDan Gohman   // TODO: Translate the .comment section to the output.
1580438390faSPeter Collingbourne   return W.OS.tell() - StartOffset;
158118eafb6cSDan Gohman }
158218eafb6cSDan Gohman 
158360fbc7ccSLang Hames std::unique_ptr<MCObjectWriter>
15841301a878SLang Hames llvm::createWasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW,
158518eafb6cSDan Gohman                              raw_pwrite_stream &OS) {
15860917c9e4SDan Gohman   return llvm::make_unique<WasmObjectWriter>(std::move(MOTW), OS);
158718eafb6cSDan Gohman }
1588