udb-gen 0.1.7 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47ff086404150fb7e0031816bc827970c615792d60f1796cc55e36730fd9c6f2
-  data.tar.gz: d257dfaa46302aed705df67c53db0602092b3e9dcc350a87a747e6b56d63dc35
+  metadata.gz: 3f2e3db34409108c4ac83f95a778d24936d06b3d5124ab6138af60020e94c740
+  data.tar.gz: f8274018357279d3aa28bfe47a7e77137f29d1238b73336ea8048575b23298d3
 SHA512:
-  metadata.gz: 7b3e6888280edb39c4a05862768126db2e339dd795e89729c5da8692c7347b1f3af092211190b7dfaa026fa964b3fa9f041e6414e8ad8d5751708811aa95dcbb
-  data.tar.gz: 142bb18d41aa582ddafc3265649b6d7da6cef6d5c99ffa478c08d2281ea865362f624bcfcd186bb042dbbfc07b2e582f0491a77c51b43cbc94b77e901ae6a1d7
+  metadata.gz: 11d8d5b8a08aa3aa2490c0998ec033538643680b266267f0b1265ea0fac15605e01e0ce8b72e1000fd4eb161e47a6f245f986b5f2170064a665c326c592b7b2b
+  data.tar.gz: 2fec5ed54797ae271ce320c31b20b549f559477cf72d9335cc6d9fdd6ea955b12b1a16f3f9717beee13ccdde5b433e2995c6e64fdeecadc0473a78eb93f3fa23

data/lib/udb-gen/cfg_header_base.rb

