CIRCT
Public Member Functions | Protected Member Functions | List of all members
circt::scheduling::ModuloProblem Class Reference

This class models the modulo scheduling problem as the composition of the cyclic problem and the resource-constrained problem with fully-pipelined shared operators. More...

#include <Problems.h>

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

Public Member Functions

virtual LogicalResult verify () override
 Return success if the computed solution is valid. More...
 
- Public Member Functions inherited from circt::scheduling::CyclicProblem
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)
 
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
 
- Public Member Functions inherited from circt::scheduling::Problem
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...
 
Optional< OperatorTypegetLinkedOperatorType (Operation *op)
 The linked operator type provides the runtime characteristics for op. More...
 
void setLinkedOperatorType (Operation *op, OperatorType opr)
 
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)
 
Optional< unsigned > getStartTime (Operation *op)
 Return the start time for op, as computed by the scheduler. More...
 
void setStartTime (Operation *op, unsigned val)
 
StringAttr getInstanceName ()
 
void setInstanceName (StringAttr name)
 
StringAttr getLibraryName ()
 
void setLibraryName (StringAttr name)
 
StringAttr getOperationName (Operation *op)
 
void setOperationName (Operation *op, StringAttr name)
 
virtual PropertyStringVector getProperties (Operation *op)
 
virtual LogicalResult check ()
 Return success if the constructed scheduling problem is valid. More...
 
- Public Member Functions inherited from circt::scheduling::SharedOperatorsProblem
Optional< unsigned > getLimit (OperatorType opr)
 The limit is the maximum number of operations using opr that are allowed to start in the same time step. More...
 
void setLimit (OperatorType opr, unsigned val)
 
virtual PropertyStringVector getProperties (OperatorType opr) override
 

Protected Member Functions

virtual LogicalResult verifyUtilization (OperatorType opr) override
 opr is not oversubscribed in any congruence class modulo II. More...
 
- Protected Member Functions inherited from circt::scheduling::CyclicProblem
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...
 
- Protected Member Functions inherited from circt::scheduling::Problem
virtual LogicalResult checkLinkedOperatorType (Operation *op)
 op is linked to a registered operator type. More...
 
virtual LogicalResult verifyStartTime (Operation *op)
 op has a start time. More...
 
- Protected Member Functions inherited from circt::scheduling::SharedOperatorsProblem
virtual LogicalResult checkLatency (OperatorType opr) override
 If opr is limited, it has a non-zero latency. 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 *, Optional< T > >
 
template<typename T >
using DependenceProperty = llvm::DenseMap< Dependence, Optional< T > >
 
template<typename T >
using OperatorTypeProperty = llvm::DenseMap< OperatorType, Optional< T > >
 
template<typename T >
using InstanceProperty = Optional< T >
 

Detailed Description

This class models the modulo scheduling problem as the composition of the cyclic problem and the resource-constrained problem with fully-pipelined shared operators.

A solution to this problem comprises an integer II and integer start times for all registered operations, and is feasible iff: (1) The precedence constraints implied by the CyclicProblem's dependence edges are satisfied, and (2) The number of operations that use a certain limited operator type, and start in the same congruence class (= start time mod II), does not exceed the operator type's limit.

Definition at line 433 of file Problems.h.

Member Function Documentation

◆ verify()

LogicalResult ModuloProblem::verify ( )
overridevirtual

Return success if the computed solution is valid.

Reimplemented from circt::scheduling::CyclicProblem.

Definition at line 389 of file Problems.cpp.

References circt::scheduling::CyclicProblem::verify().

◆ verifyUtilization()

LogicalResult ModuloProblem::verifyUtilization ( OperatorType  opr)
overrideprotectedvirtual

opr is not oversubscribed in any congruence class modulo II.

Reimplemented from circt::scheduling::SharedOperatorsProblem.

Definition at line 368 of file Problems.cpp.


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