Improve struct scopes when dumping structs to VCD (#2776)

docs/CONTRIBUTORS

@@ -5,6 +5,7 @@ Please see the Verilator manual for 200+ additional contributors. Thanks to all.
 
 Ahmed El-Mahmoudy
 Alex Chadwick
+Àlex Torregrosa
 Chris Randall
 Conor McCullough
 Dan Petrisko

include/verilated_trace.h

@@ -222,7 +222,7 @@ protected:
     void declCode(vluint32_t code, vluint32_t bits, bool tri);
 
     /// Is this an escape?
-    bool isScopeEscape(char c) { return isspace(c) || c == m_scopeEscape; }
+    bool isScopeEscape(char c) { return c != '\f' && (isspace(c) || c == m_scopeEscape); }
     /// Character that splits scopes.  Note whitespace are ALWAYS escapes.
     char scopeEscape() { return m_scopeEscape; }
 

include/verilated_vcd_c.cpp

@@ -401,13 +401,22 @@ void VerilatedVcd::dumpHeader() {
             if (*np == ' ') np++;
             if (*np == '\t') break;  // tab means signal name starts
             printIndent(1);
-            printStr("$scope module ");
+            // Find character after name end
+            const char* sp = np;
+            while(*sp && *sp != ' ' && *sp != '\t' && *sp != '\f') sp++;
+
+            if (*sp == '\f') {
+                printStr("$scope struct ");
+            } else {
+               printStr("$scope module ");
+            }
+
             for (; *np && *np != ' ' && *np != '\t'; np++) {
                 if (*np == '[') {
                     printStr("(");
                 } else if (*np == ']') {
                     printStr(")");
-                } else {
+                } else if (*np != '\f'){
                     *m_writep++ = *np;
                 }
             }

src/V3TraceDecl.cpp

@@ -295,7 +295,15 @@ private:
                     VL_RESTORER(m_traShowname);
                     VL_RESTORER(m_traValuep);
                     {
-                        m_traShowname += string(" ") + itemp->prettyName();
+                        // Add @ to mark as struct
+                        // Since it is not a valid symbol for verilog variable names, no
+                        // collision should happen
+                        if (v3Global.opt.traceFormat().fst()) {
+                            m_traShowname += string(" ") + itemp->prettyName();
+                        } else {
+                            m_traShowname += string("\f ") + itemp->prettyName();
+                        }
+
                         if (VN_IS(nodep, StructDType)) {
                             m_traValuep
                                 = new AstSel(nodep->fileline(), m_traValuep->cloneTree(true),

test_regress/driver.pl

@@ -2238,7 +2238,7 @@ sub _vcd_read {
     my @hier = ($data);
     my $lasthier;
     while (defined(my $line = $fh->getline)) {
-        if ($line =~ /\$scope module\s+(\S+)/) {
+        if ($line =~ /\$scope (module|struct)\s+(\S+)/) {
             $hier[$#hier]->{$1} ||= {};
             push @hier, $hier[$#hier]->{$1};
             $lasthier = $hier[$#hier];

test_regress/t/t_interface_ref_trace.out

@@ -14,7 +14,7 @@ $timescale   1ps $end
       $var wire  1 0 clk $end
       $var wire 32 # cyc [31:0] $end
       $var wire 32 $ value [31:0] $end
-      $scope module the_struct $end
+      $scope struct the_struct $end
        $var wire 32 % val100 [31:0] $end
        $var wire 32 & val200 [31:0] $end
       $upscope $end
@@ -25,7 +25,7 @@ $timescale   1ps $end
       $var wire  1 0 clk $end
       $var wire 32 # cyc [31:0] $end
       $var wire 32 ' value [31:0] $end
-      $scope module the_struct $end
+      $scope struct the_struct $end
        $var wire 32 ( val100 [31:0] $end
        $var wire 32 ) val200 [31:0] $end
       $upscope $end
@@ -36,7 +36,7 @@ $timescale   1ps $end
       $var wire  1 0 clk $end
       $var wire 32 # cyc [31:0] $end
       $var wire 32 * value [31:0] $end
-      $scope module the_struct $end
+      $scope struct the_struct $end
        $var wire 32 + val100 [31:0] $end
        $var wire 32 , val200 [31:0] $end
       $upscope $end
@@ -47,7 +47,7 @@ $timescale   1ps $end
       $var wire  1 0 clk $end
       $var wire 32 # cyc [31:0] $end
       $var wire 32 * value [31:0] $end
-      $scope module the_struct $end
+      $scope struct the_struct $end
        $var wire 32 + val100 [31:0] $end
        $var wire 32 , val200 [31:0] $end
       $upscope $end
@@ -57,7 +57,7 @@ $timescale   1ps $end
      $var wire  1 0 clk $end
      $var wire 32 # cyc [31:0] $end
      $var wire 32 * value [31:0] $end
-     $scope module the_struct $end
+     $scope struct the_struct $end
       $var wire 32 + val100 [31:0] $end
       $var wire 32 , val200 [31:0] $end
      $upscope $end
@@ -66,7 +66,7 @@ $timescale   1ps $end
      $var wire  1 0 clk $end
      $var wire 32 # cyc [31:0] $end
      $var wire 32 $ value [31:0] $end
-     $scope module the_struct $end
+     $scope struct the_struct $end
       $var wire 32 % val100 [31:0] $end
       $var wire 32 & val200 [31:0] $end
      $upscope $end
@@ -75,7 +75,7 @@ $timescale   1ps $end
      $var wire  1 0 clk $end
      $var wire 32 # cyc [31:0] $end
      $var wire 32 ' value [31:0] $end
-     $scope module the_struct $end
+     $scope struct the_struct $end
       $var wire 32 ( val100 [31:0] $end
       $var wire 32 ) val200 [31:0] $end
      $upscope $end
@@ -87,7 +87,7 @@ $timescale   1ps $end
       $var wire  1 0 clk $end
       $var wire 32 # cyc [31:0] $end
       $var wire 32 ' value [31:0] $end
-      $scope module the_struct $end
+      $scope struct the_struct $end
        $var wire 32 ( val100 [31:0] $end
        $var wire 32 ) val200 [31:0] $end
       $upscope $end
@@ -98,7 +98,7 @@ $timescale   1ps $end
       $var wire  1 0 clk $end
       $var wire 32 # cyc [31:0] $end
       $var wire 32 $ value [31:0] $end
-      $scope module the_struct $end
+      $scope struct the_struct $end
        $var wire 32 % val100 [31:0] $end
        $var wire 32 & val200 [31:0] $end
       $upscope $end
@@ -109,7 +109,7 @@ $timescale   1ps $end
       $var wire  1 0 clk $end
       $var wire 32 # cyc [31:0] $end
       $var wire 32 - value [31:0] $end
-      $scope module the_struct $end
+      $scope struct the_struct $end
        $var wire 32 . val100 [31:0] $end
        $var wire 32 / val200 [31:0] $end
       $upscope $end
@@ -120,7 +120,7 @@ $timescale   1ps $end
       $var wire  1 0 clk $end
       $var wire 32 # cyc [31:0] $end
       $var wire 32 - value [31:0] $end
-      $scope module the_struct $end
+      $scope struct the_struct $end
        $var wire 32 . val100 [31:0] $end
        $var wire 32 / val200 [31:0] $end
       $upscope $end
@@ -130,7 +130,7 @@ $timescale   1ps $end
      $var wire  1 0 clk $end
      $var wire 32 # cyc [31:0] $end
      $var wire 32 - value [31:0] $end
-     $scope module the_struct $end
+     $scope struct the_struct $end
       $var wire 32 . val100 [31:0] $end
       $var wire 32 / val200 [31:0] $end
      $upscope $end
@@ -139,7 +139,7 @@ $timescale   1ps $end
      $var wire  1 0 clk $end
      $var wire 32 # cyc [31:0] $end
      $var wire 32 ' value [31:0] $end
-     $scope module the_struct $end
+     $scope struct the_struct $end
       $var wire 32 ( val100 [31:0] $end
       $var wire 32 ) val200 [31:0] $end
      $upscope $end
@@ -148,7 +148,7 @@ $timescale   1ps $end
      $var wire  1 0 clk $end
      $var wire 32 # cyc [31:0] $end
      $var wire 32 $ value [31:0] $end
-     $scope module the_struct $end
+     $scope struct the_struct $end
       $var wire 32 % val100 [31:0] $end
       $var wire 32 & val200 [31:0] $end
      $upscope $end
@@ -159,7 +159,7 @@ $timescale   1ps $end
      $var wire  1 0 clk $end
      $var wire 32 # cyc [31:0] $end
      $var wire 32 $ value [31:0] $end
-     $scope module the_struct $end
+     $scope struct the_struct $end
       $var wire 32 % val100 [31:0] $end
       $var wire 32 & val200 [31:0] $end
      $upscope $end
@@ -170,7 +170,7 @@ $timescale   1ps $end
      $var wire  1 0 clk $end
      $var wire 32 # cyc [31:0] $end
      $var wire 32 ' value [31:0] $end
-     $scope module the_struct $end
+     $scope struct the_struct $end
       $var wire 32 ( val100 [31:0] $end
       $var wire 32 ) val200 [31:0] $end
      $upscope $end
@@ -180,7 +180,7 @@ $timescale   1ps $end
     $var wire  1 0 clk $end
     $var wire 32 # cyc [31:0] $end
     $var wire 32 $ value [31:0] $end
-    $scope module the_struct $end
+    $scope struct the_struct $end
      $var wire 32 % val100 [31:0] $end
      $var wire 32 & val200 [31:0] $end
     $upscope $end
@@ -189,7 +189,7 @@ $timescale   1ps $end
     $var wire  1 0 clk $end
     $var wire 32 # cyc [31:0] $end
     $var wire 32 ' value [31:0] $end
-    $scope module the_struct $end
+    $scope struct the_struct $end
      $var wire 32 ( val100 [31:0] $end
      $var wire 32 ) val200 [31:0] $end
     $upscope $end
@@ -199,7 +199,7 @@ $timescale   1ps $end
      $var wire  1 0 clk $end
      $var wire 32 # cyc [31:0] $end
      $var wire 32 $ value [31:0] $end
-     $scope module the_struct $end
+     $scope struct the_struct $end
       $var wire 32 % val100 [31:0] $end
       $var wire 32 & val200 [31:0] $end
      $upscope $end
@@ -210,7 +210,7 @@ $timescale   1ps $end
      $var wire  1 0 clk $end
      $var wire 32 # cyc [31:0] $end
      $var wire 32 ' value [31:0] $end
-     $scope module the_struct $end
+     $scope struct the_struct $end
       $var wire 32 ( val100 [31:0] $end
       $var wire 32 ) val200 [31:0] $end
      $upscope $end

test_regress/t/t_trace_complex_structs.out

@@ -38,52 +38,52 @@ $timescale   1ps $end
      $var wire 32 H a [31:0] $end
     $upscope $end
    $upscope $end
-   $scope module v_arrp_strp(3) $end
+   $scope struct v_arrp_strp(3) $end
     $var wire  1 1 b0 $end
     $var wire  1 0 b1 $end
    $upscope $end
-   $scope module v_arrp_strp(4) $end
+   $scope struct v_arrp_strp(4) $end
     $var wire  1 3 b0 $end
     $var wire  1 2 b1 $end
    $upscope $end
-   $scope module v_arru_strp(3) $end
+   $scope struct v_arru_strp(3) $end
     $var wire  1 7 b0 $end
     $var wire  1 6 b1 $end
    $upscope $end
-   $scope module v_arru_strp(4) $end
+   $scope struct v_arru_strp(4) $end
     $var wire  1 9 b0 $end
     $var wire  1 8 b1 $end
    $upscope $end
-   $scope module v_enumb2_str $end
+   $scope struct v_enumb2_str $end
     $var wire  3 E a [2:0] $end
     $var wire  3 F b [2:0] $end
    $upscope $end
-   $scope module v_str32x2(0) $end
+   $scope struct v_str32x2(0) $end
     $var wire 32 @ data [31:0] $end
    $upscope $end
-   $scope module v_str32x2(1) $end
+   $scope struct v_str32x2(1) $end
     $var wire 32 A data [31:0] $end
    $upscope $end
-   $scope module v_strp $end
+   $scope struct v_strp $end
     $var wire  1 & b0 $end
     $var wire  1 % b1 $end
    $upscope $end
-   $scope module v_strp_strp $end
+   $scope struct v_strp_strp $end
-    $scope module x0 $end
+    $scope struct x0 $end
      $var wire  1 * b0 $end
      $var wire  1 ) b1 $end
     $upscope $end
-    $scope module x1 $end
+    $scope struct x1 $end
      $var wire  1 ( b0 $end
      $var wire  1 ' b1 $end
     $upscope $end
    $upscope $end
-   $scope module v_unip_strp $end
+   $scope struct v_unip_strp $end
-    $scope module x0 $end
+    $scope struct x0 $end
      $var wire  1 , b0 $end
      $var wire  1 + b1 $end
     $upscope $end
-    $scope module x1 $end
+    $scope struct x1 $end
      $var wire  1 , b0 $end
      $var wire  1 + b1 $end
     $upscope $end