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 int8_t readVarint7(const uint8_t *&Ptr) {
103 int64_t result = readLEB128(Ptr);
104 assert(result <= VARINT7_MAX && result >= VARINT7_MIN);
108 static uint8_t readVaruint7(const uint8_t *&Ptr) {
109 uint64_t result = readULEB128(Ptr);
110 assert(result <= VARUINT7_MAX);
114 static int32_t readVarint32(const uint8_t *&Ptr) {
115 int64_t result = readLEB128(Ptr);
116 assert(result <= INT32_MAX && result >= INT32_MIN);
120 static uint32_t readVaruint32(const uint8_t *&Ptr) {
121 uint64_t result = readULEB128(Ptr);
122 assert(result <= UINT32_MAX);
126 static int64_t readVarint64(const uint8_t *&Ptr) {
127 return readLEB128(Ptr);
130 static uint8_t readOpcode(const uint8_t *&Ptr) {
131 return readUint8(Ptr);
134 static Error readInitExpr(wasm::WasmInitExpr &Expr, const uint8_t *&Ptr) {
135 Expr.Opcode = readOpcode(Ptr);
137 switch (Expr.Opcode) {
138 case wasm::WASM_OPCODE_I32_CONST:
139 Expr.Value.Int32 = readVarint32(Ptr);
141 case wasm::WASM_OPCODE_I64_CONST:
142 Expr.Value.Int64 = readVarint64(Ptr);
144 case wasm::WASM_OPCODE_F32_CONST:
145 Expr.Value.Float32 = readFloat32(Ptr);
147 case wasm::WASM_OPCODE_F64_CONST:
148 Expr.Value.Float64 = readFloat64(Ptr);
150 case wasm::WASM_OPCODE_GET_GLOBAL:
151 Expr.Value.Global = readULEB128(Ptr);
154 return make_error<GenericBinaryError>("Invalid opcode in init_expr",
155 object_error::parse_failed);
158 uint8_t EndOpcode = readOpcode(Ptr);
159 if (EndOpcode != wasm::WASM_OPCODE_END) {
160 return make_error<GenericBinaryError>("Invalid init_expr",
161 object_error::parse_failed);
163 return Error::success();
166 static wasm::WasmLimits readLimits(const uint8_t *&Ptr) {
167 wasm::WasmLimits Result;
168 Result.Flags = readVaruint1(Ptr);
169 Result.Initial = readVaruint32(Ptr);
170 if (Result.Flags & wasm::WASM_LIMITS_FLAG_HAS_MAX)
171 Result.Maximum = readVaruint32(Ptr);
175 static wasm::WasmTable readTable(const uint8_t *&Ptr) {
176 wasm::WasmTable Table;
177 Table.ElemType = readVarint7(Ptr);
178 Table.Limits = readLimits(Ptr);
182 static Error readSection(WasmSection &Section, const uint8_t *&Ptr,
183 const uint8_t *Start, const uint8_t *Eof) {
184 Section.Offset = Ptr - Start;
185 Section.Type = readVaruint7(Ptr);
186 uint32_t Size = readVaruint32(Ptr);
188 return make_error<StringError>("Zero length section",
189 object_error::parse_failed);
190 if (Ptr + Size > Eof)
191 return make_error<StringError>("Section too large",
192 object_error::parse_failed);
193 Section.Content = ArrayRef<uint8_t>(Ptr, Size);
195 return Error::success();
198 WasmObjectFile::WasmObjectFile(MemoryBufferRef Buffer, Error &Err)
199 : ObjectFile(Binary::ID_Wasm, Buffer) {
200 LinkingData.DataSize = 0;
202 ErrorAsOutParameter ErrAsOutParam(&Err);
203 Header.Magic = getData().substr(0, 4);
204 if (Header.Magic != StringRef("\0asm", 4)) {
205 Err = make_error<StringError>("Bad magic number",
206 object_error::parse_failed);
210 const uint8_t *Eof = getPtr(getData().size());
211 const uint8_t *Ptr = getPtr(4);
214 Err = make_error<StringError>("Missing version number",
215 object_error::parse_failed);
219 Header.Version = readUint32(Ptr);
220 if (Header.Version != wasm::WasmVersion) {
221 Err = make_error<StringError>("Bad version number",
222 object_error::parse_failed);
228 if ((Err = readSection(Sec, Ptr, getPtr(0), Eof)))
230 if ((Err = parseSection(Sec)))
233 Sections.push_back(Sec);
237 Error WasmObjectFile::parseSection(WasmSection &Sec) {
238 const uint8_t* Start = Sec.Content.data();
239 const uint8_t* End = Start + Sec.Content.size();
241 case wasm::WASM_SEC_CUSTOM:
242 return parseCustomSection(Sec, Start, End);
243 case wasm::WASM_SEC_TYPE:
244 return parseTypeSection(Start, End);
245 case wasm::WASM_SEC_IMPORT:
246 return parseImportSection(Start, End);
247 case wasm::WASM_SEC_FUNCTION:
248 return parseFunctionSection(Start, End);
249 case wasm::WASM_SEC_TABLE:
250 return parseTableSection(Start, End);
251 case wasm::WASM_SEC_MEMORY:
252 return parseMemorySection(Start, End);
253 case wasm::WASM_SEC_GLOBAL:
254 return parseGlobalSection(Start, End);
255 case wasm::WASM_SEC_EXPORT:
256 return parseExportSection(Start, End);
257 case wasm::WASM_SEC_START:
258 return parseStartSection(Start, End);
259 case wasm::WASM_SEC_ELEM:
260 return parseElemSection(Start, End);
261 case wasm::WASM_SEC_CODE:
262 return parseCodeSection(Start, End);
263 case wasm::WASM_SEC_DATA:
264 return parseDataSection(Start, End);
266 return make_error<GenericBinaryError>("Bad section type",
267 object_error::parse_failed);
271 Error WasmObjectFile::parseNameSection(const uint8_t *Ptr, const uint8_t *End) {
272 llvm::DenseSet<uint64_t> Seen;
273 if (Functions.size() != FunctionTypes.size()) {
274 return make_error<GenericBinaryError>("Names must come after code section",
275 object_error::parse_failed);
279 uint8_t Type = readVarint7(Ptr);
280 uint32_t Size = readVaruint32(Ptr);
281 const uint8_t *SubSectionEnd = Ptr + Size;
283 case wasm::WASM_NAMES_FUNCTION: {
284 uint32_t Count = readVaruint32(Ptr);
286 uint32_t Index = readVaruint32(Ptr);
287 if (!Seen.insert(Index).second)
288 return make_error<GenericBinaryError>("Function named more than once",
289 object_error::parse_failed);
290 StringRef Name = readString(Ptr);
291 if (!isValidFunctionIndex(Index) || Name.empty())
292 return make_error<GenericBinaryError>("Invalid name entry",
293 object_error::parse_failed);
294 DebugNames.push_back(wasm::WasmFunctionName{Index, Name});
295 if (isDefinedFunctionIndex(Index)) {
296 // Override any existing name; the name specified by the "names"
297 // section is the Function's canonical name.
298 getDefinedFunction(Index).Name = Name;
303 // Ignore local names for now
304 case wasm::WASM_NAMES_LOCAL:
309 if (Ptr != SubSectionEnd)
310 return make_error<GenericBinaryError>("Name sub-section ended prematurely",
311 object_error::parse_failed);
315 return make_error<GenericBinaryError>("Name section ended prematurely",
316 object_error::parse_failed);
317 return Error::success();
320 Error WasmObjectFile::parseLinkingSection(const uint8_t *Ptr,
321 const uint8_t *End) {
322 HasLinkingSection = true;
323 if (Functions.size() != FunctionTypes.size()) {
324 return make_error<GenericBinaryError>(
325 "Linking data must come after code section", object_error::parse_failed);
329 uint8_t Type = readVarint7(Ptr);
330 uint32_t Size = readVaruint32(Ptr);
331 const uint8_t *SubSectionEnd = Ptr + Size;
333 case wasm::WASM_SYMBOL_TABLE:
334 if (Error Err = parseLinkingSectionSymtab(Ptr, SubSectionEnd))
337 case wasm::WASM_DATA_SIZE:
338 LinkingData.DataSize = readVaruint32(Ptr);
340 case wasm::WASM_SEGMENT_INFO: {
341 uint32_t Count = readVaruint32(Ptr);
342 if (Count > DataSegments.size())
343 return make_error<GenericBinaryError>("Too many segment names",
344 object_error::parse_failed);
345 for (uint32_t i = 0; i < Count; i++) {
346 DataSegments[i].Data.Name = readString(Ptr);
347 DataSegments[i].Data.Alignment = readVaruint32(Ptr);
348 DataSegments[i].Data.Flags = readVaruint32(Ptr);
352 case wasm::WASM_INIT_FUNCS: {
353 uint32_t Count = readVaruint32(Ptr);
354 LinkingData.InitFunctions.reserve(Count);
355 for (uint32_t i = 0; i < Count; i++) {
356 wasm::WasmInitFunc Init;
357 Init.Priority = readVaruint32(Ptr);
358 Init.Symbol = readVaruint32(Ptr);
359 if (!isValidFunctionSymbolIndex(Init.Symbol))
360 return make_error<GenericBinaryError>("Invalid function symbol: " +
362 object_error::parse_failed);
363 LinkingData.InitFunctions.emplace_back(Init);
367 case wasm::WASM_COMDAT_INFO:
368 if (Error Err = parseLinkingSectionComdat(Ptr, SubSectionEnd))
375 if (Ptr != SubSectionEnd)
376 return make_error<GenericBinaryError>(
377 "Linking sub-section ended prematurely", object_error::parse_failed);
380 return make_error<GenericBinaryError>("Linking section ended prematurely",
381 object_error::parse_failed);
382 return Error::success();
385 Error WasmObjectFile::parseLinkingSectionSymtab(const uint8_t *&Ptr,
386 const uint8_t *End) {
387 uint32_t Count = readVaruint32(Ptr);
388 LinkingData.SymbolTable.reserve(Count);
389 Symbols.reserve(Count);
390 StringSet<> SymbolNames;
392 std::vector<wasm::WasmImport *> ImportedGlobals;
393 std::vector<wasm::WasmImport *> ImportedFunctions;
394 ImportedGlobals.reserve(Imports.size());
395 ImportedFunctions.reserve(Imports.size());
396 for (auto &I : Imports) {
397 if (I.Kind == wasm::WASM_EXTERNAL_FUNCTION)
398 ImportedFunctions.emplace_back(&I);
399 else if (I.Kind == wasm::WASM_EXTERNAL_GLOBAL)
400 ImportedGlobals.emplace_back(&I);
404 wasm::WasmSymbolInfo Info;
405 const wasm::WasmSignature *FunctionType = nullptr;
406 const wasm::WasmGlobalType *GlobalType = nullptr;
408 Info.Kind = readUint8(Ptr);
409 Info.Flags = readVaruint32(Ptr);
410 bool IsDefined = (Info.Flags & wasm::WASM_SYMBOL_UNDEFINED) == 0;
413 case wasm::WASM_SYMBOL_TYPE_FUNCTION:
414 Info.ElementIndex = readVaruint32(Ptr);
415 if (!isValidFunctionIndex(Info.ElementIndex) ||
416 IsDefined != isDefinedFunctionIndex(Info.ElementIndex))
417 return make_error<GenericBinaryError>("invalid function symbol index",
418 object_error::parse_failed);
420 Info.Name = readString(Ptr);
421 unsigned FuncIndex = Info.ElementIndex - NumImportedFunctions;
422 FunctionType = &Signatures[FunctionTypes[FuncIndex]];
423 auto &Function = Functions[FuncIndex];
424 if (Function.Name.empty()) {
425 // Use the symbol's name to set a name for the Function, but only if
426 // one hasn't already been set.
427 Function.Name = Info.Name;
430 wasm::WasmImport &Import = *ImportedFunctions[Info.ElementIndex];
431 FunctionType = &Signatures[Import.SigIndex];
432 Info.Name = Import.Field;
436 case wasm::WASM_SYMBOL_TYPE_GLOBAL:
437 Info.ElementIndex = readVaruint32(Ptr);
438 if (!isValidGlobalIndex(Info.ElementIndex) ||
439 IsDefined != isDefinedGlobalIndex(Info.ElementIndex))
440 return make_error<GenericBinaryError>("invalid global symbol index",
441 object_error::parse_failed);
443 Info.Name = readString(Ptr);
444 unsigned GlobalIndex = Info.ElementIndex - NumImportedGlobals;
445 GlobalType = &Globals[GlobalIndex].Type;
447 wasm::WasmImport &Import = *ImportedGlobals[Info.ElementIndex];
448 Info.Name = Import.Field;
449 GlobalType = &Import.Global;
453 case wasm::WASM_SYMBOL_TYPE_DATA:
454 Info.Name = readString(Ptr);
456 uint32_t Index = readVaruint32(Ptr);
457 if (Index >= DataSegments.size())
458 return make_error<GenericBinaryError>("invalid data symbol index",
459 object_error::parse_failed);
460 uint32_t Offset = readVaruint32(Ptr);
461 uint32_t Size = readVaruint32(Ptr);
462 if (Offset + Size > DataSegments[Index].Data.Content.size())
463 return make_error<GenericBinaryError>("invalid data symbol index",
464 object_error::parse_failed);
465 Info.DataRef = wasm::WasmDataReference{Index, Offset, Size};
470 return make_error<GenericBinaryError>("Invalid symbol type",
471 object_error::parse_failed);
474 if ((Info.Flags & wasm::WASM_SYMBOL_BINDING_MASK) !=
475 wasm::WASM_SYMBOL_BINDING_LOCAL &&
476 !SymbolNames.insert(Info.Name).second)
477 return make_error<GenericBinaryError>("Duplicate symbol name " +
479 object_error::parse_failed);
480 LinkingData.SymbolTable.emplace_back(Info);
481 Symbols.emplace_back(LinkingData.SymbolTable.back(), FunctionType,
483 DEBUG(dbgs() << "Adding symbol: " << Symbols.back() << "\n");
486 return Error::success();
489 Error WasmObjectFile::parseLinkingSectionComdat(const uint8_t *&Ptr,
492 uint32_t ComdatCount = readVaruint32(Ptr);
493 StringSet<> ComdatSet;
494 while (ComdatCount--) {
495 StringRef Name = readString(Ptr);
496 if (Name.empty() || !ComdatSet.insert(Name).second)
497 return make_error<GenericBinaryError>("Bad/duplicate COMDAT name " + Twine(Name),
498 object_error::parse_failed);
499 Comdats.emplace_back(Name);
500 uint32_t Flags = readVaruint32(Ptr);
502 return make_error<GenericBinaryError>("Unsupported COMDAT flags",
503 object_error::parse_failed);
505 uint32_t EntryCount = readVaruint32(Ptr);
506 while (EntryCount--) {
507 unsigned Kind = readVaruint32(Ptr);
508 unsigned Index = readVaruint32(Ptr);
511 return make_error<GenericBinaryError>("Invalid COMDAT entry type",
512 object_error::parse_failed);
513 case wasm::WASM_COMDAT_DATA:
514 if (Index >= DataSegments.size())
515 return make_error<GenericBinaryError>("COMDAT data index out of range",
516 object_error::parse_failed);
517 if (!DataSegments[Index].Data.Comdat.empty())
518 return make_error<GenericBinaryError>("Data segment in two COMDATs",
519 object_error::parse_failed);
520 DataSegments[Index].Data.Comdat = Name;
522 case wasm::WASM_COMDAT_FUNCTION:
523 if (!isDefinedFunctionIndex(Index))
524 return make_error<GenericBinaryError>("COMDAT function index out of range",
525 object_error::parse_failed);
526 if (!getDefinedFunction(Index).Comdat.empty())
527 return make_error<GenericBinaryError>("Function in two COMDATs",
528 object_error::parse_failed);
529 getDefinedFunction(Index).Comdat = Name;
534 return Error::success();
537 WasmSection* WasmObjectFile::findCustomSectionByName(StringRef Name) {
538 for (WasmSection& Section : Sections) {
539 if (Section.Type == wasm::WASM_SEC_CUSTOM && Section.Name == Name)
545 WasmSection* WasmObjectFile::findSectionByType(uint32_t Type) {
546 assert(Type != wasm::WASM_SEC_CUSTOM);
547 for (WasmSection& Section : Sections) {
548 if (Section.Type == Type)
554 Error WasmObjectFile::parseRelocSection(StringRef Name, const uint8_t *Ptr,
555 const uint8_t *End) {
556 uint8_t SectionCode = readVarint7(Ptr);
557 WasmSection* Section = nullptr;
558 if (SectionCode == wasm::WASM_SEC_CUSTOM) {
559 StringRef Name = readString(Ptr);
560 Section = findCustomSectionByName(Name);
562 Section = findSectionByType(SectionCode);
565 return make_error<GenericBinaryError>("Invalid section code",
566 object_error::parse_failed);
567 uint32_t RelocCount = readVaruint32(Ptr);
568 while (RelocCount--) {
569 wasm::WasmRelocation Reloc;
570 memset(&Reloc, 0, sizeof(Reloc));
571 Reloc.Type = readVaruint32(Ptr);
572 Reloc.Offset = readVaruint32(Ptr);
573 Reloc.Index = readVaruint32(Ptr);
574 switch (Reloc.Type) {
575 case wasm::R_WEBASSEMBLY_FUNCTION_INDEX_LEB:
576 case wasm::R_WEBASSEMBLY_TABLE_INDEX_SLEB:
577 case wasm::R_WEBASSEMBLY_TABLE_INDEX_I32:
578 case wasm::R_WEBASSEMBLY_TYPE_INDEX_LEB:
579 case wasm::R_WEBASSEMBLY_GLOBAL_INDEX_LEB:
581 case wasm::R_WEBASSEMBLY_MEMORY_ADDR_LEB:
582 case wasm::R_WEBASSEMBLY_MEMORY_ADDR_SLEB:
583 case wasm::R_WEBASSEMBLY_MEMORY_ADDR_I32:
584 Reloc.Addend = readVarint32(Ptr);
587 return make_error<GenericBinaryError>("Bad relocation type: " +
589 object_error::parse_failed);
591 Section->Relocations.push_back(Reloc);
594 return make_error<GenericBinaryError>("Reloc section ended prematurely",
595 object_error::parse_failed);
596 return Error::success();
599 Error WasmObjectFile::parseCustomSection(WasmSection &Sec,
600 const uint8_t *Ptr, const uint8_t *End) {
601 Sec.Name = readString(Ptr);
602 if (Sec.Name == "name") {
603 if (Error Err = parseNameSection(Ptr, End))
605 } else if (Sec.Name == "linking") {
606 if (Error Err = parseLinkingSection(Ptr, End))
608 } else if (Sec.Name.startswith("reloc.")) {
609 if (Error Err = parseRelocSection(Sec.Name, Ptr, End))
612 return Error::success();
615 Error WasmObjectFile::parseTypeSection(const uint8_t *Ptr, const uint8_t *End) {
616 uint32_t Count = readVaruint32(Ptr);
617 Signatures.reserve(Count);
619 wasm::WasmSignature Sig;
620 Sig.ReturnType = wasm::WASM_TYPE_NORESULT;
621 int8_t Form = readVarint7(Ptr);
622 if (Form != wasm::WASM_TYPE_FUNC) {
623 return make_error<GenericBinaryError>("Invalid signature type",
624 object_error::parse_failed);
626 uint32_t ParamCount = readVaruint32(Ptr);
627 Sig.ParamTypes.reserve(ParamCount);
628 while (ParamCount--) {
629 uint32_t ParamType = readVarint7(Ptr);
630 Sig.ParamTypes.push_back(ParamType);
632 uint32_t ReturnCount = readVaruint32(Ptr);
634 if (ReturnCount != 1) {
635 return make_error<GenericBinaryError>(
636 "Multiple return types not supported", object_error::parse_failed);
638 Sig.ReturnType = readVarint7(Ptr);
640 Signatures.push_back(Sig);
643 return make_error<GenericBinaryError>("Type section ended prematurely",
644 object_error::parse_failed);
645 return Error::success();
648 Error WasmObjectFile::parseImportSection(const uint8_t *Ptr, const uint8_t *End) {
649 uint32_t Count = readVaruint32(Ptr);
650 Imports.reserve(Count);
651 for (uint32_t i = 0; i < Count; i++) {
653 Im.Module = readString(Ptr);
654 Im.Field = readString(Ptr);
655 Im.Kind = readUint8(Ptr);
657 case wasm::WASM_EXTERNAL_FUNCTION:
658 NumImportedFunctions++;
659 Im.SigIndex = readVaruint32(Ptr);
661 case wasm::WASM_EXTERNAL_GLOBAL:
662 NumImportedGlobals++;
663 Im.Global.Type = readVarint7(Ptr);
664 Im.Global.Mutable = readVaruint1(Ptr);
666 case wasm::WASM_EXTERNAL_MEMORY:
667 Im.Memory = readLimits(Ptr);
669 case wasm::WASM_EXTERNAL_TABLE:
670 Im.Table = readTable(Ptr);
671 if (Im.Table.ElemType != wasm::WASM_TYPE_ANYFUNC)
672 return make_error<GenericBinaryError>("Invalid table element type",
673 object_error::parse_failed);
676 return make_error<GenericBinaryError>(
677 "Unexpected import kind", object_error::parse_failed);
679 Imports.push_back(Im);
682 return make_error<GenericBinaryError>("Import section ended prematurely",
683 object_error::parse_failed);
684 return Error::success();
687 Error WasmObjectFile::parseFunctionSection(const uint8_t *Ptr, const uint8_t *End) {
688 uint32_t Count = readVaruint32(Ptr);
689 FunctionTypes.reserve(Count);
691 FunctionTypes.push_back(readVaruint32(Ptr));
694 return make_error<GenericBinaryError>("Function section ended prematurely",
695 object_error::parse_failed);
696 return Error::success();
699 Error WasmObjectFile::parseTableSection(const uint8_t *Ptr, const uint8_t *End) {
700 uint32_t Count = readVaruint32(Ptr);
701 Tables.reserve(Count);
703 Tables.push_back(readTable(Ptr));
704 if (Tables.back().ElemType != wasm::WASM_TYPE_ANYFUNC) {
705 return make_error<GenericBinaryError>("Invalid table element type",
706 object_error::parse_failed);
710 return make_error<GenericBinaryError>("Table section ended prematurely",
711 object_error::parse_failed);
712 return Error::success();
715 Error WasmObjectFile::parseMemorySection(const uint8_t *Ptr, const uint8_t *End) {
716 uint32_t Count = readVaruint32(Ptr);
717 Memories.reserve(Count);
719 Memories.push_back(readLimits(Ptr));
722 return make_error<GenericBinaryError>("Memory section ended prematurely",
723 object_error::parse_failed);
724 return Error::success();
727 Error WasmObjectFile::parseGlobalSection(const uint8_t *Ptr, const uint8_t *End) {
728 GlobalSection = Sections.size();
729 uint32_t Count = readVaruint32(Ptr);
730 Globals.reserve(Count);
732 wasm::WasmGlobal Global;
733 Global.Index = NumImportedGlobals + Globals.size();
734 Global.Type.Type = readVarint7(Ptr);
735 Global.Type.Mutable = readVaruint1(Ptr);
736 if (Error Err = readInitExpr(Global.InitExpr, Ptr))
738 Globals.push_back(Global);
741 return make_error<GenericBinaryError>("Global section ended prematurely",
742 object_error::parse_failed);
743 return Error::success();
746 Error WasmObjectFile::parseExportSection(const uint8_t *Ptr, const uint8_t *End) {
747 uint32_t Count = readVaruint32(Ptr);
748 Exports.reserve(Count);
749 for (uint32_t i = 0; i < Count; i++) {
751 Ex.Name = readString(Ptr);
752 Ex.Kind = readUint8(Ptr);
753 Ex.Index = readVaruint32(Ptr);
755 case wasm::WASM_EXTERNAL_FUNCTION:
756 if (!isValidFunctionIndex(Ex.Index))
757 return make_error<GenericBinaryError>("Invalid function export",
758 object_error::parse_failed);
760 case wasm::WASM_EXTERNAL_GLOBAL:
761 if (!isValidGlobalIndex(Ex.Index))
762 return make_error<GenericBinaryError>("Invalid global export",
763 object_error::parse_failed);
765 case wasm::WASM_EXTERNAL_MEMORY:
766 case wasm::WASM_EXTERNAL_TABLE:
769 return make_error<GenericBinaryError>(
770 "Unexpected export kind", object_error::parse_failed);
772 Exports.push_back(Ex);
775 return make_error<GenericBinaryError>("Export section ended prematurely",
776 object_error::parse_failed);
777 return Error::success();
780 bool WasmObjectFile::isValidFunctionIndex(uint32_t Index) const {
781 return Index < NumImportedFunctions + FunctionTypes.size();
784 bool WasmObjectFile::isDefinedFunctionIndex(uint32_t Index) const {
785 return Index >= NumImportedFunctions && isValidFunctionIndex(Index);
788 bool WasmObjectFile::isValidGlobalIndex(uint32_t Index) const {
789 return Index < NumImportedGlobals + Globals.size();
792 bool WasmObjectFile::isDefinedGlobalIndex(uint32_t Index) const {
793 return Index >= NumImportedGlobals && isValidGlobalIndex(Index);
796 bool WasmObjectFile::isValidFunctionSymbolIndex(uint32_t Index) const {
797 return Index < Symbols.size() && Symbols[Index].isTypeFunction();
800 wasm::WasmFunction &WasmObjectFile::getDefinedFunction(uint32_t Index) {
801 assert(isDefinedFunctionIndex(Index));
802 return Functions[Index - NumImportedFunctions];
805 wasm::WasmGlobal &WasmObjectFile::getDefinedGlobal(uint32_t Index) {
806 assert(isDefinedGlobalIndex(Index));
807 return Globals[Index - NumImportedGlobals];
810 Error WasmObjectFile::parseStartSection(const uint8_t *Ptr, const uint8_t *End) {
811 StartFunction = readVaruint32(Ptr);
812 if (!isValidFunctionIndex(StartFunction))
813 return make_error<GenericBinaryError>("Invalid start function",
814 object_error::parse_failed);
815 return Error::success();
818 Error WasmObjectFile::parseCodeSection(const uint8_t *Ptr, const uint8_t *End) {
819 CodeSection = Sections.size();
820 const uint8_t *CodeSectionStart = Ptr;
821 uint32_t FunctionCount = readVaruint32(Ptr);
822 if (FunctionCount != FunctionTypes.size()) {
823 return make_error<GenericBinaryError>("Invalid function count",
824 object_error::parse_failed);
827 while (FunctionCount--) {
828 wasm::WasmFunction Function;
829 const uint8_t *FunctionStart = Ptr;
830 uint32_t Size = readVaruint32(Ptr);
831 const uint8_t *FunctionEnd = Ptr + Size;
833 Function.Index = NumImportedFunctions + Functions.size();
834 Function.CodeSectionOffset = FunctionStart - CodeSectionStart;
835 Function.Size = FunctionEnd - FunctionStart;
837 uint32_t NumLocalDecls = readVaruint32(Ptr);
838 Function.Locals.reserve(NumLocalDecls);
839 while (NumLocalDecls--) {
840 wasm::WasmLocalDecl Decl;
841 Decl.Count = readVaruint32(Ptr);
842 Decl.Type = readVarint7(Ptr);
843 Function.Locals.push_back(Decl);
846 uint32_t BodySize = FunctionEnd - Ptr;
847 Function.Body = ArrayRef<uint8_t>(Ptr, BodySize);
849 assert(Ptr == FunctionEnd);
850 Functions.push_back(Function);
853 return make_error<GenericBinaryError>("Code section ended prematurely",
854 object_error::parse_failed);
855 return Error::success();
858 Error WasmObjectFile::parseElemSection(const uint8_t *Ptr, const uint8_t *End) {
859 uint32_t Count = readVaruint32(Ptr);
860 ElemSegments.reserve(Count);
862 wasm::WasmElemSegment Segment;
863 Segment.TableIndex = readVaruint32(Ptr);
864 if (Segment.TableIndex != 0) {
865 return make_error<GenericBinaryError>("Invalid TableIndex",
866 object_error::parse_failed);
868 if (Error Err = readInitExpr(Segment.Offset, Ptr))
870 uint32_t NumElems = readVaruint32(Ptr);
872 Segment.Functions.push_back(readVaruint32(Ptr));
874 ElemSegments.push_back(Segment);
877 return make_error<GenericBinaryError>("Elem section ended prematurely",
878 object_error::parse_failed);
879 return Error::success();
882 Error WasmObjectFile::parseDataSection(const uint8_t *Ptr, const uint8_t *End) {
883 DataSection = Sections.size();
884 const uint8_t *Start = Ptr;
885 uint32_t Count = readVaruint32(Ptr);
886 DataSegments.reserve(Count);
889 Segment.Data.MemoryIndex = readVaruint32(Ptr);
890 if (Error Err = readInitExpr(Segment.Data.Offset, Ptr))
892 uint32_t Size = readVaruint32(Ptr);
893 Segment.Data.Content = ArrayRef<uint8_t>(Ptr, Size);
894 Segment.Data.Alignment = 0;
895 Segment.Data.Flags = 0;
896 Segment.SectionOffset = Ptr - Start;
898 DataSegments.push_back(Segment);
901 return make_error<GenericBinaryError>("Data section ended prematurely",
902 object_error::parse_failed);
903 return Error::success();
906 const uint8_t *WasmObjectFile::getPtr(size_t Offset) const {
907 return reinterpret_cast<const uint8_t *>(getData().substr(Offset, 1).data());
910 const wasm::WasmObjectHeader &WasmObjectFile::getHeader() const {
914 void WasmObjectFile::moveSymbolNext(DataRefImpl &Symb) const { Symb.d.a++; }
916 uint32_t WasmObjectFile::getSymbolFlags(DataRefImpl Symb) const {
917 uint32_t Result = SymbolRef::SF_None;
918 const WasmSymbol &Sym = getWasmSymbol(Symb);
920 DEBUG(dbgs() << "getSymbolFlags: ptr=" << &Sym << " " << Sym << "\n");
921 if (Sym.isBindingWeak())
922 Result |= SymbolRef::SF_Weak;
923 if (!Sym.isBindingLocal())
924 Result |= SymbolRef::SF_Global;
926 Result |= SymbolRef::SF_Hidden;
927 if (!Sym.isDefined())
928 Result |= SymbolRef::SF_Undefined;
929 if (Sym.isTypeFunction())
930 Result |= SymbolRef::SF_Executable;
934 basic_symbol_iterator WasmObjectFile::symbol_begin() const {
937 return BasicSymbolRef(Ref, this);
940 basic_symbol_iterator WasmObjectFile::symbol_end() const {
942 Ref.d.a = Symbols.size();
943 return BasicSymbolRef(Ref, this);
946 const WasmSymbol &WasmObjectFile::getWasmSymbol(const DataRefImpl &Symb) const {
947 return Symbols[Symb.d.a];
950 const WasmSymbol &WasmObjectFile::getWasmSymbol(const SymbolRef &Symb) const {
951 return getWasmSymbol(Symb.getRawDataRefImpl());
954 Expected<StringRef> WasmObjectFile::getSymbolName(DataRefImpl Symb) const {
955 return getWasmSymbol(Symb).Info.Name;
958 Expected<uint64_t> WasmObjectFile::getSymbolAddress(DataRefImpl Symb) const {
959 return getSymbolValue(Symb);
962 uint64_t WasmObjectFile::getWasmSymbolValue(const WasmSymbol& Sym) const {
963 switch (Sym.Info.Kind) {
964 case wasm::WASM_SYMBOL_TYPE_FUNCTION:
965 case wasm::WASM_SYMBOL_TYPE_GLOBAL:
966 return Sym.Info.ElementIndex;
967 case wasm::WASM_SYMBOL_TYPE_DATA: {
968 // The value of a data symbol is the segment offset, plus the symbol
969 // offset within the segment.
970 uint32_t SegmentIndex = Sym.Info.DataRef.Segment;
971 const wasm::WasmDataSegment &Segment = DataSegments[SegmentIndex].Data;
972 assert(Segment.Offset.Opcode == wasm::WASM_OPCODE_I32_CONST);
973 return Segment.Offset.Value.Int32 + Sym.Info.DataRef.Offset;
976 llvm_unreachable("invalid symbol type");
979 uint64_t WasmObjectFile::getSymbolValueImpl(DataRefImpl Symb) const {
980 return getWasmSymbolValue(getWasmSymbol(Symb));
983 uint32_t WasmObjectFile::getSymbolAlignment(DataRefImpl Symb) const {
984 llvm_unreachable("not yet implemented");
988 uint64_t WasmObjectFile::getCommonSymbolSizeImpl(DataRefImpl Symb) const {
989 llvm_unreachable("not yet implemented");
993 Expected<SymbolRef::Type>
994 WasmObjectFile::getSymbolType(DataRefImpl Symb) const {
995 const WasmSymbol &Sym = getWasmSymbol(Symb);
997 switch (Sym.Info.Kind) {
998 case wasm::WASM_SYMBOL_TYPE_FUNCTION:
999 return SymbolRef::ST_Function;
1000 case wasm::WASM_SYMBOL_TYPE_GLOBAL:
1001 return SymbolRef::ST_Other;
1002 case wasm::WASM_SYMBOL_TYPE_DATA:
1003 return SymbolRef::ST_Data;
1006 llvm_unreachable("Unknown WasmSymbol::SymbolType");
1007 return SymbolRef::ST_Other;
1010 Expected<section_iterator>
1011 WasmObjectFile::getSymbolSection(DataRefImpl Symb) const {
1012 const WasmSymbol& Sym = getWasmSymbol(Symb);
1013 if (Sym.isUndefined())
1014 return section_end();
1017 switch (Sym.Info.Kind) {
1018 case wasm::WASM_SYMBOL_TYPE_FUNCTION:
1019 Ref.d.a = CodeSection;
1021 case wasm::WASM_SYMBOL_TYPE_GLOBAL:
1022 Ref.d.a = GlobalSection;
1024 case wasm::WASM_SYMBOL_TYPE_DATA:
1025 Ref.d.a = DataSection;
1028 llvm_unreachable("Unknown WasmSymbol::SymbolType");
1030 return section_iterator(SectionRef(Ref, this));
1033 void WasmObjectFile::moveSectionNext(DataRefImpl &Sec) const { Sec.d.a++; }
1035 std::error_code WasmObjectFile::getSectionName(DataRefImpl Sec,
1036 StringRef &Res) const {
1037 const WasmSection &S = Sections[Sec.d.a];
1039 case wasm::WASM_SEC_##X: \
1054 case wasm::WASM_SEC_CUSTOM:
1058 return object_error::invalid_section_index;
1061 return std::error_code();
1064 uint64_t WasmObjectFile::getSectionAddress(DataRefImpl Sec) const { return 0; }
1066 uint64_t WasmObjectFile::getSectionIndex(DataRefImpl Sec) const {
1070 uint64_t WasmObjectFile::getSectionSize(DataRefImpl Sec) const {
1071 const WasmSection &S = Sections[Sec.d.a];
1072 return S.Content.size();
1075 std::error_code WasmObjectFile::getSectionContents(DataRefImpl Sec,
1076 StringRef &Res) const {
1077 const WasmSection &S = Sections[Sec.d.a];
1078 // This will never fail since wasm sections can never be empty (user-sections
1079 // must have a name and non-user sections each have a defined structure).
1080 Res = StringRef(reinterpret_cast<const char *>(S.Content.data()),
1082 return std::error_code();
1085 uint64_t WasmObjectFile::getSectionAlignment(DataRefImpl Sec) const {
1089 bool WasmObjectFile::isSectionCompressed(DataRefImpl Sec) const {
1093 bool WasmObjectFile::isSectionText(DataRefImpl Sec) const {
1094 return getWasmSection(Sec).Type == wasm::WASM_SEC_CODE;
1097 bool WasmObjectFile::isSectionData(DataRefImpl Sec) const {
1098 return getWasmSection(Sec).Type == wasm::WASM_SEC_DATA;
1101 bool WasmObjectFile::isSectionBSS(DataRefImpl Sec) const { return false; }
1103 bool WasmObjectFile::isSectionVirtual(DataRefImpl Sec) const { return false; }
1105 bool WasmObjectFile::isSectionBitcode(DataRefImpl Sec) const { return false; }
1107 relocation_iterator WasmObjectFile::section_rel_begin(DataRefImpl Ref) const {
1108 DataRefImpl RelocRef;
1109 RelocRef.d.a = Ref.d.a;
1111 return relocation_iterator(RelocationRef(RelocRef, this));
1114 relocation_iterator WasmObjectFile::section_rel_end(DataRefImpl Ref) const {
1115 const WasmSection &Sec = getWasmSection(Ref);
1116 DataRefImpl RelocRef;
1117 RelocRef.d.a = Ref.d.a;
1118 RelocRef.d.b = Sec.Relocations.size();
1119 return relocation_iterator(RelocationRef(RelocRef, this));
1122 void WasmObjectFile::moveRelocationNext(DataRefImpl &Rel) const {
1126 uint64_t WasmObjectFile::getRelocationOffset(DataRefImpl Ref) const {
1127 const wasm::WasmRelocation &Rel = getWasmRelocation(Ref);
1131 symbol_iterator WasmObjectFile::getRelocationSymbol(DataRefImpl Rel) const {
1132 llvm_unreachable("not yet implemented");
1134 return symbol_iterator(Ref);
1137 uint64_t WasmObjectFile::getRelocationType(DataRefImpl Ref) const {
1138 const wasm::WasmRelocation &Rel = getWasmRelocation(Ref);
1142 void WasmObjectFile::getRelocationTypeName(
1143 DataRefImpl Ref, SmallVectorImpl<char> &Result) const {
1144 const wasm::WasmRelocation& Rel = getWasmRelocation(Ref);
1145 StringRef Res = "Unknown";
1147 #define WASM_RELOC(name, value) \
1153 #include "llvm/BinaryFormat/WasmRelocs.def"
1158 Result.append(Res.begin(), Res.end());
1161 section_iterator WasmObjectFile::section_begin() const {
1164 return section_iterator(SectionRef(Ref, this));
1167 section_iterator WasmObjectFile::section_end() const {
1169 Ref.d.a = Sections.size();
1170 return section_iterator(SectionRef(Ref, this));
1173 uint8_t WasmObjectFile::getBytesInAddress() const { return 4; }
1175 StringRef WasmObjectFile::getFileFormatName() const { return "WASM"; }
1177 Triple::ArchType WasmObjectFile::getArch() const { return Triple::wasm32; }
1179 SubtargetFeatures WasmObjectFile::getFeatures() const {
1180 return SubtargetFeatures();
1183 bool WasmObjectFile::isRelocatableObject() const {
1184 return HasLinkingSection;
1187 const WasmSection &WasmObjectFile::getWasmSection(DataRefImpl Ref) const {
1188 assert(Ref.d.a < Sections.size());
1189 return Sections[Ref.d.a];
1193 WasmObjectFile::getWasmSection(const SectionRef &Section) const {
1194 return getWasmSection(Section.getRawDataRefImpl());
1197 const wasm::WasmRelocation &
1198 WasmObjectFile::getWasmRelocation(const RelocationRef &Ref) const {
1199 return getWasmRelocation(Ref.getRawDataRefImpl());
1202 const wasm::WasmRelocation &
1203 WasmObjectFile::getWasmRelocation(DataRefImpl Ref) const {
1204 assert(Ref.d.a < Sections.size());
1205 const WasmSection& Sec = Sections[Ref.d.a];
1206 assert(Ref.d.b < Sec.Relocations.size());
1207 return Sec.Relocations[Ref.d.b];