Finished adding support for profile processor kinds and now RVB23 is compared with the RVA profiles as desired.

Author: james-ball-qualcomm

backends/profile_doc/tasks.rake

@@ -7,30 +7,28 @@ rule %r{#{$root}/gen/profile_doc/adoc/.*\.adoc} => [
   Dir.glob("#{$root}/arch/profile_release/**/*.yaml")
 ].flatten do |t|
   profile_release_name = Pathname.new(t.name).basename(".adoc").to_s
-
-  # Switch to the generated profile certificate cfg arch and set some variables available to ERB template.
-  # XXX - Copy what certificate tasks.rake file does here (i.e. switching to generated profile cfg arch).
   profile_release = cfg_arch_for("_").profile_release(profile_release_name)
-  portfolio = profile_release
   raise ArgumentError, "No profile release named '#{profile_release_name}'" if profile_release.nil?
 
-  # Set globals for ERB template.
-  profile_class = profile_release.profile_class
-  portfolio_class = profile_class
-  portfolio = profile_release
-
   template_path = Pathname.new "#{$root}/backends/profile_doc/templates/profile.adoc.erb"
   erb = ERB.new(template_path.read, trim_mode: "-")
   erb.filename = template_path.to_s
 
+  # Switch to the generated profile certificate cfg arch and set some variables available to ERB template.
   cfg_arch = cfg_arch_for("_")
 
-  # XXX - Add call to to_cfg_arch() in portfolio instance class.
-  # But somehow have to merge the multiple portofolios in one profile release to one since
-  # to_cfg_arch used to provide coloring of fields in CSRs in appendices that apply to all profiles in a release.
+  # Create empty binding and then specify explicitly which variables the ERB template can access.
+  def create_empty_binding
+    binding
+  end
+  erb_binding = create_empty_binding
+  erb_binding.local_variable_set(:cfg_arch, cfg_arch)
+  erb_binding.local_variable_set(:profile_class, profile_release.profile_class)
+  erb_binding.local_variable_set(:profile_release, profile_release)
+  erb_binding.local_variable_set(:portfolio_class, profile_release.profile_class)
 
   FileUtils.mkdir_p File.dirname(t.name)
-  File.write t.name, AsciidocUtils.resolve_links(cfg_arch.find_replace_links(erb.result(binding)))
+  File.write t.name, AsciidocUtils.resolve_links(cfg_arch.find_replace_links(erb.result(erb_binding)))
   puts "Generated adoc source at #{t.name}"
 end
 

backends/profile_doc/templates/profile.adoc.erb

@@ -403,21 +403,21 @@ associated implementation-defined parameters.
 [appendix]
 == Profile Comparisons
 
-=== Processor Kind Comparison
+=== <%= profile_class.processor_kind %> Profile Releases
 
-The <%= profile_class.processor_kind %> processor kind has <%= profile_class.profile_releases.filter_processor_kind.size %> processor
-profile releases that reference a total of <%= profile_class.filter_processor_kind.referenced_extensions.size %> extensions.
+The <%= profile_class.processor_kind %> processor kind has <%= profile_class.profile_releases_matching_processor_kind.size %> processor
+profile releases that reference a total of <%= profile_class.referenced_extensions_matching_processor_kind.size %> extensions.
 
 .Extension Presence
 |===
-| Extension | <%= profile_class.profile_releases.filter_processor_kind.map(&:marketing_name).join(" | ") %>
+| Extension | <%= profile_class.profile_releases_matching_processor_kind.map(&:marketing_name).join(" | ") %>
 
-<% profile_class.filter_processor_kind.referenced_extensions.sort_by(&:name).each do |ext| -%>
-| <%= ext.name %> | <%= profile_class.profile_releases.filter_processor_kind.map { |profile_release| profile_release.extension_presence(ext.name) }.join(" | ") %>
+<% profile_class.referenced_extensions_matching_processor_kind.sort_by(&:name).each do |ext| -%>
+| <%= ext.name %> | <%= profile_class.profile_releases_matching_processor_kind.map { |profile_release| profile_release.extension_presence(ext.name) }.join(" | ") %>
 <% end -%>
 |===
 
-=== Release Comparison
+=== <%= profile_class.marketing_name %> Profile Releases
 
 The <%= profile_class.marketing_name %> Profile Class has <%= profile_class.profile_releases.size %> releases that
 reference a total of <%= profile_class.referenced_extensions.size %> extensions.
@@ -431,7 +431,7 @@ reference a total of <%= profile_class.referenced_extensions.size %> extensions.
 <% end -%>
 |===
 
-=== Profile Comparison
+=== <%= profile_release.marketing_name %> Profiles
 
 The <%= profile_release.marketing_name %> Profile Release has <%= profile_release.profiles.size %> profiles that
 reference a total of <%= profile_release.referenced_extensions.size %> extensions.

