package wazevoapi

Import Path
	github.com/tetratelabs/wazero/internal/engine/wazevo/wazevoapi (on go.dev)

Dependency Relation
	imports 10 packages, and imported by 6 packages

Involved Source Files

	    debug_options.go
	    exitcode.go
	    offsetdata.go
	    perfmap.go
	    perfmap_disabled.go
	    pool.go
	    ptr.go
	    queue.go
	    resetmap.go
Package-Level Type Names (total 9)

	/* sort by: alphabet | popularity */
	 type ExitCode uint32 (basic type)
		ExitCode is an exit code of an execution of a function.

		Methods (only one)
			( ExitCode) String() string
				String implements fmt.Stringer.

		Implements (at least 2)
			 ExitCode : expvar.Var
			 ExitCode : fmt.Stringer
		As Outputs Of (at least 4)
			func ExitCodeCallGoFunctionWithIndex(index int, withListener bool) ExitCode
			func ExitCodeCallGoModuleFunctionWithIndex(index int, withListener bool) ExitCode
			func github.com/tetratelabs/wazero/internal/engine/wazevo/ssa.(*Instruction).ExitIfTrueWithCodeData() (ctx, c ssa.Value, code ExitCode)
			func github.com/tetratelabs/wazero/internal/engine/wazevo/ssa.(*Instruction).ExitWithCodeData() (ctx ssa.Value, code ExitCode)
		As Inputs Of (at least 4)
			func GoFunctionIndexFromExitCode(exitCode ExitCode) int
			func github.com/tetratelabs/wazero/internal/engine/wazevo/backend.Machine.CompileGoFunctionTrampoline(exitCode ExitCode, sig *ssa.Signature, needModuleContextPtr bool) []byte
			func github.com/tetratelabs/wazero/internal/engine/wazevo/ssa.(*Instruction).AsExitIfTrueWithCode(ctx, c ssa.Value, code ExitCode) *ssa.Instruction
			func github.com/tetratelabs/wazero/internal/engine/wazevo/ssa.(*Instruction).AsExitWithCode(ctx ssa.Value, code ExitCode)
		As Types Of (total 24)
			const ExitCodeCallGoFunction
			const ExitCodeCallGoFunctionWithListener
			const ExitCodeCallGoModuleFunction
			const ExitCodeCallGoModuleFunctionWithListener
			const ExitCodeCallListenerAfter
			const ExitCodeCallListenerBefore
			const ExitCodeCheckModuleExitCode
			const ExitCodeGrowMemory
			const ExitCodeGrowStack
			const ExitCodeIndirectCallNullPointer
			const ExitCodeIndirectCallTypeMismatch
			const ExitCodeIntegerDivisionByZero
			const ExitCodeIntegerOverflow
			const ExitCodeInvalidConversionToInteger
			const ExitCodeMemoryNotify
			const ExitCodeMemoryOutOfBounds
			const ExitCodeMemoryWait32
			const ExitCodeMemoryWait64
			const ExitCodeOK
			const ExitCodeRefFunc
			const ExitCodeTableGrow
			const ExitCodeTableOutOfBounds
			const ExitCodeUnalignedAtomic
			const ExitCodeUnreachable

	 type IDedPool[T] (struct)

		Type Parameters:
			T: any

		IDedPool is a pool of T that can be allocated and reset, with a way to get T by an ID.

		Methods (total 4)
			(*IDedPool[T]) Get(id int) *T
				Get returns the T with the given id, or nil if it's not allocated.

			(*IDedPool[T]) GetOrAllocate(id int) *T
				GetOrAllocate returns the T with the given id.

			(*IDedPool[T]) MaxIDEncountered() int
				MaxIDEncountered returns the maximum id encountered so far.

			(*IDedPool[T]) Reset()
				Reset resets the pool.

		As Outputs Of (at least one exported)
			func NewIDedPool[T](resetFn func(*T)) IDedPool[T]

	 type ModuleContextOffsetData (struct)
		ModuleContextOffsetData allows the compilers to get the information about offsets to the fields of wazevo.moduleContextOpaque,
		This is unique per module.

		Fields (total 12)
			AfterListenerTrampolines1stElement Offset
			BeforeListenerTrampolines1stElement Offset
			DataInstances1stElement Offset
			ElementInstances1stElement Offset
			GlobalsBegin Offset
			ImportedFunctionsBegin Offset
			ImportedMemoryBegin Offset
			LocalMemoryBegin Offset
			ModuleInstanceOffset Offset
			TablesBegin Offset
			TotalSize int
			TypeIDs1stElement Offset
		Methods (total 5)
			(*ModuleContextOffsetData) GlobalInstanceOffset(i wasm.Index) Offset
				GlobalInstanceOffset returns an offset of the i-th global instance.

			(*ModuleContextOffsetData) ImportedFunctionOffset(i wasm.Index) (executableOffset, moduleCtxOffset, typeIDOffset Offset)
				ImportedFunctionOffset returns an offset of the i-th imported function.
				Each item is stored as wazevo.functionInstance whose size matches FunctionInstanceSize.

			(*ModuleContextOffsetData) LocalMemoryBase() Offset
				LocalMemoryBase returns an offset of the first byte of the local memory.

			(*ModuleContextOffsetData) LocalMemoryLen() Offset
				LocalMemoryLen returns an offset of the length of the local memory buffer.

			(*ModuleContextOffsetData) TableOffset(tableIndex int) Offset
				TableOffset returns an offset of the i-th table instance.

		As Outputs Of (at least one exported)
			func NewModuleContextOffsetData(m *wasm.Module, withListener bool) ModuleContextOffsetData
		As Inputs Of (at least one exported)
			func github.com/tetratelabs/wazero/internal/engine/wazevo/frontend.NewFrontendCompiler(m *wasm.Module, ssaBuilder ssa.Builder, offset *ModuleContextOffsetData, ensureTermination bool, listenerOn bool, sourceInfo bool) *frontend.Compiler

	 type Offset int32 (basic type)
		Offset represents an offset of a field of a struct.

		Methods (total 3)
			( Offset) I64() int64
				I64 encodes an Offset as int64 for convenience.

			( Offset) U32() uint32
				U32 encodes an Offset as uint32 for convenience.

			( Offset) U64() uint64
				U64 encodes an Offset as int64 for convenience.

		As Outputs Of (at least 5)
			func (*ModuleContextOffsetData).GlobalInstanceOffset(i wasm.Index) Offset
			func (*ModuleContextOffsetData).ImportedFunctionOffset(i wasm.Index) (executableOffset, moduleCtxOffset, typeIDOffset Offset)
			func (*ModuleContextOffsetData).LocalMemoryBase() Offset
			func (*ModuleContextOffsetData).LocalMemoryLen() Offset
			func (*ModuleContextOffsetData).TableOffset(tableIndex int) Offset
		As Types Of (total 21)
			const ExecutionContextOffsetCallerModuleContextPtr
			const ExecutionContextOffsetCheckModuleExitCodeTrampolineAddress
			const ExecutionContextOffsetExitCodeOffset
			const ExecutionContextOffsetFramePointerBeforeGoCall
			const ExecutionContextOffsetGoCallReturnAddress
			const ExecutionContextOffsetGoFunctionCallCalleeModuleContextOpaque
			const ExecutionContextOffsetGoReturnAddress
			const ExecutionContextOffsetMemmoveAddress
			const ExecutionContextOffsetMemoryGrowTrampolineAddress
			const ExecutionContextOffsetMemoryNotifyTrampolineAddress
			const ExecutionContextOffsetMemoryWait32TrampolineAddress
			const ExecutionContextOffsetMemoryWait64TrampolineAddress
			const ExecutionContextOffsetOriginalFramePointer
			const ExecutionContextOffsetOriginalStackPointer
			const ExecutionContextOffsetRefFuncTrampolineAddress
			const ExecutionContextOffsetSavedRegistersBegin
			const ExecutionContextOffsetStackBottomPtr
			const ExecutionContextOffsetStackGrowCallTrampolineAddress
			const ExecutionContextOffsetStackGrowRequiredSize
			const ExecutionContextOffsetStackPointerBeforeGoCall
			const ExecutionContextOffsetTableGrowTrampolineAddress

	 type Perfmap (struct)
		Perfmap holds perfmap entries to be flushed into a perfmap file.

		Methods (total 6)
			(*Perfmap) AddEntry(addr uintptr, size uint64, name string)
				AddEntry writes a perfmap entry directly into the perfmap file, not using the entries.

			(*Perfmap) AddModuleEntry(index int, offset int64, size uint64, name string)
				AddModuleEntry adds a perfmap entry into the perfmap file.
				index is the index of the function in the module, offset is the offset of the function in the module,
				size is the size of the function, and name is the name of the function.
				
				Note that the entries are not flushed into the perfmap file until Flush is called,
				and the entries are module-scoped; Perfmap must be locked until Flush is called.

			(*Perfmap) Clear()
				Clear clears the perfmap entries not yet flushed.

			(*Perfmap) Flush(addr uintptr, functionOffsets []int)
				Flush writes the perfmap entries into the perfmap file where the entries are adjusted by the given `addr` and `functionOffsets`.

			(*Perfmap) Lock()
			(*Perfmap) Unlock()
		Implements (at least one exported)
			*Perfmap : sync.Locker
		As Types Of (only one)
			  var PerfMap *Perfmap

	 type Pool[T] (struct)

		Type Parameters:
			T: any

		Pool is a pool of T that can be allocated and reset.
		This is useful to avoid unnecessary allocations.

		Methods (total 4)
			(*Pool[T]) Allocate() *T
				Allocate allocates a new T from the pool.

			(*Pool[T]) Allocated() int
				Allocated returns the number of allocated T currently in the pool.

			(*Pool[T]) Reset()
				Reset resets the pool.

			(*Pool[T]) View(i int) *T
				View returns the pointer to i-th item from the pool.

		As Outputs Of (at least one exported)
			func NewPool[T](resetFn func(*T)) Pool[T]

	 type Queue[T] (struct)

		Type Parameters:
			T: any

		Queue is the resettable queue where the underlying slice is reused.

		Fields (only one)
			Data []T
		Methods (total 4)
			(*Queue[T]) Dequeue() (ret T)
			(*Queue[T]) Empty() bool
			(*Queue[T]) Enqueue(v T)
			(*Queue[T]) Reset()

	 type VarLength[T] (struct)

		Type Parameters:
			T: any

		VarLength is a variable length array that can be reused via a pool.

		Methods (total 3)
			( VarLength[T]) Append(p *VarLengthPool[T], items ...T) VarLength[T]
				Append appends items to the backing slice just like the `append` builtin function in Go.

			( VarLength[T]) Cut(n int)
				Cut cuts the backing slice to the given length.
				Precondition: n <= len(i.backing).

			( VarLength[T]) View() []T
				View returns the backing slice.

		As Outputs Of (at least 3)
			func NewNilVarLength[T]() VarLength[T]
			func VarLength[T].Append(p *VarLengthPool[T], items ...T) VarLength[T]
			func (*VarLengthPool)[T].Allocate(knownMin int) VarLength[T]
		As Inputs Of (at least one exported)
			func github.com/tetratelabs/wazero/internal/engine/wazevo/ssa.(*Instruction).AsReturn(vs VarLength[ssa.Value]) *ssa.Instruction
		As Types Of (only one)
			  var github.com/tetratelabs/wazero/internal/engine/wazevo/ssa.ValuesNil wazevoapi.VarLength[...]

	 type VarLengthPool[T] (struct)

		Type Parameters:
			T: any

		VarLengthPool is a pool of VarLength[T] that can be allocated and reset.

		Methods (total 2)
			(*VarLengthPool[T]) Allocate(knownMin int) VarLength[T]
				Allocate allocates a new VarLength[T] from the pool.

			(*VarLengthPool[T]) Reset()
				Reset resets the pool.

		As Outputs Of (at least 2)
			func NewVarLengthPool[T]() VarLengthPool[T]
			func github.com/tetratelabs/wazero/internal/engine/wazevo/ssa.Builder[T].VarLengthPool() *VarLengthPool[ssa.Value]
		As Inputs Of (at least one exported)
			func VarLength[T].Append(p *VarLengthPool[T], items ...T) VarLength[T]


