Merge pull request #2281 from ucb-bar/config-finder

Add full-config-finder: finds eligible CONFIG targets

Author: jerryz123

.github/workflows/chipyard-full-flow.yml

@@ -106,6 +106,7 @@ jobs:
           source env.sh
           cd sims/verilator
           make find-config-fragments
+          make find-configs
       - name: Run smoke test
         run: |
           cd ${{ env.REMOTE_WORK_DIR }}

common.mk

@@ -68,6 +68,7 @@ HELP_COMMANDS += \
 "   firrtl                      = generate intermediate firrtl files from chisel elaboration" \
 "   run-tests                   = run all assembly and benchmark tests" \
 "   launch-sbt                  = start sbt terminal" \
+"   find-configs                = list Chipyard Config classes (eligible CONFIG=)" \
 "   find-config-fragments       = list all config. fragments" \
 "   check-submodule-status      = check that all submodules in generators/ have been initialized"
 
@@ -449,6 +450,10 @@ endef
 find-config-fragments:
 	$(call run_scala_main,chipyard,chipyard.ConfigFinder,)
 
+.PHONY: find-configs
+find-configs:
+	$(call run_scala_main,chipyard,chipyard.ChipyardConfigFinder,)
+
 .PHONY: help
 help:
 	@for line in $(HELP_LINES); do echo "$$line"; done

docs/Customization/Keys-Traits-Configs.rst

@@ -79,4 +79,5 @@ We can use this config fragment when composing our configs.
 Chipyard Config Fragments
 -------------------------
 
-For discoverability, users can run ``make find-config-fragments`` to see a list of config. fragments.
+For discoverability, users can run ``make find-configs`` to list Chipyard ``Config`` classes eligible for ``CONFIG=...`` (defaults to package ``chipyard``). Only classes whose names end with ``Config`` are shown.
+To see reusable building blocks, run ``make find-config-fragments`` to list config fragments.

docs/Simulation/Software-RTL-Simulation.rst

@@ -154,6 +154,17 @@ Therefore, in order to simulate a simple Rocket-based example system we can use:
     make SUB_PROJECT=yourproject
     ./simulator-<yourproject>-<yourconfig> ...
 
+Listing available configs
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To discover available Chipyard configs that can be passed as ``CONFIG=...`` (under the default ``CONFIG_PACKAGE=chipyard``), run:
+
+.. code-block:: shell
+
+    make find-configs
+
+This lists Chipyard classes that extend ``Config``. Only classes whose names end with ``Config`` are shown.
+
 
 Finally, in the ``generated-src/<...>-<package>-<config>/`` directory resides all of the collateral while the generated Verilog source files resides in ``generated-src/<...>-<package>-<config>/gen-collateral`` for the build/simulation.
 Specifically, for ``CONFIG=RocketConfig`` the SoC top-level (``TOP``) Verilog file is ``ChipTop.sv`` while the (``Model``) file is ``TestHarness.sv``.

generators/chipyard/src/main/scala/ConfigFinder.scala

@@ -17,3 +17,28 @@ object ConfigFinder {
         }
     }
 }
+
+/**
+  * Lists only Chipyard configs suitable for use with make CONFIG=<Class>.
+  * Filters to classes in the `chipyard` package hierarchy that extend Config.
+  */
+object ChipyardConfigFinder {
+    def main(args: Array[String]) = {
+        val reflections = new Reflections()
+        val classes = reflections.get(SubTypes.of(classOf[Config]).asClass()).asScala
+        val chipyardOnly = classes
+          .map(_.getName)
+          .filter { n =>
+            val isChipyard = n.startsWith("chipyard.")
+            val notExamples = !n.startsWith("chipyard.example.")
+            val notHarness = !n.startsWith("chipyard.harness.")
+            val notIOBinders = !n.startsWith("chipyard.iobinders.")
+            val notConfigPkg = !n.startsWith("chipyard.config.")
+            val endsWithConfig = n.split("\\.").lastOption.exists(_.endsWith("Config"))
+            isChipyard && notExamples && notHarness && notIOBinders && notConfigPkg && endsWithConfig
+          }
+          .map(n => n.stripPrefix("chipyard."))
+        val sorted = SortedSet[String]() ++ chipyardOnly
+        sorted.foreach(println)
+    }
+}