lib/arch_obj_models/certificate.rb

@@ -19,7 +19,7 @@ def mandatory_priv_modes = @data["mandatory_priv_modes"]
 
 # Holds information about a certificate model YAML file.
 # The inherited "data" member is the database of extensions, instructions, CSRs, etc.
-class CertModel < PortfolioInstance
+class CertModel < Portfolio
   def unpriv_isa_manual_revision = @data["unpriv_isa_manual_revision"]
   def priv_isa_manual_revision = @data["priv_isa_manual_revision"]
   def debug_manual_revision = @data["debug_manual_revision"]

lib/arch_obj_models/portfolio.rb

@@ -1,13 +1,13 @@
-# Classes for Porfolios which form a common base class for profiles and certificates.
+# Classes for Portfolios which form a common base class for profiles and certificates.
 # A "Portfolio" is a named & versioned grouping of extensions (each with a name and version).
-# Each Portfolio Instance is a member of a Portfolio Class:
-#   RVA20U64 and MC100 are examples of portfolio instances
+# Each Portfolio is a member of a Portfolio Class:
+#   RVA20U64 and MC100 are examples of portfolios
 #   RVA and MC are examples of portfolio classes
 #
 # Many classes inherit from the DatabaseObject class. This provides facilities for accessing the contents of a
 # Portfolio Class YAML or Portfolio Model YAML file via the "data" member (hash holding releated YAML file contents).
 #
-# A variable name with a "_data" suffix indicates it is the raw hash data from the porfolio YAML file.
+# A variable name with a "_data" suffix indicates it is the raw hash data from the portfolio YAML file.
 
 require "tmpdir"
 
@@ -37,15 +37,21 @@ def description = @data["description"]
   def eql?(other)
     other.instance_of?(self.class) && other.name == name
   end
+
+  # @return [Array<PortfolioClass] All portfolio classes that have the same portfolio kind and same processor kind.
+  def portfolio_classes_matching_portfolio_kind_and_processor_kind
+    cfg_arch.portfolio_classes.select {|portfolio_class|
+      (portfolio_class.kind == kind) && (portfolio_class.processor_kind == processor_kind)}
+  end
 end
 
-#####################
-# PortfolioInstance #
-#####################
+#############
+# Portfolio #
+#############
 
-# Holds information about a PortfolioInstance YAML file (certificate or profile).
+# Holds information about a Portfolio (certificate or profile).
 # The inherited "data" member is the database of extensions, instructions, CSRs, etc.
-class PortfolioInstance < DatabaseObject
+class Portfolio < DatabaseObject
   # @return [ConfiguredArchitecture] The defining ConfiguredArchitecture
   attr_reader :cfg_arch
 
@@ -55,7 +61,7 @@ def introduction = @data["introduction"]
   # @return [String] Large enough to need its own heading (generally one level deeper than the "introduction").
   def description = @data["description"]
 
-  # @return [Gem::Version] Semantic version of the PortfolioInstance
+  # @return [Gem::Version] Semantic version of the Portfolio
   def version = Gem::Version.new(@data["version"])
 
   # @return [ExtensionPresence] Given an extension +ext_name+, return the presence.
@@ -283,7 +289,7 @@ def value
     # @return [String] - # What parameter values are allowed by the portfolio.
     def allowed_values
       if (@schema_portfolio.empty?)
-        # PortfolioInstance doesn't add any constraints on parameter's value.
+        # Portfolio doesn't add any constraints on parameter's value.
         return "Any"
       end
 

lib/arch_obj_models/profile.rb

@@ -32,24 +32,33 @@ def profile_releases
 
   # @return [Array<ProfileRelease>] Defined profile releases of this processor class
   def profile_releases_matching_processor_kind
+    return @profile_releases_matching_processor_kind unless @profile_releases_matching_processor_kind.nil?
 
+    matching_classes = portfolio_classes_matching_portfolio_kind_and_processor_kind
+
+    # Look for all profile releases that are from any of the matching classes.
+    @profile_releases_matching_processor_kind = @cfg_arch.profile_releases.select { |pr|
+      matching_classes.any? { |matching_class| matching_class.name == pr.profile_class.name }
+    }
+
+    @profile_releases_matching_processor_kind
   end
 
   # @return [Array<Profile>] All profiles in this profile class (for all releases).
   def profiles
     return @profiles unless @profiles.nil?
 
-    @profiles = []
-    @cfg_arch.profiles.each do |profile|
-      if profile.profile_class.name == name
-        @profiles << profile
-      end
-    end
+    @profiles = @cfg_arch.profiles.select {|profile| profile.profile_class.name == name}
+  end
 
