Skip to content

feat: Define pass application scopes #2772

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

Open
aborgna-q wants to merge 8 commits into
base: main
Choose a base branch
from
Open

feat: Define pass application scopes #2772

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
1f05f19
feat: Define pass application scopes
aborgna-q Dec 19, 2025
aba6477
Stub implementation for all passes
aborgna-q Dec 19, 2025
3e0c6ac
Python definition for PassScope
aborgna-q Dec 19, 2025
02d2886
Add default with_scope impl, make this non-breaking
aborgna-q Dec 22, 2025
e3a63b4
Move scope to a submodule of ::composable
aborgna-q Dec 22, 2025
0b730bf
wip
acl-cqc Jan 23, 2026
e71125c
All=>Preserve (make global), add PreserveEntrypoint, enum InScope
acl-cqc Jan 23, 2026
11a643e
docs, re-export InScope
acl-cqc Jan 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions hugr-passes/src/composable.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
//! Compiler passes and utilities for composing them

mod scope;

pub use scope::{InScope, PassScope};

use std::{error::Error, marker::PhantomData};

use hugr_core::core::HugrNode;
Expand All @@ -17,6 +21,26 @@ pub trait ComposablePass<H: HugrMut>: Sized {
/// Run the pass on the given HUGR.
fn run(&self, hugr: &mut H) -> Result<Self::Result, Self::Error>;

/// Set the scope configuration used to run the pass.
///
/// See [`PassScope`] for more details.
///
/// In `hugr 0.25.*`, this configuration is only a guidance, and may be
/// ignored by the pass by using the default implementation.
///
/// From `hugr >=0.26.0`, passes must respect the scope configuration.
Copy link
Contributor

@acl-cqc acl-cqc Dec 22, 2025

Choose a reason for hiding this comment

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

Yeah, I'm really unsure about this, see main discussion/reply

//
// For hugr passes, this is tracked by <https://github.com/Quantinuum/hugr/issues/2771>
fn with_scope(self, scope: &PassScope) -> Self {
// Currently passes are not required to respect the scope configuration.
// <https://github.com/Quantinuum/hugr/issues/2771>
//
// deprecated: Remove default implementation in hugr 0.26.0,
// ensure all passes follow the scope configuration.
let _ = scope;
self
}

/// Apply a function to the error type of this pass, returning a new
/// [`ComposablePass`] that has the same result type.
fn map_err<E2: Error>(
Expand All @@ -28,6 +52,10 @@ pub trait ComposablePass<H: HugrMut>: Sized {

/// Returns a [`ComposablePass`] that does "`self` then `other`", so long as
/// `other::Err` can be combined with ours.
///
/// Composed passes may have different configured [`PassScope`]s. Use
/// [`ComposablePass::with_scope`] after the composition to override all the
/// scope configurations if needed.
fn then<P: ComposablePass<H>, E: ErrorCombiner<Self::Error, P::Error>>(
self,
other: P,
Expand All @@ -48,6 +76,14 @@ pub trait ComposablePass<H: HugrMut>: Sized {
let res2 = self.1.run(hugr).map_err(E::from_second)?;
Ok((res1, res2))
}

fn with_scope(self, scope: &PassScope) -> Self {
Self(
self.0.with_scope(scope),
self.1.with_scope(scope),
PhantomData,
)
}
}

Sequence(self, other, PhantomData)
Expand Down Expand Up @@ -110,6 +146,10 @@ impl<P: ComposablePass<H>, H: HugrMut, E: Error, F: Fn(P::Error) -> E> Composabl
fn run(&self, hugr: &mut H) -> Result<P::Result, Self::Error> {
self.0.run(hugr).map_err(&self.1)
}

fn with_scope(self, scope: &PassScope) -> Self {
Self(self.0.with_scope(scope), self.1, PhantomData)
}
}

// ValidatingPass ------------------------------
Expand Down Expand Up @@ -188,6 +228,10 @@ where
})?;
Ok(res)
}

fn with_scope(self, scope: &PassScope) -> Self {
Self(self.0.with_scope(scope), self.1)
}
}

// IfThen ------------------------------
Expand Down Expand Up @@ -225,6 +269,14 @@ impl<
res.then(|| self.1.run(hugr).map_err(ErrorCombiner::from_second))
.transpose()
}

fn with_scope(self, scope: &PassScope) -> Self {
Self(
self.0.with_scope(scope),
self.1.with_scope(scope),
PhantomData,
)
}
}

pub(crate) fn validate_if_test<P: ComposablePass<H>, H: HugrMut>(
Expand Down
Loading
Loading