Merge pull request #140 from riscv-software-src/crd_arch_def

Author: dhower-qc

backends/arch_gen/lib/arch_gen.rb

@@ -716,11 +716,18 @@ def maybe_add_csr(csr_name, extra_env = {})
     end
 
     csr_obj = Csr.new(csr_data[csr_name])
+    arch_def_mock = Object.new
+    arch_def_mock.define_singleton_method(:fully_configured?) { true }
+    pos_xlen_local = possible_xlens
+    arch_def_mock.define_singleton_method(:possible_xlens) do
+      pos_xlen_local
+    end
+    impl_ext = @cfg_impl_ext.map { |e| ExtensionVersion.new(e[0], e[1]) }
+    arch_def_mock.define_singleton_method(:implemented_extensions) do
+      impl_ext
+    end
     belongs =
-      csr_obj.exists_in_cfg?(
-        possible_xlens,
-        @cfg_impl_ext.map { |e| ExtensionVersion.new(e[0], e[1]) }
-      )
+      csr_obj.exists_in_cfg?(arch_def_mock)
 
     @implemented_csrs ||= []
     @implemented_csrs << csr_name if belongs
@@ -967,11 +974,15 @@ def maybe_add_inst(inst_name, extra_env = {})
       possible_xlens << 64 if [64, 3264].include?(params["VSXLEN"])
       possible_xlens << 64 if [64, 3264].include?(params["VUXLEN"])
     end
+    arch_def_mock = Object.new
+    arch_def_mock.define_singleton_method(:fully_configured?) { true }
+    arch_def_mock.define_singleton_method(:possible_xlens) { possible_xlens }
+    impl_ext = @cfg_impl_ext.map { |e| ExtensionVersion.new(e[0], e[1]) }
+    arch_def_mock.define_singleton_method(:implemented_extensions) do
+      impl_ext
+    end
     belongs =
-      inst_obj.exists_in_cfg?(
-        possible_xlens.uniq,
-        @cfg_impl_ext.map { |e| ExtensionVersion.new(e[0], e[1]) }
-      )
+      inst_obj.exists_in_cfg?(arch_def_mock)
 
     @implemented_instructions ||= []
     @implemented_instructions << inst_name if belongs

backends/crd_doc/tasks.rake

@@ -29,6 +29,10 @@ Dir.glob("#{$root}/arch/crd/*.yaml") do |f|
     crd = arch_def.crd(crd_name)
     raise "No CRD defined for #{crd_name}" if crd.nil?
 
+    # switch to the generated CRD arch def
+    arch_def = crd.to_arch_def
+    crd = arch_def.crd(crd_name)
+
     version = File.basename(t.name, '.adoc').split('-')[1..].join('-')
 
     erb = ERB.new(File.read("#{CRD_DOC_DIR}/templates/crd.adoc.erb"), trim_mode: "-")

backends/crd_doc/templates/crd.adoc.erb

@@ -519,7 +519,7 @@ h| Privilege Mode | <%= csr.priv_mode %>
 .<%= csr.name %> format
 [wavedrom, ,svg,subs='attributes',width="100%"]
 ....
-<%= JSON.dump csr.wavedrom_desc(crd.arch_def, csr.base.nil? ? 32 : csr.base) %>
+<%= JSON.dump csr.wavedrom_desc(crd.arch_def, csr.base.nil? ? 32 : csr.base, optional_type: 3) %>
 ....
 <% else -%>
 <%# CSR has a dynamic length, or a field has a dynamic location,
@@ -529,13 +529,13 @@ This CSR format changes dynamically with XLEN.
 .<%= csr.name %> Format when <%= csr.length_cond32 %>
 [wavedrom, ,svg,subs='attributes',width="100%"]
 ....
-<%= JSON.dump csr.wavedrom_desc(crd.arch_def, 32) %>
+<%= JSON.dump csr.wavedrom_desc(crd.arch_def, 32, optional_type: 3) %>
 ....
 
 .<%= csr.name %> Format when <%= csr.length_cond64 %>
 [wavedrom, ,svg,subs='attributes',width="100%"]
 ....
