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;
10763ebb813SSam Clegg   uint32_t Alignment;
10863ebb813SSam 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;
11832ce5ca0SDan Gohman   bool IsMutable;
1199e15f359SSam Clegg };
1209e15f359SSam Clegg 
1219e15f359SSam Clegg // A wasm function to be written into the function section.
1229e15f359SSam Clegg struct WasmFunction {
1239e15f359SSam Clegg   int32_t Type;
1249e15f359SSam Clegg   const MCSymbolWasm *Sym;
1259e15f359SSam Clegg };
1269e15f359SSam Clegg 
1279e15f359SSam Clegg // A wasm export to be written into the export section.
1289e15f359SSam Clegg struct WasmExport {
1299e15f359SSam Clegg   StringRef FieldName;
1309e15f359SSam Clegg   unsigned Kind;
1319e15f359SSam Clegg   uint32_t Index;
1329e15f359SSam Clegg };
1339e15f359SSam Clegg 
1349e15f359SSam Clegg // A wasm global to be written into the global section.
1359e15f359SSam Clegg struct WasmGlobal {
1369e15f359SSam Clegg   wasm::ValType Type;
1379e15f359SSam Clegg   bool IsMutable;
1389e15f359SSam Clegg   bool HasImport;
1399e15f359SSam Clegg   uint64_t InitialValue;
1409e15f359SSam Clegg   uint32_t ImportIndex;
1419e15f359SSam Clegg };
1429e15f359SSam Clegg 
1436dc65e91SSam Clegg // Information about a single relocation.
1446dc65e91SSam Clegg struct WasmRelocationEntry {
1456dc65e91SSam Clegg   uint64_t Offset;                  // Where is the relocation.
1466dc65e91SSam Clegg   const MCSymbolWasm *Symbol;       // The symbol to relocate with.
1476dc65e91SSam Clegg   int64_t Addend;                   // A value to add to the symbol.
1486dc65e91SSam Clegg   unsigned Type;                    // The type of the relocation.
149fe6414b0SSam Clegg   const MCSectionWasm *FixupSection;// The section the relocation is targeting.
1506dc65e91SSam Clegg 
1516dc65e91SSam Clegg   WasmRelocationEntry(uint64_t Offset, const MCSymbolWasm *Symbol,
1526dc65e91SSam Clegg                       int64_t Addend, unsigned Type,
153fe6414b0SSam Clegg                       const MCSectionWasm *FixupSection)
1546dc65e91SSam Clegg       : Offset(Offset), Symbol(Symbol), Addend(Addend), Type(Type),
1556dc65e91SSam Clegg         FixupSection(FixupSection) {}
1566dc65e91SSam Clegg 
157acd7d2b0SSam Clegg   bool hasAddend() const {
158acd7d2b0SSam Clegg     switch (Type) {
15913a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB:
16013a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB:
16113a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32:
162acd7d2b0SSam Clegg       return true;
163acd7d2b0SSam Clegg     default:
164acd7d2b0SSam Clegg       return false;
165acd7d2b0SSam Clegg     }
166acd7d2b0SSam Clegg   }
167acd7d2b0SSam Clegg 
1686dc65e91SSam Clegg   void print(raw_ostream &Out) const {
1699bf73c07SSam Clegg     Out << "Off=" << Offset << ", Sym=" << *Symbol << ", Addend=" << Addend
170759631c7SSam Clegg         << ", Type=" << Type
171759631c7SSam Clegg         << ", FixupSection=" << FixupSection->getSectionName();
1726dc65e91SSam Clegg   }
173b7787fd0SSam Clegg 
174615eb470SAaron Ballman #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
175b7787fd0SSam Clegg   LLVM_DUMP_METHOD void dump() const { print(dbgs()); }
176b7787fd0SSam Clegg #endif
1776dc65e91SSam Clegg };
1786dc65e91SSam Clegg 
1791fb8daa6SSam Clegg #if !defined(NDEBUG)
1807f055deeSSam Clegg raw_ostream &operator<<(raw_ostream &OS, const WasmRelocationEntry &Rel) {
181b7787fd0SSam Clegg   Rel.print(OS);
182b7787fd0SSam Clegg   return OS;
183b7787fd0SSam Clegg }
1841fb8daa6SSam Clegg #endif
185b7787fd0SSam Clegg 
18618eafb6cSDan Gohman class WasmObjectWriter : public MCObjectWriter {
18718eafb6cSDan Gohman   /// Helper struct for containing some precomputed information on symbols.
18818eafb6cSDan Gohman   struct WasmSymbolData {
18918eafb6cSDan Gohman     const MCSymbolWasm *Symbol;
19018eafb6cSDan Gohman     StringRef Name;
19118eafb6cSDan Gohman 
19218eafb6cSDan Gohman     // Support lexicographic sorting.
19318eafb6cSDan Gohman     bool operator<(const WasmSymbolData &RHS) const { return Name < RHS.Name; }
19418eafb6cSDan Gohman   };
19518eafb6cSDan Gohman 
19618eafb6cSDan Gohman   /// The target specific Wasm writer instance.
19718eafb6cSDan Gohman   std::unique_ptr<MCWasmObjectTargetWriter> TargetObjectWriter;
19818eafb6cSDan Gohman 
199d934cb88SDan Gohman   // Relocations for fixing up references in the code section.
200d934cb88SDan Gohman   std::vector<WasmRelocationEntry> CodeRelocations;
201d934cb88SDan Gohman 
202d934cb88SDan Gohman   // Relocations for fixing up references in the data section.
203d934cb88SDan Gohman   std::vector<WasmRelocationEntry> DataRelocations;
204d934cb88SDan Gohman 
205d934cb88SDan Gohman   // Index values to use for fixing up call_indirect type indices.
206acd7d2b0SSam Clegg   // Maps function symbols to the index of the type of the function
207acd7d2b0SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> TypeIndices;
208d99f6078SSam Clegg   // Maps function symbols to the table element index space. Used
209d99f6078SSam Clegg   // for TABLE_INDEX relocation types (i.e. address taken functions).
210d99f6078SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> IndirectSymbolIndices;
211d99f6078SSam Clegg   // Maps function/global symbols to the function/global index space.
212acd7d2b0SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> SymbolIndices;
213acd7d2b0SSam Clegg 
214acd7d2b0SSam Clegg   DenseMap<WasmFunctionType, int32_t, WasmFunctionTypeDenseMapInfo>
215acd7d2b0SSam Clegg       FunctionTypeIndices;
2165e3d33a7SSam Clegg   SmallVector<WasmFunctionType, 4> FunctionTypes;
2177c395943SSam Clegg   SmallVector<WasmGlobal, 4> Globals;
2187c395943SSam Clegg   unsigned NumGlobalImports = 0;
219d934cb88SDan Gohman 
22018eafb6cSDan Gohman   // TargetObjectWriter wrappers.
22118eafb6cSDan Gohman   bool is64Bit() const { return TargetObjectWriter->is64Bit(); }
222ae03c1e7SSam Clegg   unsigned getRelocType(const MCValue &Target, const MCFixup &Fixup) const {
223ae03c1e7SSam Clegg     return TargetObjectWriter->getRelocType(Target, Fixup);
22418eafb6cSDan Gohman   }
22518eafb6cSDan Gohman 
226d934cb88SDan Gohman   void startSection(SectionBookkeeping &Section, unsigned SectionId,
227d934cb88SDan Gohman                     const char *Name = nullptr);
228d934cb88SDan Gohman   void endSection(SectionBookkeeping &Section);
229d934cb88SDan Gohman 
23018eafb6cSDan Gohman public:
2311301a878SLang Hames   WasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW,
2321301a878SLang Hames                    raw_pwrite_stream &OS)
2331301a878SLang Hames       : MCObjectWriter(OS, /*IsLittleEndian=*/true),
2341301a878SLang Hames         TargetObjectWriter(std::move(MOTW)) {}
23518eafb6cSDan Gohman 
236d934cb88SDan Gohman private:
23718eafb6cSDan Gohman   ~WasmObjectWriter() override;
23818eafb6cSDan Gohman 
239acd7d2b0SSam Clegg   void reset() override {
240acd7d2b0SSam Clegg     CodeRelocations.clear();
241acd7d2b0SSam Clegg     DataRelocations.clear();
242acd7d2b0SSam Clegg     TypeIndices.clear();
243acd7d2b0SSam Clegg     SymbolIndices.clear();
244d99f6078SSam Clegg     IndirectSymbolIndices.clear();
245acd7d2b0SSam Clegg     FunctionTypeIndices.clear();
2465e3d33a7SSam Clegg     FunctionTypes.clear();
2477c395943SSam Clegg     Globals.clear();
248acd7d2b0SSam Clegg     MCObjectWriter::reset();
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);
273*f950b24aSSam Clegg   void writeImportSection(ArrayRef<WasmImport> Imports, uint32_t DataSize,
274*f950b24aSSam 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);
282457fb0b4SSam Clegg   void writeNameSection(ArrayRef<WasmFunction> Functions,
283457fb0b4SSam Clegg                         ArrayRef<WasmImport> Imports,
2849e15f359SSam Clegg                         uint32_t NumFuncImports);
285acd7d2b0SSam Clegg   void writeCodeRelocSection();
2867c395943SSam Clegg   void writeDataRelocSection();
28731a2c809SSam Clegg   void writeLinkingMetaDataSection(
28831a2c809SSam Clegg       ArrayRef<WasmDataSegment> Segments, uint32_t DataSize,
289ad19047dSDan Gohman       SmallVector<std::pair<StringRef, uint32_t>, 4> SymbolFlags);
290acd7d2b0SSam Clegg 
2917c395943SSam Clegg   uint32_t getProvisionalValue(const WasmRelocationEntry &RelEntry);
292acd7d2b0SSam Clegg   void applyRelocations(ArrayRef<WasmRelocationEntry> Relocations,
293acd7d2b0SSam Clegg                         uint64_t ContentsOffset);
294acd7d2b0SSam Clegg 
2957c395943SSam Clegg   void writeRelocations(ArrayRef<WasmRelocationEntry> Relocations);
296acd7d2b0SSam Clegg   uint32_t getRelocationIndexValue(const WasmRelocationEntry &RelEntry);
2975e3d33a7SSam Clegg   uint32_t getFunctionType(const MCSymbolWasm& Symbol);
2985e3d33a7SSam Clegg   uint32_t registerFunctionType(const MCSymbolWasm& Symbol);
29918eafb6cSDan Gohman };
3009e15f359SSam Clegg 
30118eafb6cSDan Gohman } // end anonymous namespace
30218eafb6cSDan Gohman 
30318eafb6cSDan Gohman WasmObjectWriter::~WasmObjectWriter() {}
30418eafb6cSDan Gohman 
305d934cb88SDan Gohman // Write out a section header and a patchable section size field.
306d934cb88SDan Gohman void WasmObjectWriter::startSection(SectionBookkeeping &Section,
307d934cb88SDan Gohman                                     unsigned SectionId,
308d934cb88SDan Gohman                                     const char *Name) {
309d934cb88SDan Gohman   assert((Name != nullptr) == (SectionId == wasm::WASM_SEC_CUSTOM) &&
310d934cb88SDan Gohman          "Only custom sections can have names");
311d934cb88SDan Gohman 
312b7787fd0SSam Clegg   DEBUG(dbgs() << "startSection " << SectionId << ": " << Name << "\n");
313e2688c43SDerek Schuff   encodeULEB128(SectionId, getStream());
314d934cb88SDan Gohman 
315d934cb88SDan Gohman   Section.SizeOffset = getStream().tell();
316d934cb88SDan Gohman 
317d934cb88SDan Gohman   // The section size. We don't know the size yet, so reserve enough space
318d934cb88SDan Gohman   // for any 32-bit value; we'll patch it later.
319d934cb88SDan Gohman   encodeULEB128(UINT32_MAX, getStream());
320d934cb88SDan Gohman 
321d934cb88SDan Gohman   // The position where the section starts, for measuring its size.
322d934cb88SDan Gohman   Section.ContentsOffset = getStream().tell();
323d934cb88SDan Gohman 
324d934cb88SDan Gohman   // Custom sections in wasm also have a string identifier.
325d934cb88SDan Gohman   if (SectionId == wasm::WASM_SEC_CUSTOM) {
326b7787fd0SSam Clegg     assert(Name);
327b7787fd0SSam Clegg     writeString(StringRef(Name));
328d934cb88SDan Gohman   }
329d934cb88SDan Gohman }
330d934cb88SDan Gohman 
331d934cb88SDan Gohman // Now that the section is complete and we know how big it is, patch up the
332d934cb88SDan Gohman // section size field at the start of the section.
333d934cb88SDan Gohman void WasmObjectWriter::endSection(SectionBookkeeping &Section) {
334d934cb88SDan Gohman   uint64_t Size = getStream().tell() - Section.ContentsOffset;
335d934cb88SDan Gohman   if (uint32_t(Size) != Size)
336d934cb88SDan Gohman     report_fatal_error("section size does not fit in a uint32_t");
337d934cb88SDan Gohman 
338b7787fd0SSam Clegg   DEBUG(dbgs() << "endSection size=" << Size << "\n");
339d934cb88SDan Gohman 
340d934cb88SDan Gohman   // Write the final section size to the payload_len field, which follows
341d934cb88SDan Gohman   // the section id byte.
342d934cb88SDan Gohman   uint8_t Buffer[16];
34366a99e41SSam Clegg   unsigned SizeLen = encodeULEB128(Size, Buffer, 5);
344d934cb88SDan Gohman   assert(SizeLen == 5);
345d934cb88SDan Gohman   getStream().pwrite((char *)Buffer, SizeLen, Section.SizeOffset);
346d934cb88SDan Gohman }
347d934cb88SDan Gohman 
34818eafb6cSDan Gohman // Emit the Wasm header.
34918eafb6cSDan Gohman void WasmObjectWriter::writeHeader(const MCAssembler &Asm) {
3507ea5adffSDan Gohman   writeBytes(StringRef(wasm::WasmMagic, sizeof(wasm::WasmMagic)));
3517ea5adffSDan Gohman   writeLE32(wasm::WasmVersion);
35218eafb6cSDan Gohman }
35318eafb6cSDan Gohman 
35418eafb6cSDan Gohman void WasmObjectWriter::executePostLayoutBinding(MCAssembler &Asm,
35518eafb6cSDan Gohman                                                 const MCAsmLayout &Layout) {
35618eafb6cSDan Gohman }
35718eafb6cSDan Gohman 
35818eafb6cSDan Gohman void WasmObjectWriter::recordRelocation(MCAssembler &Asm,
35918eafb6cSDan Gohman                                         const MCAsmLayout &Layout,
36018eafb6cSDan Gohman                                         const MCFragment *Fragment,
36118eafb6cSDan Gohman                                         const MCFixup &Fixup, MCValue Target,
362ceecfe5bSRafael Espindola                                         uint64_t &FixedValue) {
363ceecfe5bSRafael Espindola   MCAsmBackend &Backend = Asm.getBackend();
364ceecfe5bSRafael Espindola   bool IsPCRel = Backend.getFixupKindInfo(Fixup.getKind()).Flags &
365ceecfe5bSRafael Espindola                  MCFixupKindInfo::FKF_IsPCRel;
366fe6414b0SSam Clegg   const auto &FixupSection = cast<MCSectionWasm>(*Fragment->getParent());
367d934cb88SDan Gohman   uint64_t C = Target.getConstant();
368d934cb88SDan Gohman   uint64_t FixupOffset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
369d934cb88SDan Gohman   MCContext &Ctx = Asm.getContext();
370d934cb88SDan Gohman 
371d934cb88SDan Gohman   if (const MCSymbolRefExpr *RefB = Target.getSymB()) {
372d934cb88SDan Gohman     assert(RefB->getKind() == MCSymbolRefExpr::VK_None &&
373d934cb88SDan Gohman            "Should not have constructed this");
374d934cb88SDan Gohman 
375d934cb88SDan Gohman     // Let A, B and C being the components of Target and R be the location of
376d934cb88SDan Gohman     // the fixup. If the fixup is not pcrel, we want to compute (A - B + C).
377d934cb88SDan Gohman     // If it is pcrel, we want to compute (A - B + C - R).
378d934cb88SDan Gohman 
379d934cb88SDan Gohman     // In general, Wasm has no relocations for -B. It can only represent (A + C)
380d934cb88SDan Gohman     // or (A + C - R). If B = R + K and the relocation is not pcrel, we can
381d934cb88SDan Gohman     // replace B to implement it: (A - R - K + C)
382d934cb88SDan Gohman     if (IsPCRel) {
383d934cb88SDan Gohman       Ctx.reportError(
384d934cb88SDan Gohman           Fixup.getLoc(),
385d934cb88SDan Gohman           "No relocation available to represent this relative expression");
386d934cb88SDan Gohman       return;
387d934cb88SDan Gohman     }
388d934cb88SDan Gohman 
389d934cb88SDan Gohman     const auto &SymB = cast<MCSymbolWasm>(RefB->getSymbol());
390d934cb88SDan Gohman 
391d934cb88SDan Gohman     if (SymB.isUndefined()) {
392d934cb88SDan Gohman       Ctx.reportError(Fixup.getLoc(),
393d934cb88SDan Gohman                       Twine("symbol '") + SymB.getName() +
394d934cb88SDan Gohman                           "' can not be undefined in a subtraction expression");
395d934cb88SDan Gohman       return;
396d934cb88SDan Gohman     }
397d934cb88SDan Gohman 
398d934cb88SDan Gohman     assert(!SymB.isAbsolute() && "Should have been folded");
399d934cb88SDan Gohman     const MCSection &SecB = SymB.getSection();
400d934cb88SDan Gohman     if (&SecB != &FixupSection) {
401d934cb88SDan Gohman       Ctx.reportError(Fixup.getLoc(),
402d934cb88SDan Gohman                       "Cannot represent a difference across sections");
403d934cb88SDan Gohman       return;
404d934cb88SDan Gohman     }
405d934cb88SDan Gohman 
406d934cb88SDan Gohman     uint64_t SymBOffset = Layout.getSymbolOffset(SymB);
407d934cb88SDan Gohman     uint64_t K = SymBOffset - FixupOffset;
408d934cb88SDan Gohman     IsPCRel = true;
409d934cb88SDan Gohman     C -= K;
410d934cb88SDan Gohman   }
411d934cb88SDan Gohman 
412d934cb88SDan Gohman   // We either rejected the fixup or folded B into C at this point.
413d934cb88SDan Gohman   const MCSymbolRefExpr *RefA = Target.getSymA();
414d934cb88SDan Gohman   const auto *SymA = RefA ? cast<MCSymbolWasm>(&RefA->getSymbol()) : nullptr;
415d934cb88SDan Gohman 
416d934cb88SDan Gohman   if (SymA && SymA->isVariable()) {
417d934cb88SDan Gohman     const MCExpr *Expr = SymA->getVariableValue();
4186ad8f190SSam Clegg     const auto *Inner = cast<MCSymbolRefExpr>(Expr);
4196ad8f190SSam Clegg     if (Inner->getKind() == MCSymbolRefExpr::VK_WEAKREF)
4206ad8f190SSam Clegg       llvm_unreachable("weakref used in reloc not yet implemented");
421d934cb88SDan Gohman   }
422d934cb88SDan Gohman 
423d934cb88SDan Gohman   // Put any constant offset in an addend. Offsets can be negative, and
424d934cb88SDan Gohman   // LLVM expects wrapping, in contrast to wasm's immediates which can't
425d934cb88SDan Gohman   // be negative and don't wrap.
426d934cb88SDan Gohman   FixedValue = 0;
427d934cb88SDan Gohman 
4286ad8f190SSam Clegg   if (SymA)
429d934cb88SDan Gohman     SymA->setUsedInReloc();
430d934cb88SDan Gohman 
431ae03c1e7SSam Clegg   assert(!IsPCRel);
4329d24fb7fSSam Clegg   assert(SymA);
4339d24fb7fSSam Clegg 
434ae03c1e7SSam Clegg   unsigned Type = getRelocType(Target, Fixup);
435ae03c1e7SSam Clegg 
436d934cb88SDan Gohman   WasmRelocationEntry Rec(FixupOffset, SymA, C, Type, &FixupSection);
437b7787fd0SSam Clegg   DEBUG(dbgs() << "WasmReloc: " << Rec << "\n");
438d934cb88SDan Gohman 
43912fd3da9SSam Clegg   if (FixupSection.isWasmData())
440d934cb88SDan Gohman     DataRelocations.push_back(Rec);
44112fd3da9SSam Clegg   else if (FixupSection.getKind().isText())
44212fd3da9SSam Clegg     CodeRelocations.push_back(Rec);
44312fd3da9SSam Clegg   else if (!FixupSection.getKind().isMetadata())
44412fd3da9SSam Clegg     // TODO(sbc): Add support for debug sections.
44512fd3da9SSam Clegg     llvm_unreachable("unexpected section type");
446d934cb88SDan Gohman }
447d934cb88SDan Gohman 
448d934cb88SDan Gohman // Write X as an (unsigned) LEB value at offset Offset in Stream, padded
449d934cb88SDan Gohman // to allow patching.
450d934cb88SDan Gohman static void
451d934cb88SDan Gohman WritePatchableLEB(raw_pwrite_stream &Stream, uint32_t X, uint64_t Offset) {
452d934cb88SDan Gohman   uint8_t Buffer[5];
45366a99e41SSam Clegg   unsigned SizeLen = encodeULEB128(X, Buffer, 5);
454d934cb88SDan Gohman   assert(SizeLen == 5);
455d934cb88SDan Gohman   Stream.pwrite((char *)Buffer, SizeLen, Offset);
456d934cb88SDan Gohman }
457d934cb88SDan Gohman 
458d934cb88SDan Gohman // Write X as an signed LEB value at offset Offset in Stream, padded
459d934cb88SDan Gohman // to allow patching.
460d934cb88SDan Gohman static void
461d934cb88SDan Gohman WritePatchableSLEB(raw_pwrite_stream &Stream, int32_t X, uint64_t Offset) {
462d934cb88SDan Gohman   uint8_t Buffer[5];
46366a99e41SSam Clegg   unsigned SizeLen = encodeSLEB128(X, Buffer, 5);
464d934cb88SDan Gohman   assert(SizeLen == 5);
465d934cb88SDan Gohman   Stream.pwrite((char *)Buffer, SizeLen, Offset);
466d934cb88SDan Gohman }
467d934cb88SDan Gohman 
468d934cb88SDan Gohman // Write X as a plain integer value at offset Offset in Stream.
469d934cb88SDan Gohman static void WriteI32(raw_pwrite_stream &Stream, uint32_t X, uint64_t Offset) {
470d934cb88SDan Gohman   uint8_t Buffer[4];
471d934cb88SDan Gohman   support::endian::write32le(Buffer, X);
472d934cb88SDan Gohman   Stream.pwrite((char *)Buffer, sizeof(Buffer), Offset);
473d934cb88SDan Gohman }
474d934cb88SDan Gohman 
475aff1c4dfSSam Clegg static const MCSymbolWasm* ResolveSymbol(const MCSymbolWasm& Symbol) {
476aff1c4dfSSam Clegg   if (Symbol.isVariable()) {
477aff1c4dfSSam Clegg     const MCExpr *Expr = Symbol.getVariableValue();
478aff1c4dfSSam Clegg     auto *Inner = cast<MCSymbolRefExpr>(Expr);
479aff1c4dfSSam Clegg     return cast<MCSymbolWasm>(&Inner->getSymbol());
480aff1c4dfSSam Clegg   }
481aff1c4dfSSam Clegg   return &Symbol;
482aff1c4dfSSam Clegg }
483aff1c4dfSSam Clegg 
484d934cb88SDan Gohman // Compute a value to write into the code at the location covered
485d934cb88SDan Gohman // by RelEntry. This value isn't used by the static linker, since
486d934cb88SDan Gohman // we have addends; it just serves to make the code more readable
487d934cb88SDan Gohman // and to make standalone wasm modules directly usable.
4887c395943SSam Clegg uint32_t
4897c395943SSam Clegg WasmObjectWriter::getProvisionalValue(const WasmRelocationEntry &RelEntry) {
490aff1c4dfSSam Clegg   const MCSymbolWasm *Sym = ResolveSymbol(*RelEntry.Symbol);
491d934cb88SDan Gohman 
492d934cb88SDan Gohman   // For undefined symbols, use a hopefully invalid value.
493b7787fd0SSam Clegg   if (!Sym->isDefined(/*SetUsed=*/false))
494d934cb88SDan Gohman     return UINT32_MAX;
495d934cb88SDan Gohman 
4967c395943SSam Clegg   uint32_t GlobalIndex = SymbolIndices[Sym];
4977c395943SSam Clegg   const WasmGlobal& Global = Globals[GlobalIndex - NumGlobalImports];
4987c395943SSam Clegg   uint64_t Address = Global.InitialValue + RelEntry.Addend;
499d934cb88SDan Gohman 
500d934cb88SDan Gohman   // Ignore overflow. LLVM allows address arithmetic to silently wrap.
501d934cb88SDan Gohman   uint32_t Value = Address;
502d934cb88SDan Gohman 
503d934cb88SDan Gohman   return Value;
504d934cb88SDan Gohman }
505d934cb88SDan Gohman 
506759631c7SSam Clegg static void addData(SmallVectorImpl<char> &DataBytes,
50763ebb813SSam Clegg                     MCSectionWasm &DataSection) {
508759631c7SSam Clegg   DEBUG(errs() << "addData: " << DataSection.getSectionName() << "\n");
509759631c7SSam Clegg 
51063ebb813SSam Clegg   DataBytes.resize(alignTo(DataBytes.size(), DataSection.getAlignment()));
51163ebb813SSam Clegg 
512c55d13f4SSam Clegg   size_t LastFragmentSize = 0;
513759631c7SSam Clegg   for (const MCFragment &Frag : DataSection) {
514759631c7SSam Clegg     if (Frag.hasInstructions())
515759631c7SSam Clegg       report_fatal_error("only data supported in data sections");
516759631c7SSam Clegg 
517759631c7SSam Clegg     if (auto *Align = dyn_cast<MCAlignFragment>(&Frag)) {
518759631c7SSam Clegg       if (Align->getValueSize() != 1)
519759631c7SSam Clegg         report_fatal_error("only byte values supported for alignment");
520759631c7SSam Clegg       // If nops are requested, use zeros, as this is the data section.
521759631c7SSam Clegg       uint8_t Value = Align->hasEmitNops() ? 0 : Align->getValue();
522759631c7SSam Clegg       uint64_t Size = std::min<uint64_t>(alignTo(DataBytes.size(),
523759631c7SSam Clegg                                                  Align->getAlignment()),
524759631c7SSam Clegg                                          DataBytes.size() +
525759631c7SSam Clegg                                              Align->getMaxBytesToEmit());
526759631c7SSam Clegg       DataBytes.resize(Size, Value);
527759631c7SSam Clegg     } else if (auto *Fill = dyn_cast<MCFillFragment>(&Frag)) {
528759631c7SSam Clegg       DataBytes.insert(DataBytes.end(), Fill->getSize(), Fill->getValue());
529759631c7SSam Clegg     } else {
530759631c7SSam Clegg       const auto &DataFrag = cast<MCDataFragment>(Frag);
531759631c7SSam Clegg       const SmallVectorImpl<char> &Contents = DataFrag.getContents();
532759631c7SSam Clegg 
533759631c7SSam Clegg       DataBytes.insert(DataBytes.end(), Contents.begin(), Contents.end());
534c55d13f4SSam Clegg       LastFragmentSize = Contents.size();
535759631c7SSam Clegg     }
536759631c7SSam Clegg   }
537759631c7SSam Clegg 
538c55d13f4SSam Clegg   // Don't allow empty segments, or segments that end with zero-sized
539c55d13f4SSam Clegg   // fragment, otherwise the linker cannot map symbols to a unique
540c55d13f4SSam Clegg   // data segment.  This can be triggered by zero-sized structs
541c55d13f4SSam Clegg   // See: test/MC/WebAssembly/bss.ll
542c55d13f4SSam Clegg   if (LastFragmentSize == 0)
543c55d13f4SSam Clegg     DataBytes.resize(DataBytes.size() + 1);
544759631c7SSam Clegg   DEBUG(dbgs() << "addData -> " << DataBytes.size() << "\n");
545759631c7SSam Clegg }
546759631c7SSam Clegg 
547acd7d2b0SSam Clegg uint32_t WasmObjectWriter::getRelocationIndexValue(
548acd7d2b0SSam Clegg     const WasmRelocationEntry &RelEntry) {
549acd7d2b0SSam Clegg   switch (RelEntry.Type) {
550acd7d2b0SSam Clegg   case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB:
551acd7d2b0SSam Clegg   case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32:
552b7787fd0SSam Clegg     if (!IndirectSymbolIndices.count(RelEntry.Symbol))
553b7787fd0SSam Clegg       report_fatal_error("symbol not found table index space: " +
554b7787fd0SSam Clegg                          RelEntry.Symbol->getName());
555d99f6078SSam Clegg     return IndirectSymbolIndices[RelEntry.Symbol];
556d99f6078SSam Clegg   case wasm::R_WEBASSEMBLY_FUNCTION_INDEX_LEB:
5579d24fb7fSSam Clegg   case wasm::R_WEBASSEMBLY_GLOBAL_INDEX_LEB:
55813a2e899SSam Clegg   case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB:
55913a2e899SSam Clegg   case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB:
56013a2e899SSam Clegg   case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32:
561b7787fd0SSam Clegg     if (!SymbolIndices.count(RelEntry.Symbol))
562b7787fd0SSam Clegg       report_fatal_error("symbol not found function/global index space: " +
563b7787fd0SSam Clegg                          RelEntry.Symbol->getName());
564acd7d2b0SSam Clegg     return SymbolIndices[RelEntry.Symbol];
565acd7d2b0SSam Clegg   case wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB:
566b7787fd0SSam Clegg     if (!TypeIndices.count(RelEntry.Symbol))
567b7787fd0SSam Clegg       report_fatal_error("symbol not found in type index space: " +
568b7787fd0SSam Clegg                          RelEntry.Symbol->getName());
569acd7d2b0SSam Clegg     return TypeIndices[RelEntry.Symbol];
570acd7d2b0SSam Clegg   default:
571acd7d2b0SSam Clegg     llvm_unreachable("invalid relocation type");
572acd7d2b0SSam Clegg   }
573acd7d2b0SSam Clegg }
574acd7d2b0SSam Clegg 
575d934cb88SDan Gohman // Apply the portions of the relocation records that we can handle ourselves
576d934cb88SDan Gohman // directly.
577acd7d2b0SSam Clegg void WasmObjectWriter::applyRelocations(
578acd7d2b0SSam Clegg     ArrayRef<WasmRelocationEntry> Relocations, uint64_t ContentsOffset) {
579acd7d2b0SSam Clegg   raw_pwrite_stream &Stream = getStream();
580d934cb88SDan Gohman   for (const WasmRelocationEntry &RelEntry : Relocations) {
581d934cb88SDan Gohman     uint64_t Offset = ContentsOffset +
582d934cb88SDan Gohman                       RelEntry.FixupSection->getSectionOffset() +
583d934cb88SDan Gohman                       RelEntry.Offset;
584d934cb88SDan Gohman 
585b7787fd0SSam Clegg     DEBUG(dbgs() << "applyRelocation: " << RelEntry << "\n");
586acd7d2b0SSam Clegg     switch (RelEntry.Type) {
587acd7d2b0SSam Clegg     case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB:
588acd7d2b0SSam Clegg     case wasm::R_WEBASSEMBLY_FUNCTION_INDEX_LEB:
5899d24fb7fSSam Clegg     case wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB:
5909d24fb7fSSam Clegg     case wasm::R_WEBASSEMBLY_GLOBAL_INDEX_LEB: {
591acd7d2b0SSam Clegg       uint32_t Index = getRelocationIndexValue(RelEntry);
592acd7d2b0SSam Clegg       WritePatchableSLEB(Stream, Index, Offset);
593d934cb88SDan Gohman       break;
594d934cb88SDan Gohman     }
595acd7d2b0SSam Clegg     case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32: {
596acd7d2b0SSam Clegg       uint32_t Index = getRelocationIndexValue(RelEntry);
597acd7d2b0SSam Clegg       WriteI32(Stream, Index, Offset);
598d934cb88SDan Gohman       break;
599d934cb88SDan Gohman     }
60013a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB: {
6017c395943SSam Clegg       uint32_t Value = getProvisionalValue(RelEntry);
602d934cb88SDan Gohman       WritePatchableSLEB(Stream, Value, Offset);
603d934cb88SDan Gohman       break;
604d934cb88SDan Gohman     }
60513a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB: {
6067c395943SSam Clegg       uint32_t Value = getProvisionalValue(RelEntry);
607d934cb88SDan Gohman       WritePatchableLEB(Stream, Value, Offset);
608d934cb88SDan Gohman       break;
609d934cb88SDan Gohman     }
61013a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32: {
6117c395943SSam Clegg       uint32_t Value = getProvisionalValue(RelEntry);
612d934cb88SDan Gohman       WriteI32(Stream, Value, Offset);
613d934cb88SDan Gohman       break;
614d934cb88SDan Gohman     }
615d934cb88SDan Gohman     default:
6169d24fb7fSSam Clegg       llvm_unreachable("invalid relocation type");
617d934cb88SDan Gohman     }
618d934cb88SDan Gohman   }
61918eafb6cSDan Gohman }
62018eafb6cSDan Gohman 
621acd7d2b0SSam Clegg // Write out the portions of the relocation records that the linker will
622970d02c4SDan Gohman // need to handle.
623acd7d2b0SSam Clegg void WasmObjectWriter::writeRelocations(
6247c395943SSam Clegg     ArrayRef<WasmRelocationEntry> Relocations) {
625acd7d2b0SSam Clegg   raw_pwrite_stream &Stream = getStream();
626acd7d2b0SSam Clegg   for (const WasmRelocationEntry& RelEntry : Relocations) {
627970d02c4SDan Gohman 
628acd7d2b0SSam Clegg     uint64_t Offset = RelEntry.Offset +
6297c395943SSam Clegg                       RelEntry.FixupSection->getSectionOffset();
630acd7d2b0SSam Clegg     uint32_t Index = getRelocationIndexValue(RelEntry);
631970d02c4SDan Gohman 
632acd7d2b0SSam Clegg     encodeULEB128(RelEntry.Type, Stream);
633970d02c4SDan Gohman     encodeULEB128(Offset, Stream);
634acd7d2b0SSam Clegg     encodeULEB128(Index, Stream);
635acd7d2b0SSam Clegg     if (RelEntry.hasAddend())
636acd7d2b0SSam Clegg       encodeSLEB128(RelEntry.Addend, Stream);
637970d02c4SDan Gohman   }
638970d02c4SDan Gohman }
639970d02c4SDan Gohman 
6409e15f359SSam Clegg void WasmObjectWriter::writeTypeSection(
641457fb0b4SSam Clegg     ArrayRef<WasmFunctionType> FunctionTypes) {
6429e15f359SSam Clegg   if (FunctionTypes.empty())
6439e15f359SSam Clegg     return;
6449e15f359SSam Clegg 
6459e15f359SSam Clegg   SectionBookkeeping Section;
6469e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_TYPE);
6479e15f359SSam Clegg 
6489e15f359SSam Clegg   encodeULEB128(FunctionTypes.size(), getStream());
6499e15f359SSam Clegg 
6509e15f359SSam Clegg   for (const WasmFunctionType &FuncTy : FunctionTypes) {
6519e15f359SSam Clegg     encodeSLEB128(wasm::WASM_TYPE_FUNC, getStream());
6529e15f359SSam Clegg     encodeULEB128(FuncTy.Params.size(), getStream());
6539e15f359SSam Clegg     for (wasm::ValType Ty : FuncTy.Params)
6549e15f359SSam Clegg       writeValueType(Ty);
6559e15f359SSam Clegg     encodeULEB128(FuncTy.Returns.size(), getStream());
6569e15f359SSam Clegg     for (wasm::ValType Ty : FuncTy.Returns)
6579e15f359SSam Clegg       writeValueType(Ty);
6589e15f359SSam Clegg   }
6599e15f359SSam Clegg 
6609e15f359SSam Clegg   endSection(Section);
6619e15f359SSam Clegg }
6629e15f359SSam Clegg 
663*f950b24aSSam Clegg void WasmObjectWriter::writeImportSection(ArrayRef<WasmImport> Imports,
664*f950b24aSSam Clegg                                           uint32_t DataSize,
665*f950b24aSSam Clegg                                           uint32_t NumElements) {
6669e15f359SSam Clegg   if (Imports.empty())
6679e15f359SSam Clegg     return;
6689e15f359SSam Clegg 
669*f950b24aSSam Clegg   uint32_t NumPages = (DataSize + wasm::WasmPageSize - 1) / wasm::WasmPageSize;
670*f950b24aSSam Clegg 
6719e15f359SSam Clegg   SectionBookkeeping Section;
6729e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_IMPORT);
6739e15f359SSam Clegg 
6749e15f359SSam Clegg   encodeULEB128(Imports.size(), getStream());
6759e15f359SSam Clegg   for (const WasmImport &Import : Imports) {
676b7787fd0SSam Clegg     writeString(Import.ModuleName);
677b7787fd0SSam Clegg     writeString(Import.FieldName);
6789e15f359SSam Clegg 
6799e15f359SSam Clegg     encodeULEB128(Import.Kind, getStream());
6809e15f359SSam Clegg 
6819e15f359SSam Clegg     switch (Import.Kind) {
6829e15f359SSam Clegg     case wasm::WASM_EXTERNAL_FUNCTION:
6839e15f359SSam Clegg       encodeULEB128(Import.Type, getStream());
6849e15f359SSam Clegg       break;
6859e15f359SSam Clegg     case wasm::WASM_EXTERNAL_GLOBAL:
6869e15f359SSam Clegg       encodeSLEB128(int32_t(Import.Type), getStream());
68732ce5ca0SDan Gohman       encodeULEB128(int32_t(Import.IsMutable), getStream());
6889e15f359SSam Clegg       break;
689*f950b24aSSam Clegg     case wasm::WASM_EXTERNAL_MEMORY:
690*f950b24aSSam Clegg       encodeULEB128(0, getStream()); // flags
691*f950b24aSSam Clegg       encodeULEB128(NumPages, getStream()); // initial
692*f950b24aSSam Clegg       break;
693*f950b24aSSam Clegg     case wasm::WASM_EXTERNAL_TABLE:
694*f950b24aSSam Clegg       encodeSLEB128(int32_t(Import.Type), getStream());
695*f950b24aSSam Clegg       encodeULEB128(0, getStream()); // flags
696*f950b24aSSam Clegg       encodeULEB128(NumElements, getStream()); // initial
697*f950b24aSSam Clegg       break;
6989e15f359SSam Clegg     default:
6999e15f359SSam Clegg       llvm_unreachable("unsupported import kind");
7009e15f359SSam Clegg     }
7019e15f359SSam Clegg   }
7029e15f359SSam Clegg 
7039e15f359SSam Clegg   endSection(Section);
7049e15f359SSam Clegg }
7059e15f359SSam Clegg 
706457fb0b4SSam Clegg void WasmObjectWriter::writeFunctionSection(ArrayRef<WasmFunction> Functions) {
7079e15f359SSam Clegg   if (Functions.empty())
7089e15f359SSam Clegg     return;
7099e15f359SSam Clegg 
7109e15f359SSam Clegg   SectionBookkeeping Section;
7119e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_FUNCTION);
7129e15f359SSam Clegg 
7139e15f359SSam Clegg   encodeULEB128(Functions.size(), getStream());
7149e15f359SSam Clegg   for (const WasmFunction &Func : Functions)
7159e15f359SSam Clegg     encodeULEB128(Func.Type, getStream());
7169e15f359SSam Clegg 
7179e15f359SSam Clegg   endSection(Section);
7189e15f359SSam Clegg }
7199e15f359SSam Clegg 
7207c395943SSam Clegg void WasmObjectWriter::writeGlobalSection() {
7219e15f359SSam Clegg   if (Globals.empty())
7229e15f359SSam Clegg     return;
7239e15f359SSam Clegg 
7249e15f359SSam Clegg   SectionBookkeeping Section;
7259e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_GLOBAL);
7269e15f359SSam Clegg 
7279e15f359SSam Clegg   encodeULEB128(Globals.size(), getStream());
7289e15f359SSam Clegg   for (const WasmGlobal &Global : Globals) {
7299e15f359SSam Clegg     writeValueType(Global.Type);
7309e15f359SSam Clegg     write8(Global.IsMutable);
7319e15f359SSam Clegg 
7329e15f359SSam Clegg     if (Global.HasImport) {
7339e15f359SSam Clegg       assert(Global.InitialValue == 0);
7349e15f359SSam Clegg       write8(wasm::WASM_OPCODE_GET_GLOBAL);
7359e15f359SSam Clegg       encodeULEB128(Global.ImportIndex, getStream());
7369e15f359SSam Clegg     } else {
7379e15f359SSam Clegg       assert(Global.ImportIndex == 0);
7389e15f359SSam Clegg       write8(wasm::WASM_OPCODE_I32_CONST);
7399e15f359SSam Clegg       encodeSLEB128(Global.InitialValue, getStream()); // offset
7409e15f359SSam Clegg     }
7419e15f359SSam Clegg     write8(wasm::WASM_OPCODE_END);
7429e15f359SSam Clegg   }
7439e15f359SSam Clegg 
7449e15f359SSam Clegg   endSection(Section);
7459e15f359SSam Clegg }
7469e15f359SSam Clegg 
747457fb0b4SSam Clegg void WasmObjectWriter::writeExportSection(ArrayRef<WasmExport> Exports) {
7489e15f359SSam Clegg   if (Exports.empty())
7499e15f359SSam Clegg     return;
7509e15f359SSam Clegg 
7519e15f359SSam Clegg   SectionBookkeeping Section;
7529e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_EXPORT);
7539e15f359SSam Clegg 
7549e15f359SSam Clegg   encodeULEB128(Exports.size(), getStream());
7559e15f359SSam Clegg   for (const WasmExport &Export : Exports) {
756b7787fd0SSam Clegg     writeString(Export.FieldName);
7579e15f359SSam Clegg     encodeSLEB128(Export.Kind, getStream());
7589e15f359SSam Clegg     encodeULEB128(Export.Index, getStream());
7599e15f359SSam Clegg   }
7609e15f359SSam Clegg 
7619e15f359SSam Clegg   endSection(Section);
7629e15f359SSam Clegg }
7639e15f359SSam Clegg 
764457fb0b4SSam Clegg void WasmObjectWriter::writeElemSection(ArrayRef<uint32_t> TableElems) {
7659e15f359SSam Clegg   if (TableElems.empty())
7669e15f359SSam Clegg     return;
7679e15f359SSam Clegg 
7689e15f359SSam Clegg   SectionBookkeeping Section;
7699e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_ELEM);
7709e15f359SSam Clegg 
7719e15f359SSam Clegg   encodeULEB128(1, getStream()); // number of "segments"
7729e15f359SSam Clegg   encodeULEB128(0, getStream()); // the table index
7739e15f359SSam Clegg 
7749e15f359SSam Clegg   // init expr for starting offset
7759e15f359SSam Clegg   write8(wasm::WASM_OPCODE_I32_CONST);
7769e15f359SSam Clegg   encodeSLEB128(0, getStream());
7779e15f359SSam Clegg   write8(wasm::WASM_OPCODE_END);
7789e15f359SSam Clegg 
7799e15f359SSam Clegg   encodeULEB128(TableElems.size(), getStream());
7809e15f359SSam Clegg   for (uint32_t Elem : TableElems)
7819e15f359SSam Clegg     encodeULEB128(Elem, getStream());
7829e15f359SSam Clegg 
7839e15f359SSam Clegg   endSection(Section);
7849e15f359SSam Clegg }
7859e15f359SSam Clegg 
786457fb0b4SSam Clegg void WasmObjectWriter::writeCodeSection(const MCAssembler &Asm,
787457fb0b4SSam Clegg                                         const MCAsmLayout &Layout,
788457fb0b4SSam Clegg                                         ArrayRef<WasmFunction> Functions) {
7899e15f359SSam Clegg   if (Functions.empty())
7909e15f359SSam Clegg     return;
7919e15f359SSam Clegg 
7929e15f359SSam Clegg   SectionBookkeeping Section;
7939e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CODE);
7949e15f359SSam Clegg 
7959e15f359SSam Clegg   encodeULEB128(Functions.size(), getStream());
7969e15f359SSam Clegg 
7979e15f359SSam Clegg   for (const WasmFunction &Func : Functions) {
798fe6414b0SSam Clegg     auto &FuncSection = static_cast<MCSectionWasm &>(Func.Sym->getSection());
7999e15f359SSam Clegg 
8009e15f359SSam Clegg     int64_t Size = 0;
8019e15f359SSam Clegg     if (!Func.Sym->getSize()->evaluateAsAbsolute(Size, Layout))
8029e15f359SSam Clegg       report_fatal_error(".size expression must be evaluatable");
8039e15f359SSam Clegg 
8049e15f359SSam Clegg     encodeULEB128(Size, getStream());
805fe6414b0SSam Clegg     FuncSection.setSectionOffset(getStream().tell() - Section.ContentsOffset);
8069e15f359SSam Clegg     Asm.writeSectionData(&FuncSection, Layout);
8079e15f359SSam Clegg   }
8089e15f359SSam Clegg 
8099e15f359SSam Clegg   // Apply fixups.
810acd7d2b0SSam Clegg   applyRelocations(CodeRelocations, Section.ContentsOffset);
8119e15f359SSam Clegg 
8129e15f359SSam Clegg   endSection(Section);
8139e15f359SSam Clegg }
8149e15f359SSam Clegg 
815457fb0b4SSam Clegg void WasmObjectWriter::writeDataSection(ArrayRef<WasmDataSegment> Segments) {
8167c395943SSam Clegg   if (Segments.empty())
8177c395943SSam Clegg     return;
8189e15f359SSam Clegg 
8199e15f359SSam Clegg   SectionBookkeeping Section;
8209e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_DATA);
8219e15f359SSam Clegg 
8227c395943SSam Clegg   encodeULEB128(Segments.size(), getStream()); // count
8237c395943SSam Clegg 
8247c395943SSam Clegg   for (const WasmDataSegment & Segment : Segments) {
8259e15f359SSam Clegg     encodeULEB128(0, getStream()); // memory index
8269e15f359SSam Clegg     write8(wasm::WASM_OPCODE_I32_CONST);
8277c395943SSam Clegg     encodeSLEB128(Segment.Offset, getStream()); // offset
8289e15f359SSam Clegg     write8(wasm::WASM_OPCODE_END);
8297c395943SSam Clegg     encodeULEB128(Segment.Data.size(), getStream()); // size
8307c395943SSam Clegg     Segment.Section->setSectionOffset(getStream().tell() - Section.ContentsOffset);
8317c395943SSam Clegg     writeBytes(Segment.Data); // data
8327c395943SSam Clegg   }
8339e15f359SSam Clegg 
8349e15f359SSam Clegg   // Apply fixups.
8357c395943SSam Clegg   applyRelocations(DataRelocations, Section.ContentsOffset);
8369e15f359SSam Clegg 
8379e15f359SSam Clegg   endSection(Section);
8389e15f359SSam Clegg }
8399e15f359SSam Clegg 
8409e15f359SSam Clegg void WasmObjectWriter::writeNameSection(
841457fb0b4SSam Clegg     ArrayRef<WasmFunction> Functions,
842457fb0b4SSam Clegg     ArrayRef<WasmImport> Imports,
8439e15f359SSam Clegg     unsigned NumFuncImports) {
8449e15f359SSam Clegg   uint32_t TotalFunctions = NumFuncImports + Functions.size();
8459e15f359SSam Clegg   if (TotalFunctions == 0)
8469e15f359SSam Clegg     return;
8479e15f359SSam Clegg 
8489e15f359SSam Clegg   SectionBookkeeping Section;
8499e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CUSTOM, "name");
8509e15f359SSam Clegg   SectionBookkeeping SubSection;
8519e15f359SSam Clegg   startSection(SubSection, wasm::WASM_NAMES_FUNCTION);
8529e15f359SSam Clegg 
8539e15f359SSam Clegg   encodeULEB128(TotalFunctions, getStream());
8549e15f359SSam Clegg   uint32_t Index = 0;
8559e15f359SSam Clegg   for (const WasmImport &Import : Imports) {
8569e15f359SSam Clegg     if (Import.Kind == wasm::WASM_EXTERNAL_FUNCTION) {
8579e15f359SSam Clegg       encodeULEB128(Index, getStream());
858b7787fd0SSam Clegg       writeString(Import.FieldName);
8599e15f359SSam Clegg       ++Index;
8609e15f359SSam Clegg     }
8619e15f359SSam Clegg   }
8629e15f359SSam Clegg   for (const WasmFunction &Func : Functions) {
8639e15f359SSam Clegg     encodeULEB128(Index, getStream());
864b7787fd0SSam Clegg     writeString(Func.Sym->getName());
8659e15f359SSam Clegg     ++Index;
8669e15f359SSam Clegg   }
8679e15f359SSam Clegg 
8689e15f359SSam Clegg   endSection(SubSection);
8699e15f359SSam Clegg   endSection(Section);
8709e15f359SSam Clegg }
8719e15f359SSam Clegg 
872acd7d2b0SSam Clegg void WasmObjectWriter::writeCodeRelocSection() {
8739e15f359SSam Clegg   // See: https://github.com/WebAssembly/tool-conventions/blob/master/Linking.md
8749e15f359SSam Clegg   // for descriptions of the reloc sections.
8759e15f359SSam Clegg 
8769e15f359SSam Clegg   if (CodeRelocations.empty())
8779e15f359SSam Clegg     return;
8789e15f359SSam Clegg 
8799e15f359SSam Clegg   SectionBookkeeping Section;
8809e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CUSTOM, "reloc.CODE");
8819e15f359SSam Clegg 
8829e15f359SSam Clegg   encodeULEB128(wasm::WASM_SEC_CODE, getStream());
883acd7d2b0SSam Clegg   encodeULEB128(CodeRelocations.size(), getStream());
8849e15f359SSam Clegg 
8857c395943SSam Clegg   writeRelocations(CodeRelocations);
8869e15f359SSam Clegg 
8879e15f359SSam Clegg   endSection(Section);
8889e15f359SSam Clegg }
8899e15f359SSam Clegg 
8907c395943SSam Clegg void WasmObjectWriter::writeDataRelocSection() {
8919e15f359SSam Clegg   // See: https://github.com/WebAssembly/tool-conventions/blob/master/Linking.md
8929e15f359SSam Clegg   // for descriptions of the reloc sections.
8939e15f359SSam Clegg 
8949e15f359SSam Clegg   if (DataRelocations.empty())
8959e15f359SSam Clegg     return;
8969e15f359SSam Clegg 
8979e15f359SSam Clegg   SectionBookkeeping Section;
8989e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CUSTOM, "reloc.DATA");
8999e15f359SSam Clegg 
9009e15f359SSam Clegg   encodeULEB128(wasm::WASM_SEC_DATA, getStream());
9019e15f359SSam Clegg   encodeULEB128(DataRelocations.size(), getStream());
9029e15f359SSam Clegg 
9037c395943SSam Clegg   writeRelocations(DataRelocations);
9049e15f359SSam Clegg 
9059e15f359SSam Clegg   endSection(Section);
9069e15f359SSam Clegg }
9079e15f359SSam Clegg 
9089e15f359SSam Clegg void WasmObjectWriter::writeLinkingMetaDataSection(
909d95ed959SSam Clegg     ArrayRef<WasmDataSegment> Segments, uint32_t DataSize,
910ad19047dSDan Gohman     SmallVector<std::pair<StringRef, uint32_t>, 4> SymbolFlags) {
9119e15f359SSam Clegg   SectionBookkeeping Section;
9129e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CUSTOM, "linking");
913b7787fd0SSam Clegg   SectionBookkeeping SubSection;
9149e15f359SSam Clegg 
91531a2c809SSam Clegg   if (SymbolFlags.size() != 0) {
916b7787fd0SSam Clegg     startSection(SubSection, wasm::WASM_SYMBOL_INFO);
91731a2c809SSam Clegg     encodeULEB128(SymbolFlags.size(), getStream());
91831a2c809SSam Clegg     for (auto Pair: SymbolFlags) {
91931a2c809SSam Clegg       writeString(Pair.first);
92031a2c809SSam Clegg       encodeULEB128(Pair.second, getStream());
921b7787fd0SSam Clegg     }
922b7787fd0SSam Clegg     endSection(SubSection);
923b7787fd0SSam Clegg   }
9249e15f359SSam Clegg 
9259e1ade93SSam Clegg   if (DataSize > 0) {
9269e1ade93SSam Clegg     startSection(SubSection, wasm::WASM_DATA_SIZE);
9279e1ade93SSam Clegg     encodeULEB128(DataSize, getStream());
9289e1ade93SSam Clegg     endSection(SubSection);
9299e1ade93SSam Clegg   }
9309e1ade93SSam Clegg 
931d95ed959SSam Clegg   if (Segments.size()) {
93263ebb813SSam Clegg     startSection(SubSection, wasm::WASM_SEGMENT_INFO);
933d95ed959SSam Clegg     encodeULEB128(Segments.size(), getStream());
93463ebb813SSam Clegg     for (const WasmDataSegment &Segment : Segments) {
935d95ed959SSam Clegg       writeString(Segment.Name);
93663ebb813SSam Clegg       encodeULEB128(Segment.Alignment, getStream());
93763ebb813SSam Clegg       encodeULEB128(Segment.Flags, getStream());
93863ebb813SSam Clegg     }
939d95ed959SSam Clegg     endSection(SubSection);
940d95ed959SSam Clegg   }
941d95ed959SSam Clegg 
9429e15f359SSam Clegg   endSection(Section);
9439e15f359SSam Clegg }
9449e15f359SSam Clegg 
9455e3d33a7SSam Clegg uint32_t WasmObjectWriter::getFunctionType(const MCSymbolWasm& Symbol) {
9465e3d33a7SSam Clegg   assert(Symbol.isFunction());
9475e3d33a7SSam Clegg   assert(TypeIndices.count(&Symbol));
9485e3d33a7SSam Clegg   return TypeIndices[&Symbol];
9495e3d33a7SSam Clegg }
9505e3d33a7SSam Clegg 
9515e3d33a7SSam Clegg uint32_t WasmObjectWriter::registerFunctionType(const MCSymbolWasm& Symbol) {
9525e3d33a7SSam Clegg   assert(Symbol.isFunction());
9535e3d33a7SSam Clegg 
9545e3d33a7SSam Clegg   WasmFunctionType F;
955aff1c4dfSSam Clegg   const MCSymbolWasm* ResolvedSym = ResolveSymbol(Symbol);
9565e3d33a7SSam Clegg   F.Returns = ResolvedSym->getReturns();
9575e3d33a7SSam Clegg   F.Params = ResolvedSym->getParams();
9585e3d33a7SSam Clegg 
9595e3d33a7SSam Clegg   auto Pair =
9605e3d33a7SSam Clegg       FunctionTypeIndices.insert(std::make_pair(F, FunctionTypes.size()));
9615e3d33a7SSam Clegg   if (Pair.second)
9625e3d33a7SSam Clegg     FunctionTypes.push_back(F);
9635e3d33a7SSam Clegg   TypeIndices[&Symbol] = Pair.first->second;
9645e3d33a7SSam Clegg 
9655e3d33a7SSam Clegg   DEBUG(dbgs() << "registerFunctionType: " << Symbol << " new:" << Pair.second << "\n");
9665e3d33a7SSam Clegg   DEBUG(dbgs() << "  -> type index: " << Pair.first->second << "\n");
9675e3d33a7SSam Clegg   return Pair.first->second;
9685e3d33a7SSam Clegg }
9695e3d33a7SSam Clegg 
97018eafb6cSDan Gohman void WasmObjectWriter::writeObject(MCAssembler &Asm,
97118eafb6cSDan Gohman                                    const MCAsmLayout &Layout) {
972b7787fd0SSam Clegg   DEBUG(dbgs() << "WasmObjectWriter::writeObject\n");
97382607f56SDan Gohman   MCContext &Ctx = Asm.getContext();
974b879539aSDerek Schuff   wasm::ValType PtrType = is64Bit() ? wasm::ValType::I64 : wasm::ValType::I32;
975d934cb88SDan Gohman 
976d934cb88SDan Gohman   // Collect information from the available symbols.
977d934cb88SDan Gohman   SmallVector<WasmFunction, 4> Functions;
978d934cb88SDan Gohman   SmallVector<uint32_t, 4> TableElems;
979d934cb88SDan Gohman   SmallVector<WasmImport, 4> Imports;
980d934cb88SDan Gohman   SmallVector<WasmExport, 4> Exports;
98131a2c809SSam Clegg   SmallVector<std::pair<StringRef, uint32_t>, 4> SymbolFlags;
982d934cb88SDan Gohman   SmallPtrSet<const MCSymbolWasm *, 4> IsAddressTaken;
983d934cb88SDan Gohman   unsigned NumFuncImports = 0;
9847c395943SSam Clegg   SmallVector<WasmDataSegment, 4> DataSegments;
9857c395943SSam Clegg   uint32_t DataSize = 0;
986d934cb88SDan Gohman 
987d934cb88SDan Gohman   // Populate the IsAddressTaken set.
988b7787fd0SSam Clegg   for (const WasmRelocationEntry &RelEntry : CodeRelocations) {
989d934cb88SDan Gohman     switch (RelEntry.Type) {
990d934cb88SDan Gohman     case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB:
99113a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB:
992d934cb88SDan Gohman       IsAddressTaken.insert(RelEntry.Symbol);
993d934cb88SDan Gohman       break;
994d934cb88SDan Gohman     default:
995d934cb88SDan Gohman       break;
996d934cb88SDan Gohman     }
997d934cb88SDan Gohman   }
998b7787fd0SSam Clegg   for (const WasmRelocationEntry &RelEntry : DataRelocations) {
999d934cb88SDan Gohman     switch (RelEntry.Type) {
1000d934cb88SDan Gohman     case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32:
100113a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32:
1002d934cb88SDan Gohman       IsAddressTaken.insert(RelEntry.Symbol);
1003d934cb88SDan Gohman       break;
1004d934cb88SDan Gohman     default:
1005d934cb88SDan Gohman       break;
1006d934cb88SDan Gohman     }
1007d934cb88SDan Gohman   }
1008d934cb88SDan Gohman 
100982607f56SDan Gohman   // In the special .global_variables section, we've encoded global
101082607f56SDan Gohman   // variables used by the function. Translate them into the Globals
101182607f56SDan Gohman   // list.
101212fd3da9SSam Clegg   MCSectionWasm *GlobalVars =
101312fd3da9SSam Clegg       Ctx.getWasmSection(".global_variables", SectionKind::getMetadata());
101482607f56SDan Gohman   if (!GlobalVars->getFragmentList().empty()) {
101582607f56SDan Gohman     if (GlobalVars->getFragmentList().size() != 1)
101682607f56SDan Gohman       report_fatal_error("only one .global_variables fragment supported");
101782607f56SDan Gohman     const MCFragment &Frag = *GlobalVars->begin();
101882607f56SDan Gohman     if (Frag.hasInstructions() || Frag.getKind() != MCFragment::FT_Data)
101982607f56SDan Gohman       report_fatal_error("only data supported in .global_variables");
1020fe6414b0SSam Clegg     const auto &DataFrag = cast<MCDataFragment>(Frag);
102182607f56SDan Gohman     if (!DataFrag.getFixups().empty())
102282607f56SDan Gohman       report_fatal_error("fixups not supported in .global_variables");
102382607f56SDan Gohman     const SmallVectorImpl<char> &Contents = DataFrag.getContents();
1024970d02c4SDan Gohman     for (const uint8_t *p = (const uint8_t *)Contents.data(),
1025970d02c4SDan Gohman                      *end = (const uint8_t *)Contents.data() + Contents.size();
1026970d02c4SDan Gohman          p != end; ) {
102782607f56SDan Gohman       WasmGlobal G;
1028970d02c4SDan Gohman       if (end - p < 3)
1029970d02c4SDan Gohman         report_fatal_error("truncated global variable encoding");
1030970d02c4SDan Gohman       G.Type = wasm::ValType(int8_t(*p++));
1031970d02c4SDan Gohman       G.IsMutable = bool(*p++);
1032970d02c4SDan Gohman       G.HasImport = bool(*p++);
1033970d02c4SDan Gohman       if (G.HasImport) {
103482607f56SDan Gohman         G.InitialValue = 0;
1035970d02c4SDan Gohman 
1036970d02c4SDan Gohman         WasmImport Import;
1037970d02c4SDan Gohman         Import.ModuleName = (const char *)p;
1038970d02c4SDan Gohman         const uint8_t *nul = (const uint8_t *)memchr(p, '\0', end - p);
1039970d02c4SDan Gohman         if (!nul)
1040970d02c4SDan Gohman           report_fatal_error("global module name must be nul-terminated");
1041970d02c4SDan Gohman         p = nul + 1;
1042970d02c4SDan Gohman         nul = (const uint8_t *)memchr(p, '\0', end - p);
1043970d02c4SDan Gohman         if (!nul)
1044970d02c4SDan Gohman           report_fatal_error("global base name must be nul-terminated");
1045970d02c4SDan Gohman         Import.FieldName = (const char *)p;
1046970d02c4SDan Gohman         p = nul + 1;
1047970d02c4SDan Gohman 
1048970d02c4SDan Gohman         Import.Kind = wasm::WASM_EXTERNAL_GLOBAL;
1049970d02c4SDan Gohman         Import.Type = int32_t(G.Type);
1050970d02c4SDan Gohman 
1051970d02c4SDan Gohman         G.ImportIndex = NumGlobalImports;
1052970d02c4SDan Gohman         ++NumGlobalImports;
1053970d02c4SDan Gohman 
1054970d02c4SDan Gohman         Imports.push_back(Import);
1055970d02c4SDan Gohman       } else {
1056970d02c4SDan Gohman         unsigned n;
1057970d02c4SDan Gohman         G.InitialValue = decodeSLEB128(p, &n);
1058970d02c4SDan Gohman         G.ImportIndex = 0;
1059c8da0c0bSSimon Pilgrim         if ((ptrdiff_t)n > end - p)
1060970d02c4SDan Gohman           report_fatal_error("global initial value must be valid SLEB128");
1061970d02c4SDan Gohman         p += n;
1062970d02c4SDan Gohman       }
106382607f56SDan Gohman       Globals.push_back(G);
106482607f56SDan Gohman     }
106582607f56SDan Gohman   }
106682607f56SDan Gohman 
1067*f950b24aSSam Clegg   // For now, always emit the memory import, since loads and stores are not
1068*f950b24aSSam Clegg   // valid without it. In the future, we could perhaps be more clever and omit
1069*f950b24aSSam Clegg   // it if there are no loads or stores.
1070*f950b24aSSam Clegg   MCSymbolWasm *MemorySym =
1071*f950b24aSSam Clegg       cast<MCSymbolWasm>(Ctx.getOrCreateSymbol("__linear_memory"));
1072*f950b24aSSam Clegg   WasmImport MemImport;
1073*f950b24aSSam Clegg   MemImport.ModuleName = MemorySym->getModuleName();
1074*f950b24aSSam Clegg   MemImport.FieldName = MemorySym->getName();
1075*f950b24aSSam Clegg   MemImport.Kind = wasm::WASM_EXTERNAL_MEMORY;
1076*f950b24aSSam Clegg   Imports.push_back(MemImport);
1077*f950b24aSSam Clegg 
1078*f950b24aSSam Clegg   // For now, always emit the table section, since indirect calls are not
1079*f950b24aSSam Clegg   // valid without it. In the future, we could perhaps be more clever and omit
1080*f950b24aSSam Clegg   // it if there are no indirect calls.
1081*f950b24aSSam Clegg   MCSymbolWasm *TableSym =
1082*f950b24aSSam Clegg       cast<MCSymbolWasm>(Ctx.getOrCreateSymbol("__indirect_function_table"));
1083*f950b24aSSam Clegg   WasmImport TableImport;
1084*f950b24aSSam Clegg   TableImport.ModuleName = TableSym->getModuleName();
1085*f950b24aSSam Clegg   TableImport.FieldName = TableSym->getName();
1086*f950b24aSSam Clegg   TableImport.Kind = wasm::WASM_EXTERNAL_TABLE;
1087*f950b24aSSam Clegg   TableImport.Type = wasm::WASM_TYPE_ANYFUNC;
1088*f950b24aSSam Clegg   Imports.push_back(TableImport);
1089*f950b24aSSam Clegg 
109032ce5ca0SDan Gohman   // Populate FunctionTypeIndices and Imports.
109132ce5ca0SDan Gohman   for (const MCSymbol &S : Asm.symbols()) {
109232ce5ca0SDan Gohman     const auto &WS = static_cast<const MCSymbolWasm &>(S);
109332ce5ca0SDan Gohman 
109432ce5ca0SDan Gohman     // Register types for all functions, including those with private linkage
109532ce5ca0SDan Gohman     // (making them
109632ce5ca0SDan Gohman     // because wasm always needs a type signature.
109732ce5ca0SDan Gohman     if (WS.isFunction())
109832ce5ca0SDan Gohman       registerFunctionType(WS);
109932ce5ca0SDan Gohman 
110032ce5ca0SDan Gohman     if (WS.isTemporary())
110132ce5ca0SDan Gohman       continue;
110232ce5ca0SDan Gohman 
110332ce5ca0SDan Gohman     // If the symbol is not defined in this translation unit, import it.
110432ce5ca0SDan Gohman     if (!WS.isDefined(/*SetUsed=*/false)) {
110532ce5ca0SDan Gohman       WasmImport Import;
110632ce5ca0SDan Gohman       Import.ModuleName = WS.getModuleName();
110732ce5ca0SDan Gohman       Import.FieldName = WS.getName();
110832ce5ca0SDan Gohman 
110932ce5ca0SDan Gohman       if (WS.isFunction()) {
111032ce5ca0SDan Gohman         Import.Kind = wasm::WASM_EXTERNAL_FUNCTION;
111132ce5ca0SDan Gohman         Import.Type = getFunctionType(WS);
111232ce5ca0SDan Gohman         SymbolIndices[&WS] = NumFuncImports;
111332ce5ca0SDan Gohman         ++NumFuncImports;
111432ce5ca0SDan Gohman       } else {
111532ce5ca0SDan Gohman         Import.Kind = wasm::WASM_EXTERNAL_GLOBAL;
111632ce5ca0SDan Gohman         Import.Type = int32_t(PtrType);
111732ce5ca0SDan Gohman         Import.IsMutable = false;
111832ce5ca0SDan Gohman         SymbolIndices[&WS] = NumGlobalImports;
111932ce5ca0SDan Gohman 
112032ce5ca0SDan Gohman         // If this global is the stack pointer, make it mutable and remember it
112132ce5ca0SDan Gohman         // so that we can emit metadata for it.
1122ad19047dSDan Gohman         if (WS.getName() == "__stack_pointer")
112332ce5ca0SDan Gohman           Import.IsMutable = true;
112432ce5ca0SDan Gohman 
112532ce5ca0SDan Gohman         ++NumGlobalImports;
112632ce5ca0SDan Gohman       }
112732ce5ca0SDan Gohman 
112832ce5ca0SDan Gohman       Imports.push_back(Import);
112932ce5ca0SDan Gohman     }
113032ce5ca0SDan Gohman   }
113132ce5ca0SDan Gohman 
1132759631c7SSam Clegg   for (MCSection &Sec : Asm) {
1133759631c7SSam Clegg     auto &Section = static_cast<MCSectionWasm &>(Sec);
113412fd3da9SSam Clegg     if (!Section.isWasmData())
1135759631c7SSam Clegg       continue;
1136759631c7SSam Clegg 
1137759631c7SSam Clegg     DataSize = alignTo(DataSize, Section.getAlignment());
1138759631c7SSam Clegg     DataSegments.emplace_back();
1139759631c7SSam Clegg     WasmDataSegment &Segment = DataSegments.back();
1140d95ed959SSam Clegg     Segment.Name = Section.getSectionName();
1141759631c7SSam Clegg     Segment.Offset = DataSize;
1142759631c7SSam Clegg     Segment.Section = &Section;
114363ebb813SSam Clegg     addData(Segment.Data, Section);
114463ebb813SSam Clegg     Segment.Alignment = Section.getAlignment();
114563ebb813SSam Clegg     Segment.Flags = 0;
1146759631c7SSam Clegg     DataSize += Segment.Data.size();
1147759631c7SSam Clegg     Section.setMemoryOffset(Segment.Offset);
1148759631c7SSam Clegg   }
1149759631c7SSam Clegg 
1150b7787fd0SSam Clegg   // Handle regular defined and undefined symbols.
1151d934cb88SDan Gohman   for (const MCSymbol &S : Asm.symbols()) {
1152d934cb88SDan Gohman     // Ignore unnamed temporary symbols, which aren't ever exported, imported,
1153d934cb88SDan Gohman     // or used in relocations.
1154d934cb88SDan Gohman     if (S.isTemporary() && S.getName().empty())
1155d934cb88SDan Gohman       continue;
1156b7787fd0SSam Clegg 
1157d934cb88SDan Gohman     const auto &WS = static_cast<const MCSymbolWasm &>(S);
1158b7787fd0SSam Clegg     DEBUG(dbgs() << "MCSymbol: '" << S << "'"
1159b7787fd0SSam Clegg                  << " isDefined=" << S.isDefined() << " isExternal="
1160b7787fd0SSam Clegg                  << S.isExternal() << " isTemporary=" << S.isTemporary()
1161b7787fd0SSam Clegg                  << " isFunction=" << WS.isFunction()
1162b7787fd0SSam Clegg                  << " isWeak=" << WS.isWeak()
1163a2b35dacSSam Clegg                  << " isHidden=" << WS.isHidden()
1164b7787fd0SSam Clegg                  << " isVariable=" << WS.isVariable() << "\n");
1165b7787fd0SSam Clegg 
1166a2b35dacSSam Clegg     if (WS.isWeak() || WS.isHidden()) {
1167a2b35dacSSam Clegg       uint32_t Flags = (WS.isWeak() ? wasm::WASM_SYMBOL_BINDING_WEAK : 0) |
1168a2b35dacSSam Clegg           (WS.isHidden() ? wasm::WASM_SYMBOL_VISIBILITY_HIDDEN : 0);
1169a2b35dacSSam Clegg       SymbolFlags.emplace_back(WS.getName(), Flags);
1170a2b35dacSSam Clegg     }
1171b7787fd0SSam Clegg 
11725e3d33a7SSam Clegg     if (WS.isVariable())
11735e3d33a7SSam Clegg       continue;
11745e3d33a7SSam Clegg 
1175d934cb88SDan Gohman     unsigned Index;
1176b7787fd0SSam Clegg 
1177d934cb88SDan Gohman     if (WS.isFunction()) {
1178d934cb88SDan Gohman       if (WS.isDefined(/*SetUsed=*/false)) {
1179b7787fd0SSam Clegg         if (WS.getOffset() != 0)
1180b7787fd0SSam Clegg           report_fatal_error(
1181b7787fd0SSam Clegg               "function sections must contain one function each");
1182b7787fd0SSam Clegg 
1183b7787fd0SSam Clegg         if (WS.getSize() == 0)
1184b7787fd0SSam Clegg           report_fatal_error(
1185b7787fd0SSam Clegg               "function symbols must have a size set with .size");
1186b7787fd0SSam Clegg 
1187d934cb88SDan Gohman         // A definition. Take the next available index.
1188d934cb88SDan Gohman         Index = NumFuncImports + Functions.size();
1189d934cb88SDan Gohman 
1190d934cb88SDan Gohman         // Prepare the function.
1191d934cb88SDan Gohman         WasmFunction Func;
11925e3d33a7SSam Clegg         Func.Type = getFunctionType(WS);
1193d934cb88SDan Gohman         Func.Sym = &WS;
1194d934cb88SDan Gohman         SymbolIndices[&WS] = Index;
1195d934cb88SDan Gohman         Functions.push_back(Func);
1196d934cb88SDan Gohman       } else {
1197d934cb88SDan Gohman         // An import; the index was assigned above.
1198d934cb88SDan Gohman         Index = SymbolIndices.find(&WS)->second;
1199d934cb88SDan Gohman       }
1200d934cb88SDan Gohman 
12015e3d33a7SSam Clegg       DEBUG(dbgs() << "  -> function index: " << Index << "\n");
12025e3d33a7SSam Clegg 
1203d934cb88SDan Gohman       // If needed, prepare the function to be called indirectly.
12045e3d33a7SSam Clegg       if (IsAddressTaken.count(&WS) != 0) {
1205d99f6078SSam Clegg         IndirectSymbolIndices[&WS] = TableElems.size();
12065e3d33a7SSam Clegg         DEBUG(dbgs() << "  -> adding to table: " << TableElems.size() << "\n");
1207d934cb88SDan Gohman         TableElems.push_back(Index);
1208d99f6078SSam Clegg       }
1209d934cb88SDan Gohman     } else {
1210c38e947eSSam Clegg       if (WS.isTemporary() && !WS.getSize())
1211c38e947eSSam Clegg         continue;
1212c38e947eSSam Clegg 
1213fe6414b0SSam Clegg       if (!WS.isDefined(/*SetUsed=*/false))
1214fe6414b0SSam Clegg         continue;
1215fe6414b0SSam Clegg 
1216d934cb88SDan Gohman       if (!WS.getSize())
1217c38e947eSSam Clegg         report_fatal_error("data symbols must have a size set with .size: " +
1218c38e947eSSam Clegg                            WS.getName());
1219d934cb88SDan Gohman 
1220d934cb88SDan Gohman       int64_t Size = 0;
1221d934cb88SDan Gohman       if (!WS.getSize()->evaluateAsAbsolute(Size, Layout))
1222d934cb88SDan Gohman         report_fatal_error(".size expression must be evaluatable");
1223d934cb88SDan Gohman 
12247c395943SSam Clegg       // For each global, prepare a corresponding wasm global holding its
12257c395943SSam Clegg       // address.  For externals these will also be named exports.
12267c395943SSam Clegg       Index = NumGlobalImports + Globals.size();
1227759631c7SSam Clegg       auto &DataSection = static_cast<MCSectionWasm &>(WS.getSection());
12287c395943SSam Clegg 
12297c395943SSam Clegg       WasmGlobal Global;
12307c395943SSam Clegg       Global.Type = PtrType;
12317c395943SSam Clegg       Global.IsMutable = false;
12327c395943SSam Clegg       Global.HasImport = false;
1233759631c7SSam Clegg       Global.InitialValue = DataSection.getMemoryOffset() + Layout.getSymbolOffset(WS);
12347c395943SSam Clegg       Global.ImportIndex = 0;
12357c395943SSam Clegg       SymbolIndices[&WS] = Index;
12367c395943SSam Clegg       DEBUG(dbgs() << "  -> global index: " << Index << "\n");
12377c395943SSam Clegg       Globals.push_back(Global);
1238d934cb88SDan Gohman     }
1239d934cb88SDan Gohman 
1240d934cb88SDan Gohman     // If the symbol is visible outside this translation unit, export it.
124131a2c809SSam Clegg     if (WS.isDefined(/*SetUsed=*/false)) {
1242d934cb88SDan Gohman       WasmExport Export;
1243d934cb88SDan Gohman       Export.FieldName = WS.getName();
1244d934cb88SDan Gohman       Export.Index = Index;
1245d934cb88SDan Gohman       if (WS.isFunction())
1246d934cb88SDan Gohman         Export.Kind = wasm::WASM_EXTERNAL_FUNCTION;
1247d934cb88SDan Gohman       else
1248d934cb88SDan Gohman         Export.Kind = wasm::WASM_EXTERNAL_GLOBAL;
12495e3d33a7SSam Clegg       DEBUG(dbgs() << "  -> export " << Exports.size() << "\n");
1250d934cb88SDan Gohman       Exports.push_back(Export);
125131a2c809SSam Clegg       if (!WS.isExternal())
125231a2c809SSam Clegg         SymbolFlags.emplace_back(WS.getName(), wasm::WASM_SYMBOL_BINDING_LOCAL);
1253d934cb88SDan Gohman     }
1254d934cb88SDan Gohman   }
1255d934cb88SDan Gohman 
12565e3d33a7SSam Clegg   // Handle weak aliases. We need to process these in a separate pass because
12575e3d33a7SSam Clegg   // we need to have processed the target of the alias before the alias itself
12585e3d33a7SSam Clegg   // and the symbols are not necessarily ordered in this way.
1259b7787fd0SSam Clegg   for (const MCSymbol &S : Asm.symbols()) {
1260b7787fd0SSam Clegg     if (!S.isVariable())
1261b7787fd0SSam Clegg       continue;
126231a2c809SSam Clegg 
1263b7787fd0SSam Clegg     assert(S.isDefined(/*SetUsed=*/false));
1264b7787fd0SSam Clegg 
12655e3d33a7SSam Clegg     // Find the target symbol of this weak alias and export that index
1266aff1c4dfSSam Clegg     const auto &WS = static_cast<const MCSymbolWasm &>(S);
1267aff1c4dfSSam Clegg     const MCSymbolWasm *ResolvedSym = ResolveSymbol(WS);
12685e3d33a7SSam Clegg     DEBUG(dbgs() << WS.getName() << ": weak alias of '" << *ResolvedSym << "'\n");
12695e3d33a7SSam Clegg     assert(SymbolIndices.count(ResolvedSym) > 0);
1270b7787fd0SSam Clegg     uint32_t Index = SymbolIndices.find(ResolvedSym)->second;
12715e3d33a7SSam Clegg     DEBUG(dbgs() << "  -> index:" << Index << "\n");
1272b7787fd0SSam Clegg 
1273ba9fa9fdSSam Clegg     SymbolIndices[&WS] = Index;
1274b7787fd0SSam Clegg     WasmExport Export;
1275b7787fd0SSam Clegg     Export.FieldName = WS.getName();
1276b7787fd0SSam Clegg     Export.Index = Index;
1277b7787fd0SSam Clegg     if (WS.isFunction())
1278b7787fd0SSam Clegg       Export.Kind = wasm::WASM_EXTERNAL_FUNCTION;
1279b7787fd0SSam Clegg     else
1280b7787fd0SSam Clegg       Export.Kind = wasm::WASM_EXTERNAL_GLOBAL;
12815e3d33a7SSam Clegg     DEBUG(dbgs() << "  -> export " << Exports.size() << "\n");
1282b7787fd0SSam Clegg     Exports.push_back(Export);
128331a2c809SSam Clegg 
128431a2c809SSam Clegg     if (!WS.isExternal())
128531a2c809SSam Clegg       SymbolFlags.emplace_back(WS.getName(), wasm::WASM_SYMBOL_BINDING_LOCAL);
1286b7787fd0SSam Clegg   }
1287b7787fd0SSam Clegg 
1288d934cb88SDan Gohman   // Add types for indirect function calls.
1289acd7d2b0SSam Clegg   for (const WasmRelocationEntry &Fixup : CodeRelocations) {
1290acd7d2b0SSam Clegg     if (Fixup.Type != wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB)
1291acd7d2b0SSam Clegg       continue;
1292970d02c4SDan Gohman 
12935e3d33a7SSam Clegg     registerFunctionType(*Fixup.Symbol);
1294d934cb88SDan Gohman   }
1295d934cb88SDan Gohman 
129618eafb6cSDan Gohman   // Write out the Wasm header.
129718eafb6cSDan Gohman   writeHeader(Asm);
129818eafb6cSDan Gohman 
12999e15f359SSam Clegg   writeTypeSection(FunctionTypes);
1300*f950b24aSSam Clegg   writeImportSection(Imports, DataSize, TableElems.size());
13019e15f359SSam Clegg   writeFunctionSection(Functions);
1302*f950b24aSSam Clegg   // Skip the "table" section; we import the table instead.
1303*f950b24aSSam Clegg   // Skip the "memory" section; we import the memory instead.
13047c395943SSam Clegg   writeGlobalSection();
13059e15f359SSam Clegg   writeExportSection(Exports);
13069e15f359SSam Clegg   // TODO: Start Section
13079e15f359SSam Clegg   writeElemSection(TableElems);
1308acd7d2b0SSam Clegg   writeCodeSection(Asm, Layout, Functions);
13097c395943SSam Clegg   writeDataSection(DataSegments);
13109e15f359SSam Clegg   writeNameSection(Functions, Imports, NumFuncImports);
1311acd7d2b0SSam Clegg   writeCodeRelocSection();
13127c395943SSam Clegg   writeDataRelocSection();
1313ad19047dSDan Gohman   writeLinkingMetaDataSection(DataSegments, DataSize, SymbolFlags);
1314970d02c4SDan Gohman 
1315d934cb88SDan Gohman   // TODO: Translate the .comment section to the output.
1316d934cb88SDan Gohman   // TODO: Translate debug sections to the output.
131718eafb6cSDan Gohman }
131818eafb6cSDan Gohman 
131960fbc7ccSLang Hames std::unique_ptr<MCObjectWriter>
13201301a878SLang Hames llvm::createWasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW,
132118eafb6cSDan Gohman                              raw_pwrite_stream &OS) {
132260fbc7ccSLang Hames   // FIXME: Can't use make_unique<WasmObjectWriter>(...) as WasmObjectWriter's
132360fbc7ccSLang Hames   //        destructor is private. Is that necessary?
132460fbc7ccSLang Hames   return std::unique_ptr<MCObjectWriter>(
132560fbc7ccSLang Hames       new WasmObjectWriter(std::move(MOTW), OS));
132618eafb6cSDan Gohman }
1327