Struct RtLolaHir

pub struct RtLolaHir<M>
where
    M: HirMode,
{ /* private fields */ }

This struct constitutes the Mid-Level Intermediate Representation (MIR) of an RTLola specification.

The RtLolaHir is specifically designed to allow for convenient manipulation and analysis. Hence, it is perfect for working on the specification rather than work with it.

Most Notable Structs and Enums

• RtLolaMir is the root data structure representing the specification.
• Output represents a single output stream. The data structure is enriched with information regarding streams accessing it or accessed by it and much more. For input streams confer Input.
• StreamReference used for referencing streams within the Mir.
• Expression represents an expression. It contains its ExpressionKind and its type. The latter contains all information specific to a certain kind of expression such as sub-expressions of operators.

Type-State

The Hir follows a type-state pattern. To this end, it has a type parameter, its HirMode. The Hir starts in the BaseMode and progresses through different stages until reaching CompleteMode.
Each stage constitutes another level of refinement and adds functionality. The functionality can be accesses by importing the respective trait and requiring the mode of the Hir to implement the trait. The following traits exist.

• DepAnaTrait provides access to a dependency graph (see petgraph) and functions to access immediate neighbors of streams. Obtained via determine_evaluation_order.
• TypedTrait provides type information. Obtained via check_types.
• OrderedTrait provides information regarding the evaluation order of streams. Obtained via determine_evaluation_order.
• MemBoundTrait provides information on how many values of a stream have to be kept in memory at the same time. Obtained via determine_memory_bounds.

Progression through different stages is managed by the HirStage trait, in particular HirStage::progress.

See Also

• rtlola_frontend for an overview regarding different representations.
• from_ast / fully_analyzed to obtain an RtLolaHir for a specification in form of an Ast.
• RtLolaHir for a data structs designed for working _on_it.
• RtLolaAst, which is the most basic and down-to-syntax data structure available for RTLola.

Implementations

impl<M> RtLolaHir<M>

where M: HirMode + TypedTrait,

pub fn select(&self) -> StreamSelector<'_, M, All>

Creates a StreamSelector to query the HIR for different classes of output streams.

impl<M> RtLolaHir<M>

where M: HirMode,

pub fn inputs(&self) -> impl Iterator<Item = &Input>

Provides access to an iterator over all input streams.

pub fn outputs(&self) -> impl Iterator<Item = &Output>

Provides access to an iterator over all output streams.

pub fn triggers(&self) -> impl Iterator<Item = &Output>

Provides access to an iterator over all triggers.

pub fn num_inputs(&self) -> usize

Yields the number of input streams present in the Hir. Not necessarily equal to the number of input streams in the specification.

pub fn num_outputs(&self) -> usize

Yields the number of output streams present in the Hir. Not necessarily equal to the number of output streams in the specification.

pub fn num_triggers(&self) -> usize

Yields the number of triggers present in the Hir. Not necessarily equal to the number of triggers in the specification.

pub fn all_streams(&self) -> impl Iterator<Item = StreamReference>

Provides access to an iterator over all streams, i.e., inputs, outputs, and triggers.

pub fn get_input_with_name(&self, name: &str) -> Option<&Input>

Retrieves an input stream based on its name. Fails if no such input stream exists.

pub fn get_output_with_name(&self, name: &str) -> Option<&Output>

Retrieves an output stream based on its name. Fails if no such output stream exists.

pub fn output(&self, sref: StreamReference) -> Option<&Output>

Retrieves an output stream based on a stream reference. Fails if no such stream exists or sref is a StreamReference::In.

pub fn input(&self, sref: StreamReference) -> Option<&Input>

Retrieves an input stream based on a stream reference. Fails if no such stream exists or sref is a StreamReference::Out.

pub fn window_refs(&self) -> Vec<WindowReference>

Provides access to a collection of references for all windows occurring in the Hir.

pub fn sliding_windows(&self) -> Vec<&Window<SlidingAggr>>

Provides access to a collection of references for all sliding windows occurring in the Hir.

pub fn discrete_windows(&self) -> Vec<&Window<DiscreteAggr>>

