Enum SystemEvent 

#[repr(u8)]
pub enum SystemEvent {
    MerkleNodeMerge = 0,
    MerkleNodeToStack = 1,
    MapValueToStack = 2,
    MapValueCountToStack = 3,
    MapValueToStackN0 = 4,
    MapValueToStackN4 = 5,
    MapValueToStackN8 = 6,
    HasMapKey = 7,
    Ext2Inv = 8,
    U32Clz = 9,
    U32Ctz = 10,
    U32Clo = 11,
    U32Cto = 12,
    ILog2 = 13,
    MemToMap = 14,
    HdwordToMap = 15,
    HdwordToMapWithDomain = 16,
    HqwordToMap = 17,
    HpermToMap = 18,
    DeferredRegister = 19,
    DeferredEvaluate = 20,
    DeferredEvaluateTag = 21,
    DeferredEvaluatePayload = 22,
    DeferredRegisterData = 23,
    TraceEvent = 24,
}

Defines a set of host-side actions which can be initiated from the VM.

Most actions update or query one of the three advice-provider components: Merkle store, advice stack, or advice map. Deferred-DAG actions update host-side deferred state, and evaluation may also push canonical node data to the advice stack.

All actions, except for MerkleNodeMerge, Ext2Inv and UpdateMerkleNode can be invoked directly from Miden assembly via dedicated instructions.

System event IDs are derived from blake3-hashing their names (prefixed with “sys::”).

The enum variant order matches the indices in SYSTEM_EVENT_LOOKUP, allowing efficient const lookup via to_event_id(). The discriminants are implicitly 0, 1, 2, … COUNT - 1.

Variants

MerkleNodeMerge = 0

Creates a new Merkle tree in the advice provider by combining Merkle trees with the specified roots. The root of the new tree is defined as Hash(LEFT_ROOT, RIGHT_ROOT).

Inputs: Operand stack: [LEFT_ROOT, RIGHT_ROOT, …] Merkle store: {LEFT_ROOT, RIGHT_ROOT}

Outputs: Operand stack: [LEFT_ROOT, RIGHT_ROOT, …] Merkle store: {LEFT_ROOT, RIGHT_ROOT, hash(LEFT_ROOT, RIGHT_ROOT)}

After the operation, both the original trees and the new tree remains in the advice provider (i.e., the input trees are not removed).

MerkleNodeToStack = 1

Pushes a node of the Merkle tree specified by the values on the top of the operand stack onto the advice stack in structural order for consumption by AdvPopW.

Inputs: Operand stack: [depth, index, TREE_ROOT, …] Advice stack: […] Merkle store: {TREE_ROOT<-NODE}

Outputs: Operand stack: [depth, index, TREE_ROOT, …] Advice stack: [NODE, …] Merkle store: {TREE_ROOT<-NODE}

MapValueToStack = 2

Pushes a list of field elements onto the advice stack. The list is looked up in the advice map using the specified word from the operand stack as the key.

Inputs: Operand stack: [KEY, …] Advice stack: […] Advice map: {KEY: values}

Outputs: Operand stack: [KEY, …] Advice stack: [values, …] Advice map: {KEY: values}

MapValueCountToStack = 3

Pushes the number of elements in a list of field elements onto the advice stack. The list is looked up in the advice map using the specified word from the operand stack as the key.

Inputs: Operand stack: [KEY, …] Advice stack: […] Advice map: {KEY: values}

Outputs: Operand stack: [KEY, …] Advice stack: [values.len(), …] Advice map: {KEY: values}

MapValueToStackN0 = 4

Pushes a list of field elements onto the advice stack, along with the number of elements in that list. The list is looked up in the advice map using the word at the top of the operand stack as the key.

Notice that the resulting elements list is not padded.

Inputs: Operand stack: [KEY, …] Advice stack: […] Advice map: {KEY: values}

Outputs: Operand stack: [KEY, …] Advice stack: [num_values, values, …] Advice map: {KEY: values}

MapValueToStackN4 = 5

Pushes a padded list of field elements onto the advice stack, along with the number of elements in that list. The list is looked up in the advice map using the word at the top of the operand stack as the key.

Notice that the elements list obtained from the advice map will be padded with zeros, increasing its length to the next multiple of 4.

