Finally able to generate MC100-32 PDF and it looks good.

Author: james-ball-qualcomm

Rakefile

@@ -10,6 +10,9 @@ require "yard"
 require "minitest/test_task"
 
 require_relative $root / "lib" / "architecture"
+require_relative $root / "lib" / "base_architecture"
+require_relative $root / "lib" / "design"
+require_relative $root / "lib" / "portfolio_design"
 
 directory "#{$root}/.stamps"
 
@@ -19,6 +22,43 @@ end
 
 directory "#{$root}/.stamps"
 
+# @param base_isa_name [String] rv32 or rv64
+# @param base [Integer] 32 or 64
+# @return [BaseArchitecture]
+def base_arch_for(base_isa_name, base)
+  Rake::Task["#{$root}/.stamps/resolve-#{base_isa_name}.stamp"].invoke
+
+  @base_archs ||= {}
+  return @base_archs[base_isa_name] if @base_archs.key?(base_isa_name)
+
+  @base_archs[base_isa_name] =
+    BaseArchitecture.new(
+      base_isa_name,
+      base,
+      $root / "gen" / "resolved_arch" / base_isa_name,
+    )
+end
+
+# @param design_name [String] Profile release name for profiles and 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)
   Rake::Task["#{$root}/.stamps/resolve-#{config_name}.stamp"].invoke
 
@@ -117,6 +157,7 @@ namespace :test do
   end
   task schema: "gen:resolved_arch" do
     puts "Checking arch files against schema.."
+    # TODO: Needs to pass in base ISA name (rv32 or rv64).
     Architecture.new("#{$root}/resolved_arch").validate(show_progress: true)
     puts "All files validate against their schema"
   end

arch/profile_release/MockProfileRelease.yaml

@@ -2,7 +2,8 @@ $schema: profile_release_schema.json#
 kind: profile release
 name: MockProfileRelease
 marketing_name: MockProfileRelease Marketing Name
-class: MockProfileClass
+class:
+  $ref: profile_class/MockProfileClass.yaml#
 release: 20
 state: ratified # current status ["ratified", "development"]
 versions:

arch/profile_release/RVA20.yaml

@@ -2,7 +2,8 @@ $schema: profile_release_schema.json#
 kind: profile release
 name: RVA20
 marketing_name: RVA20
-class: RVA
+class:
+  $ref: profile_class/RVA.yaml#
 release: 20
 state: ratified # current status ["ratified", "development"]
 ratification_date: "2023-04-03"

arch/profile_release/RVA22.yaml

@@ -2,7 +2,8 @@ $schema: profile_release_schema.json#
 kind: profile release
 name: RVA22
 marketing_name: RVA22
-class: RVA
+class:
+  $ref: profile_class/RVA.yaml#
 release: 22
 state: ratified # current status ["ratified", "development"]
 ratification_date: "2023-04-03"

arch/profile_release/RVA23.yaml

@@ -1,8 +1,9 @@
-$schema: profile_schema.json#
-kind: profile
+$schema: profile_release_schema.json#
+kind: profile release
 name: RVA23
 marketing_name: RVA23
-class: RVA
+class:
+  $ref: profile_class/RVA.yaml#
 release: 23
 state: ratified # current status ["ratified", "development"]
 ratification_date: "2023-04-03"

arch/profile_release/RVB23.yaml

@@ -1,8 +1,9 @@
-$schema: profile_schema.json#
-kind: profile
+$schema: profile_release_schema.json#
+kind: profile release
 name: RVB23
 marketing_name: RVB23
-class: RVB
+class:
+  $ref: profile_class/RVA.yaml#
 release: 23
 state: ratified # current status ["ratified", "development"]
 ratification_date: "2023-04-03"

arch/profile_release/RVI20.yaml

@@ -2,8 +2,9 @@ $schema: profile_release_schema.json#
 kind: profile release
 name: RVI20
 marketing_name: RVI20
-class: RVI
-release: 20
+class:
+  $ref: profile_class/RVI.yaml#
+base: null
 state: ratified # current status ["ratified", "development"]
 ratification_date: "2023-04-03"
 

