Merge branch '346-revert-to-crd-terminology' into reduce-duplicate-erb-and-rake

Author: james-ball-qualcomm

.github/workflows/pages.yml

@@ -60,33 +60,37 @@ jobs:
       - name: Copy cfg html
         run: cp -R gen/cfg_html_doc/generic_rv64/html _site/example_cfg
       - name: Create RVA20 Profile Release PDF Spec
-        run: ./do gen:profile[RVA20]
+        run: ./do gen:profile_release_pdf[RVA20]
       - name: Copy RVA20 Profile Release PDF
         run: cp gen/profile_doc/pdf/RVA20.pdf _site/pdfs/RVA20.pdf
       - name: Create RVA22 Profile Release PDF Spec
-        run: ./do gen:profile[RVA22]
+        run: ./do gen:profile_release_pdf[RVA22]
       - name: Copy RVA22 Profile Release PDF
         run: cp gen/profile_doc/pdf/RVA22.pdf _site/pdfs/RVA22.pdf
+      - name: Copy RVA23 Profile Release PDF
+        run: cp gen/profile_doc/pdf/RVA23.pdf _site/pdfs/RVA23.pdf
+      - name: Copy RVB23 Profile Release PDF
+        run: cp gen/profile_doc/pdf/RVB23.pdf _site/pdfs/RVB23.pdf
       - name: Create RVI20 Profile Release PDF Spec
-        run: ./do gen:profile[RVI20]
+        run: ./do gen:profile_release_pdf[RVI20]
       - name: Copy RVI20 Profile Release PDF
         run: cp gen/profile_doc/pdf/RVA20.pdf _site/pdfs/RVI20.pdf
       - name: Create MC100-32 PDF Spec
-        run: ./do gen:cert_model_pdf[MC100-32]
+        run: ./do gen:proc_cert_model_pdf[MC100-32]
       - name: Copy MC100-32 PDF
-        run: cp gen/certificate_doc/pdf/MC100-32.pdf _site/pdfs/MC100-32.pdf
+        run: cp gen/crd/pdf/MC100-32.pdf _site/pdfs/MC100-32.pdf
       - name: Create MC100-32 HTML Spec
-        run: ./do gen:cert_model_html[MC100-32]
+        run: ./do gen:proc_cert_model_html[MC100-32]
       - name: Copy MC100-32 HTML
-        run: cp gen/certificate_doc/html/MC100-32.html _site/htmls/MC100-32.html
+        run: cp gen/crd/html/MC100-32.html _site/htmls/MC100-32.html
       - name: Create MC100-64 PDF Spec
-        run: ./do gen:cert_model_pdf[MC100-64]
+        run: ./do gen:proc_cert_model_pdf[MC100-64]
       - name: Copy MC100-64 PDF
-        run: cp gen/certificate_doc/pdf/MC100-64.pdf _site/pdfs/MC100-64.pdf
+        run: cp gen/crd/pdf/MC100-64.pdf _site/pdfs/MC100-64.pdf
       - name: Create MC100-64 HTML Spec
-        run: ./do gen:cert_model_html[MC100-64]
+        run: ./do gen:proc_cert_model_html[MC100-64]
       - name: Copy MC100-64 HTML
-        run: cp gen/certificate_doc/html/MC100-64.html _site/htmls/MC100-64.html
+        un: cp gen/crd/html/MC100-64.html _site/htmls/MC100-64.html
       - name: Copy manual html
         run: cp -R gen/manual/isa/top/all/html _site/manual
       - name: Setup Pages

.github/workflows/regress.yml

@@ -131,7 +131,7 @@ jobs:
         name: Build container
         run: ./bin/build_container
       - name: Generate extension PDF
-        run: ./do gen:cert_model_pdf[MockCertificateModel]
+        run: ./do gen:proc_cert_model_pdf[MockProcCertModel]
   regress-gen-profile:
     runs-on: ubuntu-latest
     needs: regress-smoke
@@ -160,4 +160,4 @@ jobs:
         name: Build container
         run: ./bin/build_container
       - name: Generate extension PDF
-        run: ./do gen:profile[MockProfileRelease]
+        run: ./do gen:profile_release_pdf[MockProfileRelease]

.gitignore

@@ -15,5 +15,6 @@ resolved_arch
 node_modules
 _site
 images
+*.bak
 *.log
 *.bak

.pre-commit-config.yaml

@@ -46,12 +46,12 @@ repos:
         args: ["--schemafile", "schemas/ext_schema.json"]
       - id: check-jsonschema
         alias: check-jsonschema-cert-model
