LLVM 19.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:
44 }
45
46 // Symbol info as represented in the symbol's 'syminfo' entry of an object
47 // file's symbol table.
52
53 bool isTypeFunction() const {
55 }
56
58
59 bool isTypeData() const { return Info.Kind == wasm::WASM_SYMBOL_TYPE_DATA; }
60
61 bool isTypeGlobal() const {
63 }
64
65 bool isTypeSection() const {
67 }
68
69 bool isTypeTag() const { return Info.Kind == wasm::WASM_SYMBOL_TYPE_TAG; }
70
71 bool isDefined() const { return !isUndefined(); }
72
73 bool isUndefined() const {
75 }
76
77 bool isBindingWeak() const {
79 }
80
81 bool isBindingGlobal() const {
83 }
84
85 bool isBindingLocal() const {
87 }
88
89 unsigned getBinding() const {
91 }
92
93 bool isHidden() const {
95 }
96
97 unsigned getVisibility() const {
99 }
100
101 void print(raw_ostream &Out) const;
102
103#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
104 LLVM_DUMP_METHOD void dump() const;
105#endif
106};
107
109 WasmSection() = default;
110
112 uint32_t Offset = 0; // Offset within the file
113 StringRef Name; // Section name (User-defined sections only)
114 uint32_t Comdat = UINT32_MAX; // From the "comdat info" section
116 std::vector<wasm::WasmRelocation> Relocations;
117 // Length of the LEB encoding of the section header's size field
118 std::optional<uint8_t> HeaderSecSizeEncodingLen;
119};
120
124};
125
127
128public:
130
131 const wasm::WasmObjectHeader &getHeader() const;
132 const WasmSymbol &getWasmSymbol(const DataRefImpl &Symb) const;
133 const WasmSymbol &getWasmSymbol(const SymbolRef &Symbol) const;
134 const WasmSection &getWasmSection(const SectionRef &Section) const;
136
137 static bool classof(const Binary *v) { return v->isWasm(); }
138
139 const wasm::WasmDylinkInfo &dylinkInfo() const { return DylinkInfo; }
140 const wasm::WasmProducerInfo &getProducerInfo() const { return ProducerInfo; }
142 return TargetFeatures;
143 }
144 ArrayRef<wasm::WasmSignature> types() const { return Signatures; }
145 ArrayRef<wasm::WasmImport> imports() const { return Imports; }
146 ArrayRef<wasm::WasmTable> tables() const { return Tables; }
147 ArrayRef<wasm::WasmLimits> memories() const { return Memories; }
148 ArrayRef<wasm::WasmGlobal> globals() const { return Globals; }
149 ArrayRef<wasm::WasmTag> tags() const { return Tags; }
150 ArrayRef<wasm::WasmExport> exports() const { return Exports; }
151 const wasm::WasmLinkingData &linkingData() const { return LinkingData; }
152 uint32_t getNumberOfSymbols() const { return Symbols.size(); }
153 ArrayRef<wasm::WasmElemSegment> elements() const { return ElemSegments; }
154 ArrayRef<WasmSegment> dataSegments() const { return DataSegments; }
155 ArrayRef<wasm::WasmFunction> functions() const { return Functions; }
156 ArrayRef<wasm::WasmDebugName> debugNames() const { return DebugNames; }
157 uint32_t startFunction() const { return StartFunction; }
158 uint32_t getNumImportedGlobals() const { return NumImportedGlobals; }
159 uint32_t getNumImportedTables() const { return NumImportedTables; }
160 uint32_t getNumImportedFunctions() const { return NumImportedFunctions; }
161 uint32_t getNumImportedTags() const { return NumImportedTags; }
162 uint32_t getNumSections() const { return Sections.size(); }
163 void moveSymbolNext(DataRefImpl &Symb) const override;
164
165 Expected<uint32_t> getSymbolFlags(DataRefImpl Symb) const override;
166
167 basic_symbol_iterator symbol_begin() const override;
168
169 basic_symbol_iterator symbol_end() const override;
170 Expected<StringRef> getSymbolName(DataRefImpl Symb) const override;
171
172 bool is64Bit() const override { return false; }
173
176 uint64_t getSymbolValueImpl(DataRefImpl Symb) const override;
177 uint32_t getSymbolAlignment(DataRefImpl Symb) const override;
178 uint64_t getCommonSymbolSizeImpl(DataRefImpl Symb) const override;
183
184 // Overrides from SectionRef.
185 void moveSectionNext(DataRefImpl &Sec) const override;
187 uint64_t getSectionAddress(DataRefImpl Sec) const override;
188 uint64_t getSectionIndex(DataRefImpl Sec) const override;
189 uint64_t getSectionSize(DataRefImpl Sec) const override;
191 getSectionContents(DataRefImpl Sec) const override;
192 uint64_t getSectionAlignment(DataRefImpl Sec) const override;
193 bool isSectionCompressed(DataRefImpl Sec) const override;
194 bool isSectionText(DataRefImpl Sec) const override;
195 bool isSectionData(DataRefImpl Sec) const override;
196 bool isSectionBSS(DataRefImpl Sec) const override;
197 bool isSectionVirtual(DataRefImpl Sec) const override;
200
201 // Overrides from RelocationRef.
202 void moveRelocationNext(DataRefImpl &Rel) const override;
203 uint64_t getRelocationOffset(DataRefImpl Rel) const override;
205 uint64_t getRelocationType(DataRefImpl Rel) const override;
207 SmallVectorImpl<char> &Result) const override;
208
209 section_iterator section_begin() const override;
210 section_iterator section_end() const override;
211 uint8_t getBytesInAddress() const override;
212 StringRef getFileFormatName() const override;
213 Triple::ArchType getArch() const override;
215 bool isRelocatableObject() const override;
216 bool isSharedObject() const;
217 bool hasUnmodeledTypes() const { return HasUnmodeledTypes; }
218
219 struct ReadContext {
220 const uint8_t *Start;
221 const uint8_t *Ptr;
222 const uint8_t *End;
223 };
224
225private:
226 bool isValidFunctionIndex(uint32_t Index) const;
227 bool isDefinedFunctionIndex(uint32_t Index) const;
228 bool isValidGlobalIndex(uint32_t Index) const;
229 bool isValidTableNumber(uint32_t Index) const;
230 bool isDefinedGlobalIndex(uint32_t Index) const;
231 bool isDefinedTableNumber(uint32_t Index) const;
232 bool isValidTagIndex(uint32_t Index) const;
233 bool isDefinedTagIndex(uint32_t Index) const;
234 bool isValidFunctionSymbol(uint32_t Index) const;
235 bool isValidTableSymbol(uint32_t Index) const;
236 bool isValidGlobalSymbol(uint32_t Index) const;
237 bool isValidTagSymbol(uint32_t Index) const;
238 bool isValidDataSymbol(uint32_t Index) const;
239 bool isValidSectionSymbol(uint32_t Index) const;
240 wasm::WasmFunction &getDefinedFunction(uint32_t Index);
241 const wasm::WasmFunction &getDefinedFunction(uint32_t Index) const;
242 const wasm::WasmGlobal &getDefinedGlobal(uint32_t Index) const;
243 wasm::WasmTag &getDefinedTag(uint32_t Index);
244
247 uint32_t getSymbolSectionIdImpl(const WasmSymbol &Symb) const;
248
249 Error parseSection(WasmSection &Sec);
250 Error parseCustomSection(WasmSection &Sec, ReadContext &Ctx);
251
252 // Standard section types
253 Error parseTypeSection(ReadContext &Ctx);
254 Error parseImportSection(ReadContext &Ctx);
255 Error parseFunctionSection(ReadContext &Ctx);
256 Error parseTableSection(ReadContext &Ctx);
257 Error parseMemorySection(ReadContext &Ctx);
258 Error parseTagSection(ReadContext &Ctx);
259 Error parseGlobalSection(ReadContext &Ctx);
260 Error parseExportSection(ReadContext &Ctx);
261 Error parseStartSection(ReadContext &Ctx);
262 Error parseElemSection(ReadContext &Ctx);
263 Error parseCodeSection(ReadContext &Ctx);
264 Error parseDataSection(ReadContext &Ctx);
265 Error parseDataCountSection(ReadContext &Ctx);
266
267 // Custom section types
268 Error parseDylinkSection(ReadContext &Ctx);
269 Error parseDylink0Section(ReadContext &Ctx);
270 Error parseNameSection(ReadContext &Ctx);
271 Error parseLinkingSection(ReadContext &Ctx);
272 Error parseLinkingSectionSymtab(ReadContext &Ctx);
273 Error parseLinkingSectionComdat(ReadContext &Ctx);
274 Error parseProducersSection(ReadContext &Ctx);
275 Error parseTargetFeaturesSection(ReadContext &Ctx);
276 Error parseRelocSection(StringRef Name, ReadContext &Ctx);
277
279 std::vector<WasmSection> Sections;
280 wasm::WasmDylinkInfo DylinkInfo;
281 wasm::WasmProducerInfo ProducerInfo;
282 std::vector<wasm::WasmFeatureEntry> TargetFeatures;
283 std::vector<wasm::WasmSignature> Signatures;
284 std::vector<wasm::WasmTable> Tables;
285 std::vector<wasm::WasmLimits> Memories;
286 std::vector<wasm::WasmGlobal> Globals;
287 std::vector<wasm::WasmTag> Tags;
288 std::vector<wasm::WasmImport> Imports;
289 std::vector<wasm::WasmExport> Exports;
290 std::vector<wasm::WasmElemSegment> ElemSegments;
291 std::vector<WasmSegment> DataSegments;
292 std::optional<size_t> DataCount;
293 std::vector<wasm::WasmFunction> Functions;
294 std::vector<WasmSymbol> Symbols;
295 std::vector<wasm::WasmDebugName> DebugNames;
296 uint32_t StartFunction = -1;
297 bool HasLinkingSection = false;
298 bool HasDylinkSection = false;
299 bool HasMemory64 = false;
300 bool HasUnmodeledTypes = false;
301 wasm::WasmLinkingData LinkingData;
302 uint32_t NumImportedGlobals = 0;
303 uint32_t NumImportedTables = 0;
304 uint32_t NumImportedFunctions = 0;
305 uint32_t NumImportedTags = 0;
306 uint32_t CodeSection = 0;
307 uint32_t DataSection = 0;
308 uint32_t TagSection = 0;
309 uint32_t GlobalSection = 0;
310 uint32_t TableSection = 0;
311};
312
314public:
315 // We define orders for all core wasm sections and known custom sections.
316 enum : int {
317 // Sentinel, must be zero
319
320 // Core sections
334
335 // Custom sections
336 // "dylink" should be the very first section in the module
338 // "linking" section requires DATA section in order to validate data symbols
340 // Must come after "linking" section in order to validate reloc indexes.
342 // "name" section must appear after DATA. Comes after "linking" to allow
343 // symbol table to set default function name.
345 // "producers" section must appear after "name" section.
347 // "target_features" section must appear after producers section
349
350 // Must be last
352
353 };
354
355 // Sections that may or may not be present, but cannot be predecessors
357
358 bool isValidSectionOrder(unsigned ID, StringRef CustomSectionName = "");
359
360private:
361 bool Seen[WASM_NUM_SEC_ORDERS] = {}; // Sections that have been seen already
362
363 // Returns -1 for unknown sections.
364 int getSectionOrder(unsigned ID, StringRef CustomSectionName = "");
365};
366
367} // end namespace object
368
370 Sym.print(OS);
371 return OS;
372}
373
374} // end namespace llvm
375
376#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:537
std::string Name
Symbol * Sym
Definition: ELF_riscv.cpp:479
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
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:481
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
Definition: SmallVector.h:586
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:144
uint64_t getWasmSymbolValue(const WasmSymbol &Sym) const
uint64_t getSymbolValueImpl(DataRefImpl Symb) const override
ArrayRef< wasm::WasmElemSegment > elements() const
Definition: Wasm.h:153
bool isSectionText(DataRefImpl Sec) const override
const wasm::WasmProducerInfo & getProducerInfo() const
Definition: Wasm.h:140
bool isSectionBSS(DataRefImpl Sec) const override
basic_symbol_iterator symbol_end() const override
bool hasUnmodeledTypes() const
Definition: Wasm.h:217
uint32_t startFunction() const
Definition: Wasm.h:157
Expected< uint32_t > getSymbolFlags(DataRefImpl Symb) const override
section_iterator section_begin() const override
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:152
ArrayRef< wasm::WasmLimits > memories() const
Definition: Wasm.h:147
bool is64Bit() const override
Definition: Wasm.h:172
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:150
uint32_t getNumImportedTags() const
Definition: Wasm.h:161
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:145
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:149
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:156
uint64_t getSectionSize(DataRefImpl Sec) const override
const wasm::WasmLinkingData & linkingData() const
Definition: Wasm.h:151
Triple::ArchType getArch() const override
ArrayRef< wasm::WasmFeatureEntry > getTargetFeatures() const
Definition: Wasm.h:141
uint64_t getRelocationType(DataRefImpl Rel) const override
uint32_t getNumImportedTables() const
Definition: Wasm.h:159
const WasmSection & getWasmSection(const SectionRef &Section) const
static bool classof(const Binary *v)
Definition: Wasm.h:137
ArrayRef< wasm::WasmGlobal > globals() const
Definition: Wasm.h:148
Expected< section_iterator > getSymbolSection(DataRefImpl Symb) const override
ArrayRef< wasm::WasmTable > tables() const
Definition: Wasm.h:146
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:160
ArrayRef< WasmSegment > dataSegments() const
Definition: Wasm.h:154
const wasm::WasmRelocation & getWasmRelocation(const RelocationRef &Ref) const
uint32_t getSymbolSize(SymbolRef Sym) const
const wasm::WasmDylinkInfo & dylinkInfo() const
Definition: Wasm.h:139
ArrayRef< wasm::WasmFunction > functions() const
Definition: Wasm.h:155
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:158
bool isSectionData(DataRefImpl Sec) const override
uint32_t getNumSections() const
Definition: Wasm.h:162
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:356
bool isTypeFunction() const
Definition: Wasm.h:53
unsigned getBinding() const
Definition: Wasm.h:89
LLVM_DUMP_METHOD void dump() const
bool isTypeData() const
Definition: Wasm.h:59
bool isTypeTable() const
Definition: Wasm.h:57
bool isBindingWeak() const
Definition: Wasm.h:77
bool isTypeSection() const
Definition: Wasm.h:65
bool isHidden() const
Definition: Wasm.h:93
bool isBindingGlobal() const
Definition: Wasm.h:81
unsigned getVisibility() const
Definition: Wasm.h:97
wasm::WasmSymbolInfo Info
Definition: Wasm.h:48
bool isUndefined() const
Definition: Wasm.h:73
const wasm::WasmGlobalType * GlobalType
Definition: Wasm.h:49
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:50
bool isTypeTag() const
Definition: Wasm.h:69
bool isBindingLocal() const
Definition: Wasm.h:85
bool isTypeGlobal() const
Definition: Wasm.h:61
const wasm::WasmSignature * Signature
Definition: Wasm.h:51
bool isDefined() const
Definition: Wasm.h:71
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:236
const unsigned WASM_SYMBOL_BINDING_GLOBAL
Definition: Wasm.h:231
const unsigned WASM_SYMBOL_BINDING_WEAK
Definition: Wasm.h:232
const unsigned WASM_SYMBOL_BINDING_LOCAL
Definition: Wasm.h:233
@ WASM_SYMBOL_TYPE_GLOBAL
Definition: Wasm.h:211
@ WASM_SYMBOL_TYPE_DATA
Definition: Wasm.h:210
@ WASM_SYMBOL_TYPE_TAG
Definition: Wasm.h:213
@ WASM_SYMBOL_TYPE_TABLE
Definition: Wasm.h:214
@ WASM_SYMBOL_TYPE_SECTION
Definition: Wasm.h:212
@ WASM_SYMBOL_TYPE_FUNCTION
Definition: Wasm.h:209
const unsigned WASM_SYMBOL_BINDING_MASK
Definition: Wasm.h:228
const unsigned WASM_SYMBOL_VISIBILITY_MASK
Definition: Wasm.h:229
const unsigned WASM_SYMBOL_VISIBILITY_HIDDEN
Definition: Wasm.h:235
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:293
ArrayRef< uint8_t > Content
Definition: Wasm.h:115
std::vector< wasm::WasmRelocation > Relocations
Definition: Wasm.h:116
std::optional< uint8_t > HeaderSecSizeEncodingLen
Definition: Wasm.h:118
wasm::WasmDataSegment Data
Definition: Wasm.h:123
uint32_t SectionOffset
Definition: Wasm.h:122
enum llvm::wasm::WasmSignature::@186 Kind