#include "circt/Dialect/HW/HWOps.h"
#include "circt/Dialect/HW/CustomDirectiveImpl.h"
#include "circt/Dialect/HW/HWAttributes.h"
#include "circt/Dialect/HW/HWInstanceImplementation.h"
#include "circt/Dialect/HW/HWSymCache.h"
#include "circt/Dialect/HW/HWVisitors.h"
#include "circt/Dialect/HW/ModuleImplementation.h"
#include "circt/Support/CustomDirectiveImpl.h"
#include "circt/Support/Namespace.h"
#include "circt/Support/Naming.h"
#include "mlir/IR/Builders.h"
#include "mlir/IR/Matchers.h"
#include "mlir/IR/PatternMatch.h"
#include "mlir/Interfaces/FunctionImplementation.h"
#include "llvm/ADT/BitVector.h"
#include "llvm/ADT/SmallPtrSet.h"
#include "llvm/ADT/StringSet.h"
#include "circt/Dialect/HW/HWCanonicalization.cpp.inc"
#include "circt/Dialect/HW/HW.cpp.inc"

Include dependency graph for HWOps.cpp:

Macros
#define	GET_OP_CLASSES

Enumerations
enum class	Delimiter { None , Paren , OptionalLessGreater }

Functions
static Value	foldStructExtract (Operation *inputOp, uint32_t fieldIndex)

static ArrayAttr	arrayOrEmpty (mlir::MLIRContext *context, ArrayRef< Attribute > attrs)

static void	getAsmBlockArgumentNamesImpl (mlir::Region &region, OpAsmSetValueNameFn setNameFn)
	Get a special name to use when printing the entry block arguments of the region contained by an operation in this dialect.

template<class Op >
static bool	hasAdditionalAttributes (Op op, ArrayRef< StringRef > ignoredAttrs={})
	Check whether an operation has any additional attributes set beyond its standard list of attributes returned by `getAttributeNames`.

static LogicalResult	checkAttributes (Operation *op, Attribute attr, Type type)

static ParseResult	parseParamValue (OpAsmParser &p, Attribute &value, Type &resultType)

static void	printParamValue (OpAsmPrinter &p, Operation *, Attribute value, Type resultType)

template<typename ModuleTy >
static void	buildModule (OpBuilder &builder, OperationState &result, StringAttr name, const ModulePortInfo &ports, ArrayAttr parameters, ArrayRef< NamedAttribute > attributes, StringAttr comment)

static void	modifyModuleArgs (MLIRContext context, ArrayRef< std::pair< unsigned, PortInfo > > insertArgs, ArrayRef< unsigned > removeArgs, ArrayRef< Attribute > oldArgNames, ArrayRef< Type > oldArgTypes, ArrayRef< Attribute > oldArgAttrs, ArrayRef< Location > oldArgLocs, SmallVector< Attribute > &newArgNames, SmallVector< Type > &newArgTypes, SmallVector< Attribute > &newArgAttrs, SmallVector< Location > &newArgLocs, Block body=nullptr)
	Internal implementation of argument/result insertion and removal on modules.

static void	modifyModulePorts (Operation op, ArrayRef< std::pair< unsigned, PortInfo > > insertInputs, ArrayRef< std::pair< unsigned, PortInfo > > insertOutputs, ArrayRef< unsigned > removeInputs, ArrayRef< unsigned > removeOutputs, Block body=nullptr)
	Insert and remove ports of a module.

static bool	hasAttribute (StringRef name, ArrayRef< NamedAttribute > attrs)

template<typename ModuleTy >
static ParseResult	parseHWModuleOp (OpAsmParser &parser, OperationState &result)

FunctionType	getHWModuleOpType (Operation *op)

template<typename ModuleTy >
static void	printModuleOp (OpAsmPrinter &p, ModuleTy mod)

static LogicalResult	verifyModuleCommon (HWModuleLike module)

template<typename ModTy >
static SmallVector< Location >	getAllPortLocs (ModTy module)

template<typename ModTy >
static void	setAllPortNames (ArrayRef< Attribute > names, ModTy module)

template<typename ModTy >
static void	setHWModuleType (ModTy &mod, ModuleType type)

template<typename ModuleTy >
static SmallVector< PortInfo >	getPortList (ModuleTy &mod)

template<typename ModuleTy >
static PortInfo	getPort (ModuleTy &mod, size_t idx)