-        files: ^arch/certificate_model/.*\.(yaml|yml)$
-        args: ["--schemafile", "schemas/cert_model_schema.json"]
+        files: ^arch/proc_cert_model/.*\.(yaml|yml)$
+        args: ["--schemafile", "schemas/proc_cert_model_schema.json"]
       - id: check-jsonschema
         alias: check-jsonschema-cert-class
-        files: ^arch/certificate_class/.*\.(yaml|yml)$
-        args: ["--schemafile", "schemas/cert_class_schema.json"]
+        files: ^arch/proc_cert_class/.*\.(yaml|yml)$
+        args: ["--schemafile", "schemas/proc_cert_class_schema.json"]
       # Commenting because throwing errors and not sure this is complete yet
       # - id: check-jsonschema
       #   alias: check-jsonschema-manual-version

.vscode/launch.json

@@ -6,7 +6,7 @@
       "name": "MC100-32",
       "request": "launch",
       "command": "bundle exec rake",
-      "script": "gen:cert_model_pdf[MC100-32]",
+      "script": "gen:proc_cert_model_pdf[MC100-32]",
       "args": [],
       "askParameters": false
     },
@@ -15,7 +15,16 @@
       "name": "MC200-32",
       "request": "launch",
       "command": "bundle exec rake",
-      "script": "gen:cert_model_pdf[MC200-32]",
+      "script": "gen:proc_cert_model_pdf[MC200-32]",
+      "args": [],
+      "askParameters": false
+    },
+    {
+      "type": "rdbg",
+      "name": "portfolios",
+      "request": "launch",
+      "command": "bundle exec rake",
+      "script": "portfolios",
       "args": [],
       "askParameters": false
     },
@@ -24,7 +33,16 @@
       "name": "RVA20",
       "request": "launch",
       "command": "bundle exec rake",
-      "script": "gen:profile[RVA20]",
+      "script": "gen:profile_release_pdf[RVA20]",
+      "args": [],
+      "askParameters": false
+    },
+    {
+      "type": "rdbg",
+      "name": "Smoke test",
+      "request": "launch",
+      "command": "bundle exec rake",
+      "script": "test:smoke",
       "args": [],
       "askParameters": false
     }

Rakefile

@@ -10,15 +10,21 @@ require "yard"
 require "minitest/test_task"
 
 require_relative $root / "lib" / "architecture"
+require_relative $root / "lib" / "design"
+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 config_name [String] Name of configuration
+# @return [ConfiguredArchitecture]
 def cfg_arch_for(config_name)
   Rake::Task["#{$root}/.stamps/resolve-#{config_name}.stamp"].invoke
 
@@ -117,7 +123,7 @@ namespace :test do
   end
   task schema: "gen:resolved_arch" do
     puts "Checking arch files against schema.."
