13#ifndef CIRCT_DIALECT_FIRRTL_TYPES_H
14#define CIRCT_DIALECT_FIRRTL_TYPES_H
21#include "mlir/IR/OpDefinition.h"
22#include "mlir/IR/Types.h"
23#include "llvm/ADT/TypeSwitch.h"
28struct FIRRTLBaseTypeStorage;
29struct WidthTypeStorage;
30struct BundleTypeStorage;
31struct FVectorTypeStorage;
32struct FEnumTypeStorage;
33struct CMemoryTypeStorage;
36struct BaseTypeAliasStorage;
37struct OpenBundleTypeStorage;
38struct OpenVectorTypeStorage;
39struct ClassTypeStorage;
64class BaseTypeAliasType;
90 return llvm::isa<FIRRTLDialect>(type.getDialect());
144 :
public FIRRTLType::TypeBase<FIRRTLBaseType, FIRRTLType,
145 detail::FIRRTLBaseTypeStorage> {
155 bool isPassive()
const {
return getRecursiveTypeProperties().isPassive; }
187 return llvm::isa<FIRRTLDialect>(type.getDialect()) &&
188 !llvm::isa<
PropertyType, RefType, LHSType, OpenBundleType,
189 OpenVectorType, FStringType>(type);
217 bool destOuterTypeIsConst =
false,
218 bool srcOuterTypeIsConst =
false,
219 bool requireSameWidths =
false);
226 bool destFlip =
false,
bool srcFlip =
false,
227 bool destOuterTypeIsConst =
false,
228 bool srcOuterTypeIsConst =
false);
232 bool srcOuterTypeIsConst =
false);
270template <
typename ConcreteType>
272 :
public mlir::TypeTrait::TraitBase<ConcreteType, WidthQualifiedTypeTrait> {
277 auto width =
static_cast<const ConcreteType *
>(
this)->getWidthOrSentinel();
285 return 0 <=
static_cast<const ConcreteType *
>(
this)->getWidthOrSentinel();
299 using FIRRTLBaseType::FIRRTLBaseType;
304 int32_t widthOrSentinel = -1,
bool isConst =
false);
306 bool isSigned() {
return mlir::isa<SIntType>(*
this); }
315 static bool classof(Type type) {
return mlir::isa<SIntType, UIntType>(type); }
326 return llvm::isa<AnyRefType, ClassType, StringType, FIntegerType, ListType,
327 PathType, BoolType, DoubleType>(type);
331 using FIRRTLType::FIRRTLType;
383std::optional<int64_t>
getBitWidth(FIRRTLBaseType type,
384 bool ignoreFlip =
false);
402#define GET_TYPEDEF_CLASSES
403#include "circt/Dialect/FIRRTL/FIRRTLTypes.h.inc"
413 return FIRRTLType(
static_cast<mlir::Type::ImplType *
>(pointer));
417 return FIRRTLType(
static_cast<mlir::Type::ImplType *
>(pointer));
435template <
typename head,
typename... tail>
442template <
typename BaseTy>
444 static constexpr bool isFIRRTLBaseType =
445 std::is_base_of<FIRRTLBaseType, BaseTy>::value &&
446 !std::is_same_v<FIRRTLBaseType, BaseTy>;
447 static constexpr bool isFIRRTLType =
448 std::is_base_of<FIRRTLType, BaseTy>::value;
451 static constexpr bool value = isFIRRTLBaseType || !isFIRRTLType;
454template <
typename... BaseTy>
457 if (isa<BaseTy...>(type))
463 if (
auto alias = dyn_cast<BaseTypeAliasType>(type))
464 return type_isa<BaseTy...>(alias.getInnerType());
471template <
typename... BaseTy>
478template <
typename BaseTy>
480 assert(type_isa<BaseTy>(type) &&
"type must convert to requested type");
483 if (isa<BaseTy>(type))
484 return cast<BaseTy>(type);
488 if (
auto alias = dyn_cast<BaseTypeAliasType>(type))
489 return type_cast<BaseTy>(alias.getInnerType());
494 return cast<BaseTy>(type);
497template <
typename BaseTy>
499 if (type_isa<BaseTy>(type))
500 return type_cast<BaseTy>(type);
504template <
typename BaseTy>
507 if (type_isa_and_nonnull<BaseTy>(type))
508 return type_cast<BaseTy>(type);
519template <
typename T,
typename ResultT =
void>
529 template <
typename CaseT,
typename CallableT>
536 if (
auto caseValue = circt::firrtl::type_dyn_cast<CaseT>(this->value))
537 result.emplace(caseFn(caseValue));
542 template <
typename CallableT>
543 [[nodiscard]] ResultT
546 return std::move(*
result);
547 return defaultFn(this->value);
551 [[nodiscard]] ResultT
554 return std::move(*
result);
555 return defaultResult;
558 [[nodiscard]]
operator ResultT() {
560 return std::move(*
result);
558 [[nodiscard]]
operator ResultT() {
…}
580 template <
typename CaseT,
typename CallableT>
587 if (
auto caseValue = circt::firrtl::type_dyn_cast<CaseT>(this->value)) {
595 template <
typename CallableT>
598 defaultFn(this->value);
603 bool foundMatch =
false;
606template <
typename BaseTy>
609 firrtl::FIRRTLBaseType,
610 detail::FIRRTLBaseTypeStorage> {
616 static bool classof(Type other) {
return type_isa<BaseTy>(other); }
619 operator BaseTy()
const {
return circt::firrtl::type_cast<BaseTy>(*
this); }
621 BaseTy
base()
const {
return circt::firrtl::type_cast<BaseTy>(*
this); }
assert(baseType &&"element must be base type")
static bool classof(Type other)
A struct to check if there is a type derived from FIRRTLBaseType.
static constexpr bool value
FIRRTLBaseType getAnonymousType()
Return this type with any type alias types recursively removed from itself.
static bool classof(Type type)
Support method to enable LLVM-style type casting.
bool isResetType()
Return true if this is a valid "reset" type.
bool isRegisterType()
Returns true if this is a non-const "passive" that which is not analog.
FIRRTLBaseType getMaskType()
Return this type with all ground types replaced with UInt<1>.
FIRRTLBaseType getPassiveType()
Return this type with any flip types recursively removed from itself.
int32_t getBitWidthOrSentinel()
If this is an IntType, AnalogType, or sugar type for a single bit (Clock, Reset, etc) then return the...
bool isConst()
Returns true if this is a 'const' type that can only hold compile-time constant values.
FIRRTLBaseType getAllConstDroppedType()
Return this type with a 'const' modifiers dropped.
bool isPassive() const
Return true if this is a "passive" type - one that contains no "flip" types recursively within itself...
FIRRTLBaseType getConstType(bool isConst)
Return a 'const' or non-'const' version of this type.
FIRRTLBaseType getWidthlessType()
Return this type with widths of all ground types removed.
void Default(CallableT &&defaultFn)
As a default, invoke the given callable within the root value.
FIRRTLTypeSwitch< T, void > & Case(CallableT &&caseFn)
Add a case on the given type.
FIRRTLTypeSwitch(FIRRTLTypeSwitch &&other)=default
This class implements the same functionality as TypeSwitch except that it uses firrtl::type_dyn_cast ...
ResultT Default(ResultT defaultResult)
As a default, return the given value.
FIRRTLTypeSwitch< T, ResultT > & Case(CallableT &&caseFn)
Add a case on the given type.
FIRRTLTypeSwitch(FIRRTLTypeSwitch &&other)=default
ResultT Default(CallableT &&defaultFn)
As a default, invoke the given callable within the root value.
std::optional< ResultT > result
The pointer to the result of this switch statement, once known, null before that.
bool containsReference()
Return true if this is or contains a Reference type.
bool isGround()
Return true if this is a 'ground' type, aka a non-aggregate type.
static bool classof(Type type)
Support method to enable LLVM-style type casting.
bool isConst()
Returns true if this is a 'const' type that can only hold compile-time constant values.
bool hasUninferredWidth()
Return true if this type contains an uninferred bit width.
bool containsTypeAlias()
Return true if this is an anonymous type (no type alias).
RecursiveTypeProperties getRecursiveTypeProperties() const
Return the recursive properties of the type, containing the isPassive, containsAnalog,...
bool hasUninferredReset()
Return true if this type contains an uninferred bit reset.
bool containsAnalog()
Return true if this is or contains an Analog type.
bool containsConst()
Returns true if this is or contains a 'const' type.
This is the common base class between SIntType and UIntType.
static bool classof(Type type)
int32_t getWidthOrSentinel() const
Return the width of this type, or -1 if it has none specified.
static IntType get(MLIRContext *context, bool isSigned, int32_t widthOrSentinel=-1, bool isConst=false)
Return an SIntType or UIntType with the specified signedness, width, and constness.
IntType getConstType(bool isConst)
Return a 'const' or non-'const' version of this type.
static bool classof(Type type)
Support method to enable LLVM-style type casting.
Trait for types which have a width.
bool hasWidth() const
Return true if this integer type has a known width.
std::optional< int32_t > getWidth() const
Return an optional containing the width, if the width is known (or empty if width is unknown).
BaseTy type_cast(Type type)
Direction
This represents the direction of a single port.
mlir::TypedValue< FIRRTLBaseType > FIRRTLBaseValue
ParseResult parseNestedType(FIRRTLType &result, AsmParser &parser)
Parse a FIRRTLType.
bool areAnonymousTypesEquivalent(FIRRTLBaseType lhs, FIRRTLBaseType rhs)
Return true if anonymous types of given arguments are equivalent by pointer comparison.
bool type_isa_and_nonnull(Type type)
ParseResult parseNestedBaseType(FIRRTLBaseType &result, AsmParser &parser)
bool isTypeInOut(mlir::Type type)
Returns true if the given type has some flipped (aka unaligned) dataflow.
bool areTypesRefCastable(Type dstType, Type srcType)
Return true if destination ref type can be cast from source ref type, per FIRRTL spec rules they must...
bool areTypesEquivalent(FIRRTLType destType, FIRRTLType srcType, bool destOuterTypeIsConst=false, bool srcOuterTypeIsConst=false, bool requireSameWidths=false)
Returns whether the two types are equivalent.
bool areTypesWeaklyEquivalent(FIRRTLType destType, FIRRTLType srcType, bool destFlip=false, bool srcFlip=false, bool destOuterTypeIsConst=false, bool srcOuterTypeIsConst=false)
Returns true if two types are weakly equivalent.
mlir::Type getPassiveType(mlir::Type anyBaseFIRRTLType)
bool isTypeLarger(FIRRTLBaseType dstType, FIRRTLBaseType srcType)
Returns true if the destination is at least as wide as a source.
bool containsConst(Type type)
Returns true if the type is or contains a 'const' type whose value is guaranteed to be unchanging at ...
mlir::TypedValue< FIRRTLType > FIRRTLValue
bool hasZeroBitWidth(FIRRTLType type)
Return true if the type has zero bit width.
BaseTy type_dyn_cast(Type type)
void printNestedType(Type type, AsmPrinter &os)
Print a type defined by this dialect.
BaseTy type_dyn_cast_or_null(Type type)
mlir::TypedValue< PropertyType > FIRRTLPropertyValue
bool isConst(Type type)
Returns true if this is a 'const' type whose value is guaranteed to be unchanging at circuit executio...
llvm::hash_code hash_value(const ClassElement &element)
bool areTypesConstCastable(FIRRTLType destType, FIRRTLType srcType, bool srcOuterTypeIsConst=false)
Returns whether the srcType can be const-casted to the destType.
ParseResult parseNestedPropertyType(PropertyType &result, AsmParser &parser)
std::optional< int64_t > getBitWidth(FIRRTLBaseType type, bool ignoreFlip=false)
The InstanceGraph op interface, see InstanceGraphInterface.td for more details.
llvm::hash_code hash_value(const T &e)
bool isInOut() const
Return true if this is an inout port.
ClassElement(StringAttr name, Type type, Direction direction)
bool isOutput() const
Return true if this is a simple input-only element.
bool isInput() const
Return true if this is a simple output-only element.
StringRef getName() const
bool operator!=(const ClassElement &rhs) const
bool operator==(const ClassElement &rhs) const
A collection of bits indicating the recursive properties of a type.
bool containsReference
Whether the type contains a reference type.
bool isPassive
Whether the type only contains passive elements.
bool containsAnalog
Whether the type contains an analog type.
bool hasUninferredReset
Whether the type has any uninferred reset.
bool containsTypeAlias
Whether the type contains a type alias.
bool containsConst
Whether the type contains a const type.
bool hasUninferredWidth
Whether the type has any uninferred bit widths.
static FIRRTLType getTombstoneKey()
static FIRRTLType getEmptyKey()
static unsigned getHashValue(FIRRTLType val)
static bool isEqual(FIRRTLType LHS, FIRRTLType RHS)