fix: avoid Sorbet errors and improve consistency of database to avoid nil (#722)

james-ball-qualcomm · web-flow · commit 00f1540ddcf2 · 2025-05-05T15:03:17.000Z
Fixes #716
diff --git a/.sorbet-config b/.sorbet-config
@@ -1,10 +1,8 @@
 --dir
-lib
---dir
-sorbet/rbi
---file
-Rakefile
---file
-backends/ext_pdf_doc/idl_lexer.rb
---file
-backends/cpp_hart_gen/lib/template_helpers.rb
+.
+--ignore
+ext
+--ignore
+.home/.gems
+--ignore
+node_modules
diff --git a/arch/manual/isa.yaml b/arch/manual/isa.yaml
@@ -3,6 +3,7 @@
 $schema: manual_schema.json#
 kind: manual
 name: isa
+long_name: Entire RISC-V ISA
 marketing_name: RISC-V ISA Manual
 url: https://github.com/riscv/riscv-isa-manual
 license:
diff --git a/arch/manual_version/isa/20240411/isa_20240411.yaml b/arch/manual_version/isa/20240411/isa_20240411.yaml
@@ -5,6 +5,7 @@ kind: manual version
 manual: { $ref: manual/isa.yaml# }
 version: "4.0.0-pre"
 name: "isa_20240411"
+long_name: "Release 20240411 of the RISC-V ISA Manuals"
 marketing_version: "20240411"
 state: "development"
 url: https://github.com/riscv/releases/tag/20240411
diff --git a/arch/profile/MP-S-64.yaml b/arch/profile/MP-S-64.yaml
@@ -3,6 +3,7 @@
 $schema: profile_schema.json#
 kind: profile
 name: MP-S-64
+long_name: S-mode extensions for a Mock 64-bit Apps Processor profile
 marketing_name: MockProfile 64-bit S-mode
 description: This is the Mock Profile Supervisor Mode description.
 mode: S
diff --git a/arch/profile/MP-U-64.yaml b/arch/profile/MP-U-64.yaml
@@ -1,6 +1,7 @@
 $schema: profile_schema.json#
 kind: profile
 name: MP-U-64
+long_name: U-mode extensions for a Mock 64-bit Apps Processor profile
 marketing_name: MockProfile 64-bit Unpriv
 mode: Unpriv
 base: 64
diff --git a/arch/profile/RVA20S64.yaml b/arch/profile/RVA20S64.yaml
@@ -1,6 +1,7 @@
 $schema: profile_schema.json#
 kind: profile
 name: RVA20S64
+long_name: S-mode extensions for version 20 of the 64-bit Apps Processor profile
 marketing_name: RVA20S64
 mode: S
 base: 64
diff --git a/arch/profile/RVA20U64.yaml b/arch/profile/RVA20U64.yaml
@@ -1,6 +1,7 @@
 $schema: profile_schema.json#
 kind: profile
 name: RVA20U64
+long_name: U-mode extensions for version 20 of the 64-bit Apps Processor profile
 marketing_name: RVA20U64
 mode: Unpriv
 base: 64
diff --git a/arch/profile/RVA22S64.yaml b/arch/profile/RVA22S64.yaml
@@ -1,6 +1,7 @@
 $schema: profile_schema.json#
 kind: profile
 name: RVA22S64
+long_name: S-mode extensions for version 22 of the 64-bit Apps Processor profile
 marketing_name: RVA22S64
 mode: S
 base: 64
diff --git a/arch/profile/RVA22U64.yaml b/arch/profile/RVA22U64.yaml
@@ -1,6 +1,7 @@
 $schema: profile_schema.json#
 kind: profile
 name: RVA22U64
+long_name: U-mode extensions for version 22 of the 64-bit Apps Processor profile
 marketing_name: RVA22U64
 mode: Unpriv
 base: 64
diff --git a/arch/profile/RVA23M64.yaml b/arch/profile/RVA23M64.yaml
@@ -1,6 +1,7 @@
 $schema: profile_schema.json#
 kind: profile
 name: RVA23M64
+long_name: M-mode extensions for version 23 of the 64-bit Apps Processor profile (not ratified)
 marketing_name: RVA23M64
 mode: M
 base: 64
diff --git a/arch/profile/RVA23S64.yaml b/arch/profile/RVA23S64.yaml
@@ -1,6 +1,7 @@
 $schema: profile_schema.json#
 kind: profile
 name: RVA23S64
+long_name: S-mode extensions for version 23 of the 64-bit Apps Processor profile
 marketing_name: RVA23S64
 mode: S
 base: 64
diff --git a/arch/profile/RVA23U64.yaml b/arch/profile/RVA23U64.yaml
@@ -1,6 +1,7 @@
 $schema: profile_schema.json#
 kind: profile
 name: RVA23U64
+long_name: U-mode extensions for version 23 of the 64-bit Apps Processor profile
 marketing_name: RVA23U64
 mode: Unpriv
 base: 64
diff --git a/arch/profile/RVB23M64.yaml b/arch/profile/RVB23M64.yaml
@@ -1,6 +1,7 @@
 $schema: profile_schema.json#
 kind: profile
 name: RVB23M64
+long_name: M-mode extensions for version 23 of the 64-bit Bespoke Apps Processor profile (not ratified)
 marketing_name: RVB23M64
 mode: M
 base: 64
diff --git a/arch/profile/RVB23S64.yaml b/arch/profile/RVB23S64.yaml
@@ -1,6 +1,7 @@
 $schema: profile_schema.json#
 kind: profile
 name: RVB23S64
+long_name: S-mode extensions for version 23 of the 64-bit Bespoke Apps Processor profile
 marketing_name: RVB23S64
 mode: S
 base: 64
diff --git a/arch/profile/RVB23U64.yaml b/arch/profile/RVB23U64.yaml
@@ -1,6 +1,7 @@
 $schema: profile_schema.json#
 kind: profile
 name: RVB23U64
+long_name: U-mode extensions for version 23 of the 64-bit Bespoke Apps Processor profile
 marketing_name: RVB23U64
 mode: Unpriv
 base: 64
diff --git a/arch/profile/RVI20U32.yaml b/arch/profile/RVI20U32.yaml
@@ -1,6 +1,7 @@
 $schema: profile_schema.json#
 kind: profile
 name: RVI20U32
+long_name: U-mode extensions for version 20 of a 32-bit processor
 marketing_name: RVI20U32
 mode: Unpriv
 base: 32
diff --git a/arch/profile/RVI20U64.yaml b/arch/profile/RVI20U64.yaml
@@ -1,6 +1,7 @@
 $schema: profile_schema.json#
 kind: profile
 name: RVI20U64
+long_name: U-mode extensions for version 20 of a 64-bit processor
 $inherits: "profile/RVI20U32.yaml#"
 base: 64
 marketing_name: RVI20U64
diff --git a/arch/profile_class/Mock.yaml b/arch/profile_class/Mock.yaml
@@ -2,6 +2,7 @@ $schema: profile_class_schema.json#
 kind: profile class
 processor_kind: Microcontroller
 name: Mock
+long_name: Mock Profile Class
 marketing_name: Mock Profile Class
 introduction: Here's the Mock Profile Class introduction.
 description: |
diff --git a/arch/profile_class/RVA.yaml b/arch/profile_class/RVA.yaml
@@ -4,6 +4,7 @@ $schema: profile_class_schema.json#
 kind: profile class
 processor_kind: Apps Processor
 name: RVA
+long_name: Apps Processor profile class for Rich Operating Systems requiring binary-compatibility
 marketing_name: RVA
 introduction: |
   The RVA profile class targets application processors for markets
diff --git a/arch/profile_class/RVB.yaml b/arch/profile_class/RVB.yaml
@@ -2,6 +2,7 @@ $schema: profile_class_schema.json#
 kind: profile class
 processor_kind: Apps Processor
 name: RVB
+long_name: Apps Processor profile class for Bespoke Rich Operating System
 marketing_name: RVB
 introduction: |
   The RVB profile class targets application processors for markets
diff --git a/arch/profile_class/RVI.yaml b/arch/profile_class/RVI.yaml
@@ -2,6 +2,7 @@ $schema: profile_class_schema.json#
 kind: profile class
 processor_kind: Generic Unprivileged
 name: RVI
+long_name: Unprivileged nstructions
 marketing_name: RVI
 introduction: The RVI profile class documents the initial set of unprivileged instructions.
 description: |
diff --git a/arch/profile_release/Mock.yaml b/arch/profile_release/Mock.yaml
@@ -1,6 +1,7 @@
 $schema: profile_release_schema.json#
 kind: profile release
 name: Mock
+long_name: Mock
 marketing_name: Mock Profile Release Marketing Name
 class:
   $ref: profile_class/Mock.yaml#
diff --git a/arch/profile_release/RVA20.yaml b/arch/profile_release/RVA20.yaml
@@ -1,6 +1,7 @@
 $schema: profile_release_schema.json#
 kind: profile release
 name: RVA20
+long_name: RVA20
 marketing_name: RVA20
 class:
   $ref: profile_class/RVA.yaml#
diff --git a/arch/profile_release/RVA22.yaml b/arch/profile_release/RVA22.yaml
@@ -1,6 +1,7 @@
 $schema: profile_release_schema.json#
 kind: profile release
 name: RVA22
+long_name: RVA22
 marketing_name: RVA22
 class:
   $ref: profile_class/RVA.yaml#
diff --git a/arch/profile_release/RVA23.yaml b/arch/profile_release/RVA23.yaml
@@ -1,6 +1,7 @@
 $schema: profile_release_schema.json#
 kind: profile release
 name: RVA23
+long_name: RVA23
 marketing_name: RVA23
 class:
   $ref: profile_class/RVA.yaml#
diff --git a/arch/profile_release/RVB23.yaml b/arch/profile_release/RVB23.yaml
@@ -1,6 +1,7 @@
 $schema: profile_release_schema.json#
 kind: profile release
 name: RVB23
+long_name: RVB23
 marketing_name: RVB23
 class:
   $ref: profile_class/RVB.yaml#
diff --git a/arch/profile_release/RVI20.yaml b/arch/profile_release/RVI20.yaml
@@ -1,6 +1,7 @@
 $schema: profile_release_schema.json#
 kind: profile release
 name: RVI20
+long_name: RVI20
 marketing_name: RVI20
 class:
   $ref: profile_class/RVI.yaml#
@@ -21,3 +22,5 @@ contributors:
 profiles:
   - { $ref: profile/RVI20U32.yaml# }
   - { $ref: profile/RVI20U64.yaml# }
+description: |
+  This profile release defines the RISC-V base ISA unprivileged instructions.
diff --git a/lib/arch_obj_models/cert_test_procedure.rb b/lib/arch_obj_models/cert_test_procedure.rb
@@ -1,28 +1,43 @@
 # frozen_string_literal: true
+# typed: true
+
+require "sorbet-runtime"
 
 class CertTestProcedure
+  extend T::Sig
+
+  # @return [String] Unique ID of the test procedure
+  sig { returns(String) }
+  attr_reader :id
+
+  # Description of test procedure (could be multiple lines).
+  sig { returns(String) }
+  attr_reader :description
+
+  # What kind of database object is this?
+  sig { returns(String) }
+  attr_reader :kind
+
+  # Name of test file that implements this test procedure. Could be nil.
+  sig { returns(T.nilable(String)) }
+  attr_reader :test_file_name
+
   # @param data [Hash<String, Object>] Data from YAML file
   # @param db_obj [DatabaseObject] Database object that defines test procedure (Extension, Instruction, CSR, or CSR field)
+  sig {params(data: T::Hash[String, T.untyped], db_obj: T.any(Extension, Instruction, Csr, CsrField)).void }
   def initialize(data, db_obj)
-    raise ArgumentError, "Need Hash but was passed a #{data.class}" unless data.is_a?(Hash)
-    raise ArgumentError, "Need DatabaseObject but was passed a #{db_obj.class}" unless db_obj.is_a?(DatabaseObject)
-
     @data = data
     @db_obj = db_obj
 
-    raise ArgumentError, "Missing certification test procedure ID for #{db_obj.name} of kind #{db_obj.kind}" if id.nil?
-    warn "Warning: Missing test_file_name for certification test procedure description for #{db_obj.name} of kind #{db_obj.kind}" if test_file_name.nil?
-    raise ArgumentError, "Missing certification test procedure description for #{db_obj.name} of kind #{db_obj.kind}" if description.nil?
-  end
-
-  # @return [String] Unique ID of the test procedure
-  def id = @data["id"]
+    @id = T.must_because(data["id"]) { pp data }
+    @description = T.must_because(data["description"]) { pp data }
+    @kind = T.must_because(db_obj.kind) { pp db_obj }
+    @test_file_name = data["test_file_name"]
 
-  # @return [String] Name of test file that implements this test procedure. Could be nil.
-  def test_file_name = @data["test_file_name"]
-
-  # @return [String] Description of test procedure (could be multiple lines)
-  def description = @data["description"]
+    if test_file_name.nil?
+      warn "Warning: Missing test_file_name for certification test procedure description for ID #{id} of kind #{kind}"
+    end
+  end
 
   # @return [Array<CertNormativeRule>]
   def cert_normative_rules
diff --git a/lib/arch_obj_models/csr_field.rb b/lib/arch_obj_models/csr_field.rb
@@ -34,8 +34,10 @@ def base
   # @param field_data [Hash<String,Object>] Field data from the arch spec
   sig { params(parent_csr: Csr, field_name: String, field_data: T::Hash[String, T.untyped]).void }
   def initialize(parent_csr, field_name, field_data)
+    field_data["name"] = field_name
+    field_data["long_name"] = parent_csr.long_name + " #{field_name} field"
+    field_data["kind"] = "csr_field"
     super(field_data, parent_csr.data_path, parent_csr.arch)
-    @name = field_name
     @parent = parent_csr
   end
 
diff --git a/lib/arch_obj_models/database_obj.rb b/lib/arch_obj_models/database_obj.rb
@@ -114,6 +114,9 @@ class ValidationError < ::StandardError
   sig { returns(String) }
   attr_reader :long_name
 
+  sig { returns(String) }
+  attr_reader :kind
+
   # @return [Architecture] If only a specification (no config) is known
   # @return [ConfiguredArchitecture] If a specification and config is known
   # @return [nil] If neither is known
@@ -132,9 +135,6 @@ def cfg_arch
   sig { returns(T::Boolean) }
   def cfg_arch? = !@cfg_arch.nil?
 
-  sig { returns(String) }
-  def kind = @data["kind"]
-
   @@schemas ||= {}
   @@schema_ref_resolver ||= proc do |pattern|
     if pattern.to_s =~ /^http/
@@ -299,16 +299,17 @@ def description(
 
   # @param data [Hash<String,Object>] Hash with fields to be added
   # @param data_path [Pathname] Path to the data file
-  sig { params(data: T::Hash[String, T.untyped], data_path: T.any(String, Pathname), arch: T.nilable(Architecture)).void }
+  sig { params(data: T::Hash[String, T.untyped], data_path: T.any(String, Pathname), arch: Architecture).void }
   def initialize(data, data_path, arch)
     @data = data
     @data_path = Pathname.new(data_path)
     if arch.is_a?(ConfiguredArchitecture)
       @cfg_arch = arch
     end
-    @arch = T.must(arch)
-    @name = data["name"]
-    @long_name = data["long_name"]
+    @arch = T.must_because(arch) { pp data }
+    @name = T.must_because(data["name"]) { pp data }
+    @long_name = T.must_because(data["long_name"]) { pp data }
+    @kind = T.must_because(data["kind"]) { pp data }
 
     @sem = Concurrent::Semaphore.new(1)
     @cache = Concurrent::Hash.new
diff --git a/schemas/csr_schema.json b/schemas/csr_schema.json
@@ -17,8 +17,7 @@
         },
         "long_name": {
           "type": "string",
-          "description": "Long name of the field",
-          "pattern": ".*[^.!,]$"
+          "description": "One line description of the CSR field"
         },
         "location": {
           "$ref": "schema_defs.json#/$defs/field_location",
@@ -216,8 +215,7 @@
         },
         "long_name": {
           "type": "string",
-          "description": "Descriptive name for the CSR",
-          "pattern": ".*[^.!,]$"
+          "description": "One line description for the CSR"
         },
         "description": {
           "$ref": "schema_defs.json#/$defs/spec_text",
diff --git a/schemas/ext_schema.json b/schemas/ext_schema.json
@@ -93,8 +93,7 @@
         "name": { "$ref": "schema_defs.json#/$defs/extension_name" },
         "long_name": {
           "type": "string",
-          "description": "One line description for the extension",
-          "pattern": ".*[^.!,]$"
+          "description": "One line description for the extension"
         },
         "description": {
           "$ref": "schema_defs.json#/$defs/spec_text",
diff --git a/schemas/inst_schema.json b/schemas/inst_schema.json
@@ -180,8 +180,7 @@
         },
         "long_name": {
           "type": "string",
-          "description": "Short description of the instruction",
-          "pattern": ".*[^.!,]$"
+          "description": "One line description of the instruction"
         },
         "description": {
           "$ref": "schema_defs.json#/$defs/spec_text",
diff --git a/schemas/manual_schema.json b/schemas/manual_schema.json
diff --git a/schemas/manual_version_schema.json b/schemas/manual_version_schema.json
diff --git a/schemas/proc_cert_model_schema.json b/schemas/proc_cert_model_schema.json
diff --git a/schemas/profile_class_schema.json b/schemas/profile_class_schema.json
diff --git a/schemas/profile_release_schema.json b/schemas/profile_release_schema.json
diff --git a/schemas/profile_schema.json b/schemas/profile_schema.json