Inputs: Operand stack: [KEY, …] Advice stack: […] Advice map: {KEY: values}

Outputs: Operand stack: [KEY, …] Advice stack: [num_values, values, padding, …] Advice map: {KEY: values}

MapValueToStackN8 = 6

Pushes a padded list of field elements onto the advice stack, along with the number of elements in that list. The list is looked up in the advice map using the word at the top of the operand stack as the key.

Notice that the elements list obtained from the advice map will be padded with zeros, increasing its length to the next multiple of 8.

Inputs: Operand stack: [KEY, …] Advice stack: […] Advice map: {KEY: values}

Outputs: Operand stack: [KEY, …] Advice stack: [num_values, values, padding, …] Advice map: {KEY: values}

HasMapKey = 7

Pushes a flag onto the advice stack whether advice map has an entry with specified key.

If the advice map has the entry with the key equal to the key placed at the top of the operand stack, 1 will be pushed to the advice stack and 0 otherwise.

Inputs: Operand stack: [KEY, …] Advice stack: […]

Outputs: Operand stack: [KEY, …] Advice stack: [has_mapkey, …]

Ext2Inv = 8

Given an element in a quadratic extension field on the top of the stack (i.e., a0, b1), computes its multiplicative inverse and push the result onto the advice stack.

Inputs: Operand stack: [a1, a0, …] Advice stack: […]

Outputs: Operand stack: [a1, a0, …] Advice stack: [b0, b1…]

Where (b0, b1) is the multiplicative inverse of the extension field element (a0, a1) at the top of the stack.

U32Clz = 9

Pushes the number of the leading zeros of the top stack element onto the advice stack.

Inputs: Operand stack: [n, …] Advice stack: […]

Outputs: Operand stack: [n, …] Advice stack: [leading_zeros, …]

U32Ctz = 10

Pushes the number of the trailing zeros of the top stack element onto the advice stack.

Inputs: Operand stack: [n, …] Advice stack: […]

Outputs: Operand stack: [n, …] Advice stack: [trailing_zeros, …]

U32Clo = 11

Pushes the number of the leading ones of the top stack element onto the advice stack.

Inputs: Operand stack: [n, …] Advice stack: […]

Outputs: Operand stack: [n, …] Advice stack: [leading_ones, …]

U32Cto = 12

Pushes the number of the trailing ones of the top stack element onto the advice stack.

Inputs: Operand stack: [n, …] Advice stack: […]

Outputs: Operand stack: [n, …] Advice stack: [trailing_ones, …]

ILog2 = 13

Pushes the base 2 logarithm of the top stack element, rounded down. Inputs: Operand stack: [n, …] Advice stack: […]

Outputs: Operand stack: [n, …] Advice stack: [ilog2(n), …]

MemToMap = 14

Reads words from memory at the specified range and inserts them into the advice map under the key KEY located at the top of the stack.

Inputs: Operand stack: [KEY, start_addr, end_addr, …] Advice map: {…}

Outputs: Operand stack: [KEY, start_addr, end_addr, …] Advice map: {KEY: values}

Where values are the elements located in memory[start_addr..end_addr].

HdwordToMap = 15

Reads two word from the operand stack and inserts them into the advice map under the key defined by the hash of these words.

Inputs: Operand stack: [A, B, …] Advice map: {…}

Outputs: Operand stack: [A, B, …] Advice map: {KEY: [a0, a1, a2, a3, b0, b1, b2, b3]}

Where KEY is computed as hash(A || B, domain=0).

HdwordToMapWithDomain = 16

Reads two words from the operand stack and inserts them into the advice map under the key defined by the hash of these words (using d as the domain).

Inputs: Operand stack: [A, B, d, …] Advice map: {…}

Outputs: Operand stack: [A, B, d, …] Advice map: {KEY: [a0, a1, a2, a3, b0, b1, b2, b3]}

Where KEY is computed as hash(A || B, d).

HqwordToMap = 17

Reads four words from the operand stack and inserts them into the advice map under the key defined by the hash of these words.

Inputs: Operand stack: [A, B, C, D, …] Advice map: {…}

Outputs: Operand stack: [A, B, C, D, …] Advice map: {KEY: [A, B, C, D]} (16 elements)