backends/certificate_doc/tasks.rake

@@ -18,58 +18,66 @@ Dir.glob("#{$root}/arch/certificate_model/*.yaml") do |f|
   base = cert_model_obj["base"]
   raise "Missing certificate model base" if base.nil?
 
+  base_isa_name = "rv#{base}"
+
+  puts "UPDATE: Extracted base=#{base} from #{f}"
+
   file "#{$root}/gen/certificate_doc/adoc/#{cert_model_name}.adoc" => [
-    "#{$root}/arch/certificate_model/#{cert_model_name}.yaml",
+    __FILE__,
     "#{$root}/arch/certificate_class/#{cert_class_name}.yaml",
-    "#{CERT_DOC_DIR}/templates/certificate.adoc.erb",
-    __FILE__
+    "#{$root}/arch/certificate_model/#{cert_model_name}.yaml",
+    "#{$root}/lib/arch_obj_models/certificate.rb",
+    "#{$root}/lib/arch_obj_models/portfolio.rb",
+    "#{$root}/lib/portfolio_design.rb",
+    "#{$root}/lib/design.rb",
+    "#{CERT_DOC_DIR}/templates/certificate.adoc.erb"
   ] do |t|
-    puts "UPDATE: Creating bootstrap objects for #{cert_model_name}"
-
-    # Create bootstrap ConfiguredArchitecture object which also creates and contains
-    # a PartialConfig object for the rv32/rv64 configuration.
-    bootstrap_cfg_arch = cfg_arch_for("rv#{base}")
-
-    # Creates CertModel object for every certificate model in the database
-    # using rv32/rv64 PartialConfig object and then returns named CertModel object.
-    bootstrap_cert_model = bootstrap_cfg_arch.cert_model(cert_model_name)
-    raise "No certificate model named '#{cert_model_name}'" if bootstrap_cert_model.nil?
-
-    puts "UPDATE: Creating real objects for #{cert_model_name}"
-
-    # Use bootstrap CertModel to create a ConfiguredArchitecture for this CertModel
-    # to use instead of the the bootstrap one created based on the rv32/rv64 configuration.
-    cfg_arch = bootstrap_cert_model.to_cfg_arch
-
-    # Use model-specific ConfiguredArchitecture to create CertModel objects again
-    # for every certificate model in the database and then return named CertModel object.
-    cert_model = cfg_arch.cert_model(cert_model_name)
-
-    # Set globals for ERB template.
-    portfolio = cert_model
-    cert_class = cert_model.cert_class
-    portfolio = cert_model
-    portfolio_class = cert_class
-
-    version = File.basename(t.name, '.adoc').split('-')[1..].join('-')
-
-    erb = ERB.new(File.read("#{CERT_DOC_DIR}/templates/certificate.adoc.erb"), trim_mode: "-")
-    erb.filename = "#{CERT_DOC_DIR}/templates/certificate.adoc.erb"
+    # Create BaseArchitecture object. Function located in top-level Rakefile.
+    puts "UPDATE: Creating BaseArchitecture #{base_isa_name} for #{t}"
+    base_arch = base_arch_for(base_isa_name, base)
+
+    # Create CertModel for specific 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 CertModel for #{cert_model_name} using base #{base_isa_name}"
+    cert_model = base_arch.cert_model(cert_model_name)
+
+    puts "UPDATE: Creating PortfolioDesign using CertModel #{cert_model_name}"
+    # Create the one PortfolioDesign object required for the ERB evaluation.
+    portfolio_design = portfolio_design_for(cert_model_name, base_arch, base, [cert_model])
+
+    # 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(:arch, base_arch)
+    erb_binding.local_variable_set(:design, portfolio_design)
+    erb_binding.local_variable_set(:cert_class, cert_model.cert_class)
+    erb_binding.local_variable_set(:portfolio_class, cert_model.cert_class)
+    erb_binding.local_variable_set(:cert_model, cert_model)
+    erb_binding.local_variable_set(:portfolio, cert_model)
+
+    template_path = Pathname.new("#{CERT_DOC_DIR}/templates/certificate.adoc.erb")
+    erb = ERB.new(File.read(template_path), trim_mode: "-")
+    erb.filename = template_path.to_s
 
     FileUtils.mkdir_p File.dirname(t.name)
 
     # Convert ERB to final ASCIIDOC. Note that this code is broken up into separate function calls
     # each with a variable name to aid in running a command-line debugger on this code.
-    erb_result = erb.result(binding)
-    erb_result_monospace_converted_to_links = cfg_arch.find_replace_links(erb_result)
-    erb_result_with_links_added = cfg_arch.find_replace_links(erb_result_monospace_converted_to_links)
+    puts "UPDATE: Converting ERB template to adoc for #{cert_model_name}"
+    erb_result = erb.result(erb_binding)
+    erb_result_monospace_converted_to_links = portfolio_design.find_replace_links(erb_result)
+    erb_result_with_links_added = portfolio_design.find_replace_links(erb_result_monospace_converted_to_links)
     erb_result_with_links_resolved = AsciidocUtils.resolve_links(erb_result_with_links_added)
 
-    File.write t.name, erb_result_with_links_resolved
-    puts "Generated adoc source at #{t.name}"
+    File.write(t.name, erb_result_with_links_resolved)
+    puts "UPDATE: Generated adoc source at #{t.name}"
   end
 
   file "#{$root}/gen/certificate_doc/pdf/#{cert_model_name}.pdf" => [
+    __FILE__,
     "#{$root}/gen/certificate_doc/adoc/#{cert_model_name}.adoc"
   ] do |t|
     adoc_file = "#{$root}/gen/certificate_doc/adoc/#{cert_model_name}.adoc"
@@ -88,13 +96,17 @@ Dir.glob("#{$root}/arch/certificate_model/*.yaml") do |f|
       "-o #{t.name}",
       adoc_file
     ].join(" ")
+    puts "UPDATE: Generated PDF at #{t.name}"
   end
 
   file "#{$root}/gen/certificate_doc/html/#{cert_model_name}.html" => [
+    __FILE__,
     "#{$root}/gen/certificate_doc/adoc/#{cert_model_name}.adoc"
   ] do |t|
     adoc_file = "#{$root}/gen/certificate_doc/adoc/#{cert_model_name}.adoc"
     FileUtils.mkdir_p File.dirname(t.name)
+
+    puts "UPDATE: Generating PDF at #{t.name}"
     sh [
       "asciidoctor",
       "-w",
@@ -107,29 +119,30 @@ Dir.glob("#{$root}/arch/certificate_model/*.yaml") do |f|
       "-o #{t.name}",
       adoc_file
     ].join(" ")
+    puts "UPDATE: Generated PDF at #{t.name}"
   end
-
 end
 
 namespace :gen do
   desc <<~DESC
-    Generate certificate documentation for a specific version as a PDF
+    Generate certificate documentation for a specific version as a PDF.
 
     Required options:
       cert_model_name - The key of the certification model under arch/certificate_model
   DESC
   task :cert_model_pdf, [:cert_model_name] do |_t, args|
-    if args[:cert_model_name].nil?
+    cert_model_name = args[:cert_model_name]
+    if cert_model_name.nil?
       warn "Missing required option: 'cert_model_name'"
       exit 1
     end
 
-    unless File.exist?("#{$root}/arch/certificate_model/#{args[:cert_model_name]}.yaml")
-      warn "No certification model named '#{args[:cert_model_name]}' found in arch/certificate_model"
+    unless File.exist?("#{$root}/arch/certificate_model/#{cert_model_name}.yaml")
+      warn "No certification model named '#{cert_model_name}' found in arch/certificate_model"
       exit 1
     end
 
-    Rake::Task["#{$root}/gen/certificate_doc/pdf/#{args[:cert_model_name]}.pdf"].invoke
+    Rake::Task["#{$root}/gen/certificate_doc/pdf/#{cert_model_name}.pdf"].invoke
   end
 
   task :cert_model_html, [:cert_model_name] do |_t, args|