static ParseResult	parseSliceTypes (OpAsmParser &p, Type &srcType, Type &idxType)

static void	printSliceTypes (OpAsmPrinter &p, Operation *, Type srcType, Type idxType)

static LogicalResult	foldCreateToSlice (ArrayCreateOp op, PatternRewriter &rewriter)

static std::optional< uint64_t >	getUIntFromValue (Value value)

static ParseResult	parseArrayConcatTypes (OpAsmParser &p, SmallVectorImpl< Type > &inputTypes, Type &resultType)

static void	printArrayConcatTypes (OpAsmPrinter &p, Operation *, TypeRange inputTypes, Type resultType)

static bool	flattenConcatOp (ArrayConcatOp op, PatternRewriter &rewriter)

static bool	mergeConcatSlices (ArrayConcatOp op, PatternRewriter &rewriter)

template<typename AggregateOp , typename AggregateType >
static LogicalResult	verifyAggregateFieldIndexAndType (AggregateOp &op, AggregateType aggType, Type elementType)
	Ensure an aggregate op's field index is within the bounds of the aggregate type and the accessed field is of 'elementType'.

template<typename AggregateType >
static ParseResult	parseExtractOp (OpAsmParser &parser, OperationState &result)
	Use the same parser for both struct_extract and union_extract since the syntax is identical.

template<typename AggType >
static void	printExtractOp (OpAsmPrinter &printer, AggType op)
	Use the same printer for both struct_extract and union_extract since the syntax is identical.

static LogicalResult	canonicalizeArrayInjectChain (ArrayInjectOp op, PatternRewriter &rewriter)

static LogicalResult	canonicalizeArrayInjectIntoCreate (ArrayInjectOp op, PatternRewriter &rewriter)

Macro Definition Documentation

◆ GET_OP_CLASSES

#define GET_OP_CLASSES

Definition at line 3489 of file HWOps.cpp.

Enumeration Type Documentation

◆ Delimiter

enum class Delimiter

strong

Enumerator
None
Paren
OptionalLessGreater

Definition at line 116 of file HWOps.cpp.

Function Documentation

◆ arrayOrEmpty()

static ArrayAttr arrayOrEmpty	(	mlir::MLIRContext *	context,
		ArrayRef< Attribute >	attrs
	)

static

Definition at line 84 of file HWOps.cpp.

References empty.

Referenced by buildModule().

◆ buildModule()

template<typename ModuleTy >

static void buildModule	(	OpBuilder &	builder,
		OperationState &	result,
		StringAttr	name,
		const ModulePortInfo &	ports,
		ArrayAttr	parameters,
		ArrayRef< NamedAttribute >	attributes,
		StringAttr	comment
	)

static

Definition at line 557 of file HWOps.cpp.

References arrayOrEmpty().

◆ canonicalizeArrayInjectChain()

static LogicalResult canonicalizeArrayInjectChain	(	ArrayInjectOp	op,
		PatternRewriter &	rewriter
	)

static

Definition at line 2990 of file HWOps.cpp.

◆ canonicalizeArrayInjectIntoCreate()

static LogicalResult canonicalizeArrayInjectIntoCreate	(	ArrayInjectOp	op,
		PatternRewriter &	rewriter
	)

static

Definition at line 3041 of file HWOps.cpp.

◆ checkAttributes()

static LogicalResult checkAttributes	(	Operation *	op,
		Attribute	attr,
		Type	type
	)

static

Definition at line 407 of file HWOps.cpp.

References checkAttributes(), and elementType.

Referenced by checkAttributes().

◆ flattenConcatOp()

static bool flattenConcatOp	(	ArrayConcatOp	op,
		PatternRewriter &	rewriter
	)

static

Definition at line 2136 of file HWOps.cpp.

◆ foldCreateToSlice()

static LogicalResult foldCreateToSlice	(	ArrayCreateOp	op,
		PatternRewriter &	rewriter
	)

static

Definition at line 1866 of file HWOps.cpp.

References circt::hw::isOffset().

◆ foldStructExtract()

static Value foldStructExtract	(	Operation *	inputOp,
		uint32_t	fieldIndex
	)

static

Definition at line 69 of file HWOps.cpp.

◆ getAllPortLocs()

template<typename ModTy >

static SmallVector< Location > getAllPortLocs ( ModTy module )

static

Definition at line 1206 of file HWOps.cpp.