@@ -0,0 +1,208 @@
+# Copyright (c) Jordan Carlin, Harvey Mudd College.
+# SPDX-License-Identifier: BSD-3-Clause-Clear
+
+# typed: true
+# frozen_string_literal: true
+
+require "fileutils"
+require "pathname"
+require "sorbet-runtime"
+require "tty-exit"
+require "udb/cfg_arch"
+
+module UdbGen
+  # Shared logic for generating config header files across languages (C, SystemVerilog, etc.).
+  # Including classes must include TTY::Exit, inherit from SubcommandWithCommonOptions,
+  # and include this module; SubcommandWithCommonOptions provides cfg_arch, params,
+  # parse, help, and exit_with.
+  module CfgHeaderBase
+    extend T::Sig
+    extend T::Helpers
+
+    abstract!
+
+    sig { abstract.returns(Udb::ConfiguredArchitecture) }
+    def cfg_arch; end
+
+    sig { abstract.returns(T.untyped) }
+    def params; end
+
+    sig { abstract.params(argv: T::Array[String]).returns(T.untyped) }
+    def parse(argv); end
+
+    sig { abstract.returns(String) }
+    def help; end
+
+    sig { abstract.params(exit_code: Symbol, message: T.nilable(String)).returns(T.noreturn) }
+    def exit_with(exit_code, message = nil); end
+
+    sig { abstract.returns(String) }
+    def command_name; end
+
+    # The preprocessor define directive, e.g. "#define" or "`define"
+    sig { abstract.returns(String) }
+    def define_directive; end
+
+    # The begin-guard line, e.g. "#ifndef NAME" or "`ifndef NAME"
+    sig { abstract.params(guard_name: String).returns(String) }
+    def guard_begin(guard_name); end
+
+    # The end-guard line, e.g. "#endif /* NAME */" or "`endif // NAME"
+    sig { abstract.params(guard_name: String).returns(String) }
+    def guard_end(guard_name); end
+
+    # Guard name suffix, e.g. "_H" or "_SVH"
+    sig { abstract.returns(String) }
+    def guard_suffix; end
+
+    # A section comment line, e.g. "/* text */" or "// text"
+    sig { abstract.params(text: String).returns(String) }
+    def section_comment(text); end
+
+    # Multi-line file header comment block
+    sig { abstract.params(text_lines: T::Array[String]).returns(T::Array[String]) }
+    def header_comment(text_lines); end
+
+    # Human-readable file type for log messages, e.g. "C header" or "SystemVerilog header"
+    sig { abstract.returns(String) }
+    def file_type_name; end
+
+    # Format an integer value as a language-appropriate literal
+    sig { abstract.params(value: Integer).returns(String) }
+    def format_integer(value); end
+
+    sig { returns(String) }
+    def generate_header
+      unless cfg_arch.fully_configured?
+        exit_with(:data_err, "Config '#{cfg_arch.name}' is not fully configured. Only fully configured configs are supported.\n")
+      end
+
+      lines = []
+      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}",
+        "",
+        "Define conventions:",
+        "  Extensions:           #{define_directive} NAME_SUPPORTED and #{define_directive} NAMEverPver_SUPPORTED",
+        "  Boolean params:       #{define_directive} UDB_NAME           (present when true, absent when false)",
+        "  Integer params:       #{define_directive} UDB_NAME value     and #{define_directive} UDB_NAME_<value>",
+        "  Enum (string) params: #{define_directive} UDB_NAME_VALUE     (value sanitized to uppercase identifier)",
+        "  Boolean arrays:       #{define_directive} UDB_NAME_<index>   (one per true element)",
+        "  Integer arrays:       #{define_directive} UDB_NAME_<value>   (one per unique element, sorted)",
+        "  String arrays:        #{define_directive} UDB_NAME_<VALUE>   (one per unique element, sanitized)"
+      ]
+
+      lines.concat(header_comment(convention_lines))
+      lines << ""
+      lines << guard_begin(guard_name)
+      lines << "#{define_directive} #{guard_name}"
+
+      lines << ""
+      lines << section_comment("Implemented extensions")
+      emit_extension_defines(lines)
+
+      lines << ""
+      lines << section_comment("Configuration parameters")
+      emit_param_defines(lines)
+
+      lines << ""
+      lines << guard_end(guard_name)
+      lines << ""
+
+      lines.join("\n")
+    end
+
+    sig { params(argv: T::Array[String]).returns(T.noreturn) }
+    def run_generator(argv)
+      parse(argv)
+
+      if params[:help]
+        Kernel.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
+
+      header = generate_header
+
+      if params[:output].nil?
+        $stdout.write(header)
+      else
+        FileUtils.mkdir_p(params[:output].dirname)
+        File.write(params[:output], header)
+        Udb.logger.info "Generated #{file_type_name}: #{params[:output]}"
+      end
+
+      exit_with(:success)
+    end
+
+    private
+
+    sig { params(str: String).returns(String) }
+    def sanitize_to_identifier(str)
+      str.upcase.gsub(/[^A-Z0-9]/, "_").gsub(/_+/, "_").gsub(/\A_|_\z/, "")
+    end
+
+    sig { params(lines: T::Array[String]).void }
+    def emit_extension_defines(lines)
+      ext_versions = cfg_arch.implemented_extension_versions.sort_by { |ev| ev.name.upcase }
+      ext_versions.each do |ext_ver|
+        lines << "#{define_directive} #{ext_ver.name.upcase}_SUPPORTED"
+        versioned_name = "#{ext_ver.name.upcase}#{ext_ver.version_spec.to_rvi_s.upcase}"
+        lines << "#{define_directive} #{versioned_name}_SUPPORTED"
+      end
+    end
+
+    sig { params(lines: T::Array[String]).void }
+    def emit_param_defines(lines)
+      pv = cfg_arch.param_values
+      return if pv.empty?
+
+      pv.sort_by { |k, _| k }.each do |name, value|
+        prefixed = "UDB_#{name}"
+        case value
+        when true
+          lines << "#{define_directive} #{prefixed}"
+        when false
+          next
+        when Integer
+          lines << "#{define_directive} #{prefixed} #{format_integer(value)}"
+          lines << "#{define_directive} #{prefixed}_#{value}"
+        when String
+          lines << "#{define_directive} #{prefixed}_#{sanitize_to_identifier(value)}"
+        when Array
+          emit_array_param(lines, prefixed, value)
+        end
+      end
+    end
+
+    sig { params(lines: T::Array[String], name: String, value: T::Array[T.untyped]).void }
+    def emit_array_param(lines, name, value)
+      if value.all? { |v| v == true || v == false }
+        value.each_with_index do |v, i|
+          lines << "#{define_directive} #{name}_#{i}" if v
+        end
+      elsif value.all? { |v| v.is_a?(Integer) }
+        value.uniq.sort.each do |v|
+          lines << "#{define_directive} #{name}_#{v}"
+        end
+      elsif value.all? { |v| v.is_a?(String) }
+        value.map { |v| sanitize_to_identifier(v) }.uniq.sort.each do |sanitized|
+          lines << "#{define_directive} #{name}_#{sanitized}"
+        end
+      end
+    end
+  end
+end

