feat(cli): Add CLI option to filter by contract function name #7018

aakoshh · 2025-01-10T14:36:22Z

Description

Problem*

Resolves having to hack around the code to restrict which contract function to show.

Summary*

Adds a --show-contract-fn CLI option to restrict the effects of --show-ssa, --show-ssa-pass and --print-acir to a single function in a contract, ie. a single circuit.

Example:

cargo run --release -p nargo_cli -- \
  --program-dir $PROGRAM_DIR compile \
  --package token_contract  \
  --print-acir \
  --show-ssa-pass "Remove IfElse" \
  --show-contract-fn public_dispatch

Note that --show-ssa-pass-name has been shortened to --show-ssa-pass.

Additional Context

Often when investigating the size increase of a contract circuit such as the public_dispatch function of the Token contract in AztecProtocol/aztec-packages#11138 (comment) I want to see the SSA, but currently running compile would show the SSA of 36 different functions, which, even when restricted to a single pass, results in 14MB of text in this example.

Documentation*

Check one:

No documentation needed.
Documentation included in this PR.
[For Experimental Features] Documentation to be submitted in a separate PR.

PR Checklist*

I have tested the changes locally.
I have formatted the changes with Prettier and/or cargo fmt on default settings.

github-actions · 2025-01-10T14:44:09Z

Execution Report

Program	Execution Time	%
sha256_regression	0.055s	3%
regression_4709	0.001s	0%
ram_blowup_regression	0.579s	1%
rollup-base-public	1.242s	-1%
rollup-base-private	0.471s	0%
private-kernel-tail	0.021s	0%

github-actions · 2025-01-10T14:44:15Z

Compilation Report

Program	Compilation Time	%
sha256_regression	1.360s	5%
regression_4709	0.830s	6%
ram_blowup_regression	18.660s	0%
rollup-base-public	39.520s	-16%
rollup-base-private	12.400s	-3%
private-kernel-tail	1.028s	6%

github-actions · 2025-01-10T14:44:34Z

Execution Memory Report

Program	Peak Memory
keccak256	74.67M
workspace	123.94M
regression_4709	316.00M
ram_blowup_regression	512.42M
rollup-base-public	482.47M
rollup-base-private	328.59M
private-kernel-tail	180.94M
private-kernel-reset	249.61M
private-kernel-inner	209.78M

github-actions · 2025-01-10T14:44:35Z

Compilation Memory Report

Program	Peak Memory
keccak256	78.12M
workspace	123.83M
regression_4709	422.98M
ram_blowup_regression	1.58G
rollup-base-public	4.85G
rollup-base-private	1.26G
private-kernel-tail	207.09M
private-kernel-reset	730.51M
private-kernel-inner	294.32M

michaeljklein

Small comment r.e. naming, otherwise LGTM

compiler/noirc_driver/src/lib.rs

…ion-name

