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: cfg not validating entry/exit types #1229

Merged
merged 1 commit into from
Jun 27, 2024
Merged

fix: cfg not validating entry/exit types #1229

merged 1 commit into from
Jun 27, 2024

Conversation

ss2165
Copy link
Member

@ss2165 ss2165 commented Jun 26, 2024

Closes #1189

Failing example generated using hugr-py

Closes #1189

Failing example generated using hugr-py
@ss2165 ss2165 requested a review from a team as a code owner June 26, 2024 17:25
@ss2165 ss2165 requested a review from doug-q June 26, 2024 17:25
@@ -926,6 +929,13 @@ fn cfg_children_restrictions() {
b.remove_node(exit2);

// Change the types in the BasicBlock node to work on qubits instead of bits
b.replace_op(
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this test failed because it was getting away with not updating the cfg op beforehand

Copy link

codecov bot commented Jun 26, 2024

Codecov Report

Attention: Patch coverage is 84.00000% with 8 lines in your changes missing coverage. Please review.

Project coverage is 86.98%. Comparing base (70e0b87) to head (9048c8b).

Files Patch % Lines
hugr-core/src/ops/validate.rs 76.66% 7 Missing ⚠️
hugr-core/src/hugr/validate/test.rs 95.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1229      +/-   ##
==========================================
- Coverage   86.99%   86.98%   -0.01%     
==========================================
  Files         100      100              
  Lines       18975    19023      +48     
  Branches    16992    17040      +48     
==========================================
+ Hits        16508    16548      +40     
- Misses       1689     1697       +8     
  Partials      778      778              
Flag Coverage Δ
rust 86.47% <84.00%> (-0.01%) ⬇️

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.

Copy link
Collaborator

@doug-q doug-q left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! I have a couple of minor suggestions, but happy to approve as is.

@@ -989,6 +999,23 @@ fn cfg_connections() -> Result<(), Box<dyn std::error::Error>> {
Ok(())
}

#[test]
fn cfg_entry_io_bug() -> Result<(), Box<dyn std::error::Error>> {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we get better error messages on failure if we return () and unwrap instead of ?ing in the test. I don't see any uses of ? anyway.

.expect("Child check should have already checked valid ops.");

let sig = self.signature();
if entry_op.inner_signature().input() != sig.input() {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be helpful to add a comment that we only have to check entry and exit nodes here because internal control flow edges are validated by validate_cfg_edge.

@doug-q
Copy link
Collaborator

doug-q commented Jun 27, 2024

I've also double checked that Conditional, TailLoop, and DFG do not have the same problem.

@ss2165 ss2165 added this pull request to the merge queue Jun 27, 2024
Merged via the queue into main with commit c21753d Jun 27, 2024
20 checks passed
@ss2165 ss2165 deleted the ss/cfg-fix branch June 27, 2024 08:40
This was referenced Jun 26, 2024
github-merge-queue bot pushed a commit that referenced this pull request Jul 1, 2024
## 🤖 New release
* `hugr`: 0.5.1 -> 0.6.0
* `hugr-core`: 0.2.0 -> 0.3.0
* `hugr-passes`: 0.2.0 -> 0.3.0
* `hugr-cli`: 0.1.1 -> 0.1.2

<details><summary><i><b>Changelog</b></i></summary><p>

## `hugr`
<blockquote>

## 0.6.0 (2024-06-28)

### Bug Fixes

- SimpleReplacement panic on multiports
([#1191](#1191))
- Add some validation for const nodes
([#1222](#1222))
- Cfg not validating entry/exit types
([#1229](#1229))
- `extract_hugr` not removing root node ports
([#1239](#1239))

### Documentation

- Fix documentation of `ValidationError::ConstTypeError`
([#1227](#1227))

### Features

- CircuitBuilder::add_constant
([#1168](#1168))
- [**breaking**] Make the rewrite errors more useful
([#1174](#1174))
- [**breaking**] Validate Extensions using hierarchy, ignore
input_extensions, RIP inference
([#1142](#1142))
- [**breaking**] Infer extension deltas for Case, Cfg, Conditional,
DataflowBlock, Dfg, TailLoop
([#1195](#1195))
- Helper functions for requesting inference, use with builder in tests
([#1219](#1219))

### Refactor

- [**breaking**] FunctionBuilder takes impl Into<PolyFuncType>
([#1220](#1220))
- [**breaking**] Remove NodeType and input_extensions
([#1183](#1183))
</blockquote>

## `hugr-core`
<blockquote>

## 0.3.0 (2024-06-28)

### Bug Fixes

- SimpleReplacement panic on multiports
([#1191](#1191))
- Add some validation for const nodes
([#1222](#1222))
- Cfg not validating entry/exit types
([#1229](#1229))
- `extract_hugr` not removing root node ports
([#1239](#1239))

### Documentation

- Fix documentation of `ValidationError::ConstTypeError`
([#1227](#1227))

### Features

- CircuitBuilder::add_constant
([#1168](#1168))
- [**breaking**] Make the rewrite errors more useful
([#1174](#1174))
- [**breaking**] Validate Extensions using hierarchy, ignore
input_extensions, RIP inference
([#1142](#1142))
- [**breaking**] Infer extension deltas for Case, Cfg, Conditional,
DataflowBlock, Dfg, TailLoop
([#1195](#1195))
- Helper functions for requesting inference, use with builder in tests
([#1219](#1219))

### Refactor

- [**breaking**] Remove NodeType and input_extensions
([#1183](#1183))
- [**breaking**] FunctionBuilder takes impl Into<PolyFuncType>
([#1220](#1220))
</blockquote>

## `hugr-passes`
<blockquote>

## 0.3.0 (2024-06-28)

### Features

- [**breaking**] Validate Extensions using hierarchy, ignore
input_extensions, RIP inference
([#1142](#1142))
- Helper functions for requesting inference, use with builder in tests
([#1219](#1219))

</blockquote>

## `hugr-cli`
<blockquote>

## 0.1.1 (2024-06-07)

### Features

- Reexport `clap::Parser` and `clap_verbosity_flag::Level` from hugr_cli
([#1146](#1146))

### Refactor

- Move binary to hugr-cli
([#1134](#1134))
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/MarcoIeni/release-plz/).

---------

Co-authored-by: Douglas Wilson <[email protected]>
@hugrbot hugrbot mentioned this pull request Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CFG nodes do not fail validation when their input ports do not match the input node of the entry block
2 participants