Add VM hooks as rust conditional feature #761

tdelabro · 2023-01-21T22:14:39Z

Introduce VM hooks

Description

Cairo-rs based testing tools such as cairo-foundry or those built by FuzzingLabs, need access to the state of the VM at specific points during the execution.
This PR adds the possibility for users of the cairo-rs lib to execute their custom additional code during the program execution.
I used the Rust "feature" mechanism in order to guarantee that this ability is only available when the lib user needs it, and is not compiled when it's not required.

In this PR I created tree hooks:

before the first step
before each step
after each step

More hooks could easily be added in the future, as new needs arise.

This PR does not contain any tests, nor documentation, as its immediate goal is not to be merged but to spark a discussion with the LambdaClass team and validate that:

they agree on the way the feature is designed
they agree on the principle of adding non "canon" behaviors in the VM thanks to Rust "feature" mechanism

unbalancedparentheses · 2023-01-22T17:50:13Z

This looks nice. We will check it tomorrow!

pventuzelo · 2023-01-23T08:43:09Z

Clearly something we will use for https://github.com/FuzzingLabs/cairo-fuzzer ;)

Oppen · 2023-01-23T14:45:48Z

I love it. This will also be useful to migrate the debugging/tracing functionality to Rust. Can't wait to see the final version :)

Oppen · 2023-01-23T14:46:40Z

BTW, the description says this is to spark conversation, so it would be nice to convert it to draft and add something like rfc: at the beginning of the title to avoid confusion.

tdelabro · 2023-01-27T13:12:49Z

Changes made in the way the doc is built (using nightly features) allow for this kind of informative warning in the doc about optional features.
I hope you like it!

Makefile

Oppen · 2023-01-27T19:59:08Z

src/hint_processor/builtin_hint_processor/skip_next_instruction.rs

+/// Prevent the execution of the next instruction
+///
+/// This hint doesn't belong to the Cairo common library
+/// It's only added for testing proposes


Suggested change

/// It's only added for testing proposes

/// It's only added for testing purposes

Oppen

Overall this seems really good. There are some minor notes tho. I'm also unsure why the run_until_* functions' interfaces need to change. Can't the field in VirtualMachine be used directly inside those?

src/vm/hooks.rs

Oppen · 2023-01-31T03:58:26Z

src/vm/hooks.rs

