Remove unneccessary concepts of base from architecture and portfolios (especially rakefiles). Now use cfg "_" instead of rv32 or rv64 since there really is no difference in the generated design.

Author: james-ball-qualcomm

Rakefile

@@ -15,50 +15,17 @@ require_relative $root / "lib" / "portfolio_design"
 
 directory "#{$root}/.stamps"
 
+# Load and execute Rakefile for each backend.
 Dir.glob("#{$root}/backends/*/tasks.rake") do |rakefile|
+  puts "UPDATE: Loading #{rakefile}"
   load rakefile
 end
 
 directory "#{$root}/.stamps"
 
-# @param base_isa_name [String] rv32 or rv64
-# @param base [Integer] 32 or 64
-# @return [Architecture]
-def arch_for(base_isa_name, base)
-  Rake::Task["#{$root}/.stamps/resolve-#{base_isa_name}.stamp"].invoke
-
-  @archs ||= {}
-  return @archs[base_isa_name] if @archs.key?(base_isa_name)
-
-  @archs[base_isa_name] =
-    Architecture.new(
-      base_isa_name,
-      base,
-      $root / "gen" / "resolved_arch" / base_isa_name,
-    )
-end
-
-# @param design_name [String] Profile release name for profiles and processor certificate model name for certificates
-# @param arch [Architecture] The architecture database
-# @param base [Integer] 32 or 64
-# @param portfolios [Array<Portfolio>] Portfolios in this design
-# @return [PortfolioDesign]
-def portfolio_design_for(design_name, arch, base, portfolios)
-  Rake::Task["#{$root}/.stamps/resolve-#{design_name}.stamp"].invoke
-
-  @portfolio_designs ||= {}
-  return @portfolio_designs[design_name] if @portfolio_designs.key?(design_name)
-
-  @portfolio_designs[design_name] =
-    PortfolioDesign.new(
-      design_name,
-      arch,
-      base,
-      portfolios
-    )
-end
-
-def cfg_arch_for(config_name, base = nil)
+# @param config_name [String] Name of configuration
+# @return [ConfiguredArchitecture]
+def cfg_arch_for(config_name)
   Rake::Task["#{$root}/.stamps/resolve-#{config_name}.stamp"].invoke
 
   @cfg_archs ||= {}
@@ -67,7 +34,6 @@ def cfg_arch_for(config_name, base = nil)
   @cfg_archs[config_name] =
     ConfiguredArchitecture.new(
       config_name,
-      base,
       $root / "gen" / "resolved_arch" / config_name,
       overlay_path: $root / "cfgs" / config_name / "arch_overlay"
     )
@@ -157,18 +123,18 @@ namespace :test do
   end
   task schema: "gen:resolved_arch" do
     puts "Checking arch files against schema.."
-    Architecture.new("rv64", nil, "#{$root}/resolved_arch").validate(show_progress: true)
+    Architecture.new("rv64", "#{$root}/resolved_arch").validate(show_progress: true)
     puts "All files validate against their schema"
   end
   task idl: ["gen:resolved_arch", "#{$root}/.stamps/resolve-rv32.stamp", "#{$root}/.stamps/resolve-rv64.stamp"]  do
     print "Parsing IDL code for RV32..."
-    cfg_arch32 = cfg_arch_for("rv32", 32)
+    cfg_arch32 = cfg_arch_for("rv32")
     puts "done"
 
     cfg_arch32.type_check
 
     print "Parsing IDL code for RV64..."
-    cfg_arch64 = cfg_arch_for("rv64", 64)
+    cfg_arch64 = cfg_arch_for("rv64")
     puts "done"
 
     cfg_arch64.type_check

backends/crd/tasks.rake

@@ -7,6 +7,8 @@ require "asciidoctor-diagram"
 
 require_relative "#{$lib}/idl/passes/gen_adoc"
 
+puts "UPDATE: Inside crd tasks.rake"
+
 CERT_DOC_DIR = Pathname.new "#{$root}/backends/crd"
 
 Dir.glob("#{$root}/arch/proc_cert_model/*.yaml") do |f|
@@ -15,13 +17,6 @@ Dir.glob("#{$root}/arch/proc_cert_model/*.yaml") do |f|
   proc_cert_class_name = File.basename(proc_cert_model_obj['class']['$ref'].split("#")[0], ".yaml")
   raise "Ill-formed processor certificate model file #{f}: missing 'class' field" if proc_cert_model_obj['class'].nil?
 
