An Evaluator, which is constructed with an IR module and can instantiate Objects. More...

#include <Evaluator.h>

Collaboration diagram for circt::om::Evaluator:

[legend]

Public Types
using	ActualParameters = SmallVectorImpl< std::shared_ptr< evaluator::EvaluatorValue > > *

using	ObjectKey = std::pair< Value, ActualParameters >

Public Member Functions
	Evaluator (ModuleOp mod)
	Construct an Evaluator with an IR module.

FailureOr< evaluator::EvaluatorValuePtr >	instantiate (StringAttr className, ArrayRef< EvaluatorValuePtr > actualParams)
	Instantiate an Object with its class name and actual parameters.

mlir::ModuleOp	getModule ()
	Get the Module this Evaluator is built from.

FailureOr< evaluator::EvaluatorValuePtr >	getPartiallyEvaluatedValue (Type type, Location loc)

Private Member Functions
bool	isFullyEvaluated (Value value, ActualParameters key)

bool	isFullyEvaluated (ObjectKey key)

FailureOr< EvaluatorValuePtr >	getOrCreateValue (Value value, ActualParameters actualParams, Location loc)

FailureOr< EvaluatorValuePtr >	allocateObjectInstance (StringAttr clasName, ActualParameters actualParams)

FailureOr< EvaluatorValuePtr >	evaluateValue (Value value, ActualParameters actualParams, Location loc)
	Evaluate a Value in a Class body according to the small expression grammar described in the rationale document.

FailureOr< EvaluatorValuePtr >	evaluateParameter (BlockArgument formalParam, ActualParameters actualParams, Location loc)
	Evaluator dispatch functions for the small expression grammar.

FailureOr< EvaluatorValuePtr >	evaluateConstant (ConstantOp op, ActualParameters actualParams, Location loc)
	Evaluator dispatch function for constants.

FailureOr< EvaluatorValuePtr >	evaluateIntegerBinaryArithmetic (IntegerBinaryArithmeticOp op, ActualParameters actualParams, Location loc)

FailureOr< EvaluatorValuePtr >	evaluateObjectInstance (StringAttr className, ActualParameters actualParams, Location loc, ObjectKey instanceKey={})
	Instantiate an Object with its class name and actual parameters.

FailureOr< EvaluatorValuePtr >	evaluateObjectInstance (ObjectOp op, ActualParameters actualParams)
	Evaluator dispatch function for Object instances.

FailureOr< EvaluatorValuePtr >	evaluateObjectField (ObjectFieldOp op, ActualParameters actualParams, Location loc)
	Evaluator dispatch function for Object fields.

FailureOr< EvaluatorValuePtr >	evaluateListCreate (ListCreateOp op, ActualParameters actualParams, Location loc)
	Evaluator dispatch function for List creation.

FailureOr< EvaluatorValuePtr >	evaluateListConcat (ListConcatOp op, ActualParameters actualParams, Location loc)
	Evaluator dispatch function for List concatenation.

FailureOr< evaluator::EvaluatorValuePtr >	evaluateBasePathCreate (FrozenBasePathCreateOp op, ActualParameters actualParams, Location loc)

FailureOr< evaluator::EvaluatorValuePtr >	evaluatePathCreate (FrozenPathCreateOp op, ActualParameters actualParams, Location loc)

FailureOr< evaluator::EvaluatorValuePtr >	evaluateEmptyPath (FrozenEmptyPathOp op, ActualParameters actualParams, Location loc)

FailureOr< evaluator::EvaluatorValuePtr >	evaluateUnknownValue (UnknownValueOp op, Location loc)

FailureOr< ActualParameters >	createParametersFromOperands (ValueRange range, ActualParameters actualParams, Location loc)
	Evaluator dispatch function for Object instances.

Private Attributes
SymbolTable	symbolTable
	The symbol table for the IR module the Evaluator was constructed with.

SmallVector< std::unique_ptr< SmallVector< std::shared_ptr< evaluator::EvaluatorValue > > > >	actualParametersBuffers
	This uniquely stores vectors that represent parameters.

std::queue< ObjectKey >	worklist
	A worklist that tracks values which needs to be fully evaluated.

DenseMap< ObjectKey, std::shared_ptr< evaluator::EvaluatorValue > >	objects
	Evaluator value storage.

Detailed Description

An Evaluator, which is constructed with an IR module and can instantiate Objects.

Further refinement is expected.

Definition at line 379 of file Evaluator.h.

Member Typedef Documentation

◆ ActualParameters

using circt::om::Evaluator::ActualParameters = SmallVectorImpl<std::shared_ptr<evaluator::EvaluatorValue> > *

Definition at line 394 of file Evaluator.h.

◆ ObjectKey

using circt::om::Evaluator::ObjectKey = std::pair<Value, ActualParameters>

