LLVM 18.0.0git
Wasm.h
Go to the documentation of this file.
1//===- Wasm.h - Wasm object file implementation -----------------*- C++ -*-===//
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// This file declares the WasmObjectFile class, which implements the ObjectFile
10// interface for Wasm files.
11//
12// See: https://github.com/WebAssembly/design/blob/main/BinaryEncoding.md
13//
14//===----------------------------------------------------------------------===//
15
16#ifndef LLVM_OBJECT_WASM_H
17#define LLVM_OBJECT_WASM_H
18
19#include "llvm/ADT/ArrayRef.h"
20#include "llvm/ADT/StringRef.h"
22#include "llvm/Config/llvm-config.h"
24#include "llvm/Object/Binary.h"
26#include "llvm/Support/Error.h"
28#include <cstddef>
29#include <cstdint>
30#include <vector>
31
32namespace llvm {
33namespace object {
34
36public:
43
48
49 bool isTypeFunction() const {
51 }
52
54
55 bool isTypeData() const { return Info.Kind == wasm::WASM_SYMBOL_TYPE_DATA; }
56
57 bool isTypeGlobal() const {
59 }
60
61 bool isTypeSection() const {
63 }
64
65 bool isTypeTag() const { return Info.Kind == wasm::WASM_SYMBOL_TYPE_TAG; }
66
67 bool isDefined() const { return !isUndefined(); }
68
69 bool isUndefined() const {
71 }
72
73 bool isBindingWeak() const {
75 }
76
77 bool isBindingGlobal() const {
79 }
80
81 bool isBindingLocal() const {
83 }
84
85 unsigned getBinding() const {
87 }
88
89 bool isHidden() const {
91 }
92
93 unsigned getVisibility() const {
95 }
96
97 void print(raw_ostream &Out) const;
98
99#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
100 LLVM_DUMP_METHOD void dump() const;
101#endif
102};
103
105 WasmSection() = default;
106
108 uint32_t Offset = 0; // Offset within the file
109 StringRef Name; // Section name (User-defined sections only)
110 uint32_t Comdat = UINT32_MAX; // From the "comdat info" section
112 std::vector<wasm::WasmRelocation> Relocations;
113 // Length of the LEB encoding of the section header's size field
114 std::optional<uint8_t> HeaderSecSizeEncodingLen;
115};
116
120};
121
123
124public:
126
127 const wasm::WasmObjectHeader &getHeader() const;
128 const WasmSymbol &getWasmSymbol(const DataRefImpl &Symb) const;
129 const WasmSymbol &getWasmSymbol(const SymbolRef &Symbol) const;
130 const WasmSection &getWasmSection(const SectionRef &Section) const;
132
133 static bool classof(const Binary *v) { return v->isWasm(); }
134
135 const wasm::WasmDylinkInfo &dylinkInfo() const { return DylinkInfo; }
136 const wasm::WasmProducerInfo &getProducerInfo() const { return ProducerInfo; }
138 return TargetFeatures;
139 }
140 ArrayRef<wasm::WasmSignature> types() const { return Signatures; }
141 ArrayRef<wasm::WasmImport> imports() const { return Imports; }
142 ArrayRef<wasm::WasmTable> tables() const { return Tables; }
143 ArrayRef<wasm::WasmLimits> memories() const { return Memories; }
144 ArrayRef<wasm::WasmGlobal> globals() const { return Globals; }
145 ArrayRef<wasm::WasmTag> tags() const { return Tags; }
146 ArrayRef<wasm::WasmExport> exports() const { return Exports; }
147 ArrayRef<WasmSymbol> syms() const { return Symbols; }
148 const wasm::WasmLinkingData &linkingData() const { return LinkingData; }
149 uint32_t getNumberOfSymbols() const { return Symbols.size(); }
150 ArrayRef<wasm::WasmElemSegment> elements() const { return ElemSegments; }
151 ArrayRef<WasmSegment> dataSegments() const { return DataSegments; }
152 ArrayRef<wasm::WasmFunction> functions() const { return Functions; }
153 ArrayRef<wasm::WasmDebugName> debugNames() const { return DebugNames; }
154 uint32_t startFunction() const { return StartFunction; }
155 uint32_t getNumImportedGlobals() const { return NumImportedGlobals; }
156 uint32_t getNumImportedTables() const { return NumImportedTables; }
157 uint32_t getNumImportedFunctions() const { return NumImportedFunctions; }
158 uint32_t getNumImportedTags() const { return NumImportedTags; }
159 uint32_t getNumSections() const { return Sections.size(); }
160 void moveSymbolNext(DataRefImpl &Symb) const override;
161
162 Expected<uint32_t> getSymbolFlags(DataRefImpl Symb) const override;
163
164 basic_symbol_iterator symbol_begin() const override;
165
166 basic_symbol_iterator symbol_end() const override;
167 Expected<StringRef> getSymbolName(DataRefImpl Symb) const override;
168
169 bool is64Bit() const override { return false; }
170
173 uint64_t getSymbolValueImpl(DataRefImpl Symb) const override;
174 uint32_t getSymbolAlignment(DataRefImpl Symb) const override;
175 uint64_t getCommonSymbolSizeImpl(DataRefImpl Symb) const override;
179
180 // Overrides from SectionRef.
181 void moveSectionNext(DataRefImpl &Sec) const override;
183 uint64_t getSectionAddress(DataRefImpl Sec) const override;
184 uint64_t getSectionIndex(DataRefImpl Sec) const override;
185 uint64_t getSectionSize(DataRefImpl Sec) const override;
187 getSectionContents(DataRefImpl Sec) const override;
188 uint64_t getSectionAlignment(DataRefImpl Sec) const override;
189 bool isSectionCompressed(DataRefImpl Sec) const override;
190 bool isSectionText(DataRefImpl Sec) const override;
191 bool isSectionData(DataRefImpl Sec) const override;
192 bool isSectionBSS(DataRefImpl Sec) const override;
193 bool isSectionVirtual(DataRefImpl Sec) const override;
196
197 // Overrides from RelocationRef.
198 void moveRelocationNext(DataRefImpl &Rel) const override;
199 uint64_t getRelocationOffset(DataRefImpl Rel) const override;
201 uint64_t getRelocationType(DataRefImpl Rel) const override;
203 SmallVectorImpl<char> &Result) const override;
204
205 section_iterator section_begin() const override;
206 section_iterator section_end() const override;
207 uint8_t getBytesInAddress() const override;
208 StringRef getFileFormatName() const override;
209 Triple::ArchType getArch() const override;
211 bool isRelocatableObject() const override;
212 bool isSharedObject() const;
213
214 struct ReadContext {
215 const uint8_t *Start;
216 const uint8_t *Ptr;
217 const uint8_t *End;
218 };
219
220private:
221 bool isValidFunctionIndex(uint32_t Index) const;
222 bool isDefinedFunctionIndex(uint32_t Index) const;
223 bool isValidGlobalIndex(uint32_t Index) const;
224 bool isValidTableNumber(uint32_t Index) const;
225 bool isDefinedGlobalIndex(uint32_t Index) const;
226 bool isDefinedTableNumber(uint32_t Index) const;
227 bool isValidTagIndex(uint32_t Index) const;
228 bool isDefinedTagIndex(uint32_t Index) const;
229 bool isValidFunctionSymbol(uint32_t Index) const;
230 bool isValidTableSymbol(uint32_t Index) const;
231 bool isValidGlobalSymbol(uint32_t Index) const;
232 bool isValidTagSymbol(uint32_t Index) const;
233 bool isValidDataSymbol(uint32_t Index) const;
234 bool isValidSectionSymbol(uint32_t Index) const;
235 wasm::WasmFunction &getDefinedFunction(uint32_t Index);
236 const wasm::WasmFunction &getDefinedFunction(uint32_t Index) const;
237 wasm::WasmGlobal &getDefinedGlobal(uint32_t Index);
238 wasm::WasmTag &getDefinedTag(uint32_t Index);
239
242 uint32_t getSymbolSectionIdImpl(const WasmSymbol &Symb) const;
243
244 Error parseSection(WasmSection &Sec);
245 Error parseCustomSection(WasmSection &Sec, ReadContext &Ctx);
246
247 // Standard section types
248 Error parseTypeSection(ReadContext &Ctx);
249 Error parseImportSection(ReadContext &Ctx);
250 Error parseFunctionSection(ReadContext &Ctx);
251 Error parseTableSection(ReadContext &Ctx);
252 Error parseMemorySection(ReadContext &Ctx);
253 Error parseTagSection(ReadContext &Ctx);
254 Error parseGlobalSection(ReadContext &Ctx);
255 Error parseExportSection(ReadContext &Ctx);
256 Error parseStartSection(ReadContext &Ctx);
257 Error parseElemSection(ReadContext &Ctx);
258 Error parseCodeSection(ReadContext &Ctx);
259 Error parseDataSection(ReadContext &Ctx);
260 Error parseDataCountSection(ReadContext &Ctx);
261
262 // Custom section types
263 Error parseDylinkSection(ReadContext &Ctx);
264 Error parseDylink0Section(ReadContext &Ctx);
265 Error parseNameSection(ReadContext &Ctx);
266 Error parseLinkingSection(ReadContext &Ctx);
267 Error parseLinkingSectionSymtab(ReadContext &Ctx);
268 Error parseLinkingSectionComdat(ReadContext &Ctx);
269 Error parseProducersSection(ReadContext &Ctx);
270 Error parseTargetFeaturesSection(ReadContext &Ctx);
271 Error parseRelocSection(StringRef Name, ReadContext &Ctx);
272
274 std::vector<WasmSection> Sections;
275 wasm::WasmDylinkInfo DylinkInfo;
276 wasm::WasmProducerInfo ProducerInfo;
277 std::vector<wasm::WasmFeatureEntry> TargetFeatures;
278 std::vector<wasm::WasmSignature> Signatures;
279 std::vector<wasm::WasmTable> Tables;
280 std::vector<wasm::WasmLimits> Memories;
281 std::vector<wasm::WasmGlobal> Globals;
282 std::vector<wasm::WasmTag> Tags;
283 std::vector<wasm::WasmImport> Imports;
284 std::vector<wasm::WasmExport> Exports;
285 std::vector<wasm::WasmElemSegment> ElemSegments;
286 std::vector<WasmSegment> DataSegments;
287 std::optional<size_t> DataCount;
288 std::vector<wasm::WasmFunction> Functions;
289 std::vector<WasmSymbol> Symbols;
290 std::vector<wasm::WasmDebugName> DebugNames;
291 uint32_t StartFunction = -1;
292 bool HasLinkingSection = false;
293 bool HasDylinkSection = false;
294 bool HasMemory64 = false;
295 wasm::WasmLinkingData LinkingData;
296 uint32_t NumImportedGlobals = 0;
297 uint32_t NumImportedTables = 0;
298 uint32_t NumImportedFunctions = 0;
299 uint32_t NumImportedTags = 0;
300 uint32_t CodeSection = 0;
301 uint32_t DataSection = 0;
302 uint32_t TagSection = 0;
303 uint32_t GlobalSection = 0;
304 uint32_t TableSection = 0;
305};
306
308public:
309 // We define orders for all core wasm sections and known custom sections.
310 enum : int {
311 // Sentinel, must be zero
313
314 // Core sections
328
329 // Custom sections
330 // "dylink" should be the very first section in the module
332 // "linking" section requires DATA section in order to validate data symbols
334 // Must come after "linking" section in order to validate reloc indexes.
336 // "name" section must appear after DATA. Comes after "linking" to allow
337 // symbol table to set default function name.
339 // "producers" section must appear after "name" section.
341 // "target_features" section must appear after producers section
343
344 // Must be last
346
347 };
348
349 // Sections that may or may not be present, but cannot be predecessors
351
352 bool isValidSectionOrder(unsigned ID, StringRef CustomSectionName = "");
353
354private:
355 bool Seen[WASM_NUM_SEC_ORDERS] = {}; // Sections that have been seen already
356
357 // Returns -1 for unknown sections.
358 int getSectionOrder(unsigned ID, StringRef CustomSectionName = "");
359};
360
361} // end namespace object
362
364 Sym.print(OS);
365 return OS;
366}
367
368} // end namespace llvm
369
370#endif // LLVM_OBJECT_WASM_H
#define LLVM_DUMP_METHOD
Mark debug helper function definitions like dump() that should not be stripped from debug builds.
Definition: Compiler.h:529
std::string Name
Symbol * Sym
Definition: ELF_riscv.cpp:477
raw_pwrite_stream & OS
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition: ArrayRef.h:41
Lightweight error class with error context and mandatory checking.
Definition: Error.h:160
Tagged union holding either a T or a Error.
Definition: Error.h:474
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
Definition: SmallVector.h:577
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
The instances of the Type class are immutable: once they are created, they are never changed.
Definition: Type.h:45
This class is the base class for all object file types.
Definition: ObjectFile.h:229
This is a value type class that represents a single relocation in the list of relocations in the obje...
Definition: ObjectFile.h:52
This is a value type class that represents a single section in the list of sections in the object fil...
Definition: ObjectFile.h:81
This is a value type class that represents a single symbol in the list of symbols in the object file.
Definition: ObjectFile.h:168
basic_symbol_iterator symbol_begin() const override
relocation_iterator section_rel_end(DataRefImpl Sec) const override
void moveSymbolNext(DataRefImpl &Symb) const override
uint64_t getSectionAlignment(DataRefImpl Sec) const override
uint64_t getRelocationOffset(DataRefImpl Rel) const override
Expected< SymbolRef::Type > getSymbolType(DataRefImpl Symb) const override
ArrayRef< wasm::WasmSignature > types() const
Definition: Wasm.h:140
uint64_t getWasmSymbolValue(const WasmSymbol &Sym) const
uint64_t getSymbolValueImpl(DataRefImpl Symb) const override
ArrayRef< wasm::WasmElemSegment > elements() const
Definition: Wasm.h:150
bool isSectionText(DataRefImpl Sec) const override
const wasm::WasmProducerInfo & getProducerInfo() const
Definition: Wasm.h:136
bool isSectionBSS(DataRefImpl Sec) const override
basic_symbol_iterator symbol_end() const override
uint32_t startFunction() const
Definition: Wasm.h:154
Expected< uint32_t > getSymbolFlags(DataRefImpl Symb) const override
section_iterator section_begin() const override
ArrayRef< WasmSymbol > syms() const
Definition: Wasm.h:147
bool isRelocatableObject() const override
True if this is a relocatable object (.o/.obj).
void moveRelocationNext(DataRefImpl &Rel) const override
uint32_t getNumberOfSymbols() const
Definition: Wasm.h:149
ArrayRef< wasm::WasmLimits > memories() const
Definition: Wasm.h:143
bool is64Bit() const override
Definition: Wasm.h:169
uint32_t getSymbolSectionId(SymbolRef Sym) const
bool isSectionCompressed(DataRefImpl Sec) const override
bool isSectionVirtual(DataRefImpl Sec) const override
ArrayRef< wasm::WasmExport > exports() const
Definition: Wasm.h:146
uint32_t getNumImportedTags() const
Definition: Wasm.h:158
uint64_t getCommonSymbolSizeImpl(DataRefImpl Symb) const override
void getRelocationTypeName(DataRefImpl Rel, SmallVectorImpl< char > &Result) const override
StringRef getFileFormatName() const override
Expected< StringRef > getSymbolName(DataRefImpl Symb) const override
ArrayRef< wasm::WasmImport > imports() const
Definition: Wasm.h:141
relocation_iterator section_rel_begin(DataRefImpl Sec) const override
uint8_t getBytesInAddress() const override
The number of bytes used to represent an address in this object file format.
ArrayRef< wasm::WasmTag > tags() const
Definition: Wasm.h:145
section_iterator section_end() const override
Expected< ArrayRef< uint8_t > > getSectionContents(DataRefImpl Sec) const override
uint64_t getSectionIndex(DataRefImpl Sec) const override
uint32_t getSymbolAlignment(DataRefImpl Symb) const override
ArrayRef< wasm::WasmDebugName > debugNames() const
Definition: Wasm.h:153
uint64_t getSectionSize(DataRefImpl Sec) const override
const wasm::WasmLinkingData & linkingData() const
Definition: Wasm.h:148
Triple::ArchType getArch() const override
ArrayRef< wasm::WasmFeatureEntry > getTargetFeatures() const
Definition: Wasm.h:137
uint64_t getRelocationType(DataRefImpl Rel) const override
uint32_t getNumImportedTables() const
Definition: Wasm.h:156
const WasmSection & getWasmSection(const SectionRef &Section) const
static bool classof(const Binary *v)
Definition: Wasm.h:133
ArrayRef< wasm::WasmGlobal > globals() const
Definition: Wasm.h:144
Expected< section_iterator > getSymbolSection(DataRefImpl Symb) const override
ArrayRef< wasm::WasmTable > tables() const
Definition: Wasm.h:142
symbol_iterator getRelocationSymbol(DataRefImpl Rel) const override
Expected< SubtargetFeatures > getFeatures() const override
const wasm::WasmObjectHeader & getHeader() const
void moveSectionNext(DataRefImpl &Sec) const override
uint32_t getNumImportedFunctions() const
Definition: Wasm.h:157
ArrayRef< WasmSegment > dataSegments() const
Definition: Wasm.h:151
const wasm::WasmRelocation & getWasmRelocation(const RelocationRef &Ref) const
const wasm::WasmDylinkInfo & dylinkInfo() const
Definition: Wasm.h:135
ArrayRef< wasm::WasmFunction > functions() const
Definition: Wasm.h:152
const WasmSymbol & getWasmSymbol(const DataRefImpl &Symb) const
uint64_t getSectionAddress(DataRefImpl Sec) const override
Expected< uint64_t > getSymbolAddress(DataRefImpl Symb) const override
uint32_t getNumImportedGlobals() const
Definition: Wasm.h:155
bool isSectionData(DataRefImpl Sec) const override
uint32_t getNumSections() const
Definition: Wasm.h:159
Expected< StringRef > getSectionName(DataRefImpl Sec) const override
bool isValidSectionOrder(unsigned ID, StringRef CustomSectionName="")
static int DisallowedPredecessors[WASM_NUM_SEC_ORDERS][WASM_NUM_SEC_ORDERS]
Definition: Wasm.h:350
bool isTypeFunction() const
Definition: Wasm.h:49
unsigned getBinding() const
Definition: Wasm.h:85
LLVM_DUMP_METHOD void dump() const
bool isTypeData() const
Definition: Wasm.h:55
bool isTypeTable() const
Definition: Wasm.h:53
const wasm::WasmSymbolInfo & Info
Definition: Wasm.h:44
bool isBindingWeak() const
Definition: Wasm.h:73
bool isTypeSection() const
Definition: Wasm.h:61
bool isHidden() const
Definition: Wasm.h:89
bool isBindingGlobal() const
Definition: Wasm.h:77
unsigned getVisibility() const
Definition: Wasm.h:93
bool isUndefined() const
Definition: Wasm.h:69
const wasm::WasmGlobalType * GlobalType
Definition: Wasm.h:45
WasmSymbol(const wasm::WasmSymbolInfo &Info, const wasm::WasmGlobalType *GlobalType, const wasm::WasmTableType *TableType, const wasm::WasmSignature *Signature)
Definition: Wasm.h:37
void print(raw_ostream &Out) const
const wasm::WasmTableType * TableType
Definition: Wasm.h:46
bool isTypeTag() const
Definition: Wasm.h:65
bool isBindingLocal() const
Definition: Wasm.h:81
bool isTypeGlobal() const
Definition: Wasm.h:57
const wasm::WasmSignature * Signature
Definition: Wasm.h:47
bool isDefined() const
Definition: Wasm.h:67
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
const unsigned WASM_SYMBOL_UNDEFINED
Definition: Wasm.h:410
const unsigned WASM_SYMBOL_BINDING_GLOBAL
Definition: Wasm.h:405
const unsigned WASM_SYMBOL_BINDING_WEAK
Definition: Wasm.h:406
const unsigned WASM_SYMBOL_BINDING_LOCAL
Definition: Wasm.h:407
@ WASM_SYMBOL_TYPE_GLOBAL
Definition: Wasm.h:386
@ WASM_SYMBOL_TYPE_DATA
Definition: Wasm.h:385
@ WASM_SYMBOL_TYPE_TAG
Definition: Wasm.h:388
@ WASM_SYMBOL_TYPE_TABLE
Definition: Wasm.h:389
@ WASM_SYMBOL_TYPE_SECTION
Definition: Wasm.h:387
@ WASM_SYMBOL_TYPE_FUNCTION
Definition: Wasm.h:384
const unsigned WASM_SYMBOL_BINDING_MASK
Definition: Wasm.h:402
const unsigned WASM_SYMBOL_VISIBILITY_MASK
Definition: Wasm.h:403
const unsigned WASM_SYMBOL_VISIBILITY_HIDDEN
Definition: Wasm.h:409
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
@ Ref
The access may reference the value stored in memory.
raw_ostream & operator<<(raw_ostream &OS, const APFixedPoint &FX)
Definition: APFixedPoint.h:292
ArrayRef< uint8_t > Content
Definition: Wasm.h:111
std::vector< wasm::WasmRelocation > Relocations
Definition: Wasm.h:112
std::optional< uint8_t > HeaderSecSizeEncodingLen
Definition: Wasm.h:114
wasm::WasmDataSegment Data
Definition: Wasm.h:119
uint32_t SectionOffset
Definition: Wasm.h:118