Add Driver utility support for running an analysis pass

MikePopoloski · Feb 13, 2025 · 2d4b809 · 2d4b809
1 parent 877b805
commit 2d4b809
Show file tree

Hide file tree

Showing 11 changed files with 78 additions and 46 deletions.
diff --git a/bindings/python/CompBindings.cpp b/bindings/python/CompBindings.cpp
@@ -193,7 +193,10 @@ void registerCompilation(py::module_& m) {
         .def("createOptionBag", &Driver::createOptionBag)
         .def("createCompilation", &Driver::createCompilation)
         .def("reportParseDiags", &Driver::reportParseDiags)
-        .def("reportCompilation", &Driver::reportCompilation, "compilation"_a, "quiet"_a);
+        .def("reportCompilation", &Driver::reportCompilation, "compilation"_a, "quiet"_a)
+        .def("runAnalysis", &Driver::runAnalysis, "compilation"_a)
+        .def("reportDiagnostics", &Driver::reportDiagnostics, "quiet"_a)
+        .def("runFullCompilation", &Driver::runFullCompilation, "quiet"_a = false);
 
     py::class_<SourceOptions>(m, "SourceOptions")
         .def(py::init<>())

diff --git a/include/slang/driver/Driver.h b/include/slang/driver/Driver.h
@@ -53,9 +53,7 @@ namespace slang::driver {
 /// if (!driver.parseCommandLine(someStr)) { ...error }
 /// if (!driver.processOptions()) { ...error }
 /// if (!driver.parseAllSources()) { ...error }
-///
-/// auto compilation = driver.createCompilation();
-/// if (!driver.reportCompilation(*compilation)) { ...error }
+/// if (!driver.runFullCompilation()) { ...error }
 /// else { ...success }
 /// @endcode
 ///
@@ -336,8 +334,26 @@ class SLANG_EXPORT Driver {
     /// @brief Reports the result of compilation.
     ///
     /// If @a quiet is set to true, non-essential output will be suppressed.
+    void reportCompilation(ast::Compilation& compilation, bool quiet);
+
+    /// @brief Runs analysis on a compilation and reports the results.
+    ///
+    /// @note The compilation will be frozen after this call.
+    void runAnalysis(ast::Compilation& compilation);
+
+    /// @brief Reports all diagnostics to output.
+    ///
+    /// If @a quiet is set to true, non-essential output will be suppressed.
+    /// @returns true if compilation succeeded and false if errors were encountered.
+    [[nodiscard]] bool reportDiagnostics(bool quiet);
+
+    /// @brief Runs a full compilation pass and reports the results.
+    ///
+    /// This is a helper method that calls @a createCompilation, @a reportCompilation,
+    /// @a runAnalysis, and @a reportDiagnostics in sequence.
+    ///
     /// @returns true if compilation succeeded and false if errors were encountered.
-    [[nodiscard]] bool reportCompilation(ast::Compilation& compilation, bool quiet);
+    [[nodiscard]] bool runFullCompilation(bool quiet = false);
 
 private:
     bool parseUnitListing(std::string_view text);

diff --git a/source/driver/Driver.cpp b/source/driver/Driver.cpp
@@ -11,6 +11,7 @@
 #include <BS_thread_pool.hpp>
 #include <fmt/color.h>
 
+#include "slang/analysis/AnalysisManager.h"
 #include "slang/ast/symbols/CompilationUnitSymbols.h"
 #include "slang/ast/symbols/InstanceSymbols.h"
 #include "slang/diagnostics/DeclarationsDiags.h"
@@ -876,7 +877,7 @@ bool Driver::reportParseDiags() {
     return diagEngine.getNumErrors() == 0;
 }
 
-bool Driver::reportCompilation(Compilation& compilation, bool quiet) {
+void Driver::reportCompilation(Compilation& compilation, bool quiet) {
     if (!quiet) {
         auto topInstances = compilation.getRoot().topInstances;
         if (!topInstances.empty()) {
@@ -889,7 +890,20 @@ bool Driver::reportCompilation(Compilation& compilation, bool quiet) {
 
     for (auto& diag : compilation.getAllDiagnostics())
         diagEngine.issue(diag);
+}
+
+void Driver::runAnalysis(ast::Compilation& compilation) {
+    compilation.getAllDiagnostics();
+    compilation.freeze();
+
+    analysis::AnalysisManager analysisManager(options.numThreads.value_or(0));
+    analysisManager.analyze(compilation);
+
+    for (auto& diag : analysisManager.getDiagnostics())
+        diagEngine.issue(diag);
+}
 
+bool Driver::reportDiagnostics(bool quiet) {
     bool hasDiagsStdout = false;
     bool succeeded = diagEngine.getNumErrors() == 0;
 
@@ -929,6 +943,13 @@ bool Driver::reportCompilation(Compilation& compilation, bool quiet) {
     return succeeded;
 }
 
+bool Driver::runFullCompilation(bool quiet) {
+    auto compilation = createCompilation();
+    reportCompilation(*compilation, quiet);
+    runAnalysis(*compilation);
+    return reportDiagnostics(quiet);
+}
+
 bool Driver::parseUnitListing(std::string_view text) {
     CommandLine unitCmdLine;
     std::vector<std::string> includes;

diff --git a/tests/unittests/DriverTests.cpp b/tests/unittests/DriverTests.cpp
@@ -321,9 +321,7 @@ TEST_CASE("Driver full compilation") {
     CHECK(driver.parseCommandLine(args));
     CHECK(driver.processOptions());
     CHECK(driver.parseAllSources());
-
-    auto compilation = driver.createCompilation();
-    CHECK(driver.reportCompilation(*compilation, false));
+    CHECK(driver.runFullCompilation());
     CHECK(stdoutContains("Build succeeded"));
 }
 
@@ -339,9 +337,7 @@ TEST_CASE("Driver full compilation with defines and param overrides") {
     CHECK(driver.parseCommandLine(args));
     CHECK(driver.processOptions());
     CHECK(driver.parseAllSources());
-
-    auto compilation = driver.createCompilation();
-    CHECK(driver.reportCompilation(*compilation, false));
+    CHECK(driver.runFullCompilation());
     CHECK(stdoutContains("Build succeeded"));
 }
 
@@ -364,9 +360,7 @@ TEST_CASE("Driver setting a bunch of compilation options") {
         CHECK(driver.parseCommandLine(args));
         CHECK(driver.processOptions());
         CHECK(driver.parseAllSources());
-
-        auto compilation = driver.createCompilation();
-        CHECK(driver.reportCompilation(*compilation, false));
+        CHECK(driver.runFullCompilation());
         CHECK(stdoutContains("Build succeeded"));
     }
 }
@@ -383,9 +377,7 @@ TEST_CASE("Driver failed compilation") {
     CHECK(driver.parseCommandLine(args));
     CHECK(driver.processOptions());
     CHECK(driver.parseAllSources());
-
-    auto compilation = driver.createCompilation();
-    CHECK(!driver.reportCompilation(*compilation, false));
+    CHECK(!driver.runFullCompilation());
     CHECK(stdoutContains("Build failed"));
     CHECK(stdoutContains("1 error, 1 warning"));
 }
@@ -400,9 +392,7 @@ TEST_CASE("Driver command files") {
     CHECK(driver.parseCommandLine(args));
     CHECK(driver.processOptions());
     CHECK(driver.parseAllSources());
-
-    auto compilation = driver.createCompilation();
-    CHECK(driver.reportCompilation(*compilation, false));
+    CHECK(driver.runFullCompilation());
     CHECK(stdoutContains("Build succeeded"));
 }
 
@@ -443,9 +433,7 @@ TEST_CASE("Driver allow defines to be inherited to lib files") {
     CHECK(driver.parseCommandLine(args));
     CHECK(driver.processOptions());
     CHECK(driver.parseAllSources());
-
-    auto compilation = driver.createCompilation();
-    CHECK(driver.reportCompilation(*compilation, false));
+    CHECK(driver.runFullCompilation());
     CHECK(stdoutContains("Build succeeded"));
 }
 
@@ -499,9 +487,7 @@ TEST_CASE("Driver suppress warnings by path") {
     CHECK(driver.parseCommandLine(args));
     CHECK(driver.processOptions());
     CHECK(driver.parseAllSources());
-
-    auto compilation = driver.createCompilation();
-    CHECK(driver.reportCompilation(*compilation, false));
+    CHECK(driver.runFullCompilation());
     CHECK(stdoutContains("Build succeeded"));
     CHECK(stdoutContains("0 errors, 0 warnings"));
 }
@@ -518,9 +504,7 @@ TEST_CASE("Driver suppress macro warnings by path") {
     CHECK(driver.parseCommandLine(args));
     CHECK(driver.processOptions());
     CHECK(driver.parseAllSources());
-
-    auto compilation = driver.createCompilation();
-    CHECK(driver.reportCompilation(*compilation, false));
+    CHECK(driver.runFullCompilation());
     CHECK(stdoutContains("Build succeeded"));
     CHECK(stdoutContains("0 errors, 0 warnings"));
 }
@@ -610,9 +594,7 @@ TEST_CASE("Driver library map in compilation") {
     CHECK(driver.parseCommandLine(args));
     CHECK(driver.processOptions());
     CHECK(driver.parseAllSources());
-
-    auto compilation = driver.createCompilation();
-    CHECK(driver.reportCompilation(*compilation, false));
+    CHECK(driver.runFullCompilation());
     CHECK(stdoutContains("Build succeeded"));
     CHECK(stdoutContains("0 errors, 2 warnings"));
 }
@@ -657,7 +639,8 @@ TEST_CASE("Driver separate unit listing") {
     CHECK(driver.parseAllSources());
 
     auto compilation = driver.createCompilation();
-    CHECK(driver.reportCompilation(*compilation, false));
+    driver.reportCompilation(*compilation, false);
+    CHECK(driver.reportDiagnostics(false));
     CHECK(stdoutContains("Build succeeded"));
 
     auto& root = compilation->getRoot();
@@ -693,7 +676,8 @@ TEST_CASE("Driver customize default lib name") {
     CHECK(driver.parseAllSources());
 
     auto compilation = driver.createCompilation();
-    CHECK(driver.reportCompilation(*compilation, false));
+    driver.reportCompilation(*compilation, false);
+    CHECK(driver.reportDiagnostics(false));
     CHECK(stdoutContains("Build succeeded"));
 
     auto& root = compilation->getRoot();
@@ -722,9 +706,7 @@ TEST_CASE("Driver JSON diag output") {
     CHECK(driver.parseCommandLine(args));
     CHECK(driver.processOptions());
     CHECK(driver.parseAllSources());
-
-    auto compilation = driver.createCompilation();
-    CHECK(driver.reportCompilation(*compilation, true));
+    CHECK(driver.runFullCompilation(true));
     CHECK(stdoutContains(R"({
     "severity": "warning",
     "message": "no top-level modules found in design",

diff --git a/tests/unittests/ast/ConfigTests.cpp b/tests/unittests/ast/ConfigTests.cpp
@@ -57,7 +57,8 @@ TEST_CASE("Driver library default ordering") {
     CHECK(driver.parseAllSources());
 
     auto compilation = driver.createCompilation();
-    CHECK(driver.reportCompilation(*compilation, false));
+    driver.reportCompilation(*compilation, false);
+    CHECK(driver.reportDiagnostics(false));
 
     auto& m = compilation->getRoot().lookupName<InstanceSymbol>("top.m");
     CHECK(m.getDefinition().sourceLibrary.name == "lib1");
@@ -77,7 +78,8 @@ TEST_CASE("Driver library explicit ordering") {
     CHECK(driver.parseAllSources());
 
     auto compilation = driver.createCompilation();
-    CHECK(driver.reportCompilation(*compilation, false));
+    driver.reportCompilation(*compilation, false);
+    CHECK(driver.reportDiagnostics(false));
 
     auto& m = compilation->getRoot().lookupName<InstanceSymbol>("top.m");
     CHECK(m.getDefinition().sourceLibrary.name == "lib2");

diff --git a/tools/driver/slang_main.cpp b/tools/driver/slang_main.cpp
@@ -171,7 +171,9 @@ int driverMain(int argc, TArgs argv) {
                 {
                     TimeTraceScope timeScope("elaboration"sv, ""sv);
                     auto compilation = driver.createCompilation();
-                    ok &= driver.reportCompilation(*compilation, quiet == true);
+                    driver.reportCompilation(*compilation, quiet == true);
+
+                    ok &= driver.reportDiagnostics(quiet == true);
 
                     if (astJsonFile) {
                         printJson(*compilation, *astJsonFile, astJsonScopes,

diff --git a/tools/hier/hier.cpp b/tools/hier/hier.cpp
@@ -131,7 +131,9 @@ int main(int argc, char** argv) {
             }
         }));
     }
-    ok &= driver.reportCompilation(*compilation, /* quiet */ false);
+
+    driver.reportCompilation(*compilation, /* quiet */ false);
+    ok &= driver.reportDiagnostics(/* quiet */ false);
 
     return ok ? 0 : 3;
 }
diff --git a/tools/netlist/netlist.cpp b/tools/netlist/netlist.cpp
@@ -273,7 +273,8 @@ int main(int argc, char** argv) {
         bool ok = driver.parseAllSources();
 
         auto compilation = driver.createCompilation();
-        ok &= driver.reportCompilation(*compilation, *quiet);
+        driver.reportCompilation(*compilation, *quiet);
+        ok &= driver.reportDiagnostics(*quiet);
 
         if (!ok) {
             return ok;

diff --git a/tools/reflect/src/reflect.cpp b/tools/reflect/src/reflect.cpp
@@ -73,7 +73,8 @@ int main(int argc, char** argv) {
     SLANG_TRY {
         compilation_ok = driver.parseAllSources();
         compilation = driver.createCompilation();
-        compilation_ok &= driver.reportCompilation(*compilation, true);
+        driver.reportCompilation(*compilation, true);
+        compilation_ok &= driver.reportDiagnostics(true);
     }
     SLANG_CATCH(const std::exception& e) {
 #if __cpp_exceptions

diff --git a/tools/threadtest/threadtest.cpp b/tools/threadtest/threadtest.cpp
@@ -34,7 +34,8 @@ int main(int argc, char** argv) {
         }
 
         auto compilation = driver.createCompilation();
-        if (!driver.reportCompilation(*compilation, true))
+        driver.reportCompilation(*compilation, true);
+        if (!driver.reportDiagnostics(true))
             return 2;
 
         compilation->freeze();

diff --git a/tools/tidy/src/tidy.cpp b/tools/tidy/src/tidy.cpp
@@ -171,7 +171,8 @@ int main(int argc, char** argv) {
     SLANG_TRY {
         compilationOk = driver.parseAllSources();
         compilation = driver.createCompilation();
-        compilationOk &= driver.reportCompilation(*compilation, true);
+        driver.reportCompilation(*compilation, true);
+        compilationOk &= driver.reportDiagnostics(true);
     }
     SLANG_CATCH(const std::exception& e) {
 #if __cpp_exceptions