draft: Add support for caching hint data

Author: JulianGCalderon

vm/src/hint_processor/builtin_hint_processor/builtin_hint_processor_definition.rs

@@ -188,7 +188,7 @@ impl HintProcessorLogic for BuiltinHintProcessor {
         &mut self,
         vm: &mut VirtualMachine,
         exec_scopes: &mut ExecutionScopes,
-        hint_data: &Box<dyn Any>,
+        hint_data: &dyn Any,
     ) -> Result<(), HintError> {
         let hint_data = hint_data
             .downcast_ref::<HintProcessorData>()

vm/src/hint_processor/cairo_1_hint_processor/hint_processor.rs

@@ -1284,7 +1284,7 @@ impl HintProcessorLogic for Cairo1HintProcessor {
         //access current scope variables
         exec_scopes: &mut ExecutionScopes,
         //Data structure that can be downcasted to the structure generated by compile_hint
-        hint_data: &Box<dyn Any>,
+        hint_data: &dyn Any,
     ) -> Result<(), HintError> {
         let hints: &Vec<Hint> = hint_data.downcast_ref().ok_or(HintError::WrongHintData)?;
         for hint in hints {

vm/src/hint_processor/hint_processor_definition.rs

@@ -26,7 +26,7 @@ pub trait HintProcessorLogic {
         vm: &mut VirtualMachine,
         exec_scopes: &mut ExecutionScopes,
         //Data structure that can be downcasted to the structure generated by compile_hint
-        hint_data: &Box<dyn Any>,
+        hint_data: &dyn Any,
     ) -> Result<(), HintError>;
 
     //Transforms hint data outputed by the VM into whichever format will be later used by execute_hint
@@ -62,7 +62,7 @@ pub trait HintProcessorLogic {
         vm: &mut VirtualMachine,
         exec_scopes: &mut ExecutionScopes,
         //Data structure that can be downcasted to the structure generated by compile_hint
-        hint_data: &Box<dyn Any>,
+        hint_data: &dyn Any,
     ) -> Result<HintExtension, HintError> {
         self.execute_hint(vm, exec_scopes, hint_data)?;
         Ok(HintExtension::default())
@@ -71,7 +71,7 @@ pub trait HintProcessorLogic {
 
 // A map of hints that can be used to extend the current map of hints for the vm run
 // The map matches the pc at which the hints should be executed to a vec of compiled hints (Outputed by HintProcessor::CompileHint)
-pub type HintExtension = HashMap<Relocatable, Vec<Box<dyn Any>>>;
+pub type HintExtension = HashMap<Relocatable, Vec<Rc<dyn Any>>>;
 
 pub trait HintProcessor: HintProcessorLogic + ResourceTracker {}
 impl<T> HintProcessor for T where T: HintProcessorLogic + ResourceTracker {}

vm/src/tests/run_deprecated_contract_class_simplified.rs

@@ -79,7 +79,7 @@ impl HintProcessorLogic for SimplifiedOsHintProcessor {
         _vm: &mut crate::vm::vm_core::VirtualMachine,
         _exec_scopes: &mut crate::types::exec_scope::ExecutionScopes,
         //Data structure that can be downcasted to the structure generated by compile_hint
-        _hint_data: &Box<dyn core::any::Any>,
+        _hint_data: &dyn core::any::Any,
     ) -> Result<(), crate::vm::errors::hint_errors::HintError> {
         // Empty impl as we are using `execute_hint_extensive` instead for this case
         Ok(())
@@ -90,7 +90,7 @@ impl HintProcessorLogic for SimplifiedOsHintProcessor {
         vm: &mut crate::vm::vm_core::VirtualMachine,
         exec_scopes: &mut crate::types::exec_scope::ExecutionScopes,
         //Data structure that can be downcasted to the structure generated by compile_hint
-        hint_data: &Box<dyn core::any::Any>,
+        hint_data: &dyn core::any::Any,
     ) -> Result<
         crate::hint_processor::hint_processor_definition::HintExtension,
         crate::vm::errors::hint_errors::HintError,
@@ -291,13 +291,15 @@ pub fn vm_load_program(
     let reference_ids = HashMap::default();
     let references = vec![];
     // Compile the hint
-    let compiled_hint = hint_processor.compile_hint(
-        hint_code,
-        &hint_ap_tracking_data,
-        &reference_ids,
-        &references,
-        Default::default(),
-    )?;
+    let compiled_hint = hint_processor
+        .compile_hint(
+            hint_code,
+            &hint_ap_tracking_data,
+            &reference_ids,
+            &references,
+            Default::default(),
+        )?
+        .into();
     // Create the hint extension
     // As the hint from the compiled constract has offset 0, the hint pc will be equal to the loaded contract's program base:
     // This ptr can be found at ids.compiled_class.bytecode_ptr

vm/src/vm/hooks.rs

@@ -9,7 +9,7 @@
 //! - pre_step_instruction, executed before each instruction_step in [step](VirtualMachine::step)
 //! - post_step_instruction, executed after each instruction_step in [step](VirtualMachine::step)
 
-use crate::stdlib::{any::Any, collections::HashMap, prelude::*, sync::Arc};
+use crate::stdlib::{any::Any, collections::HashMap, prelude::*, rc::Rc, sync::Arc};
 
 use crate::Felt252;
 
@@ -20,15 +20,15 @@ use crate::{
 use super::{errors::vm_errors::VirtualMachineError, vm_core::VirtualMachine};
 
 type BeforeFirstStepHookFunc = Arc<
-    dyn Fn(&mut VirtualMachine, &[Box<dyn Any>]) -> Result<(), VirtualMachineError> + Sync + Send,
+    dyn Fn(&mut VirtualMachine, &[Rc<dyn Any>]) -> Result<(), VirtualMachineError> + Sync + Send,
 >;
 
 type StepHookFunc = Arc<
     dyn Fn(
             &mut VirtualMachine,
             &mut dyn HintProcessor,
             &mut ExecutionScopes,
-            &[Box<dyn Any>],
+            &[Rc<dyn Any>],
             &HashMap<String, Felt252>,
         ) -> Result<(), VirtualMachineError>
         + Sync
@@ -62,7 +62,7 @@ impl Hooks {
 impl VirtualMachine {
     pub fn execute_before_first_step(
         &mut self,
-        hint_data: &[Box<dyn Any>],
+        hint_data: &[Rc<dyn Any>],
     ) -> Result<(), VirtualMachineError> {
         if let Some(hook_func) = self.hooks.clone().before_first_step {
             (hook_func)(self, hint_data)?;
@@ -75,7 +75,7 @@ impl VirtualMachine {
         &mut self,
         hint_executor: &mut dyn HintProcessor,
         exec_scope: &mut ExecutionScopes,
-        hint_data: &[Box<dyn Any>],
+        hint_data: &[Rc<dyn Any>],
         constants: &HashMap<String, Felt252>,
     ) -> Result<(), VirtualMachineError> {
         if let Some(hook_func) = self.hooks.clone().pre_step_instruction {
@@ -89,7 +89,7 @@ impl VirtualMachine {
         &mut self,
         hint_executor: &mut dyn HintProcessor,
         exec_scope: &mut ExecutionScopes,
-        hint_data: &[Box<dyn Any>],
+        hint_data: &[Rc<dyn Any>],
         constants: &HashMap<String, Felt252>,
     ) -> Result<(), VirtualMachineError> {
         if let Some(hook_func) = self.hooks.clone().post_step_instruction {
@@ -133,7 +133,7 @@ mod tests {
 
         fn before_first_step_hook(
             _vm: &mut VirtualMachine,
-            _hint_data: &[Box<dyn Any>],
+            _hint_data: &[Rc<dyn Any>],
         ) -> Result<(), VirtualMachineError> {
             Err(VirtualMachineError::Unexpected)
         }
@@ -142,7 +142,7 @@ mod tests {
             _vm: &mut VirtualMachine,
             _hint_processor: &mut dyn HintProcessor,
             _exec_scope: &mut ExecutionScopes,
-            _hint_data: &[Box<dyn Any>],
+            _hint_data: &[Rc<dyn Any>],
             _constants: &HashMap<String, Felt252>,
         ) -> Result<(), VirtualMachineError> {
             Err(VirtualMachineError::Unexpected)
@@ -152,7 +152,7 @@ mod tests {
             _vm: &mut VirtualMachine,
             _hint_processor: &mut dyn HintProcessor,
             _exec_scope: &mut ExecutionScopes,
-            _hint_data: &[Box<dyn Any>],
+            _hint_data: &[Rc<dyn Any>],
             _constants: &HashMap<String, Felt252>,
         ) -> Result<(), VirtualMachineError> {
             Err(VirtualMachineError::Unexpected)
@@ -193,7 +193,7 @@ mod tests {
 
         fn before_first_step_hook(
             _vm: &mut VirtualMachine,
-            _hint_data: &[Box<dyn Any>],
+            _hint_data: &[Rc<dyn Any>],
         ) -> Result<(), VirtualMachineError> {
             Ok(())
         }
@@ -202,7 +202,7 @@ mod tests {
             _vm: &mut VirtualMachine,
             _hint_processor: &mut dyn HintProcessor,
             _exec_scope: &mut ExecutionScopes,
-            _hint_data: &[Box<dyn Any>],
+            _hint_data: &[Rc<dyn Any>],
             _constants: &HashMap<String, Felt252>,
         ) -> Result<(), VirtualMachineError> {
             Ok(())
@@ -212,7 +212,7 @@ mod tests {
             _vm: &mut VirtualMachine,
             _hint_processor: &mut dyn HintProcessor,
             _exec_scope: &mut ExecutionScopes,
-            _hint_data: &[Box<dyn Any>],
+            _hint_data: &[Rc<dyn Any>],
             _constants: &HashMap<String, Felt252>,
         ) -> Result<(), VirtualMachineError> {
             Ok(())

vm/src/vm/runners/cairo_runner.rs

@@ -144,7 +144,7 @@ impl ResourceTracker for RunResources {
 
 #[derive(Clone)]
 pub struct CairoRunnerBuilder {
-    program: Program,
+    pub program: Program,
     layout: CairoLayout,
     runner_mode: RunnerMode,
     // Flags.
@@ -162,7 +162,7 @@ pub struct CairoRunnerBuilder {
     // Set after loading instruction cache.
     // instructions: Vec<Option<Instruction>>,
     // Set after compiling hints.
-    // hints: Vec<Rc<dyn Any>>,
+    hints: Option<Vec<Rc<dyn Any>>>,
 }
 
 impl CairoRunnerBuilder {
@@ -203,6 +203,7 @@ impl CairoRunnerBuilder {
             execution_base: None,
             memory: MemorySegmentManager::new(),
             loaded_program: false,
+            hints: None,
         })
     }
 
@@ -221,7 +222,7 @@ impl CairoRunnerBuilder {
             || self.runner_mode == RunnerMode::ProofModeCairo1
     }
 
-    fn add_memory_segment(&mut self) -> Relocatable {
+    pub fn add_memory_segment(&mut self) -> Relocatable {
         self.memory.add()
     }
 
@@ -352,9 +353,12 @@ impl CairoRunnerBuilder {
         Ok(())
     }
 
-    pub fn initialize_segments(&mut self) {
+    pub fn initialize_base_segments(&mut self) {
         self.program_base = Some(self.add_memory_segment());
         self.execution_base = Some(self.add_memory_segment());
+    }
+
+    pub fn initialize_builtin_segments(&mut self) {
         for builtin_runner in self.builtin_runners.iter_mut() {
             builtin_runner.initialize_segments(&mut self.memory);
         }
@@ -372,6 +376,35 @@ impl CairoRunnerBuilder {
         Ok(())
     }
 
+    pub fn compile_hints(
+        &mut self,
+        hint_processor: &mut dyn HintProcessor,
+    ) -> Result<(), VirtualMachineError> {
+        let constants = Rc::new(self.program.constants.clone());
+        let references = &self.program.shared_program_data.reference_manager;
+        let compiled_hints = self
+            .program
+            .shared_program_data
+            .hints_collection
+            .iter_hints()
+            .map(|hint| {
+                hint_processor
+                    .compile_hint(
+                        &hint.code,
+                        &hint.flow_tracking_data.ap_tracking,
+                        &hint.flow_tracking_data.reference_ids,
+                        references,
+                        constants.clone(),
+                    )
+                    .map_err(|_| VirtualMachineError::CompileHintFail(hint.code.clone().into()))
+                    .map(Into::into)
+            })
+            .collect::<Result<Vec<Rc<dyn Any>>, VirtualMachineError>>()?;
+
+        self.hints = Some(compiled_hints);
+        Ok(())
+    }
+
     pub fn build(self) -> Result<CairoRunner, RunnerError> {
         let mut vm = VirtualMachine::new(self.enable_trace, self.disable_trace_padding);
 
@@ -401,6 +434,7 @@ impl CairoRunnerBuilder {
             relocated_trace: None,
             program: self.program,
             loaded_program: self.loaded_program,
+            hints: self.hints,
         })
     }
 }
@@ -424,6 +458,7 @@ pub struct CairoRunner {
     pub exec_scopes: ExecutionScopes,
     pub relocated_trace: Option<Vec<RelocatedTraceEntry>>,
     loaded_program: bool,
+    hints: Option<Vec<Rc<dyn Any>>>,
 }
 
 #[derive(Clone, Debug, PartialEq)]
@@ -486,6 +521,7 @@ impl CairoRunner {
             },
             relocated_trace: None,
             loaded_program: false,
+            hints: None,
         })
     }
 
@@ -912,7 +948,7 @@ impl CairoRunner {
         &self,
         references: &[HintReference],
         hint_executor: &mut dyn HintProcessor,
-    ) -> Result<Vec<Box<dyn Any>>, VirtualMachineError> {
+    ) -> Result<Vec<Rc<dyn Any>>, VirtualMachineError> {
         let constants = Rc::new(self.program.constants.clone());
 
         self.program
@@ -929,6 +965,7 @@ impl CairoRunner {
                         constants.clone(),
                     )
                     .map_err(|_| VirtualMachineError::CompileHintFail(hint.code.clone().into()))
+                    .map(Into::into)
             })
             .collect()
     }
@@ -947,10 +984,12 @@ impl CairoRunner {
         hint_processor: &mut dyn HintProcessor,
     ) -> Result<(), VirtualMachineError> {
         let references = &self.program.shared_program_data.reference_manager;
-        #[cfg(not(feature = "extensive_hints"))]
-        let hint_data = self.get_hint_data(references, hint_processor)?;
-        #[cfg(feature = "extensive_hints")]
-        let mut hint_data = self.get_hint_data(references, hint_processor)?;
+        #[cfg_attr(not(feature = "extensive_hints"), allow(unused_mut))]
+        let mut hint_data = if let Some(hint_data) = &self.hints {
+            hint_data.clone()
+        } else {
+            self.get_hint_data(references, hint_processor)?
+        };
         #[cfg(feature = "extensive_hints")]
         let mut hint_ranges = self
             .program
@@ -998,10 +1037,12 @@ impl CairoRunner {
         hint_processor: &mut dyn HintProcessor,
     ) -> Result<(), VirtualMachineError> {
         let references = &self.program.shared_program_data.reference_manager;
-        #[cfg(not(feature = "extensive_hints"))]
-        let hint_data = self.get_hint_data(references, hint_processor)?;
-        #[cfg(feature = "extensive_hints")]
-        let mut hint_data = self.get_hint_data(references, hint_processor)?;
+        #[cfg_attr(not(feature = "extensive_hints"), allow(unused_mut))]
+        let mut hint_data = if let Some(hint_data) = &self.hints {
+            hint_data.clone()
+        } else {
+            self.get_hint_data(references, hint_processor)?
+        };
         #[cfg(feature = "extensive_hints")]
         let mut hint_ranges = self
             .program