Rename routines ending in _extensions to _ext_reqs or _ext_vers to make it clearer the return type since I found bugs in the code related to this.

Author: james-ball-qualcomm

backends/cfg_html_doc/adoc_gen.rake

@@ -42,7 +42,7 @@ require "ruby-prof"
         # RubyProf::FlatPrinter.new(result).print(STDOUT)
       end
     when "ext"
-      cfg_arch.transitive_implemented_extensions.each do |ext_version|
+      cfg_arch.transitive_implemented_ext_vers.each do |ext_version|
         ext = cfg_arch.extension(ext_version.name)
         path = dir_path / "#{ext.name}.adoc"
         puts "  Generating #{path}"
@@ -90,7 +90,7 @@ require "ruby-prof"
       end
     when "ext"
       puts "Generting full extension list"
-      cfg_arch.transitive_implemented_extensions.each do |ext_version|
+      cfg_arch.transitive_implemented_ext_vers.each do |ext_version|
         lines << " * `#{ext_version.name}` #{ext_version.ext.long_name}"
       end
     when "inst"

backends/cfg_html_doc/templates/config.adoc.erb

@@ -4,7 +4,7 @@
 
 |===
 | Name | Version
-<%- cfg_arch.transitive_implemented_extensions.sort{ |a,b| a.name <=> b.name }.each do |e| -%>
+<%- cfg_arch.transitive_implemented_ext_vers.sort{ |a,b| a.name <=> b.name }.each do |e| -%>
 | `<%= e.name %>` | <%= e.version_spec %>
 <%- end -%>
 |===

backends/cfg_html_doc/templates/ext.adoc.erb

@@ -7,7 +7,7 @@ Implemented Version:: <%= ext_version.version_str %>
 == Versions
 
 <%- ext.versions.each do |v| -%>
-<%- implemented = cfg_arch.transitive_implemented_extensions.include?(v) -%>
+<%- implemented = cfg_arch.transitive_implemented_ext_vers.include?(v) -%>
 <%= v.version_str %>::
   Ratification date:::
     <%= v.ratification_date %>

backends/cfg_html_doc/templates/toc.adoc.erb

@@ -1,7 +1,7 @@
 * xref:ROOT:config.adoc[Configuration]
 
 .Extensions
-<%- cfg_arch.transitive_implemented_extensions.sort { |a, b| a.name <=> b.name }.each do |ext| -%>
+<%- cfg_arch.transitive_implemented_ext_vers.sort { |a, b| a.name <=> b.name }.each do |ext| -%>
 * %%LINK%ext;<%= ext.name %>;<%= ext.name %>%%
 <%- end -%>
 

lib/arch_obj_models/csr.rb

