From 1d0a06438c93a5aff1dceb0df61411e0569f3394 Mon Sep 17 00:00:00 2001
From: Ryszard Rozak <rrozak@antmicro.com>
Date: Tue, 14 Mar 2023 09:54:43 +0100
Subject: [PATCH] Assign unique names for blocks in do..while loop (#4019)

---
 src/V3AstNodeOther.h         | 10 ++-----
 src/V3LinkJump.cpp           | 27 ++++++++++++-----
 test_regress/t/t_do_while.pl | 21 +++++++++++++
 test_regress/t/t_do_while.v  | 58 ++++++++++++++++++++++++++++++++++++
 4 files changed, 101 insertions(+), 15 deletions(-)
 create mode 100755 test_regress/t/t_do_while.pl
 create mode 100644 test_regress/t/t_do_while.v

diff --git a/src/V3AstNodeOther.h b/src/V3AstNodeOther.h
index 111b6b3a3..7ad7594ee 100644
--- a/src/V3AstNodeOther.h
+++ b/src/V3AstNodeOther.h
@@ -2651,17 +2651,13 @@ public:
     bool addNewline() const { return displayType().addNewline(); }
 };
 class AstDoWhile final : public AstNodeStmt {
-    // @astgen op1 := precondsp : List[AstNode]
-    // @astgen op2 := condp : AstNodeExpr
-    // @astgen op3 := stmtsp : List[AstNode]
-    // @astgen op4 := incsp : List[AstNode]
+    // @astgen op1 := condp : AstNodeExpr
+    // @astgen op2 := stmtsp : List[AstNode]
 public:
-    AstDoWhile(FileLine* fl, AstNodeExpr* conditionp, AstNode* stmtsp = nullptr,
-               AstNode* incsp = nullptr)
+    AstDoWhile(FileLine* fl, AstNodeExpr* conditionp, AstNode* stmtsp = nullptr)
         : ASTGEN_SUPER_DoWhile(fl) {
         condp(conditionp);
         addStmtsp(stmtsp);
-        addIncsp(incsp);
     }
     ASTGEN_MEMBERS_AstDoWhile;
     bool isGateOptimizable() const override { return false; }
diff --git a/src/V3LinkJump.cpp b/src/V3LinkJump.cpp
index 14c1eddac..ec1ce3f1a 100644
--- a/src/V3LinkJump.cpp
+++ b/src/V3LinkJump.cpp
@@ -128,6 +128,19 @@ private:
             return labelp;
         }
     }
+    void addPrefixToBlocksRecurse(AstNode* nodep) {
+        // Add do_while_ prefix to blocks
+        // Used to not have blocks with duplicated names
+        if (AstBegin* const beginp = VN_CAST(nodep, Begin)) {
+            if (beginp->name() != "") beginp->name("__Vdo_while_" + beginp->name());
+        }
+
+        if (nodep->op1p()) addPrefixToBlocksRecurse(nodep->op1p());
+        if (nodep->op2p()) addPrefixToBlocksRecurse(nodep->op2p());
+        if (nodep->op3p()) addPrefixToBlocksRecurse(nodep->op3p());
+        if (nodep->op4p()) addPrefixToBlocksRecurse(nodep->op4p());
+        if (nodep->nextp()) addPrefixToBlocksRecurse(nodep->nextp());
+    }
 
     // VISITORS
     void visit(AstNodeModule* nodep) override {
@@ -200,23 +213,21 @@ private:
     void visit(AstDoWhile* nodep) override {
         // It is converted to AstWhile in this visit method
         VL_RESTORER(m_loopp);
-        VL_RESTORER(m_loopInc);
         {
             m_loopp = nodep;
-            m_loopInc = false;
-            iterateAndNextNull(nodep->precondsp());
             iterateAndNextNull(nodep->condp());
             iterateAndNextNull(nodep->stmtsp());
-            m_loopInc = true;
-            iterateAndNextNull(nodep->incsp());
         }
         AstNodeExpr* const condp = nodep->condp() ? nodep->condp()->unlinkFrBack() : nullptr;
         AstNode* const bodyp = nodep->stmtsp() ? nodep->stmtsp()->unlinkFrBack() : nullptr;
-        AstNode* const incsp = nodep->incsp() ? nodep->incsp()->unlinkFrBack() : nullptr;
-        AstWhile* const whilep = new AstWhile{nodep->fileline(), condp, bodyp, incsp};
+        AstWhile* const whilep = new AstWhile{nodep->fileline(), condp, bodyp};
         nodep->replaceWith(whilep);
         VL_DO_DANGLING(nodep->deleteTree(), nodep);
-        if (bodyp) whilep->addHereThisAsNext(bodyp->cloneTree(false));
+        if (bodyp) {
+            AstNode* const copiedBodyp = bodyp->cloneTree(false);
+            addPrefixToBlocksRecurse(copiedBodyp);
+            whilep->addHereThisAsNext(copiedBodyp);
+        }
     }
     void visit(AstForeach* nodep) override {
         VL_RESTORER(m_loopp);
diff --git a/test_regress/t/t_do_while.pl b/test_regress/t/t_do_while.pl
new file mode 100755
index 000000000..aabcde63e
--- /dev/null
+++ b/test_regress/t/t_do_while.pl
@@ -0,0 +1,21 @@
+#!/usr/bin/env perl
+if (!$::Driver) { use FindBin; exec("$FindBin::Bin/bootstrap.pl", @ARGV, $0); die; }
+# DESCRIPTION: Verilator: Verilog Test driver/expect definition
+#
+# Copyright 2020 by Wilson Snyder. This program is free software; you
+# can redistribute it and/or modify it under the terms of either the GNU
+# Lesser General Public License Version 3 or the Perl Artistic License
+# Version 2.0.
+# SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
+
+scenarios(simulator => 1);
+
+compile(
+    );
+
+execute(
+    check_finished => 1,
+    );
+
+ok(1);
+1;
diff --git a/test_regress/t/t_do_while.v b/test_regress/t/t_do_while.v
new file mode 100644
index 000000000..9423853f4
--- /dev/null
+++ b/test_regress/t/t_do_while.v
@@ -0,0 +1,58 @@
+// DESCRIPTION: Verilator: Verilog Test module
+//
+// This file ONLY is placed under the Creative Commons Public Domain, for
+// any use, without warranty, 2023 by Antmicro Ltd.
+// SPDX-License-Identifier: CC0-1.0
+
+function automatic int get_1;
+   int a = 0;
+   do begin
+      int x = 1;
+      a += x;
+   end while (a < 0);
+   return a;
+endfunction
+
+module t (/*AUTOARG*/);
+   int a;
+   initial begin
+      if (get_1() != 1) $stop;
+
+      a = 0;
+      do begin
+         int x = 1;
+         a += x;
+         if (a == 1) begin
+            a = 2;
+         end
+      end while (a < 0);
+      if (a != 2) $stop;
+
+      a = 1;
+      do begin
+         if (a == 1) begin
+            a = 2;
+         end
+         if (a == 2) begin
+            a = 3;
+         end
+      end while (a < 0);
+      if (a != 3) $stop;
+
+      a = 1;
+      do begin
+         if (a == 1) begin
+            do begin
+               a++;
+            end while (a < 5);
+         end
+         if (a == 2) begin
+            a = 3;
+         end
+      end while (a < 0);
+      if (a != 5) $stop;
+
+      $write("*-* All Finished *-*\n");
+      $finish;
+   end
+endmodule