feat(tracer): Record function calls and returns #36
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
spartakvarna
reviewed
Jul 8, 2024
spartakvarna
approved these changes
Jul 8, 2024
spartakvarna
reviewed
Jul 8, 2024
smanilov
force-pushed
the
feat/trace-function-calls
branch
3 times, most recently
from
8797550 to
b40f710
Compare
This commit also records function calls and returns from functions, without passing the actual arguments and values in either direction. That would be a follow-up. Details: * `get_variables` is now public in `tooling/debugger/src/context.rs`; it is needed to extract the stack frame from the debugger; * drive-by: `trace_metadata.json` is also stored, because the frontend expects that too; * `tail_diff_vecs` is a generic utility function to extract the difference between two vectors; it has good documentation, so details within; * a local structure `StackFrame` is introduced, because the `StackFrame` in the debugger does not own its data; here, we need to remember the previous stack trace (a vector of `StackFrame`'s) in order to discover function calls or returns, so we need to own the data; * a `stack_trace` field is added to `TracingContext`; see previous point; * the new `fn get_stack_trace` performs the conversion mentioned; * the old contents of `update_record` are the basis for `tail_diff_vecs`; the new contents use that function to perform the same operation as before; in addition, the core logic of the PR is here: return events are registered for dropped stack frames and call events are registered for new stack frames; * all tracing tests are updated, to reflect the new traces that are generated. To test: ``` cargo test trace ```
smanilov
force-pushed
the
feat/trace-function-calls
branch
from
b40f710 to
6f731db
Compare
| @@ -3,8 +3,10 @@ | |||
| { "Function": { "path_id": 0, "line": -1, "name": "<toplevel>" } }, | |||
| { "Call": { "function_id": 0, "args": [] } }, | |||
| { "Type": { "kind": 30, "lang_type": "None", "specific_info": { "kind": "None" } } }, | |||
| { "Path": "it-does-not-matter" }, | |||
| { "Path": "<relative-to-this>/src/main.nr" }, | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit also records function calls and returns from functions, without passing the actual arguments and values in either direction. That would be a follow-up.
Details:
get_variablesis now public intooling/debugger/src/context.rs; it is needed to extract the stack frame from the debugger;trace_metadata.jsonis also stored, because the frontend expects that too;tail_diff_vecsis a generic utility function to extract the difference between two vectors; it has good documentation, so details within;StackFrameis introduced, because theStackFramein the debugger does not own its data; here, we need to remember the previous stack trace (a vector ofStackFrame's) in order to discover function calls or returns, so we need to own the data;stack_tracefield is added toTracingContext; see previous point;fn get_stack_traceperforms the conversion mentioned;update_recordare the basis fortail_diff_vecs; the new contents use that function to perform the same operation as before; in addition, the core logic of the PR is here: return events are registered for dropped stack frames and call events are registered for new stack frames;To test: