Raise error if portfilio created with cfg_arch with wrong base size (it happens and will need to be fixed).

Author: james-ball-qualcomm

.vscode/launch.json

@@ -3,10 +3,10 @@
   "configurations": [
     {
       "type": "rdbg",
-      "name": "RVA20",
+      "name": "MC100-32",
       "request": "launch",
       "command": "bundle exec rake",
-      "script": "gen:profile[RVA20]",
+      "script": "gen:cert_model_pdf[MC100-32]",
       "args": [],
       "askParameters": false
     },
@@ -18,6 +18,15 @@
       "script": "gen:cert_model_pdf[MC200-32]",
       "args": [],
       "askParameters": false
+    },
+    {
+      "type": "rdbg",
+      "name": "RVA20",
+      "request": "launch",
+      "command": "bundle exec rake",
+      "script": "gen:profile[RVA20]",
+      "args": [],
+      "askParameters": false
     }
   ]
 }

backends/certificate_doc/tasks.rake

@@ -24,13 +24,16 @@ Dir.glob("#{$root}/arch/certificate_model/*.yaml") do |f|
     "#{CERT_DOC_DIR}/templates/certificate.adoc.erb",
     __FILE__
   ] do |t|
-    # TODO: schema validation
+    # Create bootstrap ConfiguredArchitecture object which also creates and contains
+    # a PartialConfig object for the rv32/rv64 configuration.
     base_cfg_arch = cfg_arch_for("rv#{base}")
+
+    # Creates CertModel object for every certificate model in database
+    # using rv32/rv64 PartialConfig object and then returns named CertModel object.
     base_cert_model = base_cfg_arch.cert_model(cert_model_name)
     raise "No certificate model named '#{cert_model_name}'" if base_cert_model.nil?
 
-    # Ask base certification model to create an in-memory config arch for this model.
-    # XXX - Add this to profile releases
+    # Ask base certification model to create an in-memory ConfiguredArchitecture for this model.
     cfg_arch = base_cert_model.to_cfg_arch
 
     # Set globals for ERB template.

cert_flow.txt

@@ -0,0 +1,21 @@
+backends/certificate_doc/tasks.rake
+base_cfg_arch = cfg_arch_for("rv#{base}") 									# rv32 or rv64
+  Rakefile
+	Calls ConfiguredArchitecture.new("gen/resolved_arch/rv32")
+	  Calls Architecture.new 												# Parent class
+	  Calls Config.create("cfgs/rv32/cfg.yaml") 		# Factory class method
+		  Loads config yaml file into @data 					# File specifies if fully, partially, or unconfigured
+			Calls PartialConfig.new(cfg path, @data)		# Uses Ruby send() method
+				@mxlen = @data["params"].xlen
+		@name = "rv32"
+base_cert_model = base_cfg_arch.cert_model(cert_model_name = "MC100-32")
+	Calls self.generate_obj_methods("cert_model", "certificate_model", CertModel) in Architecture # Magic
+		Calls define_method("cert_model")
+			Calls define_method("cert_models")
+				Creates @cert_models array and @cert_model_hash # Per arch_dir
+				For every certificiate model in the database
+					Loads yaml under gen/resolved_arch/rv32 into @cert_models hash
+					Calls cert_model.new() -> DatabaseObject.initialize(yaml, yaml_path, arch=base_cfg_arch)
+						@data = yaml
+						@cfg_arch = arch 				# rv32 (nil if Architecture object provided)
+						@specification = arch 	# rv32

lib/arch_obj_models/certificate.rb

@@ -20,6 +20,17 @@ 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 < Portfolio
+  # @param obj_yaml [Hash<String, Object>] Contains contents of Certificate Model yaml file (put in @data)
+  # @param data_path [String] Path to yaml file
+  # @param cfg_arch [ConfiguredArchitecture] Architecture for a specific configuration
+  def initialize(obj_yaml, yaml_path, arch: nil)
+    super(obj_yaml, yaml_path, arch: arch)
+
+    unless arch.is_a?(ConfiguredArchitecture)
+      raise ArgumentError, "For #{name} arch is a #{arch.class} but must be a ConfiguredArchitecture"
+    end
+  end
+
   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/obj.rb

@@ -182,7 +182,7 @@ def definedBy
   # @param data [Hash<String,Object>] Hash with fields to be added
   # @param data_path [Pathname] Path to the data file
   def initialize(data, data_path, arch: nil)
