Module syscall Copy item path Source bigint ecall halt keccak_mode nr reg_abi BigIntBlobHeader Return Returned registers (a0, a1) from a syscall invocation. SyscallName A UTF-8 NUL-terminated name of a syscall with static lifetime. Syscall DIGEST_BYTES DIGEST_WORDS IO_CHUNK_WORDS Number of words in each cycle received using the SOFTWARE ecall KECCACK_STATE_BYTES KECCACK_STATE_DWORDS KECCACK_STATE_WORDS MAX_BUF_BYTES MAX_BUF_WORDS MAX_SHA_COMPRESS_BLOCKS sys_alloc_aligned ⚠ export-syscalls and non-target_os="zkvm"Safety sys_alloc_words Deprecated sys_argc Retrieves the count of arguments provided to program execution. sys_argv ⚠ Retrieves the argument with arg_index, and stores as much
of it as it can it in the memory at [out_words, out_words +
out_nwords). sys_bigint ⚠ Safety sys_bigint2_1 ⚠ Invoke a bigint2 program. sys_bigint2_2 ⚠ Invoke a bigint2 program. sys_bigint2_3 ⚠ Invoke a bigint2 program. sys_bigint2_4 ⚠ Invoke a bigint2 program. sys_bigint2_5 ⚠ Invoke a bigint2 program. sys_bigint2_6 ⚠ Invoke a bigint2 program. sys_cycle_count sys_exit export-syscallssys_exit() causes normal process termination.sys_fork export-syscallssys_fork() creates a new process by duplicating the calling process. The
new process is referred to as the child process. The calling process is
referred to as the parent process.sys_getenv ⚠ Retrieves the value of an environment variable, and stores as much
of it as it can it in the memory at [out_words, out_words +
out_nwords). sys_halt Safety sys_input sys_keccak ⚠ Permute the keccak state on the host sys_log ⚠ Safety sys_panic ⚠ Safety sys_pause ⚠ Safety sys_pipe ⚠ export-syscallssys_pipe() creates a pipe, a unidirectional data channel that can be used
for interprocess communication. The pointer pipefd is used to return two
file descriptors referring to the ends of the pipe. pipefd[0] refers to
the read end of the pipe. pipefd[1] refers to the write end of the pipe.
Data written to the write end of the pipe is buffered by the host until it
is read from the read end of the pipe.sys_poseidon2 ⚠ Safety sys_prove_keccak ⚠ Executes the keccak circuit, and then executes the lift predicate
in the recursion circuit. sys_rand ⚠ Safety sys_read ⚠ Reads the given number of bytes into the given buffer, posix-style. Returns
the number of bytes actually read. On end of file, returns 0. sys_read_words ⚠ Reads up to the given number of words into the buffer [recv_buf,
recv_buf + nwords). Returns the number of bytes actually read.
sys_read_words is a more efficient interface than sys_read, but
varies from POSIX semantics. Notably: sys_sha_buffer ⚠ Safety sys_sha_compress ⚠ Safety sys_verify_integrity ⚠ export-syscallsSend a ReceiptClaim digest to the host to request verification. sys_verify_integrity2 ⚠ export-syscallsTODO: Send a ReceiptClaim digest to the host to request verification. Meant for proofs that use union. sys_write ⚠ Safety syscall_0 ⚠ Deprecated Invoke a raw system call syscall_0_nr ⚠ Invoke a raw system call syscall_1 ⚠ Deprecated Invoke a raw system call syscall_2 ⚠ Deprecated Invoke a raw system call syscall_3 ⚠ Deprecated Invoke a raw system call syscall_4 ⚠ Deprecated Invoke a raw system call syscall_5 ⚠ Deprecated Invoke a raw system call syscall_1_nr ⚠ Invoke a raw system call syscall_2_nr ⚠ Invoke a raw system call syscall_3_nr ⚠ Invoke a raw system call syscall_4_nr ⚠ Invoke a raw system call syscall_5_nr ⚠ Invoke a raw system call