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,
66 UninferredResetCastOp, ConstCastOp, RefCastOp,
68 StringConstantOp, FIntegerConstantOp, BoolConstantOp,
69 DoubleConstantOp, ListCreateOp, ListConcatOp, UnresolvedPathOp,
70 PathOp, IntegerAddOp, IntegerMulOp, IntegerShrOp,
72 TimeOp, HierarchicalModuleNameOp>([&](
auto expr) -> ResultType {
73 return thisCast->visitExpr(expr, args...);
75 .Default([&](
auto expr) -> ResultType {
76 return thisCast->visitInvalidExpr(op, args...);
82 op->emitOpError(
"unknown FIRRTL expression");
104#define HANDLE(OPTYPE, OPKIND) \
105 ResultType visitExpr(OPTYPE op, ExtraArgs... args) { \
106 return static_cast<ConcreteType *>(this)->visit##OPKIND##Expr(op, \
104#define HANDLE(OPTYPE, OPKIND) \ …
171 HANDLE(PlusArgsValueIntrinsicOp, Unhandled);
172 HANDLE(PlusArgsTestIntrinsicOp, Unhandled);
175 HANDLE(ClockInverterIntrinsicOp, Unhandled);
176 HANDLE(ClockDividerIntrinsicOp, Unhandled);
179 HANDLE(LTLIntersectIntrinsicOp, Unhandled);
183 HANDLE(LTLGoToRepeatIntrinsicOp, Unhandled);
184 HANDLE(LTLNonConsecutiveRepeatIntrinsicOp, Unhandled);
186 HANDLE(LTLImplicationIntrinsicOp, Unhandled);
188 HANDLE(LTLEventuallyIntrinsicOp, Unhandled);
192 HANDLE(HasBeenResetIntrinsicOp, Unhandled);
214 HANDLE(UninferredResetCastOp, Unhandled);
234 HANDLE(HierarchicalModuleNameOp, Unhandled);
239template <
typename ConcreteType,
typename ResultType = void,
240 typename... ExtraArgs>
244 auto *thisCast =
static_cast<ConcreteType *
>(
this);
245 return TypeSwitch<Operation *, ResultType>(op)
246 .template Case<AttachOp, ConnectOp, MatchingConnectOp, RefDefineOp,
247 ForceOp, PrintFOp, FPrintFOp, FFlushOp, SkipOp, StopOp,
248 WhenOp, AssertOp, AssumeOp, CoverOp, PropAssignOp,
249 RefForceOp, RefForceInitialOp, RefReleaseOp,
250 RefReleaseInitialOp, FPGAProbeIntrinsicOp,
251 VerifAssertIntrinsicOp, VerifAssumeIntrinsicOp,
252 UnclockedAssumeIntrinsicOp, VerifCoverIntrinsicOp,
253 VerifRequireIntrinsicOp, VerifEnsureIntrinsicOp,
254 LayerBlockOp, MatchOp, ViewIntrinsicOp, BindOp>(
255 [&](
auto opNode) -> ResultType {
256 return thisCast->visitStmt(opNode, args...);
258 .Default([&](
auto expr) -> ResultType {
259 return thisCast->visitInvalidStmt(op, args...);
265 op->emitOpError(
"unknown firrtl stmt");
275#define HANDLE(OPTYPE) \
276 ResultType visitStmt(OPTYPE op, ExtraArgs... args) { \
277 return static_cast<ConcreteType *>(this)->visitUnhandledStmt(op, args...); \
315template <
typename ConcreteType,
typename ResultType = void,
316 typename... ExtraArgs>
320 auto *thisCast =
static_cast<ConcreteType *
>(
this);
321 return TypeSwitch<Operation *, ResultType>(op)
322 .template Case<InstanceOp, InstanceChoiceOp, ObjectOp, MemOp, NodeOp,
323 RegOp, RegResetOp, WireOp, VerbatimWireOp, ContractOp>(
324 [&](
auto opNode) -> ResultType {
325 return thisCast->visitDecl(opNode, args...);
327 .Default([&](
auto expr) -> ResultType {
328 return thisCast->visitInvalidDecl(op, args...);
334 op->emitOpError(
"unknown firrtl decl");
344#define HANDLE(OPTYPE) \
345 ResultType visitDecl(OPTYPE op, ExtraArgs... args) { \
346 return static_cast<ConcreteType *>(this)->visitUnhandledDecl(op, args...); \
364template <
typename ConcreteType,
typename ResultType = void,
365 typename... ExtraArgs>
369 auto *thisCast =
static_cast<ConcreteType *
>(
this);
370 return TypeSwitch<Operation *, ResultType>(op)
371 .template Case<GenericIntrinsicOp, DPICallIntrinsicOp>(
372 [&](
auto expr) -> ResultType {
373 return thisCast->visitStmtExpr(expr, args...);
375 .Default([&](
auto expr) -> ResultType {
376 return thisCast->visitInvalidStmtExpr(op, args...);
382 op->emitOpError(
"unknown FIRRTL stmt expression");
392#define HANDLE(OPTYPE, OPKIND) \
393 ResultType visitStmtExpr(OPTYPE op, ExtraArgs... args) { \
394 return static_cast<ConcreteType *>(this)->visit##OPKIND##StmtExpr( \
411template <
typename ConcreteType,
typename ResultType = void,
412 typename... ExtraArgs>
414 :
public ExprVisitor<ConcreteType, ResultType, ExtraArgs...>,
415 public StmtVisitor<ConcreteType, ResultType, ExtraArgs...>,
416 public DeclVisitor<ConcreteType, ResultType, ExtraArgs...>,
435 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(UnsafeDomainCastOp, Unhandled)
HANDLE(ClockDividerIntrinsicOp, Unhandled)
HANDLE(AddPrimOp, Binary)
HANDLE(BitsPrimOp, Unhandled)
HANDLE(RWProbeOp, Unhandled)
HANDLE(LTLAndIntrinsicOp, Unhandled)
HANDLE(OpenSubfieldOp, Unhandled)
HANDLE(BoolConstantOp, Unhandled)
HANDLE(CatPrimOp, 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(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.