Provides access to a collection of references for all discrete windows occurring in the Hir.

pub fn instance_aggregations(&self) -> Vec<&InstanceAggregation>

Provides access to a collection of references for all discrete windows occurring in the Hir.

pub fn expression(&self, id: ExprId) -> &Expression

Retrieves an expression for a given expression id.

Panic

Panics if the expression does not exist.

pub fn func_declaration(&self, func_name: &str) -> &FuncDecl

Retrieves a function declaration for a given function name.

Panic

Panics if the declaration does not exist.

pub fn single_sliding(&self, window: WindowReference) -> Window<SlidingAggr>

Retrieves a single sliding window for a given reference.

Panic

Panics if no such window exists.

pub fn single_discrete(&self, window: WindowReference) -> Window<DiscreteAggr>

Retrieves a single discrete window for a given reference.

Panic

Panics if no such window exists.

pub fn single_instance_aggregation( &self, window: WindowReference, ) -> &InstanceAggregation

Retrieves a single instance aggregation for a given reference.

Panic

Panics if no such aggregation exists.

pub fn spawn(&self, sr: StreamReference) -> Option<SpawnDef<'_>>

Retrieves the spawn definition of a particular output stream or trigger or None for input references.

pub fn spawn_cond(&self, sr: StreamReference) -> Option<&Expression>

Retrieves the spawn condition of a particular output stream or None for input and trigger references. If all parts of the SpawnDef are needed, see RtLolaHir::spawn

pub fn spawn_expr(&self, sr: StreamReference) -> Option<&Expression>

Retrieves the spawn expresion of a particular output stream or None for input and trigger references. If all parts of the SpawnDef are needed, see RtLolaHir::spawn

pub fn spawn_pacing(&self, sr: StreamReference) -> Option<&AnnotatedPacingType>

Retrieves the spawn pacing of a particular output stream or None for input and trigger references. If all parts of the SpawnDef are needed, see RtLolaHir::spawn

pub fn eval(&self, sr: StreamReference) -> Option<Vec<EvalDef<'_>>>

Retrieves the eval definitions of a particular output stream or trigger or None for input references.

pub fn eval_cond(&self, sr: StreamReference) -> Option<Vec<Option<&Expression>>>

Retrieves all eval conditions of the clauses of a particular output stream or None for input and trigger references. For each eval clause of the stream, the element in the Vec is None if no condition is or the coresponding condition otherwise. If all parts of the EvalDef are needed, see RtLolaHir::eval

pub fn eval_expr(&self, sr: StreamReference) -> Option<Vec<&Expression>>

Retrieves the eval expressions of all eval clauses of a particular output stream or trigger and None for input references. If all parts of the EvalDef are needed, see RtLolaHir::eval

pub fn eval_pacing( &self, sr: StreamReference, ) -> Option<Vec<&AnnotatedPacingType>>

Retrieves the annotated eval pacing of each eval clause of a particular output stream or trigger None for input references. If all parts of the EvalDef are needed, see RtLolaHir::eval

pub fn close(&self, sr: StreamReference) -> Option<CloseDef<'_>>

Retrieves the expressions representing the close definition of a particular output stream or None for input and trigger references.

pub fn close_cond(&self, sr: StreamReference) -> Option<&Expression>

Retrieves the expression representing the close condition of a particular output stream or None for input and trigger references. If all parts of the CloseDef are needed, see RtLolaHir::close

pub fn close_pacing(&self, sr: StreamReference) -> Option<&AnnotatedPacingType>

Retrieves the close pacing of a particular output stream or None for input and trigger references. If all parts of the CloseDef are needed, see RtLolaHir::close

pub fn names(&self) -> HashMap<StreamReference, String>

Generates a map from a StreamReference to the name of the corresponding stream.

pub fn global_tags(&self) -> &HashMap<String, Tag>

Returns the global tags annotated to the specification

impl RtLolaHir<BaseMode>

