Typedefs
using	EmitErrorFn = std::function< void(std::function< bool(InFlightDiagnostic &)>)>
	Whenever the nested function returns true, a note referring to the referenced module is attached to the error.

Functions
LogicalResult	verifyReferencedModule (Operation instanceOp, SymbolTableCollection &symbolTable, mlir::FlatSymbolRefAttr moduleName, Operation &module)
	Verify that the instance refers to a valid HW module.

LogicalResult	resolveParametricTypes (Location loc, ArrayAttr parameters, ArrayRef< Type > types, SmallVectorImpl< Type > &resolvedTypes, const EmitErrorFn &emitError)
	Stores a resolved version of each type in.

LogicalResult	verifyInputs (ArrayAttr argNames, ArrayAttr moduleArgNames, TypeRange inputTypes, ArrayRef< Type > moduleInputTypes, const EmitErrorFn &emitError)
	Verify that the list of inputs of the instance and the module match in terms of length, names, and types.

LogicalResult	verifyOutputs (ArrayAttr resultNames, ArrayAttr moduleResultNames, TypeRange resultTypes, ArrayRef< Type > moduleResultTypes, const EmitErrorFn &emitError)
	Verify that the list of outputs of the instance and the module match in terms of length, names, and types.

LogicalResult	verifyParameters (ArrayAttr parameters, ArrayAttr moduleParameters, ArrayRef< Type > resolvedModParametersRefs, const EmitErrorFn &emitError)
	Verify that the parameter lists of the instance and the module match in terms of length, names, and types.

LogicalResult	verifyInstanceOfHWModule (Operation *instance, FlatSymbolRefAttr moduleRef, OperandRange inputs, TypeRange results, ArrayAttr argNames, ArrayAttr resultNames, ArrayAttr parameters, SymbolTableCollection &symbolTable)
	Combines verifyReferencedModule, verifyInputs, verifyOutputs, and verifyParameters.

LogicalResult	verifyParameterStructure (ArrayAttr parameters, ArrayAttr moduleParameters, const EmitErrorFn &emitError)
	Check that all the parameter values specified to the instance are structurally valid.

StringAttr	getName (ArrayAttr names, size_t idx)
	Return the name at the specified index of the ArrayAttr or null if it cannot be determined.

ArrayAttr	updateName (ArrayAttr oldNames, size_t i, StringAttr name)
	Change the name at the specified index of the.

void	getAsmResultNames (OpAsmSetValueNameFn setNameFn, StringRef instanceName, ArrayAttr resultNames, ValueRange results)
	Suggest a name for each result value based on the saved result names attribute.

SmallVector< PortInfo >	getPortList (Operation *instanceOp)
	Return the port list of an instance, based on the name, type and location attributes present on the instance.

Typedef Documentation

◆ EmitErrorFn

using circt::hw::instance_like_impl::EmitErrorFn = typedef std::function<void(std::function<bool(InFlightDiagnostic &)>)>

Whenever the nested function returns true, a note referring to the referenced module is attached to the error.

Definition at line 31 of file HWInstanceImplementation.h.

Function Documentation

◆ getAsmResultNames()

void circt::hw::instance_like_impl::getAsmResultNames	(	OpAsmSetValueNameFn	setNameFn,
		StringRef	instanceName,
		ArrayAttr	resultNames,
		ValueRange	results
	)

Suggest a name for each result value based on the saved result names attribute.

Definition at line 338 of file HWInstanceImplementation.cpp.

References getName().

◆ getName()

StringAttr circt::hw::instance_like_impl::getName	(	ArrayAttr	names,
		size_t	idx
	)

Return the name at the specified index of the ArrayAttr or null if it cannot be determined.

Definition at line 322 of file HWInstanceImplementation.cpp.

Referenced by getAsmResultNames().

◆ getPortList()

SmallVector< PortInfo > circt::hw::instance_like_impl::getPortList ( Operation * instanceOp )

Return the port list of an instance, based on the name, type and location attributes present on the instance.

Definition at line 357 of file HWInstanceImplementation.cpp.

References circt::hw::getModuleType().

◆ resolveParametricTypes()

LogicalResult circt::hw::instance_like_impl::resolveParametricTypes	(	Location	loc,
		ArrayAttr	parameters,
		ArrayRef< Type >	types,
		SmallVectorImpl< Type > &	resolvedTypes,
		const EmitErrorFn &	emitError
	)

