LLZK 0.1.0
Veridise's ZK Language IR
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
llzk::dataflow::DenseForwardDataFlowAnalysis< LatticeT > Class Template Referenceabstract

LLZK: This class has been ported so that it can inherit from our port of the AbstractDenseForwardDataFlowAnalysis above. More...

#include <DenseAnalysis.h>

Inheritance diagram for llzk::dataflow::DenseForwardDataFlowAnalysis< LatticeT >:
[legend]
Collaboration diagram for llzk::dataflow::DenseForwardDataFlowAnalysis< LatticeT >:
[legend]

Public Member Functions

virtual mlir::LogicalResult visitOperation (mlir::Operation *op, const LatticeT &before, LatticeT *after)=0
 Visit an operation with the dense lattice before its execution.
virtual void visitCallControlFlowTransfer (mlir::CallOpInterface call, CallControlFlowAction action, const LatticeT &before, LatticeT *after)
 Hook for customizing the behavior of lattice propagation along the call control flow edges.
virtual void visitRegionBranchControlFlowTransfer (mlir::RegionBranchOpInterface branch, std::optional< unsigned > regionFrom, std::optional< unsigned > regionTo, const LatticeT &before, LatticeT *after)
 Hook for customizing the behavior of lattice propagation along the control flow edges between regions and their parent op.
Public Member Functions inherited from llzk::dataflow::AbstractDenseForwardDataFlowAnalysis
mlir::LogicalResult initialize (mlir::Operation *top) override
 Initialize the analysis by visiting every program point whose execution may modify the program state; that is, every operation and block.
mlir::LogicalResult visit (mlir::ProgramPoint *point) override
 Visit a program point that modifies the state of the program.

Protected Member Functions

LatticeT * getLattice (mlir::LatticeAnchor anchor) override
 Get the dense lattice on this lattice anchor.
virtual void setToEntryState (LatticeT *lattice)=0
 Set the dense lattice at control flow entry point and propagate an update if it changed.
void setToEntryState (AbstractDenseLattice *lattice) override
 Set the dense lattice at control flow entry point and propagate an update if it changed.
mlir::LogicalResult visitOperationImpl (mlir::Operation *op, const AbstractDenseLattice &before, AbstractDenseLattice *after) final
 Type-erased wrappers that convert the abstract dense lattice to a derived lattice and invoke the virtual hooks operating on the derived lattice.
void visitCallControlFlowTransfer (mlir::CallOpInterface call, CallControlFlowAction action, const AbstractDenseLattice &before, AbstractDenseLattice *after) final
 Propagate the dense lattice forward along the call control flow edge, which can be either entering or exiting the callee.
void visitRegionBranchControlFlowTransfer (mlir::RegionBranchOpInterface branch, std::optional< unsigned > regionFrom, std::optional< unsigned > regionTo, const AbstractDenseLattice &before, AbstractDenseLattice *after) final
 Propagate the dense lattice forward along the control flow edge from regionFrom to regionTo regions of the branch operation.
Protected Member Functions inherited from llzk::dataflow::AbstractDenseForwardDataFlowAnalysis
const AbstractDenseLattice * getLatticeFor (mlir::ProgramPoint *dependent, mlir::LatticeAnchor anchor)
 Get the dense lattice on the given lattice anchor and add dependent as its dependency.
void join (AbstractDenseLattice *lhs, const AbstractDenseLattice &rhs)
 Join a lattice with another and propagate an update if it changed.
virtual mlir::LogicalResult processOperation (mlir::Operation *op)
 Visit an operation.
void visitRegionBranchOperation (mlir::ProgramPoint *point, mlir::RegionBranchOpInterface branch, AbstractDenseLattice *after)
 Visit a program point within a region branch operation with predecessors in it.

Additional Inherited Members

Protected Attributes inherited from llzk::dataflow::AbstractDenseForwardDataFlowAnalysis
mlir::SymbolTableCollection tables
 LLZK: Added for use of symbol helper caching.

Detailed Description

template<typename LatticeT>
class llzk::dataflow::DenseForwardDataFlowAnalysis< LatticeT >

LLZK: This class has been ported so that it can inherit from our port of the AbstractDenseForwardDataFlowAnalysis above.

It is otherwise left unchanged.

A dense forward data-flow analysis for propagating lattices before and after the execution of every operation across the IR by implementing transfer functions for operations.

LatticeT is expected to be a subclass of AbstractDenseLattice.

Definition at line 191 of file DenseAnalysis.h.

Member Function Documentation

◆ getLattice()

template<typename LatticeT>
LatticeT * llzk::dataflow::DenseForwardDataFlowAnalysis< LatticeT >::getLattice ( mlir::LatticeAnchor anchor)
inlineoverrideprotectedvirtual

Get the dense lattice on this lattice anchor.

Implements llzk::dataflow::AbstractDenseForwardDataFlowAnalysis.

Definition at line 262 of file DenseAnalysis.h.

◆ setToEntryState() [1/2]

template<typename LatticeT>
void llzk::dataflow::DenseForwardDataFlowAnalysis< LatticeT >::setToEntryState ( AbstractDenseLattice * lattice)
inlineoverrideprotectedvirtual

Set the dense lattice at control flow entry point and propagate an update if it changed.

Implements llzk::dataflow::AbstractDenseForwardDataFlowAnalysis.

Definition at line 269 of file DenseAnalysis.h.

◆ setToEntryState() [2/2]

template<typename LatticeT>
virtual void llzk::dataflow::DenseForwardDataFlowAnalysis< LatticeT >::setToEntryState ( LatticeT * lattice)
protectedpure virtual

Set the dense lattice at control flow entry point and propagate an update if it changed.

Implemented in llzk::SourceRefAnalysis.

