udb-gen 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 185afac7b8a6c8e7bdc766345c0963b3507e5196c3b0bf5afc50df2763607617
-  data.tar.gz: 3176d980ea6d9792b86f27f2b3ed0f3a1ee3a952cbdd4c495a68a7a1e7a7d6df
+  metadata.gz: 3f2e3db34409108c4ac83f95a778d24936d06b3d5124ab6138af60020e94c740
+  data.tar.gz: f8274018357279d3aa28bfe47a7e77137f29d1238b73336ea8048575b23298d3
 SHA512:
-  metadata.gz: 9af5bcc545ef8820a6bcde727b1db168a9b60d5a3185b94846fbb9b212a53aeb9b92e2faba7d55a77643004bf2295e36822be9000dbb97c586342db4859796d0
-  data.tar.gz: 29ed9637c8140810e849db5f00632090bba16690064cd9694381843114b09871fb55016954ebd2883b9a107fed527ff40e11042ce750cce7406825d0df8da9b3
+  metadata.gz: 11d8d5b8a08aa3aa2490c0998ec033538643680b266267f0b1265ea0fac15605e01e0ce8b72e1000fd4eb161e47a6f245f986b5f2170064a665c326c592b7b2b
+  data.tar.gz: 2fec5ed54797ae271ce320c31b20b549f559477cf72d9335cc6d9fdd6ea955b12b1a16f3f9717beee13ccdde5b433e2995c6e64fdeecadc0473a78eb93f3fa23

data/lib/udb-gen/cfg_header_base.rb

