Documentation
¶
Overview ¶
Package wasmer is a Go library to run WebAssembly binaries.
Index ¶
- Constants
- func GetLastError() (string, error)
- func SetImports(imports *Imports) error
- func SetOpcodeCosts(opcode_costs *[OPCODE_COUNT]uint32)
- type ExportedFunctionCallback
- type ExportedFunctionError
- type ExportsMap
- type Import
- type ImportedFunctionError
- type Imports
- type Instance
- func (instance *Instance) Clean()
- func (instance *Instance) GetBreakpointValue() uint64
- func (instance *Instance) GetPointsUsed() uint64
- func (instance *Instance) HasMemory() bool
- func (instance *Instance) SetBreakpointValue(value uint64)
- func (instance *Instance) SetContextData(data unsafe.Pointer)
- func (instance *Instance) SetPointsUsed(points uint64)
- type InstanceContext
- type InstanceError
- type Memory
- type MemoryError
- type Value
- type ValueType
Constants ¶
const ( OpcodeUnreachable = iota OpcodeNop OpcodeBlock OpcodeLoop OpcodeIf OpcodeElse OpcodeEnd OpcodeBr OpcodeBrIf OpcodeBrTable OpcodeReturn OpcodeCall OpcodeCallIndirect OpcodeDrop OpcodeSelect OpcodeGetLocal OpcodeSetLocal OpcodeTeeLocal OpcodeGetGlobal OpcodeSetGlobal OpcodeI32Load OpcodeI64Load OpcodeF32Load OpcodeF64Load OpcodeI32Load8S OpcodeI32Load8U OpcodeI32Load16S OpcodeI32Load16U OpcodeI64Load8S OpcodeI64Load8U OpcodeI64Load16S OpcodeI64Load16U OpcodeI64Load32S OpcodeI64Load32U OpcodeI32Store OpcodeI64Store OpcodeF32Store OpcodeF64Store OpcodeI32Store8 OpcodeI32Store16 OpcodeI64Store8 OpcodeI64Store16 OpcodeI64Store32 OpcodeMemorySize OpcodeMemoryGrow OpcodeI32Const OpcodeI64Const OpcodeF32Const OpcodeF64Const OpcodeRefNull OpcodeRefIsNull OpcodeI32Eqz OpcodeI32Eq OpcodeI32Ne OpcodeI32LtS OpcodeI32LtU OpcodeI32GtS OpcodeI32GtU OpcodeI32LeS OpcodeI32LeU OpcodeI32GeS OpcodeI32GeU OpcodeI64Eqz OpcodeI64Eq OpcodeI64Ne OpcodeI64LtS OpcodeI64LtU OpcodeI64GtS OpcodeI64GtU OpcodeI64LeS OpcodeI64LeU OpcodeI64GeS OpcodeI64GeU OpcodeF32Eq OpcodeF32Ne OpcodeF32Lt OpcodeF32Gt OpcodeF32Le OpcodeF32Ge OpcodeF64Eq OpcodeF64Ne OpcodeF64Lt OpcodeF64Gt OpcodeF64Le OpcodeF64Ge OpcodeI32Clz OpcodeI32Ctz OpcodeI32Popcnt OpcodeI32Add OpcodeI32Sub OpcodeI32Mul OpcodeI32DivS OpcodeI32DivU OpcodeI32RemS OpcodeI32RemU OpcodeI32And OpcodeI32Or OpcodeI32Xor OpcodeI32Shl OpcodeI32ShrS OpcodeI32ShrU OpcodeI32Rotl OpcodeI32Rotr OpcodeI64Clz OpcodeI64Ctz OpcodeI64Popcnt OpcodeI64Add OpcodeI64Sub OpcodeI64Mul OpcodeI64DivS OpcodeI64DivU OpcodeI64RemS OpcodeI64RemU OpcodeI64And OpcodeI64Or OpcodeI64Xor OpcodeI64Shl OpcodeI64ShrS OpcodeI64ShrU OpcodeI64Rotl OpcodeI64Rotr OpcodeF32Abs OpcodeF32Neg OpcodeF32Ceil OpcodeF32Floor OpcodeF32Trunc OpcodeF32Nearest OpcodeF32Sqrt OpcodeF32Add OpcodeF32Sub OpcodeF32Mul OpcodeF32Div OpcodeF32Min OpcodeF32Max OpcodeF32Copysign OpcodeF64Abs OpcodeF64Neg OpcodeF64Ceil OpcodeF64Floor OpcodeF64Trunc OpcodeF64Nearest OpcodeF64Sqrt OpcodeF64Add OpcodeF64Sub OpcodeF64Mul OpcodeF64Div OpcodeF64Min OpcodeF64Max OpcodeF64Copysign OpcodeI32WrapI64 OpcodeI32TruncSF32 OpcodeI32TruncUF32 OpcodeI32TruncSF64 OpcodeI32TruncUF64 OpcodeI64ExtendSI32 OpcodeI64ExtendUI32 OpcodeI64TruncSF32 OpcodeI64TruncUF32 OpcodeI64TruncSF64 OpcodeI64TruncUF64 OpcodeF32ConvertSI32 OpcodeF32ConvertUI32 OpcodeF32ConvertSI64 OpcodeF32ConvertUI64 OpcodeF32DemoteF64 OpcodeF64ConvertSI32 OpcodeF64ConvertUI32 OpcodeF64ConvertSI64 OpcodeF64ConvertUI64 OpcodeF64PromoteF32 OpcodeI32ReinterpretF32 OpcodeI64ReinterpretF64 OpcodeF32ReinterpretI32 OpcodeF64ReinterpretI64 OpcodeI32Extend8S OpcodeI32Extend16S OpcodeI64Extend8S OpcodeI64Extend16S OpcodeI64Extend32S OpcodeI32TruncSSatF32 OpcodeI32TruncUSatF32 OpcodeI32TruncSSatF64 OpcodeI32TruncUSatF64 OpcodeI64TruncSSatF32 OpcodeI64TruncUSatF32 OpcodeI64TruncSSatF64 OpcodeI64TruncUSatF64 OpcodeMemoryInit OpcodeDataDrop OpcodeMemoryCopy OpcodeMemoryFill OpcodeTableInit OpcodeElemDrop OpcodeTableCopy OpcodeTableGet OpcodeTableSet OpcodeTableGrow OpcodeTableSize OpcodeWake OpcodeI32Wait OpcodeI64Wait OpcodeFence OpcodeI32AtomicLoad OpcodeI64AtomicLoad OpcodeI32AtomicLoad8U OpcodeI32AtomicLoad16U OpcodeI64AtomicLoad8U OpcodeI64AtomicLoad16U OpcodeI64AtomicLoad32U OpcodeI32AtomicStore OpcodeI64AtomicStore OpcodeI32AtomicStore8 OpcodeI32AtomicStore16 OpcodeI64AtomicStore8 OpcodeI64AtomicStore16 OpcodeI64AtomicStore32 OpcodeI32AtomicRmwAdd OpcodeI64AtomicRmwAdd OpcodeI32AtomicRmw8UAdd OpcodeI32AtomicRmw16UAdd OpcodeI64AtomicRmw8UAdd OpcodeI64AtomicRmw16UAdd OpcodeI64AtomicRmw32UAdd OpcodeI32AtomicRmwSub OpcodeI64AtomicRmwSub OpcodeI32AtomicRmw8USub OpcodeI32AtomicRmw16USub OpcodeI64AtomicRmw8USub OpcodeI64AtomicRmw16USub OpcodeI64AtomicRmw32USub OpcodeI32AtomicRmwAnd OpcodeI64AtomicRmwAnd OpcodeI32AtomicRmw8UAnd OpcodeI32AtomicRmw16UAnd OpcodeI64AtomicRmw8UAnd OpcodeI64AtomicRmw16UAnd OpcodeI64AtomicRmw32UAnd OpcodeI32AtomicRmwOr OpcodeI64AtomicRmwOr OpcodeI32AtomicRmw8UOr OpcodeI32AtomicRmw16UOr OpcodeI64AtomicRmw8UOr OpcodeI64AtomicRmw16UOr OpcodeI64AtomicRmw32UOr OpcodeI32AtomicRmwXor OpcodeI64AtomicRmwXor OpcodeI32AtomicRmw8UXor OpcodeI32AtomicRmw16UXor OpcodeI64AtomicRmw8UXor OpcodeI64AtomicRmw16UXor OpcodeI64AtomicRmw32UXor OpcodeI32AtomicRmwXchg OpcodeI64AtomicRmwXchg OpcodeI32AtomicRmw8UXchg OpcodeI32AtomicRmw16UXchg OpcodeI64AtomicRmw8UXchg OpcodeI64AtomicRmw16UXchg OpcodeI64AtomicRmw32UXchg OpcodeI32AtomicRmwCmpxchg OpcodeI64AtomicRmwCmpxchg OpcodeI32AtomicRmw8UCmpxchg OpcodeI32AtomicRmw16UCmpxchg OpcodeI64AtomicRmw8UCmpxchg OpcodeI64AtomicRmw16UCmpxchg OpcodeI64AtomicRmw32UCmpxchg OpcodeV128Load OpcodeV128Store OpcodeV128Const OpcodeI8x16Splat OpcodeI8x16ExtractLaneS OpcodeI8x16ExtractLaneU OpcodeI8x16ReplaceLane OpcodeI16x8Splat OpcodeI16x8ExtractLaneS OpcodeI16x8ExtractLaneU OpcodeI16x8ReplaceLane OpcodeI32x4Splat OpcodeI32x4ExtractLane OpcodeI32x4ReplaceLane OpcodeI64x2Splat OpcodeI64x2ExtractLane OpcodeI64x2ReplaceLane OpcodeF32x4Splat OpcodeF32x4ExtractLane OpcodeF32x4ReplaceLane OpcodeF64x2Splat OpcodeF64x2ExtractLane OpcodeF64x2ReplaceLane OpcodeI8x16Eq OpcodeI8x16Ne OpcodeI8x16LtS OpcodeI8x16LtU OpcodeI8x16GtS OpcodeI8x16GtU OpcodeI8x16LeS OpcodeI8x16LeU OpcodeI8x16GeS OpcodeI8x16GeU OpcodeI16x8Eq OpcodeI16x8Ne OpcodeI16x8LtS OpcodeI16x8LtU OpcodeI16x8GtS OpcodeI16x8GtU OpcodeI16x8LeS OpcodeI16x8LeU OpcodeI16x8GeS OpcodeI16x8GeU OpcodeI32x4Eq OpcodeI32x4Ne OpcodeI32x4LtS OpcodeI32x4LtU OpcodeI32x4GtS OpcodeI32x4GtU OpcodeI32x4LeS OpcodeI32x4LeU OpcodeI32x4GeS OpcodeI32x4GeU OpcodeF32x4Eq OpcodeF32x4Ne OpcodeF32x4Lt OpcodeF32x4Gt OpcodeF32x4Le OpcodeF32x4Ge OpcodeF64x2Eq OpcodeF64x2Ne OpcodeF64x2Lt OpcodeF64x2Gt OpcodeF64x2Le OpcodeF64x2Ge OpcodeV128Not OpcodeV128And OpcodeV128Or OpcodeV128Xor OpcodeV128Bitselect OpcodeI8x16Neg OpcodeI8x16AnyTrue OpcodeI8x16AllTrue OpcodeI8x16Shl OpcodeI8x16ShrS OpcodeI8x16ShrU OpcodeI8x16Add OpcodeI8x16AddSaturateS OpcodeI8x16AddSaturateU OpcodeI8x16Sub OpcodeI8x16SubSaturateS OpcodeI8x16SubSaturateU OpcodeI8x16Mul OpcodeI16x8Neg OpcodeI16x8AnyTrue OpcodeI16x8AllTrue OpcodeI16x8Shl OpcodeI16x8ShrS OpcodeI16x8ShrU OpcodeI16x8Add OpcodeI16x8AddSaturateS OpcodeI16x8AddSaturateU OpcodeI16x8Sub OpcodeI16x8SubSaturateS OpcodeI16x8SubSaturateU OpcodeI16x8Mul OpcodeI32x4Neg OpcodeI32x4AnyTrue OpcodeI32x4AllTrue OpcodeI32x4Shl OpcodeI32x4ShrS OpcodeI32x4ShrU OpcodeI32x4Add OpcodeI32x4Sub OpcodeI32x4Mul OpcodeI64x2Neg OpcodeI64x2AnyTrue OpcodeI64x2AllTrue OpcodeI64x2Shl OpcodeI64x2ShrS OpcodeI64x2ShrU OpcodeI64x2Add OpcodeI64x2Sub OpcodeF32x4Abs OpcodeF32x4Neg OpcodeF32x4Sqrt OpcodeF32x4Add OpcodeF32x4Sub OpcodeF32x4Mul OpcodeF32x4Div OpcodeF32x4Min OpcodeF32x4Max OpcodeF64x2Abs OpcodeF64x2Neg OpcodeF64x2Sqrt OpcodeF64x2Add OpcodeF64x2Sub OpcodeF64x2Mul OpcodeF64x2Div OpcodeF64x2Min OpcodeF64x2Max OpcodeI32x4TruncSF32x4Sat OpcodeI32x4TruncUF32x4Sat OpcodeI64x2TruncSF64x2Sat OpcodeI64x2TruncUF64x2Sat OpcodeF32x4ConvertSI32x4 OpcodeF32x4ConvertUI32x4 OpcodeF64x2ConvertSI64x2 OpcodeF64x2ConvertUI64x2 OpcodeV8x16Swizzle OpcodeV8x16Shuffle OpcodeI8x16LoadSplat OpcodeI16x8LoadSplat OpcodeI32x4LoadSplat OpcodeI64x2LoadSplat )
const OPCODE_COUNT = 410
Variables ¶
This section is empty.
Functions ¶
func GetLastError ¶
GetLastError returns the last error message if any, otherwise returns an error.
func SetImports ¶
func SetOpcodeCosts ¶
func SetOpcodeCosts(opcode_costs *[OPCODE_COUNT]uint32)
Types ¶
type ExportedFunctionError ¶
type ExportedFunctionError struct {
// contains filtered or unexported fields
}
ExportedFunctionError represents any kind of errors related to a WebAssembly exported function. It is returned by `Instance` functions only.
func NewExportedFunctionError ¶
func NewExportedFunctionError(functionName string, message string) *ExportedFunctionError
NewExportedFunctionError constructs a new `ExportedFunctionError`, where `functionName` is the name of the exported function, and `message` is the error message. If the error message contains `%s`, then this parameter will be replaced by `functionName`.
func (*ExportedFunctionError) Error ¶
func (error *ExportedFunctionError) Error() string
ExportedFunctionError is an actual error. The `Error` function returns the error message.
type ExportsMap ¶
type ExportsMap map[string]ExportedFunctionCallback
type Import ¶
type Import struct {
// contains filtered or unexported fields
}
Import represents an WebAssembly instance imported function.
type ImportedFunctionError ¶
type ImportedFunctionError struct {
// contains filtered or unexported fields
}
ImportedFunctionError represents any kind of errors related to a WebAssembly imported function. It is returned by `Import` or `Imports` functions only.
func NewImportedFunctionError ¶
func NewImportedFunctionError(functionName string, message string) *ImportedFunctionError
NewImportedFunctionError constructs a new `ImportedFunctionError`, where `functionName` is the name of the imported function, and `message` is the error message. If the error message contains `%s`, then this parameter will be replaced by `functionName`.
func (*ImportedFunctionError) Error ¶
func (error *ImportedFunctionError) Error() string
ImportedFunctionError is an actual error. The `Error` function returns the error message.
type Imports ¶
type Imports struct {
// contains filtered or unexported fields
}
Imports represents a set of imported functions for a WebAssembly instance.
func (*Imports) Append ¶
func (imports *Imports) Append(importName string, implementation interface{}, cgoPointer unsafe.Pointer) (*Imports, error)
Append adds a new imported function to the current set.
type Instance ¶
type Instance struct {
// All functions exported by the WebAssembly instance, indexed
// by their name as a string. An exported function is a
// regular variadic Go closure. Arguments are untyped. Since
// WebAssembly only supports: `i32`, `i64`, `f32` and `f64`
// types, the accepted Go types are: `int8`, `uint8`, `int16`,
// `uint16`, `int32`, `uint32`, `int64`, `int`, `uint`, `float32`
// and `float64`. In addition to those types, the `Value` type
// (from this project) is accepted. The conversion from a Go
// value to a WebAssembly value is done automatically except for
// the `Value` type (where type is coerced, that's the intent
// here). The WebAssembly type is automatically inferred. Note
// that the returned value is of kind `Value`, and not a
// standard Go type.
Exports ExportsMap
// The exported memory of a WebAssembly instance.
Memory *Memory
// contains filtered or unexported fields
}
Instance represents a WebAssembly instance.
func NewMeteredInstance ¶
func (*Instance) GetBreakpointValue ¶
func (*Instance) GetPointsUsed ¶
func (*Instance) HasMemory ¶
HasMemory checks whether the instance has at least one exported memory.
func (*Instance) SetBreakpointValue ¶
func (*Instance) SetContextData ¶
SetContextData assigns a data that can be used by all imported functions. Indeed, each imported function receives as its first argument an instance context (see `InstanceContext`). An instance context can hold a pointer to any kind of data. It is important to understand that this data is shared by all imported function, it's global to the instance.
func (*Instance) SetPointsUsed ¶
type InstanceContext ¶
type InstanceContext struct {
// contains filtered or unexported fields
}
InstanceContext represents a way to access instance API from within an imported context.
func IntoInstanceContext ¶
func IntoInstanceContext(instanceContext unsafe.Pointer) InstanceContext
IntoInstanceContext casts the first `context unsafe.Pointer` argument of an imported function into an `InstanceContext`.
func (*InstanceContext) Data ¶
func (instanceContext *InstanceContext) Data() unsafe.Pointer
Data returns the instance context data as an `unsafe.Pointer`. It's up to the user to cast it appropriately as a pointer to a data.
func (*InstanceContext) Memory ¶
func (instanceContext *InstanceContext) Memory() *Memory
Memory returns the current instance memory.
type InstanceError ¶
type InstanceError struct {
// contains filtered or unexported fields
}
InstanceError represents any kind of errors related to a WebAssembly instance. It is returned by `Instance` functions only.
func NewInstanceError ¶
func NewInstanceError(message string) *InstanceError
NewInstanceError constructs a new `InstanceError`.
func (*InstanceError) Error ¶
func (error *InstanceError) Error() string
`InstanceError` is an actual error. The `Error` function returns the error message.
type Memory ¶
type Memory struct {
// contains filtered or unexported fields
}
Memory represents an exported memory of a WebAssembly instance. To read and write data, please see the `Data` function.
type MemoryError ¶
type MemoryError struct {
// contains filtered or unexported fields
}
MemoryError represents any kind of errors related to a WebAssembly memory. It is returned by `Memory` functions only.
func NewMemoryError ¶
func NewMemoryError(message string) *MemoryError
NewMemoryError constructs a new `MemoryError`.
func (*MemoryError) Error ¶
func (error *MemoryError) Error() string
`MemoryError` is an actual error. The `Error` function returns the error message.
type Value ¶
type Value struct {
// contains filtered or unexported fields
}
Value represents a WebAssembly value of a particular type.
func (Value) ToF32 ¶
ToF32 reads the WebAssembly value bits as a `float32`. The WebAssembly value type is ignored.
func (Value) ToF64 ¶
ToF64 reads the WebAssembly value bits as a `float64`. The WebAssembly value type is ignored.
func (Value) ToI32 ¶
ToI32 reads the WebAssembly value bits as an `int32`. The WebAssembly value type is ignored.
type ValueType ¶
type ValueType int
ValueType represents the `Value` type.
const ( // TypeI32 represents the WebAssembly `i32` type. TypeI32 ValueType = iota // TypeI64 represents the WebAssembly `i64` type. TypeI64 // TypeF32 represents the WebAssembly `f32` type. TypeF32 // TypeF64 represents the WebAssembly `f64` type. TypeF64 // TypeVoid represents nothing. // WebAssembly doesn't have “void” type, but it is introduced // here to represent the returned value of a WebAssembly exported // function that returns nothing. TypeVoid )
Source Files