Class CachedCallStack

Auxiliary call stack for the FFI calls.

Lifecyle of a call stack.

Calls into allocXX to allocate space, mixed with storeXXX to store data.
Calls into ptrFromOffset, no further allocation(as ptrFromOffset can change), can still call into storeXX
Calls into commitToWasmMemory once.
reset.

Hierarchy

CachedCallStack

Implements

Disposable

Index

Constructors

Properties

Methods

allocPtrArray allocRawBytes allocThenSetArgBytes allocThenSetArgString commitToWasmMemory dispose ptrFromOffset reset storeF64 storeI32 storeI64 storePtr storeRawBytes storeU32 storeUSize

Constructors

constructor

new CachedCallStack(memory, allocSpace, freeSpace): CachedCallStack
Parameters
- memory: Memory
- allocSpace: FTVMWasmAllocSpace
- freeSpace: FTVMWasmFreeSpace
Returns CachedCallStack
- Defined in memory.ts:225

Properties

tempArgs

tempArgs: Disposable[] = []

List of temporay arguments that can be disposed during reset.

Methods

allocPtrArray

allocPtrArray(count): number
Allocate space for pointers.
Parameters
- count: number
  
  Number of pointers.
Returns number
The allocated pointer array.
- Defined in memory.ts:312

allocRawBytes

allocRawBytes(nbytes): number
Allocate space by number of bytes

Note
This function always allocate space that aligns to 64bit.
Parameters
- nbytes: number
  
  Number of bytes.
Returns number
- Defined in memory.ts:284

allocThenSetArgBytes

allocThenSetArgBytes(offset, data): void
Allocate then set the argument location with a TVMByteArray. Allocate new temporary space for bytes.
Parameters
- offset: number
  
  The offset to set ot data pointer.
- data: Uint8Array
  
  The string content.
Returns void
- Defined in memory.ts:390

allocThenSetArgString

allocThenSetArgString(offset, data): void
Allocate then set C-String pointer to the offset. This function will call into allocBytes to allocate necessary data. The address won't be set immediately(because the possible change of basePtr) and will be filled when we commit the data.
Parameters
- offset: number
  
  The offset to set ot data pointer.
- data: string
  
  The string content.
Returns void
- Defined in memory.ts:377

commitToWasmMemory

commitToWasmMemory(nbytes?): void
Commit all the cached data to WasmMemory. This function can only be called once. No further store function should be called.
Parameters
- nbytes: number = ...
  
  Number of bytes to be stored.
Returns void
- Defined in memory.ts:267

dispose

dispose(): void
Dispose the internal resource This function can be called multiple times, only the first call will take effect.

Returns void
Implementation of Disposable.dispose
- Defined in memory.ts:243

ptrFromOffset

ptrFromOffset(offset): number
Get the real pointer from offset values. Note that the returned value becomes obsolete if alloc is called on the stack.
Parameters
- offset: number
  
  The allocated offset.
Returns number
- Defined in memory.ts:321

reset

reset(): void
Rest the call stack so that it can be reused again.

Returns void
- Defined in memory.ts:252

storeF64

storeF64(offset, value): void
Parameters
- offset: number
- value: number
Returns void
- Defined in memory.ts:360

storeI32

storeI32(offset, value): void
Parameters
- offset: number
- value: number
Returns void
- Defined in memory.ts:342

storeI64

storeI64(offset, value): void
Parameters
- offset: number
- value: number
Returns void
- Defined in memory.ts:350

storePtr

storePtr(offset, value): void
Parameters
- offset: number
- value: number
Returns void
- Defined in memory.ts:326

storeRawBytes

storeRawBytes(offset, bytes): void
Parameters
- offset: number
- bytes: Uint8Array
Returns void
- Defined in memory.ts:364

storeU32

storeU32(offset, value): void
Parameters
- offset: number
- value: number
Returns void
- Defined in memory.ts:346

storeUSize

storeUSize(offset, value): void
Parameters
- offset: number
- value: number
Returns void
- Defined in memory.ts:334

Generated using TypeDoc