Tracer #1265

apoorvsadana · 2023-06-19T20:06:43Z

TITLE

Description

Track the ap, fp, pc and the state of the memory in each step of the execution.
A new crate cairo-vm-tracer which starts a server on the localhost where you can see an web UI. The UI allows you to interact with your Cairo programs and see what's happening inside the VM.
Most functionality in existing crates has been put behind feature flags with_tracer and tracer

Checklist

Linked to Github Issue
Unit tests added
Integration tests added.
This change requires new documentation.
- Documentation has been added/updated.
- CHANGELOG has been updated.

Oppen

Overall I 100% love this ❤️
Please do check the comments tho. As a general observation, we try to be conservative about exposing internal representations (this helps avoid future breakage) and about panics (e.g. due to unwrap). Could you check those? I saw a few of them.

cairo-vm-cli/Cargo.toml

cairo-vm-cli/src/main.rs

cairo-vm-tracer/Cargo.toml

vm/src/serde/deserialize_program.rs

vm/src/types/program.rs

vm/src/vm/context/run_context.rs

vm/src/vm/vm_core.rs

apoorvsadana · 2023-06-28T18:54:38Z

Overall I 100% love this ❤️ Please do check the comments tho. As a general observation, we try to be conservative about exposing internal representations (this helps avoid future breakage) and about panics (e.g. due to unwrap). Could you check those? I saw a few of them.

Thanks! I will work on this and try to push an update in the next few days!

MegaRedHand

😮 This tracer is a piece of art! Thanks for your work!

cairo-vm-tracer/static/tracer.js

.gitignore

apoorvsadana · 2023-07-03T06:41:44Z

I have made the fixes mentioned, let me know if there's anything else you would like me to fix :)

unbalancedparentheses · 2023-07-09T18:33:19Z

We will check this tomorrow

apoorvsadana · 2023-07-09T19:02:16Z

Awesome! I just noticed there were some conflicts, have fixed those!

juanbono · 2023-07-11T16:04:26Z

docs/tracer/README.md

@@ -0,0 +1,39 @@
+# Cairo Tracer
+
+Cairo-rs offers a tracer which gives you a visualization of how your memory and registers change line after line as the VM executes the code.


We should replace cairo-rs with cairo-vm that is the new name

pefontana

Amazing work!
I love this tracer, it will be really useful for debugging!

I just left a couple of comments, you can check them.

Plus we need to run Cairo 1 contracts with the tracer, is this possible? maybe we can add this in another feature? Please tell me what you think

If you have any problem with the CI or want to discuss something please contact me throw telegram, we can arrange a call to

pefontana · 2023-07-11T19:07:37Z

vm/src/vm/vm_core.rs

@@ -905,6 +905,10 @@ impl VirtualMachine {
        self.trace = None
    }

