[WIP] Metrics for Sanctuary #1186

beta-ziliani · 2024-12-11T12:36:15Z

This PR adds stats to sanctuary. Collected stats are at the moment:

file,   # the complete path at the moment, likely to change
bytes,  # total bytes of file
locs,  # a simple count of lines
number_of_contracts,  # number of hits of the query `[ContractDefinition]`,
total_inheritance_count,  # How many times contracts are inherited
max_inheritance_count,  # the max grade of the contract inheritance graph
cst_height,  # the height of the nodes tree
number_of_nodes, # the sum of nodes
without_trivia,  # same as previous one, but filtering out `.is_trivia?`
number_of_refs, # number of binding refereces
parsing_time,  # in µsec
bindings_time, # in µsec
memory_usage, # in bytes

These are collected with --collect-metrics, and if a file is specified with --metrics-file, it will write the csv tabulated file. Otherwise, it spits it in stdout.

Memory is only profiled if compiled with feature mem_profiler. This is because we're instrumentating Rust's allocator, and I figured it's a bold movement when not profiling. We can then instead remove the --collect-metrics to just check this feature.

Built on top of #1170

…e-or-more operator

- `string` and `bytes` are exported as built-in variables resolving to types that provide a `concat` function - `address` can be used as a function to cast a parameter to `address` to eg. retrieve the balance

This makes resolving to attached functions on types even when the reference of those types happen in a different lexical scope.

And also provide alternative paths with and without propagating the dynamic scope. Otherwise, since scope accumulate on the stack it's possible we'll need to resolve an attached function with the wrong dynamic scope at the top of the scope stack.

Both contracts and libraries can optionally push the dynamics scope when traversing to the parent lexical scope (ie. the source unit). But for libraries, they can also optionally push their name to correctly bind internal types which were extended (with `using`) by their qualified name (ie. `Lib.Type`).

…erations

Applying a function call with a type will always return a value of that type, so a symbol stack `type,()` is equivalent to `type,@typeof`. Reflect on the binding entry point of the using clause.

These are parsed as modifiers, and they need a similar treatment as parent constructor calls in new constructor definitions.