@@ -543,10 +543,10 @@ def wavedrom_desc(design, effective_xlen, exclude_unimplemented: false, optional
   def exists_in_design?(design)
     if design.fully_configured?
       (@data["base"].nil? || (design.possible_xlens.include? @data["base"])) &&
-        design.transitive_implemented_extensions.any? { |e| defined_by?(e) }
+        design.transitive_implemented_ext_vers.any? { |e| defined_by?(e) }
     else
       (@data["base"].nil? || (design.possible_xlens.include? @data["base"])) &&
-        design.prohibited_extensions.none? { |ext_req| ext_req.satisfying_versions.any? { |e| defined_by?(e) } }
+        design.prohibited_ext_reqs.none? { |ext_req| ext_req.satisfying_versions.any? { |e| defined_by?(e) } }
     end
   end
 
@@ -556,7 +556,7 @@ def optional_in_design?(design)
     raise "optional_in_design? should only be used by a partially-specified arch def" unless design.partially_configured?
 
     exists_in_design?(design) &&
-      design.mandatory_extensions.all? do |ext_req|
+      design.mandatory_ext_reqs.all? do |ext_req|
         ext_req.satisfying_versions.none? do |ext_ver|
           defined_by?(ext_ver)
         end

lib/arch_obj_models/csr_field.rb

@@ -35,13 +35,13 @@ def exists_in_design?(design)
     if design.fully_configured?
       parent.exists_in_design?(design) &&
         (@data["base"].nil? || design.possible_xlens.include?(@data["base"])) &&
-        (@data["definedBy"].nil? || design.transitive_implemented_extensions.any? { |ext_ver| defined_by?(ext_ver) })
+        (@data["definedBy"].nil? || design.transitive_implemented_ext_vers.any? { |ext_ver| defined_by?(ext_ver) })
     else
       raise "unexpected type" unless design.partially_configured?
 
       parent.exists_in_design?(design) &&
         (@data["base"].nil? || design.possible_xlens.include?(@data["base"])) &&
-        (@data["definedBy"].nil? || design.prohibited_extensions.none? { |ext_req| ext_req.satisfying_versions.any? { |ext_ver| defined_by?(ext_ver) } })
+        (@data["definedBy"].nil? || design.prohibited_ext_reqs.none? { |ext_req| ext_req.satisfying_versions.any? { |ext_ver| defined_by?(ext_ver) } })
     end
   end
 
@@ -54,7 +54,7 @@ def optional_in_design?(design)
         if data["definedBy"].nil?
           parent.optional_in_design?(design)
         else
-          design.mandatory_extensions.all? do |ext_req|
+          design.mandatory_ext_reqs.all? do |ext_req|
             ext_req.satisfying_versions.none? do |ext_ver|
               defined_by?(ext_ver)
             end

lib/arch_obj_models/extension.rb

@@ -500,7 +500,7 @@ def <=>(other)
     end
   end
 
-  # @return [Array<Csr>] the list of CSRs implemented by this extension version (may be empty)
+  # @return [Array<Csr>] List of CSRs implemented by this extension version (may be empty)
   def implemented_csrs
     return @implemented_csrs unless @implemented_csrs.nil?
 
@@ -509,7 +509,7 @@ def implemented_csrs
     end
   end
 
-  # @return [Array<Instructions>] the list of insts implemented by this extension version (may be empty)
+  # @return [Array<Instruction>] List of insts implemented by this extension version (may be empty)
   def implemented_instructions
     return @implemented_instructions unless @implemented_instructions.nil?
 

lib/arch_obj_models/instruction.rb

@@ -739,18 +739,23 @@ def excluded_by?(*args)
   end
 
   # @param design [Design] The design
-  # @return [Boolean] whether or not the instruction is implemented given the supplies config options
+  # @return [Boolean] whether or not the instruction is implemented given the supplied design
+  #
+  # TODO: Does this function actually work for a partially configured design?
+  #       It is calling DatabaseObject.defined_by? with ExtensionRequirement objects
+  #       returned from Design.prohibited_ext_reqs() and Design.mandatory_ext_reqs()
+  #       but only accepts an ExtensionVersion object.
   def exists_in_design?(design)
     if design.fully_configured?
-      (@data["base"].nil? || (design.possible_xlens.include? @data["base"])) &&
-        design.implemented_extensions.any? { |e| defined_by?(e) } &&
-        design.implemented_extensions.none? { |e| excluded_by?(e) }
+      (@data["base"].nil? || (design.possible_xlens.include?(@data["base"]))) &&
+        design.implemented_ext_vers.any? { |ext_ver| defined_by?(ext_ver) } &&
+        design.implemented_ext_vers.none? { |ext_ver| excluded_by?(ext_ver) }
     else
       raise "unexpected design type" unless design.partially_configured?
 
-      (@data["base"].nil? || (design.possible_xlens.include? @data["base"])) &&
-        design.prohibited_extensions.none? { |e| defined_by?(e) } &&
-        design.mandatory_extensions.none? { |e| excluded_by?(e) }
+      (@data["base"].nil? || (design.possible_xlens.include?(@data["base"]))) &&
+        design.prohibited_ext_reqs.none? { |ext_req| defined_by?(ext_req) } &&
+        design.mandatory_ext_reqs.none? { |ext_req| excluded_by?(ext_req) }
     end
   end
 end

lib/cfg_arch.rb

@@ -137,9 +137,8 @@ def params_with_value
     return @params_with_value if @config.unconfigured?
 
     if @config.fully_configured?
-      transitive_implemented_extensions.each do |ext_version|
-        ext = extension(ext_version.name)
-        ext.params.each do |ext_param|
+      transitive_implemented_ext_vers.each do |ext_version|
+        ext_version.extension.params.each do |ext_param|
           next unless @config.param_values.key?(ext_param.name)
 
           @params_with_value << ExtensionParameterWithValue.new(
@@ -149,7 +148,7 @@ def params_with_value
         end
       end
     elsif @config.partially_configured?
-      mandatory_extensions.each do |ext_req|
+      mandatory_ext_reqs.each do |ext_req|
         ext_req.extension.params.each do |ext_param|
           # Params listed in the config always only have one value.
           next unless @config.param_values.key?(ext_param.name)
@@ -183,19 +182,19 @@ def params_without_value
   end
 
   # @return [Array<ExtensionVersion>] List of all implemented extension versions.
-  def implemented_extensions
-    return @implemented_extensions unless @implemented_extensions.nil?
+  def implemented_ext_vers
+    return @implemented_ext_vers unless @implemented_ext_vers.nil?
 
-    @implemented_extensions = @config.implemented_extensions.map do |e|
+    @implemented_ext_vers = @config.implemented_ext_vers.map do |e|
       ExtensionVersion.new(e["name"], e["version"], arch, fail_if_version_does_not_exist: true)
     end
   end
 
   # @return [Array<ExtensionRequirement>] List of all mandatory extension requirements
-  def mandatory_extensions
-    return @mandatory_extensions unless @mandatory_extensions.nil?
+  def mandatory_ext_reqs
+    return @mandatory_ext_reqs unless @mandatory_ext_reqs.nil?
 
-    @mandatory_extensions = @config.mandatory_extensions.map do |e|
+    @mandatory_ext_reqs = @config.mandatory_ext_reqs.map do |e|
       ext = extension(e["name"])
       raise "Cannot find extension #{e['name']} in the architecture definition" if ext.nil?
 
@@ -206,47 +205,47 @@ def mandatory_extensions
   # @return [Array<ExtensionRequirement>] List of all extensions that are prohibited.
   #                                       This includes extensions explicitly prohibited by the config file
   #                                       and extensions that conflict with a mandatory extension.
-  def prohibited_extensions
-    return @prohibited_extensions unless @prohibited_extensions.nil?
+  def prohibited_ext_reqs
+    return @prohibited_ext_reqs unless @prohibited_ext_reqs.nil?
 
     if @config.partially_configured?
-      @prohibited_extensions =
-        @config.prohibited_extensions.map do |e|
+      @prohibited_ext_reqs =
+        @config.prohibited_ext_reqs.map do |e|
           ext = extension(e["name"])
           raise "Cannot find extension #{e['name']} in the architecture definition" if ext.nil?
 
           ExtensionRequirement.new(e["name"], *e["version"], arch, presence: "mandatory")
         end
 
       # now add any extensions that are prohibited by a mandatory extension
-      mandatory_extensions.each do |ext_req|
+      mandatory_ext_reqs.each do |ext_req|
         ext_req.extension.conflicts.each do |conflict|
-          if @prohibited_extensions.none? { |prohibited_ext| prohibited_ext.name == conflict.name }
-            @prohibited_extensions << conflict
+          if @prohibited_ext_reqs.none? { |prohibited_ext_req| prohibited_ext_req.name == conflict.name }
+            @prohibited_ext_reqs << conflict
           else
             # pick whichever requirement is more expansive
-            p = @prohibited_extensions.find { |prohibited_ext| prohibited_ext.name == confict.name }
+            p = @prohibited_ext_reqs.find { |prohibited_ext_req| prohibited_ext_req.name == confict.name }
             if p.version_requirement.subsumes?(conflict.version_requirement)
-              @prohibited_extensions.delete(p)
-              @prohibited_extensions << conflict
+              @prohibited_ext_reqs.delete(p)
+              @prohibited_ext_reqs << conflict
             end
           end
         end
       end
 
-      @prohibited_extensions
+      @prohibited_ext_reqs
     elsif @config.fully_configured?
-      prohibited_ext_versions = []
+      prohibited_ext_vers = []
       extensions.each do |ext|
         ext.versions.each do |ext_ver|
-          prohibited_ext_versions << ext_ver unless transitive_implemented_extensions.include?(ext_ver)
+          prohibited_ext_vers << ext_ver unless transitive_implemented_ext_vers.include?(ext_ver)
         end
       end
-      @prohibited_extensions = []
-      prohibited_ext_versions.group_by(&:name).each_value do |ext_ver_list|
+      @prohibited_ext_reqs = []
+      prohibited_ext_vers.group_by(&:name).each_value do |ext_ver_list|
         if ext_ver_list.sort == ext_ver_list[0].ext.versions.sort
           # excludes every version
-          @prohibited_extensions <<
+          @prohibited_ext_reqs <<
             ExtensionRequirement.new(
               ext_ver_list[0].ext.name, ">= #{ext_ver_list.min.version_spec.canonical}",
               arch, presence: "prohibited"
@@ -257,7 +256,7 @@ def prohibited_extensions
           raise "Expected only a single element" unless allowed_version_list.size == 1
 
           allowed_version = allowed_version_list[0]
-          @prohibited_extensions <<
+          @prohibited_ext_reqs <<
             ExtensionRequirement.new(
               ext_ver_list[0].ext.name, "!= #{allowed_version.version_spec.canonical}", arch,
               presence: "prohibited"
@@ -268,9 +267,9 @@ def prohibited_extensions
         end
       end
     else
-      @prohibited_extensions = []
+      @prohibited_ext_reqs = []
     end
-    @prohibited_extensions
+    @prohibited_ext_reqs
   end
 
   # @overload ext?(ext_name)
@@ -288,7 +287,7 @@ def ext?(ext_name, *ext_version_requirements)
 
     result =
       if @config.fully_configured?
-        transitive_implemented_extensions.any? do |e|
+        transitive_implemented_ext_vers.any? do |e|
           if ext_version_requirements.empty?
             e.name == ext_name.to_s
           else
@@ -297,7 +296,7 @@ def ext?(ext_name, *ext_version_requirements)
           end
         end
       elsif @config.partially_configured?
-        mandatory_extensions.any? do |e|
+        mandatory_ext_reqs.any? do |e|
           if ext_version_requirements.empty?
             e.name == ext_name.to_s
           else
@@ -320,8 +319,8 @@ def ext?(ext_name, *ext_version_requirements)
   #####################################
 
   # @return [Array<ExtensionVersion>] List of all extensions known to be implemented in this config, including transitive implications
-  def transitive_implemented_extensions
-    raise "implemented_extensions is only valid for a fully configured definition" unless @config.fully_configured?
+  def transitive_implemented_ext_vers
+    raise "transitive_implemented_ext_vers is only valid for a fully configured definition" unless @config.fully_configured?
     super
   end
 

lib/design.rb

@@ -117,19 +117,19 @@ def params_without_value
   end
 
   # @return [Array<ExtensionVersion>] List of all implemented extension versions.
-  def implemented_extensions
+  def implemented_ext_vers
     raise "Abstract Method: Must be provided in child class"
   end
 
   # @return [Array<ExtensionRequirement>] List of all mandatory extension requirements
-  def mandatory_extensions
+  def mandatory_ext_reqs
     raise "Abstract Method: Must be provided in child class"
   end
 
   # @return [Array<ExtensionRequirement>] List of all extensions that are prohibited.
   #                                       This includes extensions explicitly prohibited by the design
   #                                       and extensions that conflict with a mandatory extension.
-  def prohibited_extensions
+  def prohibited_ext_reqs
     raise "Abstract Method: Must be provided in child class"
   end
 
@@ -261,15 +261,15 @@ def type_check(show_progress: true, io: $stdout)
   end
 
   # @return [Array<ExtensionVersion>] List of all extensions known to be implemented in this design, including transitive implications
-  def transitive_implemented_extensions
-    return @transitive_implemented_extensions unless @transitive_implemented_extensions.nil?
+  def transitive_implemented_ext_vers
+    return @transitive_implemented_ext_vers unless @transitive_implemented_ext_vers.nil?
 
-    list = implemented_extensions
+    list = implemented_ext_vers
     list.each do |e|
       implications = e.transitive_implications
       list.concat(implications) unless implications.empty?
     end
-    @transitive_implemented_extensions = list.uniq.sort
+    @transitive_implemented_ext_vers = list.uniq.sort
   end
 
   # @overload prohibited_ext?(ext)
@@ -283,9 +283,9 @@ def transitive_implemented_extensions
   #   @return [Boolean]
   def prohibited_ext?(ext)
     if ext.is_a?(ExtensionVersion)
-      prohibited_extensions.any? { |ext_req| ext_req.satisfied_by?(ext) }
+      prohibited_ext_reqs.any? { |ext_req| ext_req.satisfied_by?(ext) }
     elsif ext.is_a?(String) || ext.is_a?(Symbol)
-      prohibited_extensions.any? { |ext_req| ext_req.name == ext.to_s }
+      prohibited_ext_reqs.any? { |ext_req| ext_req.name == ext.to_s }
     else
       raise ArgumentError, "Argument to prohibited_ext? should be an ExtensionVersion or a String"
     end
@@ -296,7 +296,7 @@ def implemented_exception_codes
     return @implemented_exception_codes unless @implemented_exception_codes.nil?
 
     @implemented_exception_codes =
-      implemented_extensions.reduce([]) do |list, ext_version|
+      implemented_ext_vers.reduce([]) do |list, ext_version|
         ecodes = extension(ext_version.name)["exception_codes"]
         next list if ecodes.nil?
 
@@ -319,7 +319,7 @@ def implemented_interrupt_codes
     return @implemented_interrupt_codes unless @implemented_interrupt_codes.nil?
 
     @implemented_interupt_codes =
-      implemented_extensions.reduce([]) do |list, ext_version|
+      implemented_ext_vers.reduce([]) do |list, ext_version|
         icodes = extension(ext_version.name)["interrupt_codes"]
         next list if icodes.nil?
 
@@ -347,13 +347,13 @@ def functions
   # @return [Array<Csr>] List of all implemented CSRs
   def transitive_implemented_csrs
     @transitive_implemented_csrs ||=
-      transitive_implemented_extensions.map(&:implemented_csrs).flatten.uniq.sort
+      transitive_implemented_ext_vers.map(&:implemented_csrs).flatten.uniq.sort
   end
 
   # @return [Array<Instruction>] List of all implemented instructions
   def transitive_implemented_instructions
     @transitive_implemented_instructions ||=
-      transitive_implemented_extensions.map(&:implemented_instructions).flatten.uniq.sort
+      transitive_implemented_ext_vers.map(&:implemented_instructions).flatten.uniq.sort
   end
 
   # @return [Array<FuncDefAst>] List of all reachable IDL functions for the design