CIRCT  20.0.0git
Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
circt::scheduling::ChainingCyclicProblem Class Reference

This class models the accumulation of physical propagation delays on combinational paths along SSA dependences on a cyclic scheduling problem. More...

#include <Problems.h>

Inheritance diagram for circt::scheduling::ChainingCyclicProblem:
Inheritance graph
[legend]
Collaboration diagram for circt::scheduling::ChainingCyclicProblem:
Collaboration graph
[legend]

Public Member Functions

LogicalResult checkDefUse (Dependence dep)
 
LogicalResult check () override
 Return success if the constructed scheduling problem is valid. More...
 
LogicalResult verify () override
 Return success if the computed solution is valid. More...
 
 ChainingProblem ()=default
 
- Public Member Functions inherited from circt::scheduling::ChainingProblem
std::optional< float > getIncomingDelay (OperatorType opr)
 The incoming delay denotes the propagation time from the operand inputs to either the result outputs (combinational operators) or the first internal register stage. More...
 
void setIncomingDelay (OperatorType opr, float delay)
 
std::optional< float > getOutgoingDelay (OperatorType opr)
 The outgoing delay denotes the propagation time from either the operand inputs (combinational operators) or the last internal register stage to the result outputs. More...
 
void setOutgoingDelay (OperatorType opr, float delay)
 
std::optional< float > getStartTimeInCycle (Operation *op)
 Computed by the scheduler, this start time is relative to the beginning of the cycle that op starts in. More...
 
void setStartTimeInCycle (Operation *op, float time)
 
void clearStartTimeInCycle ()
 
virtual PropertyStringVector getProperties (Operation *op) override
 
virtual PropertyStringVector getProperties (OperatorType opr) override
 
 Problem (Operation *containingOp)
 Construct an empty scheduling problem. More...
 
 Problem ()=default
 
- Public Member Functions inherited from circt::scheduling::Problem
 Problem (Operation *containingOp)
 Construct an empty scheduling problem. More...
 
virtual ~Problem ()=default
 
void insertOperation (Operation *op)
 Include op in this scheduling problem. More...
 
LogicalResult insertDependence (Dependence dep)
 Include dep in the scheduling problem. More...
 
void insertOperatorType (OperatorType opr)
 Include opr in this scheduling problem. More...
 
OperatorType getOrInsertOperatorType (StringRef name)
 Retrieves the operator type identified by the client-specific name. More...
 
Operation * getContainingOp ()
 Return the operation containing this problem, e.g. to emit diagnostics. More...
 
void setContainingOp (Operation *op)
 Set the operation containing this problem, e.g. to emit diagnostics. More...
 
bool hasOperation (Operation *op)
 Return true if op is part of this problem. More...
 
const OperationSetgetOperations ()
 Return the set of operations. More...
 
DependenceRange getDependences (Operation *op)
 Return a range object to transparently iterate over op's incoming 1) implicit def-use dependences (backed by the SSA graph), and then 2) explictly added auxiliary dependences. More...
 
bool hasOperatorType (OperatorType opr)
 Return true if opr is part of this problem. More...
 
const OperatorTypeSetgetOperatorTypes ()
 Return the set of operator types. More...
 
std::optional< OperatorTypegetLinkedOperatorType (Operation *op)
 The linked operator type provides the runtime characteristics for op. More...
 
void setLinkedOperatorType (Operation *op, OperatorType opr)
 
std::optional< unsigned > getLatency (OperatorType opr)
 The latency is the number of cycles opr needs to compute its result. More...
 
void setLatency (OperatorType opr, unsigned val)
 
std::optional< unsigned > getStartTime (Operation *op)
 Return the start time for op, as computed by the scheduler. More...
 
void setStartTime (Operation *op, unsigned val)
 
std::optional< unsigned > getEndTime (Operation *op)
 Returns the end time for op, as computed by the scheduler. More...
 
StringAttr getInstanceName ()
 
void setInstanceName (StringAttr name)
 
StringAttr getLibraryName ()
 
void setLibraryName (StringAttr name)
 
StringAttr getOperationName (Operation *op)
 
void setOperationName (Operation *op, StringAttr name)
 
- Public Member Functions inherited from circt::scheduling::CyclicProblem
std::optional< unsigned > getDistance (Dependence dep)
 The distance determines whether a dependence has to be satisfied in the same iteration (distance=0 or not set), or distance-many iterations later. More...
 
void setDistance (Dependence dep, unsigned val)
 
std::optional< unsigned > getInitiationInterval ()
 The initiation interval (II) is the number of time steps between subsequent iterations, i.e. More...
 
void setInitiationInterval (unsigned val)
 
virtual PropertyStringVector getProperties (Dependence dep) override
 
virtual PropertyStringVector getProperties () override
 
 Problem (Operation *containingOp)
 Construct an empty scheduling problem. More...
 
 Problem ()=default
 

Static Public Attributes

static constexpr auto name = "ChainingCyclicProblem"
 
