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/MCAsmInfo.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/MCObjectFileInfo.h"
2518eafb6cSDan Gohman #include "llvm/MC/MCObjectWriter.h"
2618eafb6cSDan Gohman #include "llvm/MC/MCSectionWasm.h"
2718eafb6cSDan Gohman #include "llvm/MC/MCSymbolWasm.h"
2818eafb6cSDan Gohman #include "llvm/MC/MCValue.h"
2918eafb6cSDan Gohman #include "llvm/MC/MCWasmObjectWriter.h"
30d934cb88SDan Gohman #include "llvm/Support/Casting.h"
3118eafb6cSDan Gohman #include "llvm/Support/Debug.h"
3218eafb6cSDan Gohman #include "llvm/Support/ErrorHandling.h"
33d934cb88SDan Gohman #include "llvm/Support/LEB128.h"
3418eafb6cSDan Gohman #include "llvm/Support/StringSaver.h"
3518eafb6cSDan Gohman #include <vector>
3618eafb6cSDan Gohman 
3718eafb6cSDan Gohman using namespace llvm;
3818eafb6cSDan Gohman 
395e3d33a7SSam Clegg #define DEBUG_TYPE "mc"
4018eafb6cSDan Gohman 
4118eafb6cSDan Gohman namespace {
429e15f359SSam Clegg 
43d934cb88SDan Gohman // For patching purposes, we need to remember where each section starts, both
44d934cb88SDan Gohman // for patching up the section size field, and for patching up references to
45d934cb88SDan Gohman // locations within the section.
46d934cb88SDan Gohman struct SectionBookkeeping {
47d934cb88SDan Gohman   // Where the size of the section is written.
48d934cb88SDan Gohman   uint64_t SizeOffset;
49d934cb88SDan Gohman   // Where the contents of the section starts (after the header).
50d934cb88SDan Gohman   uint64_t ContentsOffset;
51d934cb88SDan Gohman };
52d934cb88SDan Gohman 
539e15f359SSam Clegg // The signature of a wasm function, in a struct capable of being used as a
549e15f359SSam Clegg // DenseMap key.
559e15f359SSam Clegg struct WasmFunctionType {
569e15f359SSam Clegg   // Support empty and tombstone instances, needed by DenseMap.
579e15f359SSam Clegg   enum { Plain, Empty, Tombstone } State;
589e15f359SSam Clegg 
599e15f359SSam Clegg   // The return types of the function.
609e15f359SSam Clegg   SmallVector<wasm::ValType, 1> Returns;
619e15f359SSam Clegg 
629e15f359SSam Clegg   // The parameter types of the function.
639e15f359SSam Clegg   SmallVector<wasm::ValType, 4> Params;
649e15f359SSam Clegg 
659e15f359SSam Clegg   WasmFunctionType() : State(Plain) {}
669e15f359SSam Clegg 
679e15f359SSam Clegg   bool operator==(const WasmFunctionType &Other) const {
689e15f359SSam Clegg     return State == Other.State && Returns == Other.Returns &&
699e15f359SSam Clegg            Params == Other.Params;
709e15f359SSam Clegg   }
719e15f359SSam Clegg };
729e15f359SSam Clegg 
739e15f359SSam Clegg // Traits for using WasmFunctionType in a DenseMap.
749e15f359SSam Clegg struct WasmFunctionTypeDenseMapInfo {
759e15f359SSam Clegg   static WasmFunctionType getEmptyKey() {
769e15f359SSam Clegg     WasmFunctionType FuncTy;
779e15f359SSam Clegg     FuncTy.State = WasmFunctionType::Empty;
789e15f359SSam Clegg     return FuncTy;
799e15f359SSam Clegg   }
809e15f359SSam Clegg   static WasmFunctionType getTombstoneKey() {
819e15f359SSam Clegg     WasmFunctionType FuncTy;
829e15f359SSam Clegg     FuncTy.State = WasmFunctionType::Tombstone;
839e15f359SSam Clegg     return FuncTy;
849e15f359SSam Clegg   }
859e15f359SSam Clegg   static unsigned getHashValue(const WasmFunctionType &FuncTy) {
869e15f359SSam Clegg     uintptr_t Value = FuncTy.State;
879e15f359SSam Clegg     for (wasm::ValType Ret : FuncTy.Returns)
889e15f359SSam Clegg       Value += DenseMapInfo<int32_t>::getHashValue(int32_t(Ret));
899e15f359SSam Clegg     for (wasm::ValType Param : FuncTy.Params)
909e15f359SSam Clegg       Value += DenseMapInfo<int32_t>::getHashValue(int32_t(Param));
919e15f359SSam Clegg     return Value;
929e15f359SSam Clegg   }
939e15f359SSam Clegg   static bool isEqual(const WasmFunctionType &LHS,
949e15f359SSam Clegg                       const WasmFunctionType &RHS) {
959e15f359SSam Clegg     return LHS == RHS;
969e15f359SSam Clegg   }
979e15f359SSam Clegg };
989e15f359SSam Clegg 
997c395943SSam Clegg // A wasm data segment.  A wasm binary contains only a single data section
1007c395943SSam Clegg // but that can contain many segments, each with their own virtual location
1017c395943SSam Clegg // in memory.  Each MCSection data created by llvm is modeled as its own
1027c395943SSam Clegg // wasm data segment.
1037c395943SSam Clegg struct WasmDataSegment {
1047c395943SSam Clegg   MCSectionWasm *Section;
105d95ed959SSam Clegg   StringRef Name;
1067c395943SSam Clegg   uint32_t Offset;
107*63ebb813SSam Clegg   uint32_t Alignment;
108*63ebb813SSam Clegg   uint32_t Flags;
1097c395943SSam Clegg   SmallVector<char, 4> Data;
1107c395943SSam Clegg };
1117c395943SSam Clegg 
1129e15f359SSam Clegg // A wasm import to be written into the import section.
1139e15f359SSam Clegg struct WasmImport {
1149e15f359SSam Clegg   StringRef ModuleName;
1159e15f359SSam Clegg   StringRef FieldName;
1169e15f359SSam Clegg   unsigned Kind;
1179e15f359SSam Clegg   int32_t Type;
1189e15f359SSam Clegg };
1199e15f359SSam Clegg 
1209e15f359SSam Clegg // A wasm function to be written into the function section.
1219e15f359SSam Clegg struct WasmFunction {
1229e15f359SSam Clegg   int32_t Type;
1239e15f359SSam Clegg   const MCSymbolWasm *Sym;
1249e15f359SSam Clegg };
1259e15f359SSam Clegg 
1269e15f359SSam Clegg // A wasm export to be written into the export section.
1279e15f359SSam Clegg struct WasmExport {
1289e15f359SSam Clegg   StringRef FieldName;
1299e15f359SSam Clegg   unsigned Kind;
1309e15f359SSam Clegg   uint32_t Index;
1319e15f359SSam Clegg };
1329e15f359SSam Clegg 
1339e15f359SSam Clegg // A wasm global to be written into the global section.
1349e15f359SSam Clegg struct WasmGlobal {
1359e15f359SSam Clegg   wasm::ValType Type;
1369e15f359SSam Clegg   bool IsMutable;
1379e15f359SSam Clegg   bool HasImport;
1389e15f359SSam Clegg   uint64_t InitialValue;
1399e15f359SSam Clegg   uint32_t ImportIndex;
1409e15f359SSam Clegg };
1419e15f359SSam Clegg 
1426dc65e91SSam Clegg // Information about a single relocation.
1436dc65e91SSam Clegg struct WasmRelocationEntry {
1446dc65e91SSam Clegg   uint64_t Offset;                  // Where is the relocation.
1456dc65e91SSam Clegg   const MCSymbolWasm *Symbol;       // The symbol to relocate with.
1466dc65e91SSam Clegg   int64_t Addend;                   // A value to add to the symbol.
1476dc65e91SSam Clegg   unsigned Type;                    // The type of the relocation.
148fe6414b0SSam Clegg   const MCSectionWasm *FixupSection;// The section the relocation is targeting.
1496dc65e91SSam Clegg 
1506dc65e91SSam Clegg   WasmRelocationEntry(uint64_t Offset, const MCSymbolWasm *Symbol,
1516dc65e91SSam Clegg                       int64_t Addend, unsigned Type,
152fe6414b0SSam Clegg                       const MCSectionWasm *FixupSection)
1536dc65e91SSam Clegg       : Offset(Offset), Symbol(Symbol), Addend(Addend), Type(Type),
1546dc65e91SSam Clegg         FixupSection(FixupSection) {}
1556dc65e91SSam Clegg 
156acd7d2b0SSam Clegg   bool hasAddend() const {
157acd7d2b0SSam Clegg     switch (Type) {
15813a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB:
15913a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB:
16013a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32:
161acd7d2b0SSam Clegg       return true;
162acd7d2b0SSam Clegg     default:
163acd7d2b0SSam Clegg       return false;
164acd7d2b0SSam Clegg     }
165acd7d2b0SSam Clegg   }
166acd7d2b0SSam Clegg 
1676dc65e91SSam Clegg   void print(raw_ostream &Out) const {
1689bf73c07SSam Clegg     Out << "Off=" << Offset << ", Sym=" << *Symbol << ", Addend=" << Addend
169759631c7SSam Clegg         << ", Type=" << Type
170759631c7SSam Clegg         << ", FixupSection=" << FixupSection->getSectionName();
1716dc65e91SSam Clegg   }
172b7787fd0SSam Clegg 
173b7787fd0SSam Clegg #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
174b7787fd0SSam Clegg   LLVM_DUMP_METHOD void dump() const { print(dbgs()); }
175b7787fd0SSam Clegg #endif
1766dc65e91SSam Clegg };
1776dc65e91SSam Clegg 
1781fb8daa6SSam Clegg #if !defined(NDEBUG)
1797f055deeSSam Clegg raw_ostream &operator<<(raw_ostream &OS, const WasmRelocationEntry &Rel) {
180b7787fd0SSam Clegg   Rel.print(OS);
181b7787fd0SSam Clegg   return OS;
182b7787fd0SSam Clegg }
1831fb8daa6SSam Clegg #endif
184b7787fd0SSam Clegg 
18518eafb6cSDan Gohman class WasmObjectWriter : public MCObjectWriter {
18618eafb6cSDan Gohman   /// Helper struct for containing some precomputed information on symbols.
18718eafb6cSDan Gohman   struct WasmSymbolData {
18818eafb6cSDan Gohman     const MCSymbolWasm *Symbol;
18918eafb6cSDan Gohman     StringRef Name;
19018eafb6cSDan Gohman 
19118eafb6cSDan Gohman     // Support lexicographic sorting.
19218eafb6cSDan Gohman     bool operator<(const WasmSymbolData &RHS) const { return Name < RHS.Name; }
19318eafb6cSDan Gohman   };
19418eafb6cSDan Gohman 
19518eafb6cSDan Gohman   /// The target specific Wasm writer instance.
19618eafb6cSDan Gohman   std::unique_ptr<MCWasmObjectTargetWriter> TargetObjectWriter;
19718eafb6cSDan Gohman 
198d934cb88SDan Gohman   // Relocations for fixing up references in the code section.
199d934cb88SDan Gohman   std::vector<WasmRelocationEntry> CodeRelocations;
200d934cb88SDan Gohman 
201d934cb88SDan Gohman   // Relocations for fixing up references in the data section.
202d934cb88SDan Gohman   std::vector<WasmRelocationEntry> DataRelocations;
203d934cb88SDan Gohman 
204d934cb88SDan Gohman   // Index values to use for fixing up call_indirect type indices.
205acd7d2b0SSam Clegg   // Maps function symbols to the index of the type of the function
206acd7d2b0SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> TypeIndices;
207d99f6078SSam Clegg   // Maps function symbols to the table element index space. Used
208d99f6078SSam Clegg   // for TABLE_INDEX relocation types (i.e. address taken functions).
209d99f6078SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> IndirectSymbolIndices;
210d99f6078SSam Clegg   // Maps function/global symbols to the function/global index space.
211acd7d2b0SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> SymbolIndices;
212acd7d2b0SSam Clegg 
213acd7d2b0SSam Clegg   DenseMap<WasmFunctionType, int32_t, WasmFunctionTypeDenseMapInfo>
214acd7d2b0SSam Clegg       FunctionTypeIndices;
2155e3d33a7SSam Clegg   SmallVector<WasmFunctionType, 4> FunctionTypes;
2167c395943SSam Clegg   SmallVector<WasmGlobal, 4> Globals;
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:
23018eafb6cSDan Gohman   WasmObjectWriter(MCWasmObjectTargetWriter *MOTW, raw_pwrite_stream &OS)
23118eafb6cSDan Gohman       : MCObjectWriter(OS, /*IsLittleEndian=*/true), TargetObjectWriter(MOTW) {}
23218eafb6cSDan Gohman 
233d934cb88SDan Gohman private:
23418eafb6cSDan Gohman   ~WasmObjectWriter() override;
23518eafb6cSDan Gohman 
236acd7d2b0SSam Clegg   void reset() override {
237acd7d2b0SSam Clegg     CodeRelocations.clear();
238acd7d2b0SSam Clegg     DataRelocations.clear();
239acd7d2b0SSam Clegg     TypeIndices.clear();
240acd7d2b0SSam Clegg     SymbolIndices.clear();
241d99f6078SSam Clegg     IndirectSymbolIndices.clear();
242acd7d2b0SSam Clegg     FunctionTypeIndices.clear();
2435e3d33a7SSam Clegg     FunctionTypes.clear();
2447c395943SSam Clegg     Globals.clear();
245acd7d2b0SSam Clegg     MCObjectWriter::reset();
2467c395943SSam Clegg     NumGlobalImports = 0;
247acd7d2b0SSam Clegg   }
248acd7d2b0SSam Clegg 
24918eafb6cSDan Gohman   void writeHeader(const MCAssembler &Asm);
25018eafb6cSDan Gohman 
25118eafb6cSDan Gohman   void recordRelocation(MCAssembler &Asm, const MCAsmLayout &Layout,
25218eafb6cSDan Gohman                         const MCFragment *Fragment, const MCFixup &Fixup,
253ceecfe5bSRafael Espindola                         MCValue Target, uint64_t &FixedValue) override;
25418eafb6cSDan Gohman 
25518eafb6cSDan Gohman   void executePostLayoutBinding(MCAssembler &Asm,
25618eafb6cSDan Gohman                                 const MCAsmLayout &Layout) override;
25718eafb6cSDan Gohman 
25818eafb6cSDan Gohman   void writeObject(MCAssembler &Asm, const MCAsmLayout &Layout) override;
2599e15f359SSam Clegg 
260b7787fd0SSam Clegg   void writeString(const StringRef Str) {
261b7787fd0SSam Clegg     encodeULEB128(Str.size(), getStream());
262b7787fd0SSam Clegg     writeBytes(Str);
263b7787fd0SSam Clegg   }
264b7787fd0SSam Clegg 
2659e15f359SSam Clegg   void writeValueType(wasm::ValType Ty) {
2669e15f359SSam Clegg     encodeSLEB128(int32_t(Ty), getStream());
2679e15f359SSam Clegg   }
2689e15f359SSam Clegg 
269457fb0b4SSam Clegg   void writeTypeSection(ArrayRef<WasmFunctionType> FunctionTypes);
270457fb0b4SSam Clegg   void writeImportSection(ArrayRef<WasmImport> Imports);
271457fb0b4SSam Clegg   void writeFunctionSection(ArrayRef<WasmFunction> Functions);
272d99f6078SSam Clegg   void writeTableSection(uint32_t NumElements);
2737c395943SSam Clegg   void writeMemorySection(uint32_t DataSize);
2747c395943SSam Clegg   void writeGlobalSection();
275457fb0b4SSam Clegg   void writeExportSection(ArrayRef<WasmExport> Exports);
276457fb0b4SSam Clegg   void writeElemSection(ArrayRef<uint32_t> TableElems);
2779e15f359SSam Clegg   void writeCodeSection(const MCAssembler &Asm, const MCAsmLayout &Layout,
278457fb0b4SSam Clegg                         ArrayRef<WasmFunction> Functions);
279457fb0b4SSam Clegg   void writeDataSection(ArrayRef<WasmDataSegment> Segments);
280457fb0b4SSam Clegg   void writeNameSection(ArrayRef<WasmFunction> Functions,
281457fb0b4SSam Clegg                         ArrayRef<WasmImport> Imports,
2829e15f359SSam Clegg                         uint32_t NumFuncImports);
283acd7d2b0SSam Clegg   void writeCodeRelocSection();
2847c395943SSam Clegg   void writeDataRelocSection();
28531a2c809SSam Clegg   void writeLinkingMetaDataSection(
28631a2c809SSam Clegg       ArrayRef<WasmDataSegment> Segments, uint32_t DataSize,
28731a2c809SSam Clegg       SmallVector<std::pair<StringRef, uint32_t>, 4> SymbolFlags,
28831a2c809SSam Clegg       bool HasStackPointer, uint32_t StackPointerGlobal);
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 
370d934cb88SDan Gohman   if (const MCSymbolRefExpr *RefB = Target.getSymB()) {
371d934cb88SDan Gohman     assert(RefB->getKind() == MCSymbolRefExpr::VK_None &&
372d934cb88SDan Gohman            "Should not have constructed this");
373d934cb88SDan Gohman 
374d934cb88SDan Gohman     // Let A, B and C being the components of Target and R be the location of
375d934cb88SDan Gohman     // the fixup. If the fixup is not pcrel, we want to compute (A - B + C).
376d934cb88SDan Gohman     // If it is pcrel, we want to compute (A - B + C - R).
377d934cb88SDan Gohman 
378d934cb88SDan Gohman     // In general, Wasm has no relocations for -B. It can only represent (A + C)
379d934cb88SDan Gohman     // or (A + C - R). If B = R + K and the relocation is not pcrel, we can
380d934cb88SDan Gohman     // replace B to implement it: (A - R - K + C)
381d934cb88SDan Gohman     if (IsPCRel) {
382d934cb88SDan Gohman       Ctx.reportError(
383d934cb88SDan Gohman           Fixup.getLoc(),
384d934cb88SDan Gohman           "No relocation available to represent this relative expression");
385d934cb88SDan Gohman       return;
386d934cb88SDan Gohman     }
387d934cb88SDan Gohman 
388d934cb88SDan Gohman     const auto &SymB = cast<MCSymbolWasm>(RefB->getSymbol());
389d934cb88SDan Gohman 
390d934cb88SDan Gohman     if (SymB.isUndefined()) {
391d934cb88SDan Gohman       Ctx.reportError(Fixup.getLoc(),
392d934cb88SDan Gohman                       Twine("symbol '") + SymB.getName() +
393d934cb88SDan Gohman                           "' can not be undefined in a subtraction expression");
394d934cb88SDan Gohman       return;
395d934cb88SDan Gohman     }
396d934cb88SDan Gohman 
397d934cb88SDan Gohman     assert(!SymB.isAbsolute() && "Should have been folded");
398d934cb88SDan Gohman     const MCSection &SecB = SymB.getSection();
399d934cb88SDan Gohman     if (&SecB != &FixupSection) {
400d934cb88SDan Gohman       Ctx.reportError(Fixup.getLoc(),
401d934cb88SDan Gohman                       "Cannot represent a difference across sections");
402d934cb88SDan Gohman       return;
403d934cb88SDan Gohman     }
404d934cb88SDan Gohman 
405d934cb88SDan Gohman     uint64_t SymBOffset = Layout.getSymbolOffset(SymB);
406d934cb88SDan Gohman     uint64_t K = SymBOffset - FixupOffset;
407d934cb88SDan Gohman     IsPCRel = true;
408d934cb88SDan Gohman     C -= K;
409d934cb88SDan Gohman   }
410d934cb88SDan Gohman 
411d934cb88SDan Gohman   // We either rejected the fixup or folded B into C at this point.
412d934cb88SDan Gohman   const MCSymbolRefExpr *RefA = Target.getSymA();
413d934cb88SDan Gohman   const auto *SymA = RefA ? cast<MCSymbolWasm>(&RefA->getSymbol()) : nullptr;
414d934cb88SDan Gohman 
415d934cb88SDan Gohman   if (SymA && SymA->isVariable()) {
416d934cb88SDan Gohman     const MCExpr *Expr = SymA->getVariableValue();
4176ad8f190SSam Clegg     const auto *Inner = cast<MCSymbolRefExpr>(Expr);
4186ad8f190SSam Clegg     if (Inner->getKind() == MCSymbolRefExpr::VK_WEAKREF)
4196ad8f190SSam Clegg       llvm_unreachable("weakref used in reloc not yet implemented");
420d934cb88SDan Gohman   }
421d934cb88SDan Gohman 
422d934cb88SDan Gohman   // Put any constant offset in an addend. Offsets can be negative, and
423d934cb88SDan Gohman   // LLVM expects wrapping, in contrast to wasm's immediates which can't
424d934cb88SDan Gohman   // be negative and don't wrap.
425d934cb88SDan Gohman   FixedValue = 0;
426d934cb88SDan Gohman 
4276ad8f190SSam Clegg   if (SymA)
428d934cb88SDan Gohman     SymA->setUsedInReloc();
429d934cb88SDan Gohman 
430ae03c1e7SSam Clegg   assert(!IsPCRel);
4319d24fb7fSSam Clegg   assert(SymA);
4329d24fb7fSSam Clegg 
433ae03c1e7SSam Clegg   unsigned Type = getRelocType(Target, Fixup);
434ae03c1e7SSam Clegg 
435d934cb88SDan Gohman   WasmRelocationEntry Rec(FixupOffset, SymA, C, Type, &FixupSection);
436b7787fd0SSam Clegg   DEBUG(dbgs() << "WasmReloc: " << Rec << "\n");
437d934cb88SDan Gohman 
438d934cb88SDan Gohman   if (FixupSection.hasInstructions())
439d934cb88SDan Gohman     CodeRelocations.push_back(Rec);
440d934cb88SDan Gohman   else
441d934cb88SDan Gohman     DataRelocations.push_back(Rec);
442d934cb88SDan Gohman }
443d934cb88SDan Gohman 
444d934cb88SDan Gohman // Write X as an (unsigned) LEB value at offset Offset in Stream, padded
445d934cb88SDan Gohman // to allow patching.
446d934cb88SDan Gohman static void
447d934cb88SDan Gohman WritePatchableLEB(raw_pwrite_stream &Stream, uint32_t X, uint64_t Offset) {
448d934cb88SDan Gohman   uint8_t Buffer[5];
44966a99e41SSam Clegg   unsigned SizeLen = encodeULEB128(X, Buffer, 5);
450d934cb88SDan Gohman   assert(SizeLen == 5);
451d934cb88SDan Gohman   Stream.pwrite((char *)Buffer, SizeLen, Offset);
452d934cb88SDan Gohman }
453d934cb88SDan Gohman 
454d934cb88SDan Gohman // Write X as an signed LEB value at offset Offset in Stream, padded
455d934cb88SDan Gohman // to allow patching.
456d934cb88SDan Gohman static void
457d934cb88SDan Gohman WritePatchableSLEB(raw_pwrite_stream &Stream, int32_t X, uint64_t Offset) {
458d934cb88SDan Gohman   uint8_t Buffer[5];
45966a99e41SSam Clegg   unsigned SizeLen = encodeSLEB128(X, Buffer, 5);
460d934cb88SDan Gohman   assert(SizeLen == 5);
461d934cb88SDan Gohman   Stream.pwrite((char *)Buffer, SizeLen, Offset);
462d934cb88SDan Gohman }
463d934cb88SDan Gohman 
464d934cb88SDan Gohman // Write X as a plain integer value at offset Offset in Stream.
465d934cb88SDan Gohman static void WriteI32(raw_pwrite_stream &Stream, uint32_t X, uint64_t Offset) {
466d934cb88SDan Gohman   uint8_t Buffer[4];
467d934cb88SDan Gohman   support::endian::write32le(Buffer, X);
468d934cb88SDan Gohman   Stream.pwrite((char *)Buffer, sizeof(Buffer), Offset);
469d934cb88SDan Gohman }
470d934cb88SDan Gohman 
471aff1c4dfSSam Clegg static const MCSymbolWasm* ResolveSymbol(const MCSymbolWasm& Symbol) {
472aff1c4dfSSam Clegg   if (Symbol.isVariable()) {
473aff1c4dfSSam Clegg     const MCExpr *Expr = Symbol.getVariableValue();
474aff1c4dfSSam Clegg     auto *Inner = cast<MCSymbolRefExpr>(Expr);
475aff1c4dfSSam Clegg     return cast<MCSymbolWasm>(&Inner->getSymbol());
476aff1c4dfSSam Clegg   }
477aff1c4dfSSam Clegg   return &Symbol;
478aff1c4dfSSam Clegg }
479aff1c4dfSSam Clegg 
480d934cb88SDan Gohman // Compute a value to write into the code at the location covered
481d934cb88SDan Gohman // by RelEntry. This value isn't used by the static linker, since
482d934cb88SDan Gohman // we have addends; it just serves to make the code more readable
483d934cb88SDan Gohman // and to make standalone wasm modules directly usable.
4847c395943SSam Clegg uint32_t
4857c395943SSam Clegg WasmObjectWriter::getProvisionalValue(const WasmRelocationEntry &RelEntry) {
486aff1c4dfSSam Clegg   const MCSymbolWasm *Sym = ResolveSymbol(*RelEntry.Symbol);
487d934cb88SDan Gohman 
488d934cb88SDan Gohman   // For undefined symbols, use a hopefully invalid value.
489b7787fd0SSam Clegg   if (!Sym->isDefined(/*SetUsed=*/false))
490d934cb88SDan Gohman     return UINT32_MAX;
491d934cb88SDan Gohman 
4927c395943SSam Clegg   uint32_t GlobalIndex = SymbolIndices[Sym];
4937c395943SSam Clegg   const WasmGlobal& Global = Globals[GlobalIndex - NumGlobalImports];
4947c395943SSam Clegg   uint64_t Address = Global.InitialValue + RelEntry.Addend;
495d934cb88SDan Gohman 
496d934cb88SDan Gohman   // Ignore overflow. LLVM allows address arithmetic to silently wrap.
497d934cb88SDan Gohman   uint32_t Value = Address;
498d934cb88SDan Gohman 
499d934cb88SDan Gohman   return Value;
500d934cb88SDan Gohman }
501d934cb88SDan Gohman 
502759631c7SSam Clegg static void addData(SmallVectorImpl<char> &DataBytes,
503*63ebb813SSam Clegg                     MCSectionWasm &DataSection) {
504759631c7SSam Clegg   DEBUG(errs() << "addData: " << DataSection.getSectionName() << "\n");
505759631c7SSam Clegg 
506*63ebb813SSam Clegg   DataBytes.resize(alignTo(DataBytes.size(), DataSection.getAlignment()));
507*63ebb813SSam Clegg 
508759631c7SSam Clegg   for (const MCFragment &Frag : DataSection) {
509759631c7SSam Clegg     if (Frag.hasInstructions())
510759631c7SSam Clegg       report_fatal_error("only data supported in data sections");
511759631c7SSam Clegg 
512759631c7SSam Clegg     if (auto *Align = dyn_cast<MCAlignFragment>(&Frag)) {
513759631c7SSam Clegg       if (Align->getValueSize() != 1)
514759631c7SSam Clegg         report_fatal_error("only byte values supported for alignment");
515759631c7SSam Clegg       // If nops are requested, use zeros, as this is the data section.
516759631c7SSam Clegg       uint8_t Value = Align->hasEmitNops() ? 0 : Align->getValue();
517759631c7SSam Clegg       uint64_t Size = std::min<uint64_t>(alignTo(DataBytes.size(),
518759631c7SSam Clegg                                                  Align->getAlignment()),
519759631c7SSam Clegg                                          DataBytes.size() +
520759631c7SSam Clegg                                              Align->getMaxBytesToEmit());
521759631c7SSam Clegg       DataBytes.resize(Size, Value);
522759631c7SSam Clegg     } else if (auto *Fill = dyn_cast<MCFillFragment>(&Frag)) {
523759631c7SSam Clegg       DataBytes.insert(DataBytes.end(), Fill->getSize(), Fill->getValue());
524759631c7SSam Clegg     } else {
525759631c7SSam Clegg       const auto &DataFrag = cast<MCDataFragment>(Frag);
526759631c7SSam Clegg       const SmallVectorImpl<char> &Contents = DataFrag.getContents();
527759631c7SSam Clegg 
528759631c7SSam Clegg       DataBytes.insert(DataBytes.end(), Contents.begin(), Contents.end());
529759631c7SSam Clegg     }
530759631c7SSam Clegg   }
531759631c7SSam Clegg 
532759631c7SSam Clegg   DEBUG(dbgs() << "addData -> " << DataBytes.size() << "\n");
533759631c7SSam Clegg }
534759631c7SSam Clegg 
535acd7d2b0SSam Clegg uint32_t WasmObjectWriter::getRelocationIndexValue(
536acd7d2b0SSam Clegg     const WasmRelocationEntry &RelEntry) {
537acd7d2b0SSam Clegg   switch (RelEntry.Type) {
538acd7d2b0SSam Clegg   case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB:
539acd7d2b0SSam Clegg   case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32:
540b7787fd0SSam Clegg     if (!IndirectSymbolIndices.count(RelEntry.Symbol))
541b7787fd0SSam Clegg       report_fatal_error("symbol not found table index space: " +
542b7787fd0SSam Clegg                          RelEntry.Symbol->getName());
543d99f6078SSam Clegg     return IndirectSymbolIndices[RelEntry.Symbol];
544d99f6078SSam Clegg   case wasm::R_WEBASSEMBLY_FUNCTION_INDEX_LEB:
5459d24fb7fSSam Clegg   case wasm::R_WEBASSEMBLY_GLOBAL_INDEX_LEB:
54613a2e899SSam Clegg   case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB:
54713a2e899SSam Clegg   case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB:
54813a2e899SSam Clegg   case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32:
549b7787fd0SSam Clegg     if (!SymbolIndices.count(RelEntry.Symbol))
550b7787fd0SSam Clegg       report_fatal_error("symbol not found function/global index space: " +
551b7787fd0SSam Clegg                          RelEntry.Symbol->getName());
552acd7d2b0SSam Clegg     return SymbolIndices[RelEntry.Symbol];
553acd7d2b0SSam Clegg   case wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB:
554b7787fd0SSam Clegg     if (!TypeIndices.count(RelEntry.Symbol))
555b7787fd0SSam Clegg       report_fatal_error("symbol not found in type index space: " +
556b7787fd0SSam Clegg                          RelEntry.Symbol->getName());
557acd7d2b0SSam Clegg     return TypeIndices[RelEntry.Symbol];
558acd7d2b0SSam Clegg   default:
559acd7d2b0SSam Clegg     llvm_unreachable("invalid relocation type");
560acd7d2b0SSam Clegg   }
561acd7d2b0SSam Clegg }
562acd7d2b0SSam Clegg 
563d934cb88SDan Gohman // Apply the portions of the relocation records that we can handle ourselves
564d934cb88SDan Gohman // directly.
565acd7d2b0SSam Clegg void WasmObjectWriter::applyRelocations(
566acd7d2b0SSam Clegg     ArrayRef<WasmRelocationEntry> Relocations, uint64_t ContentsOffset) {
567acd7d2b0SSam Clegg   raw_pwrite_stream &Stream = getStream();
568d934cb88SDan Gohman   for (const WasmRelocationEntry &RelEntry : Relocations) {
569d934cb88SDan Gohman     uint64_t Offset = ContentsOffset +
570d934cb88SDan Gohman                       RelEntry.FixupSection->getSectionOffset() +
571d934cb88SDan Gohman                       RelEntry.Offset;
572d934cb88SDan Gohman 
573b7787fd0SSam Clegg     DEBUG(dbgs() << "applyRelocation: " << RelEntry << "\n");
574acd7d2b0SSam Clegg     switch (RelEntry.Type) {
575acd7d2b0SSam Clegg     case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB:
576acd7d2b0SSam Clegg     case wasm::R_WEBASSEMBLY_FUNCTION_INDEX_LEB:
5779d24fb7fSSam Clegg     case wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB:
5789d24fb7fSSam Clegg     case wasm::R_WEBASSEMBLY_GLOBAL_INDEX_LEB: {
579acd7d2b0SSam Clegg       uint32_t Index = getRelocationIndexValue(RelEntry);
580acd7d2b0SSam Clegg       WritePatchableSLEB(Stream, Index, Offset);
581d934cb88SDan Gohman       break;
582d934cb88SDan Gohman     }
583acd7d2b0SSam Clegg     case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32: {
584acd7d2b0SSam Clegg       uint32_t Index = getRelocationIndexValue(RelEntry);
585acd7d2b0SSam Clegg       WriteI32(Stream, Index, Offset);
586d934cb88SDan Gohman       break;
587d934cb88SDan Gohman     }
58813a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB: {
5897c395943SSam Clegg       uint32_t Value = getProvisionalValue(RelEntry);
590d934cb88SDan Gohman       WritePatchableSLEB(Stream, Value, Offset);
591d934cb88SDan Gohman       break;
592d934cb88SDan Gohman     }
59313a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB: {
5947c395943SSam Clegg       uint32_t Value = getProvisionalValue(RelEntry);
595d934cb88SDan Gohman       WritePatchableLEB(Stream, Value, Offset);
596d934cb88SDan Gohman       break;
597d934cb88SDan Gohman     }
59813a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32: {
5997c395943SSam Clegg       uint32_t Value = getProvisionalValue(RelEntry);
600d934cb88SDan Gohman       WriteI32(Stream, Value, Offset);
601d934cb88SDan Gohman       break;
602d934cb88SDan Gohman     }
603d934cb88SDan Gohman     default:
6049d24fb7fSSam Clegg       llvm_unreachable("invalid relocation type");
605d934cb88SDan Gohman     }
606d934cb88SDan Gohman   }
60718eafb6cSDan Gohman }
60818eafb6cSDan Gohman 
609acd7d2b0SSam Clegg // Write out the portions of the relocation records that the linker will
610970d02c4SDan Gohman // need to handle.
611acd7d2b0SSam Clegg void WasmObjectWriter::writeRelocations(
6127c395943SSam Clegg     ArrayRef<WasmRelocationEntry> Relocations) {
613acd7d2b0SSam Clegg   raw_pwrite_stream &Stream = getStream();
614acd7d2b0SSam Clegg   for (const WasmRelocationEntry& RelEntry : Relocations) {
615970d02c4SDan Gohman 
616acd7d2b0SSam Clegg     uint64_t Offset = RelEntry.Offset +
6177c395943SSam Clegg                       RelEntry.FixupSection->getSectionOffset();
618acd7d2b0SSam Clegg     uint32_t Index = getRelocationIndexValue(RelEntry);
619970d02c4SDan Gohman 
620acd7d2b0SSam Clegg     encodeULEB128(RelEntry.Type, Stream);
621970d02c4SDan Gohman     encodeULEB128(Offset, Stream);
622acd7d2b0SSam Clegg     encodeULEB128(Index, Stream);
623acd7d2b0SSam Clegg     if (RelEntry.hasAddend())
624acd7d2b0SSam Clegg       encodeSLEB128(RelEntry.Addend, Stream);
625970d02c4SDan Gohman   }
626970d02c4SDan Gohman }
627970d02c4SDan Gohman 
6289e15f359SSam Clegg void WasmObjectWriter::writeTypeSection(
629457fb0b4SSam Clegg     ArrayRef<WasmFunctionType> FunctionTypes) {
6309e15f359SSam Clegg   if (FunctionTypes.empty())
6319e15f359SSam Clegg     return;
6329e15f359SSam Clegg 
6339e15f359SSam Clegg   SectionBookkeeping Section;
6349e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_TYPE);
6359e15f359SSam Clegg 
6369e15f359SSam Clegg   encodeULEB128(FunctionTypes.size(), getStream());
6379e15f359SSam Clegg 
6389e15f359SSam Clegg   for (const WasmFunctionType &FuncTy : FunctionTypes) {
6399e15f359SSam Clegg     encodeSLEB128(wasm::WASM_TYPE_FUNC, getStream());
6409e15f359SSam Clegg     encodeULEB128(FuncTy.Params.size(), getStream());
6419e15f359SSam Clegg     for (wasm::ValType Ty : FuncTy.Params)
6429e15f359SSam Clegg       writeValueType(Ty);
6439e15f359SSam Clegg     encodeULEB128(FuncTy.Returns.size(), getStream());
6449e15f359SSam Clegg     for (wasm::ValType Ty : FuncTy.Returns)
6459e15f359SSam Clegg       writeValueType(Ty);
6469e15f359SSam Clegg   }
6479e15f359SSam Clegg 
6489e15f359SSam Clegg   endSection(Section);
6499e15f359SSam Clegg }
6509e15f359SSam Clegg 
651457fb0b4SSam Clegg void WasmObjectWriter::writeImportSection(ArrayRef<WasmImport> Imports) {
6529e15f359SSam Clegg   if (Imports.empty())
6539e15f359SSam Clegg     return;
6549e15f359SSam Clegg 
6559e15f359SSam Clegg   SectionBookkeeping Section;
6569e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_IMPORT);
6579e15f359SSam Clegg 
6589e15f359SSam Clegg   encodeULEB128(Imports.size(), getStream());
6599e15f359SSam Clegg   for (const WasmImport &Import : Imports) {
660b7787fd0SSam Clegg     writeString(Import.ModuleName);
661b7787fd0SSam Clegg     writeString(Import.FieldName);
6629e15f359SSam Clegg 
6639e15f359SSam Clegg     encodeULEB128(Import.Kind, getStream());
6649e15f359SSam Clegg 
6659e15f359SSam Clegg     switch (Import.Kind) {
6669e15f359SSam Clegg     case wasm::WASM_EXTERNAL_FUNCTION:
6679e15f359SSam Clegg       encodeULEB128(Import.Type, getStream());
6689e15f359SSam Clegg       break;
6699e15f359SSam Clegg     case wasm::WASM_EXTERNAL_GLOBAL:
6709e15f359SSam Clegg       encodeSLEB128(int32_t(Import.Type), getStream());
6719e15f359SSam Clegg       encodeULEB128(0, getStream()); // mutability
6729e15f359SSam Clegg       break;
6739e15f359SSam Clegg     default:
6749e15f359SSam Clegg       llvm_unreachable("unsupported import kind");
6759e15f359SSam Clegg     }
6769e15f359SSam Clegg   }
6779e15f359SSam Clegg 
6789e15f359SSam Clegg   endSection(Section);
6799e15f359SSam Clegg }
6809e15f359SSam Clegg 
681457fb0b4SSam Clegg void WasmObjectWriter::writeFunctionSection(ArrayRef<WasmFunction> Functions) {
6829e15f359SSam Clegg   if (Functions.empty())
6839e15f359SSam Clegg     return;
6849e15f359SSam Clegg 
6859e15f359SSam Clegg   SectionBookkeeping Section;
6869e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_FUNCTION);
6879e15f359SSam Clegg 
6889e15f359SSam Clegg   encodeULEB128(Functions.size(), getStream());
6899e15f359SSam Clegg   for (const WasmFunction &Func : Functions)
6909e15f359SSam Clegg     encodeULEB128(Func.Type, getStream());
6919e15f359SSam Clegg 
6929e15f359SSam Clegg   endSection(Section);
6939e15f359SSam Clegg }
6949e15f359SSam Clegg 
695d99f6078SSam Clegg void WasmObjectWriter::writeTableSection(uint32_t NumElements) {
6969e15f359SSam Clegg   // For now, always emit the table section, since indirect calls are not
6979e15f359SSam Clegg   // valid without it. In the future, we could perhaps be more clever and omit
6989e15f359SSam Clegg   // it if there are no indirect calls.
699d99f6078SSam Clegg 
7009e15f359SSam Clegg   SectionBookkeeping Section;
7019e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_TABLE);
7029e15f359SSam Clegg 
703d99f6078SSam Clegg   encodeULEB128(1, getStream());                       // The number of tables.
704d99f6078SSam Clegg                                                        // Fixed to 1 for now.
705d99f6078SSam Clegg   encodeSLEB128(wasm::WASM_TYPE_ANYFUNC, getStream()); // Type of table
7069e15f359SSam Clegg   encodeULEB128(0, getStream());                       // flags
707d99f6078SSam Clegg   encodeULEB128(NumElements, getStream());             // initial
7089e15f359SSam Clegg 
7099e15f359SSam Clegg   endSection(Section);
7109e15f359SSam Clegg }
7119e15f359SSam Clegg 
7127c395943SSam Clegg void WasmObjectWriter::writeMemorySection(uint32_t DataSize) {
7139e15f359SSam Clegg   // For now, always emit the memory section, since loads and stores are not
7149e15f359SSam Clegg   // valid without it. In the future, we could perhaps be more clever and omit
7159e15f359SSam Clegg   // it if there are no loads or stores.
7169e15f359SSam Clegg   SectionBookkeeping Section;
7177c395943SSam Clegg   uint32_t NumPages = (DataSize + wasm::WasmPageSize - 1) / wasm::WasmPageSize;
7189e15f359SSam Clegg 
7199e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_MEMORY);
7209e15f359SSam Clegg   encodeULEB128(1, getStream()); // number of memory spaces
7219e15f359SSam Clegg 
7229e15f359SSam Clegg   encodeULEB128(0, getStream()); // flags
7239e15f359SSam Clegg   encodeULEB128(NumPages, getStream()); // initial
7249e15f359SSam Clegg 
7259e15f359SSam Clegg   endSection(Section);
7269e15f359SSam Clegg }
7279e15f359SSam Clegg 
7287c395943SSam Clegg void WasmObjectWriter::writeGlobalSection() {
7299e15f359SSam Clegg   if (Globals.empty())
7309e15f359SSam Clegg     return;
7319e15f359SSam Clegg 
7329e15f359SSam Clegg   SectionBookkeeping Section;
7339e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_GLOBAL);
7349e15f359SSam Clegg 
7359e15f359SSam Clegg   encodeULEB128(Globals.size(), getStream());
7369e15f359SSam Clegg   for (const WasmGlobal &Global : Globals) {
7379e15f359SSam Clegg     writeValueType(Global.Type);
7389e15f359SSam Clegg     write8(Global.IsMutable);
7399e15f359SSam Clegg 
7409e15f359SSam Clegg     if (Global.HasImport) {
7419e15f359SSam Clegg       assert(Global.InitialValue == 0);
7429e15f359SSam Clegg       write8(wasm::WASM_OPCODE_GET_GLOBAL);
7439e15f359SSam Clegg       encodeULEB128(Global.ImportIndex, getStream());
7449e15f359SSam Clegg     } else {
7459e15f359SSam Clegg       assert(Global.ImportIndex == 0);
7469e15f359SSam Clegg       write8(wasm::WASM_OPCODE_I32_CONST);
7479e15f359SSam Clegg       encodeSLEB128(Global.InitialValue, getStream()); // offset
7489e15f359SSam Clegg     }
7499e15f359SSam Clegg     write8(wasm::WASM_OPCODE_END);
7509e15f359SSam Clegg   }
7519e15f359SSam Clegg 
7529e15f359SSam Clegg   endSection(Section);
7539e15f359SSam Clegg }
7549e15f359SSam Clegg 
755457fb0b4SSam Clegg void WasmObjectWriter::writeExportSection(ArrayRef<WasmExport> Exports) {
7569e15f359SSam Clegg   if (Exports.empty())
7579e15f359SSam Clegg     return;
7589e15f359SSam Clegg 
7599e15f359SSam Clegg   SectionBookkeeping Section;
7609e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_EXPORT);
7619e15f359SSam Clegg 
7629e15f359SSam Clegg   encodeULEB128(Exports.size(), getStream());
7639e15f359SSam Clegg   for (const WasmExport &Export : Exports) {
764b7787fd0SSam Clegg     writeString(Export.FieldName);
7659e15f359SSam Clegg     encodeSLEB128(Export.Kind, getStream());
7669e15f359SSam Clegg     encodeULEB128(Export.Index, getStream());
7679e15f359SSam Clegg   }
7689e15f359SSam Clegg 
7699e15f359SSam Clegg   endSection(Section);
7709e15f359SSam Clegg }
7719e15f359SSam Clegg 
772457fb0b4SSam Clegg void WasmObjectWriter::writeElemSection(ArrayRef<uint32_t> TableElems) {
7739e15f359SSam Clegg   if (TableElems.empty())
7749e15f359SSam Clegg     return;
7759e15f359SSam Clegg 
7769e15f359SSam Clegg   SectionBookkeeping Section;
7779e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_ELEM);
7789e15f359SSam Clegg 
7799e15f359SSam Clegg   encodeULEB128(1, getStream()); // number of "segments"
7809e15f359SSam Clegg   encodeULEB128(0, getStream()); // the table index
7819e15f359SSam Clegg 
7829e15f359SSam Clegg   // init expr for starting offset
7839e15f359SSam Clegg   write8(wasm::WASM_OPCODE_I32_CONST);
7849e15f359SSam Clegg   encodeSLEB128(0, getStream());
7859e15f359SSam Clegg   write8(wasm::WASM_OPCODE_END);
7869e15f359SSam Clegg 
7879e15f359SSam Clegg   encodeULEB128(TableElems.size(), getStream());
7889e15f359SSam Clegg   for (uint32_t Elem : TableElems)
7899e15f359SSam Clegg     encodeULEB128(Elem, getStream());
7909e15f359SSam Clegg 
7919e15f359SSam Clegg   endSection(Section);
7929e15f359SSam Clegg }
7939e15f359SSam Clegg 
794457fb0b4SSam Clegg void WasmObjectWriter::writeCodeSection(const MCAssembler &Asm,
795457fb0b4SSam Clegg                                         const MCAsmLayout &Layout,
796457fb0b4SSam Clegg                                         ArrayRef<WasmFunction> Functions) {
7979e15f359SSam Clegg   if (Functions.empty())
7989e15f359SSam Clegg     return;
7999e15f359SSam Clegg 
8009e15f359SSam Clegg   SectionBookkeeping Section;
8019e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CODE);
8029e15f359SSam Clegg 
8039e15f359SSam Clegg   encodeULEB128(Functions.size(), getStream());
8049e15f359SSam Clegg 
8059e15f359SSam Clegg   for (const WasmFunction &Func : Functions) {
806fe6414b0SSam Clegg     auto &FuncSection = static_cast<MCSectionWasm &>(Func.Sym->getSection());
8079e15f359SSam Clegg 
8089e15f359SSam Clegg     int64_t Size = 0;
8099e15f359SSam Clegg     if (!Func.Sym->getSize()->evaluateAsAbsolute(Size, Layout))
8109e15f359SSam Clegg       report_fatal_error(".size expression must be evaluatable");
8119e15f359SSam Clegg 
8129e15f359SSam Clegg     encodeULEB128(Size, getStream());
813fe6414b0SSam Clegg     FuncSection.setSectionOffset(getStream().tell() - Section.ContentsOffset);
8149e15f359SSam Clegg     Asm.writeSectionData(&FuncSection, Layout);
8159e15f359SSam Clegg   }
8169e15f359SSam Clegg 
8179e15f359SSam Clegg   // Apply fixups.
818acd7d2b0SSam Clegg   applyRelocations(CodeRelocations, Section.ContentsOffset);
8199e15f359SSam Clegg 
8209e15f359SSam Clegg   endSection(Section);
8219e15f359SSam Clegg }
8229e15f359SSam Clegg 
823457fb0b4SSam Clegg void WasmObjectWriter::writeDataSection(ArrayRef<WasmDataSegment> Segments) {
8247c395943SSam Clegg   if (Segments.empty())
8257c395943SSam Clegg     return;
8269e15f359SSam Clegg 
8279e15f359SSam Clegg   SectionBookkeeping Section;
8289e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_DATA);
8299e15f359SSam Clegg 
8307c395943SSam Clegg   encodeULEB128(Segments.size(), getStream()); // count
8317c395943SSam Clegg 
8327c395943SSam Clegg   for (const WasmDataSegment & Segment : Segments) {
8339e15f359SSam Clegg     encodeULEB128(0, getStream()); // memory index
8349e15f359SSam Clegg     write8(wasm::WASM_OPCODE_I32_CONST);
8357c395943SSam Clegg     encodeSLEB128(Segment.Offset, getStream()); // offset
8369e15f359SSam Clegg     write8(wasm::WASM_OPCODE_END);
8377c395943SSam Clegg     encodeULEB128(Segment.Data.size(), getStream()); // size
8387c395943SSam Clegg     Segment.Section->setSectionOffset(getStream().tell() - Section.ContentsOffset);
8397c395943SSam Clegg     writeBytes(Segment.Data); // data
8407c395943SSam Clegg   }
8419e15f359SSam Clegg 
8429e15f359SSam Clegg   // Apply fixups.
8437c395943SSam Clegg   applyRelocations(DataRelocations, Section.ContentsOffset);
8449e15f359SSam Clegg 
8459e15f359SSam Clegg   endSection(Section);
8469e15f359SSam Clegg }
8479e15f359SSam Clegg 
8489e15f359SSam Clegg void WasmObjectWriter::writeNameSection(
849457fb0b4SSam Clegg     ArrayRef<WasmFunction> Functions,
850457fb0b4SSam Clegg     ArrayRef<WasmImport> Imports,
8519e15f359SSam Clegg     unsigned NumFuncImports) {
8529e15f359SSam Clegg   uint32_t TotalFunctions = NumFuncImports + Functions.size();
8539e15f359SSam Clegg   if (TotalFunctions == 0)
8549e15f359SSam Clegg     return;
8559e15f359SSam Clegg 
8569e15f359SSam Clegg   SectionBookkeeping Section;
8579e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CUSTOM, "name");
8589e15f359SSam Clegg   SectionBookkeeping SubSection;
8599e15f359SSam Clegg   startSection(SubSection, wasm::WASM_NAMES_FUNCTION);
8609e15f359SSam Clegg 
8619e15f359SSam Clegg   encodeULEB128(TotalFunctions, getStream());
8629e15f359SSam Clegg   uint32_t Index = 0;
8639e15f359SSam Clegg   for (const WasmImport &Import : Imports) {
8649e15f359SSam Clegg     if (Import.Kind == wasm::WASM_EXTERNAL_FUNCTION) {
8659e15f359SSam Clegg       encodeULEB128(Index, getStream());
866b7787fd0SSam Clegg       writeString(Import.FieldName);
8679e15f359SSam Clegg       ++Index;
8689e15f359SSam Clegg     }
8699e15f359SSam Clegg   }
8709e15f359SSam Clegg   for (const WasmFunction &Func : Functions) {
8719e15f359SSam Clegg     encodeULEB128(Index, getStream());
872b7787fd0SSam Clegg     writeString(Func.Sym->getName());
8739e15f359SSam Clegg     ++Index;
8749e15f359SSam Clegg   }
8759e15f359SSam Clegg 
8769e15f359SSam Clegg   endSection(SubSection);
8779e15f359SSam Clegg   endSection(Section);
8789e15f359SSam Clegg }
8799e15f359SSam Clegg 
880acd7d2b0SSam Clegg void WasmObjectWriter::writeCodeRelocSection() {
8819e15f359SSam Clegg   // See: https://github.com/WebAssembly/tool-conventions/blob/master/Linking.md
8829e15f359SSam Clegg   // for descriptions of the reloc sections.
8839e15f359SSam Clegg 
8849e15f359SSam Clegg   if (CodeRelocations.empty())
8859e15f359SSam Clegg     return;
8869e15f359SSam Clegg 
8879e15f359SSam Clegg   SectionBookkeeping Section;
8889e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CUSTOM, "reloc.CODE");
8899e15f359SSam Clegg 
8909e15f359SSam Clegg   encodeULEB128(wasm::WASM_SEC_CODE, getStream());
891acd7d2b0SSam Clegg   encodeULEB128(CodeRelocations.size(), getStream());
8929e15f359SSam Clegg 
8937c395943SSam Clegg   writeRelocations(CodeRelocations);
8949e15f359SSam Clegg 
8959e15f359SSam Clegg   endSection(Section);
8969e15f359SSam Clegg }
8979e15f359SSam Clegg 
8987c395943SSam Clegg void WasmObjectWriter::writeDataRelocSection() {
8999e15f359SSam Clegg   // See: https://github.com/WebAssembly/tool-conventions/blob/master/Linking.md
9009e15f359SSam Clegg   // for descriptions of the reloc sections.
9019e15f359SSam Clegg 
9029e15f359SSam Clegg   if (DataRelocations.empty())
9039e15f359SSam Clegg     return;
9049e15f359SSam Clegg 
9059e15f359SSam Clegg   SectionBookkeeping Section;
9069e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CUSTOM, "reloc.DATA");
9079e15f359SSam Clegg 
9089e15f359SSam Clegg   encodeULEB128(wasm::WASM_SEC_DATA, getStream());
9099e15f359SSam Clegg   encodeULEB128(DataRelocations.size(), getStream());
9109e15f359SSam Clegg 
9117c395943SSam Clegg   writeRelocations(DataRelocations);
9129e15f359SSam Clegg 
9139e15f359SSam Clegg   endSection(Section);
9149e15f359SSam Clegg }
9159e15f359SSam Clegg 
9169e15f359SSam Clegg void WasmObjectWriter::writeLinkingMetaDataSection(
917d95ed959SSam Clegg     ArrayRef<WasmDataSegment> Segments, uint32_t DataSize,
91831a2c809SSam Clegg     SmallVector<std::pair<StringRef, uint32_t>, 4> SymbolFlags,
9199e1ade93SSam Clegg     bool HasStackPointer, uint32_t StackPointerGlobal) {
9209e15f359SSam Clegg   SectionBookkeeping Section;
9219e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CUSTOM, "linking");
922b7787fd0SSam Clegg   SectionBookkeeping SubSection;
9239e15f359SSam Clegg 
924b7787fd0SSam Clegg   if (HasStackPointer) {
925b7787fd0SSam Clegg     startSection(SubSection, wasm::WASM_STACK_POINTER);
9269e15f359SSam Clegg     encodeULEB128(StackPointerGlobal, getStream()); // id
927b7787fd0SSam Clegg     endSection(SubSection);
928b7787fd0SSam Clegg   }
929b7787fd0SSam Clegg 
93031a2c809SSam Clegg   if (SymbolFlags.size() != 0) {
931b7787fd0SSam Clegg     startSection(SubSection, wasm::WASM_SYMBOL_INFO);
93231a2c809SSam Clegg     encodeULEB128(SymbolFlags.size(), getStream());
93331a2c809SSam Clegg     for (auto Pair: SymbolFlags) {
93431a2c809SSam Clegg       writeString(Pair.first);
93531a2c809SSam Clegg       encodeULEB128(Pair.second, getStream());
936b7787fd0SSam Clegg     }
937b7787fd0SSam Clegg     endSection(SubSection);
938b7787fd0SSam Clegg   }
9399e15f359SSam Clegg 
9409e1ade93SSam Clegg   if (DataSize > 0) {
9419e1ade93SSam Clegg     startSection(SubSection, wasm::WASM_DATA_SIZE);
9429e1ade93SSam Clegg     encodeULEB128(DataSize, getStream());
9439e1ade93SSam Clegg     endSection(SubSection);
9449e1ade93SSam Clegg   }
9459e1ade93SSam Clegg 
946d95ed959SSam Clegg   if (Segments.size()) {
947*63ebb813SSam Clegg     startSection(SubSection, wasm::WASM_SEGMENT_INFO);
948d95ed959SSam Clegg     encodeULEB128(Segments.size(), getStream());
949*63ebb813SSam Clegg     for (const WasmDataSegment &Segment : Segments) {
950d95ed959SSam Clegg       writeString(Segment.Name);
951*63ebb813SSam Clegg       encodeULEB128(Segment.Alignment, getStream());
952*63ebb813SSam Clegg       encodeULEB128(Segment.Flags, getStream());
953*63ebb813SSam Clegg     }
954d95ed959SSam Clegg     endSection(SubSection);
955d95ed959SSam Clegg   }
956d95ed959SSam Clegg 
9579e15f359SSam Clegg   endSection(Section);
9589e15f359SSam Clegg }
9599e15f359SSam Clegg 
9605e3d33a7SSam Clegg uint32_t WasmObjectWriter::getFunctionType(const MCSymbolWasm& Symbol) {
9615e3d33a7SSam Clegg   assert(Symbol.isFunction());
9625e3d33a7SSam Clegg   assert(TypeIndices.count(&Symbol));
9635e3d33a7SSam Clegg   return TypeIndices[&Symbol];
9645e3d33a7SSam Clegg }
9655e3d33a7SSam Clegg 
9665e3d33a7SSam Clegg uint32_t WasmObjectWriter::registerFunctionType(const MCSymbolWasm& Symbol) {
9675e3d33a7SSam Clegg   assert(Symbol.isFunction());
9685e3d33a7SSam Clegg 
9695e3d33a7SSam Clegg   WasmFunctionType F;
970aff1c4dfSSam Clegg   const MCSymbolWasm* ResolvedSym = ResolveSymbol(Symbol);
9715e3d33a7SSam Clegg   F.Returns = ResolvedSym->getReturns();
9725e3d33a7SSam Clegg   F.Params = ResolvedSym->getParams();
9735e3d33a7SSam Clegg 
9745e3d33a7SSam Clegg   auto Pair =
9755e3d33a7SSam Clegg       FunctionTypeIndices.insert(std::make_pair(F, FunctionTypes.size()));
9765e3d33a7SSam Clegg   if (Pair.second)
9775e3d33a7SSam Clegg     FunctionTypes.push_back(F);
9785e3d33a7SSam Clegg   TypeIndices[&Symbol] = Pair.first->second;
9795e3d33a7SSam Clegg 
9805e3d33a7SSam Clegg   DEBUG(dbgs() << "registerFunctionType: " << Symbol << " new:" << Pair.second << "\n");
9815e3d33a7SSam Clegg   DEBUG(dbgs() << "  -> type index: " << Pair.first->second << "\n");
9825e3d33a7SSam Clegg   return Pair.first->second;
9835e3d33a7SSam Clegg }
9845e3d33a7SSam Clegg 
98518eafb6cSDan Gohman void WasmObjectWriter::writeObject(MCAssembler &Asm,
98618eafb6cSDan Gohman                                    const MCAsmLayout &Layout) {
987b7787fd0SSam Clegg   DEBUG(dbgs() << "WasmObjectWriter::writeObject\n");
98882607f56SDan Gohman   MCContext &Ctx = Asm.getContext();
989b879539aSDerek Schuff   wasm::ValType PtrType = is64Bit() ? wasm::ValType::I64 : wasm::ValType::I32;
990d934cb88SDan Gohman 
991d934cb88SDan Gohman   // Collect information from the available symbols.
992d934cb88SDan Gohman   SmallVector<WasmFunction, 4> Functions;
993d934cb88SDan Gohman   SmallVector<uint32_t, 4> TableElems;
994d934cb88SDan Gohman   SmallVector<WasmImport, 4> Imports;
995d934cb88SDan Gohman   SmallVector<WasmExport, 4> Exports;
99631a2c809SSam Clegg   SmallVector<std::pair<StringRef, uint32_t>, 4> SymbolFlags;
997d934cb88SDan Gohman   SmallPtrSet<const MCSymbolWasm *, 4> IsAddressTaken;
998d934cb88SDan Gohman   unsigned NumFuncImports = 0;
9997c395943SSam Clegg   SmallVector<WasmDataSegment, 4> DataSegments;
1000970d02c4SDan Gohman   uint32_t StackPointerGlobal = 0;
10017c395943SSam Clegg   uint32_t DataSize = 0;
1002970d02c4SDan Gohman   bool HasStackPointer = false;
1003d934cb88SDan Gohman 
1004d934cb88SDan Gohman   // Populate the IsAddressTaken set.
1005b7787fd0SSam Clegg   for (const WasmRelocationEntry &RelEntry : CodeRelocations) {
1006d934cb88SDan Gohman     switch (RelEntry.Type) {
1007d934cb88SDan Gohman     case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB:
100813a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB:
1009d934cb88SDan Gohman       IsAddressTaken.insert(RelEntry.Symbol);
1010d934cb88SDan Gohman       break;
1011d934cb88SDan Gohman     default:
1012d934cb88SDan Gohman       break;
1013d934cb88SDan Gohman     }
1014d934cb88SDan Gohman   }
1015b7787fd0SSam Clegg   for (const WasmRelocationEntry &RelEntry : DataRelocations) {
1016d934cb88SDan Gohman     switch (RelEntry.Type) {
1017d934cb88SDan Gohman     case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32:
101813a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32:
1019d934cb88SDan Gohman       IsAddressTaken.insert(RelEntry.Symbol);
1020d934cb88SDan Gohman       break;
1021d934cb88SDan Gohman     default:
1022d934cb88SDan Gohman       break;
1023d934cb88SDan Gohman     }
1024d934cb88SDan Gohman   }
1025d934cb88SDan Gohman 
10267c395943SSam Clegg   // Populate FunctionTypeIndices and Imports.
1027d934cb88SDan Gohman   for (const MCSymbol &S : Asm.symbols()) {
10285e3d33a7SSam Clegg     const auto &WS = static_cast<const MCSymbolWasm &>(S);
10295e3d33a7SSam Clegg 
10305e3d33a7SSam Clegg     if (WS.isTemporary())
10318c4baa00SSam Clegg       continue;
10328c4baa00SSam Clegg 
10335e3d33a7SSam Clegg     if (WS.isFunction())
10345e3d33a7SSam Clegg       registerFunctionType(WS);
1035d934cb88SDan Gohman 
1036d934cb88SDan Gohman     // If the symbol is not defined in this translation unit, import it.
1037ba9fa9fdSSam Clegg     if (!WS.isDefined(/*SetUsed=*/false)) {
1038d934cb88SDan Gohman       WasmImport Import;
1039d934cb88SDan Gohman       Import.ModuleName = WS.getModuleName();
1040d934cb88SDan Gohman       Import.FieldName = WS.getName();
1041d934cb88SDan Gohman 
1042d934cb88SDan Gohman       if (WS.isFunction()) {
1043d934cb88SDan Gohman         Import.Kind = wasm::WASM_EXTERNAL_FUNCTION;
10445e3d33a7SSam Clegg         Import.Type = getFunctionType(WS);
1045d934cb88SDan Gohman         SymbolIndices[&WS] = NumFuncImports;
1046d934cb88SDan Gohman         ++NumFuncImports;
1047d934cb88SDan Gohman       } else {
1048d934cb88SDan Gohman         Import.Kind = wasm::WASM_EXTERNAL_GLOBAL;
10495e3d33a7SSam Clegg         Import.Type = int32_t(PtrType);
1050d934cb88SDan Gohman         SymbolIndices[&WS] = NumGlobalImports;
1051d934cb88SDan Gohman         ++NumGlobalImports;
1052d934cb88SDan Gohman       }
1053d934cb88SDan Gohman 
1054d934cb88SDan Gohman       Imports.push_back(Import);
1055d934cb88SDan Gohman     }
1056d934cb88SDan Gohman   }
1057d934cb88SDan Gohman 
105882607f56SDan Gohman   // In the special .global_variables section, we've encoded global
105982607f56SDan Gohman   // variables used by the function. Translate them into the Globals
106082607f56SDan Gohman   // list.
1061759631c7SSam Clegg   MCSectionWasm *GlobalVars = Ctx.getWasmSection(".global_variables", wasm::WASM_SEC_DATA);
106282607f56SDan Gohman   if (!GlobalVars->getFragmentList().empty()) {
106382607f56SDan Gohman     if (GlobalVars->getFragmentList().size() != 1)
106482607f56SDan Gohman       report_fatal_error("only one .global_variables fragment supported");
106582607f56SDan Gohman     const MCFragment &Frag = *GlobalVars->begin();
106682607f56SDan Gohman     if (Frag.hasInstructions() || Frag.getKind() != MCFragment::FT_Data)
106782607f56SDan Gohman       report_fatal_error("only data supported in .global_variables");
1068fe6414b0SSam Clegg     const auto &DataFrag = cast<MCDataFragment>(Frag);
106982607f56SDan Gohman     if (!DataFrag.getFixups().empty())
107082607f56SDan Gohman       report_fatal_error("fixups not supported in .global_variables");
107182607f56SDan Gohman     const SmallVectorImpl<char> &Contents = DataFrag.getContents();
1072970d02c4SDan Gohman     for (const uint8_t *p = (const uint8_t *)Contents.data(),
1073970d02c4SDan Gohman                      *end = (const uint8_t *)Contents.data() + Contents.size();
1074970d02c4SDan Gohman          p != end; ) {
107582607f56SDan Gohman       WasmGlobal G;
1076970d02c4SDan Gohman       if (end - p < 3)
1077970d02c4SDan Gohman         report_fatal_error("truncated global variable encoding");
1078970d02c4SDan Gohman       G.Type = wasm::ValType(int8_t(*p++));
1079970d02c4SDan Gohman       G.IsMutable = bool(*p++);
1080970d02c4SDan Gohman       G.HasImport = bool(*p++);
1081970d02c4SDan Gohman       if (G.HasImport) {
108282607f56SDan Gohman         G.InitialValue = 0;
1083970d02c4SDan Gohman 
1084970d02c4SDan Gohman         WasmImport Import;
1085970d02c4SDan Gohman         Import.ModuleName = (const char *)p;
1086970d02c4SDan Gohman         const uint8_t *nul = (const uint8_t *)memchr(p, '\0', end - p);
1087970d02c4SDan Gohman         if (!nul)
1088970d02c4SDan Gohman           report_fatal_error("global module name must be nul-terminated");
1089970d02c4SDan Gohman         p = nul + 1;
1090970d02c4SDan Gohman         nul = (const uint8_t *)memchr(p, '\0', end - p);
1091970d02c4SDan Gohman         if (!nul)
1092970d02c4SDan Gohman           report_fatal_error("global base name must be nul-terminated");
1093970d02c4SDan Gohman         Import.FieldName = (const char *)p;
1094970d02c4SDan Gohman         p = nul + 1;
1095970d02c4SDan Gohman 
1096970d02c4SDan Gohman         Import.Kind = wasm::WASM_EXTERNAL_GLOBAL;
1097970d02c4SDan Gohman         Import.Type = int32_t(G.Type);
1098970d02c4SDan Gohman 
1099970d02c4SDan Gohman         G.ImportIndex = NumGlobalImports;
1100970d02c4SDan Gohman         ++NumGlobalImports;
1101970d02c4SDan Gohman 
1102970d02c4SDan Gohman         Imports.push_back(Import);
1103970d02c4SDan Gohman       } else {
1104970d02c4SDan Gohman         unsigned n;
1105970d02c4SDan Gohman         G.InitialValue = decodeSLEB128(p, &n);
1106970d02c4SDan Gohman         G.ImportIndex = 0;
1107c8da0c0bSSimon Pilgrim         if ((ptrdiff_t)n > end - p)
1108970d02c4SDan Gohman           report_fatal_error("global initial value must be valid SLEB128");
1109970d02c4SDan Gohman         p += n;
1110970d02c4SDan Gohman       }
111182607f56SDan Gohman       Globals.push_back(G);
111282607f56SDan Gohman     }
111382607f56SDan Gohman   }
111482607f56SDan Gohman 
1115970d02c4SDan Gohman   // In the special .stack_pointer section, we've encoded the stack pointer
1116970d02c4SDan Gohman   // index.
1117759631c7SSam Clegg   MCSectionWasm *StackPtr = Ctx.getWasmSection(".stack_pointer", wasm::WASM_SEC_DATA);
1118970d02c4SDan Gohman   if (!StackPtr->getFragmentList().empty()) {
1119970d02c4SDan Gohman     if (StackPtr->getFragmentList().size() != 1)
1120970d02c4SDan Gohman       report_fatal_error("only one .stack_pointer fragment supported");
1121970d02c4SDan Gohman     const MCFragment &Frag = *StackPtr->begin();
1122970d02c4SDan Gohman     if (Frag.hasInstructions() || Frag.getKind() != MCFragment::FT_Data)
1123970d02c4SDan Gohman       report_fatal_error("only data supported in .stack_pointer");
1124fe6414b0SSam Clegg     const auto &DataFrag = cast<MCDataFragment>(Frag);
1125970d02c4SDan Gohman     if (!DataFrag.getFixups().empty())
1126970d02c4SDan Gohman       report_fatal_error("fixups not supported in .stack_pointer");
1127970d02c4SDan Gohman     const SmallVectorImpl<char> &Contents = DataFrag.getContents();
1128970d02c4SDan Gohman     if (Contents.size() != 4)
1129970d02c4SDan Gohman       report_fatal_error("only one entry supported in .stack_pointer");
1130970d02c4SDan Gohman     HasStackPointer = true;
1131970d02c4SDan Gohman     StackPointerGlobal = NumGlobalImports + *(const int32_t *)Contents.data();
1132970d02c4SDan Gohman   }
1133970d02c4SDan Gohman 
1134759631c7SSam Clegg   for (MCSection &Sec : Asm) {
1135759631c7SSam Clegg     auto &Section = static_cast<MCSectionWasm &>(Sec);
1136759631c7SSam Clegg     if (Section.getType() != wasm::WASM_SEC_DATA)
1137759631c7SSam Clegg       continue;
1138759631c7SSam Clegg 
1139759631c7SSam Clegg     DataSize = alignTo(DataSize, Section.getAlignment());
1140759631c7SSam Clegg     DataSegments.emplace_back();
1141759631c7SSam Clegg     WasmDataSegment &Segment = DataSegments.back();
1142d95ed959SSam Clegg     Segment.Name = Section.getSectionName();
1143759631c7SSam Clegg     Segment.Offset = DataSize;
1144759631c7SSam Clegg     Segment.Section = &Section;
1145*63ebb813SSam Clegg     addData(Segment.Data, Section);
1146*63ebb813SSam Clegg     Segment.Alignment = Section.getAlignment();
1147*63ebb813SSam Clegg     Segment.Flags = 0;
1148759631c7SSam Clegg     DataSize += Segment.Data.size();
1149759631c7SSam Clegg     Section.setMemoryOffset(Segment.Offset);
1150759631c7SSam Clegg   }
1151759631c7SSam Clegg 
1152b7787fd0SSam Clegg   // Handle regular defined and undefined symbols.
1153d934cb88SDan Gohman   for (const MCSymbol &S : Asm.symbols()) {
1154d934cb88SDan Gohman     // Ignore unnamed temporary symbols, which aren't ever exported, imported,
1155d934cb88SDan Gohman     // or used in relocations.
1156d934cb88SDan Gohman     if (S.isTemporary() && S.getName().empty())
1157d934cb88SDan Gohman       continue;
1158b7787fd0SSam Clegg 
1159d934cb88SDan Gohman     const auto &WS = static_cast<const MCSymbolWasm &>(S);
1160b7787fd0SSam Clegg     DEBUG(dbgs() << "MCSymbol: '" << S << "'"
1161b7787fd0SSam Clegg                  << " isDefined=" << S.isDefined() << " isExternal="
1162b7787fd0SSam Clegg                  << S.isExternal() << " isTemporary=" << S.isTemporary()
1163b7787fd0SSam Clegg                  << " isFunction=" << WS.isFunction()
1164b7787fd0SSam Clegg                  << " isWeak=" << WS.isWeak()
1165b7787fd0SSam Clegg                  << " isVariable=" << WS.isVariable() << "\n");
1166b7787fd0SSam Clegg 
1167b7787fd0SSam Clegg     if (WS.isWeak())
116831a2c809SSam Clegg       SymbolFlags.emplace_back(WS.getName(), wasm::WASM_SYMBOL_BINDING_WEAK);
1169b7787fd0SSam Clegg 
11705e3d33a7SSam Clegg     if (WS.isVariable())
11715e3d33a7SSam Clegg       continue;
11725e3d33a7SSam Clegg 
1173d934cb88SDan Gohman     unsigned Index;
1174b7787fd0SSam Clegg 
1175d934cb88SDan Gohman     if (WS.isFunction()) {
1176d934cb88SDan Gohman       if (WS.isDefined(/*SetUsed=*/false)) {
1177b7787fd0SSam Clegg         if (WS.getOffset() != 0)
1178b7787fd0SSam Clegg           report_fatal_error(
1179b7787fd0SSam Clegg               "function sections must contain one function each");
1180b7787fd0SSam Clegg 
1181b7787fd0SSam Clegg         if (WS.getSize() == 0)
1182b7787fd0SSam Clegg           report_fatal_error(
1183b7787fd0SSam Clegg               "function symbols must have a size set with .size");
1184b7787fd0SSam Clegg 
1185d934cb88SDan Gohman         // A definition. Take the next available index.
1186d934cb88SDan Gohman         Index = NumFuncImports + Functions.size();
1187d934cb88SDan Gohman 
1188d934cb88SDan Gohman         // Prepare the function.
1189d934cb88SDan Gohman         WasmFunction Func;
11905e3d33a7SSam Clegg         Func.Type = getFunctionType(WS);
1191d934cb88SDan Gohman         Func.Sym = &WS;
1192d934cb88SDan Gohman         SymbolIndices[&WS] = Index;
1193d934cb88SDan Gohman         Functions.push_back(Func);
1194d934cb88SDan Gohman       } else {
1195d934cb88SDan Gohman         // An import; the index was assigned above.
1196d934cb88SDan Gohman         Index = SymbolIndices.find(&WS)->second;
1197d934cb88SDan Gohman       }
1198d934cb88SDan Gohman 
11995e3d33a7SSam Clegg       DEBUG(dbgs() << "  -> function index: " << Index << "\n");
12005e3d33a7SSam Clegg 
1201d934cb88SDan Gohman       // If needed, prepare the function to be called indirectly.
12025e3d33a7SSam Clegg       if (IsAddressTaken.count(&WS) != 0) {
1203d99f6078SSam Clegg         IndirectSymbolIndices[&WS] = TableElems.size();
12045e3d33a7SSam Clegg         DEBUG(dbgs() << "  -> adding to table: " << TableElems.size() << "\n");
1205d934cb88SDan Gohman         TableElems.push_back(Index);
1206d99f6078SSam Clegg       }
1207d934cb88SDan Gohman     } else {
1208c38e947eSSam Clegg       if (WS.isTemporary() && !WS.getSize())
1209c38e947eSSam Clegg         continue;
1210c38e947eSSam Clegg 
1211fe6414b0SSam Clegg       if (!WS.isDefined(/*SetUsed=*/false))
1212fe6414b0SSam Clegg         continue;
1213fe6414b0SSam Clegg 
1214d934cb88SDan Gohman       if (!WS.getSize())
1215c38e947eSSam Clegg         report_fatal_error("data symbols must have a size set with .size: " +
1216c38e947eSSam Clegg                            WS.getName());
1217d934cb88SDan Gohman 
1218d934cb88SDan Gohman       int64_t Size = 0;
1219d934cb88SDan Gohman       if (!WS.getSize()->evaluateAsAbsolute(Size, Layout))
1220d934cb88SDan Gohman         report_fatal_error(".size expression must be evaluatable");
1221d934cb88SDan Gohman 
12227c395943SSam Clegg       // For each global, prepare a corresponding wasm global holding its
12237c395943SSam Clegg       // address.  For externals these will also be named exports.
12247c395943SSam Clegg       Index = NumGlobalImports + Globals.size();
1225759631c7SSam Clegg       auto &DataSection = static_cast<MCSectionWasm &>(WS.getSection());
12267c395943SSam Clegg 
12277c395943SSam Clegg       WasmGlobal Global;
12287c395943SSam Clegg       Global.Type = PtrType;
12297c395943SSam Clegg       Global.IsMutable = false;
12307c395943SSam Clegg       Global.HasImport = false;
1231759631c7SSam Clegg       Global.InitialValue = DataSection.getMemoryOffset() + Layout.getSymbolOffset(WS);
12327c395943SSam Clegg       Global.ImportIndex = 0;
12337c395943SSam Clegg       SymbolIndices[&WS] = Index;
12347c395943SSam Clegg       DEBUG(dbgs() << "  -> global index: " << Index << "\n");
12357c395943SSam Clegg       Globals.push_back(Global);
1236d934cb88SDan Gohman     }
1237d934cb88SDan Gohman 
1238d934cb88SDan Gohman     // If the symbol is visible outside this translation unit, export it.
123931a2c809SSam Clegg     if (WS.isDefined(/*SetUsed=*/false)) {
1240d934cb88SDan Gohman       WasmExport Export;
1241d934cb88SDan Gohman       Export.FieldName = WS.getName();
1242d934cb88SDan Gohman       Export.Index = Index;
1243d934cb88SDan Gohman       if (WS.isFunction())
1244d934cb88SDan Gohman         Export.Kind = wasm::WASM_EXTERNAL_FUNCTION;
1245d934cb88SDan Gohman       else
1246d934cb88SDan Gohman         Export.Kind = wasm::WASM_EXTERNAL_GLOBAL;
12475e3d33a7SSam Clegg       DEBUG(dbgs() << "  -> export " << Exports.size() << "\n");
1248d934cb88SDan Gohman       Exports.push_back(Export);
124931a2c809SSam Clegg       if (!WS.isExternal())
125031a2c809SSam Clegg         SymbolFlags.emplace_back(WS.getName(), wasm::WASM_SYMBOL_BINDING_LOCAL);
1251d934cb88SDan Gohman     }
1252d934cb88SDan Gohman   }
1253d934cb88SDan Gohman 
12545e3d33a7SSam Clegg   // Handle weak aliases. We need to process these in a separate pass because
12555e3d33a7SSam Clegg   // we need to have processed the target of the alias before the alias itself
12565e3d33a7SSam Clegg   // and the symbols are not necessarily ordered in this way.
1257b7787fd0SSam Clegg   for (const MCSymbol &S : Asm.symbols()) {
1258b7787fd0SSam Clegg     if (!S.isVariable())
1259b7787fd0SSam Clegg       continue;
126031a2c809SSam Clegg 
1261b7787fd0SSam Clegg     assert(S.isDefined(/*SetUsed=*/false));
1262b7787fd0SSam Clegg 
12635e3d33a7SSam Clegg     // Find the target symbol of this weak alias and export that index
1264aff1c4dfSSam Clegg     const auto &WS = static_cast<const MCSymbolWasm &>(S);
1265aff1c4dfSSam Clegg     const MCSymbolWasm *ResolvedSym = ResolveSymbol(WS);
12665e3d33a7SSam Clegg     DEBUG(dbgs() << WS.getName() << ": weak alias of '" << *ResolvedSym << "'\n");
12675e3d33a7SSam Clegg     assert(SymbolIndices.count(ResolvedSym) > 0);
1268b7787fd0SSam Clegg     uint32_t Index = SymbolIndices.find(ResolvedSym)->second;
12695e3d33a7SSam Clegg     DEBUG(dbgs() << "  -> index:" << Index << "\n");
1270b7787fd0SSam Clegg 
1271ba9fa9fdSSam Clegg     SymbolIndices[&WS] = Index;
1272b7787fd0SSam Clegg     WasmExport Export;
1273b7787fd0SSam Clegg     Export.FieldName = WS.getName();
1274b7787fd0SSam Clegg     Export.Index = Index;
1275b7787fd0SSam Clegg     if (WS.isFunction())
1276b7787fd0SSam Clegg       Export.Kind = wasm::WASM_EXTERNAL_FUNCTION;
1277b7787fd0SSam Clegg     else
1278b7787fd0SSam Clegg       Export.Kind = wasm::WASM_EXTERNAL_GLOBAL;
12795e3d33a7SSam Clegg     DEBUG(dbgs() << "  -> export " << Exports.size() << "\n");
1280b7787fd0SSam Clegg     Exports.push_back(Export);
128131a2c809SSam Clegg 
128231a2c809SSam Clegg     if (!WS.isExternal())
128331a2c809SSam Clegg       SymbolFlags.emplace_back(WS.getName(), wasm::WASM_SYMBOL_BINDING_LOCAL);
1284b7787fd0SSam Clegg   }
1285b7787fd0SSam Clegg 
1286d934cb88SDan Gohman   // Add types for indirect function calls.
1287acd7d2b0SSam Clegg   for (const WasmRelocationEntry &Fixup : CodeRelocations) {
1288acd7d2b0SSam Clegg     if (Fixup.Type != wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB)
1289acd7d2b0SSam Clegg       continue;
1290970d02c4SDan Gohman 
12915e3d33a7SSam Clegg     registerFunctionType(*Fixup.Symbol);
1292d934cb88SDan Gohman   }
1293d934cb88SDan Gohman 
129418eafb6cSDan Gohman   // Write out the Wasm header.
129518eafb6cSDan Gohman   writeHeader(Asm);
129618eafb6cSDan Gohman 
12979e15f359SSam Clegg   writeTypeSection(FunctionTypes);
12989e15f359SSam Clegg   writeImportSection(Imports);
12999e15f359SSam Clegg   writeFunctionSection(Functions);
1300d99f6078SSam Clegg   writeTableSection(TableElems.size());
13017c395943SSam Clegg   writeMemorySection(DataSize);
13027c395943SSam Clegg   writeGlobalSection();
13039e15f359SSam Clegg   writeExportSection(Exports);
13049e15f359SSam Clegg   // TODO: Start Section
13059e15f359SSam Clegg   writeElemSection(TableElems);
1306acd7d2b0SSam Clegg   writeCodeSection(Asm, Layout, Functions);
13077c395943SSam Clegg   writeDataSection(DataSegments);
13089e15f359SSam Clegg   writeNameSection(Functions, Imports, NumFuncImports);
1309acd7d2b0SSam Clegg   writeCodeRelocSection();
13107c395943SSam Clegg   writeDataRelocSection();
1311*63ebb813SSam Clegg   writeLinkingMetaDataSection(DataSegments, DataSize, SymbolFlags,
1312*63ebb813SSam Clegg                               HasStackPointer, StackPointerGlobal);
1313970d02c4SDan Gohman 
1314d934cb88SDan Gohman   // TODO: Translate the .comment section to the output.
1315d934cb88SDan Gohman   // TODO: Translate debug sections to the output.
131618eafb6cSDan Gohman }
131718eafb6cSDan Gohman 
131818eafb6cSDan Gohman MCObjectWriter *llvm::createWasmObjectWriter(MCWasmObjectTargetWriter *MOTW,
131918eafb6cSDan Gohman                                              raw_pwrite_stream &OS) {
132018eafb6cSDan Gohman   return new WasmObjectWriter(MOTW, OS);
132118eafb6cSDan Gohman }
1322