References assert().

◆ getAsmBlockArgumentNamesImpl()

static void getAsmBlockArgumentNamesImpl	(	mlir::Region &	region,
		OpAsmSetValueNameFn	setNameFn
	)

static

Get a special name to use when printing the entry block arguments of the region contained by an operation in this dialect.

Definition at line 101 of file HWOps.cpp.

◆ getHWModuleOpType()

FunctionType getHWModuleOpType ( Operation * op )

Definition at line 1023 of file HWOps.cpp.

◆ getPort()

template<typename ModuleTy >

static PortInfo getPort	(	ModuleTy &	mod,
		size_t	idx
	)

static

Definition at line 1448 of file HWOps.cpp.

◆ getPortList()

template<typename ModuleTy >

static SmallVector< PortInfo > getPortList ( ModuleTy & mod )

static

Definition at line 1428 of file HWOps.cpp.

◆ getUIntFromValue()

static std::optional< uint64_t > getUIntFromValue ( Value value )

static

Definition at line 1937 of file HWOps.cpp.

◆ hasAdditionalAttributes()

template<class Op >

static bool hasAdditionalAttributes	(	Op	op,
		ArrayRef< StringRef >	ignoredAttrs = `{}`
	)

static

Check whether an operation has any additional attributes set beyond its standard list of attributes returned by getAttributeNames.

Definition at line 353 of file HWOps.cpp.

◆ hasAttribute()

static bool hasAttribute	(	StringRef	name,
		ArrayRef< NamedAttribute >	attrs
	)

static

Definition at line 901 of file HWOps.cpp.

Referenced by parseHWModuleOp().

◆ mergeConcatSlices()

static bool mergeConcatSlices	(	ArrayConcatOp	op,
		PatternRewriter &	rewriter
	)

static

Definition at line 2153 of file HWOps.cpp.

References append(), and circt::hw::isOffset().

◆ modifyModuleArgs()

static void modifyModuleArgs	(	MLIRContext *	context,
		ArrayRef< std::pair< unsigned, PortInfo > >	insertArgs,
		ArrayRef< unsigned >	removeArgs,
		ArrayRef< Attribute >	oldArgNames,
		ArrayRef< Type >	oldArgTypes,
		ArrayRef< Attribute >	oldArgAttrs,
		ArrayRef< Location >	oldArgLocs,
		SmallVector< Attribute > &	newArgNames,
		SmallVector< Type > &	newArgTypes,
		SmallVector< Attribute > &	newArgAttrs,
		SmallVector< Location > &	newArgLocs,
		Block *	body = `nullptr`
	)

static

Internal implementation of argument/result insertion and removal on modules.

Definition at line 595 of file HWOps.cpp.

References assert(), and circt::hw::ModulePort::InOut.

Referenced by modifyModulePorts().

◆ modifyModulePorts()

static void modifyModulePorts	(	Operation *	op,
		ArrayRef< std::pair< unsigned, PortInfo > >	insertInputs,
		ArrayRef< std::pair< unsigned, PortInfo > >	insertOutputs,
		ArrayRef< unsigned >	removeInputs,
		ArrayRef< unsigned >	removeOutputs,
		Block *	body = `nullptr`
	)

static

Insert and remove ports of a module.

The insertion and removal indices must be in ascending order. The indices refer to the port positions before any insertion or removal occurs. Ports inserted at the same index will appear in the module in the same order as they were listed in the insert* array.

The operation must be any of the module-like operations.

This is marked deprecated as it's only used from HandshakeToHW and PortConverter and is likely broken and not currently tested. Users of this are still written dealing with input and output ports separately, which is an old and broken style.

Definition at line 694 of file HWOps.cpp.

References circt::hw::detail::fnToMod(), and modifyModuleArgs().

◆ parseArrayConcatTypes()

static ParseResult parseArrayConcatTypes	(	OpAsmParser &	p,
		SmallVectorImpl< Type > &	inputTypes,
		Type &	resultType
	)

static

Definition at line 2067 of file HWOps.cpp.

◆ parseExtractOp()

template<typename AggregateType >

static ParseResult parseExtractOp	(	OpAsmParser &	parser,
		OperationState &	result
	)

static

Use the same parser for both struct_extract and union_extract since the syntax is identical.

Definition at line 2494 of file HWOps.cpp.

◆ parseHWModuleOp()

template<typename ModuleTy >