The ResolverCandidates will insert arbitrary edges to the graph connecting to the extension scopes determined available at the beginning of resolution (these are context dependent) when reaching nodes marked as extension hooks (usually the source unit's lexical scope).

…extensions

There's an initial dual purpose: - make resolution reentrant-safe, as some of the resolution tweaks require resolving references themselves - enable recursive lookup of extension scopes for Solidity < 0.7.0

Since extensions are now injected during the resolution phases, it's no longer needed to have a separate extended scope. This simplifies the existing rules quite a bit. Also removes all previous commented out rules that dealt with pushing the extension scope to the scope stack, since that mechanism is no longer used.

Instead of having to manually customize the resolver. Also, simplify `ResolveOptions` to an enum with two possible values: `Full` and `NonRecursive`. `NonRecursive` is used internally from `simple_resolve` to disable code paths that could lead to infinite recursions when attempting to resolve a reference.

Since the built-ins file needs to be pre-processed to transform the symbols as to ensure no conflicts can occur with user code, adding the built-ins requires a couple of manual steps that were replicated in every construction of Solidity bindings API. By encapsulating this functionality in the `slang_solidity` crate we remove a source of user error and make it easier to make changes to the built-ins ingestion code.

changeset-bot · 2024-12-11T12:36:19Z

⚠️ No Changeset found

Latest commit: 873c856

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

ggiraldez added 30 commits November 14, 2024 16:30

Add test case which broke with query engine not skipping trivia in on…

aa18f14

…e-or-more operator

Make using directives inherited in Solidity < 0.7.0

42bfde6

Resolve elementary types in expressions and add their built-ins

634b33b

- `string` and `bytes` are exported as built-in variables resolving to types that provide a `concat` function - `address` can be used as a function to cast a parameter to `address` to eg. retrieve the balance

Bind constants as library members

458855c

Propagate dynamic scopes when escaping a contract's lexical scope

bcd0d1f

This makes resolving to attached functions on types even when the reference of those types happen in a different lexical scope.

Bind elementary casting and struct construction to the resulting type

915fbd8

Fix calling parent constructors in constructors

f2ab055

Bind arithmetic, logical, bit-wise, comparison, etc. expressions

13cf7e5

Propagate the dynamic scope with resolving contract bases

5d8c379

Define a new scope for internal state variables for derived contracts

ddac849

Resolve using dynamic scope from an interface/contract casting

a5f3eda

Resolve attached functions when applied to namespace qualified types

901501a

Public getters are used as functions, so bind them as such

1d566b4

Functions can be called in derived contracts by qualifying with the name

a38e8bd

Add support for binding unnamed function declarations

3aab65d

Support old var declarations

9d620d7

Make inherited state vars accessible in all parent contracts

7daa1f4

Normalize value type aliases to bind attached functions correctly

0d2802f

Support binding literal hex addresses

58ced15

Prior to 0.5.0, this could be used as an address

438cb81

Add binding test cases for most of the remaining Sanctuary issues

9cbb4fc

_slot/_offset suffixes for storage variables in Solidity < 0.7.0

f7655e7

Bind to the output of both operands for all arithmetic and bitwise op…

b3bcf54

…erations

Bind legacy call options .value() and .gas() on Solidity < 0.7.0

d6b7174

Bind user defined types .wrap() and .unwrap()

5ec110b

Allow binding attached functions on typed casted expressions

ac13986

Applying a function call with a type will always return a value of that type, so a symbol stack `type,()` is equivalent to `type,@typeof`. Reflect on the binding entry point of the using clause.

Bind modifiers in libraries

6a560d5

Bind legacy constructor parent invocations

4df6b54

These are parsed as modifiers, and they need a similar treatment as parent constructor calls in new constructor definitions.

ggiraldez and others added 24 commits November 26, 2024 20:08

Update performance test counts and ignore built-ins in them

a865d10

Fix formatting

c278a6c

Add extension hooks and scopes and disable old scope stack rules for …

89133bc

…extensions

Add resolver options to disable certain operations

a4dc6a4

There's an initial dual purpose: - make resolution reentrant-safe, as some of the resolution tweaks require resolving references themselves - enable recursive lookup of extension scopes for Solidity < 0.7.0

Disable remaining rules used for extension pushing via rules

7ad1e0c

Allow some ranking in resolver when running in reentrant safety

a9b12c2

Clean up resolver code, removing commented code and unnecessary code

da00828

Rename simple_resolve to non_recursive_resolve

362b35c

Refactor: rename jump_to_definition to resolve_definition

d8730de

Move lookup_definition_by_name to tests crate

ad4e21e

Remove unused NoCancellation struct

fb68f12

Update public_api.txt

9d37caa

Update public_api.txt

a34c3ec

Added documentation on the added graph attributes

58fa2b8

merged main

f668bba

Collecting metrics

cd814d3

missing file

70f9718

Merge remote-tracking branch 'origin/main' into perf-metrics

d8ad14d

Fixing linting errors

fb2035a

Adding no-trivia count

b979b46

beta-ziliani requested review from a team as code owners December 11, 2024 12:36

beta-ziliani marked this pull request as draft December 11, 2024 12:36

beta-ziliani added 2 commits December 11, 2024 17:09

preparatory refactor for the heritage graph

98126a2

Adding using fors

873c856

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Metrics for Sanctuary #1186

[WIP] Metrics for Sanctuary #1186

beta-ziliani commented Dec 11, 2024 •

edited

Loading

changeset-bot bot commented Dec 11, 2024 •

edited

Loading

[WIP] Metrics for Sanctuary #1186

Are you sure you want to change the base?

[WIP] Metrics for Sanctuary #1186

Conversation

beta-ziliani commented Dec 11, 2024 • edited Loading

changeset-bot bot commented Dec 11, 2024 • edited Loading

⚠️ No Changeset found

beta-ziliani commented Dec 11, 2024 •

edited

Loading

changeset-bot bot commented Dec 11, 2024 •

edited

Loading