CIRCT 22.0.0git
Loading...
Searching...
No Matches
SVVisitors.h
Go to the documentation of this file.
1//===- SVVisitors.h - SV Dialect Visitors -----------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file defines visitors that make it easier to work with SV IR.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef CIRCT_DIALECT_SV_SVVISITORS_H
14#define CIRCT_DIALECT_SV_SVVISITORS_H
15
17#include "llvm/ADT/TypeSwitch.h"
18
19namespace circt {
20namespace sv {
21
22template <typename ConcreteType, typename ResultType = void,
23 typename... ExtraArgs>
24class Visitor {
25public:
26 ResultType dispatchSVVisitor(Operation *op, ExtraArgs... args) {
27 auto *thisCast = static_cast<ConcreteType *>(this);
28 return TypeSwitch<Operation *, ResultType>(op)
29 .template Case<
30 // Expressions
31 ReadInOutOp, ArrayIndexInOutOp, VerbatimExprOp, VerbatimExprSEOp,
32 IndexedPartSelectInOutOp, IndexedPartSelectOp, StructFieldInOutOp,
33 ConstantXOp, ConstantZOp, ConstantStrOp, MacroRefExprOp,
34 MacroRefExprSEOp, UnpackedArrayCreateOp, UnpackedOpenArrayCastOp,
35 SFormatFOp,
36 // Declarations.
37 RegOp, WireOp, LogicOp, LocalParamOp, XMROp, XMRRefOp,
38 // Control flow.
39 OrderedOutputOp, IfDefOp, IfDefProceduralOp, IfOp, AlwaysOp,
40 AlwaysCombOp, AlwaysFFOp, InitialOp, CaseOp,
41 // Other Statements.
42 AssignOp, BPAssignOp, PAssignOp, ForceOp, ReleaseOp, AliasOp,
43 FWriteOp, FFlushOp, SystemFunctionOp, VerbatimOp, MacroRefOp,
44 FuncCallOp, FuncCallProceduralOp, ReturnOp, IncludeOp, MacroErrorOp,
45 // Type declarations.
46 InterfaceOp, InterfaceSignalOp, InterfaceModportOp,
47 InterfaceInstanceOp, GetModportOp, AssignInterfaceSignalOp,
48 ReadInterfaceSignalOp, MacroDeclOp, MacroDefOp, FuncOp,
49 FuncDPIImportOp,
50 // Verification statements.
51 AssertOp, AssumeOp, CoverOp, AssertConcurrentOp, AssumeConcurrentOp,
52 CoverConcurrentOp, AssertPropertyOp, AssumePropertyOp,
53 CoverPropertyOp,
54 // Bind Statements
55 BindOp,
56 // Simulator control tasks
57 StopOp, FinishOp, ExitOp,
58 // Severity message tasks
59 FatalOp, ErrorOp, WarningOp, InfoOp,
60 // Memory loading tasks
61 ReadMemOp,
62 // Generate statements
63 GenerateOp, GenerateCaseOp,
64 // For statements
65 ForOp,
66 // Sampled value functiions
67 SampledOp,
68 // Time system functions
69 TimeOp, STimeOp>([&](auto expr) -> ResultType {
70 return thisCast->visitSV(expr, args...);
71 })
72 .Default([&](auto expr) -> ResultType {
73 return thisCast->visitInvalidSV(op, args...);
74 });
75 }
76
77 /// This callback is invoked on any invalid operations.
78 ResultType visitInvalidSV(Operation *op, ExtraArgs... args) {
79 op->emitOpError("unknown SV node");
80 abort();
81 }
82
83 /// This callback is invoked on any SV operations that are not handled by the
84 /// concrete visitor.
85 ResultType visitUnhandledSV(Operation *op, ExtraArgs... args) {
86 return ResultType();
87 }
88
89#define HANDLE(OPTYPE, OPKIND) \
90 ResultType visitSV(OPTYPE op, ExtraArgs... args) { \
91 return static_cast<ConcreteType *>(this)->visit##OPKIND##SV(op, args...); \
92 }
93
94 // Declarations
95 HANDLE(RegOp, Unhandled);
96 HANDLE(WireOp, Unhandled);
97 HANDLE(LogicOp, Unhandled);
98 HANDLE(LocalParamOp, Unhandled);
99 HANDLE(XMROp, Unhandled);
100 HANDLE(XMRRefOp, Unhandled);
101
102 // Expressions
103 HANDLE(ReadInOutOp, Unhandled);
104 HANDLE(ArrayIndexInOutOp, Unhandled);
105 HANDLE(VerbatimExprOp, Unhandled);
106 HANDLE(VerbatimExprSEOp, Unhandled);
107 HANDLE(IndexedPartSelectInOutOp, Unhandled);
108 HANDLE(IndexedPartSelectOp, Unhandled);
109 HANDLE(StructFieldInOutOp, Unhandled);
110 HANDLE(ConstantXOp, Unhandled);
111 HANDLE(ConstantZOp, Unhandled);
112 HANDLE(ConstantStrOp, Unhandled);
113 HANDLE(MacroRefExprOp, Unhandled);
114 HANDLE(MacroRefExprSEOp, Unhandled);
115 HANDLE(UnpackedArrayCreateOp, Unhandled);
116 HANDLE(UnpackedOpenArrayCastOp, Unhandled);
117 HANDLE(SFormatFOp, Unhandled);
118
119 // Control flow.
120 HANDLE(OrderedOutputOp, Unhandled);
121 HANDLE(IfDefOp, Unhandled);
122 HANDLE(IfDefProceduralOp, Unhandled);
123 HANDLE(IfOp, Unhandled);
124 HANDLE(AlwaysOp, Unhandled);
125 HANDLE(AlwaysCombOp, Unhandled);
126 HANDLE(AlwaysFFOp, Unhandled);
127 HANDLE(InitialOp, Unhandled);
128 HANDLE(CaseOp, Unhandled);
129
130 // Other Statements.
131 HANDLE(AssignOp, Unhandled);
132 HANDLE(BPAssignOp, Unhandled);
133 HANDLE(PAssignOp, Unhandled);
134 HANDLE(ForceOp, Unhandled);
135 HANDLE(ReleaseOp, Unhandled);
136 HANDLE(AliasOp, Unhandled);
137 HANDLE(FWriteOp, Unhandled);
138 HANDLE(FFlushOp, Unhandled);
139 HANDLE(SystemFunctionOp, Unhandled);
140 HANDLE(FuncCallProceduralOp, Unhandled);
141 HANDLE(FuncCallOp, Unhandled);
142 HANDLE(ReturnOp, Unhandled);
143 HANDLE(VerbatimOp, Unhandled);
144 HANDLE(MacroRefOp, Unhandled);
145 HANDLE(IncludeOp, Unhandled);
146 HANDLE(MacroErrorOp, Unhandled);
147
148 // Type declarations.
149 HANDLE(InterfaceOp, Unhandled);
150 HANDLE(InterfaceInstanceOp, Unhandled);
151 HANDLE(InterfaceSignalOp, Unhandled);
152 HANDLE(InterfaceModportOp, Unhandled);
153 HANDLE(GetModportOp, Unhandled);
154 HANDLE(AssignInterfaceSignalOp, Unhandled);
155 HANDLE(ReadInterfaceSignalOp, Unhandled);
156 HANDLE(MacroDefOp, Unhandled);
157 HANDLE(MacroDeclOp, Unhandled);
158 HANDLE(FuncDPIImportOp, Unhandled);
159 HANDLE(FuncOp, Unhandled);
160
161 // Verification statements.
162 HANDLE(AssertOp, Unhandled);
163 HANDLE(AssumeOp, Unhandled);
164 HANDLE(CoverOp, Unhandled);
165 HANDLE(AssertConcurrentOp, Unhandled);
166 HANDLE(AssumeConcurrentOp, Unhandled);
167 HANDLE(CoverConcurrentOp, Unhandled);
168 HANDLE(AssertPropertyOp, Unhandled);
169 HANDLE(AssumePropertyOp, Unhandled);
170 HANDLE(CoverPropertyOp, Unhandled);
171
172 // Bind statements.
173 HANDLE(BindOp, Unhandled);
174
175 // Simulator control tasks
176 HANDLE(StopOp, Unhandled);
177 HANDLE(FinishOp, Unhandled);
178 HANDLE(ExitOp, Unhandled);
179
180 // Severity message tasks
181 HANDLE(FatalOp, Unhandled);
182 HANDLE(ErrorOp, Unhandled);
183 HANDLE(WarningOp, Unhandled);
184 HANDLE(InfoOp, Unhandled);
185
186 // Memory loading tasks
187 HANDLE(ReadMemOp, Unhandled);
188
189 // Generate statements
190 HANDLE(GenerateOp, Unhandled);
191 HANDLE(GenerateCaseOp, Unhandled);
192
193 // For loop.
194 HANDLE(ForOp, Unhandled);
195
196 // Sampled Value Functions
197 HANDLE(SampledOp, Unhandled);
198
199 // Time System Functions
200 HANDLE(TimeOp, Unhandled);
201 HANDLE(STimeOp, Unhandled);
202#undef HANDLE
203};
204
205} // namespace sv
206} // namespace circt
207
208#endif // CIRCT_DIALECT_SV_SVVISITORS_H
HANDLE(MacroErrorOp, Unhandled)
HANDLE(AssumePropertyOp, Unhandled)
HANDLE(BindOp, Unhandled)
HANDLE(ConstantXOp, Unhandled)
HANDLE(InterfaceSignalOp, Unhandled)
HANDLE(ConstantStrOp, Unhandled)
HANDLE(ReadInterfaceSignalOp, Unhandled)
HANDLE(StopOp, Unhandled)
HANDLE(SFormatFOp, Unhandled)
HANDLE(ExitOp, Unhandled)
HANDLE(ForOp, Unhandled)
HANDLE(TimeOp, Unhandled)
HANDLE(FinishOp, Unhandled)
HANDLE(XMRRefOp, Unhandled)
HANDLE(FWriteOp, Unhandled)
HANDLE(AssumeOp, Unhandled)
HANDLE(IfDefOp, Unhandled)
HANDLE(AssertOp, Unhandled)
HANDLE(ForceOp, Unhandled)
HANDLE(AssignOp, Unhandled)
HANDLE(CoverOp, Unhandled)
HANDLE(RegOp, Unhandled)
HANDLE(FuncOp, Unhandled)
HANDLE(FuncCallOp, Unhandled)
HANDLE(ReadInOutOp, Unhandled)
ResultType dispatchSVVisitor(Operation *op, ExtraArgs... args)
Definition SVVisitors.h:26
HANDLE(UnpackedOpenArrayCastOp, Unhandled)
HANDLE(WarningOp, Unhandled)
HANDLE(SampledOp, Unhandled)
HANDLE(VerbatimExprOp, Unhandled)
HANDLE(IncludeOp, Unhandled)
HANDLE(XMROp, Unhandled)
HANDLE(ReleaseOp, Unhandled)
HANDLE(MacroDeclOp, Unhandled)
HANDLE(IfOp, Unhandled)
HANDLE(InterfaceOp, Unhandled)
HANDLE(FFlushOp, Unhandled)
HANDLE(AlwaysCombOp, Unhandled)
HANDLE(AlwaysOp, Unhandled)
HANDLE(CoverPropertyOp, Unhandled)
HANDLE(InitialOp, Unhandled)
HANDLE(GenerateCaseOp, Unhandled)
HANDLE(GetModportOp, Unhandled)
HANDLE(InterfaceInstanceOp, Unhandled)
HANDLE(StructFieldInOutOp, Unhandled)
HANDLE(ArrayIndexInOutOp, Unhandled)
HANDLE(FatalOp, Unhandled)
HANDLE(AlwaysFFOp, Unhandled)
HANDLE(AssertPropertyOp, Unhandled)
HANDLE(CoverConcurrentOp, Unhandled)
HANDLE(BPAssignOp, Unhandled)
HANDLE(CaseOp, Unhandled)
HANDLE(InterfaceModportOp, Unhandled)
HANDLE(OrderedOutputOp, Unhandled)
HANDLE(InfoOp, Unhandled)
HANDLE(UnpackedArrayCreateOp, Unhandled)
HANDLE(PAssignOp, Unhandled)
ResultType visitUnhandledSV(Operation *op, ExtraArgs... args)
This callback is invoked on any SV operations that are not handled by the concrete visitor.
Definition SVVisitors.h:85
ResultType visitInvalidSV(Operation *op, ExtraArgs... args)
This callback is invoked on any invalid operations.
Definition SVVisitors.h:78
HANDLE(AssignInterfaceSignalOp, Unhandled)
HANDLE(VerbatimOp, Unhandled)
HANDLE(FuncDPIImportOp, Unhandled)
HANDLE(MacroRefOp, Unhandled)
HANDLE(AliasOp, Unhandled)
HANDLE(GenerateOp, Unhandled)
HANDLE(MacroRefExprOp, Unhandled)
HANDLE(WireOp, Unhandled)
HANDLE(ReturnOp, Unhandled)
HANDLE(STimeOp, Unhandled)
HANDLE(IndexedPartSelectOp, Unhandled)
HANDLE(IndexedPartSelectInOutOp, Unhandled)
HANDLE(ConstantZOp, Unhandled)
HANDLE(AssumeConcurrentOp, Unhandled)
HANDLE(LocalParamOp, Unhandled)
HANDLE(FuncCallProceduralOp, Unhandled)
HANDLE(ReadMemOp, Unhandled)
HANDLE(MacroRefExprSEOp, Unhandled)
HANDLE(AssertConcurrentOp, Unhandled)
HANDLE(SystemFunctionOp, Unhandled)
HANDLE(ErrorOp, Unhandled)
HANDLE(LogicOp, Unhandled)
HANDLE(IfDefProceduralOp, Unhandled)
HANDLE(VerbatimExprSEOp, Unhandled)
HANDLE(MacroDefOp, Unhandled)
The InstanceGraph op interface, see InstanceGraphInterface.td for more details.
Definition sv.py:1