Package-Level Functions (total 19)

	 func CheckStackGuardPage(s []byte)
		CheckStackGuardPage checks the given stack guard page is not corrupted.

	 func DeterministicCompilationVerifierGetRandomizedLocalFunctionIndex(ctx context.Context, index int) int
		DeterministicCompilationVerifierGetRandomizedLocalFunctionIndex returns the randomized index for the given `index`
		which is assigned by DeterministicCompilationVerifierRandomizeIndexes.

	 func DeterministicCompilationVerifierRandomizeIndexes(ctx context.Context)
		DeterministicCompilationVerifierRandomizeIndexes randomizes the indexes for the deterministic compilation verifier.
		To get the randomized index, use DeterministicCompilationVerifierGetRandomizedLocalFunctionIndex.

	 func ExitCodeCallGoFunctionWithIndex(index int, withListener bool) ExitCode
	 func ExitCodeCallGoModuleFunctionWithIndex(index int, withListener bool) ExitCode
	 func GetCurrentFunctionIndex(ctx context.Context) int
		GetCurrentFunctionIndex returns the current function index.

	 func GetCurrentFunctionName(ctx context.Context) string
		GetCurrentFunctionName returns the current function name.

	 func GoFunctionIndexFromExitCode(exitCode ExitCode) int
	 func NewDeterministicCompilationVerifierContext(ctx context.Context, localFunctions int) context.Context
		NewDeterministicCompilationVerifierContext creates a new context with the deterministic compilation verifier used per wasm.Module.

	 func NewIDedPool[T](resetFn func(*T)) IDedPool[T]

		Type Parameters:
			T: any

		NewIDedPool returns a new IDedPool.

	 func NewModuleContextOffsetData(m *wasm.Module, withListener bool) ModuleContextOffsetData
		NewModuleContextOffsetData creates a ModuleContextOffsetData determining the structure of moduleContextOpaque for the given Module.
		The structure is described in the comment of wazevo.moduleContextOpaque.

	 func NewNilVarLength[T]() VarLength[T]

		Type Parameters:
			T: any

		NewNilVarLength returns a new VarLength[T] with a nil backing.

	 func NewPool[T](resetFn func(*T)) Pool[T]

		Type Parameters:
			T: any

		NewPool returns a new Pool.
		resetFn is called when a new T is allocated in Pool.Allocate.

	 func NewVarLengthPool[T]() VarLengthPool[T]

		Type Parameters:
			T: any

		NewVarLengthPool returns a new VarLengthPool.

	 func PrintEnabledIndex(ctx context.Context) bool
		PrintEnabledIndex returns true if the current function index is the print target.

	 func PtrFromUintptr[T](ptr uintptr) *T

		Type Parameters:
			T: any

		PtrFromUintptr resurrects the original *T from the given uintptr.
		The caller of this function MUST be sure that ptr is valid.

	 func ResetMap[K, V](m map[K]V) map[K]V

		Type Parameters:
			K: comparable
			V: any

		ResetMap resets the map to an empty state, or creates a new map if it is nil.

	 func SetCurrentFunctionName(ctx context.Context, index int, functionName string) context.Context
		SetCurrentFunctionName sets the current function name to the given `functionName`.

	 func VerifyOrSetDeterministicCompilationContextValue(ctx context.Context, scope string, newValue string)
		VerifyOrSetDeterministicCompilationContextValue verifies that the `newValue` is the same as the previous value for the given `scope`
		and the current function name. If the previous value doesn't exist, it sets the value to the given `newValue`.
		
		If the verification fails, this prints the diff and exits the process.