pub fn check_types( self, cfg: &FrontendConfig<'_>, ) -> Result<RtLolaHir<TypedMode>, RtLolaError>

Returns the RtLolaHir with the type information for each stream and expression

The function returns the RtLolaHir after the type analysis. The new mode implements the same functionality as the BaseMode and additionally holds for each stream and expression its StreamType. The function moves the information of the previous mode to the new one and therefore destroys the current mode.

Fails

The function fails if the type checker finds a type error in the specification and returns a string with a detailed description.

impl RtLolaHir<TypedMode>

pub fn analyze_dependencies( self, cfg: &FrontendConfig<'_>, ) -> Result<RtLolaHir<DepAnaMode>, RtLolaError>

Returns the RtLolaHir with additional information about the dependencies between streams

The function returns the RtLolaHir after the dependency analysis. The new mode implements the same functionality as the TypedMode and additionally contains the dependencies between streams in the specification. The function moves the information of the previous mode to the new one and therefore destroys the current mode.

Fails

The function returns a RtLolaError if the specification is not well-formed.

impl RtLolaHir<DepAnaMode>

pub fn determine_evaluation_order( self, cfg: &FrontendConfig<'_>, ) -> Result<RtLolaHir<OrderedMode>, RtLolaError>

Returns the RtLolaHir with the spawn and evaluation layer of each stream

Fails

The function fails if the evaluation order cannot be determined.

impl RtLolaHir<OrderedMode>

pub fn determine_memory_bounds( self, cfg: &FrontendConfig<'_>, ) -> Result<RtLolaHir<MemBoundMode>, RtLolaError>

Returns the RtLolaHir with the memory-bound for each stream

Fails

The function fails if the memory cannot be determined.

impl RtLolaHir<MemBoundMode>

pub fn finalize( self, cfg: &FrontendConfig<'_>, ) -> Result<RtLolaHir<CompleteMode>, RtLolaError>

Returns the RtLolaHir in the last mode

The function returns the RtLolaHir in the CompleteMode. This mode indicates that the RtLolaHir has passed all analyzes and now contains all information. The function moves the information of the previous mode to the new one and therefore destroys the current mode.

Trait Implementations

impl<M> Clone for RtLolaHir<M>

where M: Clone + HirMode,

fn clone(&self) -> RtLolaHir<M>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<M> Debug for RtLolaHir<M>

where M: Debug + HirMode,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl HirStage for RtLolaHir<BaseMode>

type NextStage = TypedMode

Defines the next mode that is produced by the progress function

fn progress( self, _cfg: &FrontendConfig<'_>, ) -> Result<RtLolaHir<<RtLolaHir<BaseMode> as HirStage>::NextStage>, RtLolaError>

Returns an RtLolaHir with additional functionality

impl HirStage for RtLolaHir<DepAnaMode>

type NextStage = OrderedMode

Defines the next mode that is produced by the progress function

fn progress( self, _cfg: &FrontendConfig<'_>, ) -> Result<RtLolaHir<<RtLolaHir<DepAnaMode> as HirStage>::NextStage>, RtLolaError>

Returns an RtLolaHir with additional functionality

impl HirStage for RtLolaHir<MemBoundMode>

type NextStage = CompleteMode

Defines the next mode that is produced by the progress function

fn progress( self, _cfg: &FrontendConfig<'_>, ) -> Result<RtLolaHir<<RtLolaHir<MemBoundMode> as HirStage>::NextStage>, RtLolaError>

Returns an RtLolaHir with additional functionality

impl HirStage for RtLolaHir<OrderedMode>

type NextStage = MemBoundMode

Defines the next mode that is produced by the progress function

fn progress( self, cfg: &FrontendConfig<'_>, ) -> Result<RtLolaHir<<RtLolaHir<OrderedMode> as HirStage>::NextStage>, RtLolaError>

Returns an RtLolaHir with additional functionality

impl HirStage for RtLolaHir<TypedMode>

type NextStage = DepAnaMode

Defines the next mode that is produced by the progress function

fn progress( self, _cfg: &FrontendConfig<'_>, ) -> Result<RtLolaHir<<RtLolaHir<TypedMode> as HirStage>::NextStage>, RtLolaError>

Returns an RtLolaHir with additional functionality