+        hint_data_dictionary: &HashMap<usize, Vec<Box<dyn Any>>>,
+        constants: &HashMap<String, Felt>,
+    ) -> Result<(), VirtualMachineError> {
+        if let Some(hook_func) = self.hooks.clone().pre_step_instruction {


src/vm/hooks.rs

tdelabro · 2023-02-04T09:11:32Z

There are some minor notes tho. I'm also unsure why the run_until_* functions' interfaces need to change. Can't the field in VirtualMachine be used directly inside those?

Yeah totally it was some flags from a previous version of the code that I forgot to remove!

doc: improve doc support for optional features

Oppen

Excellent work!

tdelabro · 2023-02-08T09:34:24Z

Thanks @Oppen, can you find us a second reviewer so we can merge ;)

Jrigada

Hey @tdelabro! Amazing work, just some small typos suggestions

Jrigada · 2023-02-13T11:13:23Z

Makefile

@@ -165,8 +165,9 @@ compare_trace_proof: $(CAIRO_RS_TRACE_PROOF) $(CAIRO_TRACE_PROOF)
 compare_memory_proof: $(CAIRO_RS_MEM_PROOF) $(CAIRO_MEM_PROOF)
 	cd tests; ./compare_vm_state.sh memory proof_mode

+# Run with nightly enable the `doc_cfg` feature wich let us provide clear explaination about which parts of the code are behind a feature flag


Suggested change

# Run with nightly enable the `doc_cfg` feature wich let us provide clear explaination about which parts of the code are behind a feature flag

# Run with nightly enable the `doc_cfg` feature which let us provide clear explanation about which parts of the code are behind a feature flag

tdelabro requested review from igaray, Oppen, fmoletta, entropidelic, juanbono, Jrigada, pefontana and Juan-M-V as code owners January 21, 2023 22:14

tdelabro force-pushed the feature-hooks branch from 28e7225 to b398a15 Compare January 22, 2023 12:57

tdelabro marked this pull request as draft January 23, 2023 15:44

tdelabro changed the title ~~feat: add VM hooks as rust conditional feature~~ RFC: add VM hooks as rust conditional feature Jan 23, 2023

tdelabro force-pushed the feature-hooks branch 2 times, most recently from 88e2890 to 2417b96 Compare January 27, 2023 13:06

tdelabro marked this pull request as ready for review January 27, 2023 13:06

tdelabro requested a review from HermanObst as a code owner January 27, 2023 13:06

tdelabro force-pushed the feature-hooks branch from 2417b96 to 683dfae Compare January 27, 2023 13:48

Oppen reviewed Jan 27, 2023

View reviewed changes

Makefile Show resolved Hide resolved

Oppen reviewed Jan 27, 2023

View reviewed changes

Oppen reviewed Jan 31, 2023

View reviewed changes

tdelabro force-pushed the feature-hooks branch from 683dfae to 6f3e840 Compare February 4, 2023 09:08

tdelabro force-pushed the feature-hooks branch from 6f3e840 to 637fbe3 Compare February 4, 2023 09:12

feat: add VM hooks as rust conditional feature

0d00eb9

doc: improve doc support for optional features

tdelabro force-pushed the feature-hooks branch from 637fbe3 to 0d00eb9 Compare February 4, 2023 09:14

Oppen approved these changes Feb 4, 2023

View reviewed changes

Jrigada approved these changes Feb 13, 2023

View reviewed changes

Oppen changed the title ~~RFC: add VM hooks as rust conditional feature~~ Add VM hooks as rust conditional feature Feb 13, 2023

Oppen added this pull request to the merge queue Feb 13, 2023

Merged via the queue into lambdaclass:main with commit 9fad715 Feb 13, 2023

tdelabro deleted the feature-hooks branch February 13, 2023 13:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add VM hooks as rust conditional feature #761

Add VM hooks as rust conditional feature #761

tdelabro commented Jan 21, 2023

unbalancedparentheses commented Jan 22, 2023

pventuzelo commented Jan 23, 2023

Oppen commented Jan 23, 2023

Oppen commented Jan 23, 2023

tdelabro commented Jan 27, 2023

Oppen Jan 27, 2023

tdelabro Feb 4, 2023

Oppen left a comment

Oppen Jan 31, 2023

tdelabro Feb 4, 2023

tdelabro commented Feb 4, 2023 •

edited

Oppen left a comment

tdelabro commented Feb 8, 2023

Jrigada left a comment

Jrigada Feb 13, 2023

	/// It's only added for testing proposes
	/// It's only added for testing purposes

	# Run with nightly enable the `doc_cfg` feature wich let us provide clear explaination about which parts of the code are behind a feature flag
	# Run with nightly enable the `doc_cfg` feature which let us provide clear explanation about which parts of the code are behind a feature flag

Add VM hooks as rust conditional feature #761

Add VM hooks as rust conditional feature #761

Conversation

tdelabro commented Jan 21, 2023

Introduce VM hooks

Description

unbalancedparentheses commented Jan 22, 2023

pventuzelo commented Jan 23, 2023

Oppen commented Jan 23, 2023

Oppen commented Jan 23, 2023

tdelabro commented Jan 27, 2023

Oppen Jan 27, 2023

Choose a reason for hiding this comment

tdelabro Feb 4, 2023

Choose a reason for hiding this comment

Oppen left a comment

Choose a reason for hiding this comment

Oppen Jan 31, 2023

Choose a reason for hiding this comment

tdelabro Feb 4, 2023

Choose a reason for hiding this comment

tdelabro commented Feb 4, 2023 • edited

Oppen left a comment

Choose a reason for hiding this comment

tdelabro commented Feb 8, 2023

Jrigada left a comment

Choose a reason for hiding this comment

Jrigada Feb 13, 2023

Choose a reason for hiding this comment

tdelabro commented Feb 4, 2023 •

edited