chore: delete docs for versions which aren't used (noir-lang/noir#7020) feat!: Disable mocks in `execute` (noir-lang/noir#6869) chore(docs): backport 1.0.0-beta.0 doc fixes (noir-lang/noir#7014) feat(cli): Add CLI option to filter by contract function name (noir-lang/noir#7018) chore: Add more Field use info (noir-lang/noir#7019) fix: let static_assert fail with the provided message (noir-lang/noir#7005) chore: mark `aztec-nr` as expected to compile (noir-lang/noir#7015) chore: clarity fix in docs (noir-lang/noir#7016) fix: require generic trait impls to be in scope to call them (noir-lang/noir#6913) feat!: require trait primitive functions/calls to have their trait in scope (noir-lang/noir#6901) feat(lsp): use trait method docs for trait impl method docs on hover (noir-lang/noir#7003) chore: turn on averaging for protocol circuits metrics in CI (noir-lang/noir#6999) feat(comptime): Implement to_be_bits and to_le_bits in the interpreter (noir-lang/noir#7008) chore: Add short circuit in ssa-gen for known if conditions (noir-lang/noir#7007) chore: Only resolved globals monomorphization (noir-lang/noir#7006) chore: Remove resolve_is_unconstrained pass (noir-lang/noir#7004) chore: require safety doc comment for unsafe instead of `//@safety` (noir-lang/noir#6992) fix: Reproduce and fix bytecode blowup (noir-lang/noir#6972) chore: mark casts as able to be deduplicated (noir-lang/noir#6996) fix: return trait impl method as FuncId if there's only one (noir-lang/noir#6989) chore(ci): fail properly in `external-repo-checks` (noir-lang/noir#6988) fix: allow multiple trait impls for the same trait as long as one is in scope (noir-lang/noir#6987) chore: Use DFG in SSA printer (noir-lang/noir#6986) chore!: Reserve `enum` and `match` keywords (noir-lang/noir#6961)

* master: chore: simplify a couple of enum variants (#7025) chore: disallow inserting ACIR-only instructions into brillig functions (#7017) feat: unchecked math operations in SSA (#7011) chore: delete docs for versions which aren't used (#7020) feat!: Disable mocks in `execute` (#6869) chore(docs): backport 1.0.0-beta.0 doc fixes (#7014) feat(cli): Add CLI option to filter by contract function name (#7018) chore: Add more Field use info (#7019) fix: let static_assert fail with the provided message (#7005) chore: mark `aztec-nr` as expected to compile (#7015) chore: clarity fix in docs (#7016)

…ang/noir#6985) feat!: disallow calling unconstrained functions outside of `unsafe` blocks and passing unconstrained functions in place of constrained functions (noir-lang/noir#6938) chore: simplify a couple of enum variants (noir-lang/noir#7025) chore: disallow inserting ACIR-only instructions into brillig functions (noir-lang/noir#7017) feat: unchecked math operations in SSA (noir-lang/noir#7011) chore: delete docs for versions which aren't used (noir-lang/noir#7020) feat!: Disable mocks in `execute` (noir-lang/noir#6869) chore(docs): backport 1.0.0-beta.0 doc fixes (noir-lang/noir#7014) feat(cli): Add CLI option to filter by contract function name (noir-lang/noir#7018) chore: Add more Field use info (noir-lang/noir#7019) fix: let static_assert fail with the provided message (noir-lang/noir#7005) chore: mark `aztec-nr` as expected to compile (noir-lang/noir#7015) chore: clarity fix in docs (noir-lang/noir#7016) fix: require generic trait impls to be in scope to call them (noir-lang/noir#6913) feat!: require trait primitive functions/calls to have their trait in scope (noir-lang/noir#6901) feat(lsp): use trait method docs for trait impl method docs on hover (noir-lang/noir#7003) chore: turn on averaging for protocol circuits metrics in CI (noir-lang/noir#6999) feat(comptime): Implement to_be_bits and to_le_bits in the interpreter (noir-lang/noir#7008) chore: Add short circuit in ssa-gen for known if conditions (noir-lang/noir#7007) chore: Only resolved globals monomorphization (noir-lang/noir#7006) chore: Remove resolve_is_unconstrained pass (noir-lang/noir#7004) chore: require safety doc comment for unsafe instead of `//@safety` (noir-lang/noir#6992) fix: Reproduce and fix bytecode blowup (noir-lang/noir#6972) chore: mark casts as able to be deduplicated (noir-lang/noir#6996) fix: return trait impl method as FuncId if there's only one (noir-lang/noir#6989) chore(ci): fail properly in `external-repo-checks` (noir-lang/noir#6988) fix: allow multiple trait impls for the same trait as long as one is in scope (noir-lang/noir#6987) chore: Use DFG in SSA printer (noir-lang/noir#6986) chore!: Reserve `enum` and `match` keywords (noir-lang/noir#6961)

feat!: disallow calling unconstrained functions outside of `unsafe` blocks and passing unconstrained functions in place of constrained functions (noir-lang/noir#6938) chore: simplify a couple of enum variants (noir-lang/noir#7025) chore: disallow inserting ACIR-only instructions into brillig functions (noir-lang/noir#7017) feat: unchecked math operations in SSA (noir-lang/noir#7011) chore: delete docs for versions which aren't used (noir-lang/noir#7020) feat!: Disable mocks in `execute` (noir-lang/noir#6869) chore(docs): backport 1.0.0-beta.0 doc fixes (noir-lang/noir#7014) feat(cli): Add CLI option to filter by contract function name (noir-lang/noir#7018) chore: Add more Field use info (noir-lang/noir#7019) fix: let static_assert fail with the provided message (noir-lang/noir#7005) chore: mark `aztec-nr` as expected to compile (noir-lang/noir#7015) chore: clarity fix in docs (noir-lang/noir#7016) fix: require generic trait impls to be in scope to call them (noir-lang/noir#6913) feat!: require trait primitive functions/calls to have their trait in scope (noir-lang/noir#6901) feat(lsp): use trait method docs for trait impl method docs on hover (noir-lang/noir#7003) chore: turn on averaging for protocol circuits metrics in CI (noir-lang/noir#6999) feat(comptime): Implement to_be_bits and to_le_bits in the interpreter (noir-lang/noir#7008) chore: Add short circuit in ssa-gen for known if conditions (noir-lang/noir#7007) chore: Only resolved globals monomorphization (noir-lang/noir#7006) chore: Remove resolve_is_unconstrained pass (noir-lang/noir#7004) chore: require safety doc comment for unsafe instead of `//@safety` (noir-lang/noir#6992) fix: Reproduce and fix bytecode blowup (noir-lang/noir#6972) chore: mark casts as able to be deduplicated (noir-lang/noir#6996) fix: return trait impl method as FuncId if there's only one (noir-lang/noir#6989) chore(ci): fail properly in `external-repo-checks` (noir-lang/noir#6988) fix: allow multiple trait impls for the same trait as long as one is in scope (noir-lang/noir#6987) chore: Use DFG in SSA printer (noir-lang/noir#6986) chore!: Reserve `enum` and `match` keywords (noir-lang/noir#6961)

Add CLI option to filter by contract function name

07391e7

aakoshh requested a review from a team January 10, 2025 14:37

michaeljklein approved these changes Jan 10, 2025

View reviewed changes

compiler/noirc_driver/src/lib.rs Outdated Show resolved Hide resolved

aakoshh added 3 commits January 10, 2025 15:45

Merge remote-tracking branch 'origin/master' into show-contract-funct…

1e4c6d0

…ion-name

Shorten it to show_contract_fn

7bacc7d

Shorten it to show_ssa_pass

979eaa5

aakoshh enabled auto-merge January 10, 2025 15:58

aakoshh added this pull request to the merge queue Jan 10, 2025

Merged via the queue into master with commit fc5848c Jan 10, 2025
87 of 91 checks passed

aakoshh deleted the show-contract-function-name branch January 10, 2025 16:08

noirwhal mentioned this pull request Jan 10, 2025

chore: Release Noir(1.0.0-beta.2) #6914

Open

AztecBot mentioned this pull request Jan 10, 2025

feat: Sync from noir AztecProtocol/aztec-packages#11138

Merged

AztecBot mentioned this pull request Jan 11, 2025

chore(master): Release 0.70.0 AztecProtocol/aztec-packages#11107

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cli): Add CLI option to filter by contract function name #7018

feat(cli): Add CLI option to filter by contract function name #7018

aakoshh commented Jan 10, 2025 •

edited

Loading

github-actions bot commented Jan 10, 2025 •

edited

Loading

github-actions bot commented Jan 10, 2025 •

edited

Loading

github-actions bot commented Jan 10, 2025 •

edited

Loading

github-actions bot commented Jan 10, 2025 •

edited

Loading

michaeljklein left a comment

feat(cli): Add CLI option to filter by contract function name #7018

feat(cli): Add CLI option to filter by contract function name #7018

Conversation

aakoshh commented Jan 10, 2025 • edited Loading

Description

Problem*

Summary*

Additional Context

Documentation*

PR Checklist*

github-actions bot commented Jan 10, 2025 • edited Loading

Execution Report

github-actions bot commented Jan 10, 2025 • edited Loading

Compilation Report

github-actions bot commented Jan 10, 2025 • edited Loading

Execution Memory Report

github-actions bot commented Jan 10, 2025 • edited Loading

Compilation Memory Report

michaeljklein left a comment

Choose a reason for hiding this comment

aakoshh commented Jan 10, 2025 •

edited

Loading

github-actions bot commented Jan 10, 2025 •

edited

Loading

github-actions bot commented Jan 10, 2025 •

edited

Loading

github-actions bot commented Jan 10, 2025 •

edited

Loading

github-actions bot commented Jan 10, 2025 •

edited

Loading