Merge new command "list csrs" CLI (riscv-software-src#909)

Added `test_list_csrs` with an assertion for equality of the number of
CSRs reported with [the number of yaml files under `csr`
directory](https://github.com/riscv-software-src/riscv-unified-db/blob/d0e69a4e02b33e0ea082a6fbc83f6f6e38480031/tools/ruby-gems/udb/test/test_cli.rb#L77).

---------

Signed-off-by: Ajit Dingankar <[email protected]>
Co-authored-by: Derek Hower <[email protected]>
Co-authored-by: Paul Clarke <[email protected]>

Author: 3 people

Gemfile.lock

@@ -130,7 +130,7 @@ GEM
     nokogiri (1.18.8-x86_64-linux-gnu)
       racc (~> 1.4)
     observer (0.1.2)
-    ostruct (0.6.1)
+    ostruct (0.6.2)
     parallel (1.27.0)
     parser (3.3.8.0)
       ast (~> 2.4.1)
@@ -188,18 +188,18 @@ GEM
       nokogiri
     rexml (3.4.1)
     rouge (4.5.2)
-    rubocop (1.76.0)
+    rubocop (1.77.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.45.0, < 2.0)
+      rubocop-ast (>= 1.45.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.45.0)
+    rubocop-ast (1.45.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
     rubocop-github (0.26.0)
@@ -239,7 +239,7 @@ GEM
     simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
     simpleidn (0.2.3)
-    solargraph (0.55.0)
+    solargraph (0.56.0)
       backport (~> 1.2)
       benchmark (~> 0.4)
       bundler (~> 2.0)
@@ -251,6 +251,7 @@ GEM
       observer (~> 0.1)
       ostruct (~> 0.6)
       parser (~> 3.0)
+      prism (~> 1.4)
       rbs (~> 3.3)
       reverse_markdown (~> 3.0)
       rubocop (~> 1.38)
@@ -287,7 +288,7 @@ GEM
     terminal-table (4.0.0)
       unicode-display_width (>= 1.1.1, < 4)
     thor (1.3.2)
-    tilt (2.6.0)
+    tilt (2.6.1)
     treetop (1.6.12)
       polyglot (~> 0.3)
     ttfunk (1.7.0)

tools/ruby-gems/udb/lib/udb/cli.rb

@@ -245,6 +245,37 @@ def parameters
           out.puts JSON.dump(yaml)
         end
       end
+
+
+      desc "csrs", "list all csrs for a config"
+      method_option :arch, aliases: "-a", type: :string, desc: "Path to architecture database", default: Udb.default_std_isa_path.to_s
+      method_option :arch_overlay, type: :string, desc: "Path to architecture overlay directory", default: Udb.default_custom_isa_path.to_s
+      method_option :gen, type: :string, desc: "Path to folder used for generation", default: Udb.default_gen_path.to_s
+      method_option :config, type: :string, required: true, desc: "Configuration name, or path to a config file", default: "_"
+      method_option :config_dir, type: :string, desc: "Path to directory with config files", default: Udb.default_cfgs_path.to_s
+      def csrs
+        raise ArgumentError, "Arch directory does not exist: #{options[:arch]}" unless File.directory?(options[:arch])
+
+        cfg_file =
+          if File.file?(options[:config])
+            Pathname.new(options[:config])
+          elsif File.file?("#{options[:config_dir]}/#{options[:config]}.yaml")
+            Pathname.new("#{options[:config_dir]}/#{options[:config]}.yaml")
+          else
+            raise ArgumentError, "Cannot find config: #{options[:config]}"
+          end
+
+        resolver =
+          Udb::Resolver.new(
+            std_path_override: Pathname.new(options[:arch]),
+            custom_path_override: Pathname.new(options[:arch_overlay]),
+            gen_path_override: Pathname.new(options[:gen])
+          )
+        cfg_arch = resolver.cfg_arch_for(cfg_file.realpath)
+        cfg_arch.csrs.each do |csr|
+          puts csr.name
+        end
+      end
     end
   end
 

tools/ruby-gems/udb/test/test_cli.rb

@@ -62,4 +62,16 @@ def test_disasm
     assert_match "  lui", out
     assert_empty err
   end
+
+  def test_list_csrs
+    out, err = capture_io do
+      run_cmd("list csrs")
+    end
+    assert_empty err
+    repo_top = Udb.repo_root
+    num_csr_yaml_files = `find #{repo_top}/spec/std/isa/csr/ -name '*.yaml' | wc -l`.to_i
+    puts num_csr_yaml_files
+    assert_equal num_csr_yaml_files, out.split.length
+  end
+
 end