Support class static members (#2233).

Changes

@@ -19,6 +19,7 @@ Verilator 4.217 devel
 
 **Minor:**
 
+* Support class static members (#2233).
 * Support force/release (#2431) (#2593). [Shunyao CAD]
 * Support lower dimension looping in foreach loops (#3172). [Ehab Ibrahim]
 * Support up to 64 bit enums for .next/.prev/.name (#3244). [Alexander Grobman]

src/V3AstNodes.h

@@ -2439,6 +2439,7 @@ public:
     virtual bool hasDType() const override { return true; }
     AstVar* varp() const { return m_varp; }  // [After Link] Pointer to variable
     AstScope* scopep() const { return m_scopep; }  // Pointer to scope it's under
+    void scopep(AstScope* nodep) { m_scopep = nodep; }
     // op1 = Calculation of value of variable, nullptr=complicated
     AstNode* valuep() const { return op1p(); }
     void valuep(AstNode* valuep) { addOp1p(valuep); }

src/V3Class.cpp

@@ -38,10 +38,12 @@ private:
 
     // MEMBERS
     string m_prefix;  // String prefix to add to name based on hier
+    AstNodeModule* m_classPackagep = nullptr;  // Package moving into
     const AstScope* m_classScopep = nullptr;  // Package moving scopes into
     AstScope* m_packageScopep = nullptr;  // Class package scope
     const AstNodeFTask* m_ftaskp = nullptr;  // Current task
     std::vector<std::pair<AstNode*, AstScope*>> m_toScopeMoves;
+    std::vector<std::pair<AstNode*, AstNodeModule*>> m_toPackageMoves;
 
     // METHODS
     VL_DEBUG_FUNC;  // Declare debug()
@@ -85,9 +87,11 @@ private:
         packagep->addStmtp(scopep);
         // Iterate
         VL_RESTORER(m_prefix);
+        VL_RESTORER(m_classPackagep);
         VL_RESTORER(m_classScopep);
         VL_RESTORER(m_packageScopep);
         {
+            m_classPackagep = packagep;
             m_classScopep = classScopep;
             m_packageScopep = scopep;
             m_prefix = nodep->name() + "__02e";  // .
@@ -112,6 +116,12 @@ private:
                 // have a pointer to it yet
                 m_toScopeMoves.push_back(std::make_pair(nodep, m_packageScopep));
             }
+            if (!m_ftaskp && nodep->lifetime().isStatic()) {
+                m_toPackageMoves.push_back(std::make_pair(nodep, m_classPackagep));
+                // We're really moving the VarScope but we might not
+                // have a pointer to it yet
+                m_toScopeMoves.push_back(std::make_pair(nodep, m_packageScopep));
+            }
         }
     }
 
@@ -138,6 +148,13 @@ private:
         //    m_toScopeMoves.push_back(std::make_pair(nodep, m_classScopep));
         //}
     }
+    virtual void visit(AstInitial* nodep) override {
+        // But not AstInitialAutomatic, which remains under the class
+        iterateChildren(nodep);
+        if (m_packageScopep) {
+            m_toScopeMoves.push_back(std::make_pair(nodep, m_packageScopep));
+        }
+    }
 
     virtual void visit(AstNodeMath* nodep) override {}  // Short circuit
     virtual void visit(AstNodeStmt* nodep) override {}  // Short circuit
@@ -155,12 +172,23 @@ public:
                 scopep->addActivep(nodep->unlinkFrBack());
             } else if (VN_IS(nodep, Var)) {
                 AstVarScope* const vscp = VN_AS(nodep->user1p(), VarScope);
+                vscp->scopep(scopep);
                 vscp->unlinkFrBack();
                 scopep->addVarp(vscp);
+            } else if (VN_IS(nodep, Initial)) {
+                nodep->unlinkFrBack();
+                scopep->addActivep(nodep);
             } else {
                 nodep->v3fatalSrc("Bad case");
             }
         }
+        for (auto moved : m_toPackageMoves) {
+            AstNode* const nodep = moved.first;
+            AstNodeModule* const modp = moved.second;
+            UINFO(9, "moving " << nodep << " to " << modp << endl);
+            nodep->unlinkFrBack();
+            modp->addStmtp(nodep);
+        }
     }
 };
 

