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: BasicBlockExits should not be OpTag::DataflowParent #1409

Merged
merged 3 commits into from
Aug 9, 2024

Conversation

aborgna-q
Copy link
Collaborator

@aborgna-q aborgna-q commented Aug 8, 2024

The optags for basic blocks where defined as

graph TD
  classDef transparent fill:#0000,stroke:#0000
  a[...]:::transparent-->DataflowParent
  b[...]:::transparent-->ControlFlowChild
  DataflowParent --> BasicBlock
  ControlFlowChild --> BasicBlock
  BasicBlock --> BasicBlockExit
Loading

notice that BasicBlockExit was a descendant from DataflowParent. This caused errors on code that checked for the tag, such as the force_order pass.

This PR changes the hierarchy to

graph TD
  classDef transparent fill:#0000,stroke:#0000
  a[...]:::transparent-->DataflowParent
  b[...]:::transparent-->ControlFlowChild
  DataflowParent --> DataflowBlock
  ControlFlowChild --> BasicBlockExit
  ControlFlowChild --> DataflowBlock
Loading

Closes #1408

BREAKING CHANGE: Removed OpTag::BasicBlock, replaced with OpTag::DataflowBlock and OpTag::ControlFlowChild

@aborgna-q aborgna-q requested a review from a team as a code owner August 8, 2024 15:25
@aborgna-q aborgna-q requested a review from ss2165 August 8, 2024 15:25
Copy link
Member

@ss2165 ss2165 left a comment

Choose a reason for hiding this comment

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

what is the difference between OpTag::BasicBlock and OpTag::ControlFlowChild now? If none, less noise to just keep BasicBlock but use it how you have used DataflowBlock in this PR, updating the docstring.

Copy link

codecov bot commented Aug 8, 2024

Codecov Report

Attention: Patch coverage is 91.66667% with 1 line in your changes missing coverage. Please review.

Project coverage is 87.65%. Comparing base (3609736) to head (d5d62a9).
Report is 2 commits behind head on main.

Files Patch % Lines
hugr-core/src/ops/tag.rs 87.50% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1409      +/-   ##
==========================================
+ Coverage   87.64%   87.65%   +0.01%     
==========================================
  Files         118      118              
  Lines       20358    20394      +36     
  Branches    18040    18042       +2     
==========================================
+ Hits        17843    17877      +34     
- Misses       1724     1726       +2     
  Partials      791      791              
Flag Coverage Δ
python 91.75% <ø> (+0.03%) ⬆️
rust 87.12% <91.66%> (+<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.

@aborgna-q
Copy link
Collaborator Author

I prefer keeping the DataflowBlock name, since it distinguishes it from BasicBlockExit (otherwise it may be expected that -Exit be a child of BasicBlock).

I'll merge BasicBlock and ControlFlowChild

@aborgna-q aborgna-q requested a review from ss2165 August 8, 2024 16:11
hugr-passes/src/force_order.rs Outdated Show resolved Hide resolved
Co-authored-by: Seyon Sivarajah <seyon.sivarajah@quantinuum.com>
Copy link
Member

@ss2165 ss2165 left a comment

Choose a reason for hiding this comment

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

LGTM

@aborgna-q aborgna-q added this pull request to the merge queue Aug 9, 2024
Merged via the queue into main with commit 373fb22 Aug 9, 2024
22 checks passed
@aborgna-q aborgna-q deleted the ab/fix-dataflow-tag branch August 9, 2024 08:21
@hugrbot hugrbot mentioned this pull request Aug 9, 2024
github-merge-queue bot pushed a commit that referenced this pull request Aug 12, 2024
## 🤖 New release
* `hugr`: 0.10.0 -> 0.11.0
* `hugr-core`: 0.7.0 -> 0.8.0
* `hugr-passes`: 0.6.2 -> 0.7.0
* `hugr-cli`: 0.3.0 -> 0.4.0

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

## `hugr`
<blockquote>

## 0.11.0 (2024-08-12)

### Bug Fixes

- [**breaking**] BasicBlockExits should not be `OpTag::DataflowParent`
([#1409](#1409))

### Documentation

- Clarify CustomConst::equal_consts
([#1396](#1396))

### Features

- [**breaking**] Serialised extensions
([#1371](#1371))
- Serialised standard extensions
([#1377](#1377))
- [**breaking**] Update remaining builder methods to "infer by default"
([#1386](#1386))
- Add Eq op to logic extension
([#1398](#1398))
- Improve error message on failed custom op validation
([#1416](#1416))
- [**breaking**] `Extension` requires a version
([#1367](#1367))
</blockquote>

## `hugr-core`
<blockquote>

## 0.8.0 (2024-08-12)

### Bug Fixes

- [**breaking**] BasicBlockExits should not be `OpTag::DataflowParent`
([#1409](#1409))

### Documentation

- Clarify CustomConst::equal_consts
([#1396](#1396))

### Features

- [**breaking**] `Extension` requires a version
([#1367](#1367))
- [**breaking**] Serialised extensions
([#1371](#1371))
- Serialised standard extensions
([#1377](#1377))
- [**breaking**] Update remaining builder methods to "infer by default"
([#1386](#1386))
- Add Eq op to logic extension
([#1398](#1398))
- Improve error message on failed custom op validation
([#1416](#1416))
</blockquote>

## `hugr-passes`
<blockquote>

## 0.7.0 (2024-08-12)

### Features

- [**breaking**] `Extension` requires a version
([#1367](#1367))
</blockquote>

## `hugr-cli`
<blockquote>

## 0.4.0 (2024-08-12)

### Features

- Serialised standard extensions
([#1377](#1377))
- Validate with extra extensions and packages
([#1389](#1389))
- [**breaking**] Move mermaid to own sub-command
([#1390](#1390))
</blockquote>


</p></details>

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

---------

Co-authored-by: Craig Roy <craig.roy@cambridgequantum.com>
@hugrbot hugrbot mentioned this pull request Aug 13, 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.

BasicBlock exit nodes should not be OpTag::DataflowParents
2 participants