Definition at line 397 of file Evaluator.h.

Constructor & Destructor Documentation

◆ Evaluator()

circt::om::Evaluator::Evaluator ( ModuleOp mod )

Construct an Evaluator with an IR module.

Definition at line 27 of file Evaluator.cpp.

Member Function Documentation

◆ allocateObjectInstance()

FailureOr< EvaluatorValuePtr > circt::om::Evaluator::allocateObjectInstance	(	StringAttr	clasName,
		ActualParameters	actualParams
	)

private

◆ createParametersFromOperands()

FailureOr< circt::om::Evaluator::ActualParameters > circt::om::Evaluator::createParametersFromOperands	(	ValueRange	range,
		ActualParameters	actualParams,
		Location	loc
	)

private

Evaluator dispatch function for Object instances.

Definition at line 486 of file Evaluator.cpp.

◆ evaluateBasePathCreate()

FailureOr< evaluator::EvaluatorValuePtr > circt::om::Evaluator::evaluateBasePathCreate	(	FrozenBasePathCreateOp	op,
		ActualParameters	actualParams,
		Location	loc
	)

private

Definition at line 637 of file Evaluator.cpp.

◆ evaluateConstant()

FailureOr< circt::om::evaluator::EvaluatorValuePtr > circt::om::Evaluator::evaluateConstant	(	ConstantOp	op,
		ActualParameters	actualParams,
		Location	loc
	)

private

Evaluator dispatch function for constants.

Definition at line 392 of file Evaluator.cpp.

References circt::om::evaluator::AttributeValue::get.

◆ evaluateEmptyPath()

FailureOr< evaluator::EvaluatorValuePtr > circt::om::Evaluator::evaluateEmptyPath	(	FrozenEmptyPathOp	op,
		ActualParameters	actualParams,
		Location	loc
	)

private

Definition at line 680 of file Evaluator.cpp.

◆ evaluateIntegerBinaryArithmetic()

FailureOr< EvaluatorValuePtr > circt::om::Evaluator::evaluateIntegerBinaryArithmetic	(	IntegerBinaryArithmeticOp	op,
		ActualParameters	actualParams,
		Location	loc
	)

private

Definition at line 401 of file Evaluator.cpp.

References assert(), circt::om::evaluator::AttributeValue::get(), and circt::om::evaluator::AttributeValue::getAs().

◆ evaluateListConcat()

FailureOr< evaluator::EvaluatorValuePtr > circt::om::Evaluator::evaluateListConcat	(	ListConcatOp	op,
		ActualParameters	actualParams,
		Location	loc
	)

private

Evaluator dispatch function for List concatenation.

Definition at line 592 of file Evaluator.cpp.

References circt::om::evaluator::ListValue::getElements(), and circt::om::evaluator::EvaluatorValue::isFullyEvaluated().

◆ evaluateListCreate()

FailureOr< evaluator::EvaluatorValuePtr > circt::om::Evaluator::evaluateListCreate	(	ListCreateOp	op,
		ActualParameters	actualParams,
		Location	loc
	)

private

Evaluator dispatch function for List creation.

Definition at line 566 of file Evaluator.cpp.

◆ evaluateObjectField()

FailureOr< evaluator::EvaluatorValuePtr > circt::om::Evaluator::evaluateObjectField	(	ObjectFieldOp	op,
		ActualParameters	actualParams,
		Location	loc
	)

private

Evaluator dispatch function for Object fields.

Definition at line 522 of file Evaluator.cpp.

◆ evaluateObjectInstance() [1/2]

FailureOr< evaluator::EvaluatorValuePtr > circt::om::Evaluator::evaluateObjectInstance	(	ObjectOp	op,
		ActualParameters	actualParams
	)

private

Evaluator dispatch function for Object instances.

Definition at line 506 of file Evaluator.cpp.

◆ evaluateObjectInstance() [2/2]

FailureOr< evaluator::EvaluatorValuePtr > circt::om::Evaluator::evaluateObjectInstance	(	StringAttr	className,
		ActualParameters	actualParams,
		Location	loc,
		ObjectKey	instanceKey = `{}`
	)

private

Instantiate an Object with its class name and actual parameters.

Definition at line 180 of file Evaluator.cpp.

References assert(), and context.

◆ evaluateParameter()

FailureOr< evaluator::EvaluatorValuePtr > circt::om::Evaluator::evaluateParameter	(	BlockArgument	formalParam,
		ActualParameters	actualParams,
		Location	loc
	)

private

Evaluator dispatch functions for the small expression grammar.

Evaluator dispatch function for parameters.

Definition at line 383 of file Evaluator.cpp.

◆ evaluatePathCreate()

FailureOr< evaluator::EvaluatorValuePtr > circt::om::Evaluator::evaluatePathCreate	(	FrozenPathCreateOp	op,
		ActualParameters	actualParams,
		Location	loc
	)

