Struct calyx::passes::CollapseControl

pub struct CollapseControl {}

Collapses and de-nests control constructs.

Running this pass removes unnecessary FSM transitions and compilation groups during the lowering phase.

Example

1. Collapses nested seq:

seq {
    seq { A; B }
    C;
}

into

seq { A; B C; }

2. Collapses nested par:

par {
    par { A; B }
    C;
}

into

par { A; B C; }

Trait Implementations

impl Default for CollapseControl

fn default() -> CollapseControl

Returns the “default value” for a type.

impl Named for CollapseControl

fn name() -> &'static str

The name of a pass. Is used for identifying passes.

fn description() -> &'static str

A short description of the pass.

impl Visitor for CollapseControl

fn finish_seq(
    &mut self,
    s: &mut Seq,
    _comp: &mut Component,
    _c: &LibrarySignatures
) -> VisResult

Collapse seq { seq { A }; B } into seq { A; B }.

fn finish_par(
    &mut self,
    s: &mut Par,
    _comp: &mut Component,
    _c: &LibrarySignatures
) -> VisResult

Collapse par { par { A }; B } into par { A; B }.

fn require_postorder() -> bool where
    Self: Sized, 

Returns true if this pass requires a post-order traversal of the components. In a post-order traversal, if component B uses a component A, then A is guaranteed to be traversed before B.

fn traverse_component(
    &mut self,
    comp: &mut Component,
    signatures: &LibrarySignatures
) -> CalyxResult<()> where
    Self: Sized, 

Define the traversal over a component. Calls Visitor::start, visits each control node, and finally calls Visitor::finish.

fn do_pass(&mut self, context: &mut Context) -> CalyxResult<()> where
    Self: Sized + ConstructVisitor, 

Run the visitor on a given program ir::Context. The function mutably borrows the control program in each component and traverses it.

fn do_pass_default(context: &mut Context) -> CalyxResult<Self> where
    Self: ConstructVisitor + Sized, 

Build a Default implementation of this pass and call Visitor::do_pass using it.

fn start(
    &mut self,
    _comp: &mut Component,
    _sigs: &LibrarySignatures
) -> VisResult

Executed before the traversal begins.

fn finish(
    &mut self,
    _comp: &mut Component,
    _sigs: &LibrarySignatures
) -> VisResult

Executed after the traversal ends. This method is always invoked regardless of the Action returned from the children.

fn start_seq(
    &mut self,
    _s: &mut Seq,
    _comp: &mut Component,
    _sigs: &LibrarySignatures
) -> VisResult

Executed before visiting the children of a ir::Seq node.

fn start_par(
    &mut self,
    _s: &mut Par,
    _comp: &mut Component,
    _sigs: &LibrarySignatures
) -> VisResult

Executed before visiting the children of a ir::Par node.

fn start_if(
    &mut self,
    _s: &mut If,
    _comp: &mut Component,
    _sigs: &LibrarySignatures
) -> VisResult

Executed before visiting the children of a ir::If node.

fn finish_if(
    &mut self,
    _s: &mut If,
    _comp: &mut Component,
    _sigs: &LibrarySignatures
) -> VisResult

Executed after visiting the children of a ir::If node.

fn start_while(
    &mut self,
    _s: &mut While,
    _comp: &mut Component,
    _sigs: &LibrarySignatures
) -> VisResult

Executed before visiting the children of a ir::While node.

fn finish_while(
    &mut self,
    _s: &mut While,
    _comp: &mut Component,
    _sigs: &LibrarySignatures
) -> VisResult

Executed after visiting the children of a ir::While node.

fn enable(
    &mut self,
    _s: &mut Enable,
    _comp: &mut Component,
    _sigs: &LibrarySignatures
) -> VisResult

Executed at an ir::Enable node.

fn invoke(
    &mut self,
    _s: &mut Invoke,
    _comp: &mut Component,
    _sigs: &LibrarySignatures
) -> VisResult

Executed at an ir::Invoke node.

fn empty(
    &mut self,
    _s: &mut Empty,
    _comp: &mut Component,
    _sigs: &LibrarySignatures
) -> VisResult

Executed at an ir::Empty node.