data/lib/udb-gen/common_opts.rb

@@ -4,6 +4,7 @@
 # typed: true
 # frozen_string_literal: true
 
+require "pathname"
 require "sorbet-runtime"
 
 require_relative "subcommand"
@@ -40,7 +41,20 @@ module UdbGen
     sig { returns(Udb::ConfiguredArchitecture) }
     def cfg_arch
       @cfg_arch ||=
-        resolver.cfg_arch_for(params[:cfg])
+        resolver.cfg_arch_for(resolve_cfg_arg(params[:cfg]))
+    end
+
+    # Accept either a known config name (looked up under @cfgs_path) or a
+    # filesystem path to a config YAML. Path-like arguments (containing a
+    # path separator or ending in .yaml/.yml, or actually existing on disk)
+    # are converted to Pathname so the resolver treats them as paths.
+    sig { params(arg: String).returns(T.any(String, Pathname)) }
+    def resolve_cfg_arg(arg)
+      return Pathname.new(arg) if arg.include?(File::SEPARATOR) ||
+                                  arg.end_with?(".yaml", ".yml") ||
+                                  File.file?(arg)
+
+      arg
     end
 
     sig { override.params(argv: T::Array[String]).returns(T.noreturn) }

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

@@ -0,0 +1,87 @@
+# Copyright (c) Jordan Carlin, Harvey Mudd College.
+# SPDX-License-Identifier: BSD-3-Clause-Clear
+
+# typed: true
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+require "tty-exit"
+
+require_relative "../../common_opts"
+require_relative "../../defines"
+require_relative "../../cfg_header_base"
+
+module UdbGen
+  class GenCfgCHeaderOptions < SubcommandWithCommonOptions
+    include TTY::Exit
+    include CfgHeaderBase
+
+    NAME = "cfg-c-header"
+
+    sig { void }
+    def initialize
+      super(name: NAME, desc: "Generate a C header with #defines from a fully configured UDB config")
+    end
+
+    usage \
+      command: NAME,
+      desc: "Generate a C header file with #define directives derived from a fully configured UDB YAML config",
+      example: <<~EXAMPLE
+        Generate a C header for the rv64 config, printed to stdout
+          $ #{File.basename($PROGRAM_NAME)} #{NAME} -c rv64
+
+        Generate a C header for the rv64 config, written to a file
+          $ #{File.basename($PROGRAM_NAME)} #{NAME} -c rv64 -o config.h
+
+        Generate a C header for a custom config file
+          $ #{File.basename($PROGRAM_NAME)} #{NAME} -c /path/to/my_config.yaml
+      EXAMPLE
+
+    option :output do
+      T.bind(self, TTY::Option::Parameter::Option)
+      short "-o"
+      long "--output=file"
+      desc "Output file path (default: stdout)"
+      convert :path
+    end
+
+    sig { override.returns(String) }
+    def define_directive = "#define"
+
+    sig { override.returns(String) }
+    def command_name = NAME
+
+    sig { override.params(guard_name: String).returns(String) }
+    def guard_begin(guard_name) = "#ifndef #{guard_name}"
+
+    sig { override.params(guard_name: String).returns(String) }
+    def guard_end(guard_name) = "#endif /* #{guard_name} */"
+
+    sig { override.returns(String) }
+    def guard_suffix = "_H"
+
+    sig { override.params(text: String).returns(String) }
+    def section_comment(text) = "/* #{text} */"
+
+    sig { override.params(text_lines: T::Array[String]).returns(T::Array[String]) }
+    def header_comment(text_lines)
+      lines = ["/*"]
+      text_lines.each do |line|
+        lines << (line.empty? ? " *" : " * #{line}")
+      end
+      lines << " */"
+      lines
+    end
+
+    sig { override.returns(String) }
+    def file_type_name = "C header"
+
+    sig { override.params(value: Integer).returns(String) }
+    def format_integer(value) = value.to_s
+
+    sig { override.params(argv: T::Array[String]).returns(T.noreturn) }
+    def run(argv)
+      run_generator(argv)
+    end
+  end
+end

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

