feat: create and use VirtualMachineConfig

Author: dorimedini-starkware

CHANGELOG.md

@@ -13,6 +13,8 @@ Both branches support Stwo prover opcodes (Blake2s, QM31) since v2.0.0.
 #### Upcoming Changes
 
 * Add Stwo cairo runner API [#2351](https://github.com/starkware-libs/cairo-vm/pull/2351)
+* 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)
 
 * feat: create and use CairoRunConfig as ctor arg for CairoRunner ctors [#2367](https://github.com/starkware-libs/cairo-vm/pull/2367)

hint_accountant/src/main.rs

@@ -49,7 +49,7 @@ fn run() {
             whitelists.push(whitelist_file.allowed_hint_expressions);
         }
     }
-    let mut vm = VirtualMachine::new(false, false);
+    let mut vm = VirtualMachine::default();
     let mut hint_executor = BuiltinHintProcessor::new_empty();
     let (ap_tracking_data, reference_ids, references, mut exec_scopes, accessible_scopes) = (
         ApTracking::default(),

vm/src/hint_processor/builtin_hint_processor/secp/cairo0_hints.rs

@@ -397,7 +397,7 @@ mod tests {
 
     #[test]
     fn test_is_on_curve_2() {
-        let mut vm = VirtualMachine::new(false, false);
+        let mut vm = VirtualMachine::default();
         vm.set_fp(1);
         let ids_data = non_continuous_ids_data![("is_on_curve", -1)];
         vm.segments = segments![((1, 0), 1)];
@@ -428,7 +428,7 @@ mod tests {
 
     #[test]
     fn test_compute_q_mod_prime() {
-        let mut vm = VirtualMachine::new(false, false);
+        let mut vm = VirtualMachine::default();
 
         let ap_tracking = ApTracking::default();
 
@@ -454,7 +454,7 @@ mod tests {
 
     #[test]
     fn test_compute_ids_high_low() {
-        let mut vm = VirtualMachine::new(false, false);
+        let mut vm = VirtualMachine::default();
 
         let value = BigInt::from(25);
         let shift = BigInt::from(12);
@@ -523,7 +523,7 @@ mod tests {
 
     #[test]
     fn test_r1_get_point_from_x() {
-        let mut vm = VirtualMachine::new(false, false);
+        let mut vm = VirtualMachine::default();
         vm.set_fp(10);
 
         let ids_data = non_continuous_ids_data![("x", -10), ("v", -7)];
@@ -582,7 +582,7 @@ mod tests {
 
     #[test]
     fn test_reduce_value() {
-        let mut vm = VirtualMachine::new(false, false);
+        let mut vm = VirtualMachine::default();
 
         //Initialize fp
         vm.run_context.fp = 10;
@@ -637,7 +637,7 @@ mod tests {
 
     #[test]
     fn test_reduce_x() {
-        let mut vm = VirtualMachine::new(false, false);
+        let mut vm = VirtualMachine::default();
 
         //Initialize fp
         vm.run_context.fp = 10;

vm/src/hint_processor/cairo_1_hint_processor/dict_manager.rs

@@ -249,7 +249,7 @@ mod tests {
     /// Test for relocate_all_dictionaries error cases
     #[test]
     fn test_relocate_all_dictionaries_errors() {
-        let mut vm = VirtualMachine::new(false, false);
+        let mut vm = VirtualMachine::default();
 
         // Test 1: First segment is a temporary segment (should error)
         {
@@ -297,7 +297,7 @@ mod tests {
     /// Test for relocate_all_dictionaries when no temporary segments
     #[test]
     fn test_relocate_all_dictionaries_no_temporary_segments() {
-        let mut vm = VirtualMachine::new(false, false);
+        let mut vm = VirtualMachine::default();
         let mut dict_manager = DictManagerExecScope::new(false);
 
         // Adding some trackers should not cause any errors

vm/src/utils.rs

@@ -233,7 +233,7 @@ pub mod test_utils {
 
     macro_rules! vm_with_range_check {
         () => {{
-            let mut vm = VirtualMachine::new(false, false);
+            let mut vm = VirtualMachine::default();
             vm.builtin_runners = vec![
                 $crate::vm::runners::builtin_runner::RangeCheckBuiltinRunner::<8>::new(
                     Some(8),
@@ -418,11 +418,14 @@ pub mod test_utils {
 
     macro_rules! vm {
         () => {{
-            crate::vm::vm_core::VirtualMachine::new(false, false)
+            crate::vm::vm_core::VirtualMachine::default()
         }};
 
         ($use_trace:expr) => {{
-            crate::vm::vm_core::VirtualMachine::new($use_trace, false)
+            crate::vm::vm_core::VirtualMachine::new(&crate::vm::vm_core::VirtualMachineConfig {
+                trace_enabled: $use_trace,
+                disable_trace_padding: false,
+            })
         }};
     }
     pub(crate) use vm;

vm/src/vm/runners/cairo_runner.rs

@@ -1,4 +1,4 @@
-use crate::vm::trace::trace_entry::TraceEntry;
+use crate::vm::{trace::trace_entry::TraceEntry, vm_core::VirtualMachineConfig};
 
 use std::{
     any::Any,
@@ -201,6 +201,15 @@ impl CairoRunConfig {
     }
 }
 
+impl CairoRunConfig {
+    pub fn vm_config(&self) -> VirtualMachineConfig {
+        VirtualMachineConfig {
+            trace_enabled: self.trace_enabled,
+            disable_trace_padding: self.disable_trace_padding,
+        }
+    }
+}
+
 pub struct CairoRunner {
     pub vm: VirtualMachine,
     pub(crate) program: Program,
@@ -234,7 +243,7 @@ impl CairoRunner {
     pub fn new(program: &Program, config: &CairoRunConfig) -> CairoRunner {
         CairoRunner {
             program: program.clone(),
-            vm: VirtualMachine::new(config.trace_enabled, config.disable_trace_padding),
+            vm: VirtualMachine::new(&config.vm_config()),
             layout: config.layout.clone(),
             final_pc: None,
             program_base: None,

vm/src/vm/vm_core.rs

@@ -106,6 +106,12 @@ impl DeducedOperands {
     }
 }
 
+#[derive(Default)]
+pub struct VirtualMachineConfig {
+    pub trace_enabled: bool,
+    pub disable_trace_padding: bool,
+}
+
 pub struct VirtualMachine {
     pub(crate) run_context: RunContext,
     pub builtin_runners: Vec<BuiltinRunner>,
@@ -135,15 +141,21 @@ pub struct VirtualMachine {
     pub(crate) relocation_table: Option<Vec<usize>>,
 }
 
+impl Default for VirtualMachine {
+    fn default() -> Self {
+        Self::new(&VirtualMachineConfig::default())
+    }
+}
+
 impl VirtualMachine {
-    pub fn new(trace_enabled: bool, disable_trace_padding: bool) -> VirtualMachine {
+    pub fn new(config: &VirtualMachineConfig) -> VirtualMachine {
         let run_context = RunContext {
             pc: Relocatable::from((0, 0)),
             ap: 0,
             fp: 0,
         };
 
-        let trace = if trace_enabled {
+        let trace = if config.trace_enabled {
             Some(Vec::<TraceEntry>::new())
         } else {
             None
@@ -160,7 +172,7 @@ impl VirtualMachine {
             segments: MemorySegmentManager::new(),
             rc_limits: None,
             run_finished: false,
-            disable_trace_padding,
+            disable_trace_padding: config.disable_trace_padding,
             instruction_cache: Vec::new(),
             #[cfg(feature = "test_utils")]
             hooks: None,
@@ -1660,7 +1672,7 @@ mod tests {
             op1: MaybeRelocatable::Int(Felt252::from(10)),
         };
 
-        let mut vm = VirtualMachine::new(false, false);
+        let mut vm = VirtualMachine::default();
         vm.run_context.pc = Relocatable::from((0, 4));
         vm.run_context.ap = 5;
         vm.run_context.fp = 6;