-    @profiles
+  # @return [Array<Profile>] All profiles in database matching my processor kind
+  def profiles_matching_processor_kind
+    return @profiles_matching_processor_kind unless @profiles_matching_processor_kind.nil?
+
+    @profiles_matching_processor_kind = @cfg_arch.profiles.select {|profile| profile.profile_class.processor_kind == processor_kind}
   end
 
-  # @return [Array<Extension>] List of all extensions referenced by the class
+  # @return [Array<Extension>] List of all extensions referenced by the profile class
   def referenced_extensions
     return @referenced_extensions unless @referenced_extensions.nil?
 
@@ -63,6 +72,19 @@ def referenced_extensions
     @referenced_extensions
   end
 
+  # @return [Array<Extension>] List of all extensions referenced by any profile class in the database with my processor kind
+  def referenced_extensions_matching_processor_kind
+    return @reference_extensions_matching_processor_kind unless @reference_extensions_matching_processor_kind.nil?
+
+    @reference_extensions_matching_processor_kind = []
+    profiles_matching_processor_kind.each do |profile|
+      @reference_extensions_matching_processor_kind += profile.in_scope_extensions
+    end
+
+    @reference_extensions_matching_processor_kind.uniq!(&:name)
+
+    @reference_extensions_matching_processor_kind
+  end
 end
 
 # A profile release consists of a number of releases each with one or more profiles.
@@ -148,7 +170,7 @@ def extension_presence(ext_name)
 end
 
 # Representation of a specific profile in a profile release.
-class Profile < PortfolioInstance
+class Profile < Portfolio
   # @return [String] The marketing name of the Profile
   def marketing_name = @data["marketing_name"]
 

lib/architecture.rb

@@ -1,5 +1,37 @@
 # frozen_string_literal: true
 
+# Contains the "database" of RISC-V standards including extensions, instructions,
+# CSRs, Profiles, and Certificates.  Could be either the standard spec (defined by RISC-V International)
+# of a custom spec (defined as an arch_overlay in cfgs/).
+#
+# Creates Ruby functions at runtime (see generate_obj_methods() and OBJS array).
+#   1) Function to return Array<klass>              (every klass in database)
+#   2) Function to return Hash<String name, klass>  (hash entry is nil if name doesn't exist)
+#   3) Function to return Klass given name          (nil if name doesn't exist)
+#
+#   klass           Array<klass>        Hash<String name,klass> Klass func(String name)
+#   =============== ==================  ======================= =========================
+#   Extension       extensions()        extension_hash()        extension(name)
+#   Instruction     instructions()      instruction_hash()      instruction(name)
+#   Csr             csrs()              csr_hash()              csr(name)
+#   CertClass       cert_classes()      cert_class_hash()       cert_class(name)
+#   CertModel       cert_models()       cert_model_hash()       cert_model(name)
+#   ProfileClass    profile_classes()   profile_class_hash()    profile_class(name)
+#   ProfileRelease  profile_releases()  profile_release_hash()  profile_release(name)
+#   Profile         profiles()          profile_hash()          profile(name)
+#   Manual          manuals()           manual_hash()           manual(name)
+#   ManualVersion   manual_versions()   manual_version_hash()   manual_version(name)
+#
+# Statically created Ruby functions:
+#
+#   klass               Array<klass>        Hash<String name,klass> Klass func(String name)
+#   ==================  ==================  ======================= =========================
+#   ExtensionParameter  params()            param_hash()            param(name)
+#   PortfolioClass      portfolio_classes() portfolio_class_hash()  portfolio_class(name)
+#   Portfolio           portfolios()        portfolio_hash()        portfolio(name)
+#   ExceptionCodes      exception_codes()
+#   InterruptCodes      interrupt_codes()
+
 require "active_support/inflector/methods"
 
 require "json"
@@ -19,10 +51,6 @@
 require_relative "arch_obj_models/portfolio"
 require_relative "arch_obj_models/profile"
 
-# Represents the entire RISC-V Architecture.
-#
-# Could be either the standard spec (defined by RISC-V International)
-# of a custom spec (defined as an arch_overlay in cfgs/)
 class Architecture
   # @return [Pathname] Path to the directory with the standard YAML files
   attr_reader :path
@@ -169,20 +197,66 @@ def params
   end
 
   # @return [Hash<String, ExtensionParameter>] Hash of all extension parameters defined in the architecture
-  def params_hash
-    return @params_hash unless @params_hash.nil?
+  def param_hash
+    return @param_hash unless @param_hash.nil?
 
-    @params_hash = {}
+    @param_hash = {}
     params.each do |param|