-  base = proc_cert_model_obj["base"]
-  raise "Missing processor certificate model base" if base.nil?
-
-  base_isa_name = "rv#{base}"
-
-  puts "UPDATE: Extracted base=#{base} from #{f}"
-
   file "#{$root}/gen/crd/adoc/#{proc_cert_model_name}.adoc" => [
     __FILE__,
     "#{$root}/arch/proc_cert_class/#{proc_cert_class_name}.yaml",
@@ -32,19 +27,22 @@ Dir.glob("#{$root}/arch/proc_cert_model/*.yaml") do |f|
     "#{$root}/lib/design.rb",
     "#{CERT_DOC_DIR}/templates/crd.adoc.erb"
   ] do |t|
-    # Create Architecture object. Function located in top-level Rakefile.
-    puts "UPDATE: Creating Architecture #{base_isa_name} for #{t}"
-    arch = arch_for(base_isa_name, base)
+    # Ensure that unconfigured resolved architecture called "_" exists.
+    Rake::Task["#{$root}/.stamps/resolve-_.stamp"].invoke
+
+    # Create architecture object so we can have it create the ProcCertModel.
+    # Use the unconfigured resolved architecture called "_".
+    arch = Architecture.new("RISC-V Architecture", $root / "gen" / "resolved_arch" / "_")
 
     # Create ProcCertModel for specific processor certificate model as specified in its arch YAML file.
     # The Architecture object also creates all other portfolio-related class instances from their arch YAML files.
     # None of these objects are provided with a Design object when created.
-    puts "UPDATE: Creating ProcCertModel for #{proc_cert_model_name} using base #{base_isa_name}"
+    puts "UPDATE: Creating ProcCertModel for #{proc_cert_model_name}"
     proc_cert_model = arch.proc_cert_model(proc_cert_model_name)
 
     puts "UPDATE: Creating PortfolioDesign using processor certificate model #{proc_cert_model_name}"
     # Create the one PortfolioDesign object required for the ERB evaluation.
-    portfolio_design = portfolio_design_for(proc_cert_model_name, arch, base, [proc_cert_model])
+    portfolio_design = PortfolioDesign.new(proc_cert_model_name, arch, [proc_cert_model])
 
     # Create empty binding and then specify explicitly which variables the ERB template can access.
     # Seems to use this method name in stack backtraces (hence its name).

backends/profile_doc/tasks.rake

@@ -7,6 +7,8 @@ require "asciidoctor-diagram"
 
 require_relative "#{$lib}/idl/passes/gen_adoc"
 
+puts "UPDATE: Inside profile_doc tasks.rake"
+
 PROFILE_DOC_DIR = Pathname.new "#{$root}/backends/profile_doc"
 
 Dir.glob("#{$root}/arch/profile_release/*.yaml") do |f|
@@ -22,29 +24,8 @@ Dir.glob("#{$root}/arch/profile_release/*.yaml") do |f|
   profile_names = profile_release_obj['profiles'].map {|p| File.basename(p['$ref'].split("#")[0], ".yaml") }
   raise "Ill-formed profile release file #{f}: can't parse profile names" if profile_names.nil?
 
-  # Find maximum base across all profiles in the profile release.
-  max_base = nil
-  profile_names.each do |profile_name|
-    profile_pathname = "#{$root}/arch/profile/#{profile_name}.yaml"
-    profile_obj = YAML.load_file(profile_pathname, permitted_classes: [Date])
-    raise "Can't parse #{profile_name}" if profile_obj.nil?
-
-    base = profile_obj["base"]
-    raise "Missing profile base in #{profile}" if base.nil?
-
-    puts "UPDATE: Extracted base=#{base} from #{f}"
-
-    max_base = base if (max_base.nil? || base > max_base)
-  end
-  raise "Couldn't find max_base in the profiles #{profile_names}" if max_base.nil?
-  puts "UPDATE:   Calculated max_base=#{max_base} across profiles in #{profile_release_name}"
-
   profile_pathnames = profile_names.map {|profile_name| "#{$root}/arch/profile/#{profile_name}.yaml" }
 
