SVVisitors.h

Go to the documentation of this file.

//===- SVVisitors.h - SV Dialect Visitors -----------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This file defines visitors that make it easier to work with SV IR.
//
//===----------------------------------------------------------------------===//
 
#ifndef CIRCT_DIALECT_SV_SVVISITORS_H
#define CIRCT_DIALECT_SV_SVVISITORS_H
 
#include "circt/Dialect/SV/SVOps.h"
#include "llvm/ADT/TypeSwitch.h"
 
namespace circt {
namespace sv {
 
template <typename ConcreteType, typename ResultType = void,
          typename... ExtraArgs>
class Visitor {
public:
  ResultType dispatchSVVisitor(Operation *op, ExtraArgs... args) {
    auto *thisCast = static_cast<ConcreteType *>(this);
    return TypeSwitch<Operation *, ResultType>(op)
        .template Case<
            // Expressions
            ReadInOutOp, ArrayIndexInOutOp, VerbatimExprOp, VerbatimExprSEOp,
            IndexedPartSelectInOutOp, IndexedPartSelectOp, StructFieldInOutOp,
            ConstantXOp, ConstantZOp, ConstantStrOp, MacroRefExprOp,
            MacroRefExprSEOp, UnpackedArrayCreateOp, UnpackedOpenArrayCastOp,
            SFormatFOp,
            // Declarations.
            RegOp, WireOp, LogicOp, LocalParamOp, XMROp, XMRRefOp,
            // Control flow.
            OrderedOutputOp, IfDefOp, IfDefProceduralOp, IfOp, AlwaysOp,
            AlwaysCombOp, AlwaysFFOp, InitialOp, CaseOp,
            // Other Statements.
            AssignOp, BPAssignOp, PAssignOp, ForceOp, ReleaseOp, AliasOp,
            WriteOp, FWriteOp, FFlushOp, SystemFunctionOp, VerbatimOp,
            MacroRefOp, FuncCallOp, FuncCallProceduralOp, ReturnOp, IncludeOp,
            MacroErrorOp,
            // Type declarations.
            InterfaceOp, SVVerbatimSourceOp, InterfaceSignalOp,
            InterfaceModportOp, InterfaceInstanceOp, GetModportOp,
            AssignInterfaceSignalOp, ReadInterfaceSignalOp, MacroDeclOp,
            MacroDefOp, FuncOp, FuncDPIImportOp,
            // Verification statements.
            AssertOp, AssumeOp, CoverOp, AssertConcurrentOp, AssumeConcurrentOp,
            CoverConcurrentOp, AssertPropertyOp, AssumePropertyOp,
            CoverPropertyOp,
            // Bind Statements
            BindOp,
            // Simulator control tasks
            StopOp, FinishOp, ExitOp,
            // Severity message tasks
            FatalProceduralOp, FatalOp, ErrorProceduralOp, WarningProceduralOp,
            InfoProceduralOp, ErrorOp, WarningOp, InfoOp,
            // Memory loading tasks
            ReadMemOp,
            // Generate statements
            GenerateOp, GenerateCaseOp,
            // For statements
            ForOp,
            // Sampled value functiions
            SampledOp,
            // Time system functions
            TimeOp, STimeOp>([&](auto expr) -> ResultType {
          return thisCast->visitSV(expr, args...);
        })
        .Default([&](auto expr) -> ResultType {
          return thisCast->visitInvalidSV(op, args...);
        });
  }
 
  /// This callback is invoked on any invalid operations.
  ResultType visitInvalidSV(Operation *op, ExtraArgs... args) {
    op->emitOpError("unknown SV node");
    abort();
  }
 
  /// This callback is invoked on any SV operations that are not handled by the
  /// concrete visitor.
  ResultType visitUnhandledSV(Operation *op, ExtraArgs... args) {
    return ResultType();
  }
 
#define HANDLE(OPTYPE, OPKIND)                                                 \
  ResultType visitSV(OPTYPE op, ExtraArgs... args) {                           \
    return static_cast<ConcreteType *>(this)->visit##OPKIND##SV(op, args...);  \
  }
 
  // Declarations
  HANDLE(RegOp, Unhandled);
  HANDLE(WireOp, Unhandled);
  HANDLE(LogicOp, Unhandled);
  HANDLE(LocalParamOp, Unhandled);
  HANDLE(XMROp, Unhandled);
  HANDLE(XMRRefOp, Unhandled);
 
