13#ifndef CIRCT_DIALECT_FIRRTL_FIRRTLVISITORS_H
14#define CIRCT_DIALECT_FIRRTL_FIRRTLVISITORS_H
17#include "mlir/IR/BuiltinOps.h"
18#include "llvm/ADT/TypeSwitch.h"
24template <
typename ConcreteType,
typename ResultType = void,
25 typename... ExtraArgs>
29 auto *thisCast =
static_cast<ConcreteType *
>(
this);
30 return TypeSwitch<Operation *, ResultType>(op)
33 ConstantOp, SpecialConstantOp, AggregateConstantOp, InvalidValueOp,
34 SubfieldOp, SubindexOp, SubaccessOp, IsTagOp, SubtagOp,
35 BundleCreateOp, VectorCreateOp, FEnumCreateOp, MultibitMuxOp,
36 TagExtractOp, OpenSubfieldOp, OpenSubindexOp, ObjectSubfieldOp,
39 AddPrimOp, SubPrimOp, MulPrimOp, DivPrimOp, RemPrimOp, AndPrimOp,
42 ElementwiseOrPrimOp, ElementwiseAndPrimOp, ElementwiseXorPrimOp,
44 LEQPrimOp, LTPrimOp, GEQPrimOp, GTPrimOp, EQPrimOp, NEQPrimOp,
46 CatPrimOp, DShlPrimOp, DShlwPrimOp, DShrPrimOp,
48 AsSIntPrimOp, AsUIntPrimOp, AsAsyncResetPrimOp, AsClockPrimOp,
49 CvtPrimOp, NegPrimOp, NotPrimOp, AndRPrimOp, OrRPrimOp, XorRPrimOp,
51 IsXIntrinsicOp, PlusArgsValueIntrinsicOp, PlusArgsTestIntrinsicOp,
52 SizeOfIntrinsicOp, ClockGateIntrinsicOp, ClockInverterIntrinsicOp,
53 ClockDividerIntrinsicOp, LTLAndIntrinsicOp, LTLOrIntrinsicOp,
54 LTLIntersectIntrinsicOp, LTLDelayIntrinsicOp, LTLConcatIntrinsicOp,
55 LTLRepeatIntrinsicOp, LTLGoToRepeatIntrinsicOp,
56 LTLNonConsecutiveRepeatIntrinsicOp, LTLNotIntrinsicOp,
57 LTLImplicationIntrinsicOp, LTLUntilIntrinsicOp,
58 LTLEventuallyIntrinsicOp, LTLClockIntrinsicOp, Mux2CellIntrinsicOp,
59 Mux4CellIntrinsicOp, HasBeenResetIntrinsicOp,
61 BitsPrimOp, HeadPrimOp, MuxPrimOp, PadPrimOp, ShlPrimOp, ShrPrimOp,
62 TailPrimOp, VerbatimExprOp, HWStructCastOp, BitCastOp, RefSendOp,
63 RefResolveOp, RefSubOp, RWProbeOp, XMRRefOp, XMRDerefOp,
65 UninferredResetCastOp, ConstCastOp, RefCastOp,
67 StringConstantOp, FIntegerConstantOp, BoolConstantOp,
68 DoubleConstantOp, ListCreateOp, ListConcatOp, UnresolvedPathOp,
69 PathOp, IntegerAddOp, IntegerMulOp, IntegerShrOp,
71 TimeOp, HierarchicalModuleNameOp>([&](
auto expr) -> ResultType {
72 return thisCast->visitExpr(expr, args...);
74 .Default([&](
auto expr) -> ResultType {
75 return thisCast->visitInvalidExpr(op, args...);
81 op->emitOpError(
"unknown FIRRTL expression");
103#define HANDLE(OPTYPE, OPKIND) \
104 ResultType visitExpr(OPTYPE op, ExtraArgs... args) { \
105 return static_cast<ConcreteType *>(this)->visit##OPKIND##Expr(op, \
103#define HANDLE(OPTYPE, OPKIND) \ …
170 HANDLE(PlusArgsValueIntrinsicOp, Unhandled);
171 HANDLE(PlusArgsTestIntrinsicOp, Unhandled);
174 HANDLE(ClockInverterIntrinsicOp, Unhandled);
175 HANDLE(ClockDividerIntrinsicOp, Unhandled);
178 HANDLE(LTLIntersectIntrinsicOp, Unhandled);
182 HANDLE(LTLGoToRepeatIntrinsicOp, Unhandled);
183 HANDLE(LTLNonConsecutiveRepeatIntrinsicOp, Unhandled);
185 HANDLE(LTLImplicationIntrinsicOp, Unhandled);
187 HANDLE(LTLEventuallyIntrinsicOp, Unhandled);
191 HANDLE(HasBeenResetIntrinsicOp, Unhandled);
212 HANDLE(UninferredResetCastOp, Unhandled);
232 HANDLE(HierarchicalModuleNameOp, Unhandled);
237template <
typename ConcreteType,
typename ResultType = void,
238 typename... ExtraArgs>
242 auto *thisCast =
static_cast<ConcreteType *
>(
this);
243 return TypeSwitch<Operation *, ResultType>(op)
244 .template Case<AttachOp, ConnectOp, MatchingConnectOp, RefDefineOp,
245 ForceOp, PrintFOp, FPrintFOp, FFlushOp, SkipOp, StopOp,
246 WhenOp, AssertOp, AssumeOp, CoverOp, PropAssignOp,
247 RefForceOp, RefForceInitialOp, RefReleaseOp,
248 RefReleaseInitialOp, FPGAProbeIntrinsicOp,
249 VerifAssertIntrinsicOp, VerifAssumeIntrinsicOp,
250 UnclockedAssumeIntrinsicOp, VerifCoverIntrinsicOp,
251 VerifRequireIntrinsicOp, VerifEnsureIntrinsicOp,
252 LayerBlockOp, MatchOp, ViewIntrinsicOp, BindOp>(
253 [&](
auto opNode) -> ResultType {
254 return thisCast->visitStmt(opNode, args...);
256 .Default([&](
auto expr) -> ResultType {
257 return thisCast->visitInvalidStmt(op, args...);
263 op->emitOpError(
"unknown firrtl stmt");
273#define HANDLE(OPTYPE) \
274 ResultType visitStmt(OPTYPE op, ExtraArgs... args) { \
275 return static_cast<ConcreteType *>(this)->visitUnhandledStmt(op, args...); \
313template <
typename ConcreteType,
typename ResultType = void,
314 typename... ExtraArgs>
318 auto *thisCast =
static_cast<ConcreteType *
>(
this);
319 return TypeSwitch<Operation *, ResultType>(op)
320 .template Case<InstanceOp, InstanceChoiceOp, ObjectOp, MemOp, NodeOp,
321 RegOp, RegResetOp, WireOp, VerbatimWireOp, ContractOp>(
322 [&](
auto opNode) -> ResultType {
323 return thisCast->visitDecl(opNode, args...);
325 .Default([&](
auto expr) -> ResultType {
326 return thisCast->visitInvalidDecl(op, args...);
332 op->emitOpError(
"unknown firrtl decl");
342#define HANDLE(OPTYPE) \
343 ResultType visitDecl(OPTYPE op, ExtraArgs... args) { \
344 return static_cast<ConcreteType *>(this)->visitUnhandledDecl(op, args...); \
362template <
typename ConcreteType,
typename ResultType = void,
363 typename... ExtraArgs>
367 auto *thisCast =
static_cast<ConcreteType *
>(
this);
368 return TypeSwitch<Operation *, ResultType>(op)
369 .template Case<GenericIntrinsicOp, DPICallIntrinsicOp>(
370 [&](
auto expr) -> ResultType {
371 return thisCast->visitStmtExpr(expr, args...);
373 .Default([&](
auto expr) -> ResultType {
374 return thisCast->visitInvalidStmtExpr(op, args...);
380 op->emitOpError(
"unknown FIRRTL stmt expression");
390#define HANDLE(OPTYPE, OPKIND) \
391 ResultType visitStmtExpr(OPTYPE op, ExtraArgs... args) { \
392 return static_cast<ConcreteType *>(this)->visit##OPKIND##StmtExpr( \
409template <
typename ConcreteType,
typename ResultType = void,
410 typename... ExtraArgs>
412 :
public ExprVisitor<ConcreteType, ResultType, ExtraArgs...>,
413 public StmtVisitor<ConcreteType, ResultType, ExtraArgs...>,
414 public DeclVisitor<ConcreteType, ResultType, ExtraArgs...>,
433 return static_cast<ConcreteType *
>(
this)->
visitInvalidOp(op, args...);
ExprVisitor is a visitor for FIRRTL declaration nodes.
ResultType dispatchDeclVisitor(Operation *op, ExtraArgs... args)
ResultType visitInvalidDecl(Operation *op, ExtraArgs... args)
This callback is invoked on any non-Decl operations.
ResultType visitUnhandledDecl(Operation *op, ExtraArgs... args)
This callback is invoked on any Decl operations that are not handled by the concrete visitor.
ExprVisitor is a visitor for FIRRTL expression nodes.
HANDLE(ListCreateOp, Unhandled)
HANDLE(LTLUntilIntrinsicOp, Unhandled)
HANDLE(DoubleConstantOp, Unhandled)
HANDLE(LTLNotIntrinsicOp, Unhandled)
HANDLE(PadPrimOp, Unhandled)
HANDLE(SubPrimOp, Binary)
HANDLE(ElementwiseXorPrimOp, Unhandled)
HANDLE(ClockDividerIntrinsicOp, Unhandled)
HANDLE(AddPrimOp, Binary)
HANDLE(BitsPrimOp, Unhandled)
HANDLE(RWProbeOp, Unhandled)
HANDLE(LTLAndIntrinsicOp, Unhandled)
HANDLE(OpenSubfieldOp, Unhandled)
HANDLE(BoolConstantOp, Unhandled)
HANDLE(AndRPrimOp, Unary)
HANDLE(HeadPrimOp, Unhandled)
HANDLE(ClockInverterIntrinsicOp, Unhandled)
HANDLE(LTLGoToRepeatIntrinsicOp, Unhandled)
HANDLE(LTLNonConsecutiveRepeatIntrinsicOp, Unhandled)
HANDLE(BitCastOp, Unhandled)
HANDLE(SubindexOp, Unhandled)
HANDLE(HasBeenResetIntrinsicOp, Unhandled)
HANDLE(SubfieldOp, Unhandled)
HANDLE(DShrPrimOp, Binary)
HANDLE(AsUIntPrimOp, Unary)
HANDLE(LTLDelayIntrinsicOp, Unhandled)
HANDLE(RefCastOp, Unhandled)
HANDLE(ElementwiseOrPrimOp, Unhandled)
HANDLE(MultibitMuxOp, Unhandled)
HANDLE(XorRPrimOp, Unary)
HANDLE(ConstCastOp, Unhandled)
HANDLE(Mux4CellIntrinsicOp, Unhandled)
HANDLE(StringConstantOp, Unhandled)
HANDLE(LTLConcatIntrinsicOp, Unhandled)
HANDLE(TagExtractOp, Unhandled)
HANDLE(UninferredResetCastOp, Unhandled)
HANDLE(XorPrimOp, Binary)
HANDLE(MulPrimOp, Binary)
HANDLE(LTLImplicationIntrinsicOp, Unhandled)
HANDLE(ListConcatOp, Unhandled)
ResultType visitInvalidExpr(Operation *op, ExtraArgs... args)
This callback is invoked on any non-expression operations.
ResultType dispatchExprVisitor(Operation *op, ExtraArgs... args)
HANDLE(RefSubOp, Unhandled)
HANDLE(ObjectAnyRefCastOp, Unhandled)
HANDLE(LTLIntersectIntrinsicOp, Unhandled)
HANDLE(RemPrimOp, Binary)
HANDLE(IntegerShrOp, Unhandled)
HANDLE(Mux2CellIntrinsicOp, Unhandled)
HANDLE(TimeOp, Unhandled)
HANDLE(MuxPrimOp, Unhandled)
HANDLE(BundleCreateOp, Unhandled)
HANDLE(PlusArgsTestIntrinsicOp, Unhandled)
HANDLE(FEnumCreateOp, Unhandled)
HANDLE(RefSendOp, Unhandled)
HANDLE(XMRDerefOp, Unhandled)
HANDLE(ShrPrimOp, Unhandled)
HANDLE(IntegerAddOp, Unhandled)
HANDLE(UnresolvedPathOp, Unhandled)
HANDLE(PlusArgsValueIntrinsicOp, Unhandled)
HANDLE(LTLOrIntrinsicOp, Unhandled)
HANDLE(LTLRepeatIntrinsicOp, Unhandled)
HANDLE(CatPrimOp, Binary)
HANDLE(FIntegerConstantOp, Unhandled)
HANDLE(HWStructCastOp, Unhandled)
HANDLE(ClockGateIntrinsicOp, Unhandled)
HANDLE(OpenSubindexOp, Unhandled)
HANDLE(ObjectSubfieldOp, Unhandled)
HANDLE(InvalidValueOp, Unhandled)
HANDLE(SubaccessOp, Unhandled)
HANDLE(HierarchicalModuleNameOp, Unhandled)
HANDLE(DShlPrimOp, Binary)
HANDLE(ShlPrimOp, Unhandled)
HANDLE(IsXIntrinsicOp, Unhandled)
HANDLE(RefResolveOp, Unhandled)
HANDLE(XMRRefOp, Unhandled)
HANDLE(TailPrimOp, Unhandled)
HANDLE(IntegerMulOp, Unhandled)
HANDLE(LTLClockIntrinsicOp, Unhandled)
HANDLE(GEQPrimOp, Binary)
HANDLE(ElementwiseAndPrimOp, Unhandled)
ResultType visitUnaryExpr(Operation *op, ExtraArgs... args)
This fallback is invoked on any unary expr that isn't explicitly handled.
HANDLE(SizeOfIntrinsicOp, Unhandled)
ResultType visitUnhandledExpr(Operation *op, ExtraArgs... args)
This callback is invoked on any expression operations that are not handled by the concrete visitor.
HANDLE(LEQPrimOp, Binary)
HANDLE(ConstantOp, Unhandled)
HANDLE(AsAsyncResetPrimOp, Unary)
HANDLE(DShlwPrimOp, Binary)
ResultType visitBinaryExpr(Operation *op, ExtraArgs... args)
This fallback is invoked on any binary expr that isn't explicitly handled.
HANDLE(AggregateConstantOp, Unhandled)
HANDLE(AndPrimOp, Binary)
HANDLE(AsClockPrimOp, Unary)
HANDLE(SpecialConstantOp, Unhandled)
HANDLE(VectorCreateOp, Unhandled)
HANDLE(LTLEventuallyIntrinsicOp, Unhandled)
HANDLE(DivPrimOp, Binary)
HANDLE(NEQPrimOp, Binary)
HANDLE(SubtagOp, Unhandled)
HANDLE(VerbatimExprOp, Unhandled)
HANDLE(IsTagOp, Unhandled)
HANDLE(AsSIntPrimOp, Unary)
HANDLE(PathOp, Unhandled)
FIRRTLVisitor allows you to visit all of the expr/stmt/decls with one class declaration.
ResultType dispatchVisitor(Operation *op, ExtraArgs... args)
This is the main entrypoint for the FIRRTLVisitor.
ResultType visitInvalidOp(Operation *op, ExtraArgs... args)
visitInvalidOp is an override point for non-FIRRTL dialect operations.
ResultType visitUnhandledExpr(Operation *op, ExtraArgs... args)
ResultType visitUnhandledOp(Operation *op, ExtraArgs... args)
visitUnhandledOp is an override point for FIRRTL dialect ops that the concrete visitor didn't bother ...
ResultType visitUnhandledStmt(Operation *op, ExtraArgs... args)
ResultType visitUnhandledDecl(Operation *op, ExtraArgs... args)
ResultType visitUnhandledStmtExpr(Operation *op, ExtraArgs... args)
ResultType visitInvalidDecl(Operation *op, ExtraArgs... args)
ResultType visitInvalidExpr(Operation *op, ExtraArgs... args)
ResultType visitInvalidStmtExpr(Operation *op, ExtraArgs... args)
ResultType visitInvalidStmt(Operation *op, ExtraArgs... args)
StmtExprVisitor is a visitor for FIRRTL operation that has an optional result.
HANDLE(DPICallIntrinsicOp, Unhandled)
ResultType visitUnhandledStmtExpr(Operation *op, ExtraArgs... args)
This callback is invoked on any StmtExpr operations that are not handled by the concrete visitor.
ResultType visitInvalidStmtExpr(Operation *op, ExtraArgs... args)
This callback is invoked on any non-StmtExpr operations.
HANDLE(GenericIntrinsicOp, Unhandled)
ResultType dispatchStmtExprVisitor(Operation *op, ExtraArgs... args)
ExprVisitor is a visitor for FIRRTL statement nodes.
HANDLE(VerifCoverIntrinsicOp)
HANDLE(RefForceInitialOp)
ResultType dispatchStmtVisitor(Operation *op, ExtraArgs... args)
HANDLE(UnclockedAssumeIntrinsicOp)
HANDLE(VerifEnsureIntrinsicOp)
HANDLE(VerifAssertIntrinsicOp)
ResultType visitUnhandledStmt(Operation *op, ExtraArgs... args)
This callback is invoked on any Stmt operations that are not handled by the concrete visitor.
HANDLE(RefReleaseInitialOp)
HANDLE(FPGAProbeIntrinsicOp)
HANDLE(MatchingConnectOp)
ResultType visitInvalidStmt(Operation *op, ExtraArgs... args)
This callback is invoked on any non-Stmt operations.
HANDLE(VerifRequireIntrinsicOp)
HANDLE(VerifAssumeIntrinsicOp)
The InstanceGraph op interface, see InstanceGraphInterface.td for more details.