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.

Sign up for GitHub

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

Jump to bottom

fix: prevent Instruction::Constrains for non-primitive types #3916

Merged
merged 1 commit into from
Jan 2, 2024
Merged

fix: prevent Instruction::Constrains for non-primitive types #3916

merged 1 commit into from
Jan 2, 2024

Conversation

TomAFrench
Copy link
Member

Description

Problem*

Followup to #3740

Summary*

#3740 fixed an issue where array equalities were making their way into SSA and not having side effect predicates applied correctly by applying the predicate to each of the array elements. We actually state that we do not want array equalities in SSA (in insert_array_equality) so the fundamental issue of array equalities in SSA still exists.

We were allowing an implicit array equality to sneak into SSA by performing an optimization of Constrain(Eq(x, y), 1) into Constrain(x, y) during codegen. This meant that if x and y were arrays then we bypass the insert_array_equality function which the Eq instruction would call, which would have calculated a primitive predicate value for the constrain statement to act on.

This PR removes the extra logic from the flatten_cfg pass (while adding an assert that we're only constraining primitive values) and removes the faulty optimization from SSA codegen.

Additional Context

Documentation*

Check one:

  • No documentation needed.
  • Documentation included in this PR.
  • [Exceptional Case] 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.

@TomAFrench TomAFrench changed the title chore: prevent Instruction::Constrains for non-primitive types fix: prevent Instruction::Constrains for non-primitive types Dec 22, 2023
@github-actions GitHub Actions
Copy link
Contributor

Changes to circuit sizes

Generated at commit: 0d0630c6da20ea2870ede8310dc0a950e7c7d17c, compared to commit: 65cbb3df63155d6b54163828290f9ef4b1441b94

🧾 Summary (10% most significant diffs)

Program ACIR opcodes (+/-) % Circuit size (+/-) %
array_eq +127 ❌ +396.88% +95 ❌ +256.76%
brillig_sha256 +127 ❌ +195.38% +95 ❌ +77.87%
brillig_blake2s +127 ❌ +181.43% +95 ❌ +74.22%
Full diff report 👇
Program ACIR opcodes (+/-) % Circuit size (+/-) %
array_eq 159 (+127) +396.88% 132 (+95) +256.76%
brillig_sha256 192 (+127) +195.38% 217 (+95) +77.87%
brillig_blake2s 197 (+127) +181.43% 223 (+95) +74.22%
references 6 (+5) +500.00% 10 (+4) +66.67%
simple_2d_array 11 (+7) +175.00% 14 (+5) +55.56%
brillig_keccak 259 (+127) +96.21% 3,157 (+95) +3.10%
nested_array_dynamic 4,670 (+202) +4.52% 14,014 (+151) +1.09%
struct_inputs 75 (+38) +102.70% 2,881 (+28) +0.98%
nested_slice_dynamic 1,823 (+113) +6.61% 12,641 (+83) +0.66%
tuple_inputs 87 (+33) +61.11% 3,710 (+24) +0.65%
slice_struct_field 34,853 (+583) +1.70% 106,708 (+424) +0.40%
sha2_byte 40,515 (+382) +0.95% 154,544 (+286) +0.19%
6 197 (+127) +181.43% 38,799 (0) 0.00%
7 197 (+127) +181.43% 19,350 (0) 0.00%
conditional_regression_short_circuit 223 (+127) +132.29% 38,799 (0) 0.00%
ecdsa_secp256k1 360 (+127) +54.51% 41,049 (0) 0.00%
keccak256 203 (+127) +167.11% 54,830 (0) 0.00%
regression 283 (+19) +7.20% 4,130 (0) 0.00%
sha256 202 (+127) +169.33% 38,799 (0) 0.00%
strings 118 (+72) +156.52% 14,373 (0) 0.00%
side_effects_constrain_array 10 (-2) -16.67% 2,755 (-2) -0.07%

@TomAFrench
Copy link
Member Author

TomAFrench commented Dec 22, 2023 •
edited
Loading

We increase gate costs here as we're constraining the predicate rather than the fields composing the arrays directly but we can work backwards from the predicate to constrain the individual fields again using #3892

@TomAFrench TomAFrench mentioned this pull request Dec 22, 2023
Open
@kevaundray kevaundray added this pull request to the merge queue Jan 2, 2024
Merged via the queue into master with commit 467948f Jan 2, 2024
31 checks passed
@kevaundray kevaundray deleted the tf/fix-non-primitive-constrains branch January 2, 2024 15:53
@kevaundray kevaundray mentioned this pull request Jan 2, 2024
Merged
@TomAFrench TomAFrench mentioned this pull request Jan 3, 2024
Merged
5 tasks
@rahul-kothari rahul-kothari mentioned this pull request Jan 3, 2024
Closed
TomAFrench added a commit that referenced this pull request Jan 3, 2024
@TomAFrench
Merge branch 'master' into tf/function-exports
7d782f2 
* master: (48 commits)
  chore: fix broken links (#3935)
  chore: updated ACIR documentation and other docs (#3932)
  chore: rename "syntax" chapter in docs to "concepts" (#3934)
  fix: checks for cyclic dependencies (#3699)
  fix(debugger): crash when stepping through locations spanning multiple lines (#3920)
  chore: abstract away subtractions from `OR` implementation (#3923)
  chore: fix `should_fail_mismatch` test to use correct pedersen return type (#3927)
  fix: prevent `Instruction::Constrain`s for non-primitive types (#3916)
  feat: remove unnecessary predicate from `Lt` instruction (#3922)
  feat: simplify multiplications by `0` or `1` in ACIR gen (#3924)
  chore: bump dependency versions (#3925)
  chore: Update CONTRIBUTING.md (#3921)
  chore: Optimize goto_definitions for workspace case (#3914)
  chore: Update index.md (#3911)
  chore: Update index.md (#3910)
  chore: Update how-to-recursion.md (#3912)
  feat: Resolve oracle calls via JSON-RPC (#3902)
  chore: Update explainer-recursion.md (#3906)
  chore: remove unnecessary dependency (#3901)
  chore: improve package.json metadata (#3900)
  ...
github-merge-queue bot pushed a commit that referenced this pull request Jan 3, 2024
@TomAFrench
chore: add test case for brillig array equality assertion (#3936)
64c144a 
# Description

## Problem\*

Resolves AztecProtocol/aztec-packages#3752

## Summary\*

This PR adds a regression test for
AztecProtocol/aztec-packages#3752 which was
fixed in #3916.

## Additional Context

## Documentation\*

Check one:
- [x] No documentation needed.
- [ ] Documentation included in this PR.
- [ ] **[Exceptional Case]** Documentation to be submitted in a separate
PR.

# PR Checklist\*

- [x] I have tested the changes locally.
- [x] I have formatted the changes with [Prettier](https://prettier.io/)
and/or `cargo fmt` on default settings.
TomAFrench added a commit that referenced this pull request Jan 4, 2024
@TomAFrench
Merge branch 'master' into tf/ne-method
3ae7cfa 
* master: (30 commits)
  fix: handle multiple imports in the same file (#3903)
  feat: add foreign call support to `noir_codegen` functions (#3933)
  feat: Implement Operator Overloading (#3931)
  chore: fix casing on `InternalError::Unexpected` (#3937)
  chore: add test case for brillig array equality assertion (#3936)
  feat(lsp): goto struct member inside Impl method (#3918)
  chore: fix broken links (#3935)
  chore: updated ACIR documentation and other docs (#3932)
  chore: rename "syntax" chapter in docs to "concepts" (#3934)
  fix: checks for cyclic dependencies (#3699)
  fix(debugger): crash when stepping through locations spanning multiple lines (#3920)
  chore: abstract away subtractions from `OR` implementation (#3923)
  chore: fix `should_fail_mismatch` test to use correct pedersen return type (#3927)
  fix: prevent `Instruction::Constrain`s for non-primitive types (#3916)
  feat: remove unnecessary predicate from `Lt` instruction (#3922)
  feat: simplify multiplications by `0` or `1` in ACIR gen (#3924)
  chore: bump dependency versions (#3925)
  chore: Update CONTRIBUTING.md (#3921)
  chore: Optimize goto_definitions for workspace case (#3914)
  chore: Update index.md (#3911)
  ...
@TomAFrench TomAFrench mentioned this pull request Jan 18, 2024
Merged
5 tasks
github-merge-queue bot pushed a commit that referenced this pull request Jan 18, 2024
@TomAFrench
chore: remove concept of constraining non-primitive types from acir-g…
43ff613 
…en (#4085)

# Description

## Problem\*

Followup to #3916

## Summary\*

`Instruction::Constrain` is now only defined for primitive types so we
don't require handling for array equalities in ACIR-gen as this should
be decomposed in SSA.

## Additional Context



## Documentation\*

Check one:
- [x] No documentation needed.
- [ ] Documentation included in this PR.
- [ ] **[Exceptional Case]** Documentation to be submitted in a separate
PR.

# PR Checklist\*

- [x] I have tested the changes locally.
- [x] I have formatted the changes with [Prettier](https://prettier.io/)
and/or `cargo fmt` on default settings.
github-merge-queue bot pushed a commit that referenced this pull request Jan 22, 2024
@kevaundray @TomAFrench
chore: Release Noir(0.23.0) (#3862)
5be9f9d 
🤖 I have created a release *beep* *boop*
---


<details><summary>0.23.0</summary>

## [0.23.0](v0.22.0...v0.23.0)
(2024-01-22)


### ⚠ BREAKING CHANGES

* Ban nested slices
([#4018](#4018))
* Breaking changes from aztec-packages
([#3955](#3955))
* Rename Arithmetic opcode to AssertZero
([#3840](#3840))
* remove circuit methods from noir_wasm
([#3869](#3869))

### Features

* Add `assert_max_bit_size` method to `Field`
([#4016](#4016))
([bc9a44f](bc9a44f))
* Add `noir-compiler` checks to `aztec_macros`
([#4031](#4031))
([420a5c7](420a5c7))
* Add a `--force` flag to force a full recompile
([#4054](#4054))
([27a8e68](27a8e68))
* Add dependency resolver for `noir_wasm` and implement `FileManager`
for consistency with native interface
([#3891](#3891))
([c29c7d7](c29c7d7))
* Add foreign call support to `noir_codegen` functions
([#3933](#3933))
([e5e52a8](e5e52a8))
* Add MVP `nargo export` command
([#3870](#3870))
([fbb51ed](fbb51ed))
* Add support for codegenning multiple functions which use the same
structs in their interface
([#3868](#3868))
([1dcfcc5](1dcfcc5))
* Added efficient field comparisons for bn254
([#4042](#4042))
([1f9cad0](1f9cad0))
* Assert maximum bit size when creating a U128 from an integer
([#4024](#4024))
([8f9c7e4](8f9c7e4))
* Avoid unnecessary range checks by inspecting instructions for casts
([#4039](#4039))
([378c18e](378c18e))
* Breaking changes from aztec-packages
([#3955](#3955))
([5be049e](5be049e))
* Bubble up `Instruction::Constrain`s to be applied as early as
possible. ([#4065](#4065))
([66f5cdd](66f5cdd))
* Cached LSP parsing
([#4083](#4083))
([b4f724e](b4f724e))
* Comparison for signed integers
([#3873](#3873))
([bcbd49b](bcbd49b))
* Decompose `Instruction::Cast` to have an explicit truncation
instruction ([#3946](#3946))
([35f18ef](35f18ef))
* Decompose `Instruction::Constrain` into multiple more basic
constraints ([#3892](#3892))
([51cf9d3](51cf9d3))
* Docker testing flow
([#3895](#3895))
([179c90d](179c90d))
* Extract parsing to its own pass and do it in parallel
([#4063](#4063))
([569cbbc](569cbbc))
* Implement `Eq` trait on curve points
([#3944](#3944))
([abf751a](abf751a))
* Implement DAP protocol in Nargo
([#3627](#3627))
([13834d4](13834d4))
* Implement generic traits
([#4000](#4000))
([916fd15](916fd15))
* Implement Operator Overloading
([#3931](#3931))
([4b16090](4b16090))
* **lsp:** Cache definitions for goto requests
([#3930](#3930))
([4a2140f](4a2140f))
* **lsp:** Goto global
([#4043](#4043))
([15237b3](15237b3))
* **lsp:** Goto struct member inside Impl method
([#3918](#3918))
([99c2c5a](99c2c5a))
* **lsp:** Goto trait from trait impl
([#3956](#3956))
([eb566e2](eb566e2))
* **lsp:** Goto trait method declaration
([#3991](#3991))
([eb79166](eb79166))
* **lsp:** Goto type alias
([#4061](#4061))
([dc83385](dc83385))
* **lsp:** Goto type definition
([#4029](#4029))
([8bb4ddf](8bb4ddf))
* **lsp:** Re-add code lens feature with improved performance
([#3829](#3829))
([8f5cd6c](8f5cd6c))
* Optimize array ops for arrays of structs
([#4027](#4027))
([c9ec0d8](c9ec0d8))
* Optimize logic gate ACIR-gen
([#3897](#3897))
([926460a](926460a))
* Prefer `AcirContext`-native methods for performing logic operations
([#3898](#3898))
([0ec39b8](0ec39b8))
* Remove range constraints from witnesses which are constrained to be
constants ([#3928](#3928))
([afe9c7a](afe9c7a))
* Remove truncation from brillig casts
([#3997](#3997))
([857ff97](857ff97))
* Remove truncations which can be seen to be noops using type
information ([#3953](#3953))
([cc3c2c2](cc3c2c2))
* Remove unnecessary predicate from `Lt` instruction
([#3922](#3922))
([a63433f](a63433f))
* Simplify chains of casts to be all in terms of the original `ValueId`
([#3984](#3984))
([2384d3e](2384d3e))
* Simplify multiplications by `0` or `1` in ACIR gen
([#3924](#3924))
([e58844d](e58844d))
* Support for u128
([#3913](#3913))
([b4911dc](b4911dc))
* Support printing more types
([#4071](#4071))
([f5c4632](f5c4632))
* Sync `aztec-packages`
([#4011](#4011))
([fee2452](fee2452))
* Sync commits from `aztec-packages`
([#4068](#4068))
([7a8f3a3](7a8f3a3))
* Use singleton `WasmBlackBoxFunctionSolver` in `noir_js`
([#3966](#3966))
([10b28de](10b28de))


### Bug Fixes

* Acir gen doesn't panic on unsupported BB function
([#3866](#3866))
([34fd978](34fd978))
* Allow abi encoding arrays of structs from JS
([#3867](#3867))
([9b713f8](9b713f8))
* Allow abi encoding tuples from JS
([#3894](#3894))
([f7fa181](f7fa181))
* Allow ast when macro errors
([#4005](#4005))
([efccec3](efccec3))
* Allow lsp to run inside of a docker container
([#3876](#3876))
([2529977](2529977))
* Bit-shifts for signed integers
([#3890](#3890))
([6ddd98a](6ddd98a))
* Checks for cyclic dependencies
([#3699](#3699))
([642011a](642011a))
* **debugger:** Crash when stepping through locations spanning multiple
lines ([#3920](#3920))
([223e860](223e860))
* Don't fail if no tests and the user didn't provide a pattern
([#3864](#3864))
([decbd0f](decbd0f))
* Fix advisory issue in cargo-deny
([#4077](#4077))
([19baea0](19baea0))
* Fixing dark mode background on the CTA button
([#3882](#3882))
([57eae42](57eae42))
* Fixup exports from `noir_wasm`
([#4022](#4022))
([358cdd2](358cdd2))
* Handle multiple imports in the same file
([#3903](#3903))
([219423e](219423e))
* Hoist constraints on inputs to top of program
([#4076](#4076))
([447aa34](447aa34))
* Implement missing codegen for `BlackBoxFunc::EcdsaSecp256r1` in
brillig ([#3943](#3943))
([2c5eceb](2c5eceb))
* Improve `nargo test` output
([#3973](#3973))
([3ab5ff4](3ab5ff4))
* Make `constant_to_radix` emit a slice instead of an array
([#4049](#4049))
([5cdb1d0](5cdb1d0))
* Operator overloading & static trait method references resolving to
generic impls ([#3967](#3967))
([f1de8fa](f1de8fa))
* Preserve brillig entrypoint functions without arguments
([#3951](#3951))
([1111465](1111465))
* Prevent `Instruction::Constrain`s for non-primitive types
([#3916](#3916))
([467948f](467948f))
* Remove panic for adding an invalid crate name in wasm compiler
([#3977](#3977))
([7a1baa5](7a1baa5))
* Return error rather instead of panicking on invalid circuit
([#3976](#3976))
([67201bf](67201bf))
* Search all levels of struct nesting before codegenning primitive types
([#3970](#3970))
([13ae014](13ae014))
* Update generics docs to mention we have traits now
([#3980](#3980))
([c2acdf1](c2acdf1))


### Miscellaneous Chores

* Ban nested slices
([#4018](#4018))
([f8a1fb7](f8a1fb7))
* Remove circuit methods from noir_wasm
([#3869](#3869))
([12d884e](12d884e))
* Rename Arithmetic opcode to AssertZero
([#3840](#3840))
([836f171](836f171))
</details>

<details><summary>0.39.0</summary>

## [0.39.0](v0.38.0...v0.39.0)
(2024-01-22)


### ⚠ BREAKING CHANGES

* Breaking changes from aztec-packages
([#3955](#3955))
* Rename Arithmetic opcode to AssertZero
([#3840](#3840))
* Remove unused methods on ACIR opcodes
([#3841](#3841))
* Remove partial backend feature
([#3805](#3805))

### Features

* Aztec-packages
([#3754](#3754))
([c043265](c043265))
* Breaking changes from aztec-packages
([#3955](#3955))
([5be049e](5be049e))
* Remove range constraints from witnesses which are constrained to be
constants ([#3928](#3928))
([afe9c7a](afe9c7a))
* Speed up transformation of debug messages
([#3815](#3815))
([2a8af1e](2a8af1e))
* Sync `aztec-packages`
([#4011](#4011))
([fee2452](fee2452))
* Sync commits from `aztec-packages`
([#4068](#4068))
([7a8f3a3](7a8f3a3))


### Bug Fixes

* Deserialize odd length hex literals
([#3747](#3747))
([4000fb2](4000fb2))
* Return error rather instead of panicking on invalid circuit
([#3976](#3976))
([67201bf](67201bf))


### Miscellaneous Chores

* Remove partial backend feature
([#3805](#3805))
([0383100](0383100))
* Remove unused methods on ACIR opcodes
([#3841](#3841))
([9e5d0e8](9e5d0e8))
* Rename Arithmetic opcode to AssertZero
([#3840](#3840))
([836f171](836f171))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

---------

Co-authored-by: TomAFrench <tom@tomfren.ch>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vezenovm vezenovm vezenovm approved these changes

@jfecher jfecher jfecher approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@TomAFrench @jfecher @vezenovm @kevaundray