feat!: DeadCodeElimPass reports error on non-existent entry_points #2566

acl-cqc · 2025-09-18T15:12:50Z

At the moment (before and after #2560) it turns out they were silently dropped.

This requires changing the error type of DeadCodeElimPass from Infallible, hence breakage is unavoidable.

Might this be a good time to change with_entry_points to, oh, with_start_points or something that reduces confusion with HugrView::entrypoint?? Happy to do that renaming here although haven't done so atm.

BREAKING CHANGE: DeadCodeElimPass's implementation of ComposablePass now returns an error (not Infallible)

codecov · 2025-09-18T15:17:46Z

Codecov Report

❌ Patch coverage is 91.42857% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 82.95%. Comparing base (de16553) to head (edba373).
⚠️ Report is 15 commits behind head on main.

Files with missing lines	Patch %	Lines
hugr-passes/src/const_fold.rs	0.00%	2 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2566      +/-   ##
==========================================
+ Coverage   82.86%   82.95%   +0.08%     
==========================================
  Files         254      254              
  Lines       47694    47919     +225     
  Branches    43205    43430     +225     
==========================================
+ Hits        39524    39753     +229     
+ Misses       6107     6106       -1     
+ Partials     2063     2060       -3

Flag	Coverage Δ
python	`91.42% <ø> (ø)`
rust	`82.08% <91.42%> (+0.10%)`	⬆️

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.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

aborgna-q

👍

I'm fine with the renaming, but not necessary for merging

aborgna-q · 2025-09-29T12:45:03Z

hugr-passes/src/dead_code.rs

    /// Mark some nodes as entry points to the Hugr, i.e. so we cannot eliminate any code
    /// used to evaluate these nodes.
    /// [`HugrView::entrypoint`] is assumed to be an entry point;
    /// for Module roots the client will want to mark some of the `FuncDefn` children
    /// as entry points too.
    pub fn with_entry_points(mut self, entry_points: impl IntoIterator<Item = H::Node>) -> Self {


Yeah, with_start_points may be a bit clearer in the callsites.
And we can avoid this comment...

[HugrView::entrypoint] is assumed to be an entry point

## 🤖 New release * `hugr-model`: 0.22.4 -> 0.23.0 (✓ API compatible changes) * `hugr-core`: 0.22.4 -> 0.23.0 (⚠ API breaking changes) * `hugr-llvm`: 0.22.4 -> 0.23.0 (✓ API compatible changes) * `hugr-passes`: 0.22.4 -> 0.23.0 (⚠ API breaking changes) * `hugr-persistent`: 0.2.3 -> 0.3.0 (✓ API compatible changes) * `hugr`: 0.22.4 -> 0.23.0 (✓ API compatible changes) * `hugr-cli`: 0.22.4 -> 0.23.0 (✓ API compatible changes) ### ⚠ `hugr-core` breaking changes ```text --- failure enum_variant_missing: pub enum variant removed or renamed --- Description: A publicly-visible enum has at least one variant that is no longer available under its prior name. It may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.43.0/src/lints/enum_variant_missing.ron Failed in: variant PackageEncodingError::ExtensionVersion, previously in file /tmp/.tmp8eoQo1/hugr-core/src/envelope/package_json.rs:89 --- failure function_parameter_count_changed: pub fn parameter count changed --- Description: A publicly-visible function now takes a different number of parameters. ref: https://doc.rust-lang.org/cargo/reference/semver.html#fn-change-arity impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.43.0/src/lints/function_parameter_count_changed.ron Failed in: hugr_core::import::import_package now takes 3 parameters instead of 2, in /tmp/.tmpBTXSed/hugr/hugr-core/src/import.rs:187 --- failure struct_missing: pub struct removed or renamed --- Description: A publicly-visible struct cannot be imported by its prior path. A `pub use` may have been removed, or the struct itself may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.43.0/src/lints/struct_missing.ron Failed in: struct hugr_core::extension::prelude::PRELUDE_REGISTRY, previously in file /tmp/.tmp8eoQo1/hugr-core/src/extension/prelude.rs:43 struct hugr_core::extension::PRELUDE_REGISTRY, previously in file /tmp/.tmp8eoQo1/hugr-core/src/extension/prelude.rs:43 struct hugr_core::std_extensions::logic::EXTENSION, previously in file /tmp/.tmp8eoQo1/hugr-core/src/std_extensions/logic.rs:134 struct hugr_core::extension::prelude::PRELUDE, previously in file /tmp/.tmp8eoQo1/hugr-core/src/extension/prelude.rs:43 struct hugr_core::extension::PRELUDE, previously in file /tmp/.tmp8eoQo1/hugr-core/src/extension/prelude.rs:43 struct hugr_core::std_extensions::ptr::EXTENSION, previously in file /tmp/.tmp8eoQo1/hugr-core/src/std_extensions/ptr.rs:112 struct hugr_core::std_extensions::arithmetic::int_types::EXTENSION, previously in file /tmp/.tmp8eoQo1/hugr-core/src/std_extensions/arithmetic/int_types.rs:209 struct hugr_core::std_extensions::arithmetic::conversions::EXTENSION, previously in file /tmp/.tmp8eoQo1/hugr-core/src/std_extensions/arithmetic/conversions.rs:174 struct hugr_core::std_extensions::collections::array::EXTENSION, previously in file /tmp/.tmp8eoQo1/hugr-core/src/std_extensions/collections/array.rs:93 struct hugr_core::std_extensions::arithmetic::int_types::INT_TYPES, previously in file /tmp/.tmp8eoQo1/hugr-core/src/std_extensions/arithmetic/int_types.rs:49 struct hugr_core::std_extensions::arithmetic::float_types::EXTENSION, previously in file /tmp/.tmp8eoQo1/hugr-core/src/std_extensions/arithmetic/float_types.rs:104 struct hugr_core::std_extensions::collections::static_array::EXTENSION, previously in file /tmp/.tmp8eoQo1/hugr-core/src/std_extensions/collections/static_array.rs:142 struct hugr_core::std_extensions::collections::list::EXTENSION, previously in file /tmp/.tmp8eoQo1/hugr-core/src/std_extensions/collections/list.rs:289 struct hugr_core::std_extensions::STD_REG, previously in file /tmp/.tmp8eoQo1/hugr-core/src/std_extensions.rs:35 struct hugr_core::std_extensions::collections::value_array::EXTENSION, previously in file /tmp/.tmp8eoQo1/hugr-core/src/std_extensions/collections/value_array.rs:99 struct hugr_core::std_extensions::collections::borrow_array::EXTENSION, previously in file /tmp/.tmp8eoQo1/hugr-core/src/std_extensions/collections/borrow_array.rs:290 struct hugr_core::std_extensions::arithmetic::float_ops::EXTENSION, previously in file /tmp/.tmp8eoQo1/hugr-core/src/std_extensions/arithmetic/float_ops.rs:115 struct hugr_core::std_extensions::arithmetic::int_ops::EXTENSION, previously in file /tmp/.tmp8eoQo1/hugr-core/src/std_extensions/arithmetic/int_ops.rs:254 ``` ### ⚠ `hugr-passes` breaking changes ```text --- failure enum_missing: pub enum removed or renamed --- Description: A publicly-visible enum cannot be imported by its prior path. A `pub use` may have been removed, or the enum itself may have been renamed or removed entirely. ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.43.0/src/lints/enum_missing.ron Failed in: enum hugr_passes::non_local::NonLocalEdgesError, previously in file /tmp/.tmp8eoQo1/hugr-passes/src/non_local.rs:57 ``` <details><summary>Changelog</summary> ## `hugr-model` <blockquote> ## [0.23.0](hugr-model-v0.22.4...hugr-model-v0.23.0) - 2025-09-30 ### Bug Fixes - [**breaking**] Appease `cargo-audit` by replacing unmaintained dependencies ([#2572](#2572)) ### New Features - Documentation and error hints ([#2523](#2523)) </blockquote> ## `hugr-core` <blockquote> ## [0.23.0](hugr-core-v0.22.4...hugr-core-v0.23.0) - 2025-09-30 ### Bug Fixes - [**breaking**] Appease `cargo-audit` by replacing unmaintained dependencies ([#2572](#2572)) - *(core)* check extension versions on model import ([#2580](#2580)) - [**breaking**] test extension version compatibility on ModelWithExts ([#2587](#2587)) - *(core)* check used extension versions against resolved extensions ([#2588](#2588)) - [**breaking**] model import loads Package extensions ([#2590](#2590)) ### Miscellaneous Tasks - [**breaking**] Cleanup deprecated definitions ([#2594](#2594)) ### New Features - add trait+funcs for linking Hugrs explicitly by Node ([#2521](#2521)) - Documentation and error hints ([#2523](#2523)) - Allow creating DFG builders from existing hugrs ([#2562](#2562)) - add_input/output for arbitrary DFGBuilders ([#2564](#2564)) - [**breaking**] Return error instead of panicking in DFGWrapper::add_{in,out}put ([#2571](#2571)) - *(core)* inner acccesors for WithGenerator error ([#2583](#2583)) - Normalize CFGs ([#2591](#2591)) ### Refactor - [**breaking**] Replace lazy_static with std::sync::LazyLock ([#2567](#2567)) </blockquote> ## `hugr-llvm` <blockquote> ## [0.23.0](hugr-llvm-v0.22.4...hugr-llvm-v0.23.0) - 2025-09-30 ### Miscellaneous Tasks - [**breaking**] Cleanup deprecated definitions ([#2594](#2594)) ### Refactor - [**breaking**] Replace lazy_static with std::sync::LazyLock ([#2567](#2567)) ### Testing - Add framework for LLVM execution tests involving panics ([#2568](#2568)) </blockquote> ## `hugr-passes` <blockquote> ## [0.23.0](hugr-passes-v0.22.4...hugr-passes-v0.23.0) - 2025-09-30 ### Bug Fixes - DeadCodeElim keeps consumers of linear outputs ([#2560](#2560)) - [**breaking**] Appease `cargo-audit` by replacing unmaintained dependencies ([#2572](#2572)) ### Miscellaneous Tasks - [**breaking**] Cleanup deprecated definitions ([#2594](#2594)) ### New Features - [**breaking**] DeadCodeElimPass reports error on non-existent entry_points ([#2566](#2566)) - Normalize CFGs ([#2591](#2591)) ### Refactor - [**breaking**] Replace lazy_static with std::sync::LazyLock ([#2567](#2567)) </blockquote> ## `hugr-persistent` <blockquote> ## [0.3.0](hugr-persistent-v0.2.3...hugr-persistent-v0.3.0) - 2025-09-30 ### Miscellaneous Tasks - [**breaking**] Cleanup deprecated definitions ([#2594](#2594)) ### Refactor - [**breaking**] Replace lazy_static with std::sync::LazyLock ([#2567](#2567)) </blockquote> ## `hugr` <blockquote> ## [0.23.0](hugr-v0.22.4...hugr-v0.23.0) - 2025-09-30 ### Bug Fixes - DeadCodeElim keeps consumers of linear outputs ([#2560](#2560)) - [**breaking**] Appease `cargo-audit` by replacing unmaintained dependencies ([#2572](#2572)) - *(core)* check extension versions on model import ([#2580](#2580)) - [**breaking**] test extension version compatibility on ModelWithExts ([#2587](#2587)) - *(core)* check used extension versions against resolved extensions ([#2588](#2588)) - [**breaking**] model import loads Package extensions ([#2590](#2590)) ### Miscellaneous Tasks - [**breaking**] Cleanup deprecated definitions ([#2594](#2594)) ### New Features - [**breaking**] DeadCodeElimPass reports error on non-existent entry_points ([#2566](#2566)) - add trait+funcs for linking Hugrs explicitly by Node ([#2521](#2521)) - Documentation and error hints ([#2523](#2523)) - Allow creating DFG builders from existing hugrs ([#2562](#2562)) - add_input/output for arbitrary DFGBuilders ([#2564](#2564)) - [**breaking**] Return error instead of panicking in DFGWrapper::add_{in,out}put ([#2571](#2571)) - *(core)* inner acccesors for WithGenerator error ([#2583](#2583)) - Normalize CFGs ([#2591](#2591)) ### Refactor - [**breaking**] Replace lazy_static with std::sync::LazyLock ([#2567](#2567)) </blockquote> ## `hugr-cli` <blockquote> ## [0.22.3](hugr-cli-v0.22.2...hugr-cli-v0.22.3) - 2025-09-11 ### New Features - *(hugr-cli)* CliError::validate helper ([#2507](#2507)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/).

acl-cqc added 2 commits September 18, 2025 16:10

(BREAKING) Give DeadCodeElim an error type

5cb6dd6

improve tests

89fcc0f

acl-cqc added the wait to merge label Sep 18, 2025

acl-cqc changed the title ~~feat! DeadCodeElimPass reports error on non-existent entry_points~~ feat!: DeadCodeElimPass reports error on non-existent entry_points Sep 18, 2025

Suppress my dislke of clippy

edba373

acl-cqc requested a review from aborgna-q September 23, 2025 09:20

acl-cqc marked this pull request as ready for review September 24, 2025 12:15

acl-cqc requested a review from a team as a code owner September 24, 2025 12:15

acl-cqc removed the wait to merge label Sep 26, 2025

aborgna-q approved these changes Sep 29, 2025

View reviewed changes

acl-cqc added this pull request to the merge queue Sep 29, 2025

Merged via the queue into main with commit 7dfbbbd Sep 29, 2025
27 checks passed

acl-cqc deleted the acl/dce_error branch September 29, 2025 20:05

hugrbot mentioned this pull request Sep 29, 2025

chore: release #2554

Merged

hugrbot mentioned this pull request Oct 1, 2025

chore: release #2605

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat!: DeadCodeElimPass reports error on non-existent entry_points #2566

feat!: DeadCodeElimPass reports error on non-existent entry_points #2566

Uh oh!

acl-cqc commented Sep 18, 2025 •

edited

Loading

Uh oh!

codecov bot commented Sep 18, 2025 •

edited

Loading

Uh oh!

aborgna-q left a comment

Uh oh!

aborgna-q Sep 29, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat!: DeadCodeElimPass reports error on non-existent entry_points #2566

feat!: DeadCodeElimPass reports error on non-existent entry_points #2566

Uh oh!

Conversation

acl-cqc commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

aborgna-q left a comment

Choose a reason for hiding this comment

Uh oh!

aborgna-q Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

acl-cqc commented Sep 18, 2025 •

edited

Loading

codecov bot commented Sep 18, 2025 •

edited

Loading