118eafb6cSDan Gohman //===- lib/MC/WasmObjectWriter.cpp - Wasm File Writer ---------------------===//
218eafb6cSDan Gohman //
318eafb6cSDan Gohman //                     The LLVM Compiler Infrastructure
418eafb6cSDan Gohman //
518eafb6cSDan Gohman // This file is distributed under the University of Illinois Open Source
618eafb6cSDan Gohman // License. See LICENSE.TXT for details.
718eafb6cSDan Gohman //
818eafb6cSDan Gohman //===----------------------------------------------------------------------===//
918eafb6cSDan Gohman //
1018eafb6cSDan Gohman // This file implements Wasm object file writer information.
1118eafb6cSDan Gohman //
1218eafb6cSDan Gohman //===----------------------------------------------------------------------===//
1318eafb6cSDan Gohman 
1418eafb6cSDan Gohman #include "llvm/ADT/STLExtras.h"
1518eafb6cSDan Gohman #include "llvm/ADT/SmallPtrSet.h"
16264b5d9eSZachary Turner #include "llvm/BinaryFormat/Wasm.h"
1718eafb6cSDan Gohman #include "llvm/MC/MCAsmBackend.h"
1818eafb6cSDan Gohman #include "llvm/MC/MCAsmLayout.h"
1918eafb6cSDan Gohman #include "llvm/MC/MCAssembler.h"
2018eafb6cSDan Gohman #include "llvm/MC/MCContext.h"
2118eafb6cSDan Gohman #include "llvm/MC/MCExpr.h"
2218eafb6cSDan Gohman #include "llvm/MC/MCFixupKindInfo.h"
2318eafb6cSDan Gohman #include "llvm/MC/MCObjectWriter.h"
2418eafb6cSDan Gohman #include "llvm/MC/MCSectionWasm.h"
2518eafb6cSDan Gohman #include "llvm/MC/MCSymbolWasm.h"
2618eafb6cSDan Gohman #include "llvm/MC/MCValue.h"
2718eafb6cSDan Gohman #include "llvm/MC/MCWasmObjectWriter.h"
28d934cb88SDan Gohman #include "llvm/Support/Casting.h"
2918eafb6cSDan Gohman #include "llvm/Support/Debug.h"
3018eafb6cSDan Gohman #include "llvm/Support/ErrorHandling.h"
31d934cb88SDan Gohman #include "llvm/Support/LEB128.h"
3218eafb6cSDan Gohman #include "llvm/Support/StringSaver.h"
3318eafb6cSDan Gohman #include <vector>
3418eafb6cSDan Gohman 
3518eafb6cSDan Gohman using namespace llvm;
3618eafb6cSDan Gohman 
375e3d33a7SSam Clegg #define DEBUG_TYPE "mc"
3818eafb6cSDan Gohman 
3918eafb6cSDan Gohman namespace {
409e15f359SSam Clegg 
4130e1bbc1SSam Clegg // Went we ceate the indirect function table we start at 1, so that there is
4230e1bbc1SSam Clegg // and emtpy slot at 0 and therefore calling a null function pointer will trap.
4330e1bbc1SSam Clegg static const uint32_t kInitialTableOffset = 1;
4430e1bbc1SSam Clegg 
45d934cb88SDan Gohman // For patching purposes, we need to remember where each section starts, both
46d934cb88SDan Gohman // for patching up the section size field, and for patching up references to
47d934cb88SDan Gohman // locations within the section.
48d934cb88SDan Gohman struct SectionBookkeeping {
49d934cb88SDan Gohman   // Where the size of the section is written.
50d934cb88SDan Gohman   uint64_t SizeOffset;
51d934cb88SDan Gohman   // Where the contents of the section starts (after the header).
52d934cb88SDan Gohman   uint64_t ContentsOffset;
53d934cb88SDan Gohman };
54d934cb88SDan Gohman 
559e15f359SSam Clegg // The signature of a wasm function, in a struct capable of being used as a
569e15f359SSam Clegg // DenseMap key.
579e15f359SSam Clegg struct WasmFunctionType {
589e15f359SSam Clegg   // Support empty and tombstone instances, needed by DenseMap.
599e15f359SSam Clegg   enum { Plain, Empty, Tombstone } State;
609e15f359SSam Clegg 
619e15f359SSam Clegg   // The return types of the function.
629e15f359SSam Clegg   SmallVector<wasm::ValType, 1> Returns;
639e15f359SSam Clegg 
649e15f359SSam Clegg   // The parameter types of the function.
659e15f359SSam Clegg   SmallVector<wasm::ValType, 4> Params;
669e15f359SSam Clegg 
679e15f359SSam Clegg   WasmFunctionType() : State(Plain) {}
689e15f359SSam Clegg 
699e15f359SSam Clegg   bool operator==(const WasmFunctionType &Other) const {
709e15f359SSam Clegg     return State == Other.State && Returns == Other.Returns &&
719e15f359SSam Clegg            Params == Other.Params;
729e15f359SSam Clegg   }
739e15f359SSam Clegg };
749e15f359SSam Clegg 
759e15f359SSam Clegg // Traits for using WasmFunctionType in a DenseMap.
769e15f359SSam Clegg struct WasmFunctionTypeDenseMapInfo {
779e15f359SSam Clegg   static WasmFunctionType getEmptyKey() {
789e15f359SSam Clegg     WasmFunctionType FuncTy;
799e15f359SSam Clegg     FuncTy.State = WasmFunctionType::Empty;
809e15f359SSam Clegg     return FuncTy;
819e15f359SSam Clegg   }
829e15f359SSam Clegg   static WasmFunctionType getTombstoneKey() {
839e15f359SSam Clegg     WasmFunctionType FuncTy;
849e15f359SSam Clegg     FuncTy.State = WasmFunctionType::Tombstone;
859e15f359SSam Clegg     return FuncTy;
869e15f359SSam Clegg   }
879e15f359SSam Clegg   static unsigned getHashValue(const WasmFunctionType &FuncTy) {
889e15f359SSam Clegg     uintptr_t Value = FuncTy.State;
899e15f359SSam Clegg     for (wasm::ValType Ret : FuncTy.Returns)
909e15f359SSam Clegg       Value += DenseMapInfo<int32_t>::getHashValue(int32_t(Ret));
919e15f359SSam Clegg     for (wasm::ValType Param : FuncTy.Params)
929e15f359SSam Clegg       Value += DenseMapInfo<int32_t>::getHashValue(int32_t(Param));
939e15f359SSam Clegg     return Value;
949e15f359SSam Clegg   }
959e15f359SSam Clegg   static bool isEqual(const WasmFunctionType &LHS,
969e15f359SSam Clegg                       const WasmFunctionType &RHS) {
979e15f359SSam Clegg     return LHS == RHS;
989e15f359SSam Clegg   }
999e15f359SSam Clegg };
1009e15f359SSam Clegg 
1017c395943SSam Clegg // A wasm data segment.  A wasm binary contains only a single data section
1027c395943SSam Clegg // but that can contain many segments, each with their own virtual location
1037c395943SSam Clegg // in memory.  Each MCSection data created by llvm is modeled as its own
1047c395943SSam Clegg // wasm data segment.
1057c395943SSam Clegg struct WasmDataSegment {
1067c395943SSam Clegg   MCSectionWasm *Section;
107d95ed959SSam Clegg   StringRef Name;
1087c395943SSam Clegg   uint32_t Offset;
10963ebb813SSam Clegg   uint32_t Alignment;
11063ebb813SSam Clegg   uint32_t Flags;
1117c395943SSam Clegg   SmallVector<char, 4> Data;
1127c395943SSam Clegg };
1137c395943SSam Clegg 
1149e15f359SSam Clegg // A wasm function to be written into the function section.
1159e15f359SSam Clegg struct WasmFunction {
1169e15f359SSam Clegg   int32_t Type;
1179e15f359SSam Clegg   const MCSymbolWasm *Sym;
1189e15f359SSam Clegg };
1199e15f359SSam Clegg 
1209e15f359SSam Clegg // A wasm global to be written into the global section.
1219e15f359SSam Clegg struct WasmGlobal {
1226e7f1826SSam Clegg   wasm::WasmGlobalType Type;
1239e15f359SSam Clegg   uint64_t InitialValue;
1249e15f359SSam Clegg };
1259e15f359SSam Clegg 
126ea7caceeSSam Clegg // Information about a single item which is part of a COMDAT.  For each data
127ea7caceeSSam Clegg // segment or function which is in the COMDAT, there is a corresponding
128ea7caceeSSam Clegg // WasmComdatEntry.
129ea7caceeSSam Clegg struct WasmComdatEntry {
130ea7caceeSSam Clegg   unsigned Kind;
131ea7caceeSSam Clegg   uint32_t Index;
132ea7caceeSSam Clegg };
133ea7caceeSSam Clegg 
1346dc65e91SSam Clegg // Information about a single relocation.
1356dc65e91SSam Clegg struct WasmRelocationEntry {
1366dc65e91SSam Clegg   uint64_t Offset;                  // Where is the relocation.
1376dc65e91SSam Clegg   const MCSymbolWasm *Symbol;       // The symbol to relocate with.
1386dc65e91SSam Clegg   int64_t Addend;                   // A value to add to the symbol.
1396dc65e91SSam Clegg   unsigned Type;                    // The type of the relocation.
140fe6414b0SSam Clegg   const MCSectionWasm *FixupSection;// The section the relocation is targeting.
1416dc65e91SSam Clegg 
1426dc65e91SSam Clegg   WasmRelocationEntry(uint64_t Offset, const MCSymbolWasm *Symbol,
1436dc65e91SSam Clegg                       int64_t Addend, unsigned Type,
144fe6414b0SSam Clegg                       const MCSectionWasm *FixupSection)
1456dc65e91SSam Clegg       : Offset(Offset), Symbol(Symbol), Addend(Addend), Type(Type),
1466dc65e91SSam Clegg         FixupSection(FixupSection) {}
1476dc65e91SSam Clegg 
148acd7d2b0SSam Clegg   bool hasAddend() const {
149acd7d2b0SSam Clegg     switch (Type) {
15013a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB:
15113a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB:
15213a2e899SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32:
153acd7d2b0SSam Clegg       return true;
154acd7d2b0SSam Clegg     default:
155acd7d2b0SSam Clegg       return false;
156acd7d2b0SSam Clegg     }
157acd7d2b0SSam Clegg   }
158acd7d2b0SSam Clegg 
1596dc65e91SSam Clegg   void print(raw_ostream &Out) const {
1609bf73c07SSam Clegg     Out << "Off=" << Offset << ", Sym=" << *Symbol << ", Addend=" << Addend
161759631c7SSam Clegg         << ", Type=" << Type
162759631c7SSam Clegg         << ", FixupSection=" << FixupSection->getSectionName();
1636dc65e91SSam Clegg   }
164b7787fd0SSam Clegg 
165615eb470SAaron Ballman #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
166b7787fd0SSam Clegg   LLVM_DUMP_METHOD void dump() const { print(dbgs()); }
167b7787fd0SSam Clegg #endif
1686dc65e91SSam Clegg };
1696dc65e91SSam Clegg 
1701fb8daa6SSam Clegg #if !defined(NDEBUG)
1717f055deeSSam Clegg raw_ostream &operator<<(raw_ostream &OS, const WasmRelocationEntry &Rel) {
172b7787fd0SSam Clegg   Rel.print(OS);
173b7787fd0SSam Clegg   return OS;
174b7787fd0SSam Clegg }
1751fb8daa6SSam Clegg #endif
176b7787fd0SSam Clegg 
17718eafb6cSDan Gohman class WasmObjectWriter : public MCObjectWriter {
17818eafb6cSDan Gohman   /// The target specific Wasm writer instance.
17918eafb6cSDan Gohman   std::unique_ptr<MCWasmObjectTargetWriter> TargetObjectWriter;
18018eafb6cSDan Gohman 
181d934cb88SDan Gohman   // Relocations for fixing up references in the code section.
182d934cb88SDan Gohman   std::vector<WasmRelocationEntry> CodeRelocations;
183d934cb88SDan Gohman 
184d934cb88SDan Gohman   // Relocations for fixing up references in the data section.
185d934cb88SDan Gohman   std::vector<WasmRelocationEntry> DataRelocations;
186d934cb88SDan Gohman 
187d934cb88SDan Gohman   // Index values to use for fixing up call_indirect type indices.
188acd7d2b0SSam Clegg   // Maps function symbols to the index of the type of the function
189acd7d2b0SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> TypeIndices;
190d99f6078SSam Clegg   // Maps function symbols to the table element index space. Used
191d99f6078SSam Clegg   // for TABLE_INDEX relocation types (i.e. address taken functions).
192f9edbe95SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> TableIndices;
1936c899ba6SSam Clegg   // Maps function/global symbols to the (shared) Symbol index space.
194acd7d2b0SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> SymbolIndices;
1956c899ba6SSam Clegg   // Maps function/global symbols to the function/global Wasm index space.
1966c899ba6SSam Clegg   DenseMap<const MCSymbolWasm *, uint32_t> WasmIndices;
1976c899ba6SSam Clegg   // Maps data symbols to the Wasm segment and offset/size with the segment.
1986c899ba6SSam Clegg   DenseMap<const MCSymbolWasm *, wasm::WasmDataReference> DataLocations;
199acd7d2b0SSam Clegg 
200acd7d2b0SSam Clegg   DenseMap<WasmFunctionType, int32_t, WasmFunctionTypeDenseMapInfo>
201acd7d2b0SSam Clegg       FunctionTypeIndices;
2025e3d33a7SSam Clegg   SmallVector<WasmFunctionType, 4> FunctionTypes;
2037c395943SSam Clegg   SmallVector<WasmGlobal, 4> Globals;
2046c899ba6SSam Clegg   SmallVector<WasmDataSegment, 4> DataSegments;
2059f3fe42eSSam Clegg   unsigned NumFunctionImports = 0;
2067c395943SSam Clegg   unsigned NumGlobalImports = 0;
207d934cb88SDan Gohman 
20818eafb6cSDan Gohman   // TargetObjectWriter wrappers.
20918eafb6cSDan Gohman   bool is64Bit() const { return TargetObjectWriter->is64Bit(); }
210ae03c1e7SSam Clegg   unsigned getRelocType(const MCValue &Target, const MCFixup &Fixup) const {
211ae03c1e7SSam Clegg     return TargetObjectWriter->getRelocType(Target, Fixup);
21218eafb6cSDan Gohman   }
21318eafb6cSDan Gohman 
214d934cb88SDan Gohman   void startSection(SectionBookkeeping &Section, unsigned SectionId,
215d934cb88SDan Gohman                     const char *Name = nullptr);
216d934cb88SDan Gohman   void endSection(SectionBookkeeping &Section);
217d934cb88SDan Gohman 
21818eafb6cSDan Gohman public:
2191301a878SLang Hames   WasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW,
2201301a878SLang Hames                    raw_pwrite_stream &OS)
2211301a878SLang Hames       : MCObjectWriter(OS, /*IsLittleEndian=*/true),
2221301a878SLang Hames         TargetObjectWriter(std::move(MOTW)) {}
22318eafb6cSDan Gohman 
22418eafb6cSDan Gohman   ~WasmObjectWriter() override;
22518eafb6cSDan Gohman 
2260917c9e4SDan Gohman private:
227acd7d2b0SSam Clegg   void reset() override {
228acd7d2b0SSam Clegg     CodeRelocations.clear();
229acd7d2b0SSam Clegg     DataRelocations.clear();
230acd7d2b0SSam Clegg     TypeIndices.clear();
231acd7d2b0SSam Clegg     SymbolIndices.clear();
2326c899ba6SSam Clegg     WasmIndices.clear();
233f9edbe95SSam Clegg     TableIndices.clear();
2346c899ba6SSam Clegg     DataLocations.clear();
235acd7d2b0SSam Clegg     FunctionTypeIndices.clear();
2365e3d33a7SSam Clegg     FunctionTypes.clear();
2377c395943SSam Clegg     Globals.clear();
2386c899ba6SSam Clegg     DataSegments.clear();
239acd7d2b0SSam Clegg     MCObjectWriter::reset();
2409f3fe42eSSam Clegg     NumFunctionImports = 0;
2417c395943SSam Clegg     NumGlobalImports = 0;
242acd7d2b0SSam Clegg   }
243acd7d2b0SSam Clegg 
24418eafb6cSDan Gohman   void writeHeader(const MCAssembler &Asm);
24518eafb6cSDan Gohman 
24618eafb6cSDan Gohman   void recordRelocation(MCAssembler &Asm, const MCAsmLayout &Layout,
24718eafb6cSDan Gohman                         const MCFragment *Fragment, const MCFixup &Fixup,
248ceecfe5bSRafael Espindola                         MCValue Target, uint64_t &FixedValue) override;
24918eafb6cSDan Gohman 
25018eafb6cSDan Gohman   void executePostLayoutBinding(MCAssembler &Asm,
25118eafb6cSDan Gohman                                 const MCAsmLayout &Layout) override;
25218eafb6cSDan Gohman 
25318eafb6cSDan Gohman   void writeObject(MCAssembler &Asm, const MCAsmLayout &Layout) override;
2549e15f359SSam Clegg 
255b7787fd0SSam Clegg   void writeString(const StringRef Str) {
256b7787fd0SSam Clegg     encodeULEB128(Str.size(), getStream());
257b7787fd0SSam Clegg     writeBytes(Str);
258b7787fd0SSam Clegg   }
259b7787fd0SSam Clegg 
2609e15f359SSam Clegg   void writeValueType(wasm::ValType Ty) {
2619e15f359SSam Clegg     encodeSLEB128(int32_t(Ty), getStream());
2629e15f359SSam Clegg   }
2639e15f359SSam Clegg 
264457fb0b4SSam Clegg   void writeTypeSection(ArrayRef<WasmFunctionType> FunctionTypes);
2658defa952SSam Clegg   void writeImportSection(ArrayRef<wasm::WasmImport> Imports, uint32_t DataSize,
266f950b24aSSam Clegg                           uint32_t NumElements);
267457fb0b4SSam Clegg   void writeFunctionSection(ArrayRef<WasmFunction> Functions);
2687c395943SSam Clegg   void writeGlobalSection();
2698defa952SSam Clegg   void writeExportSection(ArrayRef<wasm::WasmExport> Exports);
270457fb0b4SSam Clegg   void writeElemSection(ArrayRef<uint32_t> TableElems);
2719e15f359SSam Clegg   void writeCodeSection(const MCAssembler &Asm, const MCAsmLayout &Layout,
272457fb0b4SSam Clegg                         ArrayRef<WasmFunction> Functions);
2736c899ba6SSam Clegg   void writeDataSection();
274acd7d2b0SSam Clegg   void writeCodeRelocSection();
2757c395943SSam Clegg   void writeDataRelocSection();
27631a2c809SSam Clegg   void writeLinkingMetaDataSection(
2776c899ba6SSam Clegg       uint32_t DataSize, ArrayRef<wasm::WasmSymbolInfo> SymbolInfos,
278ea7caceeSSam Clegg       ArrayRef<std::pair<uint16_t, uint32_t>> InitFuncs,
279ea7caceeSSam Clegg       const std::map<StringRef, std::vector<WasmComdatEntry>> &Comdats);
280acd7d2b0SSam Clegg 
2817c395943SSam Clegg   uint32_t getProvisionalValue(const WasmRelocationEntry &RelEntry);
282acd7d2b0SSam Clegg   void applyRelocations(ArrayRef<WasmRelocationEntry> Relocations,
283acd7d2b0SSam Clegg                         uint64_t ContentsOffset);
284acd7d2b0SSam Clegg 
2857c395943SSam Clegg   void writeRelocations(ArrayRef<WasmRelocationEntry> Relocations);
286acd7d2b0SSam Clegg   uint32_t getRelocationIndexValue(const WasmRelocationEntry &RelEntry);
2875e3d33a7SSam Clegg   uint32_t getFunctionType(const MCSymbolWasm& Symbol);
2885e3d33a7SSam Clegg   uint32_t registerFunctionType(const MCSymbolWasm& Symbol);
28918eafb6cSDan Gohman };
2909e15f359SSam Clegg 
29118eafb6cSDan Gohman } // end anonymous namespace
29218eafb6cSDan Gohman 
29318eafb6cSDan Gohman WasmObjectWriter::~WasmObjectWriter() {}
29418eafb6cSDan Gohman 
295d934cb88SDan Gohman // Write out a section header and a patchable section size field.
296d934cb88SDan Gohman void WasmObjectWriter::startSection(SectionBookkeeping &Section,
297d934cb88SDan Gohman                                     unsigned SectionId,
298d934cb88SDan Gohman                                     const char *Name) {
299d934cb88SDan Gohman   assert((Name != nullptr) == (SectionId == wasm::WASM_SEC_CUSTOM) &&
300d934cb88SDan Gohman          "Only custom sections can have names");
301d934cb88SDan Gohman 
302b7787fd0SSam Clegg   DEBUG(dbgs() << "startSection " << SectionId << ": " << Name << "\n");
303e2688c43SDerek Schuff   encodeULEB128(SectionId, getStream());
304d934cb88SDan Gohman 
305d934cb88SDan Gohman   Section.SizeOffset = getStream().tell();
306d934cb88SDan Gohman 
307d934cb88SDan Gohman   // The section size. We don't know the size yet, so reserve enough space
308d934cb88SDan Gohman   // for any 32-bit value; we'll patch it later.
309d934cb88SDan Gohman   encodeULEB128(UINT32_MAX, getStream());
310d934cb88SDan Gohman 
311d934cb88SDan Gohman   // The position where the section starts, for measuring its size.
312d934cb88SDan Gohman   Section.ContentsOffset = getStream().tell();
313d934cb88SDan Gohman 
314d934cb88SDan Gohman   // Custom sections in wasm also have a string identifier.
315d934cb88SDan Gohman   if (SectionId == wasm::WASM_SEC_CUSTOM) {
316b7787fd0SSam Clegg     assert(Name);
317b7787fd0SSam Clegg     writeString(StringRef(Name));
318d934cb88SDan Gohman   }
319d934cb88SDan Gohman }
320d934cb88SDan Gohman 
321d934cb88SDan Gohman // Now that the section is complete and we know how big it is, patch up the
322d934cb88SDan Gohman // section size field at the start of the section.
323d934cb88SDan Gohman void WasmObjectWriter::endSection(SectionBookkeeping &Section) {
324d934cb88SDan Gohman   uint64_t Size = getStream().tell() - Section.ContentsOffset;
325d934cb88SDan Gohman   if (uint32_t(Size) != Size)
326d934cb88SDan Gohman     report_fatal_error("section size does not fit in a uint32_t");
327d934cb88SDan Gohman 
328b7787fd0SSam Clegg   DEBUG(dbgs() << "endSection size=" << Size << "\n");
329d934cb88SDan Gohman 
330d934cb88SDan Gohman   // Write the final section size to the payload_len field, which follows
331d934cb88SDan Gohman   // the section id byte.
332d934cb88SDan Gohman   uint8_t Buffer[16];
33366a99e41SSam Clegg   unsigned SizeLen = encodeULEB128(Size, Buffer, 5);
334d934cb88SDan Gohman   assert(SizeLen == 5);
335d934cb88SDan Gohman   getStream().pwrite((char *)Buffer, SizeLen, Section.SizeOffset);
336d934cb88SDan Gohman }
337d934cb88SDan Gohman 
33818eafb6cSDan Gohman // Emit the Wasm header.
33918eafb6cSDan Gohman void WasmObjectWriter::writeHeader(const MCAssembler &Asm) {
3407ea5adffSDan Gohman   writeBytes(StringRef(wasm::WasmMagic, sizeof(wasm::WasmMagic)));
3417ea5adffSDan Gohman   writeLE32(wasm::WasmVersion);
34218eafb6cSDan Gohman }
34318eafb6cSDan Gohman 
34418eafb6cSDan Gohman void WasmObjectWriter::executePostLayoutBinding(MCAssembler &Asm,
34518eafb6cSDan Gohman                                                 const MCAsmLayout &Layout) {
34618eafb6cSDan Gohman }
34718eafb6cSDan Gohman 
34818eafb6cSDan Gohman void WasmObjectWriter::recordRelocation(MCAssembler &Asm,
34918eafb6cSDan Gohman                                         const MCAsmLayout &Layout,
35018eafb6cSDan Gohman                                         const MCFragment *Fragment,
35118eafb6cSDan Gohman                                         const MCFixup &Fixup, MCValue Target,
352ceecfe5bSRafael Espindola                                         uint64_t &FixedValue) {
353ceecfe5bSRafael Espindola   MCAsmBackend &Backend = Asm.getBackend();
354ceecfe5bSRafael Espindola   bool IsPCRel = Backend.getFixupKindInfo(Fixup.getKind()).Flags &
355ceecfe5bSRafael Espindola                  MCFixupKindInfo::FKF_IsPCRel;
356fe6414b0SSam Clegg   const auto &FixupSection = cast<MCSectionWasm>(*Fragment->getParent());
357d934cb88SDan Gohman   uint64_t C = Target.getConstant();
358d934cb88SDan Gohman   uint64_t FixupOffset = Layout.getFragmentOffset(Fragment) + Fixup.getOffset();
359d934cb88SDan Gohman   MCContext &Ctx = Asm.getContext();
360d934cb88SDan Gohman 
361bafe6902SSam Clegg   // The .init_array isn't translated as data, so don't do relocations in it.
362bafe6902SSam Clegg   if (FixupSection.getSectionName().startswith(".init_array"))
363bafe6902SSam Clegg     return;
364bafe6902SSam Clegg 
365b7a5469cSSam Clegg   // TODO(sbc): Add support for debug sections.
366b7a5469cSSam Clegg   if (FixupSection.getKind().isMetadata())
367b7a5469cSSam Clegg     return;
368b7a5469cSSam Clegg 
369d934cb88SDan Gohman   if (const MCSymbolRefExpr *RefB = Target.getSymB()) {
370d934cb88SDan Gohman     assert(RefB->getKind() == MCSymbolRefExpr::VK_None &&
371d934cb88SDan Gohman            "Should not have constructed this");
372d934cb88SDan Gohman 
373d934cb88SDan Gohman     // Let A, B and C being the components of Target and R be the location of
374d934cb88SDan Gohman     // the fixup. If the fixup is not pcrel, we want to compute (A - B + C).
375d934cb88SDan Gohman     // If it is pcrel, we want to compute (A - B + C - R).
376d934cb88SDan Gohman 
377d934cb88SDan Gohman     // In general, Wasm has no relocations for -B. It can only represent (A + C)
378d934cb88SDan Gohman     // or (A + C - R). If B = R + K and the relocation is not pcrel, we can
379d934cb88SDan Gohman     // replace B to implement it: (A - R - K + C)
380d934cb88SDan Gohman     if (IsPCRel) {
381d934cb88SDan Gohman       Ctx.reportError(
382d934cb88SDan Gohman           Fixup.getLoc(),
383d934cb88SDan Gohman           "No relocation available to represent this relative expression");
384d934cb88SDan Gohman       return;
385d934cb88SDan Gohman     }
386d934cb88SDan Gohman 
387d934cb88SDan Gohman     const auto &SymB = cast<MCSymbolWasm>(RefB->getSymbol());
388d934cb88SDan Gohman 
389d934cb88SDan Gohman     if (SymB.isUndefined()) {
390d934cb88SDan Gohman       Ctx.reportError(Fixup.getLoc(),
391d934cb88SDan Gohman                       Twine("symbol '") + SymB.getName() +
392d934cb88SDan Gohman                           "' can not be undefined in a subtraction expression");
393d934cb88SDan Gohman       return;
394d934cb88SDan Gohman     }
395d934cb88SDan Gohman 
396d934cb88SDan Gohman     assert(!SymB.isAbsolute() && "Should have been folded");
397d934cb88SDan Gohman     const MCSection &SecB = SymB.getSection();
398d934cb88SDan Gohman     if (&SecB != &FixupSection) {
399d934cb88SDan Gohman       Ctx.reportError(Fixup.getLoc(),
400d934cb88SDan Gohman                       "Cannot represent a difference across sections");
401d934cb88SDan Gohman       return;
402d934cb88SDan Gohman     }
403d934cb88SDan Gohman 
404d934cb88SDan Gohman     uint64_t SymBOffset = Layout.getSymbolOffset(SymB);
405d934cb88SDan Gohman     uint64_t K = SymBOffset - FixupOffset;
406d934cb88SDan Gohman     IsPCRel = true;
407d934cb88SDan Gohman     C -= K;
408d934cb88SDan Gohman   }
409d934cb88SDan Gohman 
410d934cb88SDan Gohman   // We either rejected the fixup or folded B into C at this point.
411d934cb88SDan Gohman   const MCSymbolRefExpr *RefA = Target.getSymA();
412d934cb88SDan Gohman   const auto *SymA = RefA ? cast<MCSymbolWasm>(&RefA->getSymbol()) : nullptr;
413d934cb88SDan Gohman 
414d934cb88SDan Gohman   if (SymA && SymA->isVariable()) {
415d934cb88SDan Gohman     const MCExpr *Expr = SymA->getVariableValue();
4166ad8f190SSam Clegg     const auto *Inner = cast<MCSymbolRefExpr>(Expr);
4176ad8f190SSam Clegg     if (Inner->getKind() == MCSymbolRefExpr::VK_WEAKREF)
4186ad8f190SSam Clegg       llvm_unreachable("weakref used in reloc not yet implemented");
419d934cb88SDan Gohman   }
420d934cb88SDan Gohman 
421d934cb88SDan Gohman   // Put any constant offset in an addend. Offsets can be negative, and
422d934cb88SDan Gohman   // LLVM expects wrapping, in contrast to wasm's immediates which can't
423d934cb88SDan Gohman   // be negative and don't wrap.
424d934cb88SDan Gohman   FixedValue = 0;
425d934cb88SDan Gohman 
4266ad8f190SSam Clegg   if (SymA)
427d934cb88SDan Gohman     SymA->setUsedInReloc();
428d934cb88SDan Gohman 
429ae03c1e7SSam Clegg   assert(!IsPCRel);
4309d24fb7fSSam Clegg   assert(SymA);
4319d24fb7fSSam Clegg 
432ae03c1e7SSam Clegg   unsigned Type = getRelocType(Target, Fixup);
433ae03c1e7SSam Clegg 
434d934cb88SDan Gohman   WasmRelocationEntry Rec(FixupOffset, SymA, C, Type, &FixupSection);
435b7787fd0SSam Clegg   DEBUG(dbgs() << "WasmReloc: " << Rec << "\n");
436d934cb88SDan Gohman 
437b7a5469cSSam Clegg   // Relocation other than R_WEBASSEMBLY_TYPE_INDEX_LEB are currently required
438b7a5469cSSam Clegg   // to be against a named symbol.
439b7a5469cSSam Clegg   // TODO(sbc): Add support for relocations against unnamed temporaries such
440b7a5469cSSam Clegg   // as those generated by llvm's `blockaddress`.
441b7a5469cSSam Clegg   // See: test/MC/WebAssembly/blockaddress.ll
442b7a5469cSSam Clegg   if (SymA->getName().empty() && Type != wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB)
443b7a5469cSSam Clegg     report_fatal_error("relocations against un-named temporaries are not yet "
444b7a5469cSSam Clegg                        "supported by wasm");
445b7a5469cSSam Clegg 
44612fd3da9SSam Clegg   if (FixupSection.isWasmData())
447d934cb88SDan Gohman     DataRelocations.push_back(Rec);
44812fd3da9SSam Clegg   else if (FixupSection.getKind().isText())
44912fd3da9SSam Clegg     CodeRelocations.push_back(Rec);
450b7a5469cSSam Clegg   else
45112fd3da9SSam Clegg     llvm_unreachable("unexpected section type");
452d934cb88SDan Gohman }
453d934cb88SDan Gohman 
454d934cb88SDan Gohman // Write X as an (unsigned) LEB value at offset Offset in Stream, padded
455d934cb88SDan Gohman // to allow patching.
456d934cb88SDan Gohman static void
457d934cb88SDan Gohman WritePatchableLEB(raw_pwrite_stream &Stream, uint32_t X, uint64_t Offset) {
458d934cb88SDan Gohman   uint8_t Buffer[5];
45966a99e41SSam Clegg   unsigned SizeLen = encodeULEB128(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 an signed LEB value at offset Offset in Stream, padded
465d934cb88SDan Gohman // to allow patching.
466d934cb88SDan Gohman static void
467d934cb88SDan Gohman WritePatchableSLEB(raw_pwrite_stream &Stream, int32_t X, uint64_t Offset) {
468d934cb88SDan Gohman   uint8_t Buffer[5];
46966a99e41SSam Clegg   unsigned SizeLen = encodeSLEB128(X, Buffer, 5);
470d934cb88SDan Gohman   assert(SizeLen == 5);
471d934cb88SDan Gohman   Stream.pwrite((char *)Buffer, SizeLen, Offset);
472d934cb88SDan Gohman }
473d934cb88SDan Gohman 
474d934cb88SDan Gohman // Write X as a plain integer value at offset Offset in Stream.
475d934cb88SDan Gohman static void WriteI32(raw_pwrite_stream &Stream, uint32_t X, uint64_t Offset) {
476d934cb88SDan Gohman   uint8_t Buffer[4];
477d934cb88SDan Gohman   support::endian::write32le(Buffer, X);
478d934cb88SDan Gohman   Stream.pwrite((char *)Buffer, sizeof(Buffer), Offset);
479d934cb88SDan Gohman }
480d934cb88SDan Gohman 
481aff1c4dfSSam Clegg static const MCSymbolWasm* ResolveSymbol(const MCSymbolWasm& Symbol) {
482aff1c4dfSSam Clegg   if (Symbol.isVariable()) {
483aff1c4dfSSam Clegg     const MCExpr *Expr = Symbol.getVariableValue();
484aff1c4dfSSam Clegg     auto *Inner = cast<MCSymbolRefExpr>(Expr);
485aff1c4dfSSam Clegg     return cast<MCSymbolWasm>(&Inner->getSymbol());
486aff1c4dfSSam Clegg   }
487aff1c4dfSSam Clegg   return &Symbol;
488aff1c4dfSSam Clegg }
489aff1c4dfSSam Clegg 
490d934cb88SDan Gohman // Compute a value to write into the code at the location covered
49160ec3034SSam Clegg // by RelEntry. This value isn't used by the static linker; it just serves
49260ec3034SSam Clegg // to make the object format more readable and more likely to be directly
49360ec3034SSam Clegg // useable.
4947c395943SSam Clegg uint32_t
4957c395943SSam Clegg WasmObjectWriter::getProvisionalValue(const WasmRelocationEntry &RelEntry) {
49660ec3034SSam Clegg   switch (RelEntry.Type) {
49760ec3034SSam Clegg   case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB:
498f9edbe95SSam Clegg   case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32: {
499f9edbe95SSam Clegg     // Provisional value is table address of the resolved symbol itself
500f9edbe95SSam Clegg     const MCSymbolWasm *Sym = ResolveSymbol(*RelEntry.Symbol);
501f9edbe95SSam Clegg     assert(Sym->isFunction());
502f9edbe95SSam Clegg     return TableIndices[Sym];
503f9edbe95SSam Clegg   }
50460ec3034SSam Clegg   case wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB:
5056c899ba6SSam Clegg     // Provisional value is same as the index
50660ec3034SSam Clegg     return getRelocationIndexValue(RelEntry);
5076c899ba6SSam Clegg   case wasm::R_WEBASSEMBLY_FUNCTION_INDEX_LEB:
5086c899ba6SSam Clegg   case wasm::R_WEBASSEMBLY_GLOBAL_INDEX_LEB:
5096c899ba6SSam Clegg     // Provisional value is function/global Wasm index
5106c899ba6SSam Clegg     if (!WasmIndices.count(RelEntry.Symbol))
5116c899ba6SSam Clegg       report_fatal_error("symbol not found in wasm index space: " +
5126c899ba6SSam Clegg                          RelEntry.Symbol->getName());
5136c899ba6SSam Clegg     return WasmIndices[RelEntry.Symbol];
51460ec3034SSam Clegg   case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB:
51560ec3034SSam Clegg   case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32:
51660ec3034SSam Clegg   case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB: {
517f9edbe95SSam Clegg     // Provisional value is address of the global
51860ec3034SSam Clegg     const MCSymbolWasm *Sym = ResolveSymbol(*RelEntry.Symbol);
519270ed1b3SSam Clegg     // For undefined symbols, use zero
520cd65f698SSam Clegg     if (!Sym->isDefined())
521270ed1b3SSam Clegg       return 0;
5226c899ba6SSam Clegg     const wasm::WasmDataReference &Ref = DataLocations[Sym];
5236c899ba6SSam Clegg     const WasmDataSegment &Segment = DataSegments[Ref.Segment];
524d934cb88SDan Gohman     // Ignore overflow. LLVM allows address arithmetic to silently wrap.
5256c899ba6SSam Clegg     return Segment.Offset + Ref.Offset + RelEntry.Addend;
52660ec3034SSam Clegg   }
52760ec3034SSam Clegg   default:
52860ec3034SSam Clegg     llvm_unreachable("invalid relocation type");
52960ec3034SSam Clegg   }
530d934cb88SDan Gohman }
531d934cb88SDan Gohman 
532759631c7SSam Clegg static void addData(SmallVectorImpl<char> &DataBytes,
53363ebb813SSam Clegg                     MCSectionWasm &DataSection) {
534759631c7SSam Clegg   DEBUG(errs() << "addData: " << DataSection.getSectionName() << "\n");
535759631c7SSam Clegg 
53663ebb813SSam Clegg   DataBytes.resize(alignTo(DataBytes.size(), DataSection.getAlignment()));
53763ebb813SSam Clegg 
538759631c7SSam Clegg   for (const MCFragment &Frag : DataSection) {
539759631c7SSam Clegg     if (Frag.hasInstructions())
540759631c7SSam Clegg       report_fatal_error("only data supported in data sections");
541759631c7SSam Clegg 
542759631c7SSam Clegg     if (auto *Align = dyn_cast<MCAlignFragment>(&Frag)) {
543759631c7SSam Clegg       if (Align->getValueSize() != 1)
544759631c7SSam Clegg         report_fatal_error("only byte values supported for alignment");
545759631c7SSam Clegg       // If nops are requested, use zeros, as this is the data section.
546759631c7SSam Clegg       uint8_t Value = Align->hasEmitNops() ? 0 : Align->getValue();
547759631c7SSam Clegg       uint64_t Size = std::min<uint64_t>(alignTo(DataBytes.size(),
548759631c7SSam Clegg                                                  Align->getAlignment()),
549759631c7SSam Clegg                                          DataBytes.size() +
550759631c7SSam Clegg                                              Align->getMaxBytesToEmit());
551759631c7SSam Clegg       DataBytes.resize(Size, Value);
552759631c7SSam Clegg     } else if (auto *Fill = dyn_cast<MCFillFragment>(&Frag)) {
553d707c370SRafael Espindola       int64_t Size;
554d707c370SRafael Espindola       if (!Fill->getSize().evaluateAsAbsolute(Size))
555d707c370SRafael Espindola         llvm_unreachable("The fill should be an assembler constant");
556d707c370SRafael Espindola       DataBytes.insert(DataBytes.end(), Size, Fill->getValue());
557759631c7SSam Clegg     } else {
558759631c7SSam Clegg       const auto &DataFrag = cast<MCDataFragment>(Frag);
559759631c7SSam Clegg       const SmallVectorImpl<char> &Contents = DataFrag.getContents();
560759631c7SSam Clegg 
561759631c7SSam Clegg       DataBytes.insert(DataBytes.end(), Contents.begin(), Contents.end());
562759631c7SSam Clegg     }
563759631c7SSam Clegg   }
564759631c7SSam Clegg 
565759631c7SSam Clegg   DEBUG(dbgs() << "addData -> " << DataBytes.size() << "\n");
566759631c7SSam Clegg }
567759631c7SSam Clegg 
56860ec3034SSam Clegg uint32_t
56960ec3034SSam Clegg WasmObjectWriter::getRelocationIndexValue(const WasmRelocationEntry &RelEntry) {
57060ec3034SSam Clegg   if (RelEntry.Type == wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB) {
571b7787fd0SSam Clegg     if (!TypeIndices.count(RelEntry.Symbol))
572b7787fd0SSam Clegg       report_fatal_error("symbol not found in type index space: " +
573b7787fd0SSam Clegg                          RelEntry.Symbol->getName());
574acd7d2b0SSam Clegg     return TypeIndices[RelEntry.Symbol];
575acd7d2b0SSam Clegg   }
57660ec3034SSam Clegg 
57760ec3034SSam Clegg   if (!SymbolIndices.count(RelEntry.Symbol))
5786c899ba6SSam Clegg     report_fatal_error("symbol not found in symbol index space: " +
57960ec3034SSam Clegg                        RelEntry.Symbol->getName());
58060ec3034SSam Clegg   return SymbolIndices[RelEntry.Symbol];
581acd7d2b0SSam Clegg }
582acd7d2b0SSam Clegg 
583d934cb88SDan Gohman // Apply the portions of the relocation records that we can handle ourselves
584d934cb88SDan Gohman // directly.
585acd7d2b0SSam Clegg void WasmObjectWriter::applyRelocations(
586acd7d2b0SSam Clegg     ArrayRef<WasmRelocationEntry> Relocations, uint64_t ContentsOffset) {
587acd7d2b0SSam Clegg   raw_pwrite_stream &Stream = getStream();
588d934cb88SDan Gohman   for (const WasmRelocationEntry &RelEntry : Relocations) {
589d934cb88SDan Gohman     uint64_t Offset = ContentsOffset +
590d934cb88SDan Gohman                       RelEntry.FixupSection->getSectionOffset() +
591d934cb88SDan Gohman                       RelEntry.Offset;
592d934cb88SDan Gohman 
593b7787fd0SSam Clegg     DEBUG(dbgs() << "applyRelocation: " << RelEntry << "\n");
59460ec3034SSam Clegg     uint32_t Value = getProvisionalValue(RelEntry);
59560ec3034SSam Clegg 
596acd7d2b0SSam Clegg     switch (RelEntry.Type) {
597acd7d2b0SSam Clegg     case wasm::R_WEBASSEMBLY_FUNCTION_INDEX_LEB:
5989d24fb7fSSam Clegg     case wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB:
59960ec3034SSam Clegg     case wasm::R_WEBASSEMBLY_GLOBAL_INDEX_LEB:
60060ec3034SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB:
601d934cb88SDan Gohman       WritePatchableLEB(Stream, Value, Offset);
602d934cb88SDan Gohman       break;
60360ec3034SSam Clegg     case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32:
60460ec3034SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32:
605d934cb88SDan Gohman       WriteI32(Stream, Value, Offset);
606d934cb88SDan Gohman       break;
60760ec3034SSam Clegg     case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB:
60860ec3034SSam Clegg     case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB:
60960ec3034SSam Clegg       WritePatchableSLEB(Stream, Value, Offset);
61060ec3034SSam Clegg       break;
611d934cb88SDan Gohman     default:
6129d24fb7fSSam Clegg       llvm_unreachable("invalid relocation type");
613d934cb88SDan Gohman     }
614d934cb88SDan Gohman   }
61518eafb6cSDan Gohman }
61618eafb6cSDan Gohman 
617acd7d2b0SSam Clegg // Write out the portions of the relocation records that the linker will
618970d02c4SDan Gohman // need to handle.
619acd7d2b0SSam Clegg void WasmObjectWriter::writeRelocations(
6207c395943SSam Clegg     ArrayRef<WasmRelocationEntry> Relocations) {
621acd7d2b0SSam Clegg   raw_pwrite_stream &Stream = getStream();
622acd7d2b0SSam Clegg   for (const WasmRelocationEntry& RelEntry : Relocations) {
623970d02c4SDan Gohman 
624acd7d2b0SSam Clegg     uint64_t Offset = RelEntry.Offset +
6257c395943SSam Clegg                       RelEntry.FixupSection->getSectionOffset();
626acd7d2b0SSam Clegg     uint32_t Index = getRelocationIndexValue(RelEntry);
627970d02c4SDan Gohman 
628acd7d2b0SSam Clegg     encodeULEB128(RelEntry.Type, Stream);
629970d02c4SDan Gohman     encodeULEB128(Offset, Stream);
630acd7d2b0SSam Clegg     encodeULEB128(Index, Stream);
631acd7d2b0SSam Clegg     if (RelEntry.hasAddend())
632acd7d2b0SSam Clegg       encodeSLEB128(RelEntry.Addend, Stream);
633970d02c4SDan Gohman   }
634970d02c4SDan Gohman }
635970d02c4SDan Gohman 
6369e15f359SSam Clegg void WasmObjectWriter::writeTypeSection(
637457fb0b4SSam Clegg     ArrayRef<WasmFunctionType> FunctionTypes) {
6389e15f359SSam Clegg   if (FunctionTypes.empty())
6399e15f359SSam Clegg     return;
6409e15f359SSam Clegg 
6419e15f359SSam Clegg   SectionBookkeeping Section;
6429e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_TYPE);
6439e15f359SSam Clegg 
6449e15f359SSam Clegg   encodeULEB128(FunctionTypes.size(), getStream());
6459e15f359SSam Clegg 
6469e15f359SSam Clegg   for (const WasmFunctionType &FuncTy : FunctionTypes) {
6479e15f359SSam Clegg     encodeSLEB128(wasm::WASM_TYPE_FUNC, getStream());
6489e15f359SSam Clegg     encodeULEB128(FuncTy.Params.size(), getStream());
6499e15f359SSam Clegg     for (wasm::ValType Ty : FuncTy.Params)
6509e15f359SSam Clegg       writeValueType(Ty);
6519e15f359SSam Clegg     encodeULEB128(FuncTy.Returns.size(), getStream());
6529e15f359SSam Clegg     for (wasm::ValType Ty : FuncTy.Returns)
6539e15f359SSam Clegg       writeValueType(Ty);
6549e15f359SSam Clegg   }
6559e15f359SSam Clegg 
6569e15f359SSam Clegg   endSection(Section);
6579e15f359SSam Clegg }
6589e15f359SSam Clegg 
6598defa952SSam Clegg void WasmObjectWriter::writeImportSection(ArrayRef<wasm::WasmImport> Imports,
660f950b24aSSam Clegg                                           uint32_t DataSize,
661f950b24aSSam Clegg                                           uint32_t NumElements) {
6629e15f359SSam Clegg   if (Imports.empty())
6639e15f359SSam Clegg     return;
6649e15f359SSam Clegg 
665f950b24aSSam Clegg   uint32_t NumPages = (DataSize + wasm::WasmPageSize - 1) / wasm::WasmPageSize;
666f950b24aSSam Clegg 
6679e15f359SSam Clegg   SectionBookkeeping Section;
6689e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_IMPORT);
6699e15f359SSam Clegg 
6709e15f359SSam Clegg   encodeULEB128(Imports.size(), getStream());
6718defa952SSam Clegg   for (const wasm::WasmImport &Import : Imports) {
6728defa952SSam Clegg     writeString(Import.Module);
6738defa952SSam Clegg     writeString(Import.Field);
6749e15f359SSam Clegg     encodeULEB128(Import.Kind, getStream());
6759e15f359SSam Clegg 
6769e15f359SSam Clegg     switch (Import.Kind) {
6779e15f359SSam Clegg     case wasm::WASM_EXTERNAL_FUNCTION:
6788defa952SSam Clegg       encodeULEB128(Import.SigIndex, getStream());
6799e15f359SSam Clegg       break;
6809e15f359SSam Clegg     case wasm::WASM_EXTERNAL_GLOBAL:
6818defa952SSam Clegg       encodeSLEB128(Import.Global.Type, getStream());
6828defa952SSam Clegg       encodeULEB128(uint32_t(Import.Global.Mutable), getStream());
6839e15f359SSam Clegg       break;
684f950b24aSSam Clegg     case wasm::WASM_EXTERNAL_MEMORY:
685f950b24aSSam Clegg       encodeULEB128(0, getStream()); // flags
686f950b24aSSam Clegg       encodeULEB128(NumPages, getStream()); // initial
687f950b24aSSam Clegg       break;
688f950b24aSSam Clegg     case wasm::WASM_EXTERNAL_TABLE:
6898defa952SSam Clegg       encodeSLEB128(Import.Table.ElemType, getStream());
690f950b24aSSam Clegg       encodeULEB128(0, getStream()); // flags
691f950b24aSSam Clegg       encodeULEB128(NumElements, getStream()); // initial
692f950b24aSSam Clegg       break;
6939e15f359SSam Clegg     default:
6949e15f359SSam Clegg       llvm_unreachable("unsupported import kind");
6959e15f359SSam Clegg     }
6969e15f359SSam Clegg   }
6979e15f359SSam Clegg 
6989e15f359SSam Clegg   endSection(Section);
6999e15f359SSam Clegg }
7009e15f359SSam Clegg 
701457fb0b4SSam Clegg void WasmObjectWriter::writeFunctionSection(ArrayRef<WasmFunction> Functions) {
7029e15f359SSam Clegg   if (Functions.empty())
7039e15f359SSam Clegg     return;
7049e15f359SSam Clegg 
7059e15f359SSam Clegg   SectionBookkeeping Section;
7069e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_FUNCTION);
7079e15f359SSam Clegg 
7089e15f359SSam Clegg   encodeULEB128(Functions.size(), getStream());
7099e15f359SSam Clegg   for (const WasmFunction &Func : Functions)
7109e15f359SSam Clegg     encodeULEB128(Func.Type, getStream());
7119e15f359SSam Clegg 
7129e15f359SSam Clegg   endSection(Section);
7139e15f359SSam Clegg }
7149e15f359SSam Clegg 
7157c395943SSam Clegg void WasmObjectWriter::writeGlobalSection() {
7169e15f359SSam Clegg   if (Globals.empty())
7179e15f359SSam Clegg     return;
7189e15f359SSam Clegg 
7199e15f359SSam Clegg   SectionBookkeeping Section;
7209e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_GLOBAL);
7219e15f359SSam Clegg 
7229e15f359SSam Clegg   encodeULEB128(Globals.size(), getStream());
7239e15f359SSam Clegg   for (const WasmGlobal &Global : Globals) {
7246e7f1826SSam Clegg     writeValueType(static_cast<wasm::ValType>(Global.Type.Type));
7256e7f1826SSam Clegg     write8(Global.Type.Mutable);
7269e15f359SSam Clegg 
7279e15f359SSam Clegg     write8(wasm::WASM_OPCODE_I32_CONST);
7286e7f1826SSam Clegg     encodeSLEB128(Global.InitialValue, getStream());
7299e15f359SSam Clegg     write8(wasm::WASM_OPCODE_END);
7309e15f359SSam Clegg   }
7319e15f359SSam Clegg 
7329e15f359SSam Clegg   endSection(Section);
7339e15f359SSam Clegg }
7349e15f359SSam Clegg 
7358defa952SSam Clegg void WasmObjectWriter::writeExportSection(ArrayRef<wasm::WasmExport> Exports) {
7369e15f359SSam Clegg   if (Exports.empty())
7379e15f359SSam Clegg     return;
7389e15f359SSam Clegg 
7399e15f359SSam Clegg   SectionBookkeeping Section;
7409e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_EXPORT);
7419e15f359SSam Clegg 
7429e15f359SSam Clegg   encodeULEB128(Exports.size(), getStream());
7438defa952SSam Clegg   for (const wasm::WasmExport &Export : Exports) {
7448defa952SSam Clegg     writeString(Export.Name);
7459e15f359SSam Clegg     encodeSLEB128(Export.Kind, getStream());
7469e15f359SSam Clegg     encodeULEB128(Export.Index, getStream());
7479e15f359SSam Clegg   }
7489e15f359SSam Clegg 
7499e15f359SSam Clegg   endSection(Section);
7509e15f359SSam Clegg }
7519e15f359SSam Clegg 
752457fb0b4SSam Clegg void WasmObjectWriter::writeElemSection(ArrayRef<uint32_t> TableElems) {
7539e15f359SSam Clegg   if (TableElems.empty())
7549e15f359SSam Clegg     return;
7559e15f359SSam Clegg 
7569e15f359SSam Clegg   SectionBookkeeping Section;
7579e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_ELEM);
7589e15f359SSam Clegg 
7599e15f359SSam Clegg   encodeULEB128(1, getStream()); // number of "segments"
7609e15f359SSam Clegg   encodeULEB128(0, getStream()); // the table index
7619e15f359SSam Clegg 
7629e15f359SSam Clegg   // init expr for starting offset
7639e15f359SSam Clegg   write8(wasm::WASM_OPCODE_I32_CONST);
76430e1bbc1SSam Clegg   encodeSLEB128(kInitialTableOffset, getStream());
7659e15f359SSam Clegg   write8(wasm::WASM_OPCODE_END);
7669e15f359SSam Clegg 
7679e15f359SSam Clegg   encodeULEB128(TableElems.size(), getStream());
7689e15f359SSam Clegg   for (uint32_t Elem : TableElems)
7699e15f359SSam Clegg     encodeULEB128(Elem, getStream());
7709e15f359SSam Clegg 
7719e15f359SSam Clegg   endSection(Section);
7729e15f359SSam Clegg }
7739e15f359SSam Clegg 
774457fb0b4SSam Clegg void WasmObjectWriter::writeCodeSection(const MCAssembler &Asm,
775457fb0b4SSam Clegg                                         const MCAsmLayout &Layout,
776457fb0b4SSam Clegg                                         ArrayRef<WasmFunction> Functions) {
7779e15f359SSam Clegg   if (Functions.empty())
7789e15f359SSam Clegg     return;
7799e15f359SSam Clegg 
7809e15f359SSam Clegg   SectionBookkeeping Section;
7819e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CODE);
7829e15f359SSam Clegg 
7839e15f359SSam Clegg   encodeULEB128(Functions.size(), getStream());
7849e15f359SSam Clegg 
7859e15f359SSam Clegg   for (const WasmFunction &Func : Functions) {
786fe6414b0SSam Clegg     auto &FuncSection = static_cast<MCSectionWasm &>(Func.Sym->getSection());
7879e15f359SSam Clegg 
7889e15f359SSam Clegg     int64_t Size = 0;
7899e15f359SSam Clegg     if (!Func.Sym->getSize()->evaluateAsAbsolute(Size, Layout))
7909e15f359SSam Clegg       report_fatal_error(".size expression must be evaluatable");
7919e15f359SSam Clegg 
7929e15f359SSam Clegg     encodeULEB128(Size, getStream());
793fe6414b0SSam Clegg     FuncSection.setSectionOffset(getStream().tell() - Section.ContentsOffset);
7949e15f359SSam Clegg     Asm.writeSectionData(&FuncSection, Layout);
7959e15f359SSam Clegg   }
7969e15f359SSam Clegg 
7979e15f359SSam Clegg   // Apply fixups.
798acd7d2b0SSam Clegg   applyRelocations(CodeRelocations, Section.ContentsOffset);
7999e15f359SSam Clegg 
8009e15f359SSam Clegg   endSection(Section);
8019e15f359SSam Clegg }
8029e15f359SSam Clegg 
8036c899ba6SSam Clegg void WasmObjectWriter::writeDataSection() {
8046c899ba6SSam Clegg   if (DataSegments.empty())
8057c395943SSam Clegg     return;
8069e15f359SSam Clegg 
8079e15f359SSam Clegg   SectionBookkeeping Section;
8089e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_DATA);
8099e15f359SSam Clegg 
8106c899ba6SSam Clegg   encodeULEB128(DataSegments.size(), getStream()); // count
8117c395943SSam Clegg 
8126c899ba6SSam Clegg   for (const WasmDataSegment &Segment : DataSegments) {
8139e15f359SSam Clegg     encodeULEB128(0, getStream()); // memory index
8149e15f359SSam Clegg     write8(wasm::WASM_OPCODE_I32_CONST);
8157c395943SSam Clegg     encodeSLEB128(Segment.Offset, getStream()); // offset
8169e15f359SSam Clegg     write8(wasm::WASM_OPCODE_END);
8177c395943SSam Clegg     encodeULEB128(Segment.Data.size(), getStream()); // size
8187c395943SSam Clegg     Segment.Section->setSectionOffset(getStream().tell() - Section.ContentsOffset);
8197c395943SSam Clegg     writeBytes(Segment.Data); // data
8207c395943SSam Clegg   }
8219e15f359SSam Clegg 
8229e15f359SSam Clegg   // Apply fixups.
8237c395943SSam Clegg   applyRelocations(DataRelocations, Section.ContentsOffset);
8249e15f359SSam Clegg 
8259e15f359SSam Clegg   endSection(Section);
8269e15f359SSam Clegg }
8279e15f359SSam Clegg 
828acd7d2b0SSam Clegg void WasmObjectWriter::writeCodeRelocSection() {
8299e15f359SSam Clegg   // See: https://github.com/WebAssembly/tool-conventions/blob/master/Linking.md
8309e15f359SSam Clegg   // for descriptions of the reloc sections.
8319e15f359SSam Clegg 
8329e15f359SSam Clegg   if (CodeRelocations.empty())
8339e15f359SSam Clegg     return;
8349e15f359SSam Clegg 
8359e15f359SSam Clegg   SectionBookkeeping Section;
8369e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CUSTOM, "reloc.CODE");
8379e15f359SSam Clegg 
8389e15f359SSam Clegg   encodeULEB128(wasm::WASM_SEC_CODE, getStream());
839acd7d2b0SSam Clegg   encodeULEB128(CodeRelocations.size(), getStream());
8409e15f359SSam Clegg 
8417c395943SSam Clegg   writeRelocations(CodeRelocations);
8429e15f359SSam Clegg 
8439e15f359SSam Clegg   endSection(Section);
8449e15f359SSam Clegg }
8459e15f359SSam Clegg 
8467c395943SSam Clegg void WasmObjectWriter::writeDataRelocSection() {
8479e15f359SSam Clegg   // See: https://github.com/WebAssembly/tool-conventions/blob/master/Linking.md
8489e15f359SSam Clegg   // for descriptions of the reloc sections.
8499e15f359SSam Clegg 
8509e15f359SSam Clegg   if (DataRelocations.empty())
8519e15f359SSam Clegg     return;
8529e15f359SSam Clegg 
8539e15f359SSam Clegg   SectionBookkeeping Section;
8549e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CUSTOM, "reloc.DATA");
8559e15f359SSam Clegg 
8569e15f359SSam Clegg   encodeULEB128(wasm::WASM_SEC_DATA, getStream());
8579e15f359SSam Clegg   encodeULEB128(DataRelocations.size(), getStream());
8589e15f359SSam Clegg 
8597c395943SSam Clegg   writeRelocations(DataRelocations);
8609e15f359SSam Clegg 
8619e15f359SSam Clegg   endSection(Section);
8629e15f359SSam Clegg }
8639e15f359SSam Clegg 
8649e15f359SSam Clegg void WasmObjectWriter::writeLinkingMetaDataSection(
8656c899ba6SSam Clegg     uint32_t DataSize, ArrayRef<wasm::WasmSymbolInfo> SymbolInfos,
866ea7caceeSSam Clegg     ArrayRef<std::pair<uint16_t, uint32_t>> InitFuncs,
867ea7caceeSSam Clegg     const std::map<StringRef, std::vector<WasmComdatEntry>> &Comdats) {
8689e15f359SSam Clegg   SectionBookkeeping Section;
8699e15f359SSam Clegg   startSection(Section, wasm::WASM_SEC_CUSTOM, "linking");
870b7787fd0SSam Clegg   SectionBookkeeping SubSection;
8719e15f359SSam Clegg 
8726c899ba6SSam Clegg   if (SymbolInfos.size() != 0) {
8736c899ba6SSam Clegg     startSection(SubSection, wasm::WASM_SYMBOL_TABLE);
8746c899ba6SSam Clegg     encodeULEB128(SymbolInfos.size(), getStream());
8756c899ba6SSam Clegg     for (const wasm::WasmSymbolInfo &Sym : SymbolInfos) {
8766c899ba6SSam Clegg       encodeULEB128(Sym.Kind, getStream());
8776c899ba6SSam Clegg       encodeULEB128(Sym.Flags, getStream());
8786c899ba6SSam Clegg       switch (Sym.Kind) {
8796c899ba6SSam Clegg       case wasm::WASM_SYMBOL_TYPE_FUNCTION:
8806c899ba6SSam Clegg       case wasm::WASM_SYMBOL_TYPE_GLOBAL:
8816c899ba6SSam Clegg         encodeULEB128(Sym.ElementIndex, getStream());
8826c899ba6SSam Clegg         if ((Sym.Flags & wasm::WASM_SYMBOL_UNDEFINED) == 0)
8836c899ba6SSam Clegg           writeString(Sym.Name);
8846c899ba6SSam Clegg         break;
8856c899ba6SSam Clegg       case wasm::WASM_SYMBOL_TYPE_DATA:
8866c899ba6SSam Clegg         writeString(Sym.Name);
8876c899ba6SSam Clegg         if ((Sym.Flags & wasm::WASM_SYMBOL_UNDEFINED) == 0) {
8886c899ba6SSam Clegg           encodeULEB128(Sym.DataRef.Segment, getStream());
8896c899ba6SSam Clegg           encodeULEB128(Sym.DataRef.Offset, getStream());
8906c899ba6SSam Clegg           encodeULEB128(Sym.DataRef.Size, getStream());
8916c899ba6SSam Clegg         }
8926c899ba6SSam Clegg         break;
8936c899ba6SSam Clegg       default:
8946c899ba6SSam Clegg         llvm_unreachable("unexpected kind");
8956c899ba6SSam Clegg       }
896b7787fd0SSam Clegg     }
897b7787fd0SSam Clegg     endSection(SubSection);
898b7787fd0SSam Clegg   }
8999e15f359SSam Clegg 
9009e1ade93SSam Clegg   if (DataSize > 0) {
9019e1ade93SSam Clegg     startSection(SubSection, wasm::WASM_DATA_SIZE);
9029e1ade93SSam Clegg     encodeULEB128(DataSize, getStream());
9039e1ade93SSam Clegg     endSection(SubSection);
9049e1ade93SSam Clegg   }
9059e1ade93SSam Clegg 
9066c899ba6SSam Clegg   if (DataSegments.size()) {
90763ebb813SSam Clegg     startSection(SubSection, wasm::WASM_SEGMENT_INFO);
9086c899ba6SSam Clegg     encodeULEB128(DataSegments.size(), getStream());
9096c899ba6SSam Clegg     for (const WasmDataSegment &Segment : DataSegments) {
910d95ed959SSam Clegg       writeString(Segment.Name);
91163ebb813SSam Clegg       encodeULEB128(Segment.Alignment, getStream());
91263ebb813SSam Clegg       encodeULEB128(Segment.Flags, getStream());
91363ebb813SSam Clegg     }
914d95ed959SSam Clegg     endSection(SubSection);
915d95ed959SSam Clegg   }
916d95ed959SSam Clegg 
917bafe6902SSam Clegg   if (!InitFuncs.empty()) {
918bafe6902SSam Clegg     startSection(SubSection, wasm::WASM_INIT_FUNCS);
919bafe6902SSam Clegg     encodeULEB128(InitFuncs.size(), getStream());
920bafe6902SSam Clegg     for (auto &StartFunc : InitFuncs) {
921bafe6902SSam Clegg       encodeULEB128(StartFunc.first, getStream()); // priority
922bafe6902SSam Clegg       encodeULEB128(StartFunc.second, getStream()); // function index
923bafe6902SSam Clegg     }
924bafe6902SSam Clegg     endSection(SubSection);
925bafe6902SSam Clegg   }
926bafe6902SSam Clegg 
927ea7caceeSSam Clegg   if (Comdats.size()) {
928ea7caceeSSam Clegg     startSection(SubSection, wasm::WASM_COMDAT_INFO);
929ea7caceeSSam Clegg     encodeULEB128(Comdats.size(), getStream());
930ea7caceeSSam Clegg     for (const auto &C : Comdats) {
931ea7caceeSSam Clegg       writeString(C.first);
932ea7caceeSSam Clegg       encodeULEB128(0, getStream()); // flags for future use
933ea7caceeSSam Clegg       encodeULEB128(C.second.size(), getStream());
934ea7caceeSSam Clegg       for (const WasmComdatEntry &Entry : C.second) {
935ea7caceeSSam Clegg         encodeULEB128(Entry.Kind, getStream());
936ea7caceeSSam Clegg         encodeULEB128(Entry.Index, getStream());
937ea7caceeSSam Clegg       }
938ea7caceeSSam Clegg     }
939ea7caceeSSam Clegg     endSection(SubSection);
940ea7caceeSSam Clegg   }
941ea7caceeSSam 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();
974d934cb88SDan Gohman 
975d934cb88SDan Gohman   // Collect information from the available symbols.
976d934cb88SDan Gohman   SmallVector<WasmFunction, 4> Functions;
977d934cb88SDan Gohman   SmallVector<uint32_t, 4> TableElems;
9788defa952SSam Clegg   SmallVector<wasm::WasmImport, 4> Imports;
9798defa952SSam Clegg   SmallVector<wasm::WasmExport, 4> Exports;
9806c899ba6SSam Clegg   SmallVector<wasm::WasmSymbolInfo, 4> SymbolInfos;
981bafe6902SSam Clegg   SmallVector<std::pair<uint16_t, uint32_t>, 2> InitFuncs;
982ea7caceeSSam Clegg   std::map<StringRef, std::vector<WasmComdatEntry>> Comdats;
9836c899ba6SSam Clegg   unsigned NumSymbols = 0;
9847c395943SSam Clegg   uint32_t DataSize = 0;
985d934cb88SDan Gohman 
9866c899ba6SSam Clegg   auto AddSymbol = [&](const MCSymbolWasm &WS) {
9876c899ba6SSam Clegg     uint32_t Flags = 0;
9886c899ba6SSam Clegg     if (WS.isWeak())
9896c899ba6SSam Clegg       Flags |= wasm::WASM_SYMBOL_BINDING_WEAK;
9906c899ba6SSam Clegg     if (WS.isHidden())
9916c899ba6SSam Clegg       Flags |= wasm::WASM_SYMBOL_VISIBILITY_HIDDEN;
9926c899ba6SSam Clegg     if (!WS.isExternal() && WS.isDefined())
9936c899ba6SSam Clegg       Flags |= wasm::WASM_SYMBOL_BINDING_LOCAL;
9946c899ba6SSam Clegg     if (WS.isUndefined())
9956c899ba6SSam Clegg       Flags |= wasm::WASM_SYMBOL_UNDEFINED;
9966c899ba6SSam Clegg 
9976c899ba6SSam Clegg     wasm::WasmSymbolInfo Info;
9986c899ba6SSam Clegg     Info.Name = WS.getName();
9996c899ba6SSam Clegg     Info.Kind = WS.getType();
10006c899ba6SSam Clegg     Info.Flags = Flags;
10016c899ba6SSam Clegg     if (!WS.isData())
10026c899ba6SSam Clegg       Info.ElementIndex = WasmIndices[&WS];
10036c899ba6SSam Clegg     else if (WS.isDefined())
10046c899ba6SSam Clegg       Info.DataRef = DataLocations[&WS];
10056c899ba6SSam Clegg     SymbolInfos.emplace_back(Info);
10066c899ba6SSam Clegg     SymbolIndices[&WS] = NumSymbols++;
10076c899ba6SSam Clegg   };
10086c899ba6SSam Clegg 
1009f950b24aSSam Clegg   // For now, always emit the memory import, since loads and stores are not
1010f950b24aSSam Clegg   // valid without it. In the future, we could perhaps be more clever and omit
1011f950b24aSSam Clegg   // it if there are no loads or stores.
1012f950b24aSSam Clegg   MCSymbolWasm *MemorySym =
1013f950b24aSSam Clegg       cast<MCSymbolWasm>(Ctx.getOrCreateSymbol("__linear_memory"));
10148defa952SSam Clegg   wasm::WasmImport MemImport;
10158defa952SSam Clegg   MemImport.Module = MemorySym->getModuleName();
10168defa952SSam Clegg   MemImport.Field = MemorySym->getName();
1017f950b24aSSam Clegg   MemImport.Kind = wasm::WASM_EXTERNAL_MEMORY;
1018f950b24aSSam Clegg   Imports.push_back(MemImport);
1019f950b24aSSam Clegg 
1020f950b24aSSam Clegg   // For now, always emit the table section, since indirect calls are not
1021f950b24aSSam Clegg   // valid without it. In the future, we could perhaps be more clever and omit
1022f950b24aSSam Clegg   // it if there are no indirect calls.
1023f950b24aSSam Clegg   MCSymbolWasm *TableSym =
1024f950b24aSSam Clegg       cast<MCSymbolWasm>(Ctx.getOrCreateSymbol("__indirect_function_table"));
10258defa952SSam Clegg   wasm::WasmImport TableImport;
10268defa952SSam Clegg   TableImport.Module = TableSym->getModuleName();
10278defa952SSam Clegg   TableImport.Field = TableSym->getName();
1028f950b24aSSam Clegg   TableImport.Kind = wasm::WASM_EXTERNAL_TABLE;
10298defa952SSam Clegg   TableImport.Table.ElemType = wasm::WASM_TYPE_ANYFUNC;
1030f950b24aSSam Clegg   Imports.push_back(TableImport);
1031f950b24aSSam Clegg 
103232ce5ca0SDan Gohman   // Populate FunctionTypeIndices and Imports.
103332ce5ca0SDan Gohman   for (const MCSymbol &S : Asm.symbols()) {
103432ce5ca0SDan Gohman     const auto &WS = static_cast<const MCSymbolWasm &>(S);
103532ce5ca0SDan Gohman 
103632ce5ca0SDan Gohman     // Register types for all functions, including those with private linkage
10379f3fe42eSSam Clegg     // (because wasm always needs a type signature).
103832ce5ca0SDan Gohman     if (WS.isFunction())
103932ce5ca0SDan Gohman       registerFunctionType(WS);
104032ce5ca0SDan Gohman 
104132ce5ca0SDan Gohman     if (WS.isTemporary())
104232ce5ca0SDan Gohman       continue;
104332ce5ca0SDan Gohman 
104432ce5ca0SDan Gohman     // If the symbol is not defined in this translation unit, import it.
10456c899ba6SSam Clegg     if (!WS.isDefined() && !WS.isComdat()) {
10466c899ba6SSam Clegg       if (WS.isFunction()) {
10478defa952SSam Clegg         wasm::WasmImport Import;
10488defa952SSam Clegg         Import.Module = WS.getModuleName();
10498defa952SSam Clegg         Import.Field = WS.getName();
105032ce5ca0SDan Gohman         Import.Kind = wasm::WASM_EXTERNAL_FUNCTION;
10518defa952SSam Clegg         Import.SigIndex = getFunctionType(WS);
10526c899ba6SSam Clegg         Imports.push_back(Import);
10536c899ba6SSam Clegg         WasmIndices[&WS] = NumFunctionImports++;
10546c899ba6SSam Clegg       } else if (WS.isGlobal()) {
10556c899ba6SSam Clegg         wasm::WasmImport Import;
10566c899ba6SSam Clegg         Import.Module = WS.getModuleName();
10576c899ba6SSam Clegg         Import.Field = WS.getName();
105832ce5ca0SDan Gohman         Import.Kind = wasm::WASM_EXTERNAL_GLOBAL;
10596c899ba6SSam Clegg         Import.Global = WS.getGlobalType();
10606c899ba6SSam Clegg         Imports.push_back(Import);
10616c899ba6SSam Clegg         WasmIndices[&WS] = NumGlobalImports++;
106232ce5ca0SDan Gohman       }
106332ce5ca0SDan Gohman 
10646c899ba6SSam Clegg       // TODO(ncw) We shouldn't be adding the symbol to the symbol table here!
10656c899ba6SSam Clegg       // Instead it should be done by removing the "if (WS.isDefined())" block
10666c899ba6SSam Clegg       // in the big loop below (line ~1284).  However - that would reorder all
10676c899ba6SSam Clegg       // the symbols and thus require all the tests to be updated.  I think it's
10686c899ba6SSam Clegg       // better to make that change therefore in a future commit, to isolate
10696c899ba6SSam Clegg       // each test update from the change that caused it.
10706c899ba6SSam Clegg       AddSymbol(WS);
107132ce5ca0SDan Gohman     }
107232ce5ca0SDan Gohman   }
107332ce5ca0SDan Gohman 
1074759631c7SSam Clegg   for (MCSection &Sec : Asm) {
1075759631c7SSam Clegg     auto &Section = static_cast<MCSectionWasm &>(Sec);
107612fd3da9SSam Clegg     if (!Section.isWasmData())
1077759631c7SSam Clegg       continue;
1078759631c7SSam Clegg 
1079bafe6902SSam Clegg     // .init_array sections are handled specially elsewhere.
1080bafe6902SSam Clegg     if (cast<MCSectionWasm>(Sec).getSectionName().startswith(".init_array"))
1081bafe6902SSam Clegg       continue;
1082bafe6902SSam Clegg 
1083329e76d5SSam Clegg     uint32_t SegmentIndex = DataSegments.size();
1084759631c7SSam Clegg     DataSize = alignTo(DataSize, Section.getAlignment());
1085759631c7SSam Clegg     DataSegments.emplace_back();
1086759631c7SSam Clegg     WasmDataSegment &Segment = DataSegments.back();
1087d95ed959SSam Clegg     Segment.Name = Section.getSectionName();
1088759631c7SSam Clegg     Segment.Offset = DataSize;
1089759631c7SSam Clegg     Segment.Section = &Section;
109063ebb813SSam Clegg     addData(Segment.Data, Section);
109163ebb813SSam Clegg     Segment.Alignment = Section.getAlignment();
109263ebb813SSam Clegg     Segment.Flags = 0;
1093759631c7SSam Clegg     DataSize += Segment.Data.size();
10946c899ba6SSam Clegg     Section.setSegmentIndex(SegmentIndex);
1095ea7caceeSSam Clegg 
1096ea7caceeSSam Clegg     if (const MCSymbolWasm *C = Section.getGroup()) {
1097ea7caceeSSam Clegg       Comdats[C->getName()].emplace_back(
1098329e76d5SSam Clegg           WasmComdatEntry{wasm::WASM_COMDAT_DATA, SegmentIndex});
1099ea7caceeSSam Clegg     }
1100759631c7SSam Clegg   }
1101759631c7SSam Clegg 
1102b7787fd0SSam Clegg   // Handle regular defined and undefined symbols.
1103d934cb88SDan Gohman   for (const MCSymbol &S : Asm.symbols()) {
1104d934cb88SDan Gohman     // Ignore unnamed temporary symbols, which aren't ever exported, imported,
1105d934cb88SDan Gohman     // or used in relocations.
1106d934cb88SDan Gohman     if (S.isTemporary() && S.getName().empty())
1107d934cb88SDan Gohman       continue;
1108b7787fd0SSam Clegg 
1109d934cb88SDan Gohman     const auto &WS = static_cast<const MCSymbolWasm &>(S);
1110b7787fd0SSam Clegg     DEBUG(dbgs() << "MCSymbol: '" << S << "'"
1111329e76d5SSam Clegg                  << " isDefined=" << S.isDefined()
1112329e76d5SSam Clegg                  << " isExternal=" << S.isExternal()
1113329e76d5SSam Clegg                  << " isTemporary=" << S.isTemporary()
1114b7787fd0SSam Clegg                  << " isFunction=" << WS.isFunction()
1115b7787fd0SSam Clegg                  << " isWeak=" << WS.isWeak()
1116a2b35dacSSam Clegg                  << " isHidden=" << WS.isHidden()
1117b7787fd0SSam Clegg                  << " isVariable=" << WS.isVariable() << "\n");
1118b7787fd0SSam Clegg 
11195e3d33a7SSam Clegg     if (WS.isVariable())
11205e3d33a7SSam Clegg       continue;
11216c899ba6SSam Clegg     if (WS.isComdat() && !WS.isDefined())
11226c899ba6SSam Clegg       continue;
1123b7787fd0SSam Clegg 
1124d934cb88SDan Gohman     if (WS.isFunction()) {
11256c899ba6SSam Clegg       unsigned Index;
1126cd65f698SSam Clegg       if (WS.isDefined()) {
1127b7787fd0SSam Clegg         if (WS.getOffset() != 0)
1128b7787fd0SSam Clegg           report_fatal_error(
1129b7787fd0SSam Clegg               "function sections must contain one function each");
1130b7787fd0SSam Clegg 
1131b7787fd0SSam Clegg         if (WS.getSize() == 0)
1132b7787fd0SSam Clegg           report_fatal_error(
1133b7787fd0SSam Clegg               "function symbols must have a size set with .size");
1134b7787fd0SSam Clegg 
11356c899ba6SSam Clegg         // A definition. Write out the function body.
11369f3fe42eSSam Clegg         Index = NumFunctionImports + Functions.size();
1137d934cb88SDan Gohman         WasmFunction Func;
11385e3d33a7SSam Clegg         Func.Type = getFunctionType(WS);
1139d934cb88SDan Gohman         Func.Sym = &WS;
11406c899ba6SSam Clegg         WasmIndices[&WS] = Index;
1141d934cb88SDan Gohman         Functions.push_back(Func);
11426c899ba6SSam Clegg 
11436c899ba6SSam Clegg         auto &Section = static_cast<MCSectionWasm &>(WS.getSection());
11446c899ba6SSam Clegg         if (const MCSymbolWasm *C = Section.getGroup()) {
11456c899ba6SSam Clegg           Comdats[C->getName()].emplace_back(
11466c899ba6SSam Clegg               WasmComdatEntry{wasm::WASM_COMDAT_FUNCTION, Index});
11476c899ba6SSam Clegg         }
1148d934cb88SDan Gohman       } else {
1149d934cb88SDan Gohman         // An import; the index was assigned above.
11506c899ba6SSam Clegg         Index = WasmIndices.find(&WS)->second;
1151d934cb88SDan Gohman       }
1152d934cb88SDan Gohman 
11535e3d33a7SSam Clegg       DEBUG(dbgs() << "  -> function index: " << Index << "\n");
11546c899ba6SSam Clegg     } else if (WS.isData()) {
1155c38e947eSSam Clegg       if (WS.isTemporary() && !WS.getSize())
1156c38e947eSSam Clegg         continue;
1157c38e947eSSam Clegg 
11586c899ba6SSam Clegg       if (!WS.isDefined()) {
11596c899ba6SSam Clegg         DEBUG(dbgs() << "  -> segment index: -1");
1160fe6414b0SSam Clegg         continue;
11616c899ba6SSam Clegg       }
1162fe6414b0SSam Clegg 
1163d934cb88SDan Gohman       if (!WS.getSize())
1164c38e947eSSam Clegg         report_fatal_error("data symbols must have a size set with .size: " +
1165c38e947eSSam Clegg                            WS.getName());
1166d934cb88SDan Gohman 
1167d934cb88SDan Gohman       int64_t Size = 0;
1168d934cb88SDan Gohman       if (!WS.getSize()->evaluateAsAbsolute(Size, Layout))
1169d934cb88SDan Gohman         report_fatal_error(".size expression must be evaluatable");
1170d934cb88SDan Gohman 
1171759631c7SSam Clegg       auto &DataSection = static_cast<MCSectionWasm &>(WS.getSection());
1172ea7caceeSSam Clegg       assert(DataSection.isWasmData());
11737c395943SSam Clegg 
11746c899ba6SSam Clegg       // For each data symbol, export it in the symtab as a reference to the
11756c899ba6SSam Clegg       // corresponding Wasm data segment.
11766c899ba6SSam Clegg       wasm::WasmDataReference Ref = wasm::WasmDataReference{
11776c899ba6SSam Clegg           DataSection.getSegmentIndex(),
11786c899ba6SSam Clegg           static_cast<uint32_t>(Layout.getSymbolOffset(WS)),
11796c899ba6SSam Clegg           static_cast<uint32_t>(Size)};
11806c899ba6SSam Clegg       DataLocations[&WS] = Ref;
11816c899ba6SSam Clegg       DEBUG(dbgs() << "  -> segment index: " << Ref.Segment);
11826c899ba6SSam Clegg     } else {
11836c899ba6SSam Clegg       // A "true" Wasm global (currently just __stack_pointer)
1184*545932beSEric Christopher       if (WS.isDefined())
11856c899ba6SSam Clegg         report_fatal_error("don't yet support defined globals");
11866c899ba6SSam Clegg 
1187*545932beSEric Christopher       // An import; the index was assigned above
1188*545932beSEric Christopher       DEBUG(dbgs() << "  -> global index: " << WasmIndices.find(&WS)->second
1189*545932beSEric Christopher                    << "\n");
1190d934cb88SDan Gohman     }
11916c899ba6SSam Clegg 
11926c899ba6SSam Clegg     if (WS.isDefined())
11936c899ba6SSam Clegg       AddSymbol(WS);
1194d934cb88SDan Gohman   }
1195d934cb88SDan Gohman 
11965e3d33a7SSam Clegg   // Handle weak aliases. We need to process these in a separate pass because
11975e3d33a7SSam Clegg   // we need to have processed the target of the alias before the alias itself
11985e3d33a7SSam Clegg   // and the symbols are not necessarily ordered in this way.
1199b7787fd0SSam Clegg   for (const MCSymbol &S : Asm.symbols()) {
1200b7787fd0SSam Clegg     if (!S.isVariable())
1201b7787fd0SSam Clegg       continue;
120231a2c809SSam Clegg 
1203cd65f698SSam Clegg     assert(S.isDefined());
1204b7787fd0SSam Clegg 
12055e3d33a7SSam Clegg     // Find the target symbol of this weak alias and export that index
1206aff1c4dfSSam Clegg     const auto &WS = static_cast<const MCSymbolWasm &>(S);
1207aff1c4dfSSam Clegg     const MCSymbolWasm *ResolvedSym = ResolveSymbol(WS);
12085e3d33a7SSam Clegg     DEBUG(dbgs() << WS.getName() << ": weak alias of '" << *ResolvedSym << "'\n");
1209b7787fd0SSam Clegg 
12106c899ba6SSam Clegg     if (WS.isFunction()) {
12116c899ba6SSam Clegg       assert(WasmIndices.count(ResolvedSym) > 0);
12126c899ba6SSam Clegg       uint32_t WasmIndex = WasmIndices.find(ResolvedSym)->second;
12136c899ba6SSam Clegg       WasmIndices[&WS] = WasmIndex;
12146c899ba6SSam Clegg       DEBUG(dbgs() << "  -> index:" << WasmIndex << "\n");
12156c899ba6SSam Clegg     } else if (WS.isData()) {
12166c899ba6SSam Clegg       assert(DataLocations.count(ResolvedSym) > 0);
12176c899ba6SSam Clegg       const wasm::WasmDataReference &Ref =
12186c899ba6SSam Clegg           DataLocations.find(ResolvedSym)->second;
12196c899ba6SSam Clegg       DataLocations[&WS] = Ref;
12206c899ba6SSam Clegg       DEBUG(dbgs() << "  -> index:" << Ref.Segment << "\n");
12216c899ba6SSam Clegg     } else {
12226c899ba6SSam Clegg       report_fatal_error("don't yet support global aliases");
12236c899ba6SSam Clegg     }
122431a2c809SSam Clegg 
12256c899ba6SSam Clegg     AddSymbol(WS);
1226b7787fd0SSam Clegg   }
1227b7787fd0SSam Clegg 
12286006e091SSam Clegg   {
12296006e091SSam Clegg     auto HandleReloc = [&](const WasmRelocationEntry &Rel) {
1230f9edbe95SSam Clegg       // Functions referenced by a relocation need to put in the table.  This is
1231f9edbe95SSam Clegg       // purely to make the object file's provisional values readable, and is
1232f9edbe95SSam Clegg       // ignored by the linker, which re-calculates the relocations itself.
1233f9edbe95SSam Clegg       if (Rel.Type != wasm::R_WEBASSEMBLY_TABLE_INDEX_I32 &&
1234f9edbe95SSam Clegg           Rel.Type != wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB)
1235f9edbe95SSam Clegg         return;
1236f9edbe95SSam Clegg       assert(Rel.Symbol->isFunction());
1237f9edbe95SSam Clegg       const MCSymbolWasm &WS = *ResolveSymbol(*Rel.Symbol);
12386c899ba6SSam Clegg       uint32_t FunctionIndex = WasmIndices.find(&WS)->second;
1239f9edbe95SSam Clegg       uint32_t TableIndex = TableElems.size() + kInitialTableOffset;
1240f9edbe95SSam Clegg       if (TableIndices.try_emplace(&WS, TableIndex).second) {
1241329e76d5SSam Clegg         DEBUG(dbgs() << "  -> adding " << WS.getName()
1242f9edbe95SSam Clegg                      << " to table: " << TableIndex << "\n");
12436c899ba6SSam Clegg         TableElems.push_back(FunctionIndex);
12446006e091SSam Clegg         registerFunctionType(WS);
12456006e091SSam Clegg       }
12466006e091SSam Clegg     };
1247970d02c4SDan Gohman 
12486006e091SSam Clegg     for (const WasmRelocationEntry &RelEntry : CodeRelocations)
12496006e091SSam Clegg       HandleReloc(RelEntry);
12506006e091SSam Clegg     for (const WasmRelocationEntry &RelEntry : DataRelocations)
12516006e091SSam Clegg       HandleReloc(RelEntry);
1252d934cb88SDan Gohman   }
1253d934cb88SDan Gohman 
1254bafe6902SSam Clegg   // Translate .init_array section contents into start functions.
1255bafe6902SSam Clegg   for (const MCSection &S : Asm) {
1256bafe6902SSam Clegg     const auto &WS = static_cast<const MCSectionWasm &>(S);
1257bafe6902SSam Clegg     if (WS.getSectionName().startswith(".fini_array"))
1258bafe6902SSam Clegg       report_fatal_error(".fini_array sections are unsupported");
1259bafe6902SSam Clegg     if (!WS.getSectionName().startswith(".init_array"))
1260bafe6902SSam Clegg       continue;
1261bafe6902SSam Clegg     if (WS.getFragmentList().empty())
1262bafe6902SSam Clegg       continue;
1263bafe6902SSam Clegg     if (WS.getFragmentList().size() != 2)
1264bafe6902SSam Clegg       report_fatal_error("only one .init_array section fragment supported");
1265bafe6902SSam Clegg     const MCFragment &AlignFrag = *WS.begin();
1266bafe6902SSam Clegg     if (AlignFrag.getKind() != MCFragment::FT_Align)
1267bafe6902SSam Clegg       report_fatal_error(".init_array section should be aligned");
1268bafe6902SSam Clegg     if (cast<MCAlignFragment>(AlignFrag).getAlignment() != (is64Bit() ? 8 : 4))
1269bafe6902SSam Clegg       report_fatal_error(".init_array section should be aligned for pointers");
1270bafe6902SSam Clegg     const MCFragment &Frag = *std::next(WS.begin());
1271bafe6902SSam Clegg     if (Frag.hasInstructions() || Frag.getKind() != MCFragment::FT_Data)
1272bafe6902SSam Clegg       report_fatal_error("only data supported in .init_array section");
1273bafe6902SSam Clegg     uint16_t Priority = UINT16_MAX;
1274bafe6902SSam Clegg     if (WS.getSectionName().size() != 11) {
1275bafe6902SSam Clegg       if (WS.getSectionName()[11] != '.')
1276bafe6902SSam Clegg         report_fatal_error(".init_array section priority should start with '.'");
1277bafe6902SSam Clegg       if (WS.getSectionName().substr(12).getAsInteger(10, Priority))
1278bafe6902SSam Clegg         report_fatal_error("invalid .init_array section priority");
1279bafe6902SSam Clegg     }
1280bafe6902SSam Clegg     const auto &DataFrag = cast<MCDataFragment>(Frag);
1281bafe6902SSam Clegg     const SmallVectorImpl<char> &Contents = DataFrag.getContents();
1282bafe6902SSam Clegg     for (const uint8_t *p = (const uint8_t *)Contents.data(),
1283bafe6902SSam Clegg                      *end = (const uint8_t *)Contents.data() + Contents.size();
1284bafe6902SSam Clegg          p != end; ++p) {
1285bafe6902SSam Clegg       if (*p != 0)
1286bafe6902SSam Clegg         report_fatal_error("non-symbolic data in .init_array section");
1287bafe6902SSam Clegg     }
1288bafe6902SSam Clegg     for (const MCFixup &Fixup : DataFrag.getFixups()) {
1289bafe6902SSam Clegg       assert(Fixup.getKind() == MCFixup::getKindForSize(is64Bit() ? 8 : 4, false));
1290bafe6902SSam Clegg       const MCExpr *Expr = Fixup.getValue();
1291bafe6902SSam Clegg       auto *Sym = dyn_cast<MCSymbolRefExpr>(Expr);
1292bafe6902SSam Clegg       if (!Sym)
1293bafe6902SSam Clegg         report_fatal_error("fixups in .init_array should be symbol references");
1294bafe6902SSam Clegg       if (Sym->getKind() != MCSymbolRefExpr::VK_WebAssembly_FUNCTION)
1295bafe6902SSam Clegg         report_fatal_error("symbols in .init_array should be for functions");
1296bafe6902SSam Clegg       auto I = SymbolIndices.find(cast<MCSymbolWasm>(&Sym->getSymbol()));
1297bafe6902SSam Clegg       if (I == SymbolIndices.end())
1298bafe6902SSam Clegg         report_fatal_error("symbols in .init_array should be defined");
1299bafe6902SSam Clegg       uint32_t Index = I->second;
1300bafe6902SSam Clegg       InitFuncs.push_back(std::make_pair(Priority, Index));
1301bafe6902SSam Clegg     }
1302bafe6902SSam Clegg   }
1303bafe6902SSam Clegg 
130418eafb6cSDan Gohman   // Write out the Wasm header.
130518eafb6cSDan Gohman   writeHeader(Asm);
130618eafb6cSDan Gohman 
13079e15f359SSam Clegg   writeTypeSection(FunctionTypes);
1308f950b24aSSam Clegg   writeImportSection(Imports, DataSize, TableElems.size());
13099e15f359SSam Clegg   writeFunctionSection(Functions);
1310f950b24aSSam Clegg   // Skip the "table" section; we import the table instead.
1311f950b24aSSam Clegg   // Skip the "memory" section; we import the memory instead.
13127c395943SSam Clegg   writeGlobalSection();
13139e15f359SSam Clegg   writeExportSection(Exports);
13149e15f359SSam Clegg   writeElemSection(TableElems);
1315acd7d2b0SSam Clegg   writeCodeSection(Asm, Layout, Functions);
13166c899ba6SSam Clegg   writeDataSection();
1317acd7d2b0SSam Clegg   writeCodeRelocSection();
13187c395943SSam Clegg   writeDataRelocSection();
13196c899ba6SSam Clegg   writeLinkingMetaDataSection(DataSize, SymbolInfos, InitFuncs, Comdats);
1320970d02c4SDan Gohman 
1321d934cb88SDan Gohman   // TODO: Translate the .comment section to the output.
1322d934cb88SDan Gohman   // TODO: Translate debug sections to the output.
132318eafb6cSDan Gohman }
132418eafb6cSDan Gohman 
132560fbc7ccSLang Hames std::unique_ptr<MCObjectWriter>
13261301a878SLang Hames llvm::createWasmObjectWriter(std::unique_ptr<MCWasmObjectTargetWriter> MOTW,
132718eafb6cSDan Gohman                              raw_pwrite_stream &OS) {
13280917c9e4SDan Gohman   return llvm::make_unique<WasmObjectWriter>(std::move(MOTW), OS);
132918eafb6cSDan Gohman }
1330