@@ -0,0 +1,87 @@
+# Copyright (c) Jordan Carlin, Harvey Mudd College.
+# SPDX-License-Identifier: BSD-3-Clause-Clear
+
+# typed: true
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+require "tty-exit"
+
+require_relative "../../common_opts"
+require_relative "../../defines"
+require_relative "../../cfg_header_base"
+
+module UdbGen
+  class GenCfgSvhHeaderOptions < SubcommandWithCommonOptions
+    include TTY::Exit
+    include CfgHeaderBase
+
+    NAME = "cfg-svh-header"
+
+    sig { void }
+    def initialize
+      super(name: NAME, desc: "Generate a SystemVerilog header with `define directives from a fully configured UDB config")
+    end
+
+    usage \
+      command: NAME,
+      desc: "Generate a SystemVerilog header file with `define directives derived from a fully configured UDB YAML config",
+      example: <<~EXAMPLE
+        Generate a SystemVerilog header for the rv64 config, printed to stdout
+          $ #{File.basename($PROGRAM_NAME)} #{NAME} -c rv64
+
+        Generate a SystemVerilog header for the rv64 config, written to a file
+          $ #{File.basename($PROGRAM_NAME)} #{NAME} -c rv64 -o config.svh
+
+        Generate a SystemVerilog header for a custom config file
+          $ #{File.basename($PROGRAM_NAME)} #{NAME} -c /path/to/my_config.yaml
+      EXAMPLE
+
+    option :output do
+      T.bind(self, TTY::Option::Parameter::Option)
+      short "-o"
+      long "--output=file"
+      desc "Output file path (default: stdout)"
+      convert :path
+    end
+
+    sig { override.returns(String) }
+    def define_directive = "`define"
+
+    sig { override.returns(String) }
+    def command_name = NAME
+
+    sig { override.params(guard_name: String).returns(String) }
+    def guard_begin(guard_name) = "`ifndef #{guard_name}"
+
+    sig { override.params(guard_name: String).returns(String) }
+    def guard_end(guard_name) = "`endif // #{guard_name}"
+
+    sig { override.returns(String) }
+    def guard_suffix = "_SVH"
+
+    sig { override.params(text: String).returns(String) }
+    def section_comment(text) = "// #{text}"
+
+    sig { override.params(text_lines: T::Array[String]).returns(T::Array[String]) }
+    def header_comment(text_lines)
+      text_lines.map { |line| line.empty? ? "//" : "// #{line}" }
+    end
+
+    sig { override.returns(String) }
+    def file_type_name = "SystemVerilog header"
+
+    # Emit sized hex literals so large unsigned values are not misinterpreted
+    sig { override.params(value: Integer).returns(String) }
+    def format_integer(value)
+      bits = [32, value.bit_length].max
+      width = ((bits + 31) / 32) * 32
+      "#{width}'h#{value.to_s(16).upcase}"
+    end
+
+    sig { override.params(argv: T::Array[String]).returns(T.noreturn) }
+    def run(argv)
+      run_generator(argv)
+    end
+  end
+end

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

@@ -142,7 +142,7 @@ module UdbGen
           when nil
             ">=0"
           when "latest"
-            "=#{ext.versions.max}"
+            "=#{T.must(ext).versions.max}"
           else
             "=#{req}"
           end