static ParseResult parseHWModuleOp	(	OpAsmParser &	parser,
		OperationState &	result
	)

static

Definition at line 909 of file HWOps.cpp.

References hasAttribute(), circt::hw::ModulePort::Output, circt::hw::module_like_impl::parseModuleSignature(), and circt::parseOptionalParameterList().

◆ parseParamValue()

static ParseResult parseParamValue	(	OpAsmParser &	p,
		Attribute &	value,
		Type &	resultType
	)

static

Definition at line 493 of file HWOps.cpp.

◆ parseSliceTypes()

static ParseResult parseSliceTypes	(	OpAsmParser &	p,
		Type &	srcType,
		Type &	idxType
	)

static

Definition at line 1770 of file HWOps.cpp.

◆ printArrayConcatTypes()

static void printArrayConcatTypes	(	OpAsmPrinter &	p,
		Operation *	,
		TypeRange	inputTypes,
		Type	resultType
	)

static

Definition at line 2097 of file HWOps.cpp.

◆ printExtractOp()

template<typename AggType >

static void printExtractOp	(	OpAsmPrinter &	printer,
		AggType	op
	)

static

Use the same printer for both struct_extract and union_extract since the syntax is identical.

Definition at line 2531 of file HWOps.cpp.

◆ printModuleOp()

template<typename ModuleTy >

static void printModuleOp	(	OpAsmPrinter &	p,
		ModuleTy	mod
	)

static

Definition at line 1031 of file HWOps.cpp.

References circt::hw::module_like_impl::printModuleSignatureNew(), and circt::printOptionalParameterList().

◆ printParamValue()

static void printParamValue	(	OpAsmPrinter &	p,
		Operation *	,
		Attribute	value,
		Type	resultType
	)

static

Definition at line 501 of file HWOps.cpp.

◆ printSliceTypes()

static void printSliceTypes	(	OpAsmPrinter &	p,
		Operation *	,
		Type	srcType,
		Type	idxType
	)

static

Definition at line 1784 of file HWOps.cpp.

◆ setAllPortNames()

template<typename ModTy >

static void setAllPortNames	(	ArrayRef< Attribute >	names,
		ModTy	module
	)

static

Definition at line 1276 of file HWOps.cpp.

◆ setHWModuleType()

template<typename ModTy >

static void setHWModuleType	(	ModTy &	mod,
		ModuleType	type
	)

static

Definition at line 1349 of file HWOps.cpp.

◆ verifyAggregateFieldIndexAndType()

template<typename AggregateOp , typename AggregateType >

static LogicalResult verifyAggregateFieldIndexAndType	(	AggregateOp &	op,
		AggregateType	aggType,
		Type	elementType
	)

static

Ensure an aggregate op's field index is within the bounds of the aggregate type and the accessed field is of 'elementType'.

Definition at line 2468 of file HWOps.cpp.

References elementType, and circt::hw::getCanonicalType().

◆ verifyModuleCommon()

static LogicalResult verifyModuleCommon ( HWModuleLike module )

static

Definition at line 1086 of file HWOps.cpp.

References assert().

Macros

Enumerations

Functions

Macro Definition Documentation

◆ GET_OP_CLASSES

Enumeration Type Documentation

◆ Delimiter

Function Documentation

◆ arrayOrEmpty()

◆ buildModule()

◆ canonicalizeArrayInjectChain()

◆ canonicalizeArrayInjectIntoCreate()

◆ checkAttributes()

◆ flattenConcatOp()

◆ foldCreateToSlice()

◆ foldStructExtract()

◆ getAllPortLocs()

◆ getAsmBlockArgumentNamesImpl()

◆ getHWModuleOpType()

◆ getPort()

◆ getPortList()

◆ getUIntFromValue()

◆ hasAdditionalAttributes()

◆ hasAttribute()

◆ mergeConcatSlices()

◆ modifyModuleArgs()

◆ modifyModulePorts()

◆ parseArrayConcatTypes()

◆ parseExtractOp()

◆ parseHWModuleOp()

◆ parseParamValue()

◆ parseSliceTypes()

◆ printArrayConcatTypes()

◆ printExtractOp()

◆ printModuleOp()

◆ printParamValue()

◆ printSliceTypes()

◆ setAllPortNames()

◆ setHWModuleType()

◆ verifyAggregateFieldIndexAndType()

◆ verifyModuleCommon()