Merge remote-tracking branch 'rvi/main' into manual_appendices

Author: Derek Hower

arch/crd/MC-1.yaml

@@ -8,6 +8,9 @@ MC-1:
   # semantic version within the CRD family
   version: "1.0"
 
+  # XLEN used by rakefile
+  base: 32
+
   description: |
     MC-1 can be though of as a minimal 32-bit RISC-V processor with M-mode support:
 
@@ -47,7 +50,7 @@ MC-1:
     parameters:
         TIME_CSR_IMPLEMENTED: {} # Unconstrained
   - name: Sm
-    version: "~> 1.11"
+    version: "~> 1.11.0"
     presence: mandatory
     parameters:
         MTVEC_BASE_ALIGNMENT_DIRECT: {} # Unconstrained
@@ -60,10 +63,6 @@ MC-1:
         MTVAL_WIDTH: {} # Unconstrained
         MTVEC_MODES: {} # Unconstrained
         PHYS_ADDR_WIDTH: {} # Unconstrained
-        CONFIG_PTR_ADDRESS:
-          schema:
-            const: 0xdeadbeef
-          note: "This parameter and its associated CSR shouldn't be here. See GitHub issue #53."
         PRECISE_SYNCHRONOUS_EXCEPTIONS:
           schema:
             const: true

arch/crd/MockCRD-1.yaml

@@ -6,6 +6,9 @@ MockCRD-1:
 
   family: MockCRDFamily
 
+   # XLEN used by rakefile
+  base: 64
+
   # semantic version within the CRD family
   version: "1.0"
 
@@ -124,7 +127,7 @@ MockCRD-1:
             const: little
         XLEN:
           schema:
-            const: 32
+            const: 64
         CONFIG_PTR_ADDRESS:
           schema:
             const: 0xdeadbeef

backends/crd_doc/tasks.rake

@@ -13,16 +13,19 @@ Dir.glob("#{$root}/arch/crd/*.yaml") do |f|
   crd_name = File.basename(f, ".yaml")
   crd_obj = YAML.load_file(f, permitted_classes: [Date])
   raise "Ill-formed CRD file #{f}: missing 'family' field" if crd_obj.dig(crd_name, 'family').nil?
+
+  base = crd_obj[crd_name]["base"]
+  raise "Missing CRD base" if base.nil?
 
   file "#{$root}/gen/crd_doc/adoc/#{crd_name}.adoc" => [
     "#{$root}/arch/crd/#{crd_name}.yaml",
     "#{$root}/arch/crd_family/#{crd_obj[crd_name]['family']}.yaml",
     "#{CRD_DOC_DIR}/templates/crd.adoc.erb",
     __FILE__,
-    "#{$root}/.stamps/arch-gen-_64.stamp"
+    "#{$root}/.stamps/arch-gen-_#{base}.stamp"
   ] do |t|
     # TODO: schema validation
-    arch_def = arch_def_for("_64")
+    arch_def = arch_def_for("_#{base}")
     crd = arch_def.crd(crd_name)
     raise "No CRD defined for #{crd_name}" if crd.nil?
 

backends/crd_doc/templates/crd.adoc.erb

@@ -117,7 +117,7 @@ If the "Allowed Value(s)" is "Any" then any value allowed by the type is accepta
 <% if crd.all_in_scope_ext_params.empty? -%>
 None
 <% else -%>
-[cols="4,2,1,1,3"]
+[cols="4,2,1,1,2"]
 |===
 | Parameter | Type | Allowed Value(s) | Extension(s) | Note
 
@@ -316,7 +316,7 @@ The following instructions are added by this extension:
 
 <% crd.in_scope_ext_params(ext_req).sort.each do |ext_param| -%>
 [[ext-<%= ext_req.name %>-param-<%= ext_param.name %>-def]]
-<%= ext_param.name %>::
+<%= ext_param.name %> &#8658; <%= ext_param.param_db.schema_type %>::
 +
 --
 <%= ext_param.param_db.desc %>
@@ -329,7 +329,7 @@ The following instructions are added by this extension:
 
 <% crd.out_of_scope_params(ext_req.name).sort.each do |param_db| -%>
 [[ext-<%= ext_req.name %>-param-<%= param_db.name %>-def]]
-<%= param_db.name %>::
+<%= param_db.name %> &#8658; <%= param_db.schema_type %>::
 +
 --
 <%= param_db.desc %>
@@ -455,20 +455,18 @@ RV64::
 
 ==== Exceptions
 
-// TODO: add back after sym table update for generic arch def is merged in profiles branch
-<%#
-<% exception_list = inst.reachable_exceptions_str(crd.arch_def.symtab) -% >
-<% if exception_list.empty? -% >
+<%- exception_list = inst.reachable_exceptions_str(crd.arch_def.symtab) -%>
+<%- if exception_list.empty? -%>
 This instruction does not generate synchronous exceptions.
