Struct calyx_opt::passes::CompileStatic

pub struct CompileStatic { /* private fields */ }

Compiles Static Islands

Implementations

impl CompileStatic

pub fn get_coloring(
    sgroups: &Vec<RRC<StaticGroup>>,
    control: &Control
) -> HashMap<Id, Id>

Trait Implementations

impl ConstructVisitor for CompileStatic

fn from(ctx: &Context) -> CalyxResult<Self>

Construct the visitor using information from the Context

fn clear_data(&mut self)

Clear the data stored in the visitor. Called before traversing the next component by [ir::traversal::Visitor].

fn get_opts(ctx: &Context) -> LinkedHashMap<&'static str, ParseVal>where
    Self: Named,

impl Named for CompileStatic

fn name() -> &'static str

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

fn description() -> &'static str

A short description of the pass.

fn opts() -> Vec<PassOpt>

Set of options that can be passed to the pass. The options contains a tuple of the option name and a description.

impl Visitor for CompileStatic

fn start_static_control(
    &mut self,
    sc: &mut StaticControl,
    comp: &mut Component,
    sigs: &LibrarySignatures,
    _comps: &[Component]
) -> VisResult

Executed after visiting the children of a [ir::Static] node.

fn start_while(
    &mut self,
    s: &mut While,
    comp: &mut Component,
    sigs: &LibrarySignatures,
    _comps: &[Component]
) -> VisResult

If while body is static, then we want to make sure that the while body does not take the extra cycle incurred by the done condition So we replace the while loop with enable of a wrapper group that sets the go signal of the static group in the while loop body high (all static control should be compiled into static groups by static_inliner now). The done signal of the wrapper group should be the condition that the fsm of the while body is %0 and the port signal is 1’d0. For example, we replace

wires {
static group A<1> {
    ...
  }
   ...
}
control {
  while l.out {
    A;
  }
}

with

wires {
 group early_reset_A {
    ...
       }

group while_wrapper_early_reset_A {
      early_reset_A[go] = 1'd1;
      while_wrapper_early_reset_A[done] = !l.out & fsm.out == 1'd0 ? 1'd1;
    }
  }
  control {
    while_wrapper_early_reset_A;
  }

fn start(
    &mut self,
    comp: &mut Component,
    sigs: &LibrarySignatures,
    _comps: &[Component]
) -> VisResult

Executed before the traversal begins.

fn finish(
    &mut self,
    comp: &mut Component,
    _sigs: &LibrarySignatures,
    _comps: &[Component]
) -> VisResult

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

fn precondition(_ctx: &Context) -> Option<String>where
    Self: Sized,

Precondition for this pass to run on the program. If this function returns None, the pass triggers. Otherwise it aborts and logs the string as the reason.

fn start_context(&mut self, _ctx: &mut Context) -> VisResult

Transform the ir::Context before visiting the components.

fn finish_context(&mut self, _ctx: &mut Context) -> VisResult

Transform the ir::Context after visiting the components.

fn iteration_order() -> Orderwhere
    Self: Sized,

Define the iteration order in which components should be visited

fn traverse_component(
    &mut self,
    comp: &mut Component,
    signatures: &LibrarySignatures,
    components: &[Component]
) -> 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 + Named,

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 + Named,

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

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

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

fn finish_seq(
    &mut self,
    _s: &mut Seq,
    _comp: &mut Component,
    _sigs: &LibrarySignatures,
    _comps: &[Component]
) -> VisResult

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

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

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

fn finish_par(
    &mut self,
    _s: &mut Par,
    _comp: &mut Component,
    _sigs: &LibrarySignatures,
    _comps: &[Component]
) -> VisResult

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

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

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

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

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

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

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

fn start_repeat(
    &mut self,
    _s: &mut Repeat,
    _comp: &mut Component,
    _sigs: &LibrarySignatures,
    _comps: &[Component]
) -> VisResult

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

fn finish_repeat(
    &mut self,
    _s: &mut Repeat,
    _comp: &mut Component,
    _sigs: &LibrarySignatures,
    _comps: &[Component]
) -> VisResult

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

fn finish_static_control(
    &mut self,
    _s: &mut StaticControl,
    _comp: &mut Component,
    _sigs: &LibrarySignatures,
    _comps: &[Component]
) -> VisResult

Executed after visiting the conetnts of an ir::StaticControl node.

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

Executed at an ir::Enable node.

fn static_enable(
    &mut self,
    _s: &mut StaticEnable,
    _comp: &mut Component,
    _sigs: &LibrarySignatures,
    _comps: &[Component]
) -> VisResult

Executed at an ir::StaticEnable node.

fn start_static_if(
    &mut self,
    _s: &mut StaticIf,
    _comp: &mut Component,
    _sigs: &LibrarySignatures,
    _comps: &[Component]
) -> VisResult

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

fn finish_static_if(
    &mut self,
    _s: &mut StaticIf,
    _comp: &mut Component,
    _sigs: &LibrarySignatures,
    _comps: &[Component]
) -> VisResult

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

fn start_static_repeat(
    &mut self,
    _s: &mut StaticRepeat,
    _comp: &mut Component,
    _sigs: &LibrarySignatures,
    _comps: &[Component]
) -> VisResult

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

fn finish_static_repeat(
    &mut self,
    _s: &mut StaticRepeat,
    _comp: &mut Component,
    _sigs: &LibrarySignatures,
    _comps: &[Component]
) -> VisResult

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

fn start_static_seq(
    &mut self,
    _s: &mut StaticSeq,
    _comp: &mut Component,
    _sigs: &LibrarySignatures,
    _comps: &[Component]
) -> VisResult

fn finish_static_seq(
    &mut self,
    _s: &mut StaticSeq,
    _comp: &mut Component,
    _sigs: &LibrarySignatures,
    _comps: &[Component]
) -> VisResult

fn start_static_par(
    &mut self,
    _s: &mut StaticPar,
    _comp: &mut Component,
    _sigs: &LibrarySignatures,
    _comps: &[Component]
) -> VisResult

fn finish_static_par(
    &mut self,
    _s: &mut StaticPar,
    _comp: &mut Component,
    _sigs: &LibrarySignatures,
    _comps: &[Component]
) -> VisResult

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

Executed at an ir::Invoke node.

fn static_invoke(
    &mut self,
    _s: &mut StaticInvoke,
    _comp: &mut Component,
    _sigs: &LibrarySignatures,
    _comps: &[Component]
) -> VisResult

Executed at a ir::StaticInvoke node.

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

Executed at an ir::Empty node.