Implement run resources funcs (#1175)

* Add RunResources structure

* Modify changelog

* change data type of n_steps from u64 to usize

* Implement run resources functions

* Fix tests

* set comment about calculation in cairo_run

* Change CHangelog and remove option from RunResources

* Fix clippy

* Add clone trait to run resources

* Add debug and default traits to RunResources

* Fix error in while loop inside run_until_pc

* Add helper function for clarity in run_until_pc loop

* Add test for cairo 0 contracts

* Add tests with Cairo 1 contracts

* Move RunResources struct to vm::runners::cairo_runner::RunResources

* Update CHANGELOG.md

* Fix wasm and no-std compilation

---------

Co-authored-by: Pedro Fontana <[email protected]>

Author: mmsc2

CHANGELOG.md

@@ -16,9 +16,12 @@
 
 * fix: Handle the deserialization of serde_json::Number with scientific notation (e.g.: Number(1e27)) in felt_from_number function [#1188](https://github.com/lambdaclass/cairo-rs/pull/1188)
 
+* feat: Add RunResources Struct [#1175](https://github.com/lambdaclass/cairo-rs/pull/1175)
+  * BREAKING: Modify `CairoRunner::run_until_pc` arity. Add `run_resources: &mut Option<RunResources>` input
+  * BREAKING: Modify `CairoRunner::run_from_entrypoint` arity. Add `run_resources: &mut Option<RunResources>` input
+
 * fix: Fix 'as_int' conversion usage in hints `ASSERT_250_BIT` &  `SIGNED_DIV_REM` [#1191](https://github.com/lambdaclass/cairo-rs/pull/1191)
 
-* fix: Fix hint `BIGINT_PACK_DIV_MOD` [#1189](https://github.com/lambdaclass/cairo-rs/pull/1189)
 
 * bugfix: Use cairo constants in `ASSERT_250_BIT` hint [#1187](https://github.com/lambdaclass/cairo-rs/pull/1187)
 

src/cairo_run.rs

@@ -55,11 +55,14 @@ pub fn cairo_run(
         cairo_run_config.layout,
         cairo_run_config.proof_mode,
     )?;
+
     let mut vm = VirtualMachine::new(cairo_run_config.trace_enabled);
     let end = cairo_runner.initialize(&mut vm)?;
+    // check step calculation
+    let mut run_resources = None;
 
     cairo_runner
-        .run_until_pc(end, &mut vm, hint_executor)
+        .run_until_pc(end, &mut run_resources, &mut vm, hint_executor)
         .map_err(|err| VmException::from_vm_error(&cairo_runner, &vm, err))?;
     cairo_runner.end_run(false, false, &mut vm, hint_executor)?;
 
@@ -153,7 +156,7 @@ mod tests {
             .map_err(CairoRunError::Runner)?;
 
         assert!(cairo_runner
-            .run_until_pc(end, &mut vm, hint_processor)
+            .run_until_pc(end, &mut None, &mut vm, hint_processor)
             .is_ok());
 
         Ok((cairo_runner, vm))
@@ -173,7 +176,7 @@ mod tests {
 
         let end = cairo_runner.initialize(&mut vm).unwrap();
         assert!(cairo_runner
-            .run_until_pc(end, &mut vm, &mut hint_processor)
+            .run_until_pc(end, &mut None, &mut vm, &mut hint_processor)
             .is_ok());
         assert!(cairo_runner.relocate(&mut vm, true).is_ok());
         // `main` returns without doing nothing, but `not_main` sets `[ap]` to `1`
@@ -293,7 +296,7 @@ mod tests {
         let mut vm = vm!();
         let end = cairo_runner.initialize(&mut vm).unwrap();
         assert!(cairo_runner
-            .run_until_pc(end, &mut vm, &mut hint_processor)
+            .run_until_pc(end, &mut None, &mut vm, &mut hint_processor)
             .is_ok());
         assert!(cairo_runner.relocate(&mut vm, false).is_ok());
         assert!(vm.get_relocated_trace().is_err());

src/tests/cairo_1_run_from_entrypoint_tests.rs

@@ -1,4 +1,5 @@
 use crate::tests::*;
+use assert_matches::assert_matches;
 
 #[test]
 #[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
@@ -558,3 +559,60 @@ fn uint512_div_mod_test() {
         &[],
     );
 }
+
+// ================
+//   Tests run cairo 1 entrypoint with RunResources
+// ================
+
+#[test]
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
+fn fibonacci_with_run_resources_ok() {
+    let program_data = include_bytes!("../../cairo_programs/cairo-1-contracts/fib.casm");
+    let mut resources = Some(RunResources::new(621));
+    // Program takes 621 steps
+    assert_matches!(
+        run_cairo_1_entrypoint_with_run_resources(
+            program_data.as_slice(),
+            0,
+            &mut resources,
+            &[1_usize.into(), 1_usize.into(), 20_usize.into()],
+        ),
+        Ok(x) if x == [10946_usize.into()]
+    );
+
+    assert_eq!(resources, Some(RunResources::new(0)));
+}
+
+#[test]
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
+fn fibonacci_with_run_resources_2_ok() {
+    let program_data = include_bytes!("../../cairo_programs/cairo-1-contracts/fib.casm");
+    let mut resources = Some(RunResources::new(1000));
+    // Program takes 621 steps
+    assert_matches!(
+        run_cairo_1_entrypoint_with_run_resources(
+            program_data.as_slice(),
+            0,
+            &mut resources,
+            &[1_usize.into(), 1_usize.into(), 20_usize.into()],
+        ),
+        Ok(x) if x == [10946_usize.into()]
+    );
+    assert_eq!(resources, Some(RunResources::new(1000 - 621)));
+}
+
+#[test]
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
+fn fibonacci_with_run_resources_error() {
+    let program_data = include_bytes!("../../cairo_programs/cairo-1-contracts/fib.casm");
+    let mut resources = Some(RunResources::new(100));
+    // Program takes 621 steps
+    assert!(run_cairo_1_entrypoint_with_run_resources(
+        program_data.as_slice(),
+        0,
+        &mut resources,
+        &[1_usize.into(), 1_usize.into(), 20_usize.into()],
+    )
+    .is_err());
+    assert_eq!(resources, Some(RunResources::new(0)));
+}

src/tests/mod.rs

@@ -1,4 +1,8 @@
 #[cfg(feature = "cairo-1-hints")]
+use crate::vm::errors::cairo_run_errors::CairoRunError;
+#[cfg(feature = "cairo-1-hints")]
+use crate::vm::runners::cairo_runner::RunResources;
+#[cfg(feature = "cairo-1-hints")]
 use crate::{
     hint_processor::cairo_1_hint_processor::hint_processor::Cairo1HintProcessor,
     serde::deserialize_program::BuiltinName,
@@ -186,6 +190,7 @@ pub(self) fn run_cairo_1_entrypoint(
         .run_from_entrypoint(
             entrypoint_offset,
             &entrypoint_args,
+            &mut None,
             true,
             Some(runner.program.shared_program_data.data.len() + program_extra_data.len()),
             &mut vm,
@@ -206,6 +211,110 @@ pub(self) fn run_cairo_1_entrypoint(
     assert_eq!(expected_retdata, &retdata);
 }
 
+#[cfg(feature = "cairo-1-hints")]
+/// Equals to fn run_cairo_1_entrypoint
+/// But with run_resources as an input
+pub(self) fn run_cairo_1_entrypoint_with_run_resources(
+    program_content: &[u8],
+    entrypoint_offset: usize,
+    run_resources: &mut Option<RunResources>,
+    args: &[MaybeRelocatable],
+) -> Result<Vec<Felt252>, CairoRunError> {
+    let contract_class: CasmContractClass = serde_json::from_slice(program_content).unwrap();
+    let mut hint_processor = Cairo1HintProcessor::new(&contract_class.hints);
+
+    let mut runner = CairoRunner::new(
+        &(contract_class.clone().try_into().unwrap()),
+        "all_cairo",
+        false,
+    )
+    .unwrap();
+    let mut vm = VirtualMachine::new(false);
+
+    let program_builtins = get_casm_contract_builtins(&contract_class, entrypoint_offset);
+    runner
+        .initialize_function_runner_cairo_1(&mut vm, &program_builtins)
+        .unwrap();
+
+    // Implicit Args
+    let syscall_segment = MaybeRelocatable::from(vm.add_memory_segment());
+
+    let builtins: Vec<&'static str> = runner
+        .get_program_builtins()
+        .iter()
+        .map(|b| b.name())
+        .collect();
+
+    let builtin_segment: Vec<MaybeRelocatable> = vm
+        .get_builtin_runners()
+        .iter()
+        .filter(|b| builtins.contains(&b.name()))
+        .flat_map(|b| b.initial_stack())
+        .collect();
+
+    let initial_gas = MaybeRelocatable::from(usize::MAX);
+
+    let mut implicit_args = builtin_segment;
+    implicit_args.extend([initial_gas]);
+    implicit_args.extend([syscall_segment]);
+
+    // Other args
+
+    // Load builtin costs
+    let builtin_costs: Vec<MaybeRelocatable> =
+        vec![0.into(), 0.into(), 0.into(), 0.into(), 0.into()];
+    let builtin_costs_ptr = vm.add_memory_segment();
+    vm.load_data(builtin_costs_ptr, &builtin_costs).unwrap();
+
+    // Load extra data
+    let core_program_end_ptr =
+        (runner.program_base.unwrap() + runner.program.shared_program_data.data.len()).unwrap();
+    let program_extra_data: Vec<MaybeRelocatable> =
+        vec![0x208B7FFF7FFF7FFE.into(), builtin_costs_ptr.into()];
+    vm.load_data(core_program_end_ptr, &program_extra_data)
+        .unwrap();
+
+    // Load calldata
+    let calldata_start = vm.add_memory_segment();
+    let calldata_end = vm.load_data(calldata_start, &args.to_vec()).unwrap();
+
+    // Create entrypoint_args
+
+    let mut entrypoint_args: Vec<CairoArg> = implicit_args
+        .iter()
+        .map(|m| CairoArg::from(m.clone()))
+        .collect();
+    entrypoint_args.extend([
+        MaybeRelocatable::from(calldata_start).into(),
+        MaybeRelocatable::from(calldata_end).into(),
+    ]);
+    let entrypoint_args: Vec<&CairoArg> = entrypoint_args.iter().collect();
+
+    // Run contract entrypoint
+
+    runner.run_from_entrypoint(
+        entrypoint_offset,
+        &entrypoint_args,
+        run_resources,
+        true,
+        Some(runner.program.shared_program_data.data.len() + program_extra_data.len()),
+        &mut vm,
+        &mut hint_processor,
+    )?;
+
+    // Check return values
+    let return_values = vm.get_return_values(5).unwrap();
+    let retdata_start = return_values[3].get_relocatable().unwrap();
+    let retdata_end = return_values[4].get_relocatable().unwrap();
+    let retdata: Vec<Felt252> = vm
+        .get_integer_range(retdata_start, (retdata_end - retdata_start).unwrap())
+        .unwrap()
+        .iter()
+        .map(|c| c.clone().into_owned())
+        .collect();
+    Ok(retdata)
+}
+
 #[cfg(feature = "cairo-1-hints")]
 fn get_casm_contract_builtins(
     contract_class: &CasmContractClass,

src/vm/errors/vm_errors.rs

@@ -106,6 +106,8 @@ pub enum VirtualMachineError {
     EndOfProgram(usize),
     #[error("Could not reach the end of the program. Executed steps: {0}.")]
     StepsLimit(u64),
+    #[error("Could not reach the end of the program. RunResources has no remaining steps.")]
+    UnfinishedExecution,
     #[error("Current run is not finished")]
     RunNotFinished,
     #[error("Invalid argument count, expected {} but got {}", (*.0).0, (*.0).1)]

src/vm/errors/vm_exception.rs

@@ -643,7 +643,7 @@ mod test {
 
         let end = cairo_runner.initialize(&mut vm).unwrap();
         assert!(cairo_runner
-            .run_until_pc(end, &mut vm, &mut hint_processor)
+            .run_until_pc(end, &mut None, &mut vm, &mut hint_processor)
             .is_err());
 
         #[cfg(all(feature = "std"))]
@@ -657,7 +657,7 @@ mod test {
 
         let end = cairo_runner.initialize(&mut vm).unwrap();
         assert!(cairo_runner
-            .run_until_pc(end, &mut vm, &mut hint_processor)
+            .run_until_pc(end, &mut None, &mut vm, &mut hint_processor)
             .is_err());
         assert_eq!(get_traceback(&vm, &cairo_runner), Some(expected_traceback));
     }
@@ -695,7 +695,7 @@ cairo_programs/bad_programs/bad_usort.cairo:64:5: (pc=0:60)
 
         let end = cairo_runner.initialize(&mut vm).unwrap();
         assert!(cairo_runner
-            .run_until_pc(end, &mut vm, &mut hint_processor)
+            .run_until_pc(end, &mut None, &mut vm, &mut hint_processor)
             .is_err());
         assert_eq!(
             get_traceback(&vm, &cairo_runner),
@@ -854,7 +854,7 @@ cairo_programs/bad_programs/bad_range_check.cairo:11:5: (pc=0:6)
 
         let end = cairo_runner.initialize(&mut vm).unwrap();
         let error = cairo_runner
-            .run_until_pc(end, &mut vm, &mut hint_processor)
+            .run_until_pc(end, &mut None, &mut vm, &mut hint_processor)
             .unwrap_err();
         let vm_excepction = VmException::from_vm_error(&cairo_runner, &vm, error);
         assert_eq!(vm_excepction.to_string(), expected_error_string);
@@ -899,7 +899,7 @@ cairo_programs/bad_programs/bad_usort.cairo:64:5: (pc=0:60)
 
         let end = cairo_runner.initialize(&mut vm).unwrap();
         let error = cairo_runner
-            .run_until_pc(end, &mut vm, &mut hint_processor)
+            .run_until_pc(end, &mut None, &mut vm, &mut hint_processor)
             .unwrap_err();
         let vm_excepction = VmException::from_vm_error(&cairo_runner, &vm, error);
         assert_eq!(vm_excepction.to_string(), expected_error_string);

src/vm/hooks.rs

@@ -146,7 +146,7 @@ mod tests {
 
         let end = cairo_runner.initialize(&mut vm).unwrap();
         assert!(cairo_runner
-            .run_until_pc(end, &mut vm, &mut hint_processor)
+            .run_until_pc(end, &mut None, &mut vm, &mut hint_processor)
             .is_ok());
     }
 
@@ -194,7 +194,7 @@ mod tests {
 
         let end = cairo_runner.initialize(&mut vm).unwrap();
         assert!(cairo_runner
-            .run_until_pc(end, &mut vm, &mut hint_processor)
+            .run_until_pc(end, &mut None, &mut vm, &mut hint_processor)
             .is_err());
 
         // Pre step fail
@@ -205,7 +205,7 @@ mod tests {
 
         let end = cairo_runner.initialize(&mut vm).unwrap();
         assert!(cairo_runner
-            .run_until_pc(end, &mut vm, &mut hint_processor)
+            .run_until_pc(end, &mut None, &mut vm, &mut hint_processor)
             .is_err());
 
         // Post step fail
@@ -216,7 +216,7 @@ mod tests {
 
         let end = cairo_runner.initialize(&mut vm).unwrap();
         assert!(cairo_runner
-            .run_until_pc(end, &mut vm, &mut hint_processor)
+            .run_until_pc(end, &mut None, &mut vm, &mut hint_processor)
             .is_err());
     }
 
@@ -267,7 +267,7 @@ mod tests {
 
         let end = cairo_runner.initialize(&mut vm).unwrap();
         assert!(cairo_runner
-            .run_until_pc(end, &mut vm, &mut hint_processor)
+            .run_until_pc(end, &mut None, &mut vm, &mut hint_processor)
             .is_ok());
     }
 }

src/vm/runners/builtin_runner/bitwise.rs

@@ -359,7 +359,7 @@ mod tests {
         let address = cairo_runner.initialize(&mut vm).unwrap();
 
         cairo_runner
-            .run_until_pc(address, &mut vm, &mut hint_processor)
+            .run_until_pc(address, &mut None, &mut vm, &mut hint_processor)
             .unwrap();
 
         assert_eq!(builtin.get_used_cells_and_allocated_size(&vm), Ok((0, 5)));
@@ -404,7 +404,7 @@ mod tests {
         let address = cairo_runner.initialize(&mut vm).unwrap();
 
         cairo_runner
-            .run_until_pc(address, &mut vm, &mut hint_processor)
+            .run_until_pc(address, &mut None, &mut vm, &mut hint_processor)
             .unwrap();
 
         assert_eq!(builtin.get_allocated_memory_units(&vm), Ok(5));

src/vm/runners/builtin_runner/ec_op.rs

@@ -445,7 +445,7 @@ mod tests {
         let address = cairo_runner.initialize(&mut vm).unwrap();
 
         cairo_runner
-            .run_until_pc(address, &mut vm, &mut hint_processor)
+            .run_until_pc(address, &mut None, &mut vm, &mut hint_processor)
             .unwrap();
 
         assert_eq!(builtin.get_used_cells_and_allocated_size(&vm), Ok((0, 7)));
@@ -490,7 +490,7 @@ mod tests {
         let address = cairo_runner.initialize(&mut vm).unwrap();
 
         cairo_runner
-            .run_until_pc(address, &mut vm, &mut hint_processor)
+            .run_until_pc(address, &mut None, &mut vm, &mut hint_processor)
             .unwrap();
 
         assert_eq!(builtin.get_allocated_memory_units(&vm), Ok(7));