-      @params_hash[param.name] = param
+      @param_hash[param.name] = param
     end
     @param_hash
   end
 
   # @return [ExtensionParameter] Parameter named +name+
   # @return [nil] if there is no parameter named +name+
   def param(name)
-    params_hash[name]
+    param_hash[name]
+  end
+
+  # @return [Array<PortfolioClass>] Alphabetical list of all portfolio classes defined in the architecture
+  def portfolio_classes
+    return @portfolio_classes unless @portfolio_classes.nil?
+
+    @portfolio_classes = profile_classes.concat(cert_classes).sort_by!(&:name)
+  end
+
+  # @return [Hash<String, PortfolioClass>] Hash of all portfolio classes defined in the architecture
+  def portfolio_class_hash
+    return @portfolio_class_hash unless @portfolio_class_hash.nil?
+
+    @portfolio_class_hash = {}
+    portfolio_classes.each do |portfolio_class|
+      @portfolio_class_hash[portfolio_class.name] = portfolio_class
+    end
+    @portfolio_class_hash
+  end
+
+  # @return [PortfolioClass] Portfolio class named +name+
+  # @return [nil] if there is no Portfolio class named +name+
+  def portfolio_class(name) = portfolio_class_hash[name]
+
+  # @return [Array<Portfolio>] Alphabetical list of all portfolios defined in the architecture
+  def portfolios
+    return @portfolios unless @portfolios.nil?
+
+    @portfolios = @profiles.concat(@certificates).sort_by!(&:name)
+  end
+
+  # @return [Hash<String, Portfolio>] Hash of all portfolios defined in the architecture
+  def portfolio_hash
+    return @portfolio_hash unless @portfolio_hash.nil?
+
+    @portfolio_hash = {}
+    portfolios.each do |portfolio|
+      @portfolio_hash[portfolio.name] = portfolio
+    end
+    @portfolio_hash
+  end
+
+  # @return [PortfolioClass] Portfolio named +name+
+  # @return [nil] if there is no Portfolio named +name+
+  def portfolio(name)
+    portfolio_hash[name]
   end
 
   # @return [Array<ExceptionCode>] All exception codes defined by the spec

lib/cfg_arch.rb

@@ -1,28 +1,9 @@
 # frozen_string_literal: true
 
-# Many classes have an "cfg_arch" member which is an ConfiguredArchitecture (not DatabaseObject) class.
-# The "cfg_arch" member contains the "database" of RISC-V standards including extensions, instructions,
-# CSRs, Profiles, and Certificates.
-#
-# The cfg_arch member has methods such as:
-#   extensions()                Array<Extension> of all extensions known to the database (even if not implemented).
-#   extension(name)             Extension object for "name" and nil if none.
-#   parameters()                Array<ExtensionParameter> of all parameters defined in the architecture
-#   param(name)                 ExtensionParameter object for "name" and nil if none.
-#   csrs()                      Array<Csr> of all CSRs defined by RISC-V, whether or not they are implemented
-#   csr(name)                   Csr object for "name" and nil if none.
-#   instructions()              Array<Instruction> of all instructions, whether or not they are implemented
-#   inst(name)                  Instruction object for "name" and nil if none.
-#   profile_classes             Array<ProfileClass> of all known profile classes.
-#   profile_class(class_name)   ProfileClass object for "class_name" and nil if none.
-#   profile_releases            Array<ProfileRelease> of all profile releases for all profile classes
-#   profile_release(release_name) ProfileRelease object for "release_name" and nil if none.
-#   profiles                    Array<Profile> of all profiles in all releases in all classes
-#   profile(name)               Profile object for profile "name" and nil if none.
-#   cert_classes                Array<CertClass> of all known certificate classes
-#   cert_class(name)            CertClass object for "name" and nil if none.
-#   cert_models                 Array<CertModel> of all known certificate models across all classes.
-#   cert_model(name)            CertModel object for "name" and nil if none.
+# Many classes have an "cfg_arch" member which is an ConfiguredArchitecture class.
+# It combines knowledge of the RISC-V Architecture with a particular configuration.
+# A configuration is an instance of the Config object either located in the /cfg directory
+# or created at runtime for things like profiles and certificate models.
 
 require "forwardable"
 require "ruby-prof"

lib/config.rb

@@ -2,7 +2,8 @@
 
 require "pathname"
 
-# this class represents a configuration file (e.g., cfgs/*/cfg.yaml), independent of the Architecture
+# This class represents a configuration file (e.g., cfgs/*/cfg.yaml), independent of the Architecture.
+# Can either be in the /cfg directory or created at runtime in memory by the certificate tasks.rake file.
 class Config
   # @return [Hash<String, Object>] A hash mapping parameter name to value for any parameter that has
   #                                been configured with a value. May be empty.