feat: make max traceback entries configurable

Author: dorimedini-starkware

CHANGELOG.md

@@ -12,6 +12,8 @@ Both branches support Stwo prover opcodes (Blake2s, QM31) since v2.0.0.
 
 #### Upcoming Changes
 
+* feat: make max traceback entries configurable [#2370](https://github.com/starkware-libs/cairo-vm/pull/2370)
+
 * feat: create and use VirtualMachineConfig [#2369](https://github.com/starkware-libs/cairo-vm/pull/2369)
 
 * feat: consolidate CairoRunner ctors [#2368](https://github.com/starkware-libs/cairo-vm/pull/2368)

cairo-vm-cli/src/main.rs

@@ -15,6 +15,7 @@ use cairo_vm::vm::runners::cairo_pie::CairoPie;
 #[cfg(feature = "with_tracer")]
 use cairo_vm::vm::runners::cairo_runner::CairoRunner;
 use cairo_vm::vm::runners::cairo_runner::RunResources;
+use cairo_vm::vm::vm_core::DEFAULT_MAX_TRACEBACK_ENTRIES;
 #[cfg(feature = "with_tracer")]
 use cairo_vm_tracer::error::trace_data_errors::TraceDataError;
 #[cfg(feature = "with_tracer")]
@@ -157,6 +158,7 @@ fn run(args: impl Iterator<Item = String>) -> Result<(), Error> {
         allow_missing_builtins: args.allow_missing_builtins,
         dynamic_layout_params: cairo_layout_params,
         disable_trace_padding: false,
+        max_traceback_entries: DEFAULT_MAX_TRACEBACK_ENTRIES,
     };
 
     let mut cairo_runner = match if args.run_from_cairo_pie {

cairo1-run/src/cairo_run.rs

@@ -34,7 +34,7 @@ use cairo_lang_sierra_type_size::get_type_size_map;
 use cairo_lang_utils::{
     bigint::BigIntAsHex, casts::IntoOrPanic, unordered_hash_map::UnorderedHashMap,
 };
-use cairo_vm::vm::runners::cairo_runner::CairoRunConfig;
+use cairo_vm::vm::{runners::cairo_runner::CairoRunConfig, vm_core::DEFAULT_MAX_TRACEBACK_ENTRIES};
 use std::{collections::HashMap, iter::Peekable};
 
 use cairo_vm::{
@@ -113,6 +113,7 @@ pub struct Cairo1RunConfig<'a> {
     /// - It still pads each builtin segment to the next power of 2 (w.r.t the number of used
     ///   instances of the builtin) compared to their sizes at the end of the execution.
     pub disable_trace_padding: bool,
+    pub max_traceback_entries: u32,
 }
 
 impl Default for Cairo1RunConfig<'_> {
@@ -128,6 +129,7 @@ impl Default for Cairo1RunConfig<'_> {
             append_return_values: false,
             dynamic_layout_params: None,
             disable_trace_padding: false,
+            max_traceback_entries: DEFAULT_MAX_TRACEBACK_ENTRIES,
         }
     }
 }
@@ -150,6 +152,7 @@ impl Cairo1RunConfig<'_> {
             self.trace_enabled,
             self.disable_trace_padding,
             runner_mode,
+            self.max_traceback_entries,
         )
     }
 }

cairo1-run/src/main.rs

@@ -5,6 +5,7 @@ use cairo_lang_compiler::{
 };
 use cairo_vm::cairo_run::{write_encoded_memory, write_encoded_trace};
 use cairo_vm::types::layout::CairoLayoutParams;
+use cairo_vm::vm::vm_core::DEFAULT_MAX_TRACEBACK_ENTRIES;
 use cairo_vm::{
     air_public_input::PublicInputError, types::layout_name::LayoutName,
     vm::errors::trace_errors::TraceError, Felt252,
@@ -144,6 +145,7 @@ fn run(args: impl Iterator<Item = String>) -> Result<Option<String>, Error> {
         append_return_values: args.append_return_values,
         dynamic_layout_params: cairo_layout_params,
         disable_trace_padding: false,
+        max_traceback_entries: DEFAULT_MAX_TRACEBACK_ENTRIES,
     };
 
     // Try to parse the file as a sierra program

vm/src/cairo_run.rs

@@ -16,6 +16,7 @@ use crate::{
         },
         security::verify_secure_runner,
         trace::trace_entry::RelocatedTraceEntry,
+        vm_core::DEFAULT_MAX_TRACEBACK_ENTRIES,
     },
     Felt252,
 };
