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
withpush()
&pop()
. - We track the stack top and bottom using indices
stack_top_idx
andstack_bot_idx
, respectively.
- This was observed to increase performance by at least 2x compared to using a
- 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 inProcess
. That is, it is incremented by 1 for every row thatProcess
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
ordyncall
.
- It is important to do so because the clock cycle is used to determine the context ID for
new execution contexts when using
Implementations§
Source§impl FastProcessor
impl FastProcessor
Sourcepub fn new(stack_inputs: &[Felt]) -> Self
pub fn new(stack_inputs: &[Felt]) -> Self
Creates a new FastProcessor
instance with the given stack inputs.
§Panics
- Panics if the length of
stack_inputs
is greater thanMIN_STACK_DEPTH
.
Sourcepub fn new_with_advice_inputs(
stack_inputs: &[Felt],
advice_inputs: AdviceInputs,
) -> Self
pub fn new_with_advice_inputs( stack_inputs: &[Felt], advice_inputs: AdviceInputs, ) -> Self
Creates a new FastProcessor
instance with the given stack and advice inputs.
§Panics
- Panics if the length of
stack_inputs
is greater thanMIN_STACK_DEPTH
.
Sourcepub fn new_debug(stack_inputs: &[Felt], advice_inputs: AdviceInputs) -> Self
pub fn new_debug(stack_inputs: &[Felt], advice_inputs: AdviceInputs) -> Self
Creates a new FastProcessor
instance, set to debug mode, with the given stack
and advice inputs.
§Panics
- Panics if the length of
stack_inputs
is greater thanMIN_STACK_DEPTH
.
Sourcepub fn stack(&self) -> &[Felt]
pub fn stack(&self) -> &[Felt]
Returns the stack, such that the top of the stack is at the last index of the returned slice.
Sourcepub fn stack_top_mut(&mut self) -> &mut [Felt]
pub fn stack_top_mut(&mut self) -> &mut [Felt]
Returns a mutable reference to the top 16 elements of the stack.
Sourcepub fn stack_get_mut(&mut self, idx: usize) -> &mut Felt
pub fn stack_get_mut(&mut self, idx: usize) -> &mut Felt
Mutable variant of stack_get()
.
Sourcepub fn stack_get_word(&self, start_idx: usize) -> Word
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.
Sourcepub fn stack_depth(&self) -> u32
pub fn stack_depth(&self) -> u32
Returns the number of elements on the stack in the current context.
Sourcepub fn stack_write(&mut self, idx: usize, element: Felt)
pub fn stack_write(&mut self, idx: usize, element: Felt)
Writes an element to the stack at the given index.
Sourcepub fn stack_write_word(&mut self, start_idx: usize, word: &Word)
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.
Sourcepub fn stack_swap(&mut self, idx1: usize, idx2: usize)
pub fn stack_swap(&mut self, idx1: usize, idx2: usize)
Swaps the elements at the given indices on the stack.
Sourcepub async fn execute(
self,
program: &Program,
host: &mut impl AsyncHost,
) -> Result<ExecutionOutput, ExecutionError>
pub async fn execute( self, program: &Program, host: &mut impl AsyncHost, ) -> Result<ExecutionOutput, ExecutionError>
Executes the given program and returns the stack outputs as well as the advice provider.
Sourcepub async fn execute_for_trace(
self,
program: &Program,
host: &mut impl AsyncHost,
) -> Result<(ExecutionOutput, Vec<TraceFragmentContext>), ExecutionError>
pub async fn execute_for_trace( self, program: &Program, host: &mut impl AsyncHost, ) -> Result<(ExecutionOutput, Vec<TraceFragmentContext>), ExecutionError>
Executes the given program and returns the stack outputs, the advice provider, and information for building the trace.
Sourcepub async fn execute_with_tracer(
self,
program: &Program,
host: &mut impl AsyncHost,
tracer: &mut impl Tracer,
) -> Result<ExecutionOutput, ExecutionError>
pub async fn execute_with_tracer( self, program: &Program, host: &mut impl AsyncHost, tracer: &mut impl Tracer, ) -> Result<ExecutionOutput, ExecutionError>
Executes the given program with the provided tracer and returns the stack outputs, and the advice provider.
Source§impl FastProcessor
impl FastProcessor
pub fn state(&mut self) -> ProcessState<'_>
Trait Implementations§
Auto Trait Implementations§
impl Freeze for FastProcessor
impl RefUnwindSafe for FastProcessor
impl Send for FastProcessor
impl Sync for FastProcessor
impl Unpin for FastProcessor
impl UnwindSafe for FastProcessor
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<D> OwoColorize for D
impl<D> OwoColorize for D
Source§fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
Source§fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
Source§fn black(&self) -> FgColorDisplay<'_, Black, Self>
fn black(&self) -> FgColorDisplay<'_, Black, Self>
Source§fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
Source§fn red(&self) -> FgColorDisplay<'_, Red, Self>
fn red(&self) -> FgColorDisplay<'_, Red, Self>
Source§fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
Source§fn green(&self) -> FgColorDisplay<'_, Green, Self>
fn green(&self) -> FgColorDisplay<'_, Green, Self>
Source§fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
Source§fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
Source§fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
Source§fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
Source§fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
Source§fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
Source§fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
Source§fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
Source§fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
Source§fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
Source§fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
Source§fn white(&self) -> FgColorDisplay<'_, White, Self>
fn white(&self) -> FgColorDisplay<'_, White, Self>
Source§fn on_white(&self) -> BgColorDisplay<'_, White, Self>
fn on_white(&self) -> BgColorDisplay<'_, White, Self>
Source§fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
Source§fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
Source§fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
Source§fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
Source§fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
Source§fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
Source§fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
Source§fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
Source§fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
Source§fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
Source§fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
Source§fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
Source§fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Source§fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Source§fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Source§fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Source§fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
Source§fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
Source§fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
Source§fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
Source§fn bold(&self) -> BoldDisplay<'_, Self>
fn bold(&self) -> BoldDisplay<'_, Self>
Source§fn dimmed(&self) -> DimDisplay<'_, Self>
fn dimmed(&self) -> DimDisplay<'_, Self>
Source§fn italic(&self) -> ItalicDisplay<'_, Self>
fn italic(&self) -> ItalicDisplay<'_, Self>
Source§fn underline(&self) -> UnderlineDisplay<'_, Self>
fn underline(&self) -> UnderlineDisplay<'_, Self>
Source§fn blink(&self) -> BlinkDisplay<'_, Self>
fn blink(&self) -> BlinkDisplay<'_, Self>
Source§fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
Source§fn reversed(&self) -> ReversedDisplay<'_, Self>
fn reversed(&self) -> ReversedDisplay<'_, Self>
Source§fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
Source§fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
OwoColorize::fg
or
a color-specific method, such as OwoColorize::green
, Read moreSource§fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
OwoColorize::bg
or
a color-specific method, such as OwoColorize::on_yellow
, Read more