Struct FastProcessor

Source
pub struct FastProcessor { /* private fields */ }
Expand description

A fast processor which doesn’t generate any trace.

This processor is designed to be as fast as possible. Hence, it only keeps track of the current state of the processor (i.e. the stack, current clock cycle, current memory context, and free memory pointer).

§Stack Management

A few key points about how the stack was designed for maximum performance:

  • The stack has a fixed buffer size defined by STACK_BUFFER_SIZE.
    • This was observed to increase performance by at least 2x compared to using a Vec with push() & pop().
    • We track the stack top and bottom using indices stack_top_idx and stack_bot_idx, respectively.
  • Since we are using a fixed-size buffer, we need to ensure that stack buffer accesses are not out of bounds. Naively, we could check for this on every access. However, every operation alters the stack depth by a predetermined amount, allowing us to precisely determine the minimum number of operations required to reach a stack buffer boundary, whether at the top or bottom.
    • For example, if the stack top is 10 elements away from the top boundary, and the stack bottom is 15 elements away from the bottom boundary, then we can safely execute 10 operations that modify the stack depth with no bounds check.
  • When switching contexts (e.g., during a call or syscall), all elements past the first 16 are stored in an ExecutionContextInfo struct, and the stack is truncated to 16 elements. This will be restored when returning from the call or syscall.

§Clock Cycle Management

  • The clock cycle (clk) is managed in the same way as in Process. That is, it is incremented by 1 for every row that Process adds to the main trace.
    • It is important to do so because the clock cycle is used to determine the context ID for new execution contexts when using call or dyncall.
  • When executing a basic block, the clock cycle is not incremented for every individual operation for performance reasons.
    • Rather, we use clk + operation_index to determine the clock cycle when needed.
    • However this performance improvement is slightly offset by the need to parse operation batches exactly the same as Process. We will be able to recover the performance loss by redesigning the BasicBlockNode.

Implementations§

Source§

impl FastProcessor

Source

pub fn arithmetic_circuit_eval( &mut self, op_idx: usize, ) -> Result<(), ExecutionError>

Checks that the evaluation of an arithmetic circuit is equal to zero.

The inputs are composed of:

  1. a pointer to the memory region containing the arithmetic circuit description, which itself is arranged as:

    a. Read section:

    1. Inputs to the circuit which are elements in the quadratic extension field,
    2. Constants of the circuit which are elements in the quadratic extension field,

    b. Eval section, which contains the encodings of the evaluation gates of the circuit. Each gate is encoded as a single base field element.

  2. the number of rows in the READ section,

  3. the number of rows in the EVAL section,

Stack transition: [ptr, num_read_rows, num_eval_rows, …] -> [ptr, num_read_rows, num_eval_rows, …]

Source§

impl FastProcessor

Source

pub fn op_hperm(&mut self)

Applies a permutation of the Rpo256 hash function to the top 12 elements of the stack.

Analogous to Process::op_hperm.

Source

pub fn op_mpverify( &mut self, err_code: Felt, host: &mut impl Host, program: &MastForest, ) -> Result<(), ExecutionError>

Analogous to Process::op_mpverify.

Source

pub fn op_mrupdate( &mut self, host: &mut impl Host, ) -> Result<(), ExecutionError>

Analogous to Process::op_mrupdate.

Source§

impl FastProcessor

Source