Where:

• KEY is computed as hash_elements([A, B, C, D]) using the sponge construction (sequential absorption; two rounds for four words).

HpermToMap = 18

Reads three words from the operand stack and inserts the top two words into the advice map under the key defined by applying a Poseidon2 permutation to all three words.

Inputs: Operand stack: [A, B, C, …] Advice map: {…}

Outputs: Operand stack: [A, B, C, …] Advice map: {KEY: [a0, a1, a2, a3, b0, b1, b2, b3]}

Where KEY is computed by extracting the digest elements from hperm([C, A, B]). For example, if C is [0, d, 0, 0], KEY will be set as hash(A || B, d).

DeferredRegister = 19

Registers and eagerly evaluates a deferred node whose full payload is on the operand stack.

TAG is one word (4 field elements). PAYLOAD_LO || PAYLOAD_HI is eight field elements: either one crate::deferred::DataChunk, two child digests (lhs || rhs) for a join, or one lhs || rhs pair for a pair-list node. Exact crate::deferred::Tag::CHUNKS ([2, 0, 0, 0]) is framework-owned opaque data; malformed id-2 tags are rejected during tag decode. The installed registry decodes TAG via crate::deferred::DeferredState::decode; TRUE is not accepted by this event. Tags that semantically require more data chunks or pairs are rejected during precompile-specific evaluation. Registration is performed by crate::deferred::DeferredState::register, so semantic failures surface immediately.

This event does not push advice or return the node digest. The stack arguments are visible in the VM execution trace, but the host-side registration is not constrained by the event. Assembly code that later relies on the digest must compute it inside the VM from the same TAG and payload.

Inputs: Operand stack: [event_id, PAYLOAD_LO, PAYLOAD_HI, TAG, …]

Outputs: Operand stack: unchanged Advice stack: unchanged Deferred state: node registered and semantically evaluated

DeferredEvaluate = 20

Evaluates a registered deferred node and pushes its canonical tag and payload as advice.

NODE_DIGEST is one word (4 field elements) and must already be registered in deferred state. The handler evaluates it with crate::deferred::DeferredState::evaluate_digest, fetches the canonical node, and pushes its tag followed by its payload to the advice stack.

The tag is emitted first in advice-pop order so adv_pushw adv_pushw adv_pushw leaves [PAYLOAD_LO, PAYLOAD_HI, TAG, ...] on the operand stack for a single 8-felt payload. Data payloads push two words per 8-felt chunk in advice order HIGH, LOW, preserving canonical chunk order. Join payloads use the same two-word LIFO convention, leaving [lhs, rhs, TAG, ...]. TRUE pushes only Tag::TRUE. These felts are unbound host hints. Before proof-relevant use, assembly code must relate them with VM instructions to values established independently of that advice.

Inputs: Operand stack: [event_id, NODE_DIGEST, …]

Outputs: Operand stack: unchanged Advice stack: canonical tag, then canonical payload words for adv_pushw LIFO consumption

DeferredEvaluateTag = 21

Evaluates a registered deferred node and pushes only its canonical tag as advice.

NODE_DIGEST is one word (4 field elements) and must already be registered in deferred state. TRUE pushes Tag::TRUE. The returned tag is an unbound host hint; before proof-relevant use, assembly code must relate it with VM instructions to a value established independently of that advice.

Inputs: Operand stack: [event_id, NODE_DIGEST, …]

Outputs: Operand stack: unchanged Advice stack: canonical tag only

DeferredEvaluatePayload = 22

Evaluates a registered deferred node and pushes only its canonical payload as advice.

This is the payload-only compatibility event. Data payloads push two words per 8-felt chunk in advice order HIGH, LOW so adv_pushw adv_pushw leaves [LOW, HIGH, ...] on the operand stack for that chunk. Chunks are emitted in canonical chunk order. Join payloads use the same two-word LIFO convention, leaving [lhs, rhs, ...] after two adv_pushws. TRUE pushes no advice. These felts are unbound host hints. Before proof-relevant use, assembly code must relate them with VM instructions to values established independently of that advice.

Inputs: Operand stack: [event_id, NODE_DIGEST, …]