@@ -181,7 +181,7 @@ module UdbGen
         "-a imagesdir=#{params[:images]}",
         "-r asciidoctor-diagram",
         "-r idl_highlighter",
-        "-a wavedrom=/opt/node/node_modules/.bin/wavedrom-cli",
+        "-a wavedrom=#{Udb.repo_root}/node_modules/.bin/wavedrom-cli",
         "-o #{pdf_filename}",
         adoc_filename
       ].join(" ")

data/lib/udb-gen/generators/ext_doc/helpers.rb

@@ -15,7 +15,7 @@ module UdbGen
     # Uses ratification_date year if available, otherwise current year.
     sig { params(version: Udb::ExtensionVersion).returns(String) }
     def copyright_year(version)
-      version.ratification_date.nil? ? Date.today.year.to_s : T.must(version.ratification_date).split("-")[0]
+      version.ratification_date.nil? ? Date.today.year.to_s : T.must(T.must(version.ratification_date).split("-")[0])
     end
 
     # Returns the revdate for a version: release date (for nonstandard-released),
@@ -23,9 +23,9 @@ module UdbGen
     sig { params(version: Udb::ExtensionVersion).returns(T.any(String, Date)) }
     def revdate(version)
       if version.state == "nonstandard-released"
-        version.release_date.nil? ? Date.today : version.release_date
+        version.release_date.nil? ? Date.today : T.must(version.release_date)
       elsif version.state == "ratified"
-        version.ratification_date.nil? ? Date.today : version.ratification_date
+        version.ratification_date.nil? ? Date.today : T.must(version.ratification_date)
       else
         Date.today
       end

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

@@ -82,10 +82,11 @@ module UdbGen
             ext.conflicting_extensions.map(&:name),
             ext.ratified,
             if ext.ratified
-              if ext.min_ratified_version.ratification_date.nil? || ext.min_ratified_version.ratification_date.empty?
+              rat_date = T.must(ext.min_ratified_version).ratification_date
+              if rat_date.nil? || rat_date.empty?
                 "UDB MISSING"
               else
-                ext.min_ratified_version.ratification_date
+                rat_date
               end
             else
               ""