-    raise "Bad data" unless data.is_a?(Hash)
+    raise ArgumentError, "Bad data" unless data.is_a?(Hash)
 
     @data = data
     @data_path = data_path

lib/arch_obj_models/portfolio.rb

@@ -52,6 +52,25 @@ def portfolio_classes_matching_portfolio_kind_and_processor_kind
 # Holds information about a Portfolio (certificate or profile).
 # The inherited "data" member is the database of extensions, instructions, CSRs, etc.
 class Portfolio < DatabaseObject
+  # @param obj_yaml [Hash<String, Object>] Contains contents of Portfolio yaml file (put in @data)
+  # @param data_path [String] Path to yaml file
+  # @param cfg_arch [ConfiguredArchitecture] Architecture for a specific configuration
+  def initialize(obj_yaml, yaml_path, arch: nil)
+    super(obj_yaml, yaml_path, arch: arch)
+
+    unless arch.is_a?(ConfiguredArchitecture)
+      raise ArgumentError, "For #{name} arch is a #{arch.class} but must be a ConfiguredArchitecture"
+    end
+
+    raise "For #{name} @data[\"base\"] is nil" if @data["base"].nil?
+    raise "For #{name} arch.mxlen is nil" if arch.mxlen.nil?
+
+    if (obj_yaml["base"] != arch.mxlen)
+      bad_base = obj_yaml["base"]
+      raise "For #{name} called with ConfigureArchitecture #{arch.name} with mxlen=#{arch.mxlen} but my base is #{bad_base}"
+    end
+  end
+
   # @return [ConfiguredArchitecture] The defining ConfiguredArchitecture
   attr_reader :cfg_arch
 
@@ -122,6 +141,10 @@ def extension_note(ext_name)
     return ext_data["note"] unless ext_data.nil?
   end
 
+  def mandatory_ext_reqs = in_scope_ext_reqs(ExtensionPresence.mandatory)
+  def optional_ext_reqs = in_scope_ext_reqs(ExtensionPresence.optional)
+  def optional_type_ext_reqs = in_scope_ext_reqs(ExtensionPresence.optional)
+
   # @param desired_presence [String, Hash, ExtensionPresence]
   # @return [Array<ExtensionRequirements>] - # Extensions with their portfolio information.
   # If desired_presence is provided, only returns extensions with that presence.
@@ -181,9 +204,16 @@ def in_scope_ext_reqs(desired_presence = nil)
     in_scope_ext_reqs
   end
 
-  def mandatory_ext_reqs = in_scope_ext_reqs(ExtensionPresence.mandatory)
-  def optional_ext_reqs = in_scope_ext_reqs(ExtensionPresence.optional)
-  def optional_type_ext_reqs = in_scope_ext_reqs(ExtensionPresence.optional)
+  # @return [Array<Instruction>] Sorted list of all instructions associated with extensions listed as
+  #                              mandatory or optional in portfolio. Uses minimum version of
+  #                              extension version that meets extension requirement specified in portfolio.
+  def in_scope_instructions
+    return @in_scope_instructions unless @in_scope_instructions.nil?
+
+    # XXX
+    # @in_scope_instructions = in_scope_ext_reqs.map { |ext_req| ext_req.instructions }.flatten.uniq.sort
+    @in_scope_instructions = in_scope_extensions.map { |ext| ext.instructions }.flatten.uniq.sort
+  end
 
   # @return [Array<Extension>] List of all extensions listed in portfolio.
   def in_scope_extensions
@@ -196,13 +226,6 @@ def in_scope_extensions
     @in_scope_extensions
   end
 
-  # @return [Array<Instruction>] Sorted list of all instructions associated with extensions listed as
-  #                              mandatory or optional in portfolio. Uses minimum version of
-  #                              extension version that meets extension requirement specified in portfolio.
-  def in_scope_instructions
-    in_scope_extensions.map { |ext| ext.instructions }.flatten.uniq.sort
-  end
-
   # @return [Boolean] Does the profile differentiate between different types of optional.
   def uses_optional_types?
     return @uses_optional_types unless @uses_optional_types.nil?
@@ -220,7 +243,7 @@ def uses_optional_types?
     @uses_optional_types
   end
 
-  # Called by rakefile when generating a particular portfolio instance.
+  # Called by rakefile when generating a portfolio.
   # Creates an in-memory data structure used by all portfolio routines that access a cfg_arch.
   #
   # @return [ConfiguredArchitecture] A partially-configured architecture definition corresponding to this portfolio.