private

Definition at line 659 of file Evaluator.cpp.

◆ evaluateUnknownValue()

FailureOr< evaluator::EvaluatorValuePtr > circt::om::Evaluator::evaluateUnknownValue	(	UnknownValueOp	op,
		Location	loc
	)

private

Definition at line 687 of file Evaluator.cpp.

◆ evaluateValue()

FailureOr< evaluator::EvaluatorValuePtr > circt::om::Evaluator::evaluateValue	(	Value	value,
		ActualParameters	actualParams,
		Location	loc
	)

private

Evaluate a Value in a Class body according to the small expression grammar described in the rationale document.

The actual parameters are the values supplied at the current instantiation of the Class being evaluated.

Definition at line 326 of file Evaluator.cpp.

◆ getModule()

ModuleOp circt::om::Evaluator::getModule ( )

Get the Module this Evaluator is built from.

Definition at line 30 of file Evaluator.cpp.

◆ getOrCreateValue()

FailureOr< evaluator::EvaluatorValuePtr > circt::om::Evaluator::getOrCreateValue	(	Value	value,
		ActualParameters	actualParams,
		Location	loc
	)

private

Definition at line 96 of file Evaluator.cpp.

References circt::om::evaluator::AttributeValue::get, and circt::om::evaluator::PathValue::getEmptyPath().

◆ getPartiallyEvaluatedValue()

FailureOr< evaluator::EvaluatorValuePtr > circt::om::Evaluator::getPartiallyEvaluatedValue	(	Type	type,
		Location	loc
	)

Definition at line 71 of file Evaluator.cpp.

◆ instantiate()

FailureOr< std::shared_ptr< evaluator::EvaluatorValue > > circt::om::Evaluator::instantiate	(	StringAttr	className,
		ArrayRef< EvaluatorValuePtr >	actualParams
	)

Instantiate an Object with its class name and actual parameters.

Definition at line 281 of file Evaluator.cpp.

Referenced by omEvaluatorInstantiate().

◆ isFullyEvaluated() [1/2]

bool circt::om::Evaluator::isFullyEvaluated ( ObjectKey key )

inlineprivate

Definition at line 404 of file Evaluator.h.

References objects.

◆ isFullyEvaluated() [2/2]

bool circt::om::Evaluator::isFullyEvaluated	(	Value	value,
		ActualParameters	key
	)

inlineprivate

Definition at line 400 of file Evaluator.h.

References isFullyEvaluated().

Referenced by isFullyEvaluated().

Member Data Documentation

◆ actualParametersBuffers

SmallVector< std::unique_ptr<SmallVector<std::shared_ptr<evaluator::EvaluatorValue> > > > circt::om::Evaluator::actualParametersBuffers

private

This uniquely stores vectors that represent parameters.

Definition at line 470 of file Evaluator.h.

◆ objects

DenseMap<ObjectKey, std::shared_ptr<evaluator::EvaluatorValue> > circt::om::Evaluator::objects

private

Evaluator value storage.

Return an evaluator value for the given instantiation context (a pair of Value and parameters).

Definition at line 477 of file Evaluator.h.

Referenced by isFullyEvaluated().

◆ symbolTable

SymbolTable circt::om::Evaluator::symbolTable

private

The symbol table for the IR module the Evaluator was constructed with.

Used to look up class definitions.

Definition at line 465 of file Evaluator.h.

◆ worklist

std::queue<ObjectKey> circt::om::Evaluator::worklist

private

A worklist that tracks values which needs to be fully evaluated.

Definition at line 473 of file Evaluator.h.

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

/home/runner/work/circt-www/circt-www/circt_src/include/circt/Dialect/OM/Evaluator/Evaluator.h
/home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/OM/Evaluator/Evaluator.cpp

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ActualParameters

◆ ObjectKey

Constructor & Destructor Documentation

◆ Evaluator()

Member Function Documentation

◆ allocateObjectInstance()

◆ createParametersFromOperands()

◆ evaluateBasePathCreate()

◆ evaluateConstant()

◆ evaluateEmptyPath()

◆ evaluateIntegerBinaryArithmetic()

◆ evaluateListConcat()

◆ evaluateListCreate()

◆ evaluateObjectField()

◆ evaluateObjectInstance() [1/2]

◆ evaluateObjectInstance() [2/2]

◆ evaluateParameter()

◆ evaluatePathCreate()

◆ evaluateUnknownValue()

◆ evaluateValue()

◆ getModule()

◆ getOrCreateValue()

◆ getPartiallyEvaluatedValue()

◆ instantiate()

◆ isFullyEvaluated() [1/2]

◆ isFullyEvaluated() [2/2]

Member Data Documentation

◆ actualParametersBuffers

◆ objects

◆ symbolTable

◆ worklist