Support header entries in RTL filelists

Makefile

@@ -1,5 +1,6 @@
 SHELL := bash
 .SHELLFLAGS := -eu -o pipefail -c
+.DEFAULT_GOAL := all
 
 .PHONY: all init build install appimage test test_all test_vpi_all test_mem_direct_all \
         test_all_java test_all_scala clean wheel wheel_install tests smoke_tests unit_tests

example/MultiFileRTL/design.f

@@ -0,0 +1,5 @@
++incdir+inc
+inc/defs.vh
+inc/outer.svh
+leaf.v
+top.sv

example/MultiFileRTL/example.py

@@ -0,0 +1,29 @@
+try:
+    from UT_MultiFileRTLTop import *
+except:
+    try:
+        from MultiFileRTLTop import *
+    except:
+        from __init__ import *
+
+
+if __name__ == "__main__":
+    dut = DUTMultiFileRTLTop()
+
+    test_vectors = [
+        0x0,
+        0x1,
+        0x5A,
+        0x123,
+        0xABC,
+        0xFFF,
+    ]
+
+    for idx, value in enumerate(test_vectors):
+        dut.a.value = value
+        dut.Step(1)
+        print(f"case {idx}: a=0x{value:x}, b=0x{dut.b.value:x}")
+        assert dut.b.value == value, "output mismatch"
+
+    print("Test Passed, destroy UTMultiFileRTLTop")
+    dut.Finish()

example/MultiFileRTL/inc/defs.vh

@@ -0,0 +1 @@
+`define MULTI_FILE_RTL_W 8

example/MultiFileRTL/inc/outer.svh

@@ -0,0 +1,2 @@
+`include "defs.vh"
+`define MULTI_FILE_RTL_OUT_W (`MULTI_FILE_RTL_W + 4)

example/MultiFileRTL/leaf.v

@@ -0,0 +1,8 @@
+module MultiFileRTLLeaf #(
+    parameter WIDTH = 8
+) (
+    input  [WIDTH-1:0] a,
+    output [WIDTH-1:0] b
+);
+    assign b = a;
+endmodule

example/MultiFileRTL/release-vcs.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+set -e
+
+OUT_ROOT="${OUT_ROOT:-output}"
+OUT_DIR="$(realpath -m "${OUT_ROOT}/MultiFileRTL")"
+LANGUAGE_ARGS=()
+
+rm -rf "$OUT_DIR"
+if [[ $* == *"python"* ]]; then
+    LANGUAGE_ARGS+=(--lang python)
+fi
+
+./build/bin/picker export \
+  --fs example/MultiFileRTL/design.f \
+  --autobuild true \
+  --sim vcs \
+  --verdi-mode modern \
+  -w MultiFileRTLTop.fsdb \
+  --sname MultiFileRTLTop \
+  --tdir "$OUT_DIR" \
+  --sdir template \
+  "${LANGUAGE_ARGS[@]}" \
+  "$@"
+
+if [[ $* == *"python"* ]]; then
+    cp example/MultiFileRTL/example.py "$OUT_DIR"
+    cd "$OUT_DIR"
+    python3 example.py
+fi

example/MultiFileRTL/top.sv

@@ -0,0 +1,13 @@
+`include "outer.svh"
+
+module MultiFileRTLTop(
+    input logic [`MULTI_FILE_RTL_OUT_W-1:0] a,
+    output logic [`MULTI_FILE_RTL_OUT_W-1:0] b
+);
+    MultiFileRTLLeaf #(
+        .WIDTH(`MULTI_FILE_RTL_OUT_W)
+    ) u_leaf (
+        .a(a),
+        .b(b)
+    );
+endmodule

src/codegen/lib.cpp

@@ -43,7 +43,9 @@ namespace picker { namespace codegen {
                       std::string &ofilelist, std::vector<std::string> &incdirs)
     {
         std::vector<std::pair<std::string, std::string>> path_list;
-        const std::vector<std::string> allow_file_types = {".sv", ".v", ".cpp", ".c", ".cc", ".cxx", ".so", ".a", ".o"};
+        const std::vector<std::string> allow_file_types = {
+            ".sv", ".v", ".svh", ".vh", ".cpp", ".c", ".cc", ".cxx", ".so", ".a", ".o"};
+        const std::vector<std::string> header_file_types = {".svh", ".vh"};
         std::unordered_set<std::string> incdir_set;
         auto resolve_input_path = [](const std::string &path, const std::string &base_dir) {
             auto resolved = std::filesystem::path(path);
@@ -129,6 +131,10 @@ namespace picker { namespace codegen {
                 if (!std::filesystem::exists(resolved_file)) PK_FATAL("File not found: %s\n", target_file.c_str());
                 path = std::filesystem::absolute(resolved_file).lexically_normal().string();
                 if (source_file_set.count(path) != 0) { continue; } // skip source file
+                if (check_file_type(path, header_file_types)) {
+                    add_incdir(std::filesystem::path(path).parent_path().string(), "");
+                    continue;
+                }
                 ofilelist += path + "\n";
             } else if (path.ends_with("/")) { // directory
                 auto target_dir = path;
@@ -138,7 +144,14 @@ namespace picker { namespace codegen {
                 for (const auto &entry : iter) {
                     if (entry.is_regular_file()) {
                         std::string filename = entry.path().filename().string();
-                        if (check_file_type(filename, allow_file_types)) { ofilelist += entry.path().string() + "\n"; }
+                        if (check_file_type(filename, allow_file_types)) {
+                            const auto entry_path = entry.path().string();
+                            if (check_file_type(entry_path, header_file_types)) {
+                                add_incdir(entry.path().parent_path().string(), "");
+                                continue;
+                            }
+                            ofilelist += entry_path + "\n";
+                        }
                     }
                 }
             } else {

test/test_codegen_filelist.cpp

@@ -68,6 +68,8 @@ int main()
     fs::create_directories(cwd_base / "inc_shadow");
 
     write_text(base / "rtl1.sv", "module m; endmodule\n");
+    write_text(base / "defs.vh", "`define DEF_W 8\n");
+    write_text(base / "macro.svh", "`include \"defs.vh\"\n");
     write_text(base / "sub" / "rtl2.v", "module n; endmodule\n");
     write_text(base / "sub2" / "ignore.txt", "noop\n");
     write_text(base / "sub2" / "rtl3.sv", "module p; endmodule\n");
@@ -154,6 +156,26 @@ int main()
     assert(contains_line(ofilelist3, (base / "rtl1.sv").string()));
     assert(!contains_line(ofilelist3, (cwd_base / "rtl1.sv").string()));
 
+    const fs::path filelist4 = base / "filelist4.f";
+    write_text(filelist4,
+               "defs.vh\n"
+               "macro.svh\n"
+               "rtl1.sv\n");
+
+    std::string ofilelist4;
+    std::vector<std::string> incdirs4;
+    stderr_output = capture_stderr([&]() {
+        picker::codegen::gen_filelist({}, {filelist4.string()}, ofilelist4, incdirs4);
+    });
+
+    assert(stderr_output.empty());
+    assert(contains_line(ofilelist4, (base / "rtl1.sv").string()));
+    assert(!contains_line(ofilelist4, (base / "defs.vh").string()));
+    assert(!contains_line(ofilelist4, (base / "macro.svh").string()));
+    std::set<std::string> incset4(incdirs4.begin(), incdirs4.end());
+    assert(incset4.size() == 1);
+    assert(incset4.count(base.string()) == 1);
+
     fs::remove_all(cwd_base);
     fs::remove_all(base);
     return 0;