Enum sp1_core::runtime::SyscallCode

pub enum SyscallCode {
    HALT = 0,
    WRITE = 2,
    ENTER_UNCONSTRAINED = 3,
    EXIT_UNCONSTRAINED = 4,
    SHA_EXTEND = 3_145_989,
    SHA_COMPRESS = 65_798,
    ED_ADD = 65_799,
    ED_DECOMPRESS = 264,
    KECCAK_PERMUTE = 65_801,
    SECP256K1_ADD = 65_802,
    SECP256K1_DOUBLE = 267,
    SECP256K1_DECOMPRESS = 268,
    BN254_ADD = 65_806,
    BN254_DOUBLE = 271,
    COMMIT = 16,
    COMMIT_DEFERRED_PROOFS = 26,
    VERIFY_SP1_PROOF = 27,
    BLS12381_DECOMPRESS = 284,
    HINT_LEN = 240,
    HINT_READ = 241,
    UINT256_MUL = 65_821,
    BLS12381_ADD = 65_822,
    BLS12381_DOUBLE = 287,
}

A system call is invoked by the the ecall instruction with a specific value in register t0. The syscall number is a 32-bit integer, with the following layout (in litte-endian format)

• The first byte is the syscall id.
• The second byte is 0/1 depending on whether the syscall has a separate table. This is used in the CPU table to determine whether to lookup the syscall using the syscall interaction.
• The third byte is the number of additional cycles the syscall uses.

Variants

HALT = 0

Halts the program.

WRITE = 2

Write to the output buffer.

ENTER_UNCONSTRAINED = 3

Enter unconstrained block.

EXIT_UNCONSTRAINED = 4

Exit unconstrained block.

SHA_EXTEND = 3_145_989

Executes the SHA_EXTEND precompile.

SHA_COMPRESS = 65_798

Executes the SHA_COMPRESS precompile.

ED_ADD = 65_799

Executes the ED_ADD precompile.

ED_DECOMPRESS = 264

Executes the ED_DECOMPRESS precompile.

KECCAK_PERMUTE = 65_801

Executes the KECCAK_PERMUTE precompile.

SECP256K1_ADD = 65_802

Executes the SECP256K1_ADD precompile.

SECP256K1_DOUBLE = 267

Executes the SECP256K1_DOUBLE precompile.

SECP256K1_DECOMPRESS = 268

Executes the SECP256K1_DECOMPRESS precompile.

BN254_ADD = 65_806

Executes the BN254_ADD precompile.

BN254_DOUBLE = 271

Executes the BN254_DOUBLE precompile.

COMMIT = 16

Executes the COMMIT precompile.

COMMIT_DEFERRED_PROOFS = 26

Executes the COMMIT_DEFERRED_PROOFS precompile.

VERIFY_SP1_PROOF = 27

Executes the VERIFY_SP1_PROOF precompile.

BLS12381_DECOMPRESS = 284

Executes the BLS12381_DECOMPRESS precompile.

HINT_LEN = 240

Executes the HINT_LEN precompile.

HINT_READ = 241

Executes the HINT_READ precompile.

UINT256_MUL = 65_821

Executes the UINT256_MUL precompile.

BLS12381_ADD = 65_822

Executes the BLS12381_ADD precompile.

BLS12381_DOUBLE = 287

Executes the BLS12381_DOUBLE precompile.

Implementations

impl SyscallCode

pub fn from_u32(value: u32) -> Self

Create a syscall from a u32.

pub fn syscall_id(&self) -> u32

pub fn should_send(&self) -> u32

pub fn num_cycles(&self) -> u32

Trait Implementations

impl Clone for SyscallCode

fn clone(&self) -> SyscallCode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SyscallCode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SyscallCode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SyscallCode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for SyscallCode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoEnumIterator for SyscallCode

type Iterator = SyscallCodeIter

fn iter() -> SyscallCodeIter

impl Ord for SyscallCode

fn cmp(&self, other: &SyscallCode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for SyscallCode

fn eq(&self, other: &SyscallCode) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SyscallCode

fn partial_cmp(&self, other: &SyscallCode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SyscallCode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for SyscallCode

impl Eq for SyscallCode

impl StructuralPartialEq for SyscallCode