Skip to content

Commit

Permalink
Only initialize program builtins (#1815)
Browse files Browse the repository at this point in the history 
* Change initialize_all_builtins for initialize_program_builtins

* Update CHANGELOG.md

* Update comments

* Update CHANGELOG.md
  • Loading branch information
@JulianGCalderon
JulianGCalderon committed Aug 6, 2024
1 parent 4147633 commit 4e04de7
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 119 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

#### Upcoming Changes

* fix(BREAKING): Replace `CairoRunner` method `initialize_all_builtins` with `initialize_program_builtins`. Now it only initializes program builtins instead of all of them

#### [1.0.0] - 2024-08-01

* chore: bump `cairo-lang-` dependencies to 2.7.0 [#1813](https://github.com/lambdaclass/cairo-vm/pull/1813)
Expand Down
148 changes: 29 additions & 119 deletions vm/src/vm/runners/cairo_runner.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -377,28 +377,10 @@ impl CairoRunner {
|| self.runner_mode == RunnerMode::ProofModeCairo1
}

// Initialize all the builtins. Values used are the original one from the CairoFunctionRunner
// Initialize all program builtins. Values used are the original one from the CairoFunctionRunner
// Values extracted from here: https://github.com/starkware-libs/cairo-lang/blob/4fb83010ab77aa7ead0c9df4b0c05e030bc70b87/src/starkware/cairo/common/cairo_function_runner.py#L28
fn initialize_all_builtins(
&mut self,
add_segment_arena_builtin: bool,
) -> Result<(), RunnerError> {
let starknet_preset_builtins = vec![
BuiltinName::pedersen,
BuiltinName::range_check,
BuiltinName::output,
BuiltinName::ecdsa,
BuiltinName::bitwise,
BuiltinName::ec_op,
BuiltinName::keccak,
BuiltinName::poseidon,
];

fn initialize_builtin(
name: BuiltinName,
vm: &mut VirtualMachine,
add_segment_arena_builtin: bool,
) {
pub fn initialize_program_builtins(&mut self) -> Result<(), RunnerError> {
fn initialize_builtin(name: BuiltinName, vm: &mut VirtualMachine) {
match name {
BuiltinName::pedersen => vm
.builtin_runners
Expand All @@ -424,12 +406,9 @@ impl CairoRunner {
BuiltinName::poseidon => vm
.builtin_runners
.push(PoseidonBuiltinRunner::new(Some(1), true).into()),
BuiltinName::segment_arena => {
if add_segment_arena_builtin {
vm.builtin_runners
.push(SegmentArenaBuiltinRunner::new(true).into())
}
}
BuiltinName::segment_arena => vm
.builtin_runners
.push(SegmentArenaBuiltinRunner::new(true).into()),
BuiltinName::range_check96 => vm
.builtin_runners
.push(RangeCheckBuiltinRunner::<RC_N_PARTS_96>::new(Some(1), true).into()),
Expand All @@ -445,12 +424,7 @@ impl CairoRunner {
}

for builtin_name in &self.program.builtins {
initialize_builtin(*builtin_name, &mut self.vm, add_segment_arena_builtin);
}
for builtin_name in starknet_preset_builtins {
if !self.program.builtins.contains(&builtin_name) {
initialize_builtin(builtin_name, &mut self.vm, add_segment_arena_builtin)
}
initialize_builtin(*builtin_name, &mut self.vm);
}
Ok(())
}
Expand Down Expand Up @@ -1204,25 +1178,22 @@ impl CairoRunner {
}

/// Intitializes the runner in order to run cairo 1 contract entrypoints
/// Initializes builtins & segments
/// All builtins are initialized regardless of use
/// Swaps the program's builtins field with program_builtins
/// Adds the segment_arena builtin if present in the program_builtins
/// Initializes program builtins & segments
pub fn initialize_function_runner_cairo_1(
&mut self,
program_builtins: &[BuiltinName],
) -> Result<(), RunnerError> {
self.program.builtins = program_builtins.to_vec();
self.initialize_all_builtins(true)?;
self.initialize_program_builtins()?;
self.initialize_segments(self.program_base);
Ok(())
}

/// Intitializes the runner in order to run cairo 0 contract entrypoints
/// Initializes builtins & segments
/// All builtins are initialized regardless of use
/// Initializes program builtins & segments
pub fn initialize_function_runner(&mut self) -> Result<(), RunnerError> {
self.initialize_all_builtins(false)?;
self.initialize_program_builtins()?;
self.initialize_segments(self.program_base);
Ok(())
}
Expand Down Expand Up @@ -4282,48 +4253,33 @@ mod tests {

#[test]
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
fn initialize_all_builtins() {
let program = program!();

let mut cairo_runner = cairo_runner!(program);

cairo_runner
.initialize_all_builtins(false)
.expect("Builtin initialization failed.");

let given_output = cairo_runner.vm.get_builtin_runners();

assert_eq!(given_output[0].name(), BuiltinName::pedersen);
assert_eq!(given_output[1].name(), BuiltinName::range_check);
assert_eq!(given_output[2].name(), BuiltinName::output);
assert_eq!(given_output[3].name(), BuiltinName::ecdsa);
assert_eq!(given_output[4].name(), BuiltinName::bitwise);
assert_eq!(given_output[5].name(), BuiltinName::ec_op);
assert_eq!(given_output[6].name(), BuiltinName::keccak);
assert_eq!(given_output[7].name(), BuiltinName::poseidon);
}
fn initialize_all_program_builtins() {
let mut program = program!();

#[test]
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
fn initialize_all_builtins_maintain_program_order() {
let program = program![
// we manually add the builtins and check that they exist later
program.builtins = vec![
BuiltinName::pedersen,
BuiltinName::range_check,
BuiltinName::ecdsa
BuiltinName::output,
BuiltinName::ecdsa,
BuiltinName::bitwise,
BuiltinName::ec_op,
BuiltinName::keccak,
BuiltinName::poseidon,
];

let mut cairo_runner = cairo_runner!(program);

cairo_runner
.initialize_all_builtins(false)
.initialize_program_builtins()
.expect("Builtin initialization failed.");

let given_output = cairo_runner.vm.get_builtin_runners();

assert_eq!(given_output[0].name(), BuiltinName::pedersen);
assert_eq!(given_output[1].name(), BuiltinName::range_check);
assert_eq!(given_output[2].name(), BuiltinName::ecdsa);
assert_eq!(given_output[3].name(), BuiltinName::output);
assert_eq!(given_output[2].name(), BuiltinName::output);
assert_eq!(given_output[3].name(), BuiltinName::ecdsa);
assert_eq!(given_output[4].name(), BuiltinName::bitwise);
assert_eq!(given_output[5].name(), BuiltinName::ec_op);
assert_eq!(given_output[6].name(), BuiltinName::keccak);
Expand All @@ -4332,35 +4288,7 @@ mod tests {

#[test]
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
fn initialize_all_builtins_maintain_program_order_add_segment_arena() {
let program = program![
BuiltinName::pedersen,
BuiltinName::range_check,
BuiltinName::ecdsa,
BuiltinName::segment_arena
];

let mut cairo_runner = cairo_runner!(program);

cairo_runner
.initialize_all_builtins(true)
.expect("Builtin initialization failed.");

let given_output = cairo_runner.vm.get_builtin_runners();

assert_eq!(given_output[0].name(), BuiltinName::pedersen);
assert_eq!(given_output[1].name(), BuiltinName::range_check);
assert_eq!(given_output[2].name(), BuiltinName::ecdsa);
assert_eq!(given_output[3].name(), BuiltinName::segment_arena);
assert_eq!(given_output[4].name(), BuiltinName::output);
assert_eq!(given_output[5].name(), BuiltinName::bitwise);
assert_eq!(given_output[6].name(), BuiltinName::ec_op);
assert_eq!(given_output[7].name(), BuiltinName::keccak);
}

#[test]
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
fn initialize_function_runner() {
fn initialize_function_runner_without_builtins() {
let program = program!();

let mut cairo_runner = cairo_runner!(program);
Expand All @@ -4369,17 +4297,6 @@ mod tests {
.initialize_function_runner()
.expect("initialize_function_runner failed.");

let builtin_runners = cairo_runner.vm.get_builtin_runners();

assert_eq!(builtin_runners[0].name(), BuiltinName::pedersen);
assert_eq!(builtin_runners[1].name(), BuiltinName::range_check);
assert_eq!(builtin_runners[2].name(), BuiltinName::output);
assert_eq!(builtin_runners[3].name(), BuiltinName::ecdsa);
assert_eq!(builtin_runners[4].name(), BuiltinName::bitwise);
assert_eq!(builtin_runners[5].name(), BuiltinName::ec_op);
assert_eq!(builtin_runners[6].name(), BuiltinName::keccak);
assert_eq!(builtin_runners[7].name(), BuiltinName::poseidon);

assert_eq!(
cairo_runner.program_base,
Some(Relocatable {
Expand All @@ -4394,12 +4311,12 @@ mod tests {
offset: 0,
})
);
assert_eq!(cairo_runner.vm.segments.num_segments(), 10);
assert_eq!(cairo_runner.vm.segments.num_segments(), 2);
}

#[test]
#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test)]
fn initialize_function_runner_add_segment_arena_builtin() {
fn initialize_function_runner_with_segment_arena_builtin() {
let program = program!();

let mut cairo_runner = cairo_runner!(program);
Expand All @@ -4411,14 +4328,6 @@ mod tests {
let builtin_runners = cairo_runner.vm.get_builtin_runners();

assert_eq!(builtin_runners[0].name(), BuiltinName::segment_arena);
assert_eq!(builtin_runners[1].name(), BuiltinName::pedersen);
assert_eq!(builtin_runners[2].name(), BuiltinName::range_check);
assert_eq!(builtin_runners[3].name(), BuiltinName::output);
assert_eq!(builtin_runners[4].name(), BuiltinName::ecdsa);
assert_eq!(builtin_runners[5].name(), BuiltinName::bitwise);
assert_eq!(builtin_runners[6].name(), BuiltinName::ec_op);
assert_eq!(builtin_runners[7].name(), BuiltinName::keccak);
assert_eq!(builtin_runners[8].name(), BuiltinName::poseidon);

assert_eq!(
cairo_runner.program_base,
Expand All @@ -4434,7 +4343,8 @@ mod tests {
offset: 0,
})
);
assert_eq!(cairo_runner.vm.segments.num_segments(), 12);
// segment arena builtin adds 2 segments
assert_eq!(cairo_runner.vm.segments.num_segments(), 4);
}

#[test]
Expand Down

0 comments on commit 4e04de7

Please sign in to comment.