-<% else -% >
+<%- else -%>
 This instruction may result in the following synchronous exceptions:
 
-  <% exception_list.sort.each do |etype| -% >
-  * <%= etype % >
-  <% end -% >
+  <%- exception_list.sort.each do |etype| -%>
+  * <%= etype %>
+  <%- end -%>
+
+<%- end -%>
 
-<% end -% >
-%>
 
 <% end -%>
 

backends/manual/templates/instruction.adoc.erb

@@ -128,8 +128,7 @@ RV64::
 ----
 <%- end -%>
 
-<%# exception_list = inst.reachable_exceptions_str(inst.arch_def.sym_table_64, 64) -%>
-<%- exception_list = [] -%>
+<% exception_list = inst.reachable_exceptions_str(inst.arch_def.symtab, 64) -%>
 <%- unless exception_list.empty? -%>
 == Exceptions
 

backends/profile_doc/templates/profile_pdf.adoc.erb

@@ -618,20 +618,17 @@ RV64::
 
 ==== Exceptions
 
-// TODO: add back after sym table update for generic arch def is merged in profiles branch
-<%#
-<%- exception_list = inst.reachable_exceptions_str(arch_def.symtab) -% >
-<%- if exception_list.empty? -% >
+<%- exception_list = inst.reachable_exceptions_str(arch_def.symtab) -%>
+<%- if exception_list.empty? -%>
 This instruction does not generate synchronous exceptions.
-<%- else -% >
+<%- else -%>
 This instruction may result in the following synchronous exceptions:
 
-  <%- exception_list.sort.each do |etype| -% >
-  * <%= etype % >
-  <%- end -% >
+  <%- exception_list.sort.each do |etype| -%>
+  * <%= etype %>
+  <%- end -%>
 
-<%- end -% >
-%>
+<%- end -%>
 
 <%- end -%>
 

lib/arch_obj_models/crd.rb

@@ -222,11 +222,6 @@ def value
     end
 
     # @return [String] - # What parameter values are allowed by the CRD.
-    #
-    # Old implementation:
-    #   def schema_pretty_crd_merged_with_param_db
-    #     Schema.new(@param_db.schema).merge!(@schema_crd).to_pretty_s
-    #   end
     def allowed_values
       if (@schema_crd.empty?)
         # CRD doesn't add any constraints on parameter's value.
@@ -236,11 +231,9 @@ def allowed_values
       # Create a Schema object just using information in the parameter database.
       schema_obj = @param_db.schema
 
-      # Merge in constraints imposed by the CRD on the parameter.
-      schema_obj.merge!(@schema_crd)
-
-      # Create string showing allowed values of parameter with CRD constraints added
-      schema_obj.to_pretty_s
+      # Merge in constraints imposed by the CRD on the parameter and then
+      # create string showing allowed values of parameter with CRD constraints added
+      schema_obj.merge(@schema_crd).to_pretty_s
     end
 
     # sorts by name
@@ -273,6 +266,11 @@ def all_in_scope_ext_params
         param_db = ext_db.params.find { |p| p.name == param_name }
         raise "There is no param '#{param_name}' in extension '#{ext_crd["name"]}" if param_db.nil?
 
+        next unless ext_db.versions.any? do |ver|
+          Gem::Requirement.new(ext_crd["version"]).satisfied_by?(Gem::Version.new(ver["version"])) &&
+            param_db.defined_in_extension_version?(ver["version"])
+        end
+
         @all_in_scope_ext_params << 
           InScopeExtensionParameter.new(param_db, param_data["schema"], param_data["note"])
       end
@@ -302,6 +300,11 @@ def in_scope_ext_params(ext_req)
         ext_param_db = ext_db.params.find { |p| p.name == param_name }
         raise "There is no param '#{param_name}' in extension '#{ext_crd["name"]}" if ext_param_db.nil?
 
+        next unless ext_db.versions.any? do |ver|
+          Gem::Requirement.new(ext_crd["version"]).satisfied_by?(Gem::Version.new(ver["version"])) &&
+            ext_param_db.defined_in_extension_version?(ver["version"])
+        end
+
         ext_params << 
           InScopeExtensionParameter.new(ext_param_db, param_data["schema"], param_data["note"])
     end
@@ -315,8 +318,15 @@ def all_out_of_scope_params
 
     @all_out_of_scope_params = []
     in_scope_ext_reqs.each do |ext_req|