@@ -51,6 +52,7 @@ pub struct Cairo0RunConfig<'a> {
     ///   instances of the builtin) compared to their sizes at the end of the execution.
     pub disable_trace_padding: bool,
     pub allow_missing_builtins: Option<bool>,
+    pub max_traceback_entries: u32,
 }
 
 impl Default for Cairo0RunConfig<'_> {
@@ -68,6 +70,7 @@ impl Default for Cairo0RunConfig<'_> {
             disable_trace_padding: false,
             allow_missing_builtins: None,
             dynamic_layout_params: None,
+            max_traceback_entries: DEFAULT_MAX_TRACEBACK_ENTRIES,
         }
     }
 }
@@ -84,6 +87,7 @@ impl Cairo0RunConfig<'_> {
             self.trace_enabled,
             self.disable_trace_padding,
             runner_mode,
+            self.max_traceback_entries,
         )
     }
 }
@@ -97,6 +101,7 @@ pub struct StwoCairoRunConfig {
     pub secure_run: bool,
     pub disable_trace_padding: bool,
     pub runner_mode: RunnerMode,
+    pub max_traceback_entries: u32,
 }
 
 impl Default for StwoCairoRunConfig {
@@ -109,6 +114,7 @@ impl Default for StwoCairoRunConfig {
             secure_run: true,
             disable_trace_padding: true,
             runner_mode: RunnerMode::ProofModeCanonical,
+            max_traceback_entries: DEFAULT_MAX_TRACEBACK_ENTRIES,
         }
     }
 }
@@ -120,6 +126,7 @@ impl StwoCairoRunConfig {
             self.trace_enabled,
             self.disable_trace_padding,
             self.runner_mode.clone(),
+            self.max_traceback_entries,
         )
     }
 }

vm/src/utils.rs

@@ -424,7 +424,7 @@ pub mod test_utils {
         ($use_trace:expr) => {{
             crate::vm::vm_core::VirtualMachine::new(&crate::vm::vm_core::VirtualMachineConfig {
                 trace_enabled: $use_trace,
-                disable_trace_padding: false,
+                ..Default::default()
             })
         }};
     }

vm/src/vm/runners/cairo_runner.rs

@@ -163,6 +163,7 @@ pub struct CairoRunConfig {
     trace_enabled: bool,
     disable_trace_padding: bool,
     runner_mode: RunnerMode,
+    max_traceback_entries: u32,
 }
 
 impl CairoRunConfig {
@@ -171,6 +172,7 @@ impl CairoRunConfig {
         trace_enabled: bool,
         disable_trace_padding: bool,
         runner_mode: RunnerMode,
+        max_traceback_entries: u32,
     ) -> Result<Self, RunnerError> {
         // `disable_trace_padding` can only be used in `proof_mode`, so we enforce this here to
         // avoid unintended behavior.
@@ -182,6 +184,7 @@ impl CairoRunConfig {
             trace_enabled,
             disable_trace_padding,
             runner_mode,
+            max_traceback_entries,
         })
     }
 }
@@ -191,6 +194,7 @@ impl CairoRunConfig {
         VirtualMachineConfig {
             trace_enabled: self.trace_enabled,
             disable_trace_padding: self.disable_trace_padding,
+            max_traceback_entries: self.max_traceback_entries,
         }
     }
 }