+    pub fn get_relocation_table(&self) -> Result<Vec<usize>, MemoryError> {


Why are we adding this?
I think it is not necessary, plus the get_ method name can be misunderstood since it is not just a get, it relocates the memory

So the tracer needed the relocated segments but segments was public only inside the crate. I have renamed the function now to relocate_segments and added a #[cfg(feature = "with_tracer")] flag as well.

pefontana · 2023-07-11T19:08:53Z

cairo-vm-tracer/src/tracer_data.rs

+
+#[derive(Clone)]
+struct TextMark {
+    _line_start: usize,


can we delete the _, or Clippy doesn't allow it?

pefontana · 2023-07-11T19:15:30Z

docs/tracer/README.md

Please add a link to this file in the main README.md so everyone can see it!

apoorvsadana · 2023-07-12T19:21:08Z

Thanks @pefontana! This tracer should work for Cairo 1 as well as long as we generate the trace and memory records and also the DebugInfo. I am not very sure how to generate the DebugInfo for Cairo 1 and casm/sierra don't have anything like this as far as I know. Ideally, we should create a way to launch this tracer from the command line, so we can just give the debug info, trace binary and memory binary and the tracer will start. The tracer wouldn't need to know if the program was Cairo 0 or Cairo 1. Let me know what you think about this?

I am currently a little busy with some things for StarketCC but I can try to pick this up later when I get time :)

pefontana · 2023-07-15T16:08:22Z

Great one @apoorvsadana !
Can you solve the cargo.toml conflicts and we will merge it!

apoorvsadana · 2023-07-15T17:29:30Z

Sure, it's fixed @pefontana

pefontana · 2023-07-16T13:25:07Z

Sure, it's fixed @pefontana

Nice @apoorvsadana !
The PR is having some problems with the CI, can you please check them.
The make clippy command is failing, no-std and wasm tests too, you can check all the CI errors here.

If you have any trouble we can see it together so, we can merge this ASAP.

Also, have you checked running a Cairo 1 or Cairo 2 contract with the tracer?
If it is possible it will be good to add an example so you can complete the bounty! As we talk earlier, you can take this on other PR, but tell us if you need any help!

apoorvsadana · 2023-07-18T08:46:41Z

Hey @pefontana, sorry for the late reply, I was travelling for the Starknet HH. I am in Paris now, I will try to pick this up as soon as I get time! Sorry for the delay

Oppen · 2023-08-10T14:37:59Z

There seems to be quite a few untested lines according to Codecov. I'll let @pefontana decide whether we require that, but my advice is that we do.

There's also a few lints reported by clippy as well.

pefontana · 2024-03-01T20:44:47Z

@apoorvsadana Are you able to solve the merge conflicts so we can merge it?

apoorvsadana · 2024-03-02T08:02:05Z

Hey @pefontana, really sorry for the delay, I have moved this to a new PR - #1643 now as it was easier for me. Closing this one now.

apoorvsadana requested review from igaray, Oppen, fmoletta, entropidelic, juanbono, pefontana and Juan-M-V as code owners June 19, 2023 20:06

apoorvsadana marked this pull request as draft June 19, 2023 20:06

apoorvsadana force-pushed the tracer branch from 2d5b992 to 7e2e51d Compare June 19, 2023 20:08

apoorvsadana marked this pull request as ready for review June 20, 2023 13:59

Oppen reviewed Jun 28, 2023

View reviewed changes

apoorvsadana force-pushed the tracer branch from a900014 to 1183d74 Compare June 30, 2023 05:02

MegaRedHand reviewed Jun 30, 2023

View reviewed changes

cairo-vm-tracer/static/tracer.js Outdated Show resolved Hide resolved

Oppen previously approved these changes Jun 30, 2023

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

apoorvsadana force-pushed the tracer branch from 71d2969 to 35d28a4 Compare July 1, 2023 05:36

apoorvsadana force-pushed the tracer branch from 35d28a4 to 97cde00 Compare July 9, 2023 19:01

juanbono reviewed Jul 11, 2023

View reviewed changes

juanbono previously approved these changes Jul 11, 2023

View reviewed changes

pefontana previously approved these changes Jul 11, 2023

View reviewed changes

apoorvsadana force-pushed the tracer branch from d5d009b to 5ba5cb5 Compare July 12, 2023 19:53

apoorvsadana force-pushed the tracer branch from 5ba5cb5 to fbe7fb1 Compare July 15, 2023 17:28

apoorvsadana and others added 21 commits August 11, 2023 10:50

rebase#1

7bb792a

rebase#2

4ffba3e

rebase#2

c77c317

deleted binary files

df874db

fixed incorect op0 calculation

aaab6c3

rebase#3

c173b1e

added tracer docs

60fe7c9

rebase#2

779980e

fixes

6047046

add unwrap checks and add tests for get_relocated_instruction_locations

25bfb6b

removed comments

a3afe83

removed duplicate .idea

d7db4e8

breakpoint fix

d1a60c8

comments fix

8d805e0

add to main readme

74ee941

Fixes

e0028cc

fixed clippy

ec4175f

ci fixes

40a60b2

ci fixes

ed331c4

fix: clippy

f25954e

chore: add clone to debug info

f91b3dd

apoorvsadana force-pushed the tracer branch from 06437d8 to f91b3dd Compare August 11, 2023 05:29

fix: clippy

e3e7e37

apoorvsadana dismissed stale reviews from pefontana, juanbono, and Oppen via e3e7e37 December 18, 2023 22:47

apoorvsadana closed this Mar 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tracer #1265

Tracer #1265

apoorvsadana commented Jun 19, 2023

Oppen left a comment

apoorvsadana commented Jun 28, 2023

MegaRedHand left a comment

apoorvsadana commented Jul 3, 2023

unbalancedparentheses commented Jul 9, 2023

apoorvsadana commented Jul 9, 2023

juanbono Jul 11, 2023

apoorvsadana Jul 12, 2023

pefontana left a comment

pefontana Jul 11, 2023

apoorvsadana Jul 12, 2023 •

edited

pefontana Jul 11, 2023

apoorvsadana Jul 12, 2023

pefontana Jul 11, 2023 •

edited

apoorvsadana Jul 12, 2023

apoorvsadana commented Jul 12, 2023

pefontana commented Jul 15, 2023

apoorvsadana commented Jul 15, 2023

pefontana commented Jul 16, 2023

apoorvsadana commented Jul 18, 2023

Oppen commented Aug 10, 2023

pefontana commented Mar 1, 2024 •

edited

apoorvsadana commented Mar 2, 2024

		@@ -0,0 +1,39 @@
		# Cairo Tracer

		Cairo-rs offers a tracer which gives you a visualization of how your memory and registers change line after line as the VM executes the code.

Tracer #1265

Tracer #1265

Conversation

apoorvsadana commented Jun 19, 2023

TITLE

Description

Checklist

Oppen left a comment

Choose a reason for hiding this comment

apoorvsadana commented Jun 28, 2023

MegaRedHand left a comment

Choose a reason for hiding this comment

apoorvsadana commented Jul 3, 2023

unbalancedparentheses commented Jul 9, 2023

apoorvsadana commented Jul 9, 2023

juanbono Jul 11, 2023

Choose a reason for hiding this comment

apoorvsadana Jul 12, 2023

Choose a reason for hiding this comment

pefontana left a comment

Choose a reason for hiding this comment

pefontana Jul 11, 2023

Choose a reason for hiding this comment

apoorvsadana Jul 12, 2023 • edited

Choose a reason for hiding this comment

pefontana Jul 11, 2023

Choose a reason for hiding this comment

apoorvsadana Jul 12, 2023

Choose a reason for hiding this comment

pefontana Jul 11, 2023 • edited

Choose a reason for hiding this comment

apoorvsadana Jul 12, 2023

Choose a reason for hiding this comment

apoorvsadana commented Jul 12, 2023

pefontana commented Jul 15, 2023

apoorvsadana commented Jul 15, 2023

pefontana commented Jul 16, 2023

apoorvsadana commented Jul 18, 2023

Oppen commented Aug 10, 2023

pefontana commented Mar 1, 2024 • edited

apoorvsadana commented Mar 2, 2024

apoorvsadana Jul 12, 2023 •

edited

pefontana Jul 11, 2023 •

edited

pefontana commented Mar 1, 2024 •

edited