Stores a resolved version of each type in.

Parameters

types	wherein any parameter reference has been evaluated based on the set of provided
parameters	in
resolvedTypes

Definition at line 32 of file HWInstanceImplementation.cpp.

References circt::hw::evaluateParametricType().

Referenced by verifyInstanceOfHWModule().

◆ updateName()

ArrayAttr circt::hw::instance_like_impl::updateName	(	ArrayAttr	oldNames,
		size_t	i,
		StringAttr	name
	)

Change the name at the specified index of the.

Parameters

oldNames	ArrayAttr to
name

Definition at line 329 of file HWInstanceImplementation.cpp.

◆ verifyInputs()

LogicalResult circt::hw::instance_like_impl::verifyInputs	(	ArrayAttr	argNames,
		ArrayAttr	moduleArgNames,
		TypeRange	inputTypes,
		ArrayRef< Type >	moduleInputTypes,
		const EmitErrorFn &	emitError
	)

Verify that the list of inputs of the instance and the module match in terms of length, names, and types.

Definition at line 51 of file HWInstanceImplementation.cpp.

Referenced by verifyInstanceOfHWModule().

◆ verifyInstanceOfHWModule()

LogicalResult circt::hw::instance_like_impl::verifyInstanceOfHWModule	(	Operation *	instance,
		FlatSymbolRefAttr	moduleRef,
		OperandRange	inputs,
		TypeRange	results,
		ArrayAttr	argNames,
		ArrayAttr	resultNames,
		ArrayAttr	parameters,
		SymbolTableCollection &	symbolTable
	)

Combines verifyReferencedModule, verifyInputs, verifyOutputs, and verifyParameters.

It is only allowed to call this function when the instance refers to a HW module. The

Parameters

parameters attribute may be null in which case not parameters are verified.

Definition at line 201 of file HWInstanceImplementation.cpp.

References circt::hw::getModuleType(), resolveParametricTypes(), verifyInputs(), verifyOutputs(), verifyParameters(), and verifyReferencedModule().

◆ verifyOutputs()

LogicalResult circt::hw::instance_like_impl::verifyOutputs	(	ArrayAttr	resultNames,
		ArrayAttr	moduleResultNames,
		TypeRange	resultTypes,
		ArrayRef< Type >	moduleResultTypes,
		const EmitErrorFn &	emitError
	)

Verify that the list of outputs of the instance and the module match in terms of length, names, and types.

Definition at line 101 of file HWInstanceImplementation.cpp.

Referenced by verifyInstanceOfHWModule().

◆ verifyParameters()

LogicalResult circt::hw::instance_like_impl::verifyParameters	(	ArrayAttr	parameters,
		ArrayAttr	moduleParameters,
		ArrayRef< Type >	resolvedModParametersRefs,
		const EmitErrorFn &	emitError
	)

Verify that the parameter lists of the instance and the module match in terms of length, names, and types.

Definition at line 149 of file HWInstanceImplementation.cpp.

Referenced by verifyInstanceOfHWModule().

◆ verifyParameterStructure()

LogicalResult circt::hw::instance_like_impl::verifyParameterStructure	(	ArrayAttr	parameters,
		ArrayAttr	moduleParameters,
		const EmitErrorFn &	emitError
	)

Check that all the parameter values specified to the instance are structurally valid.

Definition at line 284 of file HWInstanceImplementation.cpp.

References circt::hw::checkParameterInContext().

◆ verifyReferencedModule()

LogicalResult circt::hw::instance_like_impl::verifyReferencedModule	(	Operation *	instanceOp,
		SymbolTableCollection &	symbolTable,
		mlir::FlatSymbolRefAttr	moduleName,
		Operation *&	module
	)

Verify that the instance refers to a valid HW module.

Definition at line 16 of file HWInstanceImplementation.cpp.

Referenced by verifyInstanceOfHWModule().

Typedefs

Functions

Typedef Documentation

◆ EmitErrorFn

Function Documentation

◆ getAsmResultNames()

◆ getName()

◆ getPortList()

◆ resolveParametricTypes()

◆ updateName()

◆ verifyInputs()

◆ verifyInstanceOfHWModule()

◆ verifyOutputs()

◆ verifyParameters()

◆ verifyParameterStructure()

◆ verifyReferencedModule()