-      @arch_def.extension(ext_req.name).params.each do |param_db|
+      ext_db = @arch_def.extension(ext_req.name)
+      ext_db.params.each do |param_db|
         next if all_in_scope_ext_params.any? { |c| c.param_db.name == param_db.name }
+
+        next unless ext_db.versions.any? do |ver|
+          Gem::Requirement.new(ext_req.version_requirement).satisfied_by?(Gem::Version.new(ver["version"])) &&
+            param_db.defined_in_extension_version?(ver["version"])
+        end
+
         @all_out_of_scope_params << param_db
       end
     end

lib/arch_obj_models/extension.rb

@@ -67,7 +67,7 @@ def initialize(ext, name, data)
   def defined_in_extension_version?(version)
     return true if @data.dig("when", "version").nil?
 
-    Gem::Requirement.new(@data["when"]["version"]).satisfied_by?(version)
+    Gem::Requirement.new(@data["when"]["version"]).satisfied_by?(Gem::Version.new(version))
   end
 
   # @return [String]

lib/arch_obj_models/instruction.rb

@@ -160,7 +160,6 @@ def reachable_exceptions_str(symtab, effective_xlen=nil)
     if @data["operation()"].nil?
       []
     else
-      # RubyProf.start
       etype = symtab.get("ExceptionCode")
       if effective_xlen.nil?
         if symtab.archdef.multi_xlen?
@@ -174,49 +173,41 @@ def reachable_exceptions_str(symtab, effective_xlen=nil)
               puts "done"
               pruned_ast = pruned_operation_ast(symtab, 64)
               print "Determining reachable exceptions from #{name}#RV64..."
-              e64 = mask_to_array(prunted_ast.reachable_exceptions(fill_symtab(symtab, 64, pruned_ast))).map { |code|
+              e64 = mask_to_array(pruned_ast.reachable_exceptions(fill_symtab(symtab, 64, pruned_ast))).map { |code|
                 etype.element_name(code)
               }
-              puts done
+              puts "done"
               e32 + e64
             ).uniq
           else
             pruned_ast = pruned_operation_ast(symtab, base)
             print "Determining reachable exceptions from #{name}..."
-            result = RubyProf.profile do
-              e = mask_to_array(pruned_ast.reachable_exceptions(fill_symtab(symtab, base, pruned_ast))).map { |code|
-                etype.element_name(code)
-              }
-            end
-            RubyProf::CallStackPrinter.new(result).print(File.open("#{name}-profile.html", "w+"), {})
+            e = mask_to_array(pruned_ast.reachable_exceptions(fill_symtab(symtab, base, pruned_ast))).map { |code|
+              etype.element_name(code)
+            }
             puts "done"
             e
           end
         else
           effective_xlen = symtab.archdef.mxlen
           pruned_ast = pruned_operation_ast(symtab, effective_xlen)
           print "Determining reachable exceptions from #{name}..."
-          # result = RubyProf.profile do
-            e = mask_to_array(pruned_ast.reachable_exceptions(fill_symtab(symtab, effective_xlen, pruned_ast))).map { |code|
-              etype.element_name(code)
-            }
-          # end
-          # RubyProf::FlameGraphPrinter.new(result).print(File.open("#{name}-profile.html", "w+"), {})
+          e = mask_to_array(pruned_ast.reachable_exceptions(fill_symtab(symtab, effective_xlen, pruned_ast))).map { |code|
+            etype.element_name(code)
+          }
           puts "done"
           e
         end
       else
         pruned_ast = pruned_operation_ast(symtab, effective_xlen)
 
         print "Determining reachable exceptions from #{name}..."
-        e = mask_to_array(prunted_ast.reachable_exceptions(fill_symtab(symtab, effective_xlen, pruned_ast))).map { |code|
+        e = mask_to_array(pruned_ast.reachable_exceptions(fill_symtab(symtab, effective_xlen, pruned_ast))).map { |code|
           etype.element_name(code)
         }
         puts "done"
         e
       end
-      # result = RubyProf.stop
-      # RubyProf::FlatPrinter.new(result).print(STDOUT)
     end
   end
 

lib/arch_obj_models/schema.rb

@@ -122,14 +122,12 @@ def large2hex(value)
       end
     end
 
-    def merge!(other_schema)
+    def merge(other_schema)
       raise ArgumentError, "Expecting Schema" unless (other_schema.is_a?(Schema) || other_schema.is_a?(Hash))
 
-      hash = other_schema.is_a?(Schema) ? other_schema.instance_variable_get(:@schema_hash) : other_schema
+      other_hash = other_schema.is_a?(Schema) ? other_schema.instance_variable_get(:@schema_hash) : other_schema
 
-      @schema_hash.merge!(hash)
-
-      self
+      Schema.new(@schema_hash.merge(other_hash))
     end
 
     def empty?