Outputs: Operand stack: unchanged Advice stack: canonical payload only, word-ordered for adv_pushw LIFO consumption

DeferredRegisterData = 23

Registers and eagerly evaluates a memory-backed deferred node.

TAG is one word (4 field elements), and the installed registry decodes it to determine the memory-backed payload shape. The stack-supplied ptr and n_chunks are visible in the VM execution trace and select the range [ptr, ptr + 8 * n_chunks). The host reads n_chunks 8-felt crate::deferred::DataChunk values from that range, but this event adds no AIR constraint tying the registered contents to those memory cells.

Exact crate::deferred::Tag::CHUNKS ([2, 0, 0, 0]) registers the chunks as framework-owned opaque data, while other data tags remain precompile-owned. Malformed id-2 tags are rejected during tag decode. Pair-list tags interpret chunks as lhs || rhs pairs. Join tags require n_chunks == 1 and interpret the single chunk as lhs || rhs. TRUE is not accepted. The handler performs a cheap budget pre-check before allocating or reading memory, then delegates registration to crate::deferred::DeferredState::register.

This event does not push advice or return the node digest. A program that relies on the registered node must compute its digest with VM instructions from the same TAG and ordered chunk sequence. The register_mem MASM wrapper does this by applying a Poseidon2 linear hash to the same range, with one absorption per chunk and TAG as the initial capacity word. If the event and the VM hash different chunk sequences, the VM-computed digest does not identify the host-registered node and cannot bind that registration into a proof-relevant deferred claim.

Inputs: Operand stack: [event_id, TAG, ptr, n_chunks, …]

Outputs: Operand stack: unchanged Advice stack: unchanged Deferred state: node registered and semantically evaluated

TraceEvent = 24

Signals an optional, read-only trace event to the host.

When emit observes this system event ID at stack position 0, the VM forwards the user trace event ID at stack position 1 to the host’s trace handler. This is typically emitted as push.<user_trace_id> push.<sys::trace_event> emit. Trace handlers can observe the processor state, but cannot mutate VM state or the advice provider. If no handler is registered for the user trace event ID, the event is a no-op.

Hosts are expected to not raise an error if they encounter a user_trace_id for which no trace handler is registered.

Inputs: Operand stack: [sys::trace_event, user_trace_id, …]

Outputs: Operand stack: unchanged Advice provider: unchanged

Implementations

impl SystemEvent

pub const fn from_event_id(event_id: EventId) -> Option<Self>

Attempts to convert an EventId into a SystemEvent by looking it up in the const table.

Returns Some(SystemEvent) if the ID matches a known system event, None otherwise. This uses a const lookup table with hardcoded EventIds, avoiding runtime hash computation.

pub const fn from_name(name: &str) -> Option<Self>

Attempts to convert a name into a SystemEvent by looking it up in the const table.

Returns Some(SystemEvent) if the name matches a known system event, None otherwise. This uses const string comparison against the lookup table.

pub const fn event_name(&self) -> EventName

Returns the human-readable name of this system event as an EventName.

System event names are prefixed with sys:: to distinguish them from user-defined events.

pub const fn event_id(&self) -> EventId

Returns the EventId for this system event.

The ID is looked up from the const LOOKUP table using the enum’s discriminant as the index. The discriminants are explicitly set to match the array indices.

pub const fn all() -> [Self; 25]

Returns an array of all system event variants.

impl SystemEvent

pub const COUNT: usize = 25

The total number of system events.

Trait Implementations

impl Clone for SystemEvent

fn clone(&self) -> SystemEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SystemEvent

impl Debug for SystemEvent

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

Formats the value using the given formatter.

impl Display for SystemEvent

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

Formats the value using the given formatter.

impl Eq for SystemEvent

impl From<SystemEvent> for EventName

fn from(system_event: SystemEvent) -> Self

Converts to this type from the input type.

impl PartialEq for SystemEvent

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

Equality operator ==.

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

Inequality operator !=.

impl PrettyPrint for SystemEvent

fn render(&self) -> Document

The core of the PrettyPrint functionality.

fn to_pretty_string(&self) -> String

Produce a String containing the results of pretty-printing this object.

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

Pretty-print this object to the given core::fmt::Formatter.

impl StructuralPartialEq for SystemEvent