Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(gnovm): source location always precise with line and column #2362

Merged
merged 17 commits into from
Jul 1, 2024

Conversation

mvertes
Copy link
Contributor

@mvertes mvertes commented Jun 15, 2024

The column number was not stored in the GnoVM location. A Nonce field was used to distinguished 2 block nodes on the same line. This was applied only to block nodes, not expressions or statements.

As a result, the node location was the same for all expressions and statements located at the same source line. This change ensures the uniqueness of location for all nodes, in addition to providing an accurate position in source code.

We replace Nonce by Column, computed by the Go tokenizer (the same as line numbers). Column is always included in all AST nodes, and the location string has a uniform format.

With this change it is now possible for the debugger to step in infinite loops on one line like:

for { i++; println(i) }

This change is also necessary for a correct accounting for code coverage, and also may be gas accounting.

Note: as Nonce is renamed to Column in protocol definitions (type and index unchanged),
it may qualify as a BREAKING CHANGE, but I'm not completely sure of that.

Contributors' checklist...
  • [*] Added new tests, or not needed, or not feasible
  • [*] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
  • [*] Updated the official documentation or not needed
  • [*] No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
  • Added references to related issues and PRs
  • [*] Provided any useful hints for running manual tests
  • Added new benchmarks to generated graphs, if any. More info here.

The column number was not stored in the GnoVM location. A `Nonce`
field was used to distinguished 2 block nodes on the same line.
This was applied only to block nodes, not expressions or statements.

As a result, the node location was the same for all expressions and
statements located at the same source line. This change ensures the
uniqueness of location for all nodes, in addition to providing an
accurate position in source code.

We replace `Nonce` by `Column`, computed by the Go tokenizer (the same
as line numbers). Column is always included in all AST nodes, and the
location string has a uniform format.

With this change it is now possible for the debugger to step in
infinite loops on one line like:

`for { i++; println(i) }`

This change is also necessary for a correct accounting for code
coverage, and also may gas accounting.
@github-actions github-actions bot added the 📦 🤖 gnovm Issues or PRs gnovm related label Jun 15, 2024
@github-actions github-actions bot added the 🧾 package/realm Tag used for new Realms or Packages. label Jun 15, 2024
@mvertes mvertes requested a review from ajnavarro as a code owner June 17, 2024 08:07
Copy link

codecov bot commented Jun 17, 2024

Codecov Report

Attention: Patch coverage is 83.78378% with 6 lines in your changes missing coverage. Please review.

Project coverage is 54.71%. Comparing base (3901e7e) to head (5840ec5).

Files Patch % Lines
gnovm/pkg/gnolang/machine.go 0.00% 4 Missing ⚠️
gnovm/pkg/gnolang/preprocess.go 66.66% 1 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2362      +/-   ##
==========================================
+ Coverage   54.68%   54.71%   +0.03%     
==========================================
  Files         583      582       -1     
  Lines       78503    78407      -96     
==========================================
- Hits        42928    42902      -26     
+ Misses      32368    32293      -75     
- Partials     3207     3212       +5     
Flag Coverage Δ
contribs/gnodev 23.81% <ø> (ø)
contribs/gnofaucet 14.46% <ø> (-0.86%) ⬇️
contribs/gnokeykc 0.00% <ø> (ø)
contribs/gnomd 0.00% <ø> (ø)
gno.land 62.54% <ø> (ø)
gnovm 59.93% <83.78%> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

The column number was not stored in the GnoVM location. A `Nonce`
field was used to distinguished 2 block nodes on the same line.
This was applied only to block nodes, not expressions or statements.

As a result, the node location was the same for all expressions and
statements located at the same source line. This change ensures the
uniqueness of location for all nodes, in addition to providing an
accurate position in source code.

We replace `Nonce` by `Column`, computed by the Go tokenizer (the same
as line numbers). Column is always included in all AST nodes, and the
location string has a uniform format.

With this change it is now possible for the debugger to step in
infinite loops on one line like:

`for { i++; println(i) }`

This change is also necessary for a correct accounting for code
coverage, and also may gas accounting.
@thehowl
Copy link
Member

thehowl commented Jun 20, 2024

please merge and fix conflicts 🙏

cc @deelawn for a second review

@mvertes mvertes requested a review from gfanton as a code owner June 27, 2024 14:51
@github-actions github-actions bot added the 📦 ⛰️ gno.land Issues or PRs gno.land package related label Jun 27, 2024
@mvertes mvertes merged commit e282618 into gnolang:master Jul 1, 2024
90 checks passed
@mvertes mvertes deleted the fix-location branch July 1, 2024 14:05
gfanton pushed a commit to gfanton/gno that referenced this pull request Jul 23, 2024
…ang#2362)

The column number was not stored in the GnoVM location. A `Nonce` field
was used to distinguished 2 block nodes on the same line. This was
applied only to block nodes, not expressions or statements.

As a result, the node location was the same for all expressions and
statements located at the same source line. This change ensures the
uniqueness of location for all nodes, in addition to providing an
accurate position in source code.

We replace `Nonce` by `Column`, computed by the Go tokenizer (the same
as line numbers). Column is always included in all AST nodes, and the
location string has a uniform format.

With this change it is now possible for the debugger to step in infinite
loops on one line like:

`for { i++; println(i) }`

This change is also necessary for a correct accounting for code
coverage, and also may be gas accounting.

Note: as `Nonce` is renamed to `Column` in protocol definitions (type
and index unchanged),
it may qualify as a BREAKING CHANGE, but I'm not completely sure of
that.
<!-- please provide a detailed description of the changes made in this
pull request. -->

<details><summary>Contributors' checklist...</summary>

- [*] Added new tests, or not needed, or not feasible
- [*] Provided an example (e.g. screenshot) to aid review or the PR is
self-explanatory
- [*] Updated the official documentation or not needed
- [*] No breaking changes were made, or a `BREAKING CHANGE: xxx` message
was included in the description
- [ ] Added references to related issues and PRs
- [*] Provided any useful hints for running manual tests
- [ ] Added new benchmarks to [generated
graphs](https://gnoland.github.io/benchmarks), if any. More info
[here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md).
</details>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📦 ⛰️ gno.land Issues or PRs gno.land package related 📦 🤖 gnovm Issues or PRs gnovm related 🧾 package/realm Tag used for new Realms or Packages.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants