[#llvm-wasm]
= xref:llvm.adoc[llvm]::wasm
:relfileprefix: ../
:mrdocs:

Constants and structures for the WebAssembly binary object‐file format.

== Types

[cols="1,4"]
|===
| Name| Description
| xref:llvm/wasm/WasmCommonReference.adoc[`WasmCommonReference`] 
| Size and alignment for a common (unallocated) data symbol.
| xref:llvm/wasm/WasmDataReference.adoc[`WasmDataReference`] 
| Location of a Wasm data symbol within a WasmDataSegment.
| xref:llvm/wasm/WasmDataSegment.adoc[`WasmDataSegment`] 
| Data segment from the Wasm data section (plus linking metadata).
| xref:llvm/wasm/WasmDebugName.adoc[`WasmDebugName`] 
| Debug name entry from the custom "name" section.
| xref:llvm/wasm/WasmDylinkExportInfo.adoc[`WasmDylinkExportInfo`] 
| Export entry from the custom "dylink" section.
| xref:llvm/wasm/WasmDylinkImportInfo.adoc[`WasmDylinkImportInfo`] 
| Import entry from the custom "dylink" section.
| xref:llvm/wasm/WasmDylinkInfo.adoc[`WasmDylinkInfo`] 
| Contents of the custom "dylink" / "dylink.0" section.
| xref:llvm/wasm/WasmElemSegment.adoc[`WasmElemSegment`] 
| Wasm element segment, with some limitations compared the spec.
| xref:llvm/wasm/WasmExport.adoc[`WasmExport`] 
| Export entry from the Wasm export section.
| xref:llvm/wasm/WasmFeatureEntry.adoc[`WasmFeatureEntry`] 
| Feature requirement from the custom "target_features" section.
| xref:llvm/wasm/WasmFunction.adoc[`WasmFunction`] 
| Function definition from the Wasm function and code sections.
| xref:llvm/wasm/WasmGlobal.adoc[`WasmGlobal`] 
| Global definition from the Wasm global section.
| xref:llvm/wasm/WasmGlobalType.adoc[`WasmGlobalType`] 
| Type of a Wasm global (value type and mutability).
| xref:llvm/wasm/WasmImport.adoc[`WasmImport`] 
| Import entry from the Wasm import section.
| xref:llvm/wasm/WasmInitExpr.adoc[`WasmInitExpr`] 
| Initializer expression, including extended‐const and GC forms.
| xref:llvm/wasm/WasmInitExprMVP.adoc[`WasmInitExprMVP`] 
| MVP‐style initializer expression (single instruction plus operand).
| xref:llvm/wasm/WasmInitFunc.adoc[`WasmInitFunc`] 
| Constructor function listed in the linking init‐functions subsection.
| xref:llvm/wasm/WasmLimits.adoc[`WasmLimits`] 
| Minimum/maximum limits for a table or memory.
| xref:llvm/wasm/WasmLinkingData.adoc[`WasmLinkingData`] 
| Info from the linking metadata section of a wasm object file.
| xref:llvm/wasm/WasmLocalDecl.adoc[`WasmLocalDecl`] 
| Local variable declaration group within a function body.
| xref:llvm/wasm/WasmObjectHeader.adoc[`WasmObjectHeader`] 
| Header fields of a Wasm object file.
| xref:llvm/wasm/WasmProducerInfo.adoc[`WasmProducerInfo`] 
| Producer metadata from the custom "producers" section.
| xref:llvm/wasm/WasmRelocation.adoc[`WasmRelocation`] 
| Relocation entry applied to a Wasm section.
| xref:llvm/wasm/WasmSignature.adoc[`WasmSignature`] 
| Function or tag type signature from the Wasm type section.
| xref:llvm/wasm/WasmSymbolInfo.adoc[`WasmSymbolInfo`] 
| Symbol‐table entry from the custom "linking" section.
| xref:llvm/wasm/WasmTable.adoc[`WasmTable`] 
| Table definition from the Wasm table section.
| xref:llvm/wasm/WasmTableType.adoc[`WasmTableType`] 
| Type of a Wasm table (element type and limits).
| xref:llvm/wasm/WasmTag.adoc[`WasmTag`] 
| Tag definition from the Wasm tag section.
|===


== Enums

[cols="1,4"]
|===
| Name| Description
| xref:llvm/wasm/_04enum-0f.adoc[`Unnamed enum`] 
| Section id codes used in the Wasm binary format.
| xref:llvm/wasm/_04enum-0c.adoc[`Unnamed enum`] 
| Type immediate encodings used in various contexts.
| xref:llvm/wasm/_04enum-02a.adoc[`Unnamed enum`] 
| Memory ordering encodings for atomic instructions.
| xref:llvm/wasm/_04enum-04.adoc[`Unnamed enum`] 
| Kinds of externals (for imports and exports).
| xref:llvm/wasm/_04enum-026.adoc[`Unnamed enum`] 
| Opcodes used in initializer expressions.
| xref:llvm/wasm/_04enum-0be.adoc[`Unnamed enum`] 
| Opcodes in the GC‐prefixed space (0xfb).
| xref:llvm/wasm/_04enum-057.adoc[`Unnamed enum`] 
| Opcodes used in synthetic functions.
| xref:llvm/wasm/_04enum-0e.adoc[`Unnamed enum`] 
| Sub‐opcodes for catch clauses in a try_table instruction.
| xref:llvm/wasm/_04enum-033.adoc[`Unnamed enum`] 
| Flags describing table and memory limit encodings.
| xref:llvm/wasm/_04enum-030.adoc[`Unnamed enum`] 
| Flags for data segment encodings.
| xref:llvm/wasm/_04enum-052.adoc[`Unnamed enum`] 
| Flags for element segment encodings.
| xref:llvm/wasm/_04enum-025.adoc[`Unnamed enum`] 
| Feature policy prefixes used in the custom "target_features" section.
| xref:llvm/wasm/_04enum-0a7.adoc[`Unnamed enum`] 
| Kind codes used in the custom "name" section.
| xref:llvm/wasm/_04enum-0ab.adoc[`Unnamed enum`] 
| Kind codes used in the custom "linking" section.
| xref:llvm/wasm/_04enum-0af.adoc[`Unnamed enum`] 
| Kind codes used in the custom "dylink" section.
| xref:llvm/wasm/_04enum-0bf.adoc[`Unnamed enum`] 
| Kind codes used in the custom "linking" section in the WASM_COMDAT_INFO.
| xref:llvm/wasm/ElemSegmentMode.adoc[`ElemSegmentMode`] 
| Element segment modes encodable in the Wasm elem section.
| xref:llvm/wasm/NameType.adoc[`NameType`] 
| Kind of named entity recorded in Wasm debug/name metadata.
| xref:llvm/wasm/ValType.adoc[`ValType`] 
| Subset of types that a value can have.
| xref:llvm/wasm/WasmRelocType.adoc[`WasmRelocType`] 
| Relocation types used in Wasm object files.
| xref:llvm/wasm/WasmSegmentFlag.adoc[`WasmSegmentFlag`] 
| Flags for data segments in the linking metadata.
| xref:llvm/wasm/WasmSymbolType.adoc[`WasmSymbolType`] 
| Kind codes used in the custom "linking" section in the WASM_SYMBOL_TABLE.
| xref:llvm/wasm/WasmTagAttribute.adoc[`WasmTagAttribute`] 
| Kinds of tag attributes.
|===


== Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/wasm/relocTypeHasAddend.adoc[`relocTypeHasAddend`] 
| Return whether the given relocation type carries an addend.
| xref:llvm/wasm/relocTypetoString.adoc[`relocTypetoString`] 
| Return the name of a Wasm relocation type value.
| xref:llvm/wasm/sectionTypeToString.adoc[`sectionTypeToString`] 
| Return the name of a Wasm section type value.
| xref:llvm/wasm/toString.adoc[`toString`] 
| Return the name of a Wasm symbol type enumerator.
| xref:llvm/wasm/operator_eq-0cdf.adoc[`operator==`] 
| Equality operators
| xref:llvm/wasm/operator_not_eq-06e.adoc[`operator!=`] 
| Inequality operators
|===


== Variables

[cols="1,4"]
|===
| Name| Description
| xref:llvm/wasm/WASM_ELEM_SEGMENT_MASK_HAS_ELEM_DESC.adoc[`WASM_ELEM_SEGMENT_MASK_HAS_ELEM_DESC`] 
| Mask of element‐segment flags that imply an element type descriptor.
| xref:llvm/wasm/WASM_MEMARG_HAS_MEM_ORDER.adoc[`WASM_MEMARG_HAS_MEM_ORDER`] 
| Bit set in a memarg when an explicit memory ordering is present.
| xref:llvm/wasm/WASM_SYMBOL_ABSOLUTE.adoc[`WASM_SYMBOL_ABSOLUTE`] 
| Symbol has an absolute address.
| xref:llvm/wasm/WASM_SYMBOL_BINDING_COMMON.adoc[`WASM_SYMBOL_BINDING_COMMON`] 
| Symbol has common binding.
| xref:llvm/wasm/WASM_SYMBOL_BINDING_GLOBAL.adoc[`WASM_SYMBOL_BINDING_GLOBAL`] 
| Symbol has global (default) binding.
| xref:llvm/wasm/WASM_SYMBOL_BINDING_LOCAL.adoc[`WASM_SYMBOL_BINDING_LOCAL`] 
| Symbol has local binding.
| xref:llvm/wasm/WASM_SYMBOL_BINDING_MASK.adoc[`WASM_SYMBOL_BINDING_MASK`] 
| Bitmask selecting the binding bits of a Wasm symbol's flags.
| xref:llvm/wasm/WASM_SYMBOL_BINDING_WEAK.adoc[`WASM_SYMBOL_BINDING_WEAK`] 
| Symbol has weak binding.
| xref:llvm/wasm/WASM_SYMBOL_EXPLICIT_NAME.adoc[`WASM_SYMBOL_EXPLICIT_NAME`] 
| Symbol carries an explicitly recorded name.
| xref:llvm/wasm/WASM_SYMBOL_EXPORTED.adoc[`WASM_SYMBOL_EXPORTED`] 
| Symbol must be exported from the final module.
| xref:llvm/wasm/WASM_SYMBOL_NO_STRIP.adoc[`WASM_SYMBOL_NO_STRIP`] 
| Symbol must not be stripped by the linker.
| xref:llvm/wasm/WASM_SYMBOL_TLS.adoc[`WASM_SYMBOL_TLS`] 
| Symbol is thread‐local.
| xref:llvm/wasm/WASM_SYMBOL_UNDEFINED.adoc[`WASM_SYMBOL_UNDEFINED`] 
| Symbol is undefined (imported).
| xref:llvm/wasm/WASM_SYMBOL_VISIBILITY_DEFAULT.adoc[`WASM_SYMBOL_VISIBILITY_DEFAULT`] 
| Symbol has default visibility.
| xref:llvm/wasm/WASM_SYMBOL_VISIBILITY_HIDDEN.adoc[`WASM_SYMBOL_VISIBILITY_HIDDEN`] 
| Symbol has hidden visibility.
| xref:llvm/wasm/WASM_SYMBOL_VISIBILITY_MASK.adoc[`WASM_SYMBOL_VISIBILITY_MASK`] 
| Bitmask selecting the visibility bits of a Wasm symbol's flags.
| xref:llvm/wasm/WasmDefaultPageSize.adoc[`WasmDefaultPageSize`] 
| Default Wasm linear‐memory page size in bytes (65536).
| xref:llvm/wasm/WasmMagic.adoc[`WasmMagic`] 
| Object‐file magic string ("\0asm").
| xref:llvm/wasm/WasmMetadataVersion.adoc[`WasmMetadataVersion`] 
| Wasm linking metadata version number.
| xref:llvm/wasm/WasmVersion.adoc[`WasmVersion`] 
| Wasm binary format version number.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#