1 //===- WasmObjectFile.cpp - Wasm object file implementation ---------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "llvm/ADT/ArrayRef.h"
11 #include "llvm/ADT/DenseSet.h"
12 #include "llvm/ADT/STLExtras.h"
13 #include "llvm/ADT/StringRef.h"
14 #include "llvm/ADT/StringSet.h"
15 #include "llvm/ADT/Triple.h"
16 #include "llvm/BinaryFormat/Wasm.h"
17 #include "llvm/MC/SubtargetFeature.h"
18 #include "llvm/Object/Binary.h"
19 #include "llvm/Object/Error.h"
20 #include "llvm/Object/ObjectFile.h"
21 #include "llvm/Object/SymbolicFile.h"
22 #include "llvm/Object/Wasm.h"
23 #include "llvm/Support/Endian.h"
24 #include "llvm/Support/Error.h"
25 #include "llvm/Support/ErrorHandling.h"
26 #include "llvm/Support/LEB128.h"
31 #include <system_error>
33 #define DEBUG_TYPE "wasm-object"
36 using namespace object;
38 Expected<std::unique_ptr<WasmObjectFile>>
39 ObjectFile::createWasmObjectFile(MemoryBufferRef Buffer) {
40 Error Err = Error::success();
41 auto ObjectFile = llvm::make_unique<WasmObjectFile>(Buffer, Err);
43 return std::move(Err);
45 return std::move(ObjectFile);
48 #define VARINT7_MAX ((1<<7)-1)
49 #define VARINT7_MIN (-(1<<7))
50 #define VARUINT7_MAX (1<<7)
51 #define VARUINT1_MAX (1)
53 static uint8_t readUint8(const uint8_t *&Ptr) { return *Ptr++; }
55 static uint32_t readUint32(const uint8_t *&Ptr) {
56 uint32_t Result = support::endian::read32le(Ptr);
57 Ptr += sizeof(Result);
61 static int32_t readFloat32(const uint8_t *&Ptr) {
63 memcpy(&Result, Ptr, sizeof(Result));
64 Ptr += sizeof(Result);
68 static int64_t readFloat64(const uint8_t *&Ptr) {
70 memcpy(&Result, Ptr, sizeof(Result));
71 Ptr += sizeof(Result);
75 static uint64_t readULEB128(const uint8_t *&Ptr) {
77 uint64_t Result = decodeULEB128(Ptr, &Count);
82 static StringRef readString(const uint8_t *&Ptr) {
83 uint32_t StringLen = readULEB128(Ptr);
84 StringRef Return = StringRef(reinterpret_cast<const char *>(Ptr), StringLen);
89 static int64_t readLEB128(const uint8_t *&Ptr) {
91 uint64_t Result = decodeSLEB128(Ptr, &Count);
96 static uint8_t readVaruint1(const uint8_t *&Ptr) {
97 int64_t result = readLEB128(Ptr);
98 assert(result <= VARUINT1_MAX && result >= 0);
102 static int32_t readVarint32(const uint8_t *&Ptr) {
103 int64_t result = readLEB128(Ptr);
104 assert(result <= INT32_MAX && result >= INT32_MIN);
108 static uint32_t readVaruint32(const uint8_t *&Ptr) {
109 uint64_t result = readULEB128(Ptr);
110 assert(result <= UINT32_MAX);
114 static int64_t readVarint64(const uint8_t *&Ptr) {
115 return readLEB128(Ptr);
118 static uint8_t readOpcode(const uint8_t *&Ptr) {
119 return readUint8(Ptr);
122 static Error readInitExpr(wasm::WasmInitExpr &Expr, const uint8_t *&Ptr) {
123 Expr.Opcode = readOpcode(Ptr);
125 switch (Expr.Opcode) {
126 case wasm::WASM_OPCODE_I32_CONST:
127 Expr.Value.Int32 = readVarint32(Ptr);
129 case wasm::WASM_OPCODE_I64_CONST:
130 Expr.Value.Int64 = readVarint64(Ptr);
132 case wasm::WASM_OPCODE_F32_CONST:
133 Expr.Value.Float32 = readFloat32(Ptr);
135 case wasm::WASM_OPCODE_F64_CONST:
136 Expr.Value.Float64 = readFloat64(Ptr);
138 case wasm::WASM_OPCODE_GET_GLOBAL:
139 Expr.Value.Global = readULEB128(Ptr);
142 return make_error<GenericBinaryError>("Invalid opcode in init_expr",
143 object_error::parse_failed);
146 uint8_t EndOpcode = readOpcode(Ptr);
147 if (EndOpcode != wasm::WASM_OPCODE_END) {
148 return make_error<GenericBinaryError>("Invalid init_expr",
149 object_error::parse_failed);
151 return Error::success();
154 static wasm::WasmLimits readLimits(const uint8_t *&Ptr) {
155 wasm::WasmLimits Result;
156 Result.Flags = readVaruint1(Ptr);
157 Result.Initial = readVaruint32(Ptr);
158 if (Result.Flags & wasm::WASM_LIMITS_FLAG_HAS_MAX)
159 Result.Maximum = readVaruint32(Ptr);
163 static wasm::WasmTable readTable(const uint8_t *&Ptr) {
164 wasm::WasmTable Table;
165 Table.ElemType = readUint8(Ptr);
166 Table.Limits = readLimits(Ptr);
170 static Error readSection(WasmSection &Section, const uint8_t *&Ptr,
171 const uint8_t *Start, const uint8_t *Eof) {
172 Section.Offset = Ptr - Start;
173 Section.Type = readUint8(Ptr);
174 uint32_t Size = readVaruint32(Ptr);
176 return make_error<StringError>("Zero length section",
177 object_error::parse_failed);
178 if (Ptr + Size > Eof)
179 return make_error<StringError>("Section too large",
180 object_error::parse_failed);
181 if (Section.Type == wasm::WASM_SEC_CUSTOM) {
182 const uint8_t *NameStart = Ptr;
183 Section.Name = readString(Ptr);
184 Size -= Ptr - NameStart;
186 Section.Content = ArrayRef<uint8_t>(Ptr, Size);
188 return Error::success();
191 WasmObjectFile::WasmObjectFile(MemoryBufferRef Buffer, Error &Err)
192 : ObjectFile(Binary::ID_Wasm, Buffer) {
193 ErrorAsOutParameter ErrAsOutParam(&Err);
194 Header.Magic = getData().substr(0, 4);
195 if (Header.Magic != StringRef("\0asm", 4)) {
196 Err = make_error<StringError>("Bad magic number",
197 object_error::parse_failed);
201 const uint8_t *Eof = getPtr(getData().size());
202 const uint8_t *Ptr = getPtr(4);
205 Err = make_error<StringError>("Missing version number",
206 object_error::parse_failed);
210 Header.Version = readUint32(Ptr);
211 if (Header.Version != wasm::WasmVersion) {
212 Err = make_error<StringError>("Bad version number",
213 object_error::parse_failed);
219 if ((Err = readSection(Sec, Ptr, getPtr(0), Eof)))
221 if ((Err = parseSection(Sec)))
224 Sections.push_back(Sec);
228 Error WasmObjectFile::parseSection(WasmSection &Sec) {
229 const uint8_t* Start = Sec.Content.data();
230 const uint8_t* End = Start + Sec.Content.size();
232 case wasm::WASM_SEC_CUSTOM:
233 return parseCustomSection(Sec, Start, End);
234 case wasm::WASM_SEC_TYPE:
235 return parseTypeSection(Start, End);
236 case wasm::WASM_SEC_IMPORT:
237 return parseImportSection(Start, End);
238 case wasm::WASM_SEC_FUNCTION:
239 return parseFunctionSection(Start, End);
240 case wasm::WASM_SEC_TABLE:
241 return parseTableSection(Start, End);
242 case wasm::WASM_SEC_MEMORY:
243 return parseMemorySection(Start, End);
244 case wasm::WASM_SEC_GLOBAL:
245 return parseGlobalSection(Start, End);
246 case wasm::WASM_SEC_EXPORT:
247 return parseExportSection(Start, End);
248 case wasm::WASM_SEC_START:
249 return parseStartSection(Start, End);
250 case wasm::WASM_SEC_ELEM:
251 return parseElemSection(Start, End);
252 case wasm::WASM_SEC_CODE:
253 return parseCodeSection(Start, End);
254 case wasm::WASM_SEC_DATA:
255 return parseDataSection(Start, End);
257 return make_error<GenericBinaryError>("Bad section type",
258 object_error::parse_failed);
262 Error WasmObjectFile::parseNameSection(const uint8_t *Ptr, const uint8_t *End) {
263 llvm::DenseSet<uint64_t> Seen;
264 if (Functions.size() != FunctionTypes.size()) {
265 return make_error<GenericBinaryError>("Names must come after code section",
266 object_error::parse_failed);
270 uint8_t Type = readUint8(Ptr);
271 uint32_t Size = readVaruint32(Ptr);
272 const uint8_t *SubSectionEnd = Ptr + Size;
274 case wasm::WASM_NAMES_FUNCTION: {
275 uint32_t Count = readVaruint32(Ptr);
277 uint32_t Index = readVaruint32(Ptr);
278 if (!Seen.insert(Index).second)
279 return make_error<GenericBinaryError>("Function named more than once",
280 object_error::parse_failed);
281 StringRef Name = readString(Ptr);
282 if (!isValidFunctionIndex(Index) || Name.empty())
283 return make_error<GenericBinaryError>("Invalid name entry",
284 object_error::parse_failed);
285 DebugNames.push_back(wasm::WasmFunctionName{Index, Name});
286 if (isDefinedFunctionIndex(Index))
287 getDefinedFunction(Index).DebugName = Name;
291 // Ignore local names for now
292 case wasm::WASM_NAMES_LOCAL:
297 if (Ptr != SubSectionEnd)
298 return make_error<GenericBinaryError>("Name sub-section ended prematurely",
299 object_error::parse_failed);
303 return make_error<GenericBinaryError>("Name section ended prematurely",
304 object_error::parse_failed);
305 return Error::success();
308 Error WasmObjectFile::parseLinkingSection(const uint8_t *Ptr,
309 const uint8_t *End) {
310 HasLinkingSection = true;
311 if (Functions.size() != FunctionTypes.size()) {
312 return make_error<GenericBinaryError>(
313 "Linking data must come after code section", object_error::parse_failed);
316 LinkingData.Version = readVaruint32(Ptr);
317 if (LinkingData.Version != wasm::WasmMetadataVersion) {
318 return make_error<GenericBinaryError>(
319 "Unexpected metadata version: " + Twine(LinkingData.Version) +
320 " (Expected: " + Twine(wasm::WasmMetadataVersion) + ")",
321 object_error::parse_failed);
325 uint8_t Type = readUint8(Ptr);
326 uint32_t Size = readVaruint32(Ptr);
327 const uint8_t *SubSectionEnd = Ptr + Size;
329 case wasm::WASM_SYMBOL_TABLE:
330 if (Error Err = parseLinkingSectionSymtab(Ptr, SubSectionEnd))
333 case wasm::WASM_SEGMENT_INFO: {
334 uint32_t Count = readVaruint32(Ptr);
335 if (Count > DataSegments.size())
336 return make_error<GenericBinaryError>("Too many segment names",
337 object_error::parse_failed);
338 for (uint32_t i = 0; i < Count; i++) {
339 DataSegments[i].Data.Name = readString(Ptr);
340 DataSegments[i].Data.Alignment = readVaruint32(Ptr);
341 DataSegments[i].Data.Flags = readVaruint32(Ptr);
345 case wasm::WASM_INIT_FUNCS: {
346 uint32_t Count = readVaruint32(Ptr);
347 LinkingData.InitFunctions.reserve(Count);
348 for (uint32_t i = 0; i < Count; i++) {
349 wasm::WasmInitFunc Init;
350 Init.Priority = readVaruint32(Ptr);
351 Init.Symbol = readVaruint32(Ptr);
352 if (!isValidFunctionSymbol(Init.Symbol))
353 return make_error<GenericBinaryError>("Invalid function symbol: " +
355 object_error::parse_failed);
356 LinkingData.InitFunctions.emplace_back(Init);
360 case wasm::WASM_COMDAT_INFO:
361 if (Error Err = parseLinkingSectionComdat(Ptr, SubSectionEnd))
368 if (Ptr != SubSectionEnd)
369 return make_error<GenericBinaryError>(
370 "Linking sub-section ended prematurely", object_error::parse_failed);
373 return make_error<GenericBinaryError>("Linking section ended prematurely",
374 object_error::parse_failed);
375 return Error::success();
378 Error WasmObjectFile::parseLinkingSectionSymtab(const uint8_t *&Ptr,
379 const uint8_t *End) {
380 uint32_t Count = readVaruint32(Ptr);
381 LinkingData.SymbolTable.reserve(Count);
382 Symbols.reserve(Count);
383 StringSet<> SymbolNames;
385 std::vector<wasm::WasmImport *> ImportedGlobals;
386 std::vector<wasm::WasmImport *> ImportedFunctions;
387 ImportedGlobals.reserve(Imports.size());
388 ImportedFunctions.reserve(Imports.size());
389 for (auto &I : Imports) {
390 if (I.Kind == wasm::WASM_EXTERNAL_FUNCTION)
391 ImportedFunctions.emplace_back(&I);
392 else if (I.Kind == wasm::WASM_EXTERNAL_GLOBAL)
393 ImportedGlobals.emplace_back(&I);
397 wasm::WasmSymbolInfo Info;
398 const wasm::WasmSignature *FunctionType = nullptr;
399 const wasm::WasmGlobalType *GlobalType = nullptr;
401 Info.Kind = readUint8(Ptr);
402 Info.Flags = readVaruint32(Ptr);
403 bool IsDefined = (Info.Flags & wasm::WASM_SYMBOL_UNDEFINED) == 0;
406 case wasm::WASM_SYMBOL_TYPE_FUNCTION:
407 Info.ElementIndex = readVaruint32(Ptr);
408 if (!isValidFunctionIndex(Info.ElementIndex) ||
409 IsDefined != isDefinedFunctionIndex(Info.ElementIndex))
410 return make_error<GenericBinaryError>("invalid function symbol index",
411 object_error::parse_failed);
413 Info.Name = readString(Ptr);
414 unsigned FuncIndex = Info.ElementIndex - NumImportedFunctions;
415 FunctionType = &Signatures[FunctionTypes[FuncIndex]];
416 wasm::WasmFunction &Function = Functions[FuncIndex];
417 if (Function.SymbolName.empty())
418 Function.SymbolName = Info.Name;
420 wasm::WasmImport &Import = *ImportedFunctions[Info.ElementIndex];
421 FunctionType = &Signatures[Import.SigIndex];
422 Info.Name = Import.Field;
423 Info.Module = Import.Module;
427 case wasm::WASM_SYMBOL_TYPE_GLOBAL:
428 Info.ElementIndex = readVaruint32(Ptr);
429 if (!isValidGlobalIndex(Info.ElementIndex) ||
430 IsDefined != isDefinedGlobalIndex(Info.ElementIndex))
431 return make_error<GenericBinaryError>("invalid global symbol index",
432 object_error::parse_failed);
434 (Info.Flags & wasm::WASM_SYMBOL_BINDING_MASK) ==
435 wasm::WASM_SYMBOL_BINDING_WEAK)
436 return make_error<GenericBinaryError>("undefined weak global symbol",
437 object_error::parse_failed);
439 Info.Name = readString(Ptr);
440 unsigned GlobalIndex = Info.ElementIndex - NumImportedGlobals;
441 wasm::WasmGlobal &Global = Globals[GlobalIndex];
442 GlobalType = &Global.Type;
443 if (Global.SymbolName.empty())
444 Global.SymbolName = Info.Name;
446 wasm::WasmImport &Import = *ImportedGlobals[Info.ElementIndex];
447 Info.Name = Import.Field;
448 GlobalType = &Import.Global;
452 case wasm::WASM_SYMBOL_TYPE_DATA:
453 Info.Name = readString(Ptr);
455 uint32_t Index = readVaruint32(Ptr);
456 if (Index >= DataSegments.size())
457 return make_error<GenericBinaryError>("invalid data symbol index",
458 object_error::parse_failed);
459 uint32_t Offset = readVaruint32(Ptr);
460 uint32_t Size = readVaruint32(Ptr);
461 if (Offset + Size > DataSegments[Index].Data.Content.size())
462 return make_error<GenericBinaryError>("invalid data symbol offset",
463 object_error::parse_failed);
464 Info.DataRef = wasm::WasmDataReference{Index, Offset, Size};
468 case wasm::WASM_SYMBOL_TYPE_SECTION: {
469 Info.ElementIndex = readVaruint32(Ptr);
470 // Use somewhat unique section name as symbol name.
471 StringRef SectionName = Sections[Info.ElementIndex].Name;
472 Info.Name = SectionName;
477 return make_error<GenericBinaryError>("Invalid symbol type",
478 object_error::parse_failed);
481 if ((Info.Flags & wasm::WASM_SYMBOL_BINDING_MASK) !=
482 wasm::WASM_SYMBOL_BINDING_LOCAL &&
483 !SymbolNames.insert(Info.Name).second)
484 return make_error<GenericBinaryError>("Duplicate symbol name " +
486 object_error::parse_failed);
487 LinkingData.SymbolTable.emplace_back(Info);
488 Symbols.emplace_back(LinkingData.SymbolTable.back(), FunctionType,
490 DEBUG(dbgs() << "Adding symbol: " << Symbols.back() << "\n");
493 return Error::success();
496 Error WasmObjectFile::parseLinkingSectionComdat(const uint8_t *&Ptr,
499 uint32_t ComdatCount = readVaruint32(Ptr);
500 StringSet<> ComdatSet;
501 for (unsigned ComdatIndex = 0; ComdatIndex < ComdatCount; ++ComdatIndex) {
502 StringRef Name = readString(Ptr);
503 if (Name.empty() || !ComdatSet.insert(Name).second)
504 return make_error<GenericBinaryError>("Bad/duplicate COMDAT name " + Twine(Name),
505 object_error::parse_failed);
506 LinkingData.Comdats.emplace_back(Name);
507 uint32_t Flags = readVaruint32(Ptr);
509 return make_error<GenericBinaryError>("Unsupported COMDAT flags",
510 object_error::parse_failed);
512 uint32_t EntryCount = readVaruint32(Ptr);
513 while (EntryCount--) {
514 unsigned Kind = readVaruint32(Ptr);
515 unsigned Index = readVaruint32(Ptr);
518 return make_error<GenericBinaryError>("Invalid COMDAT entry type",
519 object_error::parse_failed);
520 case wasm::WASM_COMDAT_DATA:
521 if (Index >= DataSegments.size())
522 return make_error<GenericBinaryError>("COMDAT data index out of range",
523 object_error::parse_failed);
524 if (DataSegments[Index].Data.Comdat != UINT32_MAX)
525 return make_error<GenericBinaryError>("Data segment in two COMDATs",
526 object_error::parse_failed);
527 DataSegments[Index].Data.Comdat = ComdatIndex;
529 case wasm::WASM_COMDAT_FUNCTION:
530 if (!isDefinedFunctionIndex(Index))
531 return make_error<GenericBinaryError>("COMDAT function index out of range",
532 object_error::parse_failed);
533 if (getDefinedFunction(Index).Comdat != UINT32_MAX)
534 return make_error<GenericBinaryError>("Function in two COMDATs",
535 object_error::parse_failed);
536 getDefinedFunction(Index).Comdat = ComdatIndex;
541 return Error::success();
544 Error WasmObjectFile::parseRelocSection(StringRef Name, const uint8_t *Ptr,
545 const uint8_t *End) {
546 uint32_t SectionIndex = readVaruint32(Ptr);
547 if (SectionIndex >= Sections.size())
548 return make_error<GenericBinaryError>("Invalid section index",
549 object_error::parse_failed);
550 WasmSection& Section = Sections[SectionIndex];
551 uint32_t RelocCount = readVaruint32(Ptr);
552 uint32_t EndOffset = Section.Content.size();
553 while (RelocCount--) {
554 wasm::WasmRelocation Reloc = {};
555 Reloc.Type = readVaruint32(Ptr);
556 Reloc.Offset = readVaruint32(Ptr);
557 Reloc.Index = readVaruint32(Ptr);
558 switch (Reloc.Type) {
559 case wasm::R_WEBASSEMBLY_FUNCTION_INDEX_LEB:
560 case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB:
561 case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32:
562 if (!isValidFunctionSymbol(Reloc.Index))
563 return make_error<GenericBinaryError>("Bad relocation function index",
564 object_error::parse_failed);
566 case wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB:
567 if (Reloc.Index >= Signatures.size())
568 return make_error<GenericBinaryError>("Bad relocation type index",
569 object_error::parse_failed);
571 case wasm::R_WEBASSEMBLY_GLOBAL_INDEX_LEB:
572 if (!isValidGlobalSymbol(Reloc.Index))
573 return make_error<GenericBinaryError>("Bad relocation global index",
574 object_error::parse_failed);
576 case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB:
577 case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB:
578 case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32:
579 if (!isValidDataSymbol(Reloc.Index))
580 return make_error<GenericBinaryError>("Bad relocation data index",
581 object_error::parse_failed);
582 Reloc.Addend = readVarint32(Ptr);
584 case wasm::R_WEBASSEMBLY_FUNCTION_OFFSET_I32:
585 if (!isValidFunctionSymbol(Reloc.Index))
586 return make_error<GenericBinaryError>("Bad relocation function index",
587 object_error::parse_failed);
588 Reloc.Addend = readVarint32(Ptr);
590 case wasm::R_WEBASSEMBLY_SECTION_OFFSET_I32:
591 if (!isValidSectionSymbol(Reloc.Index))
592 return make_error<GenericBinaryError>("Bad relocation section index",
593 object_error::parse_failed);
594 Reloc.Addend = readVarint32(Ptr);
597 return make_error<GenericBinaryError>("Bad relocation type: " +
599 object_error::parse_failed);
602 // Relocations must fit inside the section, and must appear in order. They
603 // also shouldn't overlap a function/element boundary, but we don't bother
606 if (Reloc.Type == wasm::R_WEBASSEMBLY_TABLE_INDEX_I32 ||
607 Reloc.Type == wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32 ||
608 Reloc.Type == wasm::R_WEBASSEMBLY_SECTION_OFFSET_I32 ||
609 Reloc.Type == wasm::R_WEBASSEMBLY_FUNCTION_OFFSET_I32)
611 if (Reloc.Offset + Size > EndOffset)
612 return make_error<GenericBinaryError>("Bad relocation offset",
613 object_error::parse_failed);
615 Section.Relocations.push_back(Reloc);
618 return make_error<GenericBinaryError>("Reloc section ended prematurely",
619 object_error::parse_failed);
620 return Error::success();
623 Error WasmObjectFile::parseCustomSection(WasmSection &Sec,
624 const uint8_t *Ptr, const uint8_t *End) {
625 if (Sec.Name == "name") {
626 if (Error Err = parseNameSection(Ptr, End))
628 } else if (Sec.Name == "linking") {
629 if (Error Err = parseLinkingSection(Ptr, End))
631 } else if (Sec.Name.startswith("reloc.")) {
632 if (Error Err = parseRelocSection(Sec.Name, Ptr, End))
635 return Error::success();
638 Error WasmObjectFile::parseTypeSection(const uint8_t *Ptr, const uint8_t *End) {
639 uint32_t Count = readVaruint32(Ptr);
640 Signatures.reserve(Count);
642 wasm::WasmSignature Sig;
643 Sig.ReturnType = wasm::WASM_TYPE_NORESULT;
644 uint8_t Form = readUint8(Ptr);
645 if (Form != wasm::WASM_TYPE_FUNC) {
646 return make_error<GenericBinaryError>("Invalid signature type",
647 object_error::parse_failed);
649 uint32_t ParamCount = readVaruint32(Ptr);
650 Sig.ParamTypes.reserve(ParamCount);
651 while (ParamCount--) {
652 uint32_t ParamType = readUint8(Ptr);
653 Sig.ParamTypes.push_back(ParamType);
655 uint32_t ReturnCount = readVaruint32(Ptr);
657 if (ReturnCount != 1) {
658 return make_error<GenericBinaryError>(
659 "Multiple return types not supported", object_error::parse_failed);
661 Sig.ReturnType = readUint8(Ptr);
663 Signatures.push_back(Sig);
666 return make_error<GenericBinaryError>("Type section ended prematurely",
667 object_error::parse_failed);
668 return Error::success();
671 Error WasmObjectFile::parseImportSection(const uint8_t *Ptr, const uint8_t *End) {
672 uint32_t Count = readVaruint32(Ptr);
673 Imports.reserve(Count);
674 for (uint32_t i = 0; i < Count; i++) {
676 Im.Module = readString(Ptr);
677 Im.Field = readString(Ptr);
678 Im.Kind = readUint8(Ptr);
680 case wasm::WASM_EXTERNAL_FUNCTION:
681 NumImportedFunctions++;
682 Im.SigIndex = readVaruint32(Ptr);
684 case wasm::WASM_EXTERNAL_GLOBAL:
685 NumImportedGlobals++;
686 Im.Global.Type = readUint8(Ptr);
687 Im.Global.Mutable = readVaruint1(Ptr);
689 case wasm::WASM_EXTERNAL_MEMORY:
690 Im.Memory = readLimits(Ptr);
692 case wasm::WASM_EXTERNAL_TABLE:
693 Im.Table = readTable(Ptr);
694 if (Im.Table.ElemType != wasm::WASM_TYPE_ANYFUNC)
695 return make_error<GenericBinaryError>("Invalid table element type",
696 object_error::parse_failed);
699 return make_error<GenericBinaryError>(
700 "Unexpected import kind", object_error::parse_failed);
702 Imports.push_back(Im);
705 return make_error<GenericBinaryError>("Import section ended prematurely",
706 object_error::parse_failed);
707 return Error::success();
710 Error WasmObjectFile::parseFunctionSection(const uint8_t *Ptr, const uint8_t *End) {
711 uint32_t Count = readVaruint32(Ptr);
712 FunctionTypes.reserve(Count);
713 uint32_t NumTypes = Signatures.size();
715 uint32_t Type = readVaruint32(Ptr);
716 if (Type >= NumTypes)
717 return make_error<GenericBinaryError>("Invalid function type",
718 object_error::parse_failed);
719 FunctionTypes.push_back(Type);
722 return make_error<GenericBinaryError>("Function section ended prematurely",
723 object_error::parse_failed);
724 return Error::success();
727 Error WasmObjectFile::parseTableSection(const uint8_t *Ptr, const uint8_t *End) {
728 uint32_t Count = readVaruint32(Ptr);
729 Tables.reserve(Count);
731 Tables.push_back(readTable(Ptr));
732 if (Tables.back().ElemType != wasm::WASM_TYPE_ANYFUNC) {
733 return make_error<GenericBinaryError>("Invalid table element type",
734 object_error::parse_failed);
738 return make_error<GenericBinaryError>("Table section ended prematurely",
739 object_error::parse_failed);
740 return Error::success();
743 Error WasmObjectFile::parseMemorySection(const uint8_t *Ptr, const uint8_t *End) {
744 uint32_t Count = readVaruint32(Ptr);
745 Memories.reserve(Count);
747 Memories.push_back(readLimits(Ptr));
750 return make_error<GenericBinaryError>("Memory section ended prematurely",
751 object_error::parse_failed);
752 return Error::success();
755 Error WasmObjectFile::parseGlobalSection(const uint8_t *Ptr, const uint8_t *End) {
756 GlobalSection = Sections.size();
757 uint32_t Count = readVaruint32(Ptr);
758 Globals.reserve(Count);
760 wasm::WasmGlobal Global;
761 Global.Index = NumImportedGlobals + Globals.size();
762 Global.Type.Type = readUint8(Ptr);
763 Global.Type.Mutable = readVaruint1(Ptr);
764 if (Error Err = readInitExpr(Global.InitExpr, Ptr))
766 Globals.push_back(Global);
769 return make_error<GenericBinaryError>("Global section ended prematurely",
770 object_error::parse_failed);
771 return Error::success();
774 Error WasmObjectFile::parseExportSection(const uint8_t *Ptr, const uint8_t *End) {
775 uint32_t Count = readVaruint32(Ptr);
776 Exports.reserve(Count);
777 for (uint32_t i = 0; i < Count; i++) {
779 Ex.Name = readString(Ptr);
780 Ex.Kind = readUint8(Ptr);
781 Ex.Index = readVaruint32(Ptr);
783 case wasm::WASM_EXTERNAL_FUNCTION:
784 if (!isValidFunctionIndex(Ex.Index))
785 return make_error<GenericBinaryError>("Invalid function export",
786 object_error::parse_failed);
788 case wasm::WASM_EXTERNAL_GLOBAL:
789 if (!isValidGlobalIndex(Ex.Index))
790 return make_error<GenericBinaryError>("Invalid global export",
791 object_error::parse_failed);
793 case wasm::WASM_EXTERNAL_MEMORY:
794 case wasm::WASM_EXTERNAL_TABLE:
797 return make_error<GenericBinaryError>(
798 "Unexpected export kind", object_error::parse_failed);
800 Exports.push_back(Ex);
803 return make_error<GenericBinaryError>("Export section ended prematurely",
804 object_error::parse_failed);
805 return Error::success();
808 bool WasmObjectFile::isValidFunctionIndex(uint32_t Index) const {
809 return Index < NumImportedFunctions + FunctionTypes.size();
812 bool WasmObjectFile::isDefinedFunctionIndex(uint32_t Index) const {
813 return Index >= NumImportedFunctions && isValidFunctionIndex(Index);
816 bool WasmObjectFile::isValidGlobalIndex(uint32_t Index) const {
817 return Index < NumImportedGlobals + Globals.size();
820 bool WasmObjectFile::isDefinedGlobalIndex(uint32_t Index) const {
821 return Index >= NumImportedGlobals && isValidGlobalIndex(Index);
824 bool WasmObjectFile::isValidFunctionSymbol(uint32_t Index) const {
825 return Index < Symbols.size() && Symbols[Index].isTypeFunction();
828 bool WasmObjectFile::isValidGlobalSymbol(uint32_t Index) const {
829 return Index < Symbols.size() && Symbols[Index].isTypeGlobal();
832 bool WasmObjectFile::isValidDataSymbol(uint32_t Index) const {
833 return Index < Symbols.size() && Symbols[Index].isTypeData();
836 bool WasmObjectFile::isValidSectionSymbol(uint32_t Index) const {
837 return Index < Symbols.size() && Symbols[Index].isTypeSection();
840 wasm::WasmFunction &WasmObjectFile::getDefinedFunction(uint32_t Index) {
841 assert(isDefinedFunctionIndex(Index));
842 return Functions[Index - NumImportedFunctions];
845 wasm::WasmGlobal &WasmObjectFile::getDefinedGlobal(uint32_t Index) {
846 assert(isDefinedGlobalIndex(Index));
847 return Globals[Index - NumImportedGlobals];
850 Error WasmObjectFile::parseStartSection(const uint8_t *Ptr, const uint8_t *End) {
851 StartFunction = readVaruint32(Ptr);
852 if (!isValidFunctionIndex(StartFunction))
853 return make_error<GenericBinaryError>("Invalid start function",
854 object_error::parse_failed);
855 return Error::success();
858 Error WasmObjectFile::parseCodeSection(const uint8_t *Ptr, const uint8_t *End) {
859 CodeSection = Sections.size();
860 const uint8_t *CodeSectionStart = Ptr;
861 uint32_t FunctionCount = readVaruint32(Ptr);
862 if (FunctionCount != FunctionTypes.size()) {
863 return make_error<GenericBinaryError>("Invalid function count",
864 object_error::parse_failed);
867 while (FunctionCount--) {
868 wasm::WasmFunction Function;
869 const uint8_t *FunctionStart = Ptr;
870 uint32_t Size = readVaruint32(Ptr);
871 const uint8_t *FunctionEnd = Ptr + Size;
873 Function.Index = NumImportedFunctions + Functions.size();
874 Function.CodeSectionOffset = FunctionStart - CodeSectionStart;
875 Function.Size = FunctionEnd - FunctionStart;
877 uint32_t NumLocalDecls = readVaruint32(Ptr);
878 Function.Locals.reserve(NumLocalDecls);
879 while (NumLocalDecls--) {
880 wasm::WasmLocalDecl Decl;
881 Decl.Count = readVaruint32(Ptr);
882 Decl.Type = readUint8(Ptr);
883 Function.Locals.push_back(Decl);
886 uint32_t BodySize = FunctionEnd - Ptr;
887 Function.Body = ArrayRef<uint8_t>(Ptr, BodySize);
888 // This will be set later when reading in the linking metadata section.
889 Function.Comdat = UINT32_MAX;
891 assert(Ptr == FunctionEnd);
892 Functions.push_back(Function);
895 return make_error<GenericBinaryError>("Code section ended prematurely",
896 object_error::parse_failed);
897 return Error::success();
900 Error WasmObjectFile::parseElemSection(const uint8_t *Ptr, const uint8_t *End) {
901 uint32_t Count = readVaruint32(Ptr);
902 ElemSegments.reserve(Count);
904 wasm::WasmElemSegment Segment;
905 Segment.TableIndex = readVaruint32(Ptr);
906 if (Segment.TableIndex != 0) {
907 return make_error<GenericBinaryError>("Invalid TableIndex",
908 object_error::parse_failed);
910 if (Error Err = readInitExpr(Segment.Offset, Ptr))
912 uint32_t NumElems = readVaruint32(Ptr);
914 Segment.Functions.push_back(readVaruint32(Ptr));
916 ElemSegments.push_back(Segment);
919 return make_error<GenericBinaryError>("Elem section ended prematurely",
920 object_error::parse_failed);
921 return Error::success();
924 Error WasmObjectFile::parseDataSection(const uint8_t *Ptr, const uint8_t *End) {
925 DataSection = Sections.size();
926 const uint8_t *Start = Ptr;
927 uint32_t Count = readVaruint32(Ptr);
928 DataSegments.reserve(Count);
931 Segment.Data.MemoryIndex = readVaruint32(Ptr);
932 if (Error Err = readInitExpr(Segment.Data.Offset, Ptr))
934 uint32_t Size = readVaruint32(Ptr);
935 Segment.Data.Content = ArrayRef<uint8_t>(Ptr, Size);
936 // The rest of these Data fields are set later, when reading in the linking
938 Segment.Data.Alignment = 0;
939 Segment.Data.Flags = 0;
940 Segment.Data.Comdat = UINT32_MAX;
941 Segment.SectionOffset = Ptr - Start;
943 DataSegments.push_back(Segment);
946 return make_error<GenericBinaryError>("Data section ended prematurely",
947 object_error::parse_failed);
948 return Error::success();
951 const uint8_t *WasmObjectFile::getPtr(size_t Offset) const {
952 return reinterpret_cast<const uint8_t *>(getData().substr(Offset, 1).data());
955 const wasm::WasmObjectHeader &WasmObjectFile::getHeader() const {
959 void WasmObjectFile::moveSymbolNext(DataRefImpl &Symb) const { Symb.d.a++; }
961 uint32_t WasmObjectFile::getSymbolFlags(DataRefImpl Symb) const {
962 uint32_t Result = SymbolRef::SF_None;
963 const WasmSymbol &Sym = getWasmSymbol(Symb);
965 DEBUG(dbgs() << "getSymbolFlags: ptr=" << &Sym << " " << Sym << "\n");
966 if (Sym.isBindingWeak())
967 Result |= SymbolRef::SF_Weak;
968 if (!Sym.isBindingLocal())
969 Result |= SymbolRef::SF_Global;
971 Result |= SymbolRef::SF_Hidden;
972 if (!Sym.isDefined())
973 Result |= SymbolRef::SF_Undefined;
974 if (Sym.isTypeFunction())
975 Result |= SymbolRef::SF_Executable;
979 basic_symbol_iterator WasmObjectFile::symbol_begin() const {
982 return BasicSymbolRef(Ref, this);
985 basic_symbol_iterator WasmObjectFile::symbol_end() const {
987 Ref.d.a = Symbols.size();
988 return BasicSymbolRef(Ref, this);
991 const WasmSymbol &WasmObjectFile::getWasmSymbol(const DataRefImpl &Symb) const {
992 return Symbols[Symb.d.a];
995 const WasmSymbol &WasmObjectFile::getWasmSymbol(const SymbolRef &Symb) const {
996 return getWasmSymbol(Symb.getRawDataRefImpl());
999 Expected<StringRef> WasmObjectFile::getSymbolName(DataRefImpl Symb) const {
1000 return getWasmSymbol(Symb).Info.Name;
1003 Expected<uint64_t> WasmObjectFile::getSymbolAddress(DataRefImpl Symb) const {
1004 return getSymbolValue(Symb);
1007 uint64_t WasmObjectFile::getWasmSymbolValue(const WasmSymbol& Sym) const {
1008 switch (Sym.Info.Kind) {
1009 case wasm::WASM_SYMBOL_TYPE_FUNCTION:
1010 case wasm::WASM_SYMBOL_TYPE_GLOBAL:
1011 return Sym.Info.ElementIndex;
1012 case wasm::WASM_SYMBOL_TYPE_DATA: {
1013 // The value of a data symbol is the segment offset, plus the symbol
1014 // offset within the segment.
1015 uint32_t SegmentIndex = Sym.Info.DataRef.Segment;
1016 const wasm::WasmDataSegment &Segment = DataSegments[SegmentIndex].Data;
1017 assert(Segment.Offset.Opcode == wasm::WASM_OPCODE_I32_CONST);
1018 return Segment.Offset.Value.Int32 + Sym.Info.DataRef.Offset;
1020 case wasm::WASM_SYMBOL_TYPE_SECTION:
1023 llvm_unreachable("invalid symbol type");
1026 uint64_t WasmObjectFile::getSymbolValueImpl(DataRefImpl Symb) const {
1027 return getWasmSymbolValue(getWasmSymbol(Symb));
1030 uint32_t WasmObjectFile::getSymbolAlignment(DataRefImpl Symb) const {
1031 llvm_unreachable("not yet implemented");
1035 uint64_t WasmObjectFile::getCommonSymbolSizeImpl(DataRefImpl Symb) const {
1036 llvm_unreachable("not yet implemented");
1040 Expected<SymbolRef::Type>
1041 WasmObjectFile::getSymbolType(DataRefImpl Symb) const {
1042 const WasmSymbol &Sym = getWasmSymbol(Symb);
1044 switch (Sym.Info.Kind) {
1045 case wasm::WASM_SYMBOL_TYPE_FUNCTION:
1046 return SymbolRef::ST_Function;
1047 case wasm::WASM_SYMBOL_TYPE_GLOBAL:
1048 return SymbolRef::ST_Other;
1049 case wasm::WASM_SYMBOL_TYPE_DATA:
1050 return SymbolRef::ST_Data;
1051 case wasm::WASM_SYMBOL_TYPE_SECTION:
1052 return SymbolRef::ST_Debug;
1055 llvm_unreachable("Unknown WasmSymbol::SymbolType");
1056 return SymbolRef::ST_Other;
1059 Expected<section_iterator>
1060 WasmObjectFile::getSymbolSection(DataRefImpl Symb) const {
1061 const WasmSymbol& Sym = getWasmSymbol(Symb);
1062 if (Sym.isUndefined())
1063 return section_end();
1066 switch (Sym.Info.Kind) {
1067 case wasm::WASM_SYMBOL_TYPE_FUNCTION:
1068 Ref.d.a = CodeSection;
1070 case wasm::WASM_SYMBOL_TYPE_GLOBAL:
1071 Ref.d.a = GlobalSection;
1073 case wasm::WASM_SYMBOL_TYPE_DATA:
1074 Ref.d.a = DataSection;
1076 case wasm::WASM_SYMBOL_TYPE_SECTION: {
1077 Ref.d.a = Sym.Info.ElementIndex;
1081 llvm_unreachable("Unknown WasmSymbol::SymbolType");
1083 return section_iterator(SectionRef(Ref, this));
1086 void WasmObjectFile::moveSectionNext(DataRefImpl &Sec) const { Sec.d.a++; }
1088 std::error_code WasmObjectFile::getSectionName(DataRefImpl Sec,
1089 StringRef &Res) const {
1090 const WasmSection &S = Sections[Sec.d.a];
1092 case wasm::WASM_SEC_##X: \
1107 case wasm::WASM_SEC_CUSTOM:
1111 return object_error::invalid_section_index;
1114 return std::error_code();
1117 uint64_t WasmObjectFile::getSectionAddress(DataRefImpl Sec) const { return 0; }
1119 uint64_t WasmObjectFile::getSectionIndex(DataRefImpl Sec) const {
1123 uint64_t WasmObjectFile::getSectionSize(DataRefImpl Sec) const {
1124 const WasmSection &S = Sections[Sec.d.a];
1125 return S.Content.size();
1128 std::error_code WasmObjectFile::getSectionContents(DataRefImpl Sec,
1129 StringRef &Res) const {
1130 const WasmSection &S = Sections[Sec.d.a];
1131 // This will never fail since wasm sections can never be empty (user-sections
1132 // must have a name and non-user sections each have a defined structure).
1133 Res = StringRef(reinterpret_cast<const char *>(S.Content.data()),
1135 return std::error_code();
1138 uint64_t WasmObjectFile::getSectionAlignment(DataRefImpl Sec) const {
1142 bool WasmObjectFile::isSectionCompressed(DataRefImpl Sec) const {
1146 bool WasmObjectFile::isSectionText(DataRefImpl Sec) const {
1147 return getWasmSection(Sec).Type == wasm::WASM_SEC_CODE;
1150 bool WasmObjectFile::isSectionData(DataRefImpl Sec) const {
1151 return getWasmSection(Sec).Type == wasm::WASM_SEC_DATA;
1154 bool WasmObjectFile::isSectionBSS(DataRefImpl Sec) const { return false; }
1156 bool WasmObjectFile::isSectionVirtual(DataRefImpl Sec) const { return false; }
1158 bool WasmObjectFile::isSectionBitcode(DataRefImpl Sec) const { return false; }
1160 relocation_iterator WasmObjectFile::section_rel_begin(DataRefImpl Ref) const {
1161 DataRefImpl RelocRef;
1162 RelocRef.d.a = Ref.d.a;
1164 return relocation_iterator(RelocationRef(RelocRef, this));
1167 relocation_iterator WasmObjectFile::section_rel_end(DataRefImpl Ref) const {
1168 const WasmSection &Sec = getWasmSection(Ref);
1169 DataRefImpl RelocRef;
1170 RelocRef.d.a = Ref.d.a;
1171 RelocRef.d.b = Sec.Relocations.size();
1172 return relocation_iterator(RelocationRef(RelocRef, this));
1175 void WasmObjectFile::moveRelocationNext(DataRefImpl &Rel) const {
1179 uint64_t WasmObjectFile::getRelocationOffset(DataRefImpl Ref) const {
1180 const wasm::WasmRelocation &Rel = getWasmRelocation(Ref);
1184 symbol_iterator WasmObjectFile::getRelocationSymbol(DataRefImpl Ref) const {
1185 const wasm::WasmRelocation &Rel = getWasmRelocation(Ref);
1186 if (Rel.Type == wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB)
1187 return symbol_end();
1189 Sym.d.a = Rel.Index;
1191 return symbol_iterator(SymbolRef(Sym, this));
1194 uint64_t WasmObjectFile::getRelocationType(DataRefImpl Ref) const {
1195 const wasm::WasmRelocation &Rel = getWasmRelocation(Ref);
1199 void WasmObjectFile::getRelocationTypeName(
1200 DataRefImpl Ref, SmallVectorImpl<char> &Result) const {
1201 const wasm::WasmRelocation& Rel = getWasmRelocation(Ref);
1202 StringRef Res = "Unknown";
1204 #define WASM_RELOC(name, value) \
1210 #include "llvm/BinaryFormat/WasmRelocs.def"
1215 Result.append(Res.begin(), Res.end());
1218 section_iterator WasmObjectFile::section_begin() const {
1221 return section_iterator(SectionRef(Ref, this));
1224 section_iterator WasmObjectFile::section_end() const {
1226 Ref.d.a = Sections.size();
1227 return section_iterator(SectionRef(Ref, this));
1230 uint8_t WasmObjectFile::getBytesInAddress() const { return 4; }
1232 StringRef WasmObjectFile::getFileFormatName() const { return "WASM"; }
1234 Triple::ArchType WasmObjectFile::getArch() const { return Triple::wasm32; }
1236 SubtargetFeatures WasmObjectFile::getFeatures() const {
1237 return SubtargetFeatures();
1240 bool WasmObjectFile::isRelocatableObject() const {
1241 return HasLinkingSection;
1244 const WasmSection &WasmObjectFile::getWasmSection(DataRefImpl Ref) const {
1245 assert(Ref.d.a < Sections.size());
1246 return Sections[Ref.d.a];
1250 WasmObjectFile::getWasmSection(const SectionRef &Section) const {
1251 return getWasmSection(Section.getRawDataRefImpl());
1254 const wasm::WasmRelocation &
1255 WasmObjectFile::getWasmRelocation(const RelocationRef &Ref) const {
1256 return getWasmRelocation(Ref.getRawDataRefImpl());
1259 const wasm::WasmRelocation &
1260 WasmObjectFile::getWasmRelocation(DataRefImpl Ref) const {
1261 assert(Ref.d.a < Sections.size());
1262 const WasmSection& Sec = Sections[Ref.d.a];
1263 assert(Ref.d.b < Sec.Relocations.size());
1264 return Sec.Relocations[Ref.d.b];