1//===- WasmObjectFile.cpp - Wasm object file implementation ---------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include "llvm/ADT/ArrayRef.h"
10#include "llvm/ADT/DenseSet.h"
11#include "llvm/ADT/SmallSet.h"
12#include "llvm/ADT/StringRef.h"
13#include "llvm/ADT/StringSet.h"
14#include "llvm/ADT/StringSwitch.h"
15#include "llvm/BinaryFormat/Wasm.h"
16#include "llvm/Object/Binary.h"
17#include "llvm/Object/Error.h"
18#include "llvm/Object/ObjectFile.h"
19#include "llvm/Object/SymbolicFile.h"
20#include "llvm/Object/Wasm.h"
21#include "llvm/Support/Endian.h"
22#include "llvm/Support/Error.h"
23#include "llvm/Support/ErrorHandling.h"
24#include "llvm/Support/LEB128.h"
25#include "llvm/Support/ScopedPrinter.h"
26#include "llvm/TargetParser/SubtargetFeature.h"
27#include "llvm/TargetParser/Triple.h"
28#include <cassert>
29#include <cstdint>
30#include <cstring>
31
32#define DEBUG_TYPE "wasm-object"
33
34using namespace llvm;
35using namespace object;
36
37void WasmSymbol::print(raw_ostream &Out) const {
38 Out << "Name=" << Info.Name
39 << ", Kind=" << toString(type: wasm::WasmSymbolType(Info.Kind)) << ", Flags=0x"
40 << Twine::utohexstr(Val: Info.Flags) << " [";
41 switch (getBinding()) {
42 case wasm::WASM_SYMBOL_BINDING_GLOBAL: Out << "global"; break;
43 case wasm::WASM_SYMBOL_BINDING_LOCAL: Out << "local"; break;
44 case wasm::WASM_SYMBOL_BINDING_WEAK: Out << "weak"; break;
45 }
46 if (isHidden())
47 Out << ", hidden";
48 else
49 Out << ", default";
50 if (Info.Flags & wasm::WASM_SYMBOL_NO_STRIP)
51 Out << ", no_strip";
52 if (Info.Flags & wasm::WASM_SYMBOL_TLS)
53 Out << ", tls";
54 if (Info.Flags & wasm::WASM_SYMBOL_ABSOLUTE)
55 Out << ", absolute";
56 if (Info.Flags & wasm::WASM_SYMBOL_EXPORTED)
57 Out << ", exported";
58 if (isUndefined())
59 Out << ", undefined";
60 Out << "]";
61 if (!isTypeData()) {
62 Out << ", ElemIndex=" << Info.ElementIndex;
63 } else if (isDefined()) {
64 Out << ", Segment=" << Info.DataRef.Segment;
65 Out << ", Offset=" << Info.DataRef.Offset;
66 Out << ", Size=" << Info.DataRef.Size;
67 }
68}
69
70#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
71LLVM_DUMP_METHOD void WasmSymbol::dump() const { print(dbgs()); }
72#endif
73
74Expected<std::unique_ptr<WasmObjectFile>>
75ObjectFile::createWasmObjectFile(MemoryBufferRef Buffer) {
76 Error Err = Error::success();
77 auto ObjectFile = std::make_unique<WasmObjectFile>(args&: Buffer, args&: Err);
78 if (Err)
79 return std::move(Err);
80
81 return std::move(ObjectFile);
82}
83
84#define VARINT7_MAX ((1 << 7) - 1)
85#define VARINT7_MIN (-(1 << 7))
86#define VARUINT7_MAX (1 << 7)
87#define VARUINT1_MAX (1)
88
89static uint8_t readUint8(WasmObjectFile::ReadContext &Ctx) {
90 if (Ctx.Ptr == Ctx.End)
91 report_fatal_error(reason: "EOF while reading uint8");
92 return *Ctx.Ptr++;
93}
94
95static uint32_t readUint32(WasmObjectFile::ReadContext &Ctx) {
96 if (Ctx.Ptr + 4 > Ctx.End)
97 report_fatal_error(reason: "EOF while reading uint32");
98 uint32_t Result = support::endian::read32le(P: Ctx.Ptr);
99 Ctx.Ptr += 4;
100 return Result;
101}
102
103static int32_t readFloat32(WasmObjectFile::ReadContext &Ctx) {
104 if (Ctx.Ptr + 4 > Ctx.End)
105 report_fatal_error(reason: "EOF while reading float64");
106 int32_t Result = 0;
107 memcpy(dest: &Result, src: Ctx.Ptr, n: sizeof(Result));
108 Ctx.Ptr += sizeof(Result);
109 return Result;
110}
111
112static int64_t readFloat64(WasmObjectFile::ReadContext &Ctx) {
113 if (Ctx.Ptr + 8 > Ctx.End)
114 report_fatal_error(reason: "EOF while reading float64");
115 int64_t Result = 0;
116 memcpy(dest: &Result, src: Ctx.Ptr, n: sizeof(Result));
117 Ctx.Ptr += sizeof(Result);
118 return Result;
119}
120
121static uint64_t readULEB128(WasmObjectFile::ReadContext &Ctx) {
122 unsigned Count;
123 const char *Error = nullptr;
124 uint64_t Result = decodeULEB128(p: Ctx.Ptr, n: &Count, end: Ctx.End, error: &Error);
125 if (Error)
126 report_fatal_error(reason: Error);
127 Ctx.Ptr += Count;
128 return Result;
129}
130
131static StringRef readString(WasmObjectFile::ReadContext &Ctx) {
132 uint32_t StringLen = readULEB128(Ctx);
133 if (Ctx.Ptr + StringLen > Ctx.End)
134 report_fatal_error(reason: "EOF while reading string");
135 StringRef Return =
136 StringRef(reinterpret_cast<const char *>(Ctx.Ptr), StringLen);
137 Ctx.Ptr += StringLen;
138 return Return;
139}
140
141static int64_t readLEB128(WasmObjectFile::ReadContext &Ctx) {
142 unsigned Count;
143 const char *Error = nullptr;
144 uint64_t Result = decodeSLEB128(p: Ctx.Ptr, n: &Count, end: Ctx.End, error: &Error);
145 if (Error)
146 report_fatal_error(reason: Error);
147 Ctx.Ptr += Count;
148 return Result;
149}
150
151static uint8_t readVaruint1(WasmObjectFile::ReadContext &Ctx) {
152 int64_t Result = readLEB128(Ctx);
153 if (Result > VARUINT1_MAX || Result < 0)
154 report_fatal_error(reason: "LEB is outside Varuint1 range");
155 return Result;
156}
157
158static int32_t readVarint32(WasmObjectFile::ReadContext &Ctx) {
159 int64_t Result = readLEB128(Ctx);
160 if (Result > INT32_MAX || Result < INT32_MIN)
161 report_fatal_error(reason: "LEB is outside Varint32 range");
162 return Result;
163}
164
165static uint32_t readVaruint32(WasmObjectFile::ReadContext &Ctx) {
166 uint64_t Result = readULEB128(Ctx);
167 if (Result > UINT32_MAX)
168 report_fatal_error(reason: "LEB is outside Varuint32 range");
169 return Result;
170}
171
172static int64_t readVarint64(WasmObjectFile::ReadContext &Ctx) {
173 return readLEB128(Ctx);
174}
175
176static uint64_t readVaruint64(WasmObjectFile::ReadContext &Ctx) {
177 return readULEB128(Ctx);
178}
179
180static uint8_t readOpcode(WasmObjectFile::ReadContext &Ctx) {
181 return readUint8(Ctx);
182}
183
184static wasm::ValType parseValType(WasmObjectFile::ReadContext &Ctx,
185 uint32_t Code) {
186 // only directly encoded FUNCREF/EXTERNREF/EXNREF are supported
187 // (not ref null func, ref null extern, or ref null exn)
188 switch (Code) {
189 case wasm::WASM_TYPE_I32:
190 case wasm::WASM_TYPE_I64:
191 case wasm::WASM_TYPE_F32:
192 case wasm::WASM_TYPE_F64:
193 case wasm::WASM_TYPE_V128:
194 case wasm::WASM_TYPE_FUNCREF:
195 case wasm::WASM_TYPE_EXTERNREF:
196 case wasm::WASM_TYPE_EXNREF:
197 return wasm::ValType(Code);
198 }
199 if (Code == wasm::WASM_TYPE_NULLABLE || Code == wasm::WASM_TYPE_NONNULLABLE) {
200 /* Discard HeapType */ readVarint64(Ctx);
201 }
202 return wasm::ValType(wasm::ValType::OTHERREF);
203}
204
205static Error readInitExpr(wasm::WasmInitExpr &Expr,
206 WasmObjectFile::ReadContext &Ctx) {
207 auto Start = Ctx.Ptr;
208
209 Expr.Extended = false;
210 Expr.Inst.Opcode = readOpcode(Ctx);
211 switch (Expr.Inst.Opcode) {
212 case wasm::WASM_OPCODE_I32_CONST:
213 Expr.Inst.Value.Int32 = readVarint32(Ctx);
214 break;
215 case wasm::WASM_OPCODE_I64_CONST:
216 Expr.Inst.Value.Int64 = readVarint64(Ctx);
217 break;
218 case wasm::WASM_OPCODE_F32_CONST:
219 Expr.Inst.Value.Float32 = readFloat32(Ctx);
220 break;
221 case wasm::WASM_OPCODE_F64_CONST:
222 Expr.Inst.Value.Float64 = readFloat64(Ctx);
223 break;
224 case wasm::WASM_OPCODE_GLOBAL_GET:
225 Expr.Inst.Value.Global = readULEB128(Ctx);
226 break;
227 case wasm::WASM_OPCODE_REF_NULL: {
228 /* Discard type */ parseValType(Ctx, Code: readVaruint32(Ctx));
229 break;
230 }
231 default:
232 Expr.Extended = true;
233 }
234
235 if (!Expr.Extended) {
236 uint8_t EndOpcode = readOpcode(Ctx);
237 if (EndOpcode != wasm::WASM_OPCODE_END)
238 Expr.Extended = true;
239 }
240
241 if (Expr.Extended) {
242 Ctx.Ptr = Start;
243 while (true) {
244 uint8_t Opcode = readOpcode(Ctx);
245 switch (Opcode) {
246 case wasm::WASM_OPCODE_I32_CONST:
247 case wasm::WASM_OPCODE_GLOBAL_GET:
248 case wasm::WASM_OPCODE_REF_NULL:
249 case wasm::WASM_OPCODE_REF_FUNC:
250 case wasm::WASM_OPCODE_I64_CONST:
251 readULEB128(Ctx);
252 break;
253 case wasm::WASM_OPCODE_F32_CONST:
254 readFloat32(Ctx);
255 break;
256 case wasm::WASM_OPCODE_F64_CONST:
257 readFloat64(Ctx);
258 break;
259 case wasm::WASM_OPCODE_I32_ADD:
260 case wasm::WASM_OPCODE_I32_SUB:
261 case wasm::WASM_OPCODE_I32_MUL:
262 case wasm::WASM_OPCODE_I64_ADD:
263 case wasm::WASM_OPCODE_I64_SUB:
264 case wasm::WASM_OPCODE_I64_MUL:
265 break;
266 case wasm::WASM_OPCODE_GC_PREFIX:
267 break;
268 // The GC opcodes are in a separate (prefixed space). This flat switch
269 // structure works as long as there is no overlap between the GC and
270 // general opcodes used in init exprs.
271 case wasm::WASM_OPCODE_STRUCT_NEW:
272 case wasm::WASM_OPCODE_STRUCT_NEW_DEFAULT:
273 case wasm::WASM_OPCODE_ARRAY_NEW:
274 case wasm::WASM_OPCODE_ARRAY_NEW_DEFAULT:
275 readULEB128(Ctx); // heap type index
276 break;
277 case wasm::WASM_OPCODE_ARRAY_NEW_FIXED:
278 readULEB128(Ctx); // heap type index
279 readULEB128(Ctx); // array size
280 break;
281 case wasm::WASM_OPCODE_REF_I31:
282 break;
283 case wasm::WASM_OPCODE_END:
284 Expr.Body = ArrayRef<uint8_t>(Start, Ctx.Ptr - Start);
285 return Error::success();
286 default:
287 return make_error<GenericBinaryError>(
288 Args: Twine("invalid opcode in init_expr: ") + Twine(unsigned(Opcode)),
289 Args: object_error::parse_failed);
290 }
291 }
292 }
293
294 return Error::success();
295}
296
297static wasm::WasmLimits readLimits(WasmObjectFile::ReadContext &Ctx) {
298 wasm::WasmLimits Result;
299 Result.Flags = readVaruint32(Ctx);
300 Result.Minimum = readVaruint64(Ctx);
301 if (Result.Flags & wasm::WASM_LIMITS_FLAG_HAS_MAX)
302 Result.Maximum = readVaruint64(Ctx);
303 if (Result.Flags & wasm::WASM_LIMITS_FLAG_HAS_PAGE_SIZE) {
304 uint32_t PageSizeLog2 = readVaruint32(Ctx);
305 if (PageSizeLog2 >= 32)
306 report_fatal_error(reason: "log2(wasm page size) too large");
307 Result.PageSize = 1 << PageSizeLog2;
308 }
309 return Result;
310}
311
312static wasm::WasmTableType readTableType(WasmObjectFile::ReadContext &Ctx) {
313 wasm::WasmTableType TableType;
314 auto ElemType = parseValType(Ctx, Code: readVaruint32(Ctx));
315 TableType.ElemType = ElemType;
316 TableType.Limits = readLimits(Ctx);
317 return TableType;
318}
319
320static Error readSection(WasmSection &Section, WasmObjectFile::ReadContext &Ctx,
321 WasmSectionOrderChecker &Checker) {
322 Section.Type = readUint8(Ctx);
323 LLVM_DEBUG(dbgs() << "readSection type=" << Section.Type << "\n");
324 // When reading the section's size, store the size of the LEB used to encode
325 // it. This allows objcopy/strip to reproduce the binary identically.
326 const uint8_t *PreSizePtr = Ctx.Ptr;
327 uint32_t Size = readVaruint32(Ctx);
328 Section.HeaderSecSizeEncodingLen = Ctx.Ptr - PreSizePtr;
329 Section.Offset = Ctx.Ptr - Ctx.Start;
330 if (Size == 0)
331 return make_error<StringError>(Args: "zero length section",
332 Args: object_error::parse_failed);
333 if (Ctx.Ptr + Size > Ctx.End)
334 return make_error<StringError>(Args: "section too large",
335 Args: object_error::parse_failed);
336 if (Section.Type == wasm::WASM_SEC_CUSTOM) {
337 WasmObjectFile::ReadContext SectionCtx;
338 SectionCtx.Start = Ctx.Ptr;
339 SectionCtx.Ptr = Ctx.Ptr;
340 SectionCtx.End = Ctx.Ptr + Size;
341
342 Section.Name = readString(Ctx&: SectionCtx);
343
344 uint32_t SectionNameSize = SectionCtx.Ptr - SectionCtx.Start;
345 Ctx.Ptr += SectionNameSize;
346 Size -= SectionNameSize;
347 }
348
349 if (!Checker.isValidSectionOrder(ID: Section.Type, CustomSectionName: Section.Name)) {
350 return make_error<StringError>(Args: "out of order section type: " +
351 llvm::to_string(Value: Section.Type),
352 Args: object_error::parse_failed);
353 }
354
355 Section.Content = ArrayRef<uint8_t>(Ctx.Ptr, Size);
356 Ctx.Ptr += Size;
357 return Error::success();
358}
359
360WasmObjectFile::WasmObjectFile(MemoryBufferRef Buffer, Error &Err)
361 : ObjectFile(Binary::ID_Wasm, Buffer) {
362 ErrorAsOutParameter ErrAsOutParam(Err);
363 Header.Magic = getData().substr(Start: 0, N: 4);
364 if (Header.Magic != StringRef("\0asm", 4)) {
365 Err = make_error<StringError>(Args: "invalid magic number",
366 Args: object_error::parse_failed);
367 return;
368 }
369
370 ReadContext Ctx;
371 Ctx.Start = getData().bytes_begin();
372 Ctx.Ptr = Ctx.Start + 4;
373 Ctx.End = Ctx.Start + getData().size();
374
375 if (Ctx.Ptr + 4 > Ctx.End) {
376 Err = make_error<StringError>(Args: "missing version number",
377 Args: object_error::parse_failed);
378 return;
379 }
380
381 Header.Version = readUint32(Ctx);
382 if (Header.Version != wasm::WasmVersion) {
383 Err = make_error<StringError>(Args: "invalid version number: " +
384 Twine(Header.Version),
385 Args: object_error::parse_failed);
386 return;
387 }
388
389 WasmSectionOrderChecker Checker;
390 while (Ctx.Ptr < Ctx.End) {
391 WasmSection Sec;
392 if ((Err = readSection(Section&: Sec, Ctx, Checker)))
393 return;
394 if ((Err = parseSection(Sec)))
395 return;
396
397 Sections.push_back(x: Sec);
398 }
399}
400
401Error WasmObjectFile::parseSection(WasmSection &Sec) {
402 ReadContext Ctx;
403 Ctx.Start = Sec.Content.data();
404 Ctx.End = Ctx.Start + Sec.Content.size();
405 Ctx.Ptr = Ctx.Start;
406 switch (Sec.Type) {
407 case wasm::WASM_SEC_CUSTOM:
408 return parseCustomSection(Sec, Ctx);
409 case wasm::WASM_SEC_TYPE:
410 return parseTypeSection(Ctx);
411 case wasm::WASM_SEC_IMPORT:
412 return parseImportSection(Ctx);
413 case wasm::WASM_SEC_FUNCTION:
414 return parseFunctionSection(Ctx);
415 case wasm::WASM_SEC_TABLE:
416 return parseTableSection(Ctx);
417 case wasm::WASM_SEC_MEMORY:
418 return parseMemorySection(Ctx);
419 case wasm::WASM_SEC_TAG:
420 return parseTagSection(Ctx);
421 case wasm::WASM_SEC_GLOBAL:
422 return parseGlobalSection(Ctx);
423 case wasm::WASM_SEC_EXPORT:
424 return parseExportSection(Ctx);
425 case wasm::WASM_SEC_START:
426 return parseStartSection(Ctx);
427 case wasm::WASM_SEC_ELEM:
428 return parseElemSection(Ctx);
429 case wasm::WASM_SEC_CODE:
430 return parseCodeSection(Ctx);
431 case wasm::WASM_SEC_DATA:
432 return parseDataSection(Ctx);
433 case wasm::WASM_SEC_DATACOUNT:
434 return parseDataCountSection(Ctx);
435 default:
436 return make_error<GenericBinaryError>(
437 Args: "invalid section type: " + Twine(Sec.Type), Args: object_error::parse_failed);
438 }
439}
440
441Error WasmObjectFile::parseDylinkSection(ReadContext &Ctx) {
442 // Legacy "dylink" section support.
443 // See parseDylink0Section for the current "dylink.0" section parsing.
444 HasDylinkSection = true;
445 DylinkInfo.MemorySize = readVaruint32(Ctx);
446 DylinkInfo.MemoryAlignment = readVaruint32(Ctx);
447 DylinkInfo.TableSize = readVaruint32(Ctx);
448 DylinkInfo.TableAlignment = readVaruint32(Ctx);
449 uint32_t Count = readVaruint32(Ctx);
450 while (Count--) {
451 DylinkInfo.Needed.push_back(x: readString(Ctx));
452 }
453
454 if (Ctx.Ptr != Ctx.End)
455 return make_error<GenericBinaryError>(Args: "dylink section ended prematurely",
456 Args: object_error::parse_failed);
457 return Error::success();
458}
459
460Error WasmObjectFile::parseDylink0Section(ReadContext &Ctx) {
461 // See
462 // https://github.com/WebAssembly/tool-conventions/blob/main/DynamicLinking.md
463 HasDylinkSection = true;
464
465 const uint8_t *OrigEnd = Ctx.End;
466 while (Ctx.Ptr < OrigEnd) {
467 Ctx.End = OrigEnd;
468 uint8_t Type = readUint8(Ctx);
469 uint32_t Size = readVaruint32(Ctx);
470 LLVM_DEBUG(dbgs() << "readSubsection type=" << int(Type) << " size=" << Size
471 << "\n");
472 Ctx.End = Ctx.Ptr + Size;
473 uint32_t Count;
474 switch (Type) {
475 case wasm::WASM_DYLINK_MEM_INFO:
476 DylinkInfo.MemorySize = readVaruint32(Ctx);
477 DylinkInfo.MemoryAlignment = readVaruint32(Ctx);
478 DylinkInfo.TableSize = readVaruint32(Ctx);
479 DylinkInfo.TableAlignment = readVaruint32(Ctx);
480 break;
481 case wasm::WASM_DYLINK_NEEDED:
482 Count = readVaruint32(Ctx);
483 while (Count--) {
484 DylinkInfo.Needed.push_back(x: readString(Ctx));
485 }
486 break;
487 case wasm::WASM_DYLINK_EXPORT_INFO: {
488 uint32_t Count = readVaruint32(Ctx);
489 while (Count--) {
490 DylinkInfo.ExportInfo.push_back(x: {.Name: readString(Ctx), .Flags: readVaruint32(Ctx)});
491 }
492 break;
493 }
494 case wasm::WASM_DYLINK_IMPORT_INFO: {
495 uint32_t Count = readVaruint32(Ctx);
496 while (Count--) {
497 DylinkInfo.ImportInfo.push_back(
498 x: {.Module: readString(Ctx), .Field: readString(Ctx), .Flags: readVaruint32(Ctx)});
499 }
500 break;
501 }
502 case wasm::WASM_DYLINK_RUNTIME_PATH: {
503 Count = readVaruint32(Ctx);
504 while (Count--) {
505 DylinkInfo.RuntimePath.push_back(x: readString(Ctx));
506 }
507 break;
508 }
509 default:
510 LLVM_DEBUG(dbgs() << "unknown dylink.0 sub-section: " << Type << "\n");
511 Ctx.Ptr += Size;
512 break;
513 }
514 if (Ctx.Ptr != Ctx.End) {
515 return make_error<GenericBinaryError>(
516 Args: "dylink.0 sub-section ended prematurely", Args: object_error::parse_failed);
517 }
518 }
519
520 if (Ctx.Ptr != Ctx.End)
521 return make_error<GenericBinaryError>(Args: "dylink.0 section ended prematurely",
522 Args: object_error::parse_failed);
523 return Error::success();
524}
525
526Error WasmObjectFile::parseNameSection(ReadContext &Ctx) {
527 llvm::DenseSet<uint64_t> SeenFunctions;
528 llvm::DenseSet<uint64_t> SeenGlobals;
529 llvm::DenseSet<uint64_t> SeenSegments;
530
531 // If we have linking section (symbol table) or if we are parsing a DSO
532 // then we don't use the name section for symbol information.
533 bool PopulateSymbolTable = !HasLinkingSection && !HasDylinkSection;
534
535 // If we are using the name section for symbol information then it will
536 // supersede any symbols created by the export section.
537 if (PopulateSymbolTable)
538 Symbols.clear();
539
540 while (Ctx.Ptr < Ctx.End) {
541 uint8_t Type = readUint8(Ctx);
542 uint32_t Size = readVaruint32(Ctx);
543 const uint8_t *SubSectionEnd = Ctx.Ptr + Size;
544
545 switch (Type) {
546 case wasm::WASM_NAMES_FUNCTION:
547 case wasm::WASM_NAMES_GLOBAL:
548 case wasm::WASM_NAMES_DATA_SEGMENT: {
549 uint32_t Count = readVaruint32(Ctx);
550 while (Count--) {
551 uint32_t Index = readVaruint32(Ctx);
552 StringRef Name = readString(Ctx);
553 wasm::NameType nameType = wasm::NameType::FUNCTION;
554 wasm::WasmSymbolInfo Info{.Name: Name,
555 /*Kind */ wasm::WASM_SYMBOL_TYPE_FUNCTION,
556 /* Flags */ 0,
557 /* ImportModule */ std::nullopt,
558 /* ImportName */ std::nullopt,
559 /* ExportName */ std::nullopt,
560 {/* ElementIndex */ Index}};
561 const wasm::WasmSignature *Signature = nullptr;
562 const wasm::WasmGlobalType *GlobalType = nullptr;
563 const wasm::WasmTableType *TableType = nullptr;
564 if (Type == wasm::WASM_NAMES_FUNCTION) {
565 if (!SeenFunctions.insert(V: Index).second)
566 return make_error<GenericBinaryError>(
567 Args: "function named more than once", Args: object_error::parse_failed);
568 if (!isValidFunctionIndex(Index) || Name.empty())
569 return make_error<GenericBinaryError>(Args: "invalid function name entry",
570 Args: object_error::parse_failed);
571
572 if (isDefinedFunctionIndex(Index)) {
573 wasm::WasmFunction &F = getDefinedFunction(Index);
574 F.DebugName = Name;
575 Signature = &Signatures[F.SigIndex];
576 if (F.ExportName) {
577 Info.ExportName = F.ExportName;
578 Info.Flags |= wasm::WASM_SYMBOL_BINDING_GLOBAL;
579 } else {
580 Info.Flags |= wasm::WASM_SYMBOL_BINDING_LOCAL;
581 }
582 } else {
583 Info.Flags |= wasm::WASM_SYMBOL_UNDEFINED;
584 }
585 } else if (Type == wasm::WASM_NAMES_GLOBAL) {
586 if (!SeenGlobals.insert(V: Index).second)
587 return make_error<GenericBinaryError>(Args: "global named more than once",
588 Args: object_error::parse_failed);
589 if (!isValidGlobalIndex(Index) || Name.empty())
590 return make_error<GenericBinaryError>(Args: "invalid global name entry",
591 Args: object_error::parse_failed);
592 nameType = wasm::NameType::GLOBAL;
593 Info.Kind = wasm::WASM_SYMBOL_TYPE_GLOBAL;
594 if (isDefinedGlobalIndex(Index)) {
595 GlobalType = &getDefinedGlobal(Index).Type;
596 } else {
597 Info.Flags |= wasm::WASM_SYMBOL_UNDEFINED;
598 }
599 } else {
600 if (!SeenSegments.insert(V: Index).second)
601 return make_error<GenericBinaryError>(
602 Args: "segment named more than once", Args: object_error::parse_failed);
603 if (Index > DataSegments.size())
604 return make_error<GenericBinaryError>(Args: "invalid data segment name entry",
605 Args: object_error::parse_failed);
606 nameType = wasm::NameType::DATA_SEGMENT;
607 Info.Kind = wasm::WASM_SYMBOL_TYPE_DATA;
608 Info.Flags |= wasm::WASM_SYMBOL_BINDING_LOCAL;
609 assert(Index < DataSegments.size());
610 Info.DataRef = wasm::WasmDataReference{
611 .Segment: Index, .Offset: 0, .Size: DataSegments[Index].Data.Content.size()};
612 }
613 DebugNames.push_back(x: wasm::WasmDebugName{.Type: nameType, .Index: Index, .Name: Name});
614 if (PopulateSymbolTable)
615 Symbols.emplace_back(args&: Info, args&: GlobalType, args&: TableType, args&: Signature);
616 }
617 break;
618 }
619 // Ignore local names for now
620 case wasm::WASM_NAMES_LOCAL:
621 default:
622 Ctx.Ptr += Size;
623 break;
624 }
625 if (Ctx.Ptr != SubSectionEnd)
626 return make_error<GenericBinaryError>(
627 Args: "name sub-section ended prematurely", Args: object_error::parse_failed);
628 }
629
630 if (Ctx.Ptr != Ctx.End)
631 return make_error<GenericBinaryError>(Args: "name section ended prematurely",
632 Args: object_error::parse_failed);
633 return Error::success();
634}
635
636Error WasmObjectFile::parseLinkingSection(ReadContext &Ctx) {
637 HasLinkingSection = true;
638
639 LinkingData.Version = readVaruint32(Ctx);
640 if (LinkingData.Version != wasm::WasmMetadataVersion) {
641 return make_error<GenericBinaryError>(
642 Args: "unexpected metadata version: " + Twine(LinkingData.Version) +
643 " (Expected: " + Twine(wasm::WasmMetadataVersion) + ")",
644 Args: object_error::parse_failed);
645 }
646
647 const uint8_t *OrigEnd = Ctx.End;
648 while (Ctx.Ptr < OrigEnd) {
649 Ctx.End = OrigEnd;
650 uint8_t Type = readUint8(Ctx);
651 uint32_t Size = readVaruint32(Ctx);
652 LLVM_DEBUG(dbgs() << "readSubsection type=" << int(Type) << " size=" << Size
653 << "\n");
654 Ctx.End = Ctx.Ptr + Size;
655 switch (Type) {
656 case wasm::WASM_SYMBOL_TABLE:
657 if (Error Err = parseLinkingSectionSymtab(Ctx))
658 return Err;
659 break;
660 case wasm::WASM_SEGMENT_INFO: {
661 uint32_t Count = readVaruint32(Ctx);
662 if (Count > DataSegments.size())
663 return make_error<GenericBinaryError>(Args: "too many segment names",
664 Args: object_error::parse_failed);
665 for (uint32_t I = 0; I < Count; I++) {
666 DataSegments[I].Data.Name = readString(Ctx);
667 DataSegments[I].Data.Alignment = readVaruint32(Ctx);
668 DataSegments[I].Data.LinkingFlags = readVaruint32(Ctx);
669 }
670 break;
671 }
672 case wasm::WASM_INIT_FUNCS: {
673 uint32_t Count = readVaruint32(Ctx);
674 LinkingData.InitFunctions.reserve(n: Count);
675 for (uint32_t I = 0; I < Count; I++) {
676 wasm::WasmInitFunc Init;
677 Init.Priority = readVaruint32(Ctx);
678 Init.Symbol = readVaruint32(Ctx);
679 if (!isValidFunctionSymbol(Index: Init.Symbol))
680 return make_error<GenericBinaryError>(Args: "invalid function symbol: " +
681 Twine(Init.Symbol),
682 Args: object_error::parse_failed);
683 LinkingData.InitFunctions.emplace_back(args&: Init);
684 }
685 break;
686 }
687 case wasm::WASM_COMDAT_INFO:
688 if (Error Err = parseLinkingSectionComdat(Ctx))
689 return Err;
690 break;
691 default:
692 Ctx.Ptr += Size;
693 break;
694 }
695 if (Ctx.Ptr != Ctx.End)
696 return make_error<GenericBinaryError>(
697 Args: "linking sub-section ended prematurely", Args: object_error::parse_failed);
698 }
699 if (Ctx.Ptr != OrigEnd)
700 return make_error<GenericBinaryError>(Args: "linking section ended prematurely",
701 Args: object_error::parse_failed);
702 return Error::success();
703}
704
705Error WasmObjectFile::parseLinkingSectionSymtab(ReadContext &Ctx) {
706 uint32_t Count = readVaruint32(Ctx);
707 // Clear out any symbol information that was derived from the exports
708 // section.
709 Symbols.clear();
710 Symbols.reserve(n: Count);
711 StringSet<> SymbolNames;
712
713 std::vector<wasm::WasmImport *> ImportedGlobals;
714 std::vector<wasm::WasmImport *> ImportedFunctions;
715 std::vector<wasm::WasmImport *> ImportedTags;
716 std::vector<wasm::WasmImport *> ImportedTables;
717 ImportedGlobals.reserve(n: Imports.size());
718 ImportedFunctions.reserve(n: Imports.size());
719 ImportedTags.reserve(n: Imports.size());
720 ImportedTables.reserve(n: Imports.size());
721 for (auto &I : Imports) {
722 if (I.Kind == wasm::WASM_EXTERNAL_FUNCTION)
723 ImportedFunctions.emplace_back(args: &I);
724 else if (I.Kind == wasm::WASM_EXTERNAL_GLOBAL)
725 ImportedGlobals.emplace_back(args: &I);
726 else if (I.Kind == wasm::WASM_EXTERNAL_TAG)
727 ImportedTags.emplace_back(args: &I);
728 else if (I.Kind == wasm::WASM_EXTERNAL_TABLE)
729 ImportedTables.emplace_back(args: &I);
730 }
731
732 while (Count--) {
733 wasm::WasmSymbolInfo Info;
734 const wasm::WasmSignature *Signature = nullptr;
735 const wasm::WasmGlobalType *GlobalType = nullptr;
736 const wasm::WasmTableType *TableType = nullptr;
737
738 Info.Kind = readUint8(Ctx);
739 Info.Flags = readVaruint32(Ctx);
740 bool IsDefined = (Info.Flags & wasm::WASM_SYMBOL_UNDEFINED) == 0;
741
742 switch (Info.Kind) {
743 case wasm::WASM_SYMBOL_TYPE_FUNCTION:
744 Info.ElementIndex = readVaruint32(Ctx);
745 if (!isValidFunctionIndex(Index: Info.ElementIndex) ||
746 IsDefined != isDefinedFunctionIndex(Index: Info.ElementIndex))
747 return make_error<GenericBinaryError>(Args: "invalid function symbol index",
748 Args: object_error::parse_failed);
749 if (IsDefined) {
750 Info.Name = readString(Ctx);
751 unsigned FuncIndex = Info.ElementIndex - NumImportedFunctions;
752 wasm::WasmFunction &Function = Functions[FuncIndex];
753 Signature = &Signatures[Function.SigIndex];
754 if (Function.SymbolName.empty())
755 Function.SymbolName = Info.Name;
756 } else {
757 wasm::WasmImport &Import = *ImportedFunctions[Info.ElementIndex];
758 if ((Info.Flags & wasm::WASM_SYMBOL_EXPLICIT_NAME) != 0) {
759 Info.Name = readString(Ctx);
760 Info.ImportName = Import.Field;
761 } else {
762 Info.Name = Import.Field;
763 }
764 Signature = &Signatures[Import.SigIndex];
765 Info.ImportModule = Import.Module;
766 }
767 break;
768
769 case wasm::WASM_SYMBOL_TYPE_GLOBAL:
770 Info.ElementIndex = readVaruint32(Ctx);
771 if (!isValidGlobalIndex(Index: Info.ElementIndex) ||
772 IsDefined != isDefinedGlobalIndex(Index: Info.ElementIndex))
773 return make_error<GenericBinaryError>(Args: "invalid global symbol index",
774 Args: object_error::parse_failed);
775 if (!IsDefined && (Info.Flags & wasm::WASM_SYMBOL_BINDING_MASK) ==
776 wasm::WASM_SYMBOL_BINDING_WEAK)
777 return make_error<GenericBinaryError>(Args: "undefined weak global symbol",
778 Args: object_error::parse_failed);
779 if (IsDefined) {
780 Info.Name = readString(Ctx);
781 unsigned GlobalIndex = Info.ElementIndex - NumImportedGlobals;
782 wasm::WasmGlobal &Global = Globals[GlobalIndex];
783 GlobalType = &Global.Type;
784 if (Global.SymbolName.empty())
785 Global.SymbolName = Info.Name;
786 } else {
787 wasm::WasmImport &Import = *ImportedGlobals[Info.ElementIndex];
788 if ((Info.Flags & wasm::WASM_SYMBOL_EXPLICIT_NAME) != 0) {
789 Info.Name = readString(Ctx);
790 Info.ImportName = Import.Field;
791 } else {
792 Info.Name = Import.Field;
793 }
794 GlobalType = &Import.Global;
795 Info.ImportModule = Import.Module;
796 }
797 break;
798
799 case wasm::WASM_SYMBOL_TYPE_TABLE:
800 Info.ElementIndex = readVaruint32(Ctx);
801 if (!isValidTableNumber(Index: Info.ElementIndex) ||
802 IsDefined != isDefinedTableNumber(Index: Info.ElementIndex))
803 return make_error<GenericBinaryError>(Args: "invalid table symbol index",
804 Args: object_error::parse_failed);
805 if (!IsDefined && (Info.Flags & wasm::WASM_SYMBOL_BINDING_MASK) ==
806 wasm::WASM_SYMBOL_BINDING_WEAK)
807 return make_error<GenericBinaryError>(Args: "undefined weak table symbol",
808 Args: object_error::parse_failed);
809 if (IsDefined) {
810 Info.Name = readString(Ctx);
811 unsigned TableNumber = Info.ElementIndex - NumImportedTables;
812 wasm::WasmTable &Table = Tables[TableNumber];
813 TableType = &Table.Type;
814 if (Table.SymbolName.empty())
815 Table.SymbolName = Info.Name;
816 } else {
817 wasm::WasmImport &Import = *ImportedTables[Info.ElementIndex];
818 if ((Info.Flags & wasm::WASM_SYMBOL_EXPLICIT_NAME) != 0) {
819 Info.Name = readString(Ctx);
820 Info.ImportName = Import.Field;
821 } else {
822 Info.Name = Import.Field;
823 }
824 TableType = &Import.Table;
825 Info.ImportModule = Import.Module;
826 }
827 break;
828
829 case wasm::WASM_SYMBOL_TYPE_DATA:
830 Info.Name = readString(Ctx);
831 if (IsDefined) {
832 auto Index = readVaruint32(Ctx);
833 auto Offset = readVaruint64(Ctx);
834 auto Size = readVaruint64(Ctx);
835 if (!(Info.Flags & wasm::WASM_SYMBOL_ABSOLUTE)) {
836 if (static_cast<size_t>(Index) >= DataSegments.size())
837 return make_error<GenericBinaryError>(
838 Args: "invalid data segment index: " + Twine(Index),
839 Args: object_error::parse_failed);
840 size_t SegmentSize = DataSegments[Index].Data.Content.size();
841 if (Offset > SegmentSize)
842 return make_error<GenericBinaryError>(
843 Args: "invalid data symbol offset: `" + Info.Name +
844 "` (offset: " + Twine(Offset) +
845 " segment size: " + Twine(SegmentSize) + ")",
846 Args: object_error::parse_failed);
847 }
848 Info.DataRef = wasm::WasmDataReference{.Segment: Index, .Offset: Offset, .Size: Size};
849 }
850 break;
851
852 case wasm::WASM_SYMBOL_TYPE_SECTION: {
853 if ((Info.Flags & wasm::WASM_SYMBOL_BINDING_MASK) !=
854 wasm::WASM_SYMBOL_BINDING_LOCAL)
855 return make_error<GenericBinaryError>(
856 Args: "section symbols must have local binding",
857 Args: object_error::parse_failed);
858 Info.ElementIndex = readVaruint32(Ctx);
859 // Use somewhat unique section name as symbol name.
860 StringRef SectionName = Sections[Info.ElementIndex].Name;
861 Info.Name = SectionName;
862 break;
863 }
864
865 case wasm::WASM_SYMBOL_TYPE_TAG: {
866 Info.ElementIndex = readVaruint32(Ctx);
867 if (!isValidTagIndex(Index: Info.ElementIndex) ||
868 IsDefined != isDefinedTagIndex(Index: Info.ElementIndex))
869 return make_error<GenericBinaryError>(Args: "invalid tag symbol index",
870 Args: object_error::parse_failed);
871 if (!IsDefined && (Info.Flags & wasm::WASM_SYMBOL_BINDING_MASK) ==
872 wasm::WASM_SYMBOL_BINDING_WEAK)
873 return make_error<GenericBinaryError>(Args: "undefined weak global symbol",
874 Args: object_error::parse_failed);
875 if (IsDefined) {
876 Info.Name = readString(Ctx);
877 unsigned TagIndex = Info.ElementIndex - NumImportedTags;
878 wasm::WasmTag &Tag = Tags[TagIndex];
879 Signature = &Signatures[Tag.SigIndex];
880 if (Tag.SymbolName.empty())
881 Tag.SymbolName = Info.Name;
882
883 } else {
884 wasm::WasmImport &Import = *ImportedTags[Info.ElementIndex];
885 if ((Info.Flags & wasm::WASM_SYMBOL_EXPLICIT_NAME) != 0) {
886 Info.Name = readString(Ctx);
887 Info.ImportName = Import.Field;
888 } else {
889 Info.Name = Import.Field;
890 }
891 Signature = &Signatures[Import.SigIndex];
892 Info.ImportModule = Import.Module;
893 }
894 break;
895 }
896
897 default:
898 return make_error<GenericBinaryError>(Args: "invalid symbol type: " +
899 Twine(unsigned(Info.Kind)),
900 Args: object_error::parse_failed);
901 }
902
903 if ((Info.Flags & wasm::WASM_SYMBOL_BINDING_MASK) !=
904 wasm::WASM_SYMBOL_BINDING_LOCAL &&
905 !SymbolNames.insert(key: Info.Name).second)
906 return make_error<GenericBinaryError>(Args: "duplicate symbol name " +
907 Twine(Info.Name),
908 Args: object_error::parse_failed);
909 Symbols.emplace_back(args&: Info, args&: GlobalType, args&: TableType, args&: Signature);
910 LLVM_DEBUG(dbgs() << "Adding symbol: " << Symbols.back() << "\n");
911 }
912
913 return Error::success();
914}
915
916Error WasmObjectFile::parseLinkingSectionComdat(ReadContext &Ctx) {
917 uint32_t ComdatCount = readVaruint32(Ctx);
918 StringSet<> ComdatSet;
919 for (unsigned ComdatIndex = 0; ComdatIndex < ComdatCount; ++ComdatIndex) {
920 StringRef Name = readString(Ctx);
921 if (Name.empty() || !ComdatSet.insert(key: Name).second)
922 return make_error<GenericBinaryError>(Args: "bad/duplicate COMDAT name " +
923 Twine(Name),
924 Args: object_error::parse_failed);
925 LinkingData.Comdats.emplace_back(args&: Name);
926 uint32_t Flags = readVaruint32(Ctx);
927 if (Flags != 0)
928 return make_error<GenericBinaryError>(Args: "unsupported COMDAT flags",
929 Args: object_error::parse_failed);
930
931 uint32_t EntryCount = readVaruint32(Ctx);
932 while (EntryCount--) {
933 unsigned Kind = readVaruint32(Ctx);
934 unsigned Index = readVaruint32(Ctx);
935 switch (Kind) {
936 default:
937 return make_error<GenericBinaryError>(Args: "invalid COMDAT entry type",
938 Args: object_error::parse_failed);
939 case wasm::WASM_COMDAT_DATA:
940 if (Index >= DataSegments.size())
941 return make_error<GenericBinaryError>(
942 Args: "COMDAT data index out of range", Args: object_error::parse_failed);
943 if (DataSegments[Index].Data.Comdat != UINT32_MAX)
944 return make_error<GenericBinaryError>(Args: "data segment in two COMDATs",
945 Args: object_error::parse_failed);
946 DataSegments[Index].Data.Comdat = ComdatIndex;
947 break;
948 case wasm::WASM_COMDAT_FUNCTION:
949 if (!isDefinedFunctionIndex(Index))
950 return make_error<GenericBinaryError>(
951 Args: "COMDAT function index out of range", Args: object_error::parse_failed);
952 if (getDefinedFunction(Index).Comdat != UINT32_MAX)
953 return make_error<GenericBinaryError>(Args: "function in two COMDATs",
954 Args: object_error::parse_failed);
955 getDefinedFunction(Index).Comdat = ComdatIndex;
956 break;
957 case wasm::WASM_COMDAT_SECTION:
958 if (Index >= Sections.size())
959 return make_error<GenericBinaryError>(
960 Args: "COMDAT section index out of range", Args: object_error::parse_failed);
961 if (Sections[Index].Type != wasm::WASM_SEC_CUSTOM)
962 return make_error<GenericBinaryError>(
963 Args: "non-custom section in a COMDAT", Args: object_error::parse_failed);
964 Sections[Index].Comdat = ComdatIndex;
965 break;
966 }
967 }
968 }
969 return Error::success();
970}
971
972Error WasmObjectFile::parseProducersSection(ReadContext &Ctx) {
973 llvm::SmallSet<StringRef, 3> FieldsSeen;
974 uint32_t Fields = readVaruint32(Ctx);
975 for (size_t I = 0; I < Fields; ++I) {
976 StringRef FieldName = readString(Ctx);
977 if (!FieldsSeen.insert(V: FieldName).second)
978 return make_error<GenericBinaryError>(
979 Args: "producers section does not have unique fields",
980 Args: object_error::parse_failed);
981 std::vector<std::pair<std::string, std::string>> *ProducerVec = nullptr;
982 if (FieldName == "language") {
983 ProducerVec = &ProducerInfo.Languages;
984 } else if (FieldName == "processed-by") {
985 ProducerVec = &ProducerInfo.Tools;
986 } else if (FieldName == "sdk") {
987 ProducerVec = &ProducerInfo.SDKs;
988 } else {
989 return make_error<GenericBinaryError>(
990 Args: "producers section field is not named one of language, processed-by, "
991 "or sdk",
992 Args: object_error::parse_failed);
993 }
994 uint32_t ValueCount = readVaruint32(Ctx);
995 llvm::SmallSet<StringRef, 8> ProducersSeen;
996 for (size_t J = 0; J < ValueCount; ++J) {
997 StringRef Name = readString(Ctx);
998 StringRef Version = readString(Ctx);
999 if (!ProducersSeen.insert(V: Name).second) {
1000 return make_error<GenericBinaryError>(
1001 Args: "producers section contains repeated producer",
1002 Args: object_error::parse_failed);
1003 }
1004 ProducerVec->emplace_back(args: std::string(Name), args: std::string(Version));
1005 }
1006 }
1007 if (Ctx.Ptr != Ctx.End)
1008 return make_error<GenericBinaryError>(Args: "producers section ended prematurely",
1009 Args: object_error::parse_failed);
1010 return Error::success();
1011}
1012
1013Error WasmObjectFile::parseTargetFeaturesSection(ReadContext &Ctx) {
1014 llvm::SmallSet<std::string, 8> FeaturesSeen;
1015 uint32_t FeatureCount = readVaruint32(Ctx);
1016 for (size_t I = 0; I < FeatureCount; ++I) {
1017 wasm::WasmFeatureEntry Feature;
1018 Feature.Prefix = readUint8(Ctx);
1019 switch (Feature.Prefix) {
1020 case wasm::WASM_FEATURE_PREFIX_USED:
1021 case wasm::WASM_FEATURE_PREFIX_DISALLOWED:
1022 break;
1023 default:
1024 return make_error<GenericBinaryError>(Args: "unknown feature policy prefix",
1025 Args: object_error::parse_failed);
1026 }
1027 Feature.Name = std::string(readString(Ctx));
1028 if (!FeaturesSeen.insert(V: Feature.Name).second)
1029 return make_error<GenericBinaryError>(
1030 Args: "target features section contains repeated feature \"" +
1031 Feature.Name + "\"",
1032 Args: object_error::parse_failed);
1033 TargetFeatures.push_back(x: Feature);
1034 }
1035 if (Ctx.Ptr != Ctx.End)
1036 return make_error<GenericBinaryError>(
1037 Args: "target features section ended prematurely",
1038 Args: object_error::parse_failed);
1039 return Error::success();
1040}
1041
1042Error WasmObjectFile::parseRelocSection(StringRef Name, ReadContext &Ctx) {
1043 uint32_t SectionIndex = readVaruint32(Ctx);
1044 if (SectionIndex >= Sections.size())
1045 return make_error<GenericBinaryError>(Args: "invalid section index",
1046 Args: object_error::parse_failed);
1047 WasmSection &Section = Sections[SectionIndex];
1048 uint32_t RelocCount = readVaruint32(Ctx);
1049 uint32_t EndOffset = Section.Content.size();
1050 uint32_t PreviousOffset = 0;
1051 while (RelocCount--) {
1052 wasm::WasmRelocation Reloc = {};
1053 uint32_t type = readVaruint32(Ctx);
1054 Reloc.Type = type;
1055 Reloc.Offset = readVaruint32(Ctx);
1056 if (Reloc.Offset < PreviousOffset)
1057 return make_error<GenericBinaryError>(Args: "relocations not in offset order",
1058 Args: object_error::parse_failed);
1059
1060 auto badReloc = [&](StringRef msg) {
1061 return make_error<GenericBinaryError>(
1062 Args: msg + ": " + Twine(Symbols[Reloc.Index].Info.Name),
1063 Args: object_error::parse_failed);
1064 };
1065
1066 PreviousOffset = Reloc.Offset;
1067 Reloc.Index = readVaruint32(Ctx);
1068 switch (type) {
1069 case wasm::R_WASM_FUNCTION_INDEX_LEB:
1070 case wasm::R_WASM_FUNCTION_INDEX_I32:
1071 case wasm::R_WASM_TABLE_INDEX_SLEB:
1072 case wasm::R_WASM_TABLE_INDEX_SLEB64:
1073 case wasm::R_WASM_TABLE_INDEX_I32:
1074 case wasm::R_WASM_TABLE_INDEX_I64:
1075 case wasm::R_WASM_TABLE_INDEX_REL_SLEB:
1076 case wasm::R_WASM_TABLE_INDEX_REL_SLEB64:
1077 if (!isValidFunctionSymbol(Index: Reloc.Index))
1078 return badReloc("invalid function relocation");
1079 break;
1080 case wasm::R_WASM_TABLE_NUMBER_LEB:
1081 if (!isValidTableSymbol(Index: Reloc.Index))
1082 return badReloc("invalid table relocation");
1083 break;
1084 case wasm::R_WASM_TYPE_INDEX_LEB:
1085 if (Reloc.Index >= Signatures.size())
1086 return badReloc("invalid relocation type index");
1087 break;
1088 case wasm::R_WASM_GLOBAL_INDEX_LEB:
1089 // R_WASM_GLOBAL_INDEX_LEB are can be used against function and data
1090 // symbols to refer to their GOT entries.
1091 if (!isValidGlobalSymbol(Index: Reloc.Index) &&
1092 !isValidDataSymbol(Index: Reloc.Index) &&
1093 !isValidFunctionSymbol(Index: Reloc.Index))
1094 return badReloc("invalid global relocation");
1095 break;
1096 case wasm::R_WASM_GLOBAL_INDEX_I32:
1097 if (!isValidGlobalSymbol(Index: Reloc.Index))
1098 return badReloc("invalid global relocation");
1099 break;
1100 case wasm::R_WASM_TAG_INDEX_LEB:
1101 if (!isValidTagSymbol(Index: Reloc.Index))
1102 return badReloc("invalid tag relocation");
1103 break;
1104 case wasm::R_WASM_MEMORY_ADDR_LEB:
1105 case wasm::R_WASM_MEMORY_ADDR_SLEB:
1106 case wasm::R_WASM_MEMORY_ADDR_I32:
1107 case wasm::R_WASM_MEMORY_ADDR_REL_SLEB:
1108 case wasm::R_WASM_MEMORY_ADDR_TLS_SLEB:
1109 case wasm::R_WASM_MEMORY_ADDR_LOCREL_I32:
1110 if (!isValidDataSymbol(Index: Reloc.Index))
1111 return badReloc("invalid data relocation");
1112 Reloc.Addend = readVarint32(Ctx);
1113 break;
1114 case wasm::R_WASM_MEMORY_ADDR_LEB64:
1115 case wasm::R_WASM_MEMORY_ADDR_SLEB64:
1116 case wasm::R_WASM_MEMORY_ADDR_I64:
1117 case wasm::R_WASM_MEMORY_ADDR_REL_SLEB64:
1118 case wasm::R_WASM_MEMORY_ADDR_TLS_SLEB64:
1119 if (!isValidDataSymbol(Index: Reloc.Index))
1120 return badReloc("invalid data relocation");
1121 Reloc.Addend = readVarint64(Ctx);
1122 break;
1123 case wasm::R_WASM_FUNCTION_OFFSET_I32:
1124 if (!isValidFunctionSymbol(Index: Reloc.Index))
1125 return badReloc("invalid function relocation");
1126 Reloc.Addend = readVarint32(Ctx);
1127 break;
1128 case wasm::R_WASM_FUNCTION_OFFSET_I64:
1129 if (!isValidFunctionSymbol(Index: Reloc.Index))
1130 return badReloc("invalid function relocation");
1131 Reloc.Addend = readVarint64(Ctx);
1132 break;
1133 case wasm::R_WASM_SECTION_OFFSET_I32:
1134 if (!isValidSectionSymbol(Index: Reloc.Index))
1135 return badReloc("invalid section relocation");
1136 Reloc.Addend = readVarint32(Ctx);
1137 break;
1138 default:
1139 return make_error<GenericBinaryError>(Args: "invalid relocation type: " +
1140 Twine(type),
1141 Args: object_error::parse_failed);
1142 }
1143
1144 // Relocations must fit inside the section, and must appear in order. They
1145 // also shouldn't overlap a function/element boundary, but we don't bother
1146 // to check that.
1147 uint64_t Size = 5;
1148 if (Reloc.Type == wasm::R_WASM_MEMORY_ADDR_LEB64 ||
1149 Reloc.Type == wasm::R_WASM_MEMORY_ADDR_SLEB64 ||
1150 Reloc.Type == wasm::R_WASM_MEMORY_ADDR_REL_SLEB64)
1151 Size = 10;
1152 if (Reloc.Type == wasm::R_WASM_TABLE_INDEX_I32 ||
1153 Reloc.Type == wasm::R_WASM_MEMORY_ADDR_I32 ||
1154 Reloc.Type == wasm::R_WASM_MEMORY_ADDR_LOCREL_I32 ||
1155 Reloc.Type == wasm::R_WASM_SECTION_OFFSET_I32 ||
1156 Reloc.Type == wasm::R_WASM_FUNCTION_OFFSET_I32 ||
1157 Reloc.Type == wasm::R_WASM_FUNCTION_INDEX_I32 ||
1158 Reloc.Type == wasm::R_WASM_GLOBAL_INDEX_I32)
1159 Size = 4;
1160 if (Reloc.Type == wasm::R_WASM_TABLE_INDEX_I64 ||
1161 Reloc.Type == wasm::R_WASM_MEMORY_ADDR_I64 ||
1162 Reloc.Type == wasm::R_WASM_FUNCTION_OFFSET_I64)
1163 Size = 8;
1164 if (Reloc.Offset + Size > EndOffset)
1165 return make_error<GenericBinaryError>(Args: "invalid relocation offset",
1166 Args: object_error::parse_failed);
1167
1168 Section.Relocations.push_back(x: Reloc);
1169 }
1170 if (Ctx.Ptr != Ctx.End)
1171 return make_error<GenericBinaryError>(Args: "reloc section ended prematurely",
1172 Args: object_error::parse_failed);
1173 return Error::success();
1174}
1175
1176Error WasmObjectFile::parseCustomSection(WasmSection &Sec, ReadContext &Ctx) {
1177 if (Sec.Name == "dylink") {
1178 if (Error Err = parseDylinkSection(Ctx))
1179 return Err;
1180 } else if (Sec.Name == "dylink.0") {
1181 if (Error Err = parseDylink0Section(Ctx))
1182 return Err;
1183 } else if (Sec.Name == "name") {
1184 if (Error Err = parseNameSection(Ctx))
1185 return Err;
1186 } else if (Sec.Name == "linking") {
1187 if (Error Err = parseLinkingSection(Ctx))
1188 return Err;
1189 } else if (Sec.Name == "producers") {
1190 if (Error Err = parseProducersSection(Ctx))
1191 return Err;
1192 } else if (Sec.Name == "target_features") {
1193 if (Error Err = parseTargetFeaturesSection(Ctx))
1194 return Err;
1195 } else if (Sec.Name.starts_with(Prefix: "reloc.")) {
1196 if (Error Err = parseRelocSection(Name: Sec.Name, Ctx))
1197 return Err;
1198 }
1199 return Error::success();
1200}
1201
1202Error WasmObjectFile::parseTypeSection(ReadContext &Ctx) {
1203 auto parseFieldDef = [&]() {
1204 uint32_t TypeCode = readVaruint32((Ctx));
1205 /* Discard StorageType */ parseValType(Ctx, Code: TypeCode);
1206 /* Discard Mutability */ readVaruint32(Ctx);
1207 };
1208
1209 uint32_t Count = readVaruint32(Ctx);
1210 Signatures.reserve(n: Count);
1211 while (Count--) {
1212 wasm::WasmSignature Sig;
1213 uint8_t Form = readUint8(Ctx);
1214 if (Form == wasm::WASM_TYPE_REC) {
1215 // Rec groups expand the type index space (beyond what was declared at
1216 // the top of the section, and also consume one element in that space.
1217 uint32_t RecSize = readVaruint32(Ctx);
1218 if (RecSize == 0)
1219 return make_error<GenericBinaryError>(Args: "Rec group size cannot be 0",
1220 Args: object_error::parse_failed);
1221 Signatures.reserve(n: Signatures.size() + RecSize);
1222 Count += RecSize;
1223 Sig.Kind = wasm::WasmSignature::Placeholder;
1224 Signatures.push_back(x: std::move(Sig));
1225 HasUnmodeledTypes = true;
1226 continue;
1227 }
1228 if (Form != wasm::WASM_TYPE_FUNC) {
1229 // Currently LLVM only models function types, and not other composite
1230 // types. Here we parse the type declarations just enough to skip past
1231 // them in the binary.
1232 if (Form == wasm::WASM_TYPE_SUB || Form == wasm::WASM_TYPE_SUB_FINAL) {
1233 uint32_t Supers = readVaruint32(Ctx);
1234 if (Supers > 0) {
1235 if (Supers != 1)
1236 return make_error<GenericBinaryError>(
1237 Args: "Invalid number of supertypes", Args: object_error::parse_failed);
1238 /* Discard SuperIndex */ readVaruint32(Ctx);
1239 }
1240 Form = readVaruint32(Ctx);
1241 }
1242 if (Form == wasm::WASM_TYPE_STRUCT) {
1243 uint32_t FieldCount = readVaruint32(Ctx);
1244 while (FieldCount--) {
1245 parseFieldDef();
1246 }
1247 } else if (Form == wasm::WASM_TYPE_ARRAY) {
1248 parseFieldDef();
1249 } else {
1250 return make_error<GenericBinaryError>(Args: "bad form",
1251 Args: object_error::parse_failed);
1252 }
1253 Sig.Kind = wasm::WasmSignature::Placeholder;
1254 Signatures.push_back(x: std::move(Sig));
1255 HasUnmodeledTypes = true;
1256 continue;
1257 }
1258
1259 uint32_t ParamCount = readVaruint32(Ctx);
1260 Sig.Params.reserve(N: ParamCount);
1261 while (ParamCount--) {
1262 uint32_t ParamType = readUint8(Ctx);
1263 Sig.Params.push_back(Elt: parseValType(Ctx, Code: ParamType));
1264 }
1265 uint32_t ReturnCount = readVaruint32(Ctx);
1266 while (ReturnCount--) {
1267 uint32_t ReturnType = readUint8(Ctx);
1268 Sig.Returns.push_back(Elt: parseValType(Ctx, Code: ReturnType));
1269 }
1270
1271 Signatures.push_back(x: std::move(Sig));
1272 }
1273 if (Ctx.Ptr != Ctx.End)
1274 return make_error<GenericBinaryError>(Args: "type section ended prematurely",
1275 Args: object_error::parse_failed);
1276 return Error::success();
1277}
1278
1279Error WasmObjectFile::parseImportSection(ReadContext &Ctx) {
1280 uint32_t Count = readVaruint32(Ctx);
1281 uint32_t NumTypes = Signatures.size();
1282 Imports.reserve(n: Count);
1283 for (uint32_t I = 0; I < Count; I++) {
1284 wasm::WasmImport Im;
1285 Im.Module = readString(Ctx);
1286 Im.Field = readString(Ctx);
1287 Im.Kind = readUint8(Ctx);
1288 switch (Im.Kind) {
1289 case wasm::WASM_EXTERNAL_FUNCTION:
1290 NumImportedFunctions++;
1291 Im.SigIndex = readVaruint32(Ctx);
1292 if (Im.SigIndex >= NumTypes)
1293 return make_error<GenericBinaryError>(Args: "invalid function type",
1294 Args: object_error::parse_failed);
1295 break;
1296 case wasm::WASM_EXTERNAL_GLOBAL:
1297 NumImportedGlobals++;
1298 Im.Global.Type = readUint8(Ctx);
1299 Im.Global.Mutable = readVaruint1(Ctx);
1300 break;
1301 case wasm::WASM_EXTERNAL_MEMORY:
1302 Im.Memory = readLimits(Ctx);
1303 if (Im.Memory.Flags & wasm::WASM_LIMITS_FLAG_IS_64)
1304 HasMemory64 = true;
1305 break;
1306 case wasm::WASM_EXTERNAL_TABLE: {
1307 Im.Table = readTableType(Ctx);
1308 NumImportedTables++;
1309 auto ElemType = Im.Table.ElemType;
1310 if (ElemType != wasm::ValType::FUNCREF &&
1311 ElemType != wasm::ValType::EXTERNREF &&
1312 ElemType != wasm::ValType::EXNREF &&
1313 ElemType != wasm::ValType::OTHERREF)
1314 return make_error<GenericBinaryError>(Args: "invalid table element type",
1315 Args: object_error::parse_failed);
1316 break;
1317 }
1318 case wasm::WASM_EXTERNAL_TAG:
1319 NumImportedTags++;
1320 if (readUint8(Ctx) != 0) // Reserved 'attribute' field
1321 return make_error<GenericBinaryError>(Args: "invalid attribute",
1322 Args: object_error::parse_failed);
1323 Im.SigIndex = readVaruint32(Ctx);
1324 if (Im.SigIndex >= NumTypes)
1325 return make_error<GenericBinaryError>(Args: "invalid tag type",
1326 Args: object_error::parse_failed);
1327 break;
1328 default:
1329 return make_error<GenericBinaryError>(Args: "unexpected import kind",
1330 Args: object_error::parse_failed);
1331 }
1332 Imports.push_back(x: Im);
1333 }
1334 if (Ctx.Ptr != Ctx.End)
1335 return make_error<GenericBinaryError>(Args: "import section ended prematurely",
1336 Args: object_error::parse_failed);
1337 return Error::success();
1338}
1339
1340Error WasmObjectFile::parseFunctionSection(ReadContext &Ctx) {
1341 uint32_t Count = readVaruint32(Ctx);
1342 Functions.reserve(n: Count);
1343 uint32_t NumTypes = Signatures.size();
1344 while (Count--) {
1345 uint32_t Type = readVaruint32(Ctx);
1346 if (Type >= NumTypes)
1347 return make_error<GenericBinaryError>(Args: "invalid function type",
1348 Args: object_error::parse_failed);
1349 wasm::WasmFunction F;
1350 F.SigIndex = Type;
1351 Functions.push_back(x: F);
1352 }
1353 if (Ctx.Ptr != Ctx.End)
1354 return make_error<GenericBinaryError>(Args: "function section ended prematurely",
1355 Args: object_error::parse_failed);
1356 return Error::success();
1357}
1358
1359Error WasmObjectFile::parseTableSection(ReadContext &Ctx) {
1360 TableSection = Sections.size();
1361 uint32_t Count = readVaruint32(Ctx);
1362 Tables.reserve(n: Count);
1363 while (Count--) {
1364 wasm::WasmTable T;
1365 T.Type = readTableType(Ctx);
1366 T.Index = NumImportedTables + Tables.size();
1367 Tables.push_back(x: T);
1368 auto ElemType = Tables.back().Type.ElemType;
1369 if (ElemType != wasm::ValType::FUNCREF &&
1370 ElemType != wasm::ValType::EXTERNREF &&
1371 ElemType != wasm::ValType::EXNREF &&
1372 ElemType != wasm::ValType::OTHERREF) {
1373 return make_error<GenericBinaryError>(Args: "invalid table element type",
1374 Args: object_error::parse_failed);
1375 }
1376 }
1377 if (Ctx.Ptr != Ctx.End)
1378 return make_error<GenericBinaryError>(Args: "table section ended prematurely",
1379 Args: object_error::parse_failed);
1380 return Error::success();
1381}
1382
1383Error WasmObjectFile::parseMemorySection(ReadContext &Ctx) {
1384 uint32_t Count = readVaruint32(Ctx);
1385 Memories.reserve(n: Count);
1386 while (Count--) {
1387 auto Limits = readLimits(Ctx);
1388 if (Limits.Flags & wasm::WASM_LIMITS_FLAG_IS_64)
1389 HasMemory64 = true;
1390 Memories.push_back(x: Limits);
1391 }
1392 if (Ctx.Ptr != Ctx.End)
1393 return make_error<GenericBinaryError>(Args: "memory section ended prematurely",
1394 Args: object_error::parse_failed);
1395 return Error::success();
1396}
1397
1398Error WasmObjectFile::parseTagSection(ReadContext &Ctx) {
1399 TagSection = Sections.size();
1400 uint32_t Count = readVaruint32(Ctx);
1401 Tags.reserve(n: Count);
1402 uint32_t NumTypes = Signatures.size();
1403 while (Count--) {
1404 if (readUint8(Ctx) != 0) // Reserved 'attribute' field
1405 return make_error<GenericBinaryError>(Args: "invalid attribute",
1406 Args: object_error::parse_failed);
1407 uint32_t Type = readVaruint32(Ctx);
1408 if (Type >= NumTypes)
1409 return make_error<GenericBinaryError>(Args: "invalid tag type",
1410 Args: object_error::parse_failed);
1411 wasm::WasmTag Tag;
1412 Tag.Index = NumImportedTags + Tags.size();
1413 Tag.SigIndex = Type;
1414 Signatures[Type].Kind = wasm::WasmSignature::Tag;
1415 Tags.push_back(x: Tag);
1416 }
1417
1418 if (Ctx.Ptr != Ctx.End)
1419 return make_error<GenericBinaryError>(Args: "tag section ended prematurely",
1420 Args: object_error::parse_failed);
1421 return Error::success();
1422}
1423
1424Error WasmObjectFile::parseGlobalSection(ReadContext &Ctx) {
1425 GlobalSection = Sections.size();
1426 const uint8_t *SectionStart = Ctx.Ptr;
1427 uint32_t Count = readVaruint32(Ctx);
1428 Globals.reserve(n: Count);
1429 while (Count--) {
1430 wasm::WasmGlobal Global;
1431 Global.Index = NumImportedGlobals + Globals.size();
1432 const uint8_t *GlobalStart = Ctx.Ptr;
1433 Global.Offset = static_cast<uint32_t>(GlobalStart - SectionStart);
1434 auto GlobalOpcode = readVaruint32(Ctx);
1435 Global.Type.Type = (uint8_t)parseValType(Ctx, Code: GlobalOpcode);
1436 Global.Type.Mutable = readVaruint1(Ctx);
1437 if (Error Err = readInitExpr(Expr&: Global.InitExpr, Ctx))
1438 return Err;
1439 Global.Size = static_cast<uint32_t>(Ctx.Ptr - GlobalStart);
1440 Globals.push_back(x: Global);
1441 }
1442 if (Ctx.Ptr != Ctx.End)
1443 return make_error<GenericBinaryError>(Args: "global section ended prematurely",
1444 Args: object_error::parse_failed);
1445 return Error::success();
1446}
1447
1448Error WasmObjectFile::parseExportSection(ReadContext &Ctx) {
1449 uint32_t Count = readVaruint32(Ctx);
1450 Exports.reserve(n: Count);
1451 Symbols.reserve(n: Count);
1452 for (uint32_t I = 0; I < Count; I++) {
1453 wasm::WasmExport Ex;
1454 Ex.Name = readString(Ctx);
1455 Ex.Kind = readUint8(Ctx);
1456 Ex.Index = readVaruint32(Ctx);
1457 const wasm::WasmSignature *Signature = nullptr;
1458 const wasm::WasmGlobalType *GlobalType = nullptr;
1459 const wasm::WasmTableType *TableType = nullptr;
1460 wasm::WasmSymbolInfo Info;
1461 Info.Name = Ex.Name;
1462 Info.Flags = 0;
1463 switch (Ex.Kind) {
1464 case wasm::WASM_EXTERNAL_FUNCTION: {
1465 if (!isValidFunctionIndex(Index: Ex.Index))
1466 return make_error<GenericBinaryError>(Args: "invalid function export",
1467 Args: object_error::parse_failed);
1468 Info.Kind = wasm::WASM_SYMBOL_TYPE_FUNCTION;
1469 Info.ElementIndex = Ex.Index;
1470 if (isDefinedFunctionIndex(Index: Ex.Index)) {
1471 getDefinedFunction(Index: Ex.Index).ExportName = Ex.Name;
1472 unsigned FuncIndex = Info.ElementIndex - NumImportedFunctions;
1473 wasm::WasmFunction &Function = Functions[FuncIndex];
1474 Signature = &Signatures[Function.SigIndex];
1475 }
1476 // Else the function is imported. LLVM object files don't use this
1477 // pattern and we still treat this as an undefined symbol, but we want to
1478 // parse it without crashing.
1479 break;
1480 }
1481 case wasm::WASM_EXTERNAL_GLOBAL: {
1482 if (!isValidGlobalIndex(Index: Ex.Index))
1483 return make_error<GenericBinaryError>(Args: "invalid global export",
1484 Args: object_error::parse_failed);
1485 Info.Kind = wasm::WASM_SYMBOL_TYPE_DATA;
1486 uint64_t Offset = 0;
1487 if (isDefinedGlobalIndex(Index: Ex.Index)) {
1488 auto Global = getDefinedGlobal(Index: Ex.Index);
1489 if (!Global.InitExpr.Extended) {
1490 auto Inst = Global.InitExpr.Inst;
1491 if (Inst.Opcode == wasm::WASM_OPCODE_I32_CONST) {
1492 Offset = Inst.Value.Int32;
1493 } else if (Inst.Opcode == wasm::WASM_OPCODE_I64_CONST) {
1494 Offset = Inst.Value.Int64;
1495 }
1496 }
1497 }
1498 Info.DataRef = wasm::WasmDataReference{.Segment: 0, .Offset: Offset, .Size: 0};
1499 break;
1500 }
1501 case wasm::WASM_EXTERNAL_TAG:
1502 if (!isValidTagIndex(Index: Ex.Index))
1503 return make_error<GenericBinaryError>(Args: "invalid tag export",
1504 Args: object_error::parse_failed);
1505 Info.Kind = wasm::WASM_SYMBOL_TYPE_TAG;
1506 Info.ElementIndex = Ex.Index;
1507 break;
1508 case wasm::WASM_EXTERNAL_MEMORY:
1509 break;
1510 case wasm::WASM_EXTERNAL_TABLE:
1511 Info.Kind = wasm::WASM_SYMBOL_TYPE_TABLE;
1512 Info.ElementIndex = Ex.Index;
1513 break;
1514 default:
1515 return make_error<GenericBinaryError>(Args: "unexpected export kind",
1516 Args: object_error::parse_failed);
1517 }
1518 Exports.push_back(x: Ex);
1519 if (Ex.Kind != wasm::WASM_EXTERNAL_MEMORY) {
1520 Symbols.emplace_back(args&: Info, args&: GlobalType, args&: TableType, args&: Signature);
1521 LLVM_DEBUG(dbgs() << "Adding symbol: " << Symbols.back() << "\n");
1522 }
1523 }
1524 if (Ctx.Ptr != Ctx.End)
1525 return make_error<GenericBinaryError>(Args: "export section ended prematurely",
1526 Args: object_error::parse_failed);
1527 return Error::success();
1528}
1529
1530bool WasmObjectFile::isValidFunctionIndex(uint32_t Index) const {
1531 return Index < NumImportedFunctions + Functions.size();
1532}
1533
1534bool WasmObjectFile::isDefinedFunctionIndex(uint32_t Index) const {
1535 return Index >= NumImportedFunctions && isValidFunctionIndex(Index);
1536}
1537
1538bool WasmObjectFile::isValidGlobalIndex(uint32_t Index) const {
1539 return Index < NumImportedGlobals + Globals.size();
1540}
1541
1542bool WasmObjectFile::isValidTableNumber(uint32_t Index) const {
1543 return Index < NumImportedTables + Tables.size();
1544}
1545
1546bool WasmObjectFile::isDefinedGlobalIndex(uint32_t Index) const {
1547 return Index >= NumImportedGlobals && isValidGlobalIndex(Index);
1548}
1549
1550bool WasmObjectFile::isDefinedTableNumber(uint32_t Index) const {
1551 return Index >= NumImportedTables && isValidTableNumber(Index);
1552}
1553
1554bool WasmObjectFile::isValidTagIndex(uint32_t Index) const {
1555 return Index < NumImportedTags + Tags.size();
1556}
1557
1558bool WasmObjectFile::isDefinedTagIndex(uint32_t Index) const {
1559 return Index >= NumImportedTags && isValidTagIndex(Index);
1560}
1561
1562bool WasmObjectFile::isValidFunctionSymbol(uint32_t Index) const {
1563 return Index < Symbols.size() && Symbols[Index].isTypeFunction();
1564}
1565
1566bool WasmObjectFile::isValidTableSymbol(uint32_t Index) const {
1567 return Index < Symbols.size() && Symbols[Index].isTypeTable();
1568}
1569
1570bool WasmObjectFile::isValidGlobalSymbol(uint32_t Index) const {
1571 return Index < Symbols.size() && Symbols[Index].isTypeGlobal();
1572}
1573
1574bool WasmObjectFile::isValidTagSymbol(uint32_t Index) const {
1575 return Index < Symbols.size() && Symbols[Index].isTypeTag();
1576}
1577
1578bool WasmObjectFile::isValidDataSymbol(uint32_t Index) const {
1579 return Index < Symbols.size() && Symbols[Index].isTypeData();
1580}
1581
1582bool WasmObjectFile::isValidSectionSymbol(uint32_t Index) const {
1583 return Index < Symbols.size() && Symbols[Index].isTypeSection();
1584}
1585
1586wasm::WasmFunction &WasmObjectFile::getDefinedFunction(uint32_t Index) {
1587 assert(isDefinedFunctionIndex(Index));
1588 return Functions[Index - NumImportedFunctions];
1589}
1590
1591const wasm::WasmFunction &
1592WasmObjectFile::getDefinedFunction(uint32_t Index) const {
1593 assert(isDefinedFunctionIndex(Index));
1594 return Functions[Index - NumImportedFunctions];
1595}
1596
1597const wasm::WasmGlobal &WasmObjectFile::getDefinedGlobal(uint32_t Index) const {
1598 assert(isDefinedGlobalIndex(Index));
1599 return Globals[Index - NumImportedGlobals];
1600}
1601
1602wasm::WasmTag &WasmObjectFile::getDefinedTag(uint32_t Index) {
1603 assert(isDefinedTagIndex(Index));
1604 return Tags[Index - NumImportedTags];
1605}
1606
1607Error WasmObjectFile::parseStartSection(ReadContext &Ctx) {
1608 StartFunction = readVaruint32(Ctx);
1609 if (!isValidFunctionIndex(Index: StartFunction))
1610 return make_error<GenericBinaryError>(Args: "invalid start function",
1611 Args: object_error::parse_failed);
1612 return Error::success();
1613}
1614
1615Error WasmObjectFile::parseCodeSection(ReadContext &Ctx) {
1616 CodeSection = Sections.size();
1617 uint32_t FunctionCount = readVaruint32(Ctx);
1618 if (FunctionCount != Functions.size()) {
1619 return make_error<GenericBinaryError>(Args: "invalid function count",
1620 Args: object_error::parse_failed);
1621 }
1622
1623 for (uint32_t i = 0; i < FunctionCount; i++) {
1624 wasm::WasmFunction& Function = Functions[i];
1625 const uint8_t *FunctionStart = Ctx.Ptr;
1626 uint32_t Size = readVaruint32(Ctx);
1627 const uint8_t *FunctionEnd = Ctx.Ptr + Size;
1628
1629 Function.CodeOffset = Ctx.Ptr - FunctionStart;
1630 Function.Index = NumImportedFunctions + i;
1631 Function.CodeSectionOffset = FunctionStart - Ctx.Start;
1632 Function.Size = FunctionEnd - FunctionStart;
1633
1634 uint32_t NumLocalDecls = readVaruint32(Ctx);
1635 Function.Locals.reserve(n: NumLocalDecls);
1636 while (NumLocalDecls--) {
1637 wasm::WasmLocalDecl Decl;
1638 Decl.Count = readVaruint32(Ctx);
1639 Decl.Type = readUint8(Ctx);
1640 Function.Locals.push_back(x: Decl);
1641 }
1642
1643 uint32_t BodySize = FunctionEnd - Ctx.Ptr;
1644 // Ensure that Function is within Ctx's buffer.
1645 if (Ctx.Ptr + BodySize > Ctx.End) {
1646 return make_error<GenericBinaryError>(Args: "Function extends beyond buffer",
1647 Args: object_error::parse_failed);
1648 }
1649 Function.Body = ArrayRef<uint8_t>(Ctx.Ptr, BodySize);
1650 // This will be set later when reading in the linking metadata section.
1651 Function.Comdat = UINT32_MAX;
1652 Ctx.Ptr += BodySize;
1653 assert(Ctx.Ptr == FunctionEnd);
1654 }
1655 if (Ctx.Ptr != Ctx.End)
1656 return make_error<GenericBinaryError>(Args: "code section ended prematurely",
1657 Args: object_error::parse_failed);
1658 return Error::success();
1659}
1660
1661Error WasmObjectFile::parseElemSection(ReadContext &Ctx) {
1662 uint32_t Count = readVaruint32(Ctx);
1663 ElemSegments.reserve(n: Count);
1664 while (Count--) {
1665 wasm::WasmElemSegment Segment;
1666 Segment.Flags = readVaruint32(Ctx);
1667
1668 uint32_t SupportedFlags = wasm::WASM_ELEM_SEGMENT_HAS_TABLE_NUMBER |
1669 wasm::WASM_ELEM_SEGMENT_IS_PASSIVE |
1670 wasm::WASM_ELEM_SEGMENT_HAS_INIT_EXPRS;
1671 if (Segment.Flags & ~SupportedFlags)
1672 return make_error<GenericBinaryError>(
1673 Args: "Unsupported flags for element segment", Args: object_error::parse_failed);
1674
1675 wasm::ElemSegmentMode Mode;
1676 if ((Segment.Flags & wasm::WASM_ELEM_SEGMENT_IS_PASSIVE) == 0) {
1677 Mode = wasm::ElemSegmentMode::Active;
1678 } else if (Segment.Flags & wasm::WASM_ELEM_SEGMENT_IS_DECLARATIVE) {
1679 Mode = wasm::ElemSegmentMode::Declarative;
1680 } else {
1681 Mode = wasm::ElemSegmentMode::Passive;
1682 }
1683 bool HasTableNumber =
1684 Mode == wasm::ElemSegmentMode::Active &&
1685 (Segment.Flags & wasm::WASM_ELEM_SEGMENT_HAS_TABLE_NUMBER);
1686 bool HasElemKind =
1687 (Segment.Flags & wasm::WASM_ELEM_SEGMENT_MASK_HAS_ELEM_DESC) &&
1688 !(Segment.Flags & wasm::WASM_ELEM_SEGMENT_HAS_INIT_EXPRS);
1689 bool HasElemType =
1690 (Segment.Flags & wasm::WASM_ELEM_SEGMENT_MASK_HAS_ELEM_DESC) &&
1691 (Segment.Flags & wasm::WASM_ELEM_SEGMENT_HAS_INIT_EXPRS);
1692 bool HasInitExprs =
1693 (Segment.Flags & wasm::WASM_ELEM_SEGMENT_HAS_INIT_EXPRS);
1694
1695 if (HasTableNumber)
1696 Segment.TableNumber = readVaruint32(Ctx);
1697 else
1698 Segment.TableNumber = 0;
1699
1700 if (!isValidTableNumber(Index: Segment.TableNumber))
1701 return make_error<GenericBinaryError>(Args: "invalid TableNumber",
1702 Args: object_error::parse_failed);
1703
1704 if (Mode != wasm::ElemSegmentMode::Active) {
1705 Segment.Offset.Extended = false;
1706 Segment.Offset.Inst.Opcode = wasm::WASM_OPCODE_I32_CONST;
1707 Segment.Offset.Inst.Value.Int32 = 0;
1708 } else {
1709 if (Error Err = readInitExpr(Expr&: Segment.Offset, Ctx))
1710 return Err;
1711 }
1712
1713 if (HasElemKind) {
1714 auto ElemKind = readVaruint32(Ctx);
1715 if (Segment.Flags & wasm::WASM_ELEM_SEGMENT_HAS_INIT_EXPRS) {
1716 Segment.ElemKind = parseValType(Ctx, Code: ElemKind);
1717 if (Segment.ElemKind != wasm::ValType::FUNCREF &&
1718 Segment.ElemKind != wasm::ValType::EXTERNREF &&
1719 Segment.ElemKind != wasm::ValType::EXNREF &&
1720 Segment.ElemKind != wasm::ValType::OTHERREF) {
1721 return make_error<GenericBinaryError>(Args: "invalid elem type",
1722 Args: object_error::parse_failed);
1723 }
1724 } else {
1725 if (ElemKind != 0)
1726 return make_error<GenericBinaryError>(Args: "invalid elem type",
1727 Args: object_error::parse_failed);
1728 Segment.ElemKind = wasm::ValType::FUNCREF;
1729 }
1730 } else if (HasElemType) {
1731 auto ElemType = parseValType(Ctx, Code: readVaruint32(Ctx));
1732 Segment.ElemKind = ElemType;
1733 } else {
1734 Segment.ElemKind = wasm::ValType::FUNCREF;
1735 }
1736
1737 uint32_t NumElems = readVaruint32(Ctx);
1738
1739 if (HasInitExprs) {
1740 while (NumElems--) {
1741 wasm::WasmInitExpr Expr;
1742 if (Error Err = readInitExpr(Expr, Ctx))
1743 return Err;
1744 }
1745 } else {
1746 while (NumElems--) {
1747 Segment.Functions.push_back(x: readVaruint32(Ctx));
1748 }
1749 }
1750 ElemSegments.push_back(x: Segment);
1751 }
1752 if (Ctx.Ptr != Ctx.End)
1753 return make_error<GenericBinaryError>(Args: "elem section ended prematurely",
1754 Args: object_error::parse_failed);
1755 return Error::success();
1756}
1757
1758Error WasmObjectFile::parseDataSection(ReadContext &Ctx) {
1759 DataSection = Sections.size();
1760 uint32_t Count = readVaruint32(Ctx);
1761 if (DataCount && Count != *DataCount)
1762 return make_error<GenericBinaryError>(
1763 Args: "number of data segments does not match DataCount section");
1764 DataSegments.reserve(n: Count);
1765 while (Count--) {
1766 WasmSegment Segment;
1767 Segment.Data.InitFlags = readVaruint32(Ctx);
1768 Segment.Data.MemoryIndex =
1769 (Segment.Data.InitFlags & wasm::WASM_DATA_SEGMENT_HAS_MEMINDEX)
1770 ? readVaruint32(Ctx)
1771 : 0;
1772 if ((Segment.Data.InitFlags & wasm::WASM_DATA_SEGMENT_IS_PASSIVE) == 0) {
1773 if (Error Err = readInitExpr(Expr&: Segment.Data.Offset, Ctx))
1774 return Err;
1775 } else {
1776 Segment.Data.Offset.Extended = false;
1777 Segment.Data.Offset.Inst.Opcode = wasm::WASM_OPCODE_I32_CONST;
1778 Segment.Data.Offset.Inst.Value.Int32 = 0;
1779 }
1780 uint32_t Size = readVaruint32(Ctx);
1781 if (Size > (size_t)(Ctx.End - Ctx.Ptr))
1782 return make_error<GenericBinaryError>(Args: "invalid segment size",
1783 Args: object_error::parse_failed);
1784 Segment.Data.Content = ArrayRef<uint8_t>(Ctx.Ptr, Size);
1785 // The rest of these Data fields are set later, when reading in the linking
1786 // metadata section.
1787 Segment.Data.Alignment = 0;
1788 Segment.Data.LinkingFlags = 0;
1789 Segment.Data.Comdat = UINT32_MAX;
1790 Segment.SectionOffset = Ctx.Ptr - Ctx.Start;
1791 Ctx.Ptr += Size;
1792 DataSegments.push_back(x: Segment);
1793 }
1794 if (Ctx.Ptr != Ctx.End)
1795 return make_error<GenericBinaryError>(Args: "data section ended prematurely",
1796 Args: object_error::parse_failed);
1797 return Error::success();
1798}
1799
1800Error WasmObjectFile::parseDataCountSection(ReadContext &Ctx) {
1801 DataCount = readVaruint32(Ctx);
1802 return Error::success();
1803}
1804
1805const wasm::WasmObjectHeader &WasmObjectFile::getHeader() const {
1806 return Header;
1807}
1808
1809void WasmObjectFile::moveSymbolNext(DataRefImpl &Symb) const { Symb.d.b++; }
1810
1811Expected<uint32_t> WasmObjectFile::getSymbolFlags(DataRefImpl Symb) const {
1812 uint32_t Result = SymbolRef::SF_None;
1813 const WasmSymbol &Sym = getWasmSymbol(Symb);
1814
1815 LLVM_DEBUG(dbgs() << "getSymbolFlags: ptr=" << &Sym << " " << Sym << "\n");
1816 if (Sym.isBindingWeak())
1817 Result |= SymbolRef::SF_Weak;
1818 if (!Sym.isBindingLocal())
1819 Result |= SymbolRef::SF_Global;
1820 if (Sym.isHidden())
1821 Result |= SymbolRef::SF_Hidden;
1822 if (!Sym.isDefined())
1823 Result |= SymbolRef::SF_Undefined;
1824 if (Sym.isTypeFunction())
1825 Result |= SymbolRef::SF_Executable;
1826 return Result;
1827}
1828
1829basic_symbol_iterator WasmObjectFile::symbol_begin() const {
1830 DataRefImpl Ref;
1831 Ref.d.a = 1; // Arbitrary non-zero value so that Ref.p is non-null
1832 Ref.d.b = 0; // Symbol index
1833 return BasicSymbolRef(Ref, this);
1834}
1835
1836basic_symbol_iterator WasmObjectFile::symbol_end() const {
1837 DataRefImpl Ref;
1838 Ref.d.a = 1; // Arbitrary non-zero value so that Ref.p is non-null
1839 Ref.d.b = Symbols.size(); // Symbol index
1840 return BasicSymbolRef(Ref, this);
1841}
1842
1843const WasmSymbol &WasmObjectFile::getWasmSymbol(const DataRefImpl &Symb) const {
1844 return Symbols[Symb.d.b];
1845}
1846
1847const WasmSymbol &WasmObjectFile::getWasmSymbol(const SymbolRef &Symb) const {
1848 return getWasmSymbol(Symb: Symb.getRawDataRefImpl());
1849}
1850
1851Expected<StringRef> WasmObjectFile::getSymbolName(DataRefImpl Symb) const {
1852 return getWasmSymbol(Symb).Info.Name;
1853}
1854
1855Expected<uint64_t> WasmObjectFile::getSymbolAddress(DataRefImpl Symb) const {
1856 auto &Sym = getWasmSymbol(Symb);
1857 if (!Sym.isDefined())
1858 return 0;
1859 Expected<section_iterator> Sec = getSymbolSection(Symb);
1860 if (!Sec)
1861 return Sec.takeError();
1862 uint32_t SectionAddress = getSectionAddress(Sec: Sec.get()->getRawDataRefImpl());
1863 if (Sym.Info.Kind == wasm::WASM_SYMBOL_TYPE_FUNCTION &&
1864 isDefinedFunctionIndex(Index: Sym.Info.ElementIndex)) {
1865 return getDefinedFunction(Index: Sym.Info.ElementIndex).CodeSectionOffset +
1866 SectionAddress;
1867 }
1868 if (Sym.Info.Kind == wasm::WASM_SYMBOL_TYPE_GLOBAL &&
1869 isDefinedGlobalIndex(Index: Sym.Info.ElementIndex)) {
1870 return getDefinedGlobal(Index: Sym.Info.ElementIndex).Offset + SectionAddress;
1871 }
1872
1873 return getSymbolValue(Symb);
1874}
1875
1876uint64_t WasmObjectFile::getWasmSymbolValue(const WasmSymbol &Sym) const {
1877 switch (Sym.Info.Kind) {
1878 case wasm::WASM_SYMBOL_TYPE_FUNCTION:
1879 case wasm::WASM_SYMBOL_TYPE_GLOBAL:
1880 case wasm::WASM_SYMBOL_TYPE_TAG:
1881 case wasm::WASM_SYMBOL_TYPE_TABLE:
1882 return Sym.Info.ElementIndex;
1883 case wasm::WASM_SYMBOL_TYPE_DATA: {
1884 // The value of a data symbol is the segment offset, plus the symbol
1885 // offset within the segment.
1886 uint32_t SegmentIndex = Sym.Info.DataRef.Segment;
1887 const wasm::WasmDataSegment &Segment = DataSegments[SegmentIndex].Data;
1888 if (Segment.Offset.Extended) {
1889 llvm_unreachable("extended init exprs not supported");
1890 } else if (Segment.Offset.Inst.Opcode == wasm::WASM_OPCODE_I32_CONST) {
1891 return Segment.Offset.Inst.Value.Int32 + Sym.Info.DataRef.Offset;
1892 } else if (Segment.Offset.Inst.Opcode == wasm::WASM_OPCODE_I64_CONST) {
1893 return Segment.Offset.Inst.Value.Int64 + Sym.Info.DataRef.Offset;
1894 } else if (Segment.Offset.Inst.Opcode == wasm::WASM_OPCODE_GLOBAL_GET) {
1895 return Sym.Info.DataRef.Offset;
1896 } else {
1897 llvm_unreachable("unknown init expr opcode");
1898 }
1899 }
1900 case wasm::WASM_SYMBOL_TYPE_SECTION:
1901 return 0;
1902 }
1903 llvm_unreachable("invalid symbol type");
1904}
1905
1906uint64_t WasmObjectFile::getSymbolValueImpl(DataRefImpl Symb) const {
1907 return getWasmSymbolValue(Sym: getWasmSymbol(Symb));
1908}
1909
1910uint32_t WasmObjectFile::getSymbolAlignment(DataRefImpl Symb) const {
1911 llvm_unreachable("not yet implemented");
1912 return 0;
1913}
1914
1915uint64_t WasmObjectFile::getCommonSymbolSizeImpl(DataRefImpl Symb) const {
1916 llvm_unreachable("not yet implemented");
1917 return 0;
1918}
1919
1920Expected<SymbolRef::Type>
1921WasmObjectFile::getSymbolType(DataRefImpl Symb) const {
1922 const WasmSymbol &Sym = getWasmSymbol(Symb);
1923
1924 switch (Sym.Info.Kind) {
1925 case wasm::WASM_SYMBOL_TYPE_FUNCTION:
1926 return SymbolRef::ST_Function;
1927 case wasm::WASM_SYMBOL_TYPE_GLOBAL:
1928 return SymbolRef::ST_Other;
1929 case wasm::WASM_SYMBOL_TYPE_DATA:
1930 return SymbolRef::ST_Data;
1931 case wasm::WASM_SYMBOL_TYPE_SECTION:
1932 return SymbolRef::ST_Debug;
1933 case wasm::WASM_SYMBOL_TYPE_TAG:
1934 return SymbolRef::ST_Other;
1935 case wasm::WASM_SYMBOL_TYPE_TABLE:
1936 return SymbolRef::ST_Other;
1937 }
1938
1939 llvm_unreachable("unknown WasmSymbol::SymbolType");
1940 return SymbolRef::ST_Other;
1941}
1942
1943Expected<section_iterator>
1944WasmObjectFile::getSymbolSection(DataRefImpl Symb) const {
1945 const WasmSymbol &Sym = getWasmSymbol(Symb);
1946 if (Sym.isUndefined())
1947 return section_end();
1948
1949 DataRefImpl Ref;
1950 Ref.d.a = getSymbolSectionIdImpl(Symb: Sym);
1951 return section_iterator(SectionRef(Ref, this));
1952}
1953
1954uint32_t WasmObjectFile::getSymbolSectionId(SymbolRef Symb) const {
1955 const WasmSymbol &Sym = getWasmSymbol(Symb);
1956 return getSymbolSectionIdImpl(Symb: Sym);
1957}
1958
1959uint32_t WasmObjectFile::getSymbolSectionIdImpl(const WasmSymbol &Sym) const {
1960 switch (Sym.Info.Kind) {
1961 case wasm::WASM_SYMBOL_TYPE_FUNCTION:
1962 return CodeSection;
1963 case wasm::WASM_SYMBOL_TYPE_GLOBAL:
1964 return GlobalSection;
1965 case wasm::WASM_SYMBOL_TYPE_DATA:
1966 return DataSection;
1967 case wasm::WASM_SYMBOL_TYPE_SECTION:
1968 return Sym.Info.ElementIndex;
1969 case wasm::WASM_SYMBOL_TYPE_TAG:
1970 return TagSection;
1971 case wasm::WASM_SYMBOL_TYPE_TABLE:
1972 return TableSection;
1973 default:
1974 llvm_unreachable("unknown WasmSymbol::SymbolType");
1975 }
1976}
1977
1978uint32_t WasmObjectFile::getSymbolSize(SymbolRef Symb) const {
1979 const WasmSymbol &Sym = getWasmSymbol(Symb);
1980 if (!Sym.isDefined())
1981 return 0;
1982 if (Sym.isTypeGlobal())
1983 return getDefinedGlobal(Index: Sym.Info.ElementIndex).Size;
1984 if (Sym.isTypeData())
1985 return Sym.Info.DataRef.Size;
1986 if (Sym.isTypeFunction())
1987 return functions()[Sym.Info.ElementIndex - getNumImportedFunctions()].Size;
1988 // Currently symbol size is only tracked for data segments and functions. In
1989 // principle we could also track size (e.g. binary size) for tables, globals
1990 // and element segments etc too.
1991 return 0;
1992}
1993
1994void WasmObjectFile::moveSectionNext(DataRefImpl &Sec) const { Sec.d.a++; }
1995
1996Expected<StringRef> WasmObjectFile::getSectionName(DataRefImpl Sec) const {
1997 const WasmSection &S = Sections[Sec.d.a];
1998 if (S.Type == wasm::WASM_SEC_CUSTOM)
1999 return S.Name;
2000 if (S.Type > wasm::WASM_SEC_LAST_KNOWN)
2001 return createStringError(EC: object_error::invalid_section_index, S: "");
2002 return wasm::sectionTypeToString(type: S.Type);
2003}
2004
2005uint64_t WasmObjectFile::getSectionAddress(DataRefImpl Sec) const {
2006 // For object files, use 0 for section addresses, and section offsets for
2007 // symbol addresses. For linked files, use file offsets.
2008 // See also getSymbolAddress.
2009 return isRelocatableObject() || isSharedObject() ? 0
2010 : Sections[Sec.d.a].Offset;
2011}
2012
2013uint64_t WasmObjectFile::getSectionIndex(DataRefImpl Sec) const {
2014 return Sec.d.a;
2015}
2016
2017uint64_t WasmObjectFile::getSectionSize(DataRefImpl Sec) const {
2018 const WasmSection &S = Sections[Sec.d.a];
2019 return S.Content.size();
2020}
2021
2022Expected<ArrayRef<uint8_t>>
2023WasmObjectFile::getSectionContents(DataRefImpl Sec) const {
2024 const WasmSection &S = Sections[Sec.d.a];
2025 // This will never fail since wasm sections can never be empty (user-sections
2026 // must have a name and non-user sections each have a defined structure).
2027 return S.Content;
2028}
2029
2030uint64_t WasmObjectFile::getSectionAlignment(DataRefImpl Sec) const {
2031 return 1;
2032}
2033
2034bool WasmObjectFile::isSectionCompressed(DataRefImpl Sec) const {
2035 return false;
2036}
2037
2038bool WasmObjectFile::isSectionText(DataRefImpl Sec) const {
2039 return getWasmSection(Ref: Sec).Type == wasm::WASM_SEC_CODE;
2040}
2041
2042bool WasmObjectFile::isSectionData(DataRefImpl Sec) const {
2043 return getWasmSection(Ref: Sec).Type == wasm::WASM_SEC_DATA;
2044}
2045
2046bool WasmObjectFile::isSectionBSS(DataRefImpl Sec) const { return false; }
2047
2048bool WasmObjectFile::isSectionVirtual(DataRefImpl Sec) const { return false; }
2049
2050relocation_iterator WasmObjectFile::section_rel_begin(DataRefImpl Ref) const {
2051 DataRefImpl RelocRef;
2052 RelocRef.d.a = Ref.d.a;
2053 RelocRef.d.b = 0;
2054 return relocation_iterator(RelocationRef(RelocRef, this));
2055}
2056
2057relocation_iterator WasmObjectFile::section_rel_end(DataRefImpl Ref) const {
2058 const WasmSection &Sec = getWasmSection(Ref);
2059 DataRefImpl RelocRef;
2060 RelocRef.d.a = Ref.d.a;
2061 RelocRef.d.b = Sec.Relocations.size();
2062 return relocation_iterator(RelocationRef(RelocRef, this));
2063}
2064
2065void WasmObjectFile::moveRelocationNext(DataRefImpl &Rel) const { Rel.d.b++; }
2066
2067uint64_t WasmObjectFile::getRelocationOffset(DataRefImpl Ref) const {
2068 const wasm::WasmRelocation &Rel = getWasmRelocation(Ref);
2069 return Rel.Offset;
2070}
2071
2072symbol_iterator WasmObjectFile::getRelocationSymbol(DataRefImpl Ref) const {
2073 const wasm::WasmRelocation &Rel = getWasmRelocation(Ref);
2074 if (Rel.Type == wasm::R_WASM_TYPE_INDEX_LEB)
2075 return symbol_end();
2076 DataRefImpl Sym;
2077 Sym.d.a = 1;
2078 Sym.d.b = Rel.Index;
2079 return symbol_iterator(SymbolRef(Sym, this));
2080}
2081
2082uint64_t WasmObjectFile::getRelocationType(DataRefImpl Ref) const {
2083 const wasm::WasmRelocation &Rel = getWasmRelocation(Ref);
2084 return Rel.Type;
2085}
2086
2087void WasmObjectFile::getRelocationTypeName(
2088 DataRefImpl Ref, SmallVectorImpl<char> &Result) const {
2089 const wasm::WasmRelocation &Rel = getWasmRelocation(Ref);
2090 StringRef Res = "Unknown";
2091
2092#define WASM_RELOC(name, value) \
2093 case wasm::name: \
2094 Res = #name; \
2095 break;
2096
2097 switch (Rel.Type) {
2098#include "llvm/BinaryFormat/WasmRelocs.def"
2099 }
2100
2101#undef WASM_RELOC
2102
2103 Result.append(in_start: Res.begin(), in_end: Res.end());
2104}
2105
2106section_iterator WasmObjectFile::section_begin() const {
2107 DataRefImpl Ref;
2108 Ref.d.a = 0;
2109 return section_iterator(SectionRef(Ref, this));
2110}
2111
2112section_iterator WasmObjectFile::section_end() const {
2113 DataRefImpl Ref;
2114 Ref.d.a = Sections.size();
2115 return section_iterator(SectionRef(Ref, this));
2116}
2117
2118uint8_t WasmObjectFile::getBytesInAddress() const {
2119 return HasMemory64 ? 8 : 4;
2120}
2121
2122StringRef WasmObjectFile::getFileFormatName() const { return "WASM"; }
2123
2124Triple::ArchType WasmObjectFile::getArch() const {
2125 return HasMemory64 ? Triple::wasm64 : Triple::wasm32;
2126}
2127
2128Expected<SubtargetFeatures> WasmObjectFile::getFeatures() const {
2129 return SubtargetFeatures();
2130}
2131
2132bool WasmObjectFile::isRelocatableObject() const { return HasLinkingSection; }
2133
2134bool WasmObjectFile::isSharedObject() const { return HasDylinkSection; }
2135
2136const WasmSection &WasmObjectFile::getWasmSection(DataRefImpl Ref) const {
2137 assert(Ref.d.a < Sections.size());
2138 return Sections[Ref.d.a];
2139}
2140
2141const WasmSection &
2142WasmObjectFile::getWasmSection(const SectionRef &Section) const {
2143 return getWasmSection(Ref: Section.getRawDataRefImpl());
2144}
2145
2146const wasm::WasmRelocation &
2147WasmObjectFile::getWasmRelocation(const RelocationRef &Ref) const {
2148 return getWasmRelocation(Ref: Ref.getRawDataRefImpl());
2149}
2150
2151const wasm::WasmRelocation &
2152WasmObjectFile::getWasmRelocation(DataRefImpl Ref) const {
2153 assert(Ref.d.a < Sections.size());
2154 const WasmSection &Sec = Sections[Ref.d.a];
2155 assert(Ref.d.b < Sec.Relocations.size());
2156 return Sec.Relocations[Ref.d.b];
2157}
2158
2159int WasmSectionOrderChecker::getSectionOrder(unsigned ID,
2160 StringRef CustomSectionName) {
2161 switch (ID) {
2162 case wasm::WASM_SEC_CUSTOM:
2163 return StringSwitch<unsigned>(CustomSectionName)
2164 .Case(S: "dylink", Value: WASM_SEC_ORDER_DYLINK)
2165 .Case(S: "dylink.0", Value: WASM_SEC_ORDER_DYLINK)
2166 .Case(S: "linking", Value: WASM_SEC_ORDER_LINKING)
2167 .StartsWith(S: "reloc.", Value: WASM_SEC_ORDER_RELOC)
2168 .Case(S: "name", Value: WASM_SEC_ORDER_NAME)
2169 .Case(S: "producers", Value: WASM_SEC_ORDER_PRODUCERS)
2170 .Case(S: "target_features", Value: WASM_SEC_ORDER_TARGET_FEATURES)
2171 .Default(Value: WASM_SEC_ORDER_NONE);
2172 case wasm::WASM_SEC_TYPE:
2173 return WASM_SEC_ORDER_TYPE;
2174 case wasm::WASM_SEC_IMPORT:
2175 return WASM_SEC_ORDER_IMPORT;
2176 case wasm::WASM_SEC_FUNCTION:
2177 return WASM_SEC_ORDER_FUNCTION;
2178 case wasm::WASM_SEC_TABLE:
2179 return WASM_SEC_ORDER_TABLE;
2180 case wasm::WASM_SEC_MEMORY:
2181 return WASM_SEC_ORDER_MEMORY;
2182 case wasm::WASM_SEC_GLOBAL:
2183 return WASM_SEC_ORDER_GLOBAL;
2184 case wasm::WASM_SEC_EXPORT:
2185 return WASM_SEC_ORDER_EXPORT;
2186 case wasm::WASM_SEC_START:
2187 return WASM_SEC_ORDER_START;
2188 case wasm::WASM_SEC_ELEM:
2189 return WASM_SEC_ORDER_ELEM;
2190 case wasm::WASM_SEC_CODE:
2191 return WASM_SEC_ORDER_CODE;
2192 case wasm::WASM_SEC_DATA:
2193 return WASM_SEC_ORDER_DATA;
2194 case wasm::WASM_SEC_DATACOUNT:
2195 return WASM_SEC_ORDER_DATACOUNT;
2196 case wasm::WASM_SEC_TAG:
2197 return WASM_SEC_ORDER_TAG;
2198 default:
2199 return WASM_SEC_ORDER_NONE;
2200 }
2201}
2202
2203// Represents the edges in a directed graph where any node B reachable from node
2204// A is not allowed to appear before A in the section ordering, but may appear
2205// afterward.
2206int WasmSectionOrderChecker::DisallowedPredecessors
2207 [WASM_NUM_SEC_ORDERS][WASM_NUM_SEC_ORDERS] = {
2208 // WASM_SEC_ORDER_NONE
2209 {},
2210 // WASM_SEC_ORDER_TYPE
2211 {WASM_SEC_ORDER_TYPE, WASM_SEC_ORDER_IMPORT},
2212 // WASM_SEC_ORDER_IMPORT
2213 {WASM_SEC_ORDER_IMPORT, WASM_SEC_ORDER_FUNCTION},
2214 // WASM_SEC_ORDER_FUNCTION
2215 {WASM_SEC_ORDER_FUNCTION, WASM_SEC_ORDER_TABLE},
2216 // WASM_SEC_ORDER_TABLE
2217 {WASM_SEC_ORDER_TABLE, WASM_SEC_ORDER_MEMORY},
2218 // WASM_SEC_ORDER_MEMORY
2219 {WASM_SEC_ORDER_MEMORY, WASM_SEC_ORDER_TAG},
2220 // WASM_SEC_ORDER_TAG
2221 {WASM_SEC_ORDER_TAG, WASM_SEC_ORDER_GLOBAL},
2222 // WASM_SEC_ORDER_GLOBAL
2223 {WASM_SEC_ORDER_GLOBAL, WASM_SEC_ORDER_EXPORT},
2224 // WASM_SEC_ORDER_EXPORT
2225 {WASM_SEC_ORDER_EXPORT, WASM_SEC_ORDER_START},
2226 // WASM_SEC_ORDER_START
2227 {WASM_SEC_ORDER_START, WASM_SEC_ORDER_ELEM},
2228 // WASM_SEC_ORDER_ELEM
2229 {WASM_SEC_ORDER_ELEM, WASM_SEC_ORDER_DATACOUNT},
2230 // WASM_SEC_ORDER_DATACOUNT
2231 {WASM_SEC_ORDER_DATACOUNT, WASM_SEC_ORDER_CODE},
2232 // WASM_SEC_ORDER_CODE
2233 {WASM_SEC_ORDER_CODE, WASM_SEC_ORDER_DATA},
2234 // WASM_SEC_ORDER_DATA
2235 {WASM_SEC_ORDER_DATA, WASM_SEC_ORDER_LINKING},
2236
2237 // Custom Sections
2238 // WASM_SEC_ORDER_DYLINK
2239 {WASM_SEC_ORDER_DYLINK, WASM_SEC_ORDER_TYPE},
2240 // WASM_SEC_ORDER_LINKING
2241 {WASM_SEC_ORDER_LINKING, WASM_SEC_ORDER_RELOC, WASM_SEC_ORDER_NAME},
2242 // WASM_SEC_ORDER_RELOC (can be repeated)
2243 {},
2244 // WASM_SEC_ORDER_NAME
2245 {WASM_SEC_ORDER_NAME, WASM_SEC_ORDER_PRODUCERS},
2246 // WASM_SEC_ORDER_PRODUCERS
2247 {WASM_SEC_ORDER_PRODUCERS, WASM_SEC_ORDER_TARGET_FEATURES},
2248 // WASM_SEC_ORDER_TARGET_FEATURES
2249 {WASM_SEC_ORDER_TARGET_FEATURES}};
2250
2251bool WasmSectionOrderChecker::isValidSectionOrder(unsigned ID,
2252 StringRef CustomSectionName) {
2253 int Order = getSectionOrder(ID, CustomSectionName);
2254 if (Order == WASM_SEC_ORDER_NONE)
2255 return true;
2256
2257 // Disallowed predecessors we need to check for
2258 SmallVector<int, WASM_NUM_SEC_ORDERS> WorkList;
2259
2260 // Keep track of completed checks to avoid repeating work
2261 bool Checked[WASM_NUM_SEC_ORDERS] = {};
2262
2263 int Curr = Order;
2264 while (true) {
2265 // Add new disallowed predecessors to work list
2266 for (size_t I = 0;; ++I) {
2267 int Next = DisallowedPredecessors[Curr][I];
2268 if (Next == WASM_SEC_ORDER_NONE)
2269 break;
2270 if (Checked[Next])
2271 continue;
2272 WorkList.push_back(Elt: Next);
2273 Checked[Next] = true;
2274 }
2275
2276 if (WorkList.empty())
2277 break;
2278
2279 // Consider next disallowed predecessor
2280 Curr = WorkList.pop_back_val();
2281 if (Seen[Curr])
2282 return false;
2283 }
2284
2285 // Have not seen any disallowed predecessors
2286 Seen[Order] = true;
2287 return true;
2288}
2289