feat: add math cairo tests to cairo-vm

Author: OmriEshhar1

CHANGELOG.md

@@ -29,11 +29,11 @@ All types of contributions are encouraged and valued. See the [Table of Contents
 
 > If you want to ask a question, we assume that you have read the available [Documentation](docs/).
 
-Before you ask a question, it is best to search for existing [Issues](https://github.com/lambdaclass/cairo-vm/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
+Before you ask a question, it is best to search for existing [Issues](https://github.com/starkware-libs/cairo-vm/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
 
 If you then still feel the need to ask a question and need clarification, we recommend the following:
 
-- Open an [Issue](https://github.com/lambdaclass/cairo-vm/issues/new).
+- Open an [Issue](https://github.com/starkware-libs/cairo-vm/issues/new).
 - Provide as much context as you can about what you're running into.
 - Provide project and platform versions (cairo language, rust compiler, Python, etc), depending on what seems relevant.
 
@@ -73,7 +73,7 @@ A good bug report shouldn't leave others needing to chase you up for more inform
 
 We use GitHub issues to track bugs and errors. If you run into an issue with the project:
 
-- Open an [Issue](https://github.com/lambdaclass/cairo-vm/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
+- Open an [Issue](https://github.com/starkware-libs/cairo-vm/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
 - Explain the behavior you would expect and the actual behavior.
 - Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
 - Provide the information you collected in the previous section.
@@ -96,13 +96,13 @@ This section guides you through submitting an enhancement suggestion for CONTRIB
 
 - Make sure that you are using the latest version.
 - Read the [documentation](docs/) carefully and find out if the functionality is already covered, maybe by an individual configuration.
-- Perform a [search](https://github.com/lambdaclass/cairo-vm/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+- Perform a [search](https://github.com/starkware-libs/cairo-vm/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
 - Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
 
 
 #### How Do I Submit a Good Enhancement Suggestion?
 
-Enhancement suggestions are tracked as [GitHub issues](https://github.com/lambdaclass/cairo-vm/issues).
+Enhancement suggestions are tracked as [GitHub issues](https://github.com/starkware-libs/cairo-vm/issues).
 
 - Use a **clear and descriptive title** for the issue to identify the suggestion.
 - Provide a **step-by-step description of the suggested enhancement** in as many details as possible.

CONTRIBUTING.md

@@ -17,7 +17,7 @@ resolver = "2"
 version = "3.2.0"
 edition = "2021"
 license = "Apache-2.0"
-repository = "https://github.com/lambdaclass/cairo-vm/"
+repository = "https://github.com/starkware-libs/cairo-vm/"
 readme = "README.md"
 keywords = ["starknet", "cairo", "vm"]
 

Cargo.toml

@@ -7,11 +7,11 @@
 
 A faster and safer implementation of the Cairo VM in Rust
 
-[Report Bug](https://github.com/lambdaclass/cairo-vm/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=bug%3A+) · [Request Feature](https://github.com/lambdaclass/cairo-vm/issues/new?labels=enhancement&title=feat%3A+)
+[Report Bug](https://github.com/starkware-libs/cairo-vm/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=bug%3A+) · [Request Feature](https://github.com/starkware-libs/cairo-vm/issues/new?labels=enhancement&title=feat%3A+)
 
-[![rust](https://github.com/lambdaclass/cairo-vm/actions/workflows/rust.yml/badge.svg)](https://github.com/lambdaclass/cairo-vm/actions/workflows/rust.yml)
-[![codecov](https://img.shields.io/codecov/c/github/lambdaclass/cairo-vm)](https://codecov.io/gh/lambdaclass/cairo-vm)
-[![license](https://img.shields.io/github/license/lambdaclass/cairo-vm)](/LICENSE)
+[![rust](https://github.com/starkware-libs/cairo-vm/actions/workflows/rust.yml/badge.svg)](https://github.com/starkware-libs/cairo-vm/actions/workflows/rust.yml)
+[![codecov](https://img.shields.io/codecov/c/github/starkware-libs/cairo-vm)](https://codecov.io/gh/starkware-libs/cairo-vm)
+[![license](https://img.shields.io/github/license/starkware-libs/cairo-vm)](/LICENSE)
 [![pr-welcome]](#-contributing)
 [![Telegram Chat][tg-badge]][tg-url]
 
@@ -150,7 +150,7 @@ The flag `--layout` determines which builtins can be used. More info about layou
 To sum up, the following code will get you from zero to running a Cairo program:
 
 ```bash
-git clone https://github.com/lambdaclass/cairo-vm.git
+git clone https://github.com/starkware-libs/cairo-vm.git
 
 cd cairo-vm
 
@@ -213,7 +213,7 @@ Currently, as this VM is under construction, it's missing some of the features o
 There are two ways to use non-standard hints in this VM:
 
 - Extend the cairo-vm code and build your own binary using the interface [HintProcessor](docs/hint_processor/README.md).
-- Use [cairo-vm-py](https://github.com/lambdaclass/cairo-vm-py) which supports running any hint in a Python interpreter.
+
 
 ### Running a function in a Cairo program with arguments
 
@@ -229,7 +229,8 @@ When running a Cairo program directly using the Cairo-vm repository you would fi
 2. Instantiate the VM, the cairo_runner, the hint processor, and the entrypoint
 
   ```rust
-  let mut cairo_runner = CairoRunner::new(&program, LayoutName::all_cairo, false, false);
+  let mut cairo_runner =
+      CairoRunner::new(&program, CairoLayout::new(LayoutName::all_cairo, None)?, false, false);
 
   let mut hint_processor = BuiltinHintProcessor::new_empty();
 
@@ -286,7 +287,7 @@ Running a [Cairo program](./cairo_programs/benchmarks/big_fibonacci.cairo) that
 - [Flamegraph](./docs/benchmarks/flamegraph.svg)
 - Github action [results](https://lambdaclass.github.io/cairo-vm/)
 
-Note before running the benchmark suite: the benchmark named [iai_benchmark](https://github.com/lambdaclass/cairo-vm/blob/8dba86dbec935fa04a255e2edf3d5d184950fa22/Cargo.toml#L59) depends on Valgrind. Please make sure it is installed prior to running the `iai_benchmark` benchmark.
+Note before running the benchmark suite: the benchmark named [iai_benchmark](https://github.com/starkware-libs/cairo-vm/blob/8dba86dbec935fa04a255e2edf3d5d184950fa22/Cargo.toml#L59) depends on Valgrind. Please make sure it is installed prior to running the `iai_benchmark` benchmark.
 
 Run the complete benchmark suite with cargo:
 
@@ -335,7 +336,7 @@ You can find more detailed instructions in the [CONTRIBUTING.md](CONTRIBUTING.md
 ## 🌞 Related Projects
 
 - [starknet_in_rust](https://github.com/lambdaclass/starknet_in_rust): implementation of Starknet in Rust, powered by the cairo-vm.
-- [cairo-vm-py](https://github.com/lambdaclass/cairo-vm-py): Bindings for using cairo-vm from Python code.
+
 
 ## 📚 Documentation
 

README.md

@@ -14,7 +14,7 @@
   - The versions must be the same.
   - You need to update the workspace dependency `cairo-vm`, which
     you can find in the root cargo manifest under the section `[workspace.dependencies]`.
-  - [Here](https://github.com/lambdaclass/cairo-vm/pull/1748/files) is an
+  - [Here](https://github.com/starkware-libs/cairo-vm/pull/1748/files) is an
     example pull request with these changes.
 - [ ] Run `cargo update` and `git add Cargo.lock`
 - [ ] Update `CHANGELOG.md`:

RELEASE.md

@@ -1,4 +1,5 @@
 use cairo_vm::{
+    cairo_run::Cairo0RunConfig,
     types::{layout_name::LayoutName, program::Program},
     vm::runners::cairo_runner::CairoRunner,
 };
@@ -26,17 +27,20 @@ fn build_many_runners(c: &mut Criterion) {
     let program = Program::from_bytes(program.as_slice(), Some("main")).unwrap();
     c.bench_function("build runner", |b| {
         b.iter_with_large_drop(|| {
-            _ = black_box(
-                CairoRunner::new(
-                    black_box(&program),
-                    black_box(LayoutName::starknet_with_keccak),
-                    black_box(None),
-                    black_box(false),
-                    black_box(false),
-                    black_box(false),
-                )
-                .unwrap(),
-            );
+            _ = black_box(CairoRunner::new(
+                black_box(&program),
+                black_box(
+                    &Cairo0RunConfig {
+                        layout: LayoutName::starknet_with_keccak,
+                        proof_mode: false,
+                        trace_enabled: false,
+                        disable_trace_padding: false,
+                        ..Default::default()
+                    }
+                    .run_config()
+                    .unwrap(),
+                ),
+            ));
         })
     });
 }
@@ -50,13 +54,16 @@ fn load_program_data(c: &mut Criterion) {
             || {
                 CairoRunner::new(
                     &program,
-                    LayoutName::starknet_with_keccak,
-                    None,
-                    false,
-                    false,
-                    false,
+                    &Cairo0RunConfig {
+                        layout: LayoutName::starknet_with_keccak,
+                        proof_mode: false,
+                        trace_enabled: false,
+                        disable_trace_padding: false,
+                        ..Default::default()
+                    }
+                    .run_config()
+                    .unwrap(),
                 )
-                .unwrap()
             },
             |mut runner| _ = black_box(runner.initialize(false).unwrap()),
             BatchSize::SmallInput,

bench/criterion_benchmark.rs

@@ -1,3 +1,4 @@
+use cairo_vm::cairo_run::Cairo0RunConfig;
 use core::hint::black_box;
 use iai_callgrind::library_benchmark;
 use iai_callgrind::library_benchmark_group;
@@ -36,13 +37,16 @@ fn build_runner() {
     let program = parse_program_helper();
     let runner = CairoRunner::new(
         black_box(&program),
-        LayoutName::starknet_with_keccak,
-        None,
-        false,
-        false,
-        false,
-    )
-    .unwrap();
+        &Cairo0RunConfig {
+            layout: LayoutName::starknet_with_keccak,
+            proof_mode: false,
+            trace_enabled: false,
+            disable_trace_padding: false,
+            ..Default::default()
+        }
+        .run_config()
+        .unwrap(),
+    );
     core::mem::drop(black_box(runner));
 }
 
@@ -54,13 +58,16 @@ fn build_runner_helper() -> CairoRunner {
     let program = Program::from_bytes(program.as_slice(), Some("main")).unwrap();
     CairoRunner::new(
         &program,
-        LayoutName::starknet_with_keccak,
-        None,
-        false,
-        false,
-        false,
+        &Cairo0RunConfig {
+            layout: LayoutName::starknet_with_keccak,
+            proof_mode: false,
+            trace_enabled: false,
+            disable_trace_padding: false,
+            ..Default::default()
+        }
+        .run_config()
+        .unwrap(),
     )
-    .unwrap()
 }
 
 #[library_benchmark]

bench/iai_benchmark.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")]
@@ -145,7 +146,7 @@ fn run(args: impl Iterator<Item = String>) -> Result<(), Error> {
         None => None,
     };
 
-    let cairo_run_config = cairo_run::CairoRunConfig {
+    let cairo_run_config = cairo_run::Cairo0RunConfig {
         entrypoint: &args.entrypoint,
         trace_enabled,
         relocate_mem: args.memory_file.is_some() || args.air_public_input.is_some(),
@@ -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 {
@@ -269,8 +271,8 @@ mod tests {
     use super::*;
     use assert_matches::assert_matches;
     use cairo_vm::{
-        hint_processor::hint_processor_definition::HintProcessor, types::program::Program,
-        vm::runners::cairo_runner::CairoRunner,
+        cairo_run::Cairo0RunConfig, hint_processor::hint_processor_definition::HintProcessor,
+        types::program::Program, vm::runners::cairo_runner::CairoRunner,
     };
     use rstest::rstest;
 
@@ -280,8 +282,18 @@ mod tests {
         hint_processor: &mut dyn HintProcessor,
     ) -> Result<CairoRunner, CairoRunError> {
         let program = Program::from_bytes(program_content, Some("main")).unwrap();
-        let mut cairo_runner =
-            CairoRunner::new(&program, LayoutName::all_cairo, None, false, true, false).unwrap();
+        let mut cairo_runner = CairoRunner::new(
+            &program,
+            &Cairo0RunConfig {
+                layout: LayoutName::all_cairo,
+                proof_mode: false,
+                trace_enabled: true,
+                disable_trace_padding: false,
+                ..Default::default()
+            }
+            .run_config()
+            .unwrap(),
+        );
         let end = cairo_runner
             .initialize(false)
             .map_err(CairoRunError::Runner)?;

cairo-vm-cli/src/main.rs

@@ -34,15 +34,19 @@ 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, vm_core::DEFAULT_MAX_TRACEBACK_ENTRIES};
 use std::{collections::HashMap, iter::Peekable};
 
 use cairo_vm::{
     hint_processor::cairo_1_hint_processor::hint_processor::Cairo1HintProcessor,
     math_utils::signed_felt,
     serde::deserialize_program::{ApTracking, FlowTrackingData, HintParams, ReferenceManager},
     types::{
-        builtin_name::BuiltinName, layout::CairoLayoutParams, layout_name::LayoutName,
-        program::Program, relocatable::MaybeRelocatable,
+        builtin_name::BuiltinName,
+        layout::{CairoLayout, CairoLayoutParams},
+        layout_name::LayoutName,
+        program::Program,
+        relocatable::MaybeRelocatable,
     },
     vm::{
         errors::{runner_errors::RunnerError, vm_errors::VirtualMachineError},
@@ -101,6 +105,15 @@ pub struct Cairo1RunConfig<'a> {
     pub finalize_builtins: bool,
     /// Appends the return and input values to the output segment. This is performed by default when running in proof_mode
     pub append_return_values: bool,
+    /// Disable padding of the trace.
+    /// By default, the trace is padded to accommodate the expected builtins-n_steps relationships
+    /// according to the layout.
+    /// When the padding is disabled:
+    /// - It doesn't modify/pad n_steps.
+    /// - 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<'_> {
@@ -115,6 +128,8 @@ impl Default for Cairo1RunConfig<'_> {
             finalize_builtins: false,
             append_return_values: false,
             dynamic_layout_params: None,
+            disable_trace_padding: false,
+            max_traceback_entries: DEFAULT_MAX_TRACEBACK_ENTRIES,
         }
     }
 }
@@ -125,6 +140,21 @@ impl Cairo1RunConfig<'_> {
     fn copy_to_output(&self) -> bool {
         self.append_return_values || self.proof_mode
     }
+
+    pub fn run_config(&self) -> Result<CairoRunConfig, RunnerError> {
+        let runner_mode = if self.proof_mode {
+            RunnerMode::ProofModeCairo1
+        } else {
+            RunnerMode::ExecutionMode
+        };
+        CairoRunConfig::new(
+            CairoLayout::new(self.layout, self.dynamic_layout_params.clone())?,
+            self.trace_enabled,
+            self.disable_trace_padding,
+            runner_mode,
+            self.max_traceback_entries,
+        )
+    }
 }
 
 /// Runs a Cairo 1 program
@@ -250,20 +280,7 @@ pub fn cairo_run_program(
         )?
     };
 
-    let runner_mode = if cairo_run_config.proof_mode {
-        RunnerMode::ProofModeCairo1
-    } else {
-        RunnerMode::ExecutionMode
-    };
-
-    let mut runner = CairoRunner::new_v2(
-        &program,
-        cairo_run_config.layout,
-        cairo_run_config.dynamic_layout_params.clone(),
-        runner_mode,
-        cairo_run_config.trace_enabled,
-        false,
-    )?;
+    let mut runner = CairoRunner::new(&program, &cairo_run_config.run_config()?);
     let end = runner.initialize(cairo_run_config.proof_mode)?;
     load_arguments(&mut runner, &cairo_run_config, main_func)?;
 

cairo1-run/src/cairo_run.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,
@@ -143,6 +144,8 @@ fn run(args: impl Iterator<Item = String>) -> Result<Option<String>, Error> {
         finalize_builtins: args.air_public_input.is_some() || args.cairo_pie_output.is_some(),
         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