-    Architecture.new("#{$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
@@ -289,9 +295,13 @@ namespace :test do
     These are basic but fast-running tests to check the database and tools
   DESC
   task :smoke do
+    puts "UPDATE: Running test:idl_compiler"
     Rake::Task["test:idl_compiler"].invoke
+    puts "UPDATE: Running test:lib"
     Rake::Task["test:lib"].invoke
+    puts "UPDATE: Running test:schema"
     Rake::Task["test:schema"].invoke
+    puts "UPDATE: Running test:idl"
     Rake::Task["test:idl"].invoke
   end
 
@@ -313,7 +323,7 @@ namespace :test do
 
     Rake::Task["gen:html"].invoke("generic_rv64")
 
-    Rake::Task["#{$root}/gen/certificate_doc/pdf/MockCertificateModel.pdf"].invoke
+    Rake::Task["#{$root}/gen/crd/pdf/MockProcCertModel.pdf"].invoke
     Rake::Task["#{$root}/gen/profile_doc/pdf/MockProfileRelease.pdf"].invoke
 
     puts
@@ -337,31 +347,31 @@ desc <<~DESC
   Generate all portfolio-based PDF artifacts (certificates and profiles)
 DESC
 task :portfolios do
-  portfolio_start_msg("MockCertificateModel")
-  Rake::Task["#{$root}/gen/certificate_doc/pdf/MockCertificateModel.pdf"].invoke
-  portfolio_start_msg("MockProfileRelease")
+  portfolio_start_msg("MockProcCertModel CRD")
+  Rake::Task["#{$root}/gen/crd/pdf/MockProcCertModel.pdf"].invoke
+  portfolio_start_msg("MockProfileRelease CRD")
   Rake::Task["#{$root}/gen/profile_doc/pdf/MockProfileRelease.pdf"].invoke
-  portfolio_start_msg("MC100-32")
-  Rake::Task["#{$root}/gen/certificate_doc/pdf/MC100-32.pdf"].invoke
-  portfolio_start_msg("MC100-64")
-  Rake::Task["#{$root}/gen/certificate_doc/pdf/MC100-64.pdf"].invoke
-  portfolio_start_msg("MC200-32")
-  Rake::Task["#{$root}/gen/certificate_doc/pdf/MC200-32.pdf"].invoke
-  portfolio_start_msg("MC200-64")
-  Rake::Task["#{$root}/gen/certificate_doc/pdf/MC200-64.pdf"].invoke
-  portfolio_start_msg("MC300-32")
-  Rake::Task["#{$root}/gen/certificate_doc/pdf/MC300-32.pdf"].invoke
-  portfolio_start_msg("MC300-64")
-  Rake::Task["#{$root}/gen/certificate_doc/pdf/MC300-64.pdf"].invoke
-  portfolio_start_msg("RVI20")
+  portfolio_start_msg("MC100-32 CRD")
+  Rake::Task["#{$root}/gen/crd/pdf/MC100-32.pdf"].invoke
+  portfolio_start_msg("MC100-64 CRD")
+  Rake::Task["#{$root}/gen/crd/pdf/MC100-64.pdf"].invoke
+  portfolio_start_msg("MC200-32 CRD")
+  Rake::Task["#{$root}/gen/crd/pdf/MC200-32.pdf"].invoke
+  portfolio_start_msg("MC200-64 CRD")
+  Rake::Task["#{$root}/gen/crd/pdf/MC200-64.pdf"].invoke
+  portfolio_start_msg("MC300-32 CRD")
+  Rake::Task["#{$root}/gen/crd/pdf/MC300-32.pdf"].invoke
+  portfolio_start_msg("MC300-64 CRD")
+  Rake::Task["#{$root}/gen/crd/pdf/MC300-64.pdf"].invoke
+  portfolio_start_msg("RVI20 Profile Release")
   Rake::Task["#{$root}/gen/profile_doc/pdf/RVI20.pdf"].invoke
-  portfolio_start_msg("RVA20")
+  portfolio_start_msg("RVA20 Profile Release")
   Rake::Task["#{$root}/gen/profile_doc/pdf/RVA20.pdf"].invoke
-  portfolio_start_msg("RVA22")
+  portfolio_start_msg("RVA22 Profile Release")
   Rake::Task["#{$root}/gen/profile_doc/pdf/RVA22.pdf"].invoke
-  portfolio_start_msg("RVA23")
+  portfolio_start_msg("RVA23 Profile Release")
   Rake::Task["#{$root}/gen/profile_doc/pdf/RVA23.pdf"].invoke
-  portfolio_start_msg("RVB23")
+  portfolio_start_msg("RVB23 Profile Release")
   Rake::Task["#{$root}/gen/profile_doc/pdf/RVB23.pdf"].invoke
 end
 
@@ -374,13 +384,13 @@ def portfolio_start_msg(name)
 end
 
 # Shortcut targets for building profiles and certificates.
-task "MockCertificateModel": "#{$root}/gen/certificate_doc/pdf/MockCertificateModel.pdf"
-task "MC100-32": "#{$root}/gen/certificate_doc/pdf/MC100-32.pdf"
-task "MC100-64": "#{$root}/gen/certificate_doc/pdf/MC100-64.pdf"
-task "MC200-32": "#{$root}/gen/certificate_doc/pdf/MC200-32.pdf"
-task "MC200-64": "#{$root}/gen/certificate_doc/pdf/MC200-64.pdf"
-task "MC300-32": "#{$root}/gen/certificate_doc/pdf/MC300-32.pdf"
-task "MC300-64": "#{$root}/gen/certificate_doc/pdf/MC300-64.pdf"
+task "MockProcCertModel": "#{$root}/gen/crd/pdf/MockProcCertModel.pdf"
+task "MC100-32": "#{$root}/gen/crd/pdf/MC100-32.pdf"
+task "MC100-64": "#{$root}/gen/crd/pdf/MC100-64.pdf"
+task "MC200-32": "#{$root}/gen/crd/pdf/MC200-32.pdf"
+task "MC200-64": "#{$root}/gen/crd/pdf/MC200-64.pdf"
+task "MC300-32": "#{$root}/gen/crd/pdf/MC300-32.pdf"
+task "MC300-64": "#{$root}/gen/crd/pdf/MC300-64.pdf"
 task "MockProfileRelease": "#{$root}/gen/profile_doc/pdf/MockProfileRelease.pdf"
 task "RVI20": "#{$root}/gen/profile_doc/pdf/RVI20.pdf"
 task "RVA20": "#{$root}/gen/profile_doc/pdf/RVA20.pdf"