@@ -81,7 +81,9 @@ module UdbGen
       guard_name = "UDB_CFG_#{cfg_arch.name.upcase.gsub(/[^A-Z0-9]/, "_")}#{guard_suffix}"
 
       convention_lines = [
+        # REUSE-IgnoreStart
         "SPDX-License-Identifier: BSD-3-Clause-Clear",
+        # REUSE-IgnoreEnd
         "",
         "Auto-generated by riscv-unified-db (udb-gen #{command_name})",
         "Config: #{cfg_arch.name}",

data/lib/udb-gen/generators/inst_table/generator.rb

@@ -0,0 +1,81 @@
+# SPDX-License-Identifier: BSD-3-Clause-Clear
+# SPDX-FileCopyrightText: Copyright (c) Charlie Jenkins
+
+# typed: true
+# frozen_string_literal: true
+
+require "tty-exit"
+
+require_relative "../../common_opts"
+require_relative "../../defines"
+require_relative "../../template_helpers"
+require_relative "table_builder"
+
+require "udb/obj/extension"
+
+module UdbGen
+  class InstTableOptions < SubcommandWithCommonOptions
+    include TTY::Exit
+
+    NAME = "inst-table"
+
+    sig { void }
+    def initialize
+      super(name: NAME, desc: "Generate an instruction table")
+    end
+
+    usage \
+      command: NAME,
+      desc:   "Generate an instruction table for extensions defined in UDB",
+      example: <<~EXAMPLE
+        Generate an instruction table for all extensions, printed to stdout
+          $ #{File.basename($PROGRAM_NAME)} #{NAME}
+
+        Generate an instruction table for all extensions, written to a file
+          $ #{File.basename($PROGRAM_NAME)} #{NAME} -o inst_table.txt
+      EXAMPLE
+
+    option :output_file do
+      T.bind(self, TTY::Option::Parameter::Option)
+      short "-o"
+      long "--out=file"
+      desc "Output file (default: stdout)"
+      convert :path
+    end
+
+    sig { void }
+    def gen_inst_table
+      target_file = params[:output_file]
+      builder = InstTable::TableBuilder.new(cfg_arch, target_file&.basename&.to_s)
+
+      if target_file.nil?
+        $stdout.write(builder.generate)
+      else
+        File.write(target_file, builder.generate)
+      end
+    end
+
+    sig { override.params(argv: T::Array[String]).returns(T.noreturn) }
+    def run(argv)
+      parse(argv)
+
+      if params[:help]
+        print help
+        exit_with(:success)
+      end
+
+      if params.errors.any?
+        exit_with(:usage_error, "#{params.errors.summary}\n\n#{help}")
+      end
+
+      unless params.remaining.empty?
+        exit_with(:usage_error, "Unknown arguments: #{params.remaining}\n")
+      end
+
+      gen_inst_table
+
+      exit_with(:success)
+    end
+
+  end
+end

data/lib/udb-gen/generators/inst_table/table_builder.rb

@@ -0,0 +1,127 @@
+# SPDX-License-Identifier: BSD-3-Clause-Clear
+# SPDX-FileCopyrightText: Copyright (c) Charlie Jenkins
+
+# typed: false
+# frozen_string_literal: true
+
+require "pathname"
+require "fileutils"
+require "optparse"
+require "udb/resolver"
+
+module UdbGen
+  module InstTable
+    class TableBuilder
+      extend T::Sig
+
+      sig { params(arch: Udb::ConfiguredArchitecture, file_name: T.nilable(String)).void }
+      def initialize(arch, file_name)
+        @arch = arch
+        @file_name = file_name
+      end
+
+      def get_encoding(inst, base)
+        return [] unless inst.defined_in_base?(base)
+
+        fields = []
+
+        enc_obj = inst.encoding(base)
+        fixed = enc_obj.opcode_fields.map do |fo|
+          "#{fo.name}<#{fo.range.first}"
+        end
+
+        fields.append(fixed.join("|"))
+
+        dvs = inst.decode_variables(base)
+
+        dvs.each do |d|
+          field = "#{d.name}"
+
+          if d.sext?
+            field += "~"
+          end
+
+          unless d.excludes.empty?
+            field += "!#{d.excludes.join('!')}"
+          end
+
+          if d.left_shift > 0
+            field += "<#{d.left_shift}"
+          end
+
+          field += "=#{d.location}"
+
+          fields.append(field)
+        end
+
+        return fields
+      end
+
+      sig { returns(String) }
+      def generate
+        lines = []
+        @arch.instructions.each do |inst|
+          enc_32 = get_encoding(inst, 32)
+          enc_64 = get_encoding(inst, 64)
+
+          if enc_32.empty? && enc_64.empty?
+            puts "instruction #{inst.name} not supported by 32-bit or 64-bit"
+            next
+          end
+
+          # Same encoding for 32/64-bit
+          if (enc_32 == enc_64)
+            lines << ([inst.name, "common"] + enc_64).join(" ")
+            next
+          end
+
+          # There are some instructions that have different encodings on 32/64-bit
+          unless enc_32.empty? || enc_64.empty?
+            lines << ([inst.name, "common,32"] + enc_32).join(" ")
+            lines << ([inst.name, "common,64"] + enc_64).join(" ")
+            next
+          end
+
+          if enc_32.any?
+            lines << ([inst.name, "32"] + enc_32).join(" ")
+            next
+          end
+
+          if enc_64.any?
+            lines << ([inst.name, "64"] + enc_64).join(" ")
+            next
+          end
+        end
+
+        command = "./bin/generate inst-table"
+        command += " -o #{@file_name}" unless @file_name.nil?
+
+        header = <<EOM
+# SPDX-License-Identifier: BSD-3-Clause-Clear
+#
+# GENERATED WITH https://github.com/riscv-software-src/riscv-unified-db
+# "#{command}"
+#
+# Each line of the instruction table should have the following format:
+# NAME BASE FIXED_BITS [VARIABLE_LIST]
+# NAME                        instruction name
+# BASE                        instruction base size (common[,(32|64)])
+#                             "common" means the instruction is valid on both architecture sizes
+#                             "32" or "64" means the instruction is valid on that size
+#                             if the instruction is valid on both architectures but has unique
+#                             encodings, use a 32-bit entry "common,32" and 64-bit entry
+# FIXED_BITS                  bitfields of the fixed bits of an instruction concatenated with '|'
+#                             continuous grouping of fixed bits are in the form of 'bits<offset'
+# VARIABLE_LIST               a variable sized list of all variables in the instruction definition
+#                             in the form of name[~][<num][!num...]=(high[-low])|...
+#                             symbols after the name represent different modifiers:
+#                                 ~ sign extension, can only appear once
+#                                 < left shift by 'num' amount on extraction, can only appear once
+#                                 ! mark 'num' as an invalid input for this variable
+EOM
+
+        header + lines.join("\n") + "\n"
+      end
+    end
+  end
+end

data/lib/udb-gen/generators/isa_explorer/js_xlsx_writer.rb

@@ -74,7 +74,7 @@ module UdbGen
             urlPrefix = formatterParams.fetch(:urlPrefix)
             fp.write ", formatterParams:{\n"
             fp.write "      labelField:\"#{column_name}\",\n"
-            fp.write "      urlPrefix:\"#{urlPrefix}\"\n"
+            fp.write "      url: function(cell) { return \"#{urlPrefix}\" + cell.getValue().replace(/\\./g, \"_\"); }\n"
             fp.write "      }\n"
           end
           fp.write "    },\n"

data/lib/udb-gen/generators/isa_explorer/table_builder.rb

@@ -140,7 +140,7 @@ module UdbGen
           row = [
             inst.name,
             inst.long_name,
-            inst.name + " " + inst.assembly.gsub("x", "r")
+            inst.name + " " + inst.assembly
           ]
 
           sorted_releases.each do |pr|

data/lib/udb-gen/generators/manual/tasks.rake

@@ -6,6 +6,14 @@
 
 require "digest"
 
+def sanitized_inst_lookup
+  Rake.application.instance_variable_get(:@sanitized_inst_lookup) ||
+    Rake.application.instance_variable_set(
+      :@sanitized_inst_lookup,
+      Rake.application.cfg_arch.instructions.each_with_object({}) { |i, h| h[i.name.sanitize] = i }
+    )
+end
+
 def versions_from_env(versions)
   manual_name = "isa"
   output_hash = nil
@@ -184,11 +192,11 @@ rule %r{#{Rake.application.gen_dir}/.*/.*/antora/modules/insts/pages/.*.adoc} =>
   __FILE__,
   (UdbGen.root / "templates" / "manual" / "instruction.adoc.erb").to_s
 ] do |t|
-  inst_name = File.basename(t.name, ".adoc")
+  inst_sanitized_name = File.basename(t.name, ".adoc")
 
   cfg_arch = Rake.application.cfg_arch
-  inst = cfg_arch.instruction(inst_name)
-  raise "Can't find instruction '#{inst_name}'" if inst.nil?
+  inst = sanitized_inst_lookup[inst_sanitized_name]
+  raise "Can't find instruction with sanitized name '#{inst_sanitized_name}'" if inst.nil?
 
   inst_template_path = UdbGen.root / "templates" / "manual" / "instruction.adoc.erb"
   erb = ERB.new(inst_template_path.read, trim_mode: "-")
@@ -406,7 +414,7 @@ namespace :gen do
 
       Udb.logger.info "Generating Instructions"
       version_obj.instructions.each do |inst|
-        Rake::Task[antora_path / "modules" / "insts" / "pages" / "#{inst.name}.adoc"].invoke
+        Rake::Task[antora_path / "modules" / "insts" / "pages" / "#{inst.name.sanitize}.adoc"].invoke
       end
 
       Udb.logger.info "Generating Extensions"

data/lib/udb-gen/version.rb

@@ -5,5 +5,5 @@
 # frozen_string_literal: true
 
 module UdbGen
-  def self.version = "0.1.12"
+  def self.version = "0.1.13"
 end

data/templates/common/inst.adoc.erb

@@ -11,7 +11,7 @@ Synopsis::
 
 Mnemonic::
 ----
-<%= inst.name %> <%= inst.assembly.gsub('x', 'r') %>
+<%= inst.name %> <%= inst.assembly %>
 ----
 
 Encoding::

data/templates/ext_doc/_instruction_list.adoc.erb

@@ -27,7 +27,7 @@ The following <%= insts.size %> instructions must be implemented when <%= ext_re
 <%-     insts.each do |i| -%>
 | <%= i.rv32? ? "&#x2713;" : "" %>
 | <%= i.rv64? ? "&#x2713;" : "" %>
-| `<%= [i.name, i.assembly.gsub("x", "r").strip].join(" ").strip %>`
+| `<%= [i.name, i.assembly.strip].join(" ").strip %>`
 | <%= link_to(i, i.long_name) %>
 <%-       if versions.size > 1 -%>
 | <%= versions.map { |v| (-i.defined_by_condition & v.to_condition_exclusive).unsatisfiable_by_arch?(cfg_arch) ? "&#x2713;" : "" }.join(" | ") %>
@@ -55,7 +55,7 @@ of this extension.
 ^ Mnemonic ^ Instruction ^ Defined by
 
 <%-       implied_insts.sort.each do |i| -%>
-^ `<%= [i.name, i.assembly.gsub("x", "r").strip].join(" ").strip %>`
+^ `<%= [i.name, i.assembly.strip].join(" ").strip %>`
 ^ <%= link_to(i, i.long_name) %>
 a^ <%= i.defined_by_condition.to_asciidoc %>
 <%-       end -%>

data/templates/manual/instruction.adoc.erb

@@ -17,7 +17,7 @@ This instruction must have data-independent timing when extension `Zkt` is enabl
 
 == Assembly format
 
-`<%= inst.name %> <%= inst.assembly.gsub('x', 'r') %>`
+`<%= inst.name %> <%= inst.assembly %>`
 
 == Decode Variables
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: udb-gen
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.13
 platform: ruby
 authors:
 - Derek Hower
 bindir: bin
 cert_chain: []
-date: 2026-05-19 00:00:00.000000000 Z
+date: 2026-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -141,14 +141,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.13
+        version: 0.1.14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.13
+        version: 0.1.14
 - !ruby/object:Gem::Dependency
   name: write_xlsx
   requirement: !ruby/object:Gem::Requirement
@@ -163,6 +163,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
@@ -212,6 +226,8 @@ files:
 - lib/udb-gen/generators/cfg_svh_header/generator.rb
 - lib/udb-gen/generators/ext_doc/generator.rb
 - lib/udb-gen/generators/ext_doc/helpers.rb
+- lib/udb-gen/generators/inst_table/generator.rb
+- lib/udb-gen/generators/inst_table/table_builder.rb
 - lib/udb-gen/generators/isa_explorer/generator.rb
 - lib/udb-gen/generators/isa_explorer/js_xlsx_writer.rb
 - lib/udb-gen/generators/isa_explorer/table_builder.rb