Package-Level Variables (only one)

	  var PerfMap *Perfmap
Package-Level Constants (total 67)

	const DeterministicCompilationVerifierEnabled = false
		DeterministicCompilationVerifierEnabled enables the deterministic compilation verifier. This is disabled by default
		since the operation is expensive. But when in doubt, enable this to make sure the compilation is deterministic.

	const DeterministicCompilationVerifyingIter = 5
	const ExecutionContextOffsetCallerModuleContextPtr Offset = 8
		ExecutionContextOffsetCallerModuleContextPtr is an offset of `callerModuleContextPtr` field in wazevo.executionContext

	const ExecutionContextOffsetCheckModuleExitCodeTrampolineAddress Offset = 88
		ExecutionContextOffsetCheckModuleExitCodeTrampolineAddress is an offset of `checkModuleExitCodeTrampolineAddress` field in wazevo.executionContext.

	const ExecutionContextOffsetExitCodeOffset Offset = 0
		ExecutionContextOffsetExitCodeOffset is an offset of `exitCode` field in wazevo.executionContext

	const ExecutionContextOffsetFramePointerBeforeGoCall Offset = 1152
	const ExecutionContextOffsetGoCallReturnAddress Offset = 48
		ExecutionContextOffsetGoCallReturnAddress is an offset of `goCallReturnAddress` field in wazevo.executionContext

	const ExecutionContextOffsetGoFunctionCallCalleeModuleContextOpaque Offset = 1120
		ExecutionContextOffsetGoFunctionCallCalleeModuleContextOpaque is an offset of `goFunctionCallCalleeModuleContextOpaque` field in wazevo.executionContext

	const ExecutionContextOffsetGoReturnAddress Offset = 32
		ExecutionContextOffsetGoReturnAddress is an offset of `goReturnAddress` field in wazevo.executionContext

	const ExecutionContextOffsetMemmoveAddress Offset = 1144
	const ExecutionContextOffsetMemoryGrowTrampolineAddress Offset = 72
		ExecutionContextOffsetMemoryGrowTrampolineAddress is an offset of `memoryGrowTrampolineAddress` field in wazevo.executionContext

	const ExecutionContextOffsetMemoryNotifyTrampolineAddress Offset = 1176
	const ExecutionContextOffsetMemoryWait32TrampolineAddress Offset = 1160
	const ExecutionContextOffsetMemoryWait64TrampolineAddress Offset = 1168
	const ExecutionContextOffsetOriginalFramePointer Offset = 16
		ExecutionContextOffsetOriginalFramePointer is an offset of `originalFramePointer` field in wazevo.executionContext

	const ExecutionContextOffsetOriginalStackPointer Offset = 24
		ExecutionContextOffsetOriginalStackPointer is an offset of `originalStackPointer` field in wazevo.executionContext

	const ExecutionContextOffsetRefFuncTrampolineAddress Offset = 1136
		ExecutionContextOffsetRefFuncTrampolineAddress is an offset of `refFuncTrampolineAddress` field in wazevo.executionContext

	const ExecutionContextOffsetSavedRegistersBegin Offset = 96
		ExecutionContextOffsetSavedRegistersBegin is an offset of the first element of `savedRegisters` field in wazevo.executionContext

	const ExecutionContextOffsetStackBottomPtr Offset = 40
		ExecutionContextOffsetStackBottomPtr is an offset of `stackBottomPtr` field in wazevo.executionContext

	const ExecutionContextOffsetStackGrowCallTrampolineAddress Offset = 80
		ExecutionContextOffsetStackGrowCallTrampolineAddress is an offset of `stackGrowCallTrampolineAddress` field in wazevo.executionContext.

	const ExecutionContextOffsetStackGrowRequiredSize Offset = 64
		ExecutionContextOffsetStackGrowRequiredSize is an offset of `stackGrowRequiredSize` field in wazevo.executionContext

	const ExecutionContextOffsetStackPointerBeforeGoCall Offset = 56
		ExecutionContextOffsetStackPointerBeforeGoCall is an offset of `StackPointerBeforeGoCall` field in wazevo.executionContext

	const ExecutionContextOffsetTableGrowTrampolineAddress Offset = 1128
		ExecutionContextOffsetTableGrowTrampolineAddress is an offset of `tableGrowTrampolineAddress` field in wazevo.executionContext

	const ExitCodeCallGoFunction ExitCode = 6
		ExitCodeCallGoFunction is an exit code for a call to an api.GoFunction.

	const ExitCodeCallGoFunctionWithListener ExitCode = 17
	const ExitCodeCallGoModuleFunction ExitCode = 5
		ExitCodeCallGoModuleFunction is an exit code for a call to an api.GoModuleFunction.

	const ExitCodeCallGoModuleFunctionWithListener ExitCode = 16
	const ExitCodeCallListenerAfter ExitCode = 15
	const ExitCodeCallListenerBefore ExitCode = 14
	const ExitCodeCheckModuleExitCode ExitCode = 13
	const ExitCodeGrowMemory ExitCode = 2
	const ExitCodeGrowStack ExitCode = 1
	const ExitCodeIndirectCallNullPointer ExitCode = 8
	const ExitCodeIndirectCallTypeMismatch ExitCode = 9
	const ExitCodeIntegerDivisionByZero ExitCode = 10
	const ExitCodeIntegerOverflow ExitCode = 11
	const ExitCodeInvalidConversionToInteger ExitCode = 12
	const ExitCodeMask = 255
	const ExitCodeMemoryNotify ExitCode = 22
	const ExitCodeMemoryOutOfBounds ExitCode = 4
	const ExitCodeMemoryWait32 ExitCode = 20
	const ExitCodeMemoryWait64 ExitCode = 21
	const ExitCodeOK ExitCode = 0
	const ExitCodeRefFunc ExitCode = 19
	const ExitCodeTableGrow ExitCode = 18
	const ExitCodeTableOutOfBounds ExitCode = 7
	const ExitCodeUnalignedAtomic ExitCode = 23
	const ExitCodeUnreachable ExitCode = 3
	const FrontEndLoggingEnabled = false
	const FunctionInstanceExecutableOffset = 0
		FunctionInstanceExecutableOffset is an offset of `executable` field in wazevo.functionInstance

	const FunctionInstanceModuleContextOpaquePtrOffset = 8
		FunctionInstanceModuleContextOpaquePtrOffset is an offset of `moduleContextOpaquePtr` field in wazevo.functionInstance

	const FunctionInstanceSize = 24
		FunctionInstanceSize is the size of wazevo.functionInstance.

	const FunctionInstanceTypeIDOffset = 16
		FunctionInstanceTypeIDOffset is an offset of `typeID` field in wazevo.functionInstance

	const NeedFunctionNameInContext = false
		nolint

	const PerfMapEnabled = false
	const PrintFinalizedMachineCode = false
	const PrintMachineCodeHexPerFunction = false // nolint
	const PrintMachineCodeHexPerFunctionDisassemblable = false
		PrintMachineCodeHexPerFunctionDisassemblable prints the machine code while modifying the actual result
		to make it disassemblable. This is useful when debugging the final machine code. See the places where this is used for detail.
		When this is enabled, functions must not be called.

	const PrintOptimizedSSA = false
	const PrintRegisterAllocated = false
	const PrintSSA = false
	const PrintSSAToBackendIRLowering = false
	const RegAllocLoggingEnabled = false
	const SSALoggingEnabled = false
	const SSAValidationEnabled = false
		SSAValidationEnabled enables the SSA validation. This is disabled by default since the operation is expensive.

	const StackGuardCheckEnabled = false
		StackGuardCheckEnabled enables the stack guard check to ensure that our stack bounds check works correctly.

	const StackGuardCheckGuardPageSize = 8096
		----- Stack Guard Check -----

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.