@@ -139,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"
@@ -457,7 +465,7 @@ namespace :gen do
     end
 
     sh [
-      "/opt/node/node_modules/.bin/antora",
+      "#{Udb.repo_root}/node_modules/.bin/antora",
       "--stacktrace",
       "generate",
       "--cache-dir=#{Udb.repo_root}/.home/.antora",

data/lib/udb-gen/template_helpers.rb

@@ -27,7 +27,7 @@ module UdbGen
       erb.result(context.instance_eval { binding })
     end
 
-    LinkableObj = T.type_alias { T.any(Udb::Instruction, Udb::Csr, Udb::CsrField, Udb::Extension, Idl::FunctionDefAst) }
+    LinkableObj = T.type_alias { T.any(Udb::Instruction, Udb::Csr, Udb::CsrField, Udb::Extension, Udb::Parameter, Idl::FunctionDefAst) }
 
     # return an asciidoc link to obj, with text "text"
     sig { params(obj: LinkableObj, text: String).returns(String) }
@@ -56,6 +56,8 @@ module UdbGen
         "udb-extension-#{obj.name.gsub(".", "_")}"
       when Udb::Instruction
         "udb-insn-#{obj.name.gsub(".", "_")}"
+      when Udb::Parameter
+        "udb-param-#{obj.name.gsub(".", "_")}"
       else
         T.absurd(obj)
       end
@@ -64,17 +66,17 @@ module UdbGen
     sig { params(cfg_arch: Udb::ConfiguredArchitecture, adoc: String).returns(String) }
     def convert_monospace_to_links(cfg_arch, adoc)
       adoc.gsub(/`([\w.]+)`/) do |match|
-        name = Regexp.last_match(1)
-        csr_name, field_name = T.must(name).split(".")
+        name = T.must(Regexp.last_match(1))
+        csr_name, field_name = name.split(".")
         csr = cfg_arch.not_prohibited_csrs.find { |c| c.name == csr_name }
         if !field_name.nil? && !csr.nil? && csr.field?(field_name)
           link_to(csr.field(field_name), match)
         elsif !csr.nil?
           link_to(csr, match)
         elsif cfg_arch.not_prohibited_instructions.any? { |inst| inst.name == name }
-          link_to(cfg_arch.instruction(name), match)
+          link_to(T.must(cfg_arch.instruction(name)), match)
         elsif cfg_arch.not_prohibited_extensions.any? { |ext| ext.name == name }
-          link_to(cfg_arch.extension(name), match)
+          link_to(T.must(cfg_arch.extension(name)), match)
         else
           match
         end
@@ -92,7 +94,7 @@ module UdbGen
         when "ext"
           ext = cfg_arch.extension(name)
           if ext
-            link_to(cfg_arch.extension(name), link_text)
+            link_to(ext, link_text)
           else
             Udb.logger.warn "Attempted link to undefined extension: #{name}"
             match
@@ -116,14 +118,14 @@ module UdbGen
         when "csr"
           csr = cfg_arch.csr(name)
           if csr
-            link_to(cfg_arch.csr(name), link_text)
+            link_to(csr, link_text)
           else
             Udb.logger.warn "Attempted link to undefined CSR: #{name}"
             match
           end
         when "csr_field"
           csr_name, field_name = name.split("*")
-          csr = cfg_arch.csr(csr_name)
+          csr = cfg_arch.csr(T.must(csr_name))
           if csr
             csr_field = csr.field(field_name)
             if csr_field

data/lib/udb-gen/version.rb

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

data/templates/common/csr.adoc.erb

@@ -36,7 +36,7 @@ h^ Privilege Mode ^ <%= csr.priv_mode %>
 .<%= csr.name %> format
 [wavedrom, ,svg,subs='attributes',width="100%"]
 ....
-<%= JSON.dump csr.wavedrom_desc(cfg_arch, 64) %>
+<%= JSON.dump csr.wavedrom_desc(cfg_arch, csr.base || 64) %>
 ....
 <%- else -%>
 <%# CSR has a dynamic length, or a field has a dynamic location,

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
 

data/templates/manual/playbook.yml.erb

@@ -29,9 +29,9 @@ ui:
     snapshot: true
   supplemental_files:
   - path: css/vendor/tabs.css
-    contents: /opt/node/node_modules/@asciidoctor/tabs/dist/css/tabs.css
+    contents: <%= Udb.repo_root %>/node_modules/@asciidoctor/tabs/dist/css/tabs.css
   - path: js/vendor/tabs.js
-    contents: /opt/node/node_modules/@asciidoctor/tabs/dist/js/tabs.js
+    contents: <%= Udb.repo_root %>/node_modules/@asciidoctor/tabs/dist/js/tabs.js
   - path: partials/footer-scripts.hbs
     contents: |
       <script id="site-script" src="{{{uiRootPath}}}/js/site.js" data-ui-root-path="{{{uiRootPath}}}"></script>

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: udb-gen
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.13
 platform: ruby
 authors:
 - Derek Hower
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-11 00:00:00.000000000 Z
+date: 2026-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -138,6 +137,20 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: udb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.14
+- !ruby/object:Gem::Dependency
+  name: write_xlsx
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,13 +164,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: write_xlsx
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -206,10 +219,15 @@ files:
 - bin/udb-gen
 - lib/udb-gen.rb
 - lib/udb-gen/adoc_helpers.rb
+- lib/udb-gen/cfg_header_base.rb
 - lib/udb-gen/common_opts.rb
 - lib/udb-gen/defines.rb
+- lib/udb-gen/generators/cfg_c_header/generator.rb
+- 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
@@ -248,7 +266,6 @@ metadata:
   homepage_uri: https://github.com/riscv/riscv-unified-db
   mailing_list_uri: https://lists.riscv.org/g/tech-unifieddb
   bug_tracker_uri: https://github.com/riscv/riscv-unified-db/issues
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -263,8 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Command line interface for UDB-based generators
 test_files: []