-<%= JSON.dump csr.wavedrom_desc(crd.arch_def, 64) %>
+<%= JSON.dump csr.wavedrom_desc(crd.arch_def, 64, optional_type: 3) %>
 ....
 
 

backends/manual/templates/ext.adoc.erb

@@ -5,7 +5,6 @@
 == Versions
 
 <%- ext.versions.each do |v| -%>
-<%- implemented = arch_def.implemented_extensions.include?(ExtensionVersion.new(ext.name, v["version"])) -%>
 <%= v["version"] %>::
   State:::
     <%= v["state"] %>

lib/arch_def.rb

@@ -341,6 +341,8 @@ def extensions
   # may be overridden by subclass
   # @return [Array<ExtensionVersion>] List of all extensions known to be implemented in this architecture
   def implemented_extensions
+    raise "implemented_extensions is only valid for a fully configured defintion" unless fully_configured?
+
     return @implemented_extensions unless @implemented_extensions.nil?
 
     @implemented_extensions = []
@@ -352,6 +354,21 @@ def implemented_extensions
     @implemented_extensions
   end
 
+  # @return [Array<ExtensionRequirement>] List of extensions that are explicitly required by an arch def
+  def mandatory_extensions
+    raise "mandatory_extensions is only valid for a partially configured defintion" unless partially_configured?
+
+    return @mandatory_extensions unless @mandatory_extensions.nil?
+
+    @mandatory_extensions = []
+    if @arch_def.key?("mandatory_extensions")
+      @arch_def["mandatory_extensions"].each do |e|
+        @mandatory_extensions << ExtensionRequirement.new(e["name"], e["version"])
+      end
+    end
+    @mandatory_extensions
+  end
+
   # @return [Array<ExtensionRequirement>] List of extensions that are explicitly prohibited by an arch def
   def prohibited_extensions
     return @prohibited_extensions unless @prohibited_extensions.nil?
@@ -411,12 +428,27 @@ def ext?(ext_name, *ext_version_requirements)
     return cached_result unless cached_result.nil?
 
     result =
-      implemented_extensions.any? do |e|
-        if ext_version_requirements.empty?
-          e.name == ext_name.to_s
-        else
-          requirement = Gem::Requirement.new(ext_version_requirements)
-          (e.name == ext_name.to_s) && requirement.satisfied_by?(e.version)
+      if fully_configured?
+        implemented_extensions.any? do |e|
+          if ext_version_requirements.empty?
+            e.name == ext_name.to_s
+          else
+            requirement = Gem::Requirement.new(ext_version_requirements)
+            (e.name == ext_name.to_s) && requirement.satisfied_by?(e.version)
+          end
+        end
+      else
+        raise "unexpected type" unless partially_configured?
+
+        mandatory_extensions.any? do |e|
+          if ext_version_requirements.empty?
+            e.name == ext_name.to_s
+          else
+            requirement = Gem::Requirement.new(ext_version_requirements)
+            e.satisfying_versions.all? do |ext_ver|
+              (e.name == ext_name.to_s) && requirement.satisfied_by?(exrt_ver.version)
+            end
+          end
         end
       end
     @ext_cache[[ext_name, ext_version_requirements]] = result
@@ -935,6 +967,27 @@ def implemented_interrupt_codes
   end
   private :erb_env
 