◆ visitCallControlFlowTransfer() [1/2]

template<typename LatticeT>
void llzk::dataflow::DenseForwardDataFlowAnalysis< LatticeT >::visitCallControlFlowTransfer ( mlir::CallOpInterface ,
CallControlFlowAction action,
const AbstractDenseLattice & before,
AbstractDenseLattice * after )
inlinefinalprotectedvirtual

Propagate the dense lattice forward along the call control flow edge, which can be either entering or exiting the callee.

Default implementation for enter and exit callee actions just meets the states, meaning that operations implementing CallOpInterface don't have any effect on the lattice that isn't already expressed by the interface itself. Default implementation for the external callee action additionally sets the "after" lattice to the entry state.

Reimplemented from llzk::dataflow::AbstractDenseForwardDataFlowAnalysis.

Definition at line 282 of file DenseAnalysis.h.

◆ visitCallControlFlowTransfer() [2/2]

template<typename LatticeT>
virtual void llzk::dataflow::DenseForwardDataFlowAnalysis< LatticeT >::visitCallControlFlowTransfer ( mlir::CallOpInterface call,
CallControlFlowAction action,
const LatticeT & before,
LatticeT * after )
inlinevirtual

Hook for customizing the behavior of lattice propagation along the call control flow edges.

Two types of (forward) propagation are possible here:

  • action == CallControlFlowAction::Enter indicates that:
    • before is the state before the call operation;
    • after is the state at the beginning of the callee entry block;
  • action == CallControlFlowAction::Exit indicates that:
    • before is the state at the end of a callee exit block;
    • after is the state after the call operation. By default, the after state is simply joined with the before state. Concrete analyses can override this behavior or delegate to the parent call for the default behavior. Specifically, if the call op may affect the lattice prior to entering the callee, the custom behavior can be added for action == CallControlFlowAction::Enter. If the call op may affect the lattice post exiting the callee, the custom behavior can be added for action == CallControlFlowAction::Exit.

Reimplemented in llzk::IntervalDataFlowAnalysis, and llzk::SourceRefAnalysis.

Definition at line 221 of file DenseAnalysis.h.

◆ visitOperation()

template<typename LatticeT>
virtual mlir::LogicalResult llzk::dataflow::DenseForwardDataFlowAnalysis< LatticeT >::visitOperation ( mlir::Operation * op,
const LatticeT & before,
LatticeT * after )
pure virtual

Visit an operation with the dense lattice before its execution.

This function is expected to set the dense lattice after its execution and trigger change propagation in case of change.

Implemented in llzk::IntervalDataFlowAnalysis, and llzk::SourceRefAnalysis.

◆ visitOperationImpl()

template<typename LatticeT>
mlir::LogicalResult llzk::dataflow::DenseForwardDataFlowAnalysis< LatticeT >::visitOperationImpl ( mlir::Operation * op,
const AbstractDenseLattice & before,
AbstractDenseLattice * after )
inlinefinalprotectedvirtual

Type-erased wrappers that convert the abstract dense lattice to a derived lattice and invoke the virtual hooks operating on the derived lattice.

Implements llzk::dataflow::AbstractDenseForwardDataFlowAnalysis.

Definition at line 275 of file DenseAnalysis.h.

◆ visitRegionBranchControlFlowTransfer() [1/2]

template<typename LatticeT>
void llzk::dataflow::DenseForwardDataFlowAnalysis< LatticeT >::visitRegionBranchControlFlowTransfer ( mlir::RegionBranchOpInterface ,
std::optional< unsigned > regionFrom,
std::optional< unsigned > regionTo,
const AbstractDenseLattice & before,
AbstractDenseLattice * after )
inlinefinalprotectedvirtual

Propagate the dense lattice forward along the control flow edge from regionFrom to regionTo regions of the branch operation.

nullopt values correspond to control flow branches originating at or targeting the branch operation itself. Default implementation just joins the states, meaning that operations implementing RegionBranchOpInterface don't have any effect on the lattice that isn't already expressed by the interface itself.

Reimplemented from llzk::dataflow::AbstractDenseForwardDataFlowAnalysis.

Definition at line 290 of file DenseAnalysis.h.

◆ visitRegionBranchControlFlowTransfer() [2/2]

template<typename LatticeT>
virtual void llzk::dataflow::DenseForwardDataFlowAnalysis< LatticeT >::visitRegionBranchControlFlowTransfer ( mlir::RegionBranchOpInterface branch,
std::optional< unsigned > regionFrom,
std::optional< unsigned > regionTo,
const LatticeT & before,
LatticeT * after )
inlinevirtual

Hook for customizing the behavior of lattice propagation along the control flow edges between regions and their parent op.

The control flows from regionFrom to regionTo, both of which may be nullopt to indicate the parent op. The lattice is propagated forward along this edge. The lattices are as follows:

  • before:
    • if regionFrom is a region, this is the lattice at the end of the block that exits the region; note that for multi-exit regions, the lattices are equal at the end of all exiting blocks, but they are associated with different program points.
    • otherwise, this is the lattice before the parent op.
  • after:
    • if regionTo is a region, this is the lattice at the beginning of the entry block of that region;
    • otherwise, this is the lattice after the parent op. By default, the after state is simply joined with the before state. Concrete analyses can override this behavior or delegate to the parent call for the default behavior. Specifically, if the branch op may affect the lattice before entering any region, the custom behavior can be added for regionFrom == nullopt. If the branch op may affect the lattice after all terminated, the custom behavior can be added for regionTo == / nullptr. The behavior can be further refined for specific pairs of "from" and "to" regions.

Definition at line 251 of file DenseAnalysis.h.

The documentation for this class was generated from the following file: