Fix hierarchical compilation with nested -F (#5114) (#5124)

docs/CONTRIBUTORS

@@ -9,6 +9,7 @@ Adrien Le Masle
 Ahmed El-Mahmoudy
 Aleksander Kiryk
 Alex Chadwick
+Alex Solomatnikov
 Àlex Torregrosa
 Aliaksei Chapyzhenka
 Ameya Vikram Singh

src/V3HierBlock.cpp

@@ -98,8 +98,6 @@ static void V3HierWriteCommonInputs(const V3HierBlock* hblockp, std::ostream* of
     if (hblockp) topModuleFile = hblockp->vFileIfNecessary();
     if (!forCMake) {
         if (!topModuleFile.empty()) *of << topModuleFile << "\n";
-        const V3StringList& vFiles = v3Global.opt.vFiles();
-        for (const string& i : vFiles) *of << i << "\n";
     }
     const V3StringSet& libraryFiles = v3Global.opt.libraryFiles();
     for (const string& i : libraryFiles) {
@@ -227,7 +225,7 @@ void V3HierBlock::writeCommandArgsFile(bool forCMake) const {
     for (const string& opt : commandOpts) *of << opt << "\n";
     *of << hierBlockArgs().front() << "\n";
     for (const auto& hierblockp : m_children) *of << hierblockp->hierBlockArgs().front() << "\n";
-    *of << v3Global.opt.allArgsStringForHierBlock(false) << "\n";
+    *of << v3Global.opt.allArgsStringForHierBlock(false, forCMake) << "\n";
 }
 
 string V3HierBlock::commandArgsFileName(bool forCMake) const {
@@ -424,7 +422,7 @@ void V3HierBlockPlan::writeCommandArgsFiles(bool forCMake) const {
     }
     *of << "--threads " << cvtToStr(v3Global.opt.threads()) << "\n";
     *of << (v3Global.opt.systemC() ? "--sc" : "--cc") << "\n";
-    *of << v3Global.opt.allArgsStringForHierBlock(true) << "\n";
+    *of << v3Global.opt.allArgsStringForHierBlock(true, forCMake) << "\n";
 }
 
 string V3HierBlockPlan::topCommandArgsFileName(bool forCMake) {

src/V3Options.cpp

@@ -67,6 +67,7 @@ public:
     using DirMap = std::map<const string, std::set<std::string>>;  // Directory listing
 
     // STATE
+    std::list<string> m_lineArgs;  // List of command line argument encountered
     std::list<string> m_allArgs;  // List of every argument encountered
     std::list<string> m_incDirUsers;  // Include directories (ordered)
     std::set<string> m_incDirUserSet;  // Include directories (for removing duplicates)
@@ -393,6 +394,8 @@ void V3Options::addVFile(const string& filename) {
 }
 void V3Options::addForceInc(const string& filename) { m_forceIncs.push_back(filename); }
 
+void V3Options::addLineArg(const string& arg) { m_impp->m_lineArgs.push_back(arg); }
+
 void V3Options::addArg(const string& arg) { m_impp->m_allArgs.push_back(arg); }
 
 string V3Options::allArgsString() const VL_MT_SAFE {
@@ -405,12 +408,12 @@ string V3Options::allArgsString() const VL_MT_SAFE {
 }
 
 // Delete some options for Verilation of the hierarchical blocks.
-string V3Options::allArgsStringForHierBlock(bool forTop) const {
+string V3Options::allArgsStringForHierBlock(bool forTop, bool forCMake) const {
     std::set<string> vFiles;
     for (const auto& vFile : m_vFiles) vFiles.insert(vFile);
     string out;
-    for (std::list<string>::const_iterator it = m_impp->m_allArgs.begin();
+    for (std::list<string>::const_iterator it = m_impp->m_lineArgs.begin();
-         it != m_impp->m_allArgs.end(); ++it) {
+         it != m_impp->m_lineArgs.end(); ++it) {
         int skip = 0;
         if (it->length() >= 2 && (*it)[0] == '-' && (*it)[1] == '-') {
             skip = 2;
@@ -426,7 +429,7 @@ string V3Options::allArgsStringForHierBlock(bool forTop) const {
                 continue;
             }
         } else {  // Not an option
-            if (vFiles.find(*it) != vFiles.end()  // Remove HDL
+            if ((forCMake && vFiles.find(*it) != vFiles.end())  // Remove HDL
                 || m_cppFiles.find(*it) != m_cppFiles.end()) {  // Remove C++
                 continue;
             }
@@ -1003,6 +1006,11 @@ string V3Options::argString(int argc, char** argv) {
 // V3 Options Parsing
 
 void V3Options::parseOpts(FileLine* fl, int argc, char** argv) VL_MT_DISABLED {
+    // Save command line options
+    for (int i = 0; i < argc; ++i) {
+        addLineArg(argv[i]);
+    }
+
     // Parse all options
     // Initial entry point from Verilator.cpp
     parseOptsList(fl, ".", argc, argv);

src/V3Options.h

@@ -400,6 +400,7 @@ private:
 
 private:
     // METHODS
+    void addLineArg(const string& arg);
     void addArg(const string& arg);
     void addDefine(const string& defline, bool allowPlus) VL_MT_DISABLED;
     void addFuture(const string& flag);
@@ -699,7 +700,7 @@ public:
     string allArgsString() const VL_MT_SAFE;  ///< Return all passed arguments as simple string
     // Return options for child hierarchical blocks when forTop==false, otherwise returns args for
     // the top module.
-    string allArgsStringForHierBlock(bool forTop) const;
+    string allArgsStringForHierBlock(bool forTop, bool forCMake) const;
     void parseOpts(FileLine* fl, int argc, char** argv) VL_MT_DISABLED;
     void parseOptsList(FileLine* fl, const string& optdir, int argc, char** argv) VL_MT_DISABLED;
     void parseOptsFile(FileLine* fl, const string& filename, bool rel) VL_MT_DISABLED;

test_regress/t/t_hier_trace.pl

@@ -11,7 +11,7 @@ if (!$::Driver) { use FindBin; exec("$FindBin::Bin/bootstrap.pl", @ARGV, $0); di
 scenarios(simulator => 1);
 
 compile(
-    verilator_flags2 => ['--trace', '-j 4', 't/t_hier_trace.vlt', '--top-module t', '--hierarchical'],
+    verilator_flags2 => ['--trace', '-j 4', 't/t_hier_trace_sub/t_hier_trace.vlt', '--top-module t', '--hierarchical', '-F t/t_hier_trace_sub/top.F'],
     );
 
 execute(

test_regress/t/t_hier_trace.v

@@ -4,49 +4,6 @@
 // any use, without warranty, 2024 by Wilson Snyder.
 // SPDX-License-Identifier: CC0-1.0
 
-module detail_code(
-    input clk,
-    input reset_l);
-endmodule
-
-module sub_top(
-    input clk,
-    input reset_l);
-
-    detail_code u0(
-          .clk(clk),
-          .reset_l(reset_l)
-    );
-    detail_code u1(
-          .clk(clk),
-          .reset_l(reset_l)
-    );
-    detail_code u2(
-          .clk(clk),
-          .reset_l(reset_l)
-    );
-    detail_code u3(
-          .clk(clk),
-          .reset_l(reset_l)
-    );
-    detail_code u4(
-          .clk(clk),
-          .reset_l(reset_l)
-    );
-    detail_code u5(
-          .clk(clk),
-          .reset_l(reset_l)
-    );
-    detail_code u6(
-          .clk(clk),
-          .reset_l(reset_l)
-    );
-    detail_code u7(
-          .clk(clk),
-          .reset_l(reset_l)
-    );
-endmodule
-
 module t(
     input clk,
     input reset_l);

test_regress/t/t_hier_trace_noinl.pl

@@ -13,7 +13,7 @@ scenarios(simulator => 1);
 top_filename("t/t_hier_trace.v");
 
 compile(
-    verilator_flags2 => ['--trace', '-j 4', 't/t_hier_trace.vlt', '--top-module t', '--hierarchical', '--fno-inline'],
+    verilator_flags2 => ['--trace', '-j 4', 't/t_hier_trace_sub/t_hier_trace.vlt', '--top-module t', '--hierarchical', '--fno-inline', '-F t/t_hier_trace_sub/top.F'],
     );
 
 execute(

test_regress/t/t_hier_trace_sub/sub.F

@@ -0,0 +1,7 @@
+# Copyright 2024 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
+
+t_hier_trace_sub.v

test_regress/t/t_hier_trace_sub/t_hier_trace_sub.v

@@ -0,0 +1,48 @@
+// DESCRIPTION: Verilator: Verilog Test module
+//
+// This file ONLY is placed under the Creative Commons Public Domain, for
+// any use, without warranty, 2024 by Wilson Snyder.
+// SPDX-License-Identifier: CC0-1.0
+
+module detail_code(
+    input clk,
+    input reset_l);
+endmodule
+
+module sub_top(
+    input clk,
+    input reset_l);
+
+    detail_code u0(
+          .clk(clk),
+          .reset_l(reset_l)
+    );
+    detail_code u1(
+          .clk(clk),
+          .reset_l(reset_l)
+    );
+    detail_code u2(
+          .clk(clk),
+          .reset_l(reset_l)
+    );
+    detail_code u3(
+          .clk(clk),
+          .reset_l(reset_l)
+    );
+    detail_code u4(
+          .clk(clk),
+          .reset_l(reset_l)
+    );
+    detail_code u5(
+          .clk(clk),
+          .reset_l(reset_l)
+    );
+    detail_code u6(
+          .clk(clk),
+          .reset_l(reset_l)
+    );
+    detail_code u7(
+          .clk(clk),
+          .reset_l(reset_l)
+    );
+endmodule

test_regress/t/t_hier_trace_sub/top.F

@@ -0,0 +1,7 @@
+# Copyright 2024 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
+
+-F sub.F