+  # create a new raw *unconfigured* architecture defintion data structure
+  #
+  # The data will not include anything configuration-dependent such as implemented_*/mandatory_*/etc.
+  #
+  # This function can be used to create a new arch_def for a different configuration
+  #
+  # @return [Hash] A unconfigured architecture definition
+  def unconfigured_data
+    {
+      "type" => "partially configured",
+      "instructions" => instructions.map { |i| [i.name, i.data] }.to_h,
+      "extensions" => extensions.map.map { |e| [e.name, e.data] }.to_h,
+      "csrs" => csrs.map { |c| [c.name, c.data] }.to_h,
+      "profile_families" => profile_families.map { |f| [f.name, f.data] }.to_h,
+      "profiles" => profiles.map { |p| [p.name, p.data] }.to_h,
+      "manuals" => manuals.map { |m| [m.name, m.data] }.to_h,
+      "crd_families" => crd_families.map { |f| [f.name, f.data] }.to_h,
+      "crds" => crds.map { |c| [c.name, c.data] }.to_h
+    }
+  end
+
   # passes _erb_template_ through ERB within the content of this config
   #
   # @param erb_template [String] ERB source

lib/arch_obj_models/crd.rb

@@ -305,7 +305,7 @@ def in_scope_ext_params(ext_req)
             ext_param_db.defined_in_extension_version?(ver["version"])
         end
 
-        ext_params << 
+        ext_params <<
           InScopeExtensionParameter.new(ext_param_db, param_data["schema"], param_data["note"])
     end
 
@@ -479,4 +479,25 @@ def requirement_groups
     @requirement_groups
   end
 
+  # @return [ArchDef] A partially-configued architecture definition corresponding to this CRD
+  def to_arch_def
+    return @generated_arch_def unless @generated_arch_def.nil?
+
+    arch_def_data = arch_def.unconfigured_data
+
+    arch_def_data["mandatory_extensions"] = in_scope_ext_reqs("mandatory").map do |ext_req|
+      {
+        "name" => ext_req.name,
+        "version" => ext_req.version_requirement.requirements.map { |r| "#{r[0]} #{r[1]}" }
+      }
+    end
+    arch_def_data["params"] = all_in_scope_ext_params.select(&:single_value?).map { |p| [p.name, p.value] }.to_h
+
+    file = Tempfile.new("archdef")
+    file.write(YAML.safe_dump(arch_def_data, permitted_classes: [Date]))
+    file.flush
+    file.close
+    @generated_arch_def = ArchDef.new(name, Pathname.new(file.path))
+  end
+
 end

lib/arch_obj_models/csr.rb

@@ -352,7 +352,7 @@ def implemented_fields(arch_def)
       end
 
     @implemented_fields = fields.select do |f|
-      f.exists_in_cfg?(implemented_bases, arch_def.implemented_extensions)
+      f.exists_in_cfg?(arch_def)
     end
   end
 
@@ -509,8 +509,10 @@ def pruned_sw_read_ast(arch_def)
   #
   # @param arch_def [ArchDef] A configuration
   # @param effective_xlen [Integer,nil] Effective XLEN to use when CSR length is dynamic
+  # @param exclude_unimplemented [Boolean] If true, do not create include unimplemented fields in the figure
+  # @param optional_type [Integer] Wavedrom type (Fill color) for fields that are optional (not mandatory) in a partially-specified arch_def
   # @return [Hash] A representation of the WaveDrom drawing for the CSR (should be turned into JSON for wavedrom)
-  def wavedrom_desc(arch_def, effective_xlen, exclude_unimplemented: false)
+  def wavedrom_desc(arch_def, effective_xlen, exclude_unimplemented: false, optional_type: 2)
     desc = {
       "reg" => []
     }
@@ -533,7 +535,11 @@ def wavedrom_desc(arch_def, effective_xlen, exclude_unimplemented: false)
 
         desc["reg"] << { "bits" => n, type: 1 }
       end
-      desc["reg"] << { "bits" => field.location(arch_def, effective_xlen).size, "name" => field.name, type: 2 }
+      if arch_def.partially_configured? && field.optional_in_cfg?(arch_def)
+        desc["reg"] << { "bits" => field.location(arch_def, effective_xlen).size, "name" => field.name, type: optional_type }
+      else
+        desc["reg"] << { "bits" => field.location(arch_def, effective_xlen).size, "name" => field.name, type: 2 }
+      end
       last_idx = field.location(arch_def, effective_xlen).max
     end
     if !field_list.empty? && (field_list.last.location(arch_def, effective_xlen).max != (length(arch_def, effective_xlen) - 1))