  // Expressions
  HANDLE(ReadInOutOp, Unhandled);
  HANDLE(ArrayIndexInOutOp, Unhandled);
  HANDLE(VerbatimExprOp, Unhandled);
  HANDLE(VerbatimExprSEOp, Unhandled);
  HANDLE(IndexedPartSelectInOutOp, Unhandled);
  HANDLE(IndexedPartSelectOp, Unhandled);
  HANDLE(StructFieldInOutOp, Unhandled);
  HANDLE(ConstantXOp, Unhandled);
  HANDLE(ConstantZOp, Unhandled);
  HANDLE(ConstantStrOp, Unhandled);
  HANDLE(MacroRefExprOp, Unhandled);
  HANDLE(MacroRefExprSEOp, Unhandled);
  HANDLE(UnpackedArrayCreateOp, Unhandled);
  HANDLE(UnpackedOpenArrayCastOp, Unhandled);
  HANDLE(SFormatFOp, Unhandled);
 
  // Control flow.
  HANDLE(OrderedOutputOp, Unhandled);
  HANDLE(IfDefOp, Unhandled);
  HANDLE(IfDefProceduralOp, Unhandled);
  HANDLE(IfOp, Unhandled);
  HANDLE(AlwaysOp, Unhandled);
  HANDLE(AlwaysCombOp, Unhandled);
  HANDLE(AlwaysFFOp, Unhandled);
  HANDLE(InitialOp, Unhandled);
  HANDLE(CaseOp, Unhandled);
 
  // Other Statements.
  HANDLE(AssignOp, Unhandled);
  HANDLE(BPAssignOp, Unhandled);
  HANDLE(PAssignOp, Unhandled);
  HANDLE(ForceOp, Unhandled);
  HANDLE(ReleaseOp, Unhandled);
  HANDLE(AliasOp, Unhandled);
  HANDLE(WriteOp, Unhandled);
  HANDLE(FWriteOp, Unhandled);
  HANDLE(FFlushOp, Unhandled);
  HANDLE(SystemFunctionOp, Unhandled);
  HANDLE(FuncCallProceduralOp, Unhandled);
  HANDLE(FuncCallOp, Unhandled);
  HANDLE(ReturnOp, Unhandled);
  HANDLE(VerbatimOp, Unhandled);
  HANDLE(MacroRefOp, Unhandled);
  HANDLE(IncludeOp, Unhandled);
  HANDLE(MacroErrorOp, Unhandled);
 
  // Type declarations.
  HANDLE(InterfaceOp, Unhandled);
  HANDLE(SVVerbatimSourceOp, Unhandled);
  HANDLE(InterfaceInstanceOp, Unhandled);
  HANDLE(InterfaceSignalOp, Unhandled);
  HANDLE(InterfaceModportOp, Unhandled);
  HANDLE(GetModportOp, Unhandled);
  HANDLE(AssignInterfaceSignalOp, Unhandled);
  HANDLE(ReadInterfaceSignalOp, Unhandled);
  HANDLE(MacroDefOp, Unhandled);
  HANDLE(MacroDeclOp, Unhandled);
  HANDLE(FuncDPIImportOp, Unhandled);
  HANDLE(FuncOp, Unhandled);
 
  // Verification statements.
  HANDLE(AssertOp, Unhandled);
  HANDLE(AssumeOp, Unhandled);
  HANDLE(CoverOp, Unhandled);
  HANDLE(AssertConcurrentOp, Unhandled);
  HANDLE(AssumeConcurrentOp, Unhandled);
  HANDLE(CoverConcurrentOp, Unhandled);
  HANDLE(AssertPropertyOp, Unhandled);
  HANDLE(AssumePropertyOp, Unhandled);
  HANDLE(CoverPropertyOp, Unhandled);
 
  // Bind statements.
  HANDLE(BindOp, Unhandled);
 
  // Simulator control tasks
  HANDLE(StopOp, Unhandled);
  HANDLE(FinishOp, Unhandled);
  HANDLE(ExitOp, Unhandled);
 
  // Severity message tasks
  HANDLE(FatalProceduralOp, Unhandled);
  HANDLE(FatalOp, Unhandled);
  HANDLE(ErrorProceduralOp, Unhandled);
  HANDLE(WarningProceduralOp, Unhandled);
  HANDLE(InfoProceduralOp, Unhandled);
  HANDLE(ErrorOp, Unhandled);
  HANDLE(WarningOp, Unhandled);
  HANDLE(InfoOp, Unhandled);
 
  // Memory loading tasks
  HANDLE(ReadMemOp, Unhandled);
 
  // Generate statements
  HANDLE(GenerateOp, Unhandled);
  HANDLE(GenerateCaseOp, Unhandled);
 
  // For loop.
  HANDLE(ForOp, Unhandled);
 
  // Sampled Value Functions
  HANDLE(SampledOp, Unhandled);
 
  // Time System Functions
  HANDLE(TimeOp, Unhandled);
  HANDLE(STimeOp, Unhandled);
#undef HANDLE
};
 
} // namespace sv
} // namespace circt
 
#endif // CIRCT_DIALECT_SV_SVVISITORS_H