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"
1718eafb6cSDan Gohman #include "llvm/MC/MCAsmBackend.h"
1818eafb6cSDan Gohman #include "llvm/MC/MCAsmLayout.h"
1918eafb6cSDan Gohman #include "llvm/MC/MCAssembler.h"
2018eafb6cSDan Gohman #include "llvm/MC/MCContext.h"
2118eafb6cSDan Gohman #include "llvm/MC/MCExpr.h"
2218eafb6cSDan Gohman #include "llvm/MC/MCFixupKindInfo.h"
2318eafb6cSDan Gohman #include "llvm/MC/MCObjectWriter.h"
2418eafb6cSDan Gohman #include "llvm/MC/MCSectionWasm.h"
2518eafb6cSDan Gohman #include "llvm/MC/MCSymbolWasm.h"
2618eafb6cSDan Gohman #include "llvm/MC/MCValue.h"
2718eafb6cSDan Gohman #include "llvm/MC/MCWasmObjectWriter.h"
28d934cb88SDan Gohman #include "llvm/Support/Casting.h"
2918eafb6cSDan Gohman #include "llvm/Support/Debug.h"
3018eafb6cSDan Gohman #include "llvm/Support/ErrorHandling.h"
31d934cb88SDan Gohman #include "llvm/Support/LEB128.h"
3218eafb6cSDan Gohman #include "llvm/Support/StringSaver.h"
3318eafb6cSDan Gohman #include <vector>
3418eafb6cSDan Gohman 
3518eafb6cSDan Gohman using namespace llvm;
3618eafb6cSDan Gohman 
375e3d33a7SSam Clegg #define DEBUG_TYPE "mc"
3818eafb6cSDan Gohman 
3918eafb6cSDan Gohman namespace {
409e15f359SSam Clegg 
4130e1bbc1SSam Clegg // Went we ceate the indirect function table we start at 1, so that there is
4230e1bbc1SSam Clegg // and emtpy slot at 0 and therefore calling a null function pointer will trap.
4330e1bbc1SSam Clegg static const uint32_t kInitialTableOffset = 1;
4430e1bbc1SSam Clegg 
45d934cb88SDan Gohman // For patching purposes, we need to remember where each section starts, both
46d934cb88SDan Gohman // for patching up the section size field, and for patching up references to
47d934cb88SDan Gohman // locations within the section.
48d934cb88SDan Gohman struct SectionBookkeeping {
49d934cb88SDan Gohman   // Where the size of the section is written.
50d934cb88SDan Gohman   uint64_t SizeOffset;
51d934cb88SDan Gohman   // Where the contents of the section starts (after the header).
52d934cb88SDan Gohman   uint64_t ContentsOffset;
53d934cb88SDan Gohman };
54d934cb88SDan Gohman 
559e15f359SSam Clegg // The signature of a wasm function, in a struct capable of being used as a
569e15f359SSam Clegg // DenseMap key.
579e15f359SSam Clegg struct WasmFunctionType {
589e15f359SSam Clegg   // Support empty and tombstone instances, needed by DenseMap.
599e15f359SSam Clegg   enum { Plain, Empty, Tombstone } State;
609e15f359SSam Clegg 
619e15f359SSam Clegg   // The return types of the function.
629e15f359SSam Clegg   SmallVector<wasm::ValType, 1> Returns;
639e15f359SSam Clegg 
649e15f359SSam Clegg   // The parameter types of the function.
659e15f359SSam Clegg   SmallVector<wasm::ValType, 4> Params;
669e15f359SSam Clegg 
679e15f359SSam Clegg   WasmFunctionType() : State(Plain) {}
689e15f359SSam Clegg 
699e15f359SSam Clegg   bool operator==(const WasmFunctionType &Other) const {
709e15f359SSam Clegg     return State == Other.State && Returns == Other.Returns &&
719e15f359SSam Clegg            Params == Other.Params;
729e15f359SSam Clegg   }
739e15f359SSam Clegg };
749e15f359SSam Clegg 
759e15f359SSam Clegg // Traits for using WasmFunctionType in a DenseMap.
769e15f359SSam Clegg struct WasmFunctionTypeDenseMapInfo {
779e15f359SSam Clegg   static WasmFunctionType getEmptyKey() {
789e15f359SSam Clegg     WasmFunctionType FuncTy;
799e15f359SSam Clegg     FuncTy.State = WasmFunctionType::Empty;
809e15f359SSam Clegg     return FuncTy;
819e15f359SSam Clegg   }
829e15f359SSam Clegg   static WasmFunctionType getTombstoneKey() {
839e15f359SSam Clegg     WasmFunctionType FuncTy;
849e15f359SSam Clegg     FuncTy.State = WasmFunctionType::Tombstone;
859e15f359SSam Clegg     return FuncTy;
869e15f359SSam Clegg   }
879e15f359SSam Clegg   static unsigned getHashValue(const WasmFunctionType &FuncTy) {
889e15f359SSam Clegg     uintptr_t Value = FuncTy.State;
899e15f359SSam Clegg     for (wasm::ValType Ret : FuncTy.Returns)
909e15f359SSam Clegg       Value += DenseMapInfo<int32_t>::getHashValue(int32_t(Ret));
919e15f359SSam Clegg     for (wasm::ValType Param : FuncTy.Params)
929e15f359SSam Clegg       Value += DenseMapInfo<int32_t>::getHashValue(int32_t(Param));
939e15f359SSam Clegg     return Value;
949e15f359SSam Clegg   }
959e15f359SSam Clegg   static bool isEqual(const WasmFunctionType &LHS,
969e15f359SSam Clegg                       const WasmFunctionType &RHS) {
979e15f359SSam Clegg     return LHS == RHS;
989e15f359SSam Clegg   }
999e15f359SSam Clegg };
1009e15f359SSam Clegg 
1017c395943SSam Clegg // A wasm data segment.  A wasm binary contains only a single data section
1027c395943SSam Clegg // but that can contain many segments, each with their own virtual location
1037c395943SSam Clegg // in memory.  Each MCSection data created by llvm is modeled as its own
1047c395943SSam Clegg // wasm data segment.
1057c395943SSam Clegg struct WasmDataSegment {
1067c395943SSam Clegg   MCSectionWasm *Section;
107d95ed959SSam Clegg   StringRef Name;
1087c395943SSam Clegg   uint32_t Offset;
10963ebb813SSam Clegg   uint32_t Alignment;
11063ebb813SSam Clegg   uint32_t Flags;
1117c395943SSam Clegg   SmallVector<char, 4> Data;
1127c395943SSam Clegg };
1137c395943SSam Clegg 
1149e15f359SSam Clegg // A wasm import to be written into the import section.
1159e15f359SSam Clegg struct WasmImport {
1169e15f359SSam Clegg   StringRef ModuleName;
1179e15f359SSam Clegg   StringRef FieldName;
1189e15f359SSam Clegg   unsigned Kind;
1199e15f359SSam Clegg   int32_t Type;
12032ce5ca0SDan Gohman   bool IsMutable;
1219e15f359SSam Clegg };
1229e15f359SSam Clegg 
1239e15f359SSam Clegg // A wasm function to be written into the function section.
1249e15f359SSam Clegg struct WasmFunction {
1259e15f359SSam Clegg   int32_t Type;
1269e15f359SSam Clegg   const MCSymbolWasm *Sym;
1279e15f359SSam Clegg };
1289e15f359SSam Clegg 
1299e15f359SSam Clegg // A wasm export to be written into the export section.
1309e15f359SSam Clegg struct WasmExport {
1319e15f359SSam Clegg   StringRef FieldName;
1329e15f359SSam Clegg   unsigned Kind;
1339e15f359SSam Clegg   uint32_t Index;
1349e15f359SSam Clegg };
1359e15f359SSam Clegg 
1369e15f359SSam Clegg // A wasm global to be written into the global section.
1379e15f359SSam Clegg struct WasmGlobal {
138*6e7f1826SSam Clegg   wasm::WasmGlobalType Type;
1399e15f359SSam Clegg   uint64_t InitialValue;
1409e15f359SSam Clegg };
1419e15f359SSam Clegg 
142ea7caceeSSam Clegg // Information about a single item which is part of a COMDAT.  For each data
143ea7caceeSSam Clegg // segment or function which is in the COMDAT, there is a corresponding
144ea7caceeSSam Clegg // WasmComdatEntry.
145ea7caceeSSam Clegg struct WasmComdatEntry {
146ea7caceeSSam Clegg   unsigned Kind;
147ea7caceeSSam Clegg   uint32_t Index;
148ea7caceeSSam Clegg };
149ea7caceeSSam Clegg 
1506dc65e91SSam Clegg // Information about a single relocation.
1516dc65e91SSam Clegg struct WasmRelocationEntry {
1526dc65e91SSam Clegg   uint64_t Offset;                  // Where is the relocation.
1536dc65e91SSam Clegg   const MCSymbolWasm *Symbol;       // The symbol to relocate with.
1546dc65e91SSam Clegg   int64_t Addend;                   // A value to add to the symbol.
1556dc65e91SSam Clegg   unsigned Type;                    // The type of the relocation.
156fe6414b0SSam Clegg   const MCSectionWasm *FixupSection;// The section the relocation is targeting.
1576dc65e91SSam Clegg 
1586dc65e91SSam Clegg   WasmRelocationEntry(uint64_t Offset, const MCSymbolWasm *Symbol,
1596dc65e91SSam Clegg                       int64_t Addend, unsigned Type,
160fe6414b0SSam Clegg                       const MCSectionWasm *FixupSection)
1616dc65e91SSam Clegg       : Offset(Offset), Symbol(Symbol), Addend(Addend), Type(Type),
1626dc65e91SSam Clegg         FixupSection(FixupSection) {}
1636dc65e91SSam Clegg 
164acd7d2b0SSam Clegg   bool hasAddend() const {
165acd7d2b0SSam Clegg     switch (Type) {
16613a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB:
16713a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB:
16813a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32:
169acd7d2b0SSam Clegg       return true;
170acd7d2b0SSam Clegg     default:
171acd7d2b0SSam Clegg       return false;
172acd7d2b0SSam Clegg     }
173acd7d2b0SSam Clegg   }
174acd7d2b0SSam Clegg 
1756dc65e91SSam Clegg   void print(raw_ostream &Out) const {
1769bf73c07SSam Clegg     Out << "Off=" << Offset << ", Sym=" << *Symbol << ", Addend=" << Addend
177759631c7SSam Clegg         << ", Type=" << Type
178759631c7SSam Clegg         << ", FixupSection=" << FixupSection->getSectionName();
1796dc65e91SSam Clegg   }
180b7787fd0SSam Clegg 
181615eb470SAaron Ballman #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
182b7787fd0SSam Clegg   LLVM_DUMP_METHOD void dump() const { print(dbgs()); }
183b7787fd0SSam Clegg #endif
1846dc65e91SSam Clegg };
1856dc65e91SSam Clegg 
1861fb8daa6SSam Clegg #if !defined(NDEBUG)
1877f055deeSSam Clegg raw_ostream &operator<<(raw_ostream &OS, const WasmRelocationEntry &Rel) {
188b7787fd0SSam Clegg   Rel.print(OS);
189b7787fd0SSam Clegg   return OS;
190b7787fd0SSam Clegg }
1911fb8daa6SSam Clegg #endif
192b7787fd0SSam Clegg 
19318eafb6cSDan Gohman class WasmObjectWriter : public MCObjectWriter {
19418eafb6cSDan Gohman   /// The target specific Wasm writer instance.
19518eafb6cSDan Gohman   std::unique_ptr<MCWasmObjectTargetWriter> TargetObjectWriter;
19618eafb6cSDan Gohman 
197d934cb88SDan Gohman   // Relocations for fixing up references in the code section.
198d934cb88SDan Gohman   std::vector<WasmRelocationEntry> CodeRelocations;
199d934cb88SDan Gohman 
200d934cb88SDan Gohman   // Relocations for fixing up references in the data section.
201d934cb88SDan Gohman   std::vector<WasmRelocationEntry> DataRelocations;
202d934cb88SDan Gohman 
203d934cb88SDan Gohman   // Index values to use for fixing up call_indirect type indices.
204acd7d2b0SSam Clegg   // Maps function symbols to the index of the type of the function
205acd7d2b0SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> TypeIndices;
206d99f6078SSam Clegg   // Maps function symbols to the table element index space. Used
207d99f6078SSam Clegg   // for TABLE_INDEX relocation types (i.e. address taken functions).
208f9edbe95SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> TableIndices;
209d99f6078SSam Clegg   // Maps function/global symbols to the function/global index space.
210acd7d2b0SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> SymbolIndices;
211acd7d2b0SSam Clegg 
212acd7d2b0SSam Clegg   DenseMap<WasmFunctionType, int32_t, WasmFunctionTypeDenseMapInfo>
213acd7d2b0SSam Clegg       FunctionTypeIndices;
2145e3d33a7SSam Clegg   SmallVector<WasmFunctionType, 4> FunctionTypes;
2157c395943SSam Clegg   SmallVector<WasmGlobal, 4> Globals;
2169f3fe42eSSam Clegg   unsigned NumFunctionImports = 0;
2177c395943SSam Clegg   unsigned NumGlobalImports = 0;
218d934cb88SDan Gohman 
21918eafb6cSDan Gohman   // TargetObjectWriter wrappers.
22018eafb6cSDan Gohman   bool is64Bit() const { return TargetObjectWriter->is64Bit(); }
221ae03c1e7SSam Clegg   unsigned getRelocType(const MCValue &Target, const MCFixup &Fixup) const {
222ae03c1e7SSam Clegg     return TargetObjectWriter->getRelocType(Target, Fixup);
22318eafb6cSDan Gohman   }
22418eafb6cSDan Gohman 
225d934cb88SDan Gohman   void startSection(SectionBookkeeping &Section, unsigned SectionId,
226d934cb88SDan Gohman                     const char *Name = nullptr);
227d934cb88SDan Gohman   void endSection(SectionBookkeeping &Section);
228d934cb88SDan Gohman 
22918eafb6cSDan Gohman public:
2301301a878SLang Hames   WasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW,
2311301a878SLang Hames                    raw_pwrite_stream &OS)
2321301a878SLang Hames       : MCObjectWriter(OS, /*IsLittleEndian=*/true),
2331301a878SLang Hames         TargetObjectWriter(std::move(MOTW)) {}
23418eafb6cSDan Gohman 
23518eafb6cSDan Gohman   ~WasmObjectWriter() override;
23618eafb6cSDan Gohman 
2370917c9e4SDan Gohman private:
238acd7d2b0SSam Clegg   void reset() override {
239acd7d2b0SSam Clegg     CodeRelocations.clear();
240acd7d2b0SSam Clegg     DataRelocations.clear();
241acd7d2b0SSam Clegg     TypeIndices.clear();
242acd7d2b0SSam Clegg     SymbolIndices.clear();
243f9edbe95SSam Clegg     TableIndices.clear();
244acd7d2b0SSam Clegg     FunctionTypeIndices.clear();
2455e3d33a7SSam Clegg     FunctionTypes.clear();
2467c395943SSam Clegg     Globals.clear();
247acd7d2b0SSam Clegg     MCObjectWriter::reset();
2489f3fe42eSSam Clegg     NumFunctionImports = 0;
2497c395943SSam Clegg     NumGlobalImports = 0;
250acd7d2b0SSam Clegg   }
251acd7d2b0SSam Clegg 
25218eafb6cSDan Gohman   void writeHeader(const MCAssembler &Asm);
25318eafb6cSDan Gohman 
25418eafb6cSDan Gohman   void recordRelocation(MCAssembler &Asm, const MCAsmLayout &Layout,
25518eafb6cSDan Gohman                         const MCFragment *Fragment, const MCFixup &Fixup,
256ceecfe5bSRafael Espindola                         MCValue Target, uint64_t &FixedValue) override;
25718eafb6cSDan Gohman 
25818eafb6cSDan Gohman   void executePostLayoutBinding(MCAssembler &Asm,
25918eafb6cSDan Gohman                                 const MCAsmLayout &Layout) override;
26018eafb6cSDan Gohman 
26118eafb6cSDan Gohman   void writeObject(MCAssembler &Asm, const MCAsmLayout &Layout) override;
2629e15f359SSam Clegg 
263b7787fd0SSam Clegg   void writeString(const StringRef Str) {
264b7787fd0SSam Clegg     encodeULEB128(Str.size(), getStream());
265b7787fd0SSam Clegg     writeBytes(Str);
266b7787fd0SSam Clegg   }
267b7787fd0SSam Clegg 
2689e15f359SSam Clegg   void writeValueType(wasm::ValType Ty) {
2699e15f359SSam Clegg     encodeSLEB128(int32_t(Ty), getStream());
2709e15f359SSam Clegg   }
2719e15f359SSam Clegg 
272457fb0b4SSam Clegg   void writeTypeSection(ArrayRef<WasmFunctionType> FunctionTypes);
273f950b24aSSam Clegg   void writeImportSection(ArrayRef<WasmImport> Imports, uint32_t DataSize,
274f950b24aSSam Clegg                           uint32_t NumElements);
275457fb0b4SSam Clegg   void writeFunctionSection(ArrayRef<WasmFunction> Functions);
2767c395943SSam Clegg   void writeGlobalSection();
277457fb0b4SSam Clegg   void writeExportSection(ArrayRef<WasmExport> Exports);
278457fb0b4SSam Clegg   void writeElemSection(ArrayRef<uint32_t> TableElems);
2799e15f359SSam Clegg   void writeCodeSection(const MCAssembler &Asm, const MCAsmLayout &Layout,
280457fb0b4SSam Clegg                         ArrayRef<WasmFunction> Functions);
281457fb0b4SSam Clegg   void writeDataSection(ArrayRef<WasmDataSegment> Segments);
282acd7d2b0SSam Clegg   void writeCodeRelocSection();
2837c395943SSam Clegg   void writeDataRelocSection();
28431a2c809SSam Clegg   void writeLinkingMetaDataSection(
28531a2c809SSam Clegg       ArrayRef<WasmDataSegment> Segments, uint32_t DataSize,
286ea7caceeSSam Clegg       ArrayRef<std::pair<StringRef, uint32_t>> SymbolFlags,
287ea7caceeSSam Clegg       ArrayRef<std::pair<uint16_t, uint32_t>> InitFuncs,
288ea7caceeSSam Clegg       const std::map<StringRef, std::vector<WasmComdatEntry>>& Comdats);
289acd7d2b0SSam Clegg 
2907c395943SSam Clegg   uint32_t getProvisionalValue(const WasmRelocationEntry &RelEntry);
291acd7d2b0SSam Clegg   void applyRelocations(ArrayRef<WasmRelocationEntry> Relocations,
292acd7d2b0SSam Clegg                         uint64_t ContentsOffset);
293acd7d2b0SSam Clegg 
2947c395943SSam Clegg   void writeRelocations(ArrayRef<WasmRelocationEntry> Relocations);
295acd7d2b0SSam Clegg   uint32_t getRelocationIndexValue(const WasmRelocationEntry &RelEntry);
2965e3d33a7SSam Clegg   uint32_t getFunctionType(const MCSymbolWasm& Symbol);
2975e3d33a7SSam Clegg   uint32_t registerFunctionType(const MCSymbolWasm& Symbol);
29818eafb6cSDan Gohman };
2999e15f359SSam Clegg 
30018eafb6cSDan Gohman } // end anonymous namespace
30118eafb6cSDan Gohman 
30218eafb6cSDan Gohman WasmObjectWriter::~WasmObjectWriter() {}
30318eafb6cSDan Gohman 
304d934cb88SDan Gohman // Write out a section header and a patchable section size field.
305d934cb88SDan Gohman void WasmObjectWriter::startSection(SectionBookkeeping &Section,
306d934cb88SDan Gohman                                     unsigned SectionId,
307d934cb88SDan Gohman                                     const char *Name) {
308d934cb88SDan Gohman   assert((Name != nullptr) == (SectionId == wasm::WASM_SEC_CUSTOM) &&
309d934cb88SDan Gohman          "Only custom sections can have names");
310d934cb88SDan Gohman 
311b7787fd0SSam Clegg   DEBUG(dbgs() << "startSection " << SectionId << ": " << Name << "\n");
312e2688c43SDerek Schuff   encodeULEB128(SectionId, getStream());
313d934cb88SDan Gohman 
314d934cb88SDan Gohman   Section.SizeOffset = getStream().tell();
315d934cb88SDan Gohman 
316d934cb88SDan Gohman   // The section size. We don't know the size yet, so reserve enough space
317d934cb88SDan Gohman   // for any 32-bit value; we'll patch it later.
318d934cb88SDan Gohman   encodeULEB128(UINT32_MAX, getStream());
319d934cb88SDan Gohman 
320d934cb88SDan Gohman   // The position where the section starts, for measuring its size.
321d934cb88SDan Gohman   Section.ContentsOffset = getStream().tell();
322d934cb88SDan Gohman 
323d934cb88SDan Gohman   // Custom sections in wasm also have a string identifier.
324d934cb88SDan Gohman   if (SectionId == wasm::WASM_SEC_CUSTOM) {
325b7787fd0SSam Clegg     assert(Name);
326b7787fd0SSam Clegg     writeString(StringRef(Name));
327d934cb88SDan Gohman   }
328d934cb88SDan Gohman }
329d934cb88SDan Gohman 
330d934cb88SDan Gohman // Now that the section is complete and we know how big it is, patch up the
331d934cb88SDan Gohman // section size field at the start of the section.
332d934cb88SDan Gohman void WasmObjectWriter::endSection(SectionBookkeeping &Section) {
333d934cb88SDan Gohman   uint64_t Size = getStream().tell() - Section.ContentsOffset;
334d934cb88SDan Gohman   if (uint32_t(Size) != Size)
335d934cb88SDan Gohman     report_fatal_error("section size does not fit in a uint32_t");
336d934cb88SDan Gohman 
337b7787fd0SSam Clegg   DEBUG(dbgs() << "endSection size=" << Size << "\n");
338d934cb88SDan Gohman 
339d934cb88SDan Gohman   // Write the final section size to the payload_len field, which follows
340d934cb88SDan Gohman   // the section id byte.
341d934cb88SDan Gohman   uint8_t Buffer[16];
34266a99e41SSam Clegg   unsigned SizeLen = encodeULEB128(Size, Buffer, 5);
343d934cb88SDan Gohman   assert(SizeLen == 5);
344d934cb88SDan Gohman   getStream().pwrite((char *)Buffer, SizeLen, Section.SizeOffset);
345d934cb88SDan Gohman }
346d934cb88SDan Gohman 
34718eafb6cSDan Gohman // Emit the Wasm header.
34818eafb6cSDan Gohman void WasmObjectWriter::writeHeader(const MCAssembler &Asm) {
3497ea5adffSDan Gohman   writeBytes(StringRef(wasm::WasmMagic, sizeof(wasm::WasmMagic)));
3507ea5adffSDan Gohman   writeLE32(wasm::WasmVersion);
35118eafb6cSDan Gohman }
35218eafb6cSDan Gohman 
35318eafb6cSDan Gohman void WasmObjectWriter::executePostLayoutBinding(MCAssembler &Asm,
35418eafb6cSDan Gohman                                                 const MCAsmLayout &Layout) {
35518eafb6cSDan Gohman }
35618eafb6cSDan Gohman 
35718eafb6cSDan Gohman void WasmObjectWriter::recordRelocation(MCAssembler &Asm,
35818eafb6cSDan Gohman                                         const MCAsmLayout &Layout,
35918eafb6cSDan Gohman                                         const MCFragment *Fragment,
36018eafb6cSDan Gohman                                         const MCFixup &Fixup, MCValue Target,
361ceecfe5bSRafael Espindola                                         uint64_t &FixedValue) {
362ceecfe5bSRafael Espindola   MCAsmBackend &Backend = Asm.getBackend();
363ceecfe5bSRafael Espindola   bool IsPCRel = Backend.getFixupKindInfo(Fixup.getKind()).Flags &
364ceecfe5bSRafael Espindola                  MCFixupKindInfo::FKF_IsPCRel;
365fe6414b0SSam Clegg   const auto &FixupSection = cast<MCSectionWasm>(*Fragment->getParent());
366d934cb88SDan Gohman   uint64_t C = Target.getConstant();
367d934cb88SDan Gohman   uint64_t FixupOffset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
368d934cb88SDan Gohman   MCContext &Ctx = Asm.getContext();
369d934cb88SDan Gohman 
370bafe6902SSam Clegg   // The .init_array isn't translated as data, so don't do relocations in it.
371bafe6902SSam Clegg   if (FixupSection.getSectionName().startswith(".init_array"))
372bafe6902SSam Clegg     return;
373bafe6902SSam Clegg 
374d934cb88SDan Gohman   if (const MCSymbolRefExpr *RefB = Target.getSymB()) {
375d934cb88SDan Gohman     assert(RefB->getKind() == MCSymbolRefExpr::VK_None &&
376d934cb88SDan Gohman            "Should not have constructed this");
377d934cb88SDan Gohman 
378d934cb88SDan Gohman     // Let A, B and C being the components of Target and R be the location of
379d934cb88SDan Gohman     // the fixup. If the fixup is not pcrel, we want to compute (A - B + C).
380d934cb88SDan Gohman     // If it is pcrel, we want to compute (A - B + C - R).
381d934cb88SDan Gohman 
382d934cb88SDan Gohman     // In general, Wasm has no relocations for -B. It can only represent (A + C)
383d934cb88SDan Gohman     // or (A + C - R). If B = R + K and the relocation is not pcrel, we can
384d934cb88SDan Gohman     // replace B to implement it: (A - R - K + C)
385d934cb88SDan Gohman     if (IsPCRel) {
386d934cb88SDan Gohman       Ctx.reportError(
387d934cb88SDan Gohman           Fixup.getLoc(),
388d934cb88SDan Gohman           "No relocation available to represent this relative expression");
389d934cb88SDan Gohman       return;
390d934cb88SDan Gohman     }
391d934cb88SDan Gohman 
392d934cb88SDan Gohman     const auto &SymB = cast<MCSymbolWasm>(RefB->getSymbol());
393d934cb88SDan Gohman 
394d934cb88SDan Gohman     if (SymB.isUndefined()) {
395d934cb88SDan Gohman       Ctx.reportError(Fixup.getLoc(),
396d934cb88SDan Gohman                       Twine("symbol '") + SymB.getName() +
397d934cb88SDan Gohman                           "' can not be undefined in a subtraction expression");
398d934cb88SDan Gohman       return;
399d934cb88SDan Gohman     }
400d934cb88SDan Gohman 
401d934cb88SDan Gohman     assert(!SymB.isAbsolute() && "Should have been folded");
402d934cb88SDan Gohman     const MCSection &SecB = SymB.getSection();
403d934cb88SDan Gohman     if (&SecB != &FixupSection) {
404d934cb88SDan Gohman       Ctx.reportError(Fixup.getLoc(),
405d934cb88SDan Gohman                       "Cannot represent a difference across sections");
406d934cb88SDan Gohman       return;
407d934cb88SDan Gohman     }
408d934cb88SDan Gohman 
409d934cb88SDan Gohman     uint64_t SymBOffset = Layout.getSymbolOffset(SymB);
410d934cb88SDan Gohman     uint64_t K = SymBOffset - FixupOffset;
411d934cb88SDan Gohman     IsPCRel = true;
412d934cb88SDan Gohman     C -= K;
413d934cb88SDan Gohman   }
414d934cb88SDan Gohman 
415d934cb88SDan Gohman   // We either rejected the fixup or folded B into C at this point.
416d934cb88SDan Gohman   const MCSymbolRefExpr *RefA = Target.getSymA();
417d934cb88SDan Gohman   const auto *SymA = RefA ? cast<MCSymbolWasm>(&RefA->getSymbol()) : nullptr;
418d934cb88SDan Gohman 
419d934cb88SDan Gohman   if (SymA && SymA->isVariable()) {
420d934cb88SDan Gohman     const MCExpr *Expr = SymA->getVariableValue();
4216ad8f190SSam Clegg     const auto *Inner = cast<MCSymbolRefExpr>(Expr);
4226ad8f190SSam Clegg     if (Inner->getKind() == MCSymbolRefExpr::VK_WEAKREF)
4236ad8f190SSam Clegg       llvm_unreachable("weakref used in reloc not yet implemented");
424d934cb88SDan Gohman   }
425d934cb88SDan Gohman 
426d934cb88SDan Gohman   // Put any constant offset in an addend. Offsets can be negative, and
427d934cb88SDan Gohman   // LLVM expects wrapping, in contrast to wasm's immediates which can't
428d934cb88SDan Gohman   // be negative and don't wrap.
429d934cb88SDan Gohman   FixedValue = 0;
430d934cb88SDan Gohman 
4316ad8f190SSam Clegg   if (SymA)
432d934cb88SDan Gohman     SymA->setUsedInReloc();
433d934cb88SDan Gohman 
434ae03c1e7SSam Clegg   assert(!IsPCRel);
4359d24fb7fSSam Clegg   assert(SymA);
4369d24fb7fSSam Clegg 
437ae03c1e7SSam Clegg   unsigned Type = getRelocType(Target, Fixup);
438ae03c1e7SSam Clegg 
439d934cb88SDan Gohman   WasmRelocationEntry Rec(FixupOffset, SymA, C, Type, &FixupSection);
440b7787fd0SSam Clegg   DEBUG(dbgs() << "WasmReloc: " << Rec << "\n");
441d934cb88SDan Gohman 
44212fd3da9SSam Clegg   if (FixupSection.isWasmData())
443d934cb88SDan Gohman     DataRelocations.push_back(Rec);
44412fd3da9SSam Clegg   else if (FixupSection.getKind().isText())
44512fd3da9SSam Clegg     CodeRelocations.push_back(Rec);
44612fd3da9SSam Clegg   else if (!FixupSection.getKind().isMetadata())
44712fd3da9SSam Clegg     // TODO(sbc): Add support for debug sections.
44812fd3da9SSam Clegg     llvm_unreachable("unexpected section type");
449d934cb88SDan Gohman }
450d934cb88SDan Gohman 
451d934cb88SDan Gohman // Write X as an (unsigned) LEB value at offset Offset in Stream, padded
452d934cb88SDan Gohman // to allow patching.
453d934cb88SDan Gohman static void
454d934cb88SDan Gohman WritePatchableLEB(raw_pwrite_stream &Stream, uint32_t X, uint64_t Offset) {
455d934cb88SDan Gohman   uint8_t Buffer[5];
45666a99e41SSam Clegg   unsigned SizeLen = encodeULEB128(X, Buffer, 5);
457d934cb88SDan Gohman   assert(SizeLen == 5);
458d934cb88SDan Gohman   Stream.pwrite((char *)Buffer, SizeLen, Offset);
459d934cb88SDan Gohman }
460d934cb88SDan Gohman 
461d934cb88SDan Gohman // Write X as an signed LEB value at offset Offset in Stream, padded
462d934cb88SDan Gohman // to allow patching.
463d934cb88SDan Gohman static void
464d934cb88SDan Gohman WritePatchableSLEB(raw_pwrite_stream &Stream, int32_t X, uint64_t Offset) {
465d934cb88SDan Gohman   uint8_t Buffer[5];
46666a99e41SSam Clegg   unsigned SizeLen = encodeSLEB128(X, Buffer, 5);
467d934cb88SDan Gohman   assert(SizeLen == 5);
468d934cb88SDan Gohman   Stream.pwrite((char *)Buffer, SizeLen, Offset);
469d934cb88SDan Gohman }
470d934cb88SDan Gohman 
471d934cb88SDan Gohman // Write X as a plain integer value at offset Offset in Stream.
472d934cb88SDan Gohman static void WriteI32(raw_pwrite_stream &Stream, uint32_t X, uint64_t Offset) {
473d934cb88SDan Gohman   uint8_t Buffer[4];
474d934cb88SDan Gohman   support::endian::write32le(Buffer, X);
475d934cb88SDan Gohman   Stream.pwrite((char *)Buffer, sizeof(Buffer), Offset);
476d934cb88SDan Gohman }
477d934cb88SDan Gohman 
478aff1c4dfSSam Clegg static const MCSymbolWasm* ResolveSymbol(const MCSymbolWasm& Symbol) {
479aff1c4dfSSam Clegg   if (Symbol.isVariable()) {
480aff1c4dfSSam Clegg     const MCExpr *Expr = Symbol.getVariableValue();
481aff1c4dfSSam Clegg     auto *Inner = cast<MCSymbolRefExpr>(Expr);
482aff1c4dfSSam Clegg     return cast<MCSymbolWasm>(&Inner->getSymbol());
483aff1c4dfSSam Clegg   }
484aff1c4dfSSam Clegg   return &Symbol;
485aff1c4dfSSam Clegg }
486aff1c4dfSSam Clegg 
487d934cb88SDan Gohman // Compute a value to write into the code at the location covered
48860ec3034SSam Clegg // by RelEntry. This value isn't used by the static linker; it just serves
48960ec3034SSam Clegg // to make the object format more readable and more likely to be directly
49060ec3034SSam Clegg // useable.
4917c395943SSam Clegg uint32_t
4927c395943SSam Clegg WasmObjectWriter::getProvisionalValue(const WasmRelocationEntry &RelEntry) {
49360ec3034SSam Clegg   switch (RelEntry.Type) {
49460ec3034SSam Clegg   case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB:
495f9edbe95SSam Clegg   case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32: {
496f9edbe95SSam Clegg     // Provisional value is table address of the resolved symbol itself
497f9edbe95SSam Clegg     const MCSymbolWasm *Sym = ResolveSymbol(*RelEntry.Symbol);
498f9edbe95SSam Clegg     assert(Sym->isFunction());
499f9edbe95SSam Clegg     return TableIndices[Sym];
500f9edbe95SSam Clegg   }
50160ec3034SSam Clegg   case wasm::R_WEBASSEMBLY_FUNCTION_INDEX_LEB:
50260ec3034SSam Clegg   case wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB:
50360ec3034SSam Clegg   case wasm::R_WEBASSEMBLY_GLOBAL_INDEX_LEB:
504f9edbe95SSam Clegg     // Provisional value is function/type/global index itself
50560ec3034SSam Clegg     return getRelocationIndexValue(RelEntry);
50660ec3034SSam Clegg   case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB:
50760ec3034SSam Clegg   case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32:
50860ec3034SSam Clegg   case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB: {
509f9edbe95SSam Clegg     // Provisional value is address of the global
51060ec3034SSam Clegg     const MCSymbolWasm *Sym = ResolveSymbol(*RelEntry.Symbol);
511270ed1b3SSam Clegg     // For undefined symbols, use zero
512cd65f698SSam Clegg     if (!Sym->isDefined())
513270ed1b3SSam Clegg       return 0;
514d934cb88SDan Gohman 
5157c395943SSam Clegg     uint32_t GlobalIndex = SymbolIndices[Sym];
5167c395943SSam Clegg     const WasmGlobal& Global = Globals[GlobalIndex - NumGlobalImports];
5177c395943SSam Clegg     uint64_t Address = Global.InitialValue + RelEntry.Addend;
518d934cb88SDan Gohman 
519d934cb88SDan Gohman     // Ignore overflow. LLVM allows address arithmetic to silently wrap.
52060ec3034SSam Clegg     return Address;
52160ec3034SSam Clegg   }
52260ec3034SSam Clegg   default:
52360ec3034SSam Clegg     llvm_unreachable("invalid relocation type");
52460ec3034SSam Clegg   }
525d934cb88SDan Gohman }
526d934cb88SDan Gohman 
527759631c7SSam Clegg static void addData(SmallVectorImpl<char> &DataBytes,
52863ebb813SSam Clegg                     MCSectionWasm &DataSection) {
529759631c7SSam Clegg   DEBUG(errs() << "addData: " << DataSection.getSectionName() << "\n");
530759631c7SSam Clegg 
53163ebb813SSam Clegg   DataBytes.resize(alignTo(DataBytes.size(), DataSection.getAlignment()));
53263ebb813SSam Clegg 
533c55d13f4SSam Clegg   size_t LastFragmentSize = 0;
534759631c7SSam Clegg   for (const MCFragment &Frag : DataSection) {
535759631c7SSam Clegg     if (Frag.hasInstructions())
536759631c7SSam Clegg       report_fatal_error("only data supported in data sections");
537759631c7SSam Clegg 
538759631c7SSam Clegg     if (auto *Align = dyn_cast<MCAlignFragment>(&Frag)) {
539759631c7SSam Clegg       if (Align->getValueSize() != 1)
540759631c7SSam Clegg         report_fatal_error("only byte values supported for alignment");
541759631c7SSam Clegg       // If nops are requested, use zeros, as this is the data section.
542759631c7SSam Clegg       uint8_t Value = Align->hasEmitNops() ? 0 : Align->getValue();
543759631c7SSam Clegg       uint64_t Size = std::min<uint64_t>(alignTo(DataBytes.size(),
544759631c7SSam Clegg                                                  Align->getAlignment()),
545759631c7SSam Clegg                                          DataBytes.size() +
546759631c7SSam Clegg                                              Align->getMaxBytesToEmit());
547759631c7SSam Clegg       DataBytes.resize(Size, Value);
548759631c7SSam Clegg     } else if (auto *Fill = dyn_cast<MCFillFragment>(&Frag)) {
549d707c370SRafael Espindola       int64_t Size;
550d707c370SRafael Espindola       if (!Fill->getSize().evaluateAsAbsolute(Size))
551d707c370SRafael Espindola         llvm_unreachable("The fill should be an assembler constant");
552d707c370SRafael Espindola       DataBytes.insert(DataBytes.end(), Size, Fill->getValue());
553759631c7SSam Clegg     } else {
554759631c7SSam Clegg       const auto &DataFrag = cast<MCDataFragment>(Frag);
555759631c7SSam Clegg       const SmallVectorImpl<char> &Contents = DataFrag.getContents();
556759631c7SSam Clegg 
557759631c7SSam Clegg       DataBytes.insert(DataBytes.end(), Contents.begin(), Contents.end());
558c55d13f4SSam Clegg       LastFragmentSize = Contents.size();
559759631c7SSam Clegg     }
560759631c7SSam Clegg   }
561759631c7SSam Clegg 
562c55d13f4SSam Clegg   // Don't allow empty segments, or segments that end with zero-sized
563c55d13f4SSam Clegg   // fragment, otherwise the linker cannot map symbols to a unique
564c55d13f4SSam Clegg   // data segment.  This can be triggered by zero-sized structs
565c55d13f4SSam Clegg   // See: test/MC/WebAssembly/bss.ll
566c55d13f4SSam Clegg   if (LastFragmentSize == 0)
567c55d13f4SSam Clegg     DataBytes.resize(DataBytes.size() + 1);
568759631c7SSam Clegg   DEBUG(dbgs() << "addData -> " << DataBytes.size() << "\n");
569759631c7SSam Clegg }
570759631c7SSam Clegg 
57160ec3034SSam Clegg uint32_t
57260ec3034SSam Clegg WasmObjectWriter::getRelocationIndexValue(const WasmRelocationEntry &RelEntry) {
57360ec3034SSam Clegg   if (RelEntry.Type == wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB) {
574b7787fd0SSam Clegg     if (!TypeIndices.count(RelEntry.Symbol))
575b7787fd0SSam Clegg       report_fatal_error("symbol not found in type index space: " +
576b7787fd0SSam Clegg                          RelEntry.Symbol->getName());
577acd7d2b0SSam Clegg     return TypeIndices[RelEntry.Symbol];
578acd7d2b0SSam Clegg   }
57960ec3034SSam Clegg 
58060ec3034SSam Clegg   if (!SymbolIndices.count(RelEntry.Symbol))
58160ec3034SSam Clegg     report_fatal_error("symbol not found in function/global index space: " +
58260ec3034SSam Clegg                        RelEntry.Symbol->getName());
58360ec3034SSam Clegg   return SymbolIndices[RelEntry.Symbol];
584acd7d2b0SSam Clegg }
585acd7d2b0SSam Clegg 
586d934cb88SDan Gohman // Apply the portions of the relocation records that we can handle ourselves
587d934cb88SDan Gohman // directly.
588acd7d2b0SSam Clegg void WasmObjectWriter::applyRelocations(
589acd7d2b0SSam Clegg     ArrayRef<WasmRelocationEntry> Relocations, uint64_t ContentsOffset) {
590acd7d2b0SSam Clegg   raw_pwrite_stream &Stream = getStream();
591d934cb88SDan Gohman   for (const WasmRelocationEntry &RelEntry : Relocations) {
592d934cb88SDan Gohman     uint64_t Offset = ContentsOffset +
593d934cb88SDan Gohman                       RelEntry.FixupSection->getSectionOffset() +
594d934cb88SDan Gohman                       RelEntry.Offset;
595d934cb88SDan Gohman 
596b7787fd0SSam Clegg     DEBUG(dbgs() << "applyRelocation: " << RelEntry << "\n");
59760ec3034SSam Clegg     uint32_t Value = getProvisionalValue(RelEntry);
59860ec3034SSam Clegg 
599acd7d2b0SSam Clegg     switch (RelEntry.Type) {
600acd7d2b0SSam Clegg     case wasm::R_WEBASSEMBLY_FUNCTION_INDEX_LEB:
6019d24fb7fSSam Clegg     case wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB:
60260ec3034SSam Clegg     case wasm::R_WEBASSEMBLY_GLOBAL_INDEX_LEB:
60360ec3034SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB:
604d934cb88SDan Gohman       WritePatchableLEB(Stream, Value, Offset);
605d934cb88SDan Gohman       break;
60660ec3034SSam Clegg     case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32:
60760ec3034SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32:
608d934cb88SDan Gohman       WriteI32(Stream, Value, Offset);
609d934cb88SDan Gohman       break;
61060ec3034SSam Clegg     case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB:
61160ec3034SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB:
61260ec3034SSam Clegg       WritePatchableSLEB(Stream, Value, Offset);
61360ec3034SSam Clegg       break;
614d934cb88SDan Gohman     default:
6159d24fb7fSSam Clegg       llvm_unreachable("invalid relocation type");
616d934cb88SDan Gohman     }
617d934cb88SDan Gohman   }
61818eafb6cSDan Gohman }
61918eafb6cSDan Gohman 
620acd7d2b0SSam Clegg // Write out the portions of the relocation records that the linker will
621970d02c4SDan Gohman // need to handle.
622acd7d2b0SSam Clegg void WasmObjectWriter::writeRelocations(
6237c395943SSam Clegg     ArrayRef<WasmRelocationEntry> Relocations) {
624acd7d2b0SSam Clegg   raw_pwrite_stream &Stream = getStream();
625acd7d2b0SSam Clegg   for (const WasmRelocationEntry& RelEntry : Relocations) {
626970d02c4SDan Gohman 
627acd7d2b0SSam Clegg     uint64_t Offset = RelEntry.Offset +
6287c395943SSam Clegg                       RelEntry.FixupSection->getSectionOffset();
629acd7d2b0SSam Clegg     uint32_t Index = getRelocationIndexValue(RelEntry);
630970d02c4SDan Gohman 
631acd7d2b0SSam Clegg     encodeULEB128(RelEntry.Type, Stream);
632970d02c4SDan Gohman     encodeULEB128(Offset, Stream);
633acd7d2b0SSam Clegg     encodeULEB128(Index, Stream);
634acd7d2b0SSam Clegg     if (RelEntry.hasAddend())
635acd7d2b0SSam Clegg       encodeSLEB128(RelEntry.Addend, Stream);
636970d02c4SDan Gohman   }
637970d02c4SDan Gohman }
638970d02c4SDan Gohman 
6399e15f359SSam Clegg void WasmObjectWriter::writeTypeSection(
640457fb0b4SSam Clegg     ArrayRef<WasmFunctionType> FunctionTypes) {
6419e15f359SSam Clegg   if (FunctionTypes.empty())
6429e15f359SSam Clegg     return;
6439e15f359SSam Clegg 
6449e15f359SSam Clegg   SectionBookkeeping Section;
6459e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_TYPE);
6469e15f359SSam Clegg 
6479e15f359SSam Clegg   encodeULEB128(FunctionTypes.size(), getStream());
6489e15f359SSam Clegg 
6499e15f359SSam Clegg   for (const WasmFunctionType &FuncTy : FunctionTypes) {
6509e15f359SSam Clegg     encodeSLEB128(wasm::WASM_TYPE_FUNC, getStream());
6519e15f359SSam Clegg     encodeULEB128(FuncTy.Params.size(), getStream());
6529e15f359SSam Clegg     for (wasm::ValType Ty : FuncTy.Params)
6539e15f359SSam Clegg       writeValueType(Ty);
6549e15f359SSam Clegg     encodeULEB128(FuncTy.Returns.size(), getStream());
6559e15f359SSam Clegg     for (wasm::ValType Ty : FuncTy.Returns)
6569e15f359SSam Clegg       writeValueType(Ty);
6579e15f359SSam Clegg   }
6589e15f359SSam Clegg 
6599e15f359SSam Clegg   endSection(Section);
6609e15f359SSam Clegg }
6619e15f359SSam Clegg 
662f950b24aSSam Clegg void WasmObjectWriter::writeImportSection(ArrayRef<WasmImport> Imports,
663f950b24aSSam Clegg                                           uint32_t DataSize,
664f950b24aSSam Clegg                                           uint32_t NumElements) {
6659e15f359SSam Clegg   if (Imports.empty())
6669e15f359SSam Clegg     return;
6679e15f359SSam Clegg 
668f950b24aSSam Clegg   uint32_t NumPages = (DataSize + wasm::WasmPageSize - 1) / wasm::WasmPageSize;
669f950b24aSSam Clegg 
6709e15f359SSam Clegg   SectionBookkeeping Section;
6719e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_IMPORT);
6729e15f359SSam Clegg 
6739e15f359SSam Clegg   encodeULEB128(Imports.size(), getStream());
6749e15f359SSam Clegg   for (const WasmImport &Import : Imports) {
675b7787fd0SSam Clegg     writeString(Import.ModuleName);
676b7787fd0SSam Clegg     writeString(Import.FieldName);
6779e15f359SSam Clegg 
6789e15f359SSam Clegg     encodeULEB128(Import.Kind, getStream());
6799e15f359SSam Clegg 
6809e15f359SSam Clegg     switch (Import.Kind) {
6819e15f359SSam Clegg     case wasm::WASM_EXTERNAL_FUNCTION:
6829e15f359SSam Clegg       encodeULEB128(Import.Type, getStream());
6839e15f359SSam Clegg       break;
6849e15f359SSam Clegg     case wasm::WASM_EXTERNAL_GLOBAL:
6859e15f359SSam Clegg       encodeSLEB128(int32_t(Import.Type), getStream());
68632ce5ca0SDan Gohman       encodeULEB128(int32_t(Import.IsMutable), getStream());
6879e15f359SSam Clegg       break;
688f950b24aSSam Clegg     case wasm::WASM_EXTERNAL_MEMORY:
689f950b24aSSam Clegg       encodeULEB128(0, getStream()); // flags
690f950b24aSSam Clegg       encodeULEB128(NumPages, getStream()); // initial
691f950b24aSSam Clegg       break;
692f950b24aSSam Clegg     case wasm::WASM_EXTERNAL_TABLE:
693f950b24aSSam Clegg       encodeSLEB128(int32_t(Import.Type), getStream());
694f950b24aSSam Clegg       encodeULEB128(0, getStream()); // flags
695f950b24aSSam Clegg       encodeULEB128(NumElements, getStream()); // initial
696f950b24aSSam Clegg       break;
6979e15f359SSam Clegg     default:
6989e15f359SSam Clegg       llvm_unreachable("unsupported import kind");
6999e15f359SSam Clegg     }
7009e15f359SSam Clegg   }
7019e15f359SSam Clegg 
7029e15f359SSam Clegg   endSection(Section);
7039e15f359SSam Clegg }
7049e15f359SSam Clegg 
705457fb0b4SSam Clegg void WasmObjectWriter::writeFunctionSection(ArrayRef<WasmFunction> Functions) {
7069e15f359SSam Clegg   if (Functions.empty())
7079e15f359SSam Clegg     return;
7089e15f359SSam Clegg 
7099e15f359SSam Clegg   SectionBookkeeping Section;
7109e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_FUNCTION);
7119e15f359SSam Clegg 
7129e15f359SSam Clegg   encodeULEB128(Functions.size(), getStream());
7139e15f359SSam Clegg   for (const WasmFunction &Func : Functions)
7149e15f359SSam Clegg     encodeULEB128(Func.Type, getStream());
7159e15f359SSam Clegg 
7169e15f359SSam Clegg   endSection(Section);
7179e15f359SSam Clegg }
7189e15f359SSam Clegg 
7197c395943SSam Clegg void WasmObjectWriter::writeGlobalSection() {
7209e15f359SSam Clegg   if (Globals.empty())
7219e15f359SSam Clegg     return;
7229e15f359SSam Clegg 
7239e15f359SSam Clegg   SectionBookkeeping Section;
7249e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_GLOBAL);
7259e15f359SSam Clegg 
7269e15f359SSam Clegg   encodeULEB128(Globals.size(), getStream());
7279e15f359SSam Clegg   for (const WasmGlobal &Global : Globals) {
728*6e7f1826SSam Clegg     writeValueType(static_cast<wasm::ValType>(Global.Type.Type));
729*6e7f1826SSam Clegg     write8(Global.Type.Mutable);
7309e15f359SSam Clegg 
7319e15f359SSam Clegg     write8(wasm::WASM_OPCODE_I32_CONST);
732*6e7f1826SSam Clegg     encodeSLEB128(Global.InitialValue, getStream());
7339e15f359SSam Clegg     write8(wasm::WASM_OPCODE_END);
7349e15f359SSam Clegg   }
7359e15f359SSam Clegg 
7369e15f359SSam Clegg   endSection(Section);
7379e15f359SSam Clegg }
7389e15f359SSam Clegg 
739457fb0b4SSam Clegg void WasmObjectWriter::writeExportSection(ArrayRef<WasmExport> Exports) {
7409e15f359SSam Clegg   if (Exports.empty())
7419e15f359SSam Clegg     return;
7429e15f359SSam Clegg 
7439e15f359SSam Clegg   SectionBookkeeping Section;
7449e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_EXPORT);
7459e15f359SSam Clegg 
7469e15f359SSam Clegg   encodeULEB128(Exports.size(), getStream());
7479e15f359SSam Clegg   for (const WasmExport &Export : Exports) {
748b7787fd0SSam Clegg     writeString(Export.FieldName);
7499e15f359SSam Clegg     encodeSLEB128(Export.Kind, getStream());
7509e15f359SSam Clegg     encodeULEB128(Export.Index, getStream());
7519e15f359SSam Clegg   }
7529e15f359SSam Clegg 
7539e15f359SSam Clegg   endSection(Section);
7549e15f359SSam Clegg }
7559e15f359SSam Clegg 
756457fb0b4SSam Clegg void WasmObjectWriter::writeElemSection(ArrayRef<uint32_t> TableElems) {
7579e15f359SSam Clegg   if (TableElems.empty())
7589e15f359SSam Clegg     return;
7599e15f359SSam Clegg 
7609e15f359SSam Clegg   SectionBookkeeping Section;
7619e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_ELEM);
7629e15f359SSam Clegg 
7639e15f359SSam Clegg   encodeULEB128(1, getStream()); // number of "segments"
7649e15f359SSam Clegg   encodeULEB128(0, getStream()); // the table index
7659e15f359SSam Clegg 
7669e15f359SSam Clegg   // init expr for starting offset
7679e15f359SSam Clegg   write8(wasm::WASM_OPCODE_I32_CONST);
76830e1bbc1SSam Clegg   encodeSLEB128(kInitialTableOffset, getStream());
7699e15f359SSam Clegg   write8(wasm::WASM_OPCODE_END);
7709e15f359SSam Clegg 
7719e15f359SSam Clegg   encodeULEB128(TableElems.size(), getStream());
7729e15f359SSam Clegg   for (uint32_t Elem : TableElems)
7739e15f359SSam Clegg     encodeULEB128(Elem, getStream());
7749e15f359SSam Clegg 
7759e15f359SSam Clegg   endSection(Section);
7769e15f359SSam Clegg }
7779e15f359SSam Clegg 
778457fb0b4SSam Clegg void WasmObjectWriter::writeCodeSection(const MCAssembler &Asm,
779457fb0b4SSam Clegg                                         const MCAsmLayout &Layout,
780457fb0b4SSam Clegg                                         ArrayRef<WasmFunction> Functions) {
7819e15f359SSam Clegg   if (Functions.empty())
7829e15f359SSam Clegg     return;
7839e15f359SSam Clegg 
7849e15f359SSam Clegg   SectionBookkeeping Section;
7859e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CODE);
7869e15f359SSam Clegg 
7879e15f359SSam Clegg   encodeULEB128(Functions.size(), getStream());
7889e15f359SSam Clegg 
7899e15f359SSam Clegg   for (const WasmFunction &Func : Functions) {
790fe6414b0SSam Clegg     auto &FuncSection = static_cast<MCSectionWasm &>(Func.Sym->getSection());
7919e15f359SSam Clegg 
7929e15f359SSam Clegg     int64_t Size = 0;
7939e15f359SSam Clegg     if (!Func.Sym->getSize()->evaluateAsAbsolute(Size, Layout))
7949e15f359SSam Clegg       report_fatal_error(".size expression must be evaluatable");
7959e15f359SSam Clegg 
7969e15f359SSam Clegg     encodeULEB128(Size, getStream());
797fe6414b0SSam Clegg     FuncSection.setSectionOffset(getStream().tell() - Section.ContentsOffset);
7989e15f359SSam Clegg     Asm.writeSectionData(&FuncSection, Layout);
7999e15f359SSam Clegg   }
8009e15f359SSam Clegg 
8019e15f359SSam Clegg   // Apply fixups.
802acd7d2b0SSam Clegg   applyRelocations(CodeRelocations, Section.ContentsOffset);
8039e15f359SSam Clegg 
8049e15f359SSam Clegg   endSection(Section);
8059e15f359SSam Clegg }
8069e15f359SSam Clegg 
807457fb0b4SSam Clegg void WasmObjectWriter::writeDataSection(ArrayRef<WasmDataSegment> Segments) {
8087c395943SSam Clegg   if (Segments.empty())
8097c395943SSam Clegg     return;
8109e15f359SSam Clegg 
8119e15f359SSam Clegg   SectionBookkeeping Section;
8129e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_DATA);
8139e15f359SSam Clegg 
8147c395943SSam Clegg   encodeULEB128(Segments.size(), getStream()); // count
8157c395943SSam Clegg 
8167c395943SSam Clegg   for (const WasmDataSegment & Segment : Segments) {
8179e15f359SSam Clegg     encodeULEB128(0, getStream()); // memory index
8189e15f359SSam Clegg     write8(wasm::WASM_OPCODE_I32_CONST);
8197c395943SSam Clegg     encodeSLEB128(Segment.Offset, getStream()); // offset
8209e15f359SSam Clegg     write8(wasm::WASM_OPCODE_END);
8217c395943SSam Clegg     encodeULEB128(Segment.Data.size(), getStream()); // size
8227c395943SSam Clegg     Segment.Section->setSectionOffset(getStream().tell() - Section.ContentsOffset);
8237c395943SSam Clegg     writeBytes(Segment.Data); // data
8247c395943SSam Clegg   }
8259e15f359SSam Clegg 
8269e15f359SSam Clegg   // Apply fixups.
8277c395943SSam Clegg   applyRelocations(DataRelocations, Section.ContentsOffset);
8289e15f359SSam Clegg 
8299e15f359SSam Clegg   endSection(Section);
8309e15f359SSam Clegg }
8319e15f359SSam Clegg 
832acd7d2b0SSam Clegg void WasmObjectWriter::writeCodeRelocSection() {
8339e15f359SSam Clegg   // See: https://github.com/WebAssembly/tool-conventions/blob/master/Linking.md
8349e15f359SSam Clegg   // for descriptions of the reloc sections.
8359e15f359SSam Clegg 
8369e15f359SSam Clegg   if (CodeRelocations.empty())
8379e15f359SSam Clegg     return;
8389e15f359SSam Clegg 
8399e15f359SSam Clegg   SectionBookkeeping Section;
8409e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CUSTOM, "reloc.CODE");
8419e15f359SSam Clegg 
8429e15f359SSam Clegg   encodeULEB128(wasm::WASM_SEC_CODE, getStream());
843acd7d2b0SSam Clegg   encodeULEB128(CodeRelocations.size(), getStream());
8449e15f359SSam Clegg 
8457c395943SSam Clegg   writeRelocations(CodeRelocations);
8469e15f359SSam Clegg 
8479e15f359SSam Clegg   endSection(Section);
8489e15f359SSam Clegg }
8499e15f359SSam Clegg 
8507c395943SSam Clegg void WasmObjectWriter::writeDataRelocSection() {
8519e15f359SSam Clegg   // See: https://github.com/WebAssembly/tool-conventions/blob/master/Linking.md
8529e15f359SSam Clegg   // for descriptions of the reloc sections.
8539e15f359SSam Clegg 
8549e15f359SSam Clegg   if (DataRelocations.empty())
8559e15f359SSam Clegg     return;
8569e15f359SSam Clegg 
8579e15f359SSam Clegg   SectionBookkeeping Section;
8589e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CUSTOM, "reloc.DATA");
8599e15f359SSam Clegg 
8609e15f359SSam Clegg   encodeULEB128(wasm::WASM_SEC_DATA, getStream());
8619e15f359SSam Clegg   encodeULEB128(DataRelocations.size(), getStream());
8629e15f359SSam Clegg 
8637c395943SSam Clegg   writeRelocations(DataRelocations);
8649e15f359SSam Clegg 
8659e15f359SSam Clegg   endSection(Section);
8669e15f359SSam Clegg }
8679e15f359SSam Clegg 
8689e15f359SSam Clegg void WasmObjectWriter::writeLinkingMetaDataSection(
869d95ed959SSam Clegg     ArrayRef<WasmDataSegment> Segments, uint32_t DataSize,
870ea7caceeSSam Clegg     ArrayRef<std::pair<StringRef, uint32_t>> SymbolFlags,
871ea7caceeSSam Clegg     ArrayRef<std::pair<uint16_t, uint32_t>> InitFuncs,
872ea7caceeSSam Clegg     const std::map<StringRef, std::vector<WasmComdatEntry>>& Comdats) {
8739e15f359SSam Clegg   SectionBookkeeping Section;
8749e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CUSTOM, "linking");
875b7787fd0SSam Clegg   SectionBookkeeping SubSection;
8769e15f359SSam Clegg 
87731a2c809SSam Clegg   if (SymbolFlags.size() != 0) {
878b7787fd0SSam Clegg     startSection(SubSection, wasm::WASM_SYMBOL_INFO);
87931a2c809SSam Clegg     encodeULEB128(SymbolFlags.size(), getStream());
88031a2c809SSam Clegg     for (auto Pair: SymbolFlags) {
88131a2c809SSam Clegg       writeString(Pair.first);
88231a2c809SSam Clegg       encodeULEB128(Pair.second, getStream());
883b7787fd0SSam Clegg     }
884b7787fd0SSam Clegg     endSection(SubSection);
885b7787fd0SSam Clegg   }
8869e15f359SSam Clegg 
8879e1ade93SSam Clegg   if (DataSize > 0) {
8889e1ade93SSam Clegg     startSection(SubSection, wasm::WASM_DATA_SIZE);
8899e1ade93SSam Clegg     encodeULEB128(DataSize, getStream());
8909e1ade93SSam Clegg     endSection(SubSection);
8919e1ade93SSam Clegg   }
8929e1ade93SSam Clegg 
893d95ed959SSam Clegg   if (Segments.size()) {
89463ebb813SSam Clegg     startSection(SubSection, wasm::WASM_SEGMENT_INFO);
895d95ed959SSam Clegg     encodeULEB128(Segments.size(), getStream());
89663ebb813SSam Clegg     for (const WasmDataSegment &Segment : Segments) {
897d95ed959SSam Clegg       writeString(Segment.Name);
89863ebb813SSam Clegg       encodeULEB128(Segment.Alignment, getStream());
89963ebb813SSam Clegg       encodeULEB128(Segment.Flags, getStream());
90063ebb813SSam Clegg     }
901d95ed959SSam Clegg     endSection(SubSection);
902d95ed959SSam Clegg   }
903d95ed959SSam Clegg 
904bafe6902SSam Clegg   if (!InitFuncs.empty()) {
905bafe6902SSam Clegg     startSection(SubSection, wasm::WASM_INIT_FUNCS);
906bafe6902SSam Clegg     encodeULEB128(InitFuncs.size(), getStream());
907bafe6902SSam Clegg     for (auto &StartFunc : InitFuncs) {
908bafe6902SSam Clegg       encodeULEB128(StartFunc.first, getStream()); // priority
909bafe6902SSam Clegg       encodeULEB128(StartFunc.second, getStream()); // function index
910bafe6902SSam Clegg     }
911bafe6902SSam Clegg     endSection(SubSection);
912bafe6902SSam Clegg   }
913bafe6902SSam Clegg 
914ea7caceeSSam Clegg   if (Comdats.size()) {
915ea7caceeSSam Clegg     startSection(SubSection, wasm::WASM_COMDAT_INFO);
916ea7caceeSSam Clegg     encodeULEB128(Comdats.size(), getStream());
917ea7caceeSSam Clegg     for (const auto &C : Comdats) {
918ea7caceeSSam Clegg       writeString(C.first);
919ea7caceeSSam Clegg       encodeULEB128(0, getStream()); // flags for future use
920ea7caceeSSam Clegg       encodeULEB128(C.second.size(), getStream());
921ea7caceeSSam Clegg       for (const WasmComdatEntry &Entry : C.second) {
922ea7caceeSSam Clegg         encodeULEB128(Entry.Kind, getStream());
923ea7caceeSSam Clegg         encodeULEB128(Entry.Index, getStream());
924ea7caceeSSam Clegg       }
925ea7caceeSSam Clegg     }
926ea7caceeSSam Clegg     endSection(SubSection);
927ea7caceeSSam Clegg   }
928ea7caceeSSam Clegg 
9299e15f359SSam Clegg   endSection(Section);
9309e15f359SSam Clegg }
9319e15f359SSam Clegg 
9325e3d33a7SSam Clegg uint32_t WasmObjectWriter::getFunctionType(const MCSymbolWasm& Symbol) {
9335e3d33a7SSam Clegg   assert(Symbol.isFunction());
9345e3d33a7SSam Clegg   assert(TypeIndices.count(&Symbol));
9355e3d33a7SSam Clegg   return TypeIndices[&Symbol];
9365e3d33a7SSam Clegg }
9375e3d33a7SSam Clegg 
9385e3d33a7SSam Clegg uint32_t WasmObjectWriter::registerFunctionType(const MCSymbolWasm& Symbol) {
9395e3d33a7SSam Clegg   assert(Symbol.isFunction());
9405e3d33a7SSam Clegg 
9415e3d33a7SSam Clegg   WasmFunctionType F;
942aff1c4dfSSam Clegg   const MCSymbolWasm* ResolvedSym = ResolveSymbol(Symbol);
9435e3d33a7SSam Clegg   F.Returns = ResolvedSym->getReturns();
9445e3d33a7SSam Clegg   F.Params = ResolvedSym->getParams();
9455e3d33a7SSam Clegg 
9465e3d33a7SSam Clegg   auto Pair =
9475e3d33a7SSam Clegg       FunctionTypeIndices.insert(std::make_pair(F, FunctionTypes.size()));
9485e3d33a7SSam Clegg   if (Pair.second)
9495e3d33a7SSam Clegg     FunctionTypes.push_back(F);
9505e3d33a7SSam Clegg   TypeIndices[&Symbol] = Pair.first->second;
9515e3d33a7SSam Clegg 
9525e3d33a7SSam Clegg   DEBUG(dbgs() << "registerFunctionType: " << Symbol << " new:" << Pair.second << "\n");
9535e3d33a7SSam Clegg   DEBUG(dbgs() << "  -> type index: " << Pair.first->second << "\n");
9545e3d33a7SSam Clegg   return Pair.first->second;
9555e3d33a7SSam Clegg }
9565e3d33a7SSam Clegg 
95718eafb6cSDan Gohman void WasmObjectWriter::writeObject(MCAssembler &Asm,
95818eafb6cSDan Gohman                                    const MCAsmLayout &Layout) {
959b7787fd0SSam Clegg   DEBUG(dbgs() << "WasmObjectWriter::writeObject\n");
96082607f56SDan Gohman   MCContext &Ctx = Asm.getContext();
961*6e7f1826SSam Clegg   int32_t PtrType = is64Bit() ? wasm::WASM_TYPE_I64 : wasm::WASM_TYPE_I32;
962d934cb88SDan Gohman 
963d934cb88SDan Gohman   // Collect information from the available symbols.
964d934cb88SDan Gohman   SmallVector<WasmFunction, 4> Functions;
965d934cb88SDan Gohman   SmallVector<uint32_t, 4> TableElems;
966d934cb88SDan Gohman   SmallVector<WasmImport, 4> Imports;
967d934cb88SDan Gohman   SmallVector<WasmExport, 4> Exports;
96831a2c809SSam Clegg   SmallVector<std::pair<StringRef, uint32_t>, 4> SymbolFlags;
969bafe6902SSam Clegg   SmallVector<std::pair<uint16_t, uint32_t>, 2> InitFuncs;
970ea7caceeSSam Clegg   std::map<StringRef, std::vector<WasmComdatEntry>> Comdats;
9717c395943SSam Clegg   SmallVector<WasmDataSegment, 4> DataSegments;
9727c395943SSam Clegg   uint32_t DataSize = 0;
973d934cb88SDan Gohman 
974f950b24aSSam Clegg   // For now, always emit the memory import, since loads and stores are not
975f950b24aSSam Clegg   // valid without it. In the future, we could perhaps be more clever and omit
976f950b24aSSam Clegg   // it if there are no loads or stores.
977f950b24aSSam Clegg   MCSymbolWasm *MemorySym =
978f950b24aSSam Clegg       cast<MCSymbolWasm>(Ctx.getOrCreateSymbol("__linear_memory"));
979f950b24aSSam Clegg   WasmImport MemImport;
980f950b24aSSam Clegg   MemImport.ModuleName = MemorySym->getModuleName();
981f950b24aSSam Clegg   MemImport.FieldName = MemorySym->getName();
982f950b24aSSam Clegg   MemImport.Kind = wasm::WASM_EXTERNAL_MEMORY;
983f950b24aSSam Clegg   Imports.push_back(MemImport);
984f950b24aSSam Clegg 
985f950b24aSSam Clegg   // For now, always emit the table section, since indirect calls are not
986f950b24aSSam Clegg   // valid without it. In the future, we could perhaps be more clever and omit
987f950b24aSSam Clegg   // it if there are no indirect calls.
988f950b24aSSam Clegg   MCSymbolWasm *TableSym =
989f950b24aSSam Clegg       cast<MCSymbolWasm>(Ctx.getOrCreateSymbol("__indirect_function_table"));
990f950b24aSSam Clegg   WasmImport TableImport;
991f950b24aSSam Clegg   TableImport.ModuleName = TableSym->getModuleName();
992f950b24aSSam Clegg   TableImport.FieldName = TableSym->getName();
993f950b24aSSam Clegg   TableImport.Kind = wasm::WASM_EXTERNAL_TABLE;
994f950b24aSSam Clegg   TableImport.Type = wasm::WASM_TYPE_ANYFUNC;
995f950b24aSSam Clegg   Imports.push_back(TableImport);
996f950b24aSSam Clegg 
99732ce5ca0SDan Gohman   // Populate FunctionTypeIndices and Imports.
99832ce5ca0SDan Gohman   for (const MCSymbol &S : Asm.symbols()) {
99932ce5ca0SDan Gohman     const auto &WS = static_cast<const MCSymbolWasm &>(S);
100032ce5ca0SDan Gohman 
100132ce5ca0SDan Gohman     // Register types for all functions, including those with private linkage
10029f3fe42eSSam Clegg     // (because wasm always needs a type signature).
100332ce5ca0SDan Gohman     if (WS.isFunction())
100432ce5ca0SDan Gohman       registerFunctionType(WS);
100532ce5ca0SDan Gohman 
100632ce5ca0SDan Gohman     if (WS.isTemporary())
100732ce5ca0SDan Gohman       continue;
100832ce5ca0SDan Gohman 
100932ce5ca0SDan Gohman     // If the symbol is not defined in this translation unit, import it.
1010cd65f698SSam Clegg     if ((!WS.isDefined() && !WS.isComdat()) ||
1011d423f0d2SSam Clegg         WS.isVariable()) {
101232ce5ca0SDan Gohman       WasmImport Import;
101332ce5ca0SDan Gohman       Import.ModuleName = WS.getModuleName();
101432ce5ca0SDan Gohman       Import.FieldName = WS.getName();
101532ce5ca0SDan Gohman 
101632ce5ca0SDan Gohman       if (WS.isFunction()) {
101732ce5ca0SDan Gohman         Import.Kind = wasm::WASM_EXTERNAL_FUNCTION;
101832ce5ca0SDan Gohman         Import.Type = getFunctionType(WS);
10199f3fe42eSSam Clegg         SymbolIndices[&WS] = NumFunctionImports;
10209f3fe42eSSam Clegg         ++NumFunctionImports;
102132ce5ca0SDan Gohman       } else {
102232ce5ca0SDan Gohman         Import.Kind = wasm::WASM_EXTERNAL_GLOBAL;
1023*6e7f1826SSam Clegg         Import.Type = PtrType;
102432ce5ca0SDan Gohman         Import.IsMutable = false;
102532ce5ca0SDan Gohman         SymbolIndices[&WS] = NumGlobalImports;
102632ce5ca0SDan Gohman 
102783b16226SDan Gohman         // If this global is the stack pointer, make it mutable.
1028ad19047dSDan Gohman         if (WS.getName() == "__stack_pointer")
102932ce5ca0SDan Gohman           Import.IsMutable = true;
103032ce5ca0SDan Gohman 
103132ce5ca0SDan Gohman         ++NumGlobalImports;
103232ce5ca0SDan Gohman       }
103332ce5ca0SDan Gohman 
103432ce5ca0SDan Gohman       Imports.push_back(Import);
103532ce5ca0SDan Gohman     }
103632ce5ca0SDan Gohman   }
103732ce5ca0SDan Gohman 
1038759631c7SSam Clegg   for (MCSection &Sec : Asm) {
1039759631c7SSam Clegg     auto &Section = static_cast<MCSectionWasm &>(Sec);
104012fd3da9SSam Clegg     if (!Section.isWasmData())
1041759631c7SSam Clegg       continue;
1042759631c7SSam Clegg 
1043bafe6902SSam Clegg     // .init_array sections are handled specially elsewhere.
1044bafe6902SSam Clegg     if (cast<MCSectionWasm>(Sec).getSectionName().startswith(".init_array"))
1045bafe6902SSam Clegg       continue;
1046bafe6902SSam Clegg 
1047329e76d5SSam Clegg     uint32_t SegmentIndex = DataSegments.size();
1048759631c7SSam Clegg     DataSize = alignTo(DataSize, Section.getAlignment());
1049759631c7SSam Clegg     DataSegments.emplace_back();
1050759631c7SSam Clegg     WasmDataSegment &Segment = DataSegments.back();
1051d95ed959SSam Clegg     Segment.Name = Section.getSectionName();
1052759631c7SSam Clegg     Segment.Offset = DataSize;
1053759631c7SSam Clegg     Segment.Section = &Section;
105463ebb813SSam Clegg     addData(Segment.Data, Section);
105563ebb813SSam Clegg     Segment.Alignment = Section.getAlignment();
105663ebb813SSam Clegg     Segment.Flags = 0;
1057759631c7SSam Clegg     DataSize += Segment.Data.size();
1058759631c7SSam Clegg     Section.setMemoryOffset(Segment.Offset);
1059ea7caceeSSam Clegg 
1060ea7caceeSSam Clegg     if (const MCSymbolWasm *C = Section.getGroup()) {
1061ea7caceeSSam Clegg       Comdats[C->getName()].emplace_back(
1062329e76d5SSam Clegg           WasmComdatEntry{wasm::WASM_COMDAT_DATA, SegmentIndex});
1063ea7caceeSSam Clegg     }
1064759631c7SSam Clegg   }
1065759631c7SSam Clegg 
1066b7787fd0SSam Clegg   // Handle regular defined and undefined symbols.
1067d934cb88SDan Gohman   for (const MCSymbol &S : Asm.symbols()) {
1068d934cb88SDan Gohman     // Ignore unnamed temporary symbols, which aren't ever exported, imported,
1069d934cb88SDan Gohman     // or used in relocations.
1070d934cb88SDan Gohman     if (S.isTemporary() && S.getName().empty())
1071d934cb88SDan Gohman       continue;
1072b7787fd0SSam Clegg 
1073d934cb88SDan Gohman     const auto &WS = static_cast<const MCSymbolWasm &>(S);
1074b7787fd0SSam Clegg     DEBUG(dbgs() << "MCSymbol: '" << S << "'"
1075329e76d5SSam Clegg                  << " isDefined=" << S.isDefined()
1076329e76d5SSam Clegg                  << " isExternal=" << S.isExternal()
1077329e76d5SSam Clegg                  << " isTemporary=" << S.isTemporary()
1078b7787fd0SSam Clegg                  << " isFunction=" << WS.isFunction()
1079b7787fd0SSam Clegg                  << " isWeak=" << WS.isWeak()
1080a2b35dacSSam Clegg                  << " isHidden=" << WS.isHidden()
1081b7787fd0SSam Clegg                  << " isVariable=" << WS.isVariable() << "\n");
1082b7787fd0SSam Clegg 
1083a2b35dacSSam Clegg     if (WS.isWeak() || WS.isHidden()) {
1084a2b35dacSSam Clegg       uint32_t Flags = (WS.isWeak() ? wasm::WASM_SYMBOL_BINDING_WEAK : 0) |
1085a2b35dacSSam Clegg           (WS.isHidden() ? wasm::WASM_SYMBOL_VISIBILITY_HIDDEN : 0);
1086a2b35dacSSam Clegg       SymbolFlags.emplace_back(WS.getName(), Flags);
1087a2b35dacSSam Clegg     }
1088b7787fd0SSam Clegg 
10895e3d33a7SSam Clegg     if (WS.isVariable())
10905e3d33a7SSam Clegg       continue;
10915e3d33a7SSam Clegg 
1092d934cb88SDan Gohman     unsigned Index;
1093b7787fd0SSam Clegg 
1094d934cb88SDan Gohman     if (WS.isFunction()) {
1095cd65f698SSam Clegg       if (WS.isDefined()) {
1096b7787fd0SSam Clegg         if (WS.getOffset() != 0)
1097b7787fd0SSam Clegg           report_fatal_error(
1098b7787fd0SSam Clegg               "function sections must contain one function each");
1099b7787fd0SSam Clegg 
1100b7787fd0SSam Clegg         if (WS.getSize() == 0)
1101b7787fd0SSam Clegg           report_fatal_error(
1102b7787fd0SSam Clegg               "function symbols must have a size set with .size");
1103b7787fd0SSam Clegg 
1104d934cb88SDan Gohman         // A definition. Take the next available index.
11059f3fe42eSSam Clegg         Index = NumFunctionImports + Functions.size();
1106d934cb88SDan Gohman 
1107d934cb88SDan Gohman         // Prepare the function.
1108d934cb88SDan Gohman         WasmFunction Func;
11095e3d33a7SSam Clegg         Func.Type = getFunctionType(WS);
1110d934cb88SDan Gohman         Func.Sym = &WS;
1111d934cb88SDan Gohman         SymbolIndices[&WS] = Index;
1112d934cb88SDan Gohman         Functions.push_back(Func);
1113d934cb88SDan Gohman       } else {
1114d934cb88SDan Gohman         // An import; the index was assigned above.
1115d934cb88SDan Gohman         Index = SymbolIndices.find(&WS)->second;
1116d934cb88SDan Gohman       }
1117d934cb88SDan Gohman 
11185e3d33a7SSam Clegg       DEBUG(dbgs() << "  -> function index: " << Index << "\n");
1119d934cb88SDan Gohman    } else {
1120c38e947eSSam Clegg       if (WS.isTemporary() && !WS.getSize())
1121c38e947eSSam Clegg         continue;
1122c38e947eSSam Clegg 
1123cd65f698SSam Clegg       if (!WS.isDefined())
1124fe6414b0SSam Clegg         continue;
1125fe6414b0SSam Clegg 
1126d934cb88SDan Gohman       if (!WS.getSize())
1127c38e947eSSam Clegg         report_fatal_error("data symbols must have a size set with .size: " +
1128c38e947eSSam Clegg                            WS.getName());
1129d934cb88SDan Gohman 
1130d934cb88SDan Gohman       int64_t Size = 0;
1131d934cb88SDan Gohman       if (!WS.getSize()->evaluateAsAbsolute(Size, Layout))
1132d934cb88SDan Gohman         report_fatal_error(".size expression must be evaluatable");
1133d934cb88SDan Gohman 
11347c395943SSam Clegg       // For each global, prepare a corresponding wasm global holding its
11357c395943SSam Clegg       // address.  For externals these will also be named exports.
11367c395943SSam Clegg       Index = NumGlobalImports + Globals.size();
1137759631c7SSam Clegg       auto &DataSection = static_cast<MCSectionWasm &>(WS.getSection());
1138ea7caceeSSam Clegg       assert(DataSection.isWasmData());
11397c395943SSam Clegg 
11407c395943SSam Clegg       WasmGlobal Global;
1141*6e7f1826SSam Clegg       Global.Type.Type = PtrType;
1142*6e7f1826SSam Clegg       Global.Type.Mutable = false;
1143759631c7SSam Clegg       Global.InitialValue = DataSection.getMemoryOffset() + Layout.getSymbolOffset(WS);
11447c395943SSam Clegg       SymbolIndices[&WS] = Index;
11457c395943SSam Clegg       DEBUG(dbgs() << "  -> global index: " << Index << "\n");
11467c395943SSam Clegg       Globals.push_back(Global);
1147d934cb88SDan Gohman     }
1148d934cb88SDan Gohman 
1149d934cb88SDan Gohman     // If the symbol is visible outside this translation unit, export it.
1150cd65f698SSam Clegg     if (WS.isDefined()) {
1151d934cb88SDan Gohman       WasmExport Export;
1152d934cb88SDan Gohman       Export.FieldName = WS.getName();
1153d934cb88SDan Gohman       Export.Index = Index;
1154d934cb88SDan Gohman       if (WS.isFunction())
1155d934cb88SDan Gohman         Export.Kind = wasm::WASM_EXTERNAL_FUNCTION;
1156d934cb88SDan Gohman       else
1157d934cb88SDan Gohman         Export.Kind = wasm::WASM_EXTERNAL_GLOBAL;
11585e3d33a7SSam Clegg       DEBUG(dbgs() << "  -> export " << Exports.size() << "\n");
1159d934cb88SDan Gohman       Exports.push_back(Export);
1160ea7caceeSSam Clegg 
116131a2c809SSam Clegg       if (!WS.isExternal())
116231a2c809SSam Clegg         SymbolFlags.emplace_back(WS.getName(), wasm::WASM_SYMBOL_BINDING_LOCAL);
1163ea7caceeSSam Clegg 
1164ea7caceeSSam Clegg       if (WS.isFunction()) {
1165cd65f698SSam Clegg         auto &Section = static_cast<MCSectionWasm &>(WS.getSection());
1166ea7caceeSSam Clegg         if (const MCSymbolWasm *C = Section.getGroup())
1167ea7caceeSSam Clegg           Comdats[C->getName()].emplace_back(
1168ea7caceeSSam Clegg               WasmComdatEntry{wasm::WASM_COMDAT_FUNCTION, Index});
1169ea7caceeSSam Clegg       }
1170d934cb88SDan Gohman     }
1171d934cb88SDan Gohman   }
1172d934cb88SDan Gohman 
11735e3d33a7SSam Clegg   // Handle weak aliases. We need to process these in a separate pass because
11745e3d33a7SSam Clegg   // we need to have processed the target of the alias before the alias itself
11755e3d33a7SSam Clegg   // and the symbols are not necessarily ordered in this way.
1176b7787fd0SSam Clegg   for (const MCSymbol &S : Asm.symbols()) {
1177b7787fd0SSam Clegg     if (!S.isVariable())
1178b7787fd0SSam Clegg       continue;
117931a2c809SSam Clegg 
1180cd65f698SSam Clegg     assert(S.isDefined());
1181b7787fd0SSam Clegg 
11825e3d33a7SSam Clegg     // Find the target symbol of this weak alias and export that index
1183aff1c4dfSSam Clegg     const auto &WS = static_cast<const MCSymbolWasm &>(S);
1184aff1c4dfSSam Clegg     const MCSymbolWasm *ResolvedSym = ResolveSymbol(WS);
11855e3d33a7SSam Clegg     DEBUG(dbgs() << WS.getName() << ": weak alias of '" << *ResolvedSym << "'\n");
11865e3d33a7SSam Clegg     assert(SymbolIndices.count(ResolvedSym) > 0);
1187b7787fd0SSam Clegg     uint32_t Index = SymbolIndices.find(ResolvedSym)->second;
11885e3d33a7SSam Clegg     DEBUG(dbgs() << "  -> index:" << Index << "\n");
1189b7787fd0SSam Clegg 
1190b7787fd0SSam Clegg     WasmExport Export;
1191b7787fd0SSam Clegg     Export.FieldName = WS.getName();
1192b7787fd0SSam Clegg     Export.Index = Index;
1193b7787fd0SSam Clegg     if (WS.isFunction())
1194b7787fd0SSam Clegg       Export.Kind = wasm::WASM_EXTERNAL_FUNCTION;
1195b7787fd0SSam Clegg     else
1196b7787fd0SSam Clegg       Export.Kind = wasm::WASM_EXTERNAL_GLOBAL;
11975e3d33a7SSam Clegg     DEBUG(dbgs() << "  -> export " << Exports.size() << "\n");
1198b7787fd0SSam Clegg     Exports.push_back(Export);
119931a2c809SSam Clegg 
120031a2c809SSam Clegg     if (!WS.isExternal())
120131a2c809SSam Clegg       SymbolFlags.emplace_back(WS.getName(), wasm::WASM_SYMBOL_BINDING_LOCAL);
1202b7787fd0SSam Clegg   }
1203b7787fd0SSam Clegg 
12046006e091SSam Clegg   {
12056006e091SSam Clegg     auto HandleReloc = [&](const WasmRelocationEntry &Rel) {
1206f9edbe95SSam Clegg       // Functions referenced by a relocation need to put in the table.  This is
1207f9edbe95SSam Clegg       // purely to make the object file's provisional values readable, and is
1208f9edbe95SSam Clegg       // ignored by the linker, which re-calculates the relocations itself.
1209f9edbe95SSam Clegg       if (Rel.Type != wasm::R_WEBASSEMBLY_TABLE_INDEX_I32 &&
1210f9edbe95SSam Clegg           Rel.Type != wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB)
1211f9edbe95SSam Clegg         return;
1212f9edbe95SSam Clegg       assert(Rel.Symbol->isFunction());
1213f9edbe95SSam Clegg       const MCSymbolWasm &WS = *ResolveSymbol(*Rel.Symbol);
1214f9edbe95SSam Clegg       uint32_t SymbolIndex = SymbolIndices.find(&WS)->second;
1215f9edbe95SSam Clegg       uint32_t TableIndex = TableElems.size() + kInitialTableOffset;
1216f9edbe95SSam Clegg       if (TableIndices.try_emplace(&WS, TableIndex).second) {
1217329e76d5SSam Clegg         DEBUG(dbgs() << "  -> adding " << WS.getName()
1218f9edbe95SSam Clegg                      << " to table: " << TableIndex << "\n");
1219f9edbe95SSam Clegg         TableElems.push_back(SymbolIndex);
12206006e091SSam Clegg         registerFunctionType(WS);
12216006e091SSam Clegg       }
12226006e091SSam Clegg     };
1223970d02c4SDan Gohman 
12246006e091SSam Clegg     for (const WasmRelocationEntry &RelEntry : CodeRelocations)
12256006e091SSam Clegg       HandleReloc(RelEntry);
12266006e091SSam Clegg     for (const WasmRelocationEntry &RelEntry : DataRelocations)
12276006e091SSam Clegg       HandleReloc(RelEntry);
1228d934cb88SDan Gohman   }
1229d934cb88SDan Gohman 
1230bafe6902SSam Clegg   // Translate .init_array section contents into start functions.
1231bafe6902SSam Clegg   for (const MCSection &S : Asm) {
1232bafe6902SSam Clegg     const auto &WS = static_cast<const MCSectionWasm &>(S);
1233bafe6902SSam Clegg     if (WS.getSectionName().startswith(".fini_array"))
1234bafe6902SSam Clegg       report_fatal_error(".fini_array sections are unsupported");
1235bafe6902SSam Clegg     if (!WS.getSectionName().startswith(".init_array"))
1236bafe6902SSam Clegg       continue;
1237bafe6902SSam Clegg     if (WS.getFragmentList().empty())
1238bafe6902SSam Clegg       continue;
1239bafe6902SSam Clegg     if (WS.getFragmentList().size() != 2)
1240bafe6902SSam Clegg       report_fatal_error("only one .init_array section fragment supported");
1241bafe6902SSam Clegg     const MCFragment &AlignFrag = *WS.begin();
1242bafe6902SSam Clegg     if (AlignFrag.getKind() != MCFragment::FT_Align)
1243bafe6902SSam Clegg       report_fatal_error(".init_array section should be aligned");
1244bafe6902SSam Clegg     if (cast<MCAlignFragment>(AlignFrag).getAlignment() != (is64Bit() ? 8 : 4))
1245bafe6902SSam Clegg       report_fatal_error(".init_array section should be aligned for pointers");
1246bafe6902SSam Clegg     const MCFragment &Frag = *std::next(WS.begin());
1247bafe6902SSam Clegg     if (Frag.hasInstructions() || Frag.getKind() != MCFragment::FT_Data)
1248bafe6902SSam Clegg       report_fatal_error("only data supported in .init_array section");
1249bafe6902SSam Clegg     uint16_t Priority = UINT16_MAX;
1250bafe6902SSam Clegg     if (WS.getSectionName().size() != 11) {
1251bafe6902SSam Clegg       if (WS.getSectionName()[11] != '.')
1252bafe6902SSam Clegg         report_fatal_error(".init_array section priority should start with '.'");
1253bafe6902SSam Clegg       if (WS.getSectionName().substr(12).getAsInteger(10, Priority))
1254bafe6902SSam Clegg         report_fatal_error("invalid .init_array section priority");
1255bafe6902SSam Clegg     }
1256bafe6902SSam Clegg     const auto &DataFrag = cast<MCDataFragment>(Frag);
1257bafe6902SSam Clegg     const SmallVectorImpl<char> &Contents = DataFrag.getContents();
1258bafe6902SSam Clegg     for (const uint8_t *p = (const uint8_t *)Contents.data(),
1259bafe6902SSam Clegg                      *end = (const uint8_t *)Contents.data() + Contents.size();
1260bafe6902SSam Clegg          p != end; ++p) {
1261bafe6902SSam Clegg       if (*p != 0)
1262bafe6902SSam Clegg         report_fatal_error("non-symbolic data in .init_array section");
1263bafe6902SSam Clegg     }
1264bafe6902SSam Clegg     for (const MCFixup &Fixup : DataFrag.getFixups()) {
1265bafe6902SSam Clegg       assert(Fixup.getKind() == MCFixup::getKindForSize(is64Bit() ? 8 : 4, false));
1266bafe6902SSam Clegg       const MCExpr *Expr = Fixup.getValue();
1267bafe6902SSam Clegg       auto *Sym = dyn_cast<MCSymbolRefExpr>(Expr);
1268bafe6902SSam Clegg       if (!Sym)
1269bafe6902SSam Clegg         report_fatal_error("fixups in .init_array should be symbol references");
1270bafe6902SSam Clegg       if (Sym->getKind() != MCSymbolRefExpr::VK_WebAssembly_FUNCTION)
1271bafe6902SSam Clegg         report_fatal_error("symbols in .init_array should be for functions");
1272bafe6902SSam Clegg       auto I = SymbolIndices.find(cast<MCSymbolWasm>(&Sym->getSymbol()));
1273bafe6902SSam Clegg       if (I == SymbolIndices.end())
1274bafe6902SSam Clegg         report_fatal_error("symbols in .init_array should be defined");
1275bafe6902SSam Clegg       uint32_t Index = I->second;
1276bafe6902SSam Clegg       InitFuncs.push_back(std::make_pair(Priority, Index));
1277bafe6902SSam Clegg     }
1278bafe6902SSam Clegg   }
1279bafe6902SSam Clegg 
128018eafb6cSDan Gohman   // Write out the Wasm header.
128118eafb6cSDan Gohman   writeHeader(Asm);
128218eafb6cSDan Gohman 
12839e15f359SSam Clegg   writeTypeSection(FunctionTypes);
1284f950b24aSSam Clegg   writeImportSection(Imports, DataSize, TableElems.size());
12859e15f359SSam Clegg   writeFunctionSection(Functions);
1286f950b24aSSam Clegg   // Skip the "table" section; we import the table instead.
1287f950b24aSSam Clegg   // Skip the "memory" section; we import the memory instead.
12887c395943SSam Clegg   writeGlobalSection();
12899e15f359SSam Clegg   writeExportSection(Exports);
12909e15f359SSam Clegg   writeElemSection(TableElems);
1291acd7d2b0SSam Clegg   writeCodeSection(Asm, Layout, Functions);
12927c395943SSam Clegg   writeDataSection(DataSegments);
1293acd7d2b0SSam Clegg   writeCodeRelocSection();
12947c395943SSam Clegg   writeDataRelocSection();
1295bafe6902SSam Clegg   writeLinkingMetaDataSection(DataSegments, DataSize, SymbolFlags,
1296ea7caceeSSam Clegg                               InitFuncs, Comdats);
1297970d02c4SDan Gohman 
1298d934cb88SDan Gohman   // TODO: Translate the .comment section to the output.
1299d934cb88SDan Gohman   // TODO: Translate debug sections to the output.
130018eafb6cSDan Gohman }
130118eafb6cSDan Gohman 
130260fbc7ccSLang Hames std::unique_ptr<MCObjectWriter>
13031301a878SLang Hames llvm::createWasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW,
130418eafb6cSDan Gohman                              raw_pwrite_stream &OS) {
13050917c9e4SDan Gohman   return llvm::make_unique<WasmObjectWriter>(std::move(MOTW), OS);
130618eafb6cSDan Gohman }
1307