@@ -546,11 +552,26 @@ def wavedrom_desc(arch_def, effective_xlen, exclude_unimplemented: false)
     desc
   end
 
-  # @param possible_xlens [Array<Integer>] List of xlens that be used in any implemented mode
-  # @param extensions [Array<ExtensionVersion>] List of extensions implemented
-  # @return [Boolean] whether or not the instruction is implemented given the supplies config options
-  def exists_in_cfg?(possible_xlens, extensions)
-    (@data["base"].nil? || (possible_xlens.include? @data["base"])) &&
-      extensions.any? { |e| defined_by?(e) }
+  # @param arch_def [ArchDef] Architecture def
+  # @return [Boolean] whether or not the CSR is possibly implemented given the supplies config options
+  def exists_in_cfg?(arch_def)
+    if arch_def.fully_configured?
+      (@data["base"].nil? || (arch_def.possible_xlens.include? @data["base"])) &&
+        arch_def.implemented_extensions.any? { |e| defined_by?(e) }
+    else
+      (@data["base"].nil? || (arch_def.possible_xlens.include? @data["base"])) &&
+        arch_def.prohibited_extensions.none? { |e| defined_by?(e) }
+    end
+  end
+
+  # @param arch_def [ArchDef] Architecture def
+  # @return [Boolean] whether or not the CSR is optional in the config
+  def optional_in_cfg?(arch_def)
+    raise "optional_in_cfg? should only be used by a partially-specified arch def" unless arch_def.partially_configured?
+
+    exists_in_cfg?(arch_def) &&
+      arch_def.mandatory_extensions.none? do |ext_req|
+        ext_req.satisfying_versions(arch_def).none? { |ext_ver| defined_by?(ext_ver) }
+      end
   end
 end

lib/arch_obj_models/csr_field.rb

@@ -31,10 +31,31 @@ def initialize(parent_csr, field_data)
   # @param possible_xlens [Array<Integer>] List of xlens that be used in any implemented mode
   # @param extensions [Array<ExtensionVersion>] List of extensions implemented
   # @return [Boolean] whether or not the instruction is implemented given the supplies config options
-  def exists_in_cfg?(possible_xlens, extensions)
-    parent.exists_in_cfg?(possible_xlens, extensions) &&
-      (@data["base"].nil? || possible_xlens.include?(@data["base"])) &&
-      (@data["definedBy"].nil? || extensions.any? { |e| defined_by?(e) } )
+  def exists_in_cfg?(arch_def)
+    if arch_def.fully_configured?
+      parent.exists_in_cfg?(arch_def) &&
+        (@data["base"].nil? || arch_def.possible_xlens.include?(@data["base"])) &&
+        (@data["definedBy"].nil? || arch_def.implemented_extensions.any? { |ext_ver| defined_by?(ext_ver) })
+    else
+      raise "unexpected type" unless arch_def.partially_configured?
+
+      parent.exists_in_cfg?(arch_def) &&
+        (@data["base"].nil? || arch_def.possible_xlens.include?(@data["base"])) &&
+        (@data["definedBy"].nil? || arch_def.prohibited_extensions.none? { |ext_ver| defined_by?(ext_ver) })
+    end
+  end
+
+  # @return [Boolean] For a partially configured arch_def, whether or not the field is optional (not mandatory or prohibited)
+  def optional_in_cfg?(arch_def)
+    raise "optional_in_cfg? should only be called on a partially configured arch_def" unless arch_def.partially_configured?
+
+    exists_in_cfg?(arch_def) &&
+      (
+        parent.optional_in_cfg?(arch_def) ||
+        (data["definedBy"].nil? || arch_def.mandatory_extensions.none? do |ext_req|
+          ext_req.satisfying_versions(arch_def).none? { |ext_ver| defined_by?(ext_ver) }
+        end)
+      )
   end
 
   # @return [Idl::FunctionBodyAst] Abstract syntax tree of the type() function