- Static Public Attributes inherited from circt::scheduling::ChainingProblem
static constexpr auto name = "ChainingProblem"
 
- Static Public Attributes inherited from circt::scheduling::Problem
static constexpr auto name = "Problem"
 
- Static Public Attributes inherited from circt::scheduling::CyclicProblem
static constexpr auto name = "CyclicProblem"
 

Protected Member Functions

 ChainingCyclicProblem ()=default
 
- Protected Member Functions inherited from circt::scheduling::ChainingProblem
 ChainingProblem ()=default
 
virtual LogicalResult checkDelays (OperatorType opr)
 Incoming/outgoing delays are set for opr and non-negative. More...
 
virtual LogicalResult verifyStartTimeInCycle (Operation *op)
 op has a non-negative start time in its cycle. More...
 
virtual LogicalResult verifyPrecedenceInCycle (Dependence dep)
 If dep is an SSA edge and its source operation finishes in the same time step as the destination operation, the source's result is available before the destination starts in that cycle. More...
 
- Protected Member Functions inherited from circt::scheduling::Problem
 Problem ()=default
 
virtual LogicalResult checkLinkedOperatorType (Operation *op)
 op is linked to a registered operator type. More...
 
virtual LogicalResult checkLatency (OperatorType opr)
 opr has a latency. More...
 
virtual LogicalResult verifyStartTime (Operation *op)
 op has a start time. More...
 
- Protected Member Functions inherited from circt::scheduling::CyclicProblem
 CyclicProblem ()=default
 
virtual LogicalResult verifyPrecedence (Dependence dep) override
 dep's source operation is available before dep's destination operation starts (dep's distance iterations later). More...
 
virtual LogicalResult verifyInitiationInterval ()
 This problem has a non-zero II. More...
 

Additional Inherited Members

- Public Types inherited from circt::scheduling::Problem
using Dependence = detail::Dependence
 A thin wrapper to allow a uniform handling of def-use and auxiliary dependences. More...
 
using OperatorType = mlir::StringAttr
 Operator types are distinguished by name (chosen by the client). More...
 
using OperationSet = llvm::SetVector< Operation * >
 
using DependenceRange = llvm::iterator_range< detail::DependenceIterator >
 
using OperatorTypeSet = llvm::SetVector< OperatorType >
 
using PropertyStringVector = llvm::SmallVector< std::pair< std::string, std::string >, 2 >
 
- Protected Types inherited from circt::scheduling::Problem
using AuxDependenceMap = llvm::DenseMap< Operation *, llvm::SmallSetVector< Operation *, 4 > >
 
template<typename T >
using OperationProperty = llvm::DenseMap< Operation *, std::optional< T > >
 
template<typename T >
using DependenceProperty = llvm::DenseMap< Dependence, std::optional< T > >
 
template<typename T >
using OperatorTypeProperty = llvm::DenseMap< OperatorType, std::optional< T > >
 
template<typename T >
using InstanceProperty = std::optional< T >
 

Detailed Description

This class models the accumulation of physical propagation delays on combinational paths along SSA dependences on a cyclic scheduling problem.

Each operator type is annotated with estimated values for incoming and outgoing delays. Combinational operators (zero-latency, no internal registers) have only a single delay; this important special case is modeled by setting the incoming and outgoing delays to the same values.

A solution to this problem comprises per-operation start times in a continuous unit, e.g. in nanoseconds, inside the discrete time steps/cycles determined by the underlying scheduling problem. Its solution can be used to construct a pipelined datapath with a fixed, integer initiation interval, in which the execution of multiple iterations/samples/etc. may overlap.

Definition at line 484 of file Problems.h.

Constructor & Destructor Documentation

◆ ChainingCyclicProblem()

circt::scheduling::ChainingCyclicProblem::ChainingCyclicProblem ( )
protecteddefault

Member Function Documentation

◆ ChainingProblem()

circt::scheduling::ChainingProblem::ChainingProblem
default

◆ check()

LogicalResult ChainingCyclicProblem::check ( )
overridevirtual

Return success if the constructed scheduling problem is valid.

Reimplemented from circt::scheduling::ChainingProblem.

Definition at line 422 of file Problems.cpp.

References circt::scheduling::Problem::check(), and circt::scheduling::ChainingProblem::check().

◆ checkDefUse()

LogicalResult ChainingCyclicProblem::checkDefUse ( Dependence  dep)

◆ verify()

LogicalResult ChainingCyclicProblem::verify ( )
overridevirtual

Return success if the computed solution is valid.

Reimplemented from circt::scheduling::CyclicProblem.

Definition at line 434 of file Problems.cpp.

References circt::scheduling::CyclicProblem::verify(), and circt::scheduling::ChainingProblem::verify().

Member Data Documentation

◆ name

constexpr auto circt::scheduling::ChainingCyclicProblem::name = "ChainingCyclicProblem"
staticconstexpr

Definition at line 487 of file Problems.h.


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