pub fn op_add(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_add.

Source

pub fn op_neg(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_neg.

Source

pub fn op_mul(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_mul.

Source

pub fn op_inv(&mut self, op_idx: usize) -> Result<(), ExecutionError>

Analogous to Process::op_inv.

Source

pub fn op_incr(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_inc.

Source

pub fn op_and(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_and.

Source

pub fn op_or(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_or.

Source

pub fn op_not(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_not.

Source

pub fn op_eq(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_eq.

Source

pub fn op_eqz(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_eqz.

Source

pub fn op_expacc(&mut self)

Analogous to Process::op_expacc.

Source

pub fn op_ext2mul(&mut self)

Analogous to Process::op_ext2mul.

Gets the top four values from the stack [b1, b0, a1, a0], where a = (a1, a0) and b = (b1, b0) are elements of the extension field, and outputs the product c = (c1, c0) where c0 = b0 * a0 - 2 * b1 * a1 and c1 = (b0 + b1) * (a1 + a0) - b0 * a0. It pushes 0 to the first and second positions on the stack, c1 and c2 to the third and fourth positions, and leaves the rest of the stack unchanged.

Source§

impl FastProcessor

Source

pub fn op_fri_ext2fold4(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_fri_ext2fold4.

Source§

impl FastProcessor

Source

pub fn op_horner_eval_base( &mut self, op_idx: usize, ) -> Result<(), ExecutionError>

Analogous to Process::op_horner_eval_base.

Source

pub fn op_horner_eval_ext( &mut self, op_idx: usize, ) -> Result<(), ExecutionError>

Analogous to Process::op_horner_eval_ext.

Source§

impl FastProcessor

Source

pub fn op_push(&mut self, element: Felt)

Analogous to Process::op_push.

Source

pub fn op_advpop( &mut self, op_idx: usize, host: &mut impl Host, ) -> Result<(), ExecutionError>

Analogous to Process::op_advpop.

Source

pub fn op_advpopw( &mut self, op_idx: usize, host: &mut impl Host, ) -> Result<(), ExecutionError>

Analogous to Process::op_advpopw.

Source

pub fn op_mloadw(&mut self, op_idx: usize) -> Result<(), ExecutionError>

Analogous to Process::op_mloadw.

Source

pub fn op_mstorew(&mut self, op_idx: usize) -> Result<(), ExecutionError>

Analogous to Process::op_mstorew.

Source

pub fn op_mload(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_mload.

Source

pub fn op_mstore(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_mstore.

Source

pub fn op_mstream(&mut self, op_idx: usize) -> Result<(), ExecutionError>

Analogous to Process::op_mstream.

Source

pub fn op_pipe( &mut self, op_idx: usize, host: &mut impl Host, ) -> Result<(), ExecutionError>

Analogous to Process::op_pipe.

Source§

impl FastProcessor

Source

pub fn op_pad(&mut self)

Analogous to Process::op_pad.

Source

pub fn op_swap(&mut self)

Analogous to Process::op_swap.

Source

pub fn op_swap_double_word(&mut self)

Analogous to Process::op_swapdw.

Source

pub fn rotate_left(&mut self, n: usize)

Rotates the top n elements of the stack to the left by 1.

For example, if the stack is [a, b, c, d], with d at the top, then rotate_left(3) will result in the top 3 elements being rotated left: [a, c, d, b].

This operation is useful for implementing the movup instructions.

The stack size doesn’t change.

Note: This method doesn’t use the stack_get() and stack_write() methods because it is more efficient to directly manipulate the stack array (~10% performance difference).

Source

pub fn rotate_right(&mut self, n: usize)

Rotates the top n elements of the stack to the right by 1.

Analogous to rotate_left, but in the opposite direction.

Note: This method doesn’t use the stack_get() and stack_write() methods because it is more efficient to directly manipulate the stack array (~10% performance difference).

Source

pub fn dup_nth(&mut self, n: usize)

Duplicates the n’th element from the top of the stack to the top of the stack.

The size of the stack is incremented by 1.

Source

pub fn swapw_nth(&mut self, n: usize)

Swaps the nth word from the top of the stack with the top word of the stack.

Valid values of n are 1, 2, and 3.

Source

pub fn op_cswap(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_cswap.

Source

pub fn op_cswapw(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_cswapw.

Source§

impl FastProcessor

Source

pub fn op_assert( &mut self, err_code: Felt, op_idx: usize, host: &mut impl Host, program: &MastForest, ) -> Result<(), ExecutionError>

Analogous to Process::op_assert.

Source

pub fn op_fmpadd(&mut self)

Analogous to Process::op_fmpadd.

Source

pub fn op_fmpupdate(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_fmpupdate.

Source

pub fn op_sdepth(&mut self)

Analogous to Process::op_sdepth.

Source

pub fn op_caller(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_caller.

Source

pub fn op_clk(&mut self, op_idx: usize) -> Result<(), ExecutionError>

Analogous to Process::op_clk.

Source

pub fn op_emit( &mut self, event_id: u32, op_idx: usize, host: &mut impl Host, ) -> Result<(), ExecutionError>

Analogous to Process::op_emit.

Source§

impl FastProcessor

Source

pub fn op_u32split(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_u32split.

Source

pub fn op_u32add(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_u32add.

Source

pub fn op_u32add3(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_u32add3.

Pops three elements off the stack, adds them, splits the result into low and high 32-bit values, and pushes these values back onto the stack.

The size of the stack is decremented by 1.

Source

pub fn op_u32sub(&mut self, op_idx: usize) -> Result<(), ExecutionError>

Analogous to Process::op_u32sub.

Source

pub fn op_u32mul(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_u32mul.

Source

pub fn op_u32madd(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_u32madd.

Pops three elements off the stack, multiplies the first two and adds the third element to the result, splits the result into low and high 32-bit values, and pushes these values back onto the stack.

Source

pub fn op_u32div(&mut self, op_idx: usize) -> Result<(), ExecutionError>

Analogous to Process::op_u32div.

Source

pub fn op_u32and(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_u32and.

Source

pub fn op_u32xor(&mut self) -> Result<(), ExecutionError>

Analogous to Process::op_u32xor.

Source

pub fn op_u32assert2(&mut self, err_code: Felt) -> Result<(), ExecutionError>

Analogous to Process::op_u32assert2.

Source§

impl FastProcessor

Source

pub fn new(stack_inputs: &[Felt]) -> Self

Creates a new FastProcessor instance with the given stack inputs.

The stack inputs are expected to be stored in reverse order. For example, if stack_inputs = [1,2,3], then the stack will be initialized as [3,2,1,0,0,...], with 3 being on top.

§Panics
  • Panics if the length of stack_inputs is greater than MIN_STACK_DEPTH.
Source

pub fn new_debug(stack_inputs: &[Felt]) -> Self

Creates a new FastProcessor instance with the given stack inputs, set to debug mode.

The stack inputs are expected to be stored in reverse order. For example, if stack_inputs = [1,2,3], then the stack will be initialized as [3,2,1,0,0,...], with 3 being on top.

§Panics
  • Panics if the length of stack_inputs is greater than MIN_STACK_DEPTH.
Source

pub fn stack(&self) -> &[Felt]

Returns the stack, such that the top of the stack is at the last index of the returned slice.

Source

pub fn stack_get(&self, idx: usize) -> Felt

Returns the element on the stack at index idx.

Source

pub fn stack_get_mut(&mut self, idx: usize) -> &mut Felt

Mutable variant of stack_get().

Source

pub fn stack_get_word(&self, start_idx: usize) -> Word

Returns the word on the stack starting at index start_idx in “stack order”.

That is, for start_idx=0 the top element of the stack will be at the last position in the word.

For example, if the stack looks like this:

top bottom v v a | b | c | d | e | f | g | h | i | j | k | l | m | n | o | p

Then

  • stack_get_word(0) returns [d, c, b, a],
  • stack_get_word(1) returns [e, d, c ,b],
  • etc.
Source

pub fn stack_depth(&self) -> u32

Returns the number of elements on the stack in the current context.

Source

pub fn stack_write(&mut self, idx: usize, element: Felt)

Writes an element to the stack at the given index.

Source

pub fn stack_write_word(&mut self, start_idx: usize, word: &Word)

Writes a word to the stack starting at the given index.

The index is the index of the first element of the word, and the word is written in reverse order.

Source

pub fn stack_swap(&mut self, idx1: usize, idx2: usize)

Swaps the elements at the given indices on the stack.

Source

pub fn execute( self, program: &Program, host: &mut impl Host, ) -> Result<StackOutputs, ExecutionError>

Executes the given program and returns the stack outputs.

Trait Implementations§

Source§

impl Debug for FastProcessor

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more