[FIRRTL] Add InferDomains pass

Add a pass that does domain inference and checking.  This is used to
verify the legality of a FIRRTL circuit with respect to its domains.
E.g., this pass is intended to be used for checking for illegal clock
domain crossings.

Signed-off-by: Schuyler Eldridge <[email protected]>

Author: seldridge

include/circt/Dialect/FIRRTL/FIRRTLOpInterfaces.h

@@ -85,6 +85,28 @@ struct PortInfo {
         annotations(annos), domains(domains) {}
 };
 
+inline bool operator==(const PortInfo &lhs, const PortInfo &rhs) {
+  if (lhs.name != rhs.name)
+    return false;
+  if (lhs.type != rhs.type)
+    return false;
+  if (lhs.direction != rhs.direction)
+    return false;
+  if (lhs.sym != rhs.sym)
+    return false;
+  if (lhs.loc != rhs.loc)
+    return false;
+  if (lhs.annotations != rhs.annotations)
+    return false;
+  if (lhs.domains != rhs.domains)
+    return false;
+  return true;
+}
+
+inline bool operator!=(const PortInfo &lhs, const PortInfo &rhs) {
+  return !(lhs == rhs);
+}
+
 enum class ConnectBehaviorKind {
   /// Classic FIRRTL connections: last connect 'wins' across paths;
   /// conditionally applied under 'when'.

include/circt/Dialect/FIRRTL/Passes.td

@@ -909,6 +909,19 @@ def CheckLayers : Pass<"firrtl-check-layers", "firrtl::CircuitOp"> {
   }];
 }
 
+def InferDomains : Pass<"firrtl-infer-domains", "firrtl::CircuitOp"> {
+  let summary = "Infer and type check all firrtl domains";
+  let description = [{
+    This pass does domain inference on a FIRRTL circuit.  The end result of this
+    is either a corrrctly domain-checked FIRRTL circuit or failure with verbose
+    error messages indicating why the FIRRTL circuit has illegal domain
+    constructs.
+
+    E.g., this pass can be used to check for illegal clock-domain-crossings if
+    clock domains are specified for signals in the design.
+  }];
+}
+
 def LowerDomains : Pass<"firrtl-lower-domains", "firrtl::CircuitOp"> {
   let summary = "lower domain information to properties";
   let description = [{

include/circt/Firtool/Firtool.h

@@ -144,6 +144,8 @@ class FirtoolOptions {
 
   bool getEmitAllBindFiles() const { return emitAllBindFiles; }
 
+  bool shouldInferDomains() const { return inferDomains; }
+
   // Setters, used by the CAPI
   FirtoolOptions &setOutputFilename(StringRef name) {
     outputFilename = name;
@@ -393,6 +395,11 @@ class FirtoolOptions {
     return *this;
   }
 
+  FirtoolOptions &setInferDomains(bool value) {
+    inferDomains = value;
+    return *this;
+  }
+
 private:
   std::string outputFilename;
 
@@ -447,6 +454,7 @@ class FirtoolOptions {
   bool lintStaticAsserts;
   bool lintXmrsInDesign;
   bool emitAllBindFiles;
+  bool inferDomains;
 };
 
 void registerFirtoolCLOptions();

include/circt/Support/InstanceGraph.h

@@ -59,6 +59,11 @@ class InstanceGraphNode;
 class InstanceRecord
     : public llvm::ilist_node_with_parent<InstanceRecord, InstanceGraphNode> {
 public:
+  /// Get the op that this is tracking.
+  Operation *getOperation() {
+    return instance.getOperation();
+  }
+
   /// Get the instance-like op that this is tracking.
   template <typename TTarget = InstanceOpInterface>
   auto getInstance() {
@@ -113,6 +118,8 @@ class InstanceGraphNode : public llvm::ilist_node<InstanceGraphNode> {
 public:
   InstanceGraphNode() : module(nullptr) {}
 
+  Operation *getOperation() { return module.getOperation(); }
+
   /// Get the module that this node is tracking.
   template <typename TTarget = ModuleOpInterface>
   auto getModule() {

lib/Dialect/FIRRTL/Transforms/CMakeLists.txt

@@ -17,6 +17,7 @@ add_circt_dialect_library(CIRCTFIRRTLTransforms
   GrandCentral.cpp
   IMConstProp.cpp
   IMDeadCodeElim.cpp
+  InferDomains.cpp
   InferReadWrite.cpp
   InferResets.cpp
   InferWidths.cpp