Add support for multi-file designs

This commit removes requirement of providing single-file as an input to
sv-bugpoint.
Now, user can provide multiple input files and they are passed to test
script as separate arguments. Each file is minimalized separately until
we can't remove any node from any file.

It adds `-f` flag that accepts command file with additional parameters
for sv-bugpoint and `-y` flag that includes add (System)Verilog files
from given folder.

Signed-off-by: Kamil Rakoczy <krakoczy@antmicro.com>

Author: kamilrakoczy

CMakeLists.txt

@@ -12,7 +12,7 @@ FetchContent_Declare(
 FetchContent_MakeAvailable(slang)
 
 add_executable(sv-bugpoint source/SvBugpoint.cpp source/Utils.cpp source/PairRemovers.cpp source/BodyRemover.cpp
-  source/BodyPartsRemover.cpp source/DeclRemover.cpp source/InstantationRemover.cpp source/BindRemover.cpp source/ModportRemover.cpp source/ContAssignRemover.cpp source/ParamAssignRemover.cpp
+  source/BodyPartsRemover.cpp source/DeclRemover.cpp source/InstantationRemover.cpp source/BindRemover.cpp source/ModportRemover.cpp source/ContAssignRemover.cpp source/ParamAssignRemover.cpp source/ModuleRemover.cpp
   source/StatementsRemover.cpp source/MemberRemover.cpp source/ImportsRemover.cpp source/TypeSimplifier.cpp)
 
 target_link_libraries(sv-bugpoint PRIVATE slang::slang)

README.md

@@ -40,25 +40,27 @@ First, you need to prepare:
 It should exit with 0 if the assertion is successful.
 For reference, see [`examples/caliptra_verilation_err/sv-bugpoint-check.sh`](examples/caliptra_verilation_err/sv-bugpoint-check.sh) and [`examples/caliptra_vcd/sv-bugpoint-check.sh`](examples/caliptra_vcd/sv-bugpoint-check.sh).
 The script can be written in any language you are comfortable with, it just needs to be an executable. See the Python example: [`examples/caliptra_verilation_err/sv-bugpoint-check.py`](examples/caliptra_verilation_err/sv-bugpoint-check.py).
-- SystemVerilog code that `sv-bugpoint` will attempt to minimize. In order to get one from a multi-file design,
-you can use a preprocessor of your choice (e.g `verilator -E -P [other flags...] > sv-bugpoint-input.sv`).
+- SystemVerilog code that `sv-bugpoint` will attempt to minimize.
 
 After that, run:
 
 ```sh
-sv-bugpoint <OUT_DIR> <CHECK_SCRIPT> <INPUT_SV>
+sv-bugpoint <OUT_DIR> <CHECK_SCRIPT> <INPUT_SV> [<INPUT_SV>]
 ```
 
 The output directory will be populated with:
-- `sv-bugpoint-minimized.sv` - minimized code that satisfies the assertion checked by the provided script,
+- `sv-bugpoint-minimized.sv` - minimized code that satisfies the assertion checked by the provided script. It contains concatenated output of every input file,
+- `sv-bugpoint-<INPUT_SV>` - minimalized code for each input file,
 - `tmp/<INPUT_SV>` - a copy of the previous file with a removal attempt applied, to be checked with the provided script,
-- `sv-bugpoint-trace` - verbose, tab-delimited trace with stats and additional info about each removal attempt ([example](examples/caliptra_verilation_err/sv-bugpoint-trace)).
+- `sv-bugpoint-trace<INPUT_SV>` - verbose, tab-delimited trace with stats and additional info about each removal attempt ([example](examples/caliptra_verilation_err/sv-bugpoint-trace)).
   It can be turned into a concise, high-level summary with the [`sv-bugpoint-trace_summary script`](scripts/sv-bugpoint-trace_summary) ([example](examples/caliptra_verilation_err/sv-bugpoint-trace_summarized)).
 
 There are flags that enable additional dumps:
 - `--save-intermediates` saves each removal attempt in `<OUT_DIR>/intermediates/attempt<index>.sv`.
 - `--dump-trees` saves dumps of Slang's AST.
 
+To get more information about available flags, run `sv-bugpoint --help`.
+
 ### Automatically generating check scripts
 
 If your goal is to debug Verilator, the [`sv-bugpoint-verilator-gen` script](scripts/sv-bugpoint-verilator-gen) can automatically generate an input test case and a check script template for you.

source/BindRemover.cpp

@@ -11,4 +11,5 @@ class BindRemover : public OneTimeRewriter<BindRemover> {
 
 template bool rewriteLoop<BindRemover>(std::shared_ptr<SyntaxTree>& tree,
                                        std::string stageName,
-                                       std::string passIdx);
+                                       std::string passIdx,
+                                       SvBugpoint* svBugpoint);

source/BodyPartsRemover.cpp

@@ -19,4 +19,5 @@ class BodyPartsRemover : public OneTimeRewriter<BodyPartsRemover> {
 
 template bool rewriteLoop<BodyPartsRemover>(std::shared_ptr<SyntaxTree>& tree,
                                             std::string stageName,
-                                            std::string passIdx);
+                                            std::string passIdx,
+                                            SvBugpoint* svBugpoint);

source/BodyRemover.cpp

@@ -26,4 +26,5 @@ class BodyRemover : public OneTimeRewriter<BodyRemover> {
 
 template bool rewriteLoop<BodyRemover>(std::shared_ptr<SyntaxTree>& tree,
                                        std::string stageName,
-                                       std::string passIdx);
+                                       std::string passIdx,
+                                       SvBugpoint* svBugpoint);

source/ContAssignRemover.cpp

@@ -11,4 +11,5 @@ class ContAssignRemover : public OneTimeRewriter<ContAssignRemover> {
 
 template bool rewriteLoop<ContAssignRemover>(std::shared_ptr<SyntaxTree>& tree,
                                              std::string stageName,
-                                             std::string passIdx);
+                                             std::string passIdx,
+                                             SvBugpoint* svBugpoint);

source/DeclRemover.cpp

@@ -56,4 +56,5 @@ class DeclRemover : public OneTimeRewriter<DeclRemover> {
 
 template bool rewriteLoop<DeclRemover>(std::shared_ptr<SyntaxTree>& tree,
                                        std::string stageName,
-                                       std::string passIdx);
+                                       std::string passIdx,
+                                       SvBugpoint* svBugpoint);

source/ImportsRemover.cpp

@@ -11,4 +11,5 @@ class ImportsRemover : public OneTimeRewriter<ImportsRemover> {
 
 template bool rewriteLoop<ImportsRemover>(std::shared_ptr<SyntaxTree>& tree,
                                           std::string stageName,
-                                          std::string passIdx);
+                                          std::string passIdx,
+                                          SvBugpoint* svBugpoint);

source/InstantationRemover.cpp

@@ -11,4 +11,5 @@ class InstantationRemover : public OneTimeRewriter<InstantationRemover> {
 
 template bool rewriteLoop<InstantationRemover>(std::shared_ptr<SyntaxTree>& tree,
                                                std::string stageName,
-                                               std::string passIdx);
+                                               std::string passIdx,
+                                               SvBugpoint* svBugpoint);

source/MemberRemover.cpp

@@ -43,4 +43,5 @@ class MemberRemover : public OneTimeRewriter<MemberRemover> {
 
 template bool rewriteLoop<MemberRemover>(std::shared_ptr<SyntaxTree>& tree,
                                          std::string stageName,
-                                         std::string passIdx);
+                                         std::string passIdx,
+                                         SvBugpoint* svBugpoint);