src/V3LinkDot.cpp

@@ -1041,8 +1041,6 @@ class LinkDotFindVisitor final : public VNVisitor {
         iterateChildren(nodep);
         if (nodep->isFuncLocal() && nodep->lifetime().isStatic()) {
             nodep->v3warn(E_UNSUPPORTED, "Unsupported: 'static' function/task variables");
-        } else if (nodep->isClassMember() && nodep->lifetime().isStatic()) {
-            nodep->v3warn(E_UNSUPPORTED, "Unsupported: 'static' class members");
         }
         if (!m_statep->forScopeCreation()) {
             // Find under either a task or the module's vars
@@ -2511,6 +2509,16 @@ private:
         }
         if (start) m_ds = lastStates;
     }
+    virtual void visit(AstClassOrPackageRef* nodep) override {
+        UINFO(9, "   linkClassOrPackageRef " << m_ds.ascii() << "  n=" << nodep << endl);
+        if (m_ds.m_dotPos == DP_PACKAGE) {
+            // Already under dot, so this is {ClassOrPackage} Dot {ClassOrPackage}
+            // m_ds.m_dotText communicates the cell prefix between stages
+            m_ds.m_dotPos = DP_PACKAGE;
+        }
+        // TODO we don't iterate pins yet, as class parameters are not supported
+    }
+
     virtual void visit(AstVarRef* nodep) override {
         // VarRef: Resolve its reference
         // ParseRefs are used the first pass (forPrimary) so we shouldn't get can't find

test_regress/t/t_class_param_pkg.out

@@ -1,9 +1,30 @@
-%Error: t/t_class_param_pkg.v:51:16: Syntax Error: Not expecting CLASSORPACKAGEREF under a DOT in dotted expression
+%Error-UNSUPPORTED: t/t_class_param_pkg.v:43:16: Unsupported: parameterized classes
-   51 |       if (Pkg::Cls#()::PBASE != 12) $stop;
+                                               : ... In instance t
-      |                ^~~
+   43 |    Pkg::Cls #(.PBASE(4)) c4;
-%Error: t/t_class_param_pkg.v:51:21: Syntax Error: Not expecting PIN under a CLASSORPACKAGEREF in dotted expression
+      |                ^~~~~
-   51 |       if (Pkg::Cls#()::PBASE != 12) $stop;
+                    ... For error description see https://verilator.org/warn/UNSUPPORTED?v=latest
+%Error-UNSUPPORTED: t/t_class_param_pkg.v:45:17: Unsupported: parameterized classes
+                                               : ... In instance t
+   45 |    Pkg::Wrap #(.P(16)) w16;
       |                 ^
-%Error: Internal Error: t/t_class_param_pkg.v:51:21: ../V3LinkDot.cpp:#: Pin not under instance?
+%Error-UNSUPPORTED: t/t_class_param_pkg.v:14:27: Unsupported: class parameters
-   51 |       if (Pkg::Cls#()::PBASE != 12) $stop;
+                                               : ... In instance t
+   14 |    class Wrap #(parameter P = 13);
       |                           ^
+%Error-UNSUPPORTED: t/t_class_param_pkg.v:22:18: Unsupported: class parameters
+                                               : ... In instance t
+   22 |       localparam PMINUS1 = P - 1;   
+      |                  ^~~~~~~
+%Error-UNSUPPORTED: t/t_class_param_pkg.v:21:20: Unsupported: parameterized classes
+                                               : ... In instance t
+   21 |       Cls#(PMINUS1 + 1) c1;
+      |                    ^
+%Error-UNSUPPORTED: t/t_class_param_pkg.v:25:26: Unsupported: class parameters
+                                               : ... In instance t
+   25 |    class Cls #(parameter PBASE = 12);
+      |                          ^~~~~
+%Error-UNSUPPORTED: t/t_class_param_pkg.v:36:22: Unsupported: parameterized classes
+                                               : ... In instance t
+   36 |    typedef Pkg::Cls#(8) Cls8_t;
+      |                      ^
+%Error: Exiting due to

test_regress/t/t_class_static.out

@@ -1,10 +1,6 @@
-%Error-UNSUPPORTED: t/t_class_static.v:12:15: Unsupported: 'static' class members
-                                            : ... In instance t
-   12 |    static int c_st = 2;
-      |               ^~~~
-                    ... For error description see https://verilator.org/warn/UNSUPPORTED?v=latest
 %Error-UNSUPPORTED: t/t_class_static.v:25:18: Unsupported: 'static' function/task variables
                                             : ... In instance t
    25 |       static int st = 2; st++; return st;
       |                  ^~
+                    ... For error description see https://verilator.org/warn/UNSUPPORTED?v=latest
 %Error: Exiting due to

test_regress/t/t_class_static_member.out

@@ -1,6 +0,0 @@
-%Error-UNSUPPORTED: t/t_class_static_member.v:12:15: Unsupported: 'static' class members
-                                                   : ... In instance t
-   12 |    static int c_st = 22;
-      |               ^~~~
-                    ... For error description see https://verilator.org/warn/UNSUPPORTED?v=latest
-%Error: Exiting due to

test_regress/t/t_class_static_member.pl

@@ -11,13 +11,11 @@ if (!$::Driver) { use FindBin; exec("$FindBin::Bin/bootstrap.pl", @ARGV, $0); di
 scenarios(simulator => 1);
 
 compile(
-    fails => $Self->{vlt_all},  # Verilator unsupported, bug546
-    expect_filename => $Self->{golden_filename},
     );
 
 execute(
     check_finished => 1,
-    ) if !$Self->{vlt_all};
+    );
 
 ok(1);
 1;

test_regress/t/t_class_static_member_pkg.out

@@ -1,4 +0,0 @@
-%Error: t/t_class_static_member_pkg.v:51:16: Syntax Error: Not expecting CLASSORPACKAGEREF under a DOT in dotted expression
-   51 |       v = Pkg::Cls::f_cs_st(); do if ((v) !== (27)) begin $write("%%Error: %s:%0d:  got='h%x exp='h%x\n", "t/t_class_static_member_pkg.v",51, (v), (27)); $stop; end while(0);;
-      |                ^~~
-%Error: Exiting due to

test_regress/t/t_class_static_member_pkg.pl

@@ -11,13 +11,11 @@ if (!$::Driver) { use FindBin; exec("$FindBin::Bin/bootstrap.pl", @ARGV, $0); di
 scenarios(simulator => 1);
 
 compile(
-    fails => $Self->{vlt_all},  # Verilator unsupported, bug546
-    expect_filename => $Self->{golden_filename},
     );
 
 execute(
     check_finished => 1,
-    ) if !$Self->{vlt_all};
+    );
 
 ok(1);
 1;

test_regress/t/t_class_static_order.out

@@ -1,14 +0,0 @@
-%Error-UNSUPPORTED: t/t_class_static_order.v:23:16: Unsupported: 'static' class members
-                                                  : ... In instance t
-   23 |    static ClsZ z = new;
-      |                ^
-                    ... For error description see https://verilator.org/warn/UNSUPPORTED?v=latest
-%Error-UNSUPPORTED: t/t_class_static_order.v:34:16: Unsupported: 'static' class members
-                                                  : ... In instance t
-   34 |    static ClsA a = new;
-      |                ^
-%Error-UNSUPPORTED: t/t_class_static_order.v:35:16: Unsupported: 'static' class members
-                                                  : ... In instance t
-   35 |    static ClsB b = new;
-      |                ^
-%Error: Exiting due to

test_regress/t/t_class_static_order.pl

@@ -11,13 +11,11 @@ if (!$::Driver) { use FindBin; exec("$FindBin::Bin/bootstrap.pl", @ARGV, $0); di
 scenarios(simulator => 1);
 
 compile(
-    fails => $Self->{vlt_all},
-    expect_filename => $Self->{golden_filename},
     );
 
 execute(
     check_finished => 1,
-    ) if !$Self->{vlt_all};
+    );
 
 ok(1);
 1;