@@ -1734,6 +1738,7 @@ mod tests {
     use crate::types::instance_definitions::bitwise_instance_def::CELLS_PER_BITWISE;
     use crate::types::instance_definitions::keccak_instance_def::CELLS_PER_KECCAK;
     use crate::types::layout_name::LayoutName;
+    use crate::vm::vm_core::DEFAULT_MAX_TRACEBACK_ENTRIES;
     use crate::vm::vm_memory::memory::MemoryCell;
     use std::collections::{HashMap, HashSet};
 
@@ -6050,6 +6055,7 @@ mod tests {
                     secure_run: true,
                     disable_trace_padding: true,
                     runner_mode: RunnerMode::ProofModeCanonical,
+                    max_traceback_entries: DEFAULT_MAX_TRACEBACK_ENTRIES,
                 },
             )
             .unwrap();

vm/src/vm/vm_core.rs

@@ -44,7 +44,7 @@ use super::errors::runner_errors::RunnerError;
 use super::runners::builtin_runner::{ModBuiltinRunner, RC_N_PARTS_STANDARD};
 use super::runners::cairo_pie::CairoPie;
 
-const MAX_TRACEBACK_ENTRIES: u32 = 20;
+pub const DEFAULT_MAX_TRACEBACK_ENTRIES: u32 = 20;
 
 #[derive(PartialEq, Eq, Debug)]
 pub struct Operands {
@@ -106,10 +106,20 @@ impl DeducedOperands {
     }
 }
 
-#[derive(Default)]
 pub struct VirtualMachineConfig {
     pub trace_enabled: bool,
     pub disable_trace_padding: bool,
+    pub max_traceback_entries: u32,
+}
+
+impl Default for VirtualMachineConfig {
+    fn default() -> Self {
+        Self {
+            trace_enabled: false,
+            disable_trace_padding: false,
+            max_traceback_entries: DEFAULT_MAX_TRACEBACK_ENTRIES,
+        }
+    }
 }
 
 pub struct VirtualMachine {
@@ -139,6 +149,7 @@ pub struct VirtualMachine {
     #[cfg(feature = "test_utils")]
     pub(crate) hooks: Option<Box<dyn crate::vm::hooks::StepHooks>>,
     pub(crate) relocation_table: Option<Vec<usize>>,
+    pub(crate) max_traceback_entries: u32,
 }
 
 impl Default for VirtualMachine {
@@ -177,6 +188,7 @@ impl VirtualMachine {
             #[cfg(feature = "test_utils")]
             hooks: None,
             relocation_table: None,
+            max_traceback_entries: config.max_traceback_entries,
         }
     }
 
@@ -947,7 +959,7 @@ impl VirtualMachine {
         let mut entries = Vec::<(Relocatable, Relocatable)>::new();
         let mut fp = Relocatable::from((1, self.run_context.fp));
         // Fetch the fp and pc traceback entries
-        for _ in 0..MAX_TRACEBACK_ENTRIES {
+        for _ in 0..self.max_traceback_entries {
             // Get return pc
             let ret_pc = match (fp - 1)
                 .ok()
@@ -1396,6 +1408,7 @@ pub struct VirtualMachineBuilder {
     run_finished: bool,
     #[cfg(feature = "test_utils")]
     pub(crate) hooks: Option<Box<dyn crate::vm::hooks::StepHooks>>,
+    pub(crate) max_traceback_entries: u32,
 }
 
 impl Default for VirtualMachineBuilder {
@@ -1416,6 +1429,7 @@ impl Default for VirtualMachineBuilder {
             run_finished: false,
             #[cfg(feature = "test_utils")]
             hooks: None,
+            max_traceback_entries: DEFAULT_MAX_TRACEBACK_ENTRIES,
         }
     }
 }
@@ -1465,6 +1479,11 @@ impl VirtualMachineBuilder {
         self
     }
 
+    pub fn max_traceback_entries(mut self, max_traceback_entries: u32) -> VirtualMachineBuilder {
+        self.max_traceback_entries = max_traceback_entries;
+        self
+    }
+
     pub fn build(self) -> VirtualMachine {
         VirtualMachine {
             run_context: self.run_context,
@@ -1482,6 +1501,7 @@ impl VirtualMachineBuilder {
             hooks: self.hooks,
             relocation_table: None,
             disable_trace_padding: false,
+            max_traceback_entries: self.max_traceback_entries,
         }
     }
 }