-  # Just go with maximum base since it is the most inclusive.
-  base = max_base
-  base_isa_name = "rv#{base}"
-
   file "#{$root}/gen/profile_doc/adoc/#{profile_release_name}.adoc" => [
     __FILE__,
     "#{$root}/arch/profile_class/#{profile_class_name}.yaml",
@@ -55,20 +36,23 @@ Dir.glob("#{$root}/arch/profile_release/*.yaml") do |f|
     "#{$root}/lib/design.rb",
     "#{PROFILE_DOC_DIR}/templates/profile.adoc.erb"
   ].concat(profile_pathnames) do |t|
-    # Create Architecture object. Function located in top-level Rakefile.
-    puts "UPDATE: Creating Architecture #{base_isa_name} for #{t}"
-    arch = arch_for(base_isa_name, base)
+    # Ensure that unconfigured resolved architecture called "_" exists.
+    Rake::Task["#{$root}/.stamps/resolve-_.stamp"].invoke
+
+    # Create architecture object so we can have it create the ProcCertModel.
+    # Use the unconfigured resolved architecture called "_".
+    arch = Architecture.new("RISC-V Architecture", $root / "gen" / "resolved_arch" / "_")
 
     # Create PortfolioRelease for specific portfolio release as specified in its arch YAML file.
     # The Architecture object also creates all other portfolio-related class instances from their arch YAML files.
     # None of these objects are provided with a Design object when created.
-    puts "UPDATE: Creating Profile Release for #{profile_release_name} using #{base_isa_name}"
+    puts "UPDATE: Creating Profile Release for #{profile_release_name}"
     profile_release = arch.profile_release(profile_release_name)
 
-    puts "UPDATE: Creating PortfolioDesign using profile release #{profile_release_name}"
     # Create the one PortfolioDesign object required for the ERB evaluation.
     # Provide it with all the profiles in this ProfileRelease.
-    portfolio_design = portfolio_design_for(profile_release_name, arch, base, profile_release.profiles)
+    puts "UPDATE: Creating PortfolioDesign using profile release #{profile_release_name}"
+    portfolio_design = PortfolioDesign.new(profile_release_name, arch, profile_release.profiles)
 
     # Create empty binding and then specify explicitly which variables the ERB template can access.
     # Seems to use this method name in stack backtraces (hence its name).

lib/architecture.rb

@@ -53,26 +53,16 @@ class Architecture
   # @return [String] Best name to identify architecture
   attr_reader :name
 
-  # @return [Integer] 32 for RV32I or 64 for RV64I
-  attr_reader :base
-
   # @return [Pathname] Path to the directory containing YAML files defining the RISC-V standards
   attr_reader :path
 
   # Initialize a new architecture definition
   #
   # @param name [#to_s] The name associated with this architecture
-  # @param base [Integer] RISC-V base ISA width (32 for RV32I/RV32E, 64 for RV64I, nil if unknown)
   # @param arch_dir [String, Pathname] Path to a directory with a fully merged/resolved architecture definition
-  def initialize(name, base, arch_dir)
+  def initialize(name, arch_dir)
     @name = name.to_s.freeze
 
-    unless base.nil?
-      raise "Unsupported base ISA value of #{base}. Supported values are 32 or 64." unless base == 32 || base == 64
-    end
-    @base = base
-    @base.freeze
-
     @arch_dir = Pathname.new(arch_dir)
     raise "Architecture directory #{arch_dir} not found" unless @arch_dir.exist?
 

lib/cfg_arch.rb

@@ -22,18 +22,12 @@ class ConfiguredArchitecture < Design
     :fully_configured?, :partially_configured?, :unconfigured?, :configured?, :param_values
 
   # @param config_name [#to_s] The configuration name which corresponds to a folder name under cfg_path
-  # @param base [Integer] RISC-V base ISA width (32 for RV32I/RV32E, 64 for RV64I, nil if unknown)
   # @param arch_dir [String,Pathname] Path to a directory with a fully merged/resolved architecture definition
   # @param overlay_path [String] Optional path to a directory that overlays the architecture
   # @param cfg_path [String] Optional path to where to find configuration file
-  def initialize(config_name, base, arch_dir, overlay_path: nil, cfg_path: "#{$root}/cfgs")
+  def initialize(config_name, arch_dir, overlay_path: nil, cfg_path: "#{$root}/cfgs")
     @config = Config.create("#{cfg_path}/#{config_name}/cfg.yaml")
-    @mxlen = @config.mxlen
-    @mxlen.freeze
-
-    arch = Architecture.new(config_name, base, arch_dir)
-
-    super(config_name, arch, overlay_path: overlay_path)
+    super(config_name, Architecture.new(config_name, arch_dir), @config.mxlen, overlay_path: overlay_path)
   end
 
   # Returns a string representation of the object, suitable for debugging.
@@ -46,9 +40,6 @@ def inspect = "ConfiguredArchitecture##{name}"
   # These raise an error in the base class. #
   ###########################################
 
-  # @return [Integer] 32, 64, or nil if dynamic or undefined.
-  def mxlen = @mxlen
-
   # Returns whether or not it may be possible to switch XLEN in +mode+ given this definition.
   #
   # There are three cases when this will return true:

lib/design.rb

@@ -43,6 +43,9 @@ class Design < IDesign
   # @return [Architecture] The RISC-V architecture
   attr_reader :arch
 
+  # @return [Integer] 32, 64, or nil for dynamic
+  attr_reader :mxlen
+
   # @return [Idl::Compiler] The IDL compiler
   attr_reader :idl_compiler
 
@@ -58,12 +61,17 @@ def hash = @name_sym.hash
 
   # @param name [#to_s] The design name
   # @param arch [Architecture] The entire architecture
+  # @param mxlen [Integer] 32, 64, or nil for dynamic
   # @param overlay_path [String] Optional path to a directory that overlays the architecture
-  def initialize(name, arch, overlay_path: nil)
+  def initialize(name, arch, mxlen, overlay_path: nil)
     super(name)
 
     raise ArgumentError, "arch must be an Architecture but is a #{arch.class}" unless arch.is_a?(Architecture)
     @arch = arch
+
+    @mxlen = mxlen
+    @mxlen.freeze
+
     @idl_compiler = Idl::Compiler.new
     @symtab = Idl::SymbolTable.new(self)
     custom_globals_path = overlay_path.nil? ? Pathname.new("/does/not/exist") : overlay_path / "isa" / "globals.isa"

lib/portfolio_design.rb

@@ -21,23 +21,18 @@ class PortfolioDesign < Design
   # @param mxlen [Integer] Comes from portfolio YAML "base" (either 32 or 64)
   # @param portfolios [Array<Portfolio>] Portfolios being converted to adoc
   # @param overlay_path [String] Optional path to a directory that overlays the architecture
-  def initialize(base_isa_name, arch, base, portfolios, overlay_path: nil)
-    raise ArgumentError, "base must be 32 or 64 but is #{base}" unless (base == 32 || base == 64)
+  def initialize(base_isa_name, arch, portfolios, overlay_path: nil)
     raise ArgumentError, "arch must be an Architecture but is a #{arch.class}" unless arch.is_a?(Architecture)
     raise ArgumentError, "portfolios must be an Array<Portfolio> but is a #{portfolios.class}" unless portfolios.is_a?(Array)
 
-    @mxlen = base
-    @mxlen.freeze
-
     # The PortfolioGroup has an Array<Portfolio> inside it and forwards common Array methods to its internal Array.
     # Can call @portfolio_grp.each or @portfolio_grp.map and they are handled by the normal Array methods.
     @portfolio_grp = PortfolioGroup.new(portfolios)
 
-    # Sanity check base passed in to me.
     max_base = portfolios.map(&:base).max
-    raise ArgumentError, "Provided base of #{base} but maximum base across all provided portfolios is #{max_base}" unless base == max_base
+    raise ArgumentError, "Calculated maximum base of #{max_base} across portfolios is not 32 or 64" unless max_base == 32 || max_base == 64
 
-    super(base_isa_name, arch, overlay_path: overlay_path)
+    super(base_isa_name, arch, max_base, overlay_path: overlay_path)
   end
 
   # Returns a string representation of the object, suitable for debugging.
@@ -48,9 +43,6 @@ def inspect = "PortfolioDesign##{name}"
   # METHODS REQUIRED BY BASE CLASS #
   ##################################
 
-  # @return [Integer] 32 or 64. Might be nil if dynamic (not sure if dynamic required for portfolios).
-  def mxlen = @mxlen
-
   # Returns whether or not it may be possible to switch XLEN in +mode+ given this definition.
   #
   # There are three cases when this will return true: