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.

Implements

Disposable

Index

Constructors

Properties

Methods

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

Constructors

constructor

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

Properties

tempArgs

tempArgs: Disposable[] = []

List of temporay arguments that can be disposed during reset.

Methods

allocByteArrayForString

allocByteArrayForString(data: string): number
Allocate a byte array for a string and return the offset of the byte array.
Parameters
- data: string
  The string to allocate.
Returns number
The offset of the byte array.
- Defined in memory.ts:446

allocPtrArray

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

allocRawBytes

allocRawBytes(nbytes: number): number
Allocate space by number of bytes
Parameters
- nbytes: number
  Number of bytes.
  
  Note: This function always allocate space that aligns to 64bit.
Returns number
- Defined in memory.ts:357

allocThenSetArgBytes

allocThenSetArgBytes(offset: number, data: Uint8Array): 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:478

allocThenSetArgString

allocThenSetArgString(offset: number, data: string): 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:465

commitToWasmMemory

commitToWasmMemory(nbytes?: number): 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:340

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:316

ptrFromOffset

ptrFromOffset(offset: number): 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:394

reset

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

Returns void
- Defined in memory.ts:325

storeF64

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

storeI32

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

storeI64

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

storePtr

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

storeRawBytes

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

storeU32

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

storeUSize

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