Partially-configured ArchDef, CRD development, extension names for Priv mode features

.github/workflows/pages.yml

@@ -62,13 +62,13 @@ jobs:
     - name: Copy RVA Family PDF
       run: cp gen/profile_doc/pdf/rva.pdf _site/pdfs/rva.pdf
     - name: Create MC-1 PDF Spec
-      run: ./do gen:csc_crd_pdf[MC-1]
+      run: ./do gen:crd_pdf[MC-1]
     - name: Copy MC-1 PDF
-      run: cp gen/csc_crd_doc/pdf/MC-1.pdf _site/pdfs/MC-1.pdf
+      run: cp gen/crd_doc/pdf/MC-1.pdf _site/pdfs/MC-1.pdf
     - name: Create MC-1 HTML Spec
-      run: ./do gen:csc_crd_html[MC-1]
+      run: ./do gen:crd_html[MC-1]
     - name: Copy MC-1 HTML
-      run: cp gen/csc_crd_doc/html/MC-1.html _site/htmls/MC-1.html
+      run: cp gen/crd_doc/html/MC-1.html _site/htmls/MC-1.html
     - name: Copy manual html
       run: cp -R gen/manual/isa/top/all/html _site/manual
     - name: Setup Pages

.github/workflows/regress.yml

@@ -37,7 +37,9 @@ jobs:
       run: ./do validate
     - name: Build html documentation for generic_rv64
       run: ./do gen:html[generic_rv64]
+    - name: Build PDF documentation for MockCRD-1
+      run: ./do gen:crd_pdf[MockCRD-1]
     - name: Build PDF documentation for MC-1
-      run: ./do gen:csc_crd_pdf[MC-1]
+      run: ./do gen:crd_pdf[MC-1]
     - name: Build PDF documentation for RVA Profile Family
       run: ./do gen:profile_pdf[rva]

Gemfile

@@ -23,4 +23,5 @@ group :development do
   gem "solargraph"
   gem 'rubocop-minitest'
   gem 'ruby-prof'
+  gem "ruby-prof-flamegraph"
 end

Gemfile.lock

@@ -107,7 +107,9 @@ GEM
     rubocop-minitest (0.35.1)
       rubocop (>= 1.61, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
-    ruby-prof (1.7.0)
+    ruby-prof (0.18.0)
+    ruby-prof-flamegraph (0.3.0)
+      ruby-prof (~> 0.13)
     ruby-progressbar (1.13.0)
     ruby-rc4 (0.1.5)
     simpleidn (0.2.3)
@@ -152,6 +154,7 @@ DEPENDENCIES
   rouge
   rubocop-minitest
   ruby-prof
+  ruby-prof-flamegraph
   ruby-progressbar (~> 1.13)
   solargraph
   treetop (= 1.6.12)

Rakefile

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "etc"
+
 $root = Pathname.new(__FILE__).dirname.realpath
 $lib = $root / "lib"
 
@@ -82,45 +84,84 @@ namespace :validate do
     end
     puts "All files validate against their schema"  
   end
-  task idl: "gen:arch"  do
-    puts "Type checking IDL code..."
-    arch_def = arch_def_for("_")
-    progressbar = ProgressBar.create(title: "Instructions", total: arch_def.instructions.size)
-    arch_def.instructions.each do |inst|
-      progressbar.increment
-      inst.type_checked_operation_ast(arch_def.idl_compiler, arch_def.sym_table_32, 32) if inst.rv32?
-      inst.type_checked_operation_ast(arch_def.idl_compiler, arch_def.sym_table_64, 64) if inst.rv64?
-      # also need to check for an RV64 machine running with effective XLEN of 32
-      inst.type_checked_operation_ast(arch_def.idl_compiler, arch_def.sym_table_64, 32) if inst.rv64? && inst.rv32?
-    end
-    progressbar = ProgressBar.create(title: "CSRs", total: arch_def.csrs.size)
-    arch_def.csrs.each do |csr|
-      progressbar.increment
-      if csr.has_custom_sw_read?
-        csr.type_checked_sw_read_ast(arch_def.sym_table_32) if csr.defined_in_base32?
-        csr.type_checked_sw_read_ast(arch_def.sym_table_64) if csr.defined_in_base64?
-      end
-      csr.fields.each do |field|
-        unless field.type_ast(arch_def.idl_compiler).nil?
-          field.type_checked_type_ast(arch_def.sym_table_32) if csr.defined_in_base32? && field.defined_in_base32?
-          field.type_checked_type_ast(arch_def.sym_table_64) if csr.defined_in_base64? && field.defined_in_base64?
-        end
-        unless field.reset_value_ast(arch_def.idl_compiler).nil?
-          field.type_checked_reset_value_ast(arch_def.sym_table_32) if csr.defined_in_base32? && field.defined_in_base32?
-          field.type_checked_reset_value_ast(arch_def.sym_table_64) if csr.defined_in_base64? && field.defined_in_base64?
-        end
-        unless field.sw_write_ast(arch_def.idl_compiler).nil?
-          field.type_checked_sw_write_ast(arch_def.sym_table_32, 32) if csr.defined_in_base32? && field.defined_in_base32?
-          field.type_checked_sw_write_ast(arch_def.sym_table_64, 64) if csr.defined_in_base64? && field.defined_in_base64?
-        end
-      end
-    end
-    progressbar = ProgressBar.create(title: "Functions", total: arch_def.functions.size)
-    arch_def.functions.each do |func|
-      progressbar.increment
-      func.type_check_body(arch_def.sym_table_32)
-      func.type_check_body(arch_def.sym_table_64)
-    end
+  task idl: ["gen:arch", "#{$root}/.stamps/arch-gen-_32.stamp", "#{$root}/.stamps/arch-gen-_64.stamp"]  do
+    print "Parsing IDL code for RV32..."
+    arch_def_32 = arch_def_for("_32")
+    puts "done"
+
+    arch_def_32.type_check
+
+    print "Parsing IDL code for RV64..."
+    arch_def_64 = arch_def_for("_64")
+    puts "done"
+
+    arch_def_64.type_check
+
+    # arch_def_64 = arch_def_for("_64")
+    # arch_def_64.type_check
+
+    # puts "Type checking IDL code..."
+    # progressbar = ProgressBar.create(title: "Instructions", total: arch_def_32.instructions.size + arch_def_64.instructions.size)
+    # arch_def_32.instructions.each do |inst|
+    #   progressbar.increment
+    #   inst.type_checked_operation_ast(arch_def_32.idl_compiler, arch_def_32.symtab, 32) if inst.rv32?
+    # end
+    # arch_def_64.instructions.each do |inst|
+    #   progressbar.increment
+    #   inst.type_checked_operation_ast(arch_def_64.idl_compiler, arch_def_64.symtab, 64) if inst.rv64?
+    #   # also need to check for an RV64 machine running with effective XLEN of 32
+    #   inst.type_checked_operation_ast(arch_def_64.idl_compiler, arch_def_64.symtab, 32) if inst.rv64? && inst.rv32?
+    # end
+
+    # progressbar = ProgressBar.create(title: "CSRs", total: arch_def_32.csrs.size + arch_def_64.csrs.size)
+    # arch_def_32.csrs.each do |csr|
+    #   progressbar.increment
+    #   profile = RubyProf::Profile.new
+    #   result = profile.profile do
+    #     if csr.has_custom_sw_read?
+    #       csr.type_checked_sw_read_ast(arch_def_32.symtab) if csr.defined_in_base32?
+    #     end
+    #     csr.fields.each do |field|
+    #       unless field.type_ast(arch_def_32.symtab).nil?
+    #         field.type_checked_type_ast(arch_def_32.symtab) if csr.defined_in_base32? && field.defined_in_base32?
+    #       end
+    #       unless field.reset_value_ast(arch_def_32.symtab).nil?
+    #         field.type_checked_reset_value_ast(arch_def_32.symtab) if csr.defined_in_base32? && field.defined_in_base32?
+    #       end
+    #       unless field.sw_write_ast(arch_def_32.symtab).nil?
+    #         field.type_checked_sw_write_ast(arch_def_32.symtab, 32) if csr.defined_in_base32? && field.defined_in_base32?
+    #       end
+    #     end
+    #   end
+    #   RubyProf::GraphHtmlPrinter.new(result).print(File.open("#{csr.name}-prof.html", "w+"), {})
+    # end
+    # arch_def_64.csrs.each do |csr|
+    #   progressbar.increment
+    #   if csr.has_custom_sw_read?
+    #     csr.type_checked_sw_read_ast(arch_def_64.symtab) if csr.defined_in_base64?
+    #   end
+    #   csr.fields.each do |field|
+    #     unless field.type_ast(arch_def_64.symtab).nil?
+    #       field.type_checked_type_ast(arch_def_64.symtab) if csr.defined_in_base64? && field.defined_in_base64?
+    #     end
+    #     unless field.reset_value_ast(arch_def_64.symtab).nil?
+    #       field.type_checked_reset_value_ast(arch_def_64.symtab) if csr.defined_in_base64? && field.defined_in_base64?
+    #     end
+    #     unless field.sw_write_ast(arch_def_64.symtab).nil?
+    #       field.type_checked_sw_write_ast(arch_def_64.symtab, 32) if csr.defined_in_base32? && field.defined_in_base32?
+    #       field.type_checked_sw_write_ast(arch_def_64.symtab, 64) if csr.defined_in_base64? && field.defined_in_base64?
+    #     end
+    #   end
+    # end
+    # progressbar = ProgressBar.create(title: "Functions", total: arch_def_32.functions.size + arch_def_64.functions.size)
+    # arch_def_32.functions.each do |func|
+    #   progressbar.increment
+    #   func.type_check(arch_def_32.symtab)
+    # end
+    # arch_def_64.functions.each do |func|
+    #   progressbar.increment
+    #   func.type_check(arch_def_64.symtab)
+    # end
     puts "All IDL passed type checking"
   end
 end

arch/csc_crd/MC-1.yaml → arch/crd/MC-1.yaml

@@ -29,71 +29,56 @@ MC-1:
 
 # XXX - Remove version information since specifying priv/unpriv ISA manual should imply this.
   extensions:
-    mandatory:
-    - name: I
-      version: "~> 2.1"
-    - name: C
-      version: "~> 2.2"
-      param_constraints:
-          MUTABLE_MISA_C:
-            schema:
-              const: false
-    - name: M
-      version: "~> 2.0"
-    - name: Zicsr
-      version: "~> 2.0"
-    - name: Zicntr
-      version: "~> 2.0"
-    - name: Sm
-      version: "~> 1.11"
-      param_constraints:
-          MTVEC_BASE_ALIGNMENT_DIRECT: {} # Unconstrained
-          MTVEC_BASE_ALIGNMENT_VECTORED: {} # Unconstrained
-          ARCH_ID: {} # Unconstrained
-          IMP_ID: {} # Unconstrained
-          VENDOR_ID_BANK: {} # Unconstrained
-          VENDOR_ID_OFFSET: {} # Unconstrained
-          MISA_CSR_IMPLEMENTED: {} # Unconstrained
-          TIME_CSR_IMPLEMENTED: {} # Unconstrained
-          MTVAL_WIDTH: {} # Unconstrained
-          PHYS_ADDR_WIDTH: {} # Unconstrained
-          PRECISE_SYNCHRONOUS_EXCEPTIONS:
-            schema:
-              const: true
-          TRAP_ON_ECALL_FROM_M:
-            schema:
-              const: true
-          TRAP_ON_EBREAK:
-            schema:
-              const: true
-          REPORT_VA_IN_MTVAL_ON_BREAKPOINT:
-            schema:
-              const: true
-          REPORT_VA_IN_MTVAL_ON_INSTRUCTION_ACCESS_FAULT:
-            schema:
-              const: true
-          REPORT_VA_IN_MTVAL_ON_LOAD_ACCESS_FAULT:
-            schema:
-              const: true
-          REPORT_VA_IN_MTVAL_ON_STORE_AMO_ACCESS_FAULT:
-            schema:
-              const: true
-          REPORT_ENCODING_IN_MTVAL_ON_ILLEGAL_INSTRUCTION:
-            schema:
-              const: true
-          M_MODE_ENDIANESS:
-            schema:
-              const: little
-          XLEN:
-            schema:
-              const: 32
-          CONFIG_PTR_ADDRESS:
-            schema:
-              const: 0
-    #XXX optional: {} # None
-    optional:
-    - name: Zifencei
-      note: "This is just for testing. Zifencei extension isn't really optional for MC-1."
+  - name: I
+    version: "~> 2.1"
+    presence: mandatory
+  - name: C
+    version: "~> 2.2"
+    presence: mandatory
+  - name: M
+    version: "~> 2.0"
+    presence: mandatory
+  - name: Zicsr
+    version: "~> 2.0"
+    presence: mandatory
+  - name: Zicntr
+    version: "~> 2.0"
+    presence: mandatory
+    parameters:
+        TIME_CSR_IMPLEMENTED: {} # Unconstrained
+  - name: Sm
+    version: "~> 1.11"
+    presence: mandatory
+    parameters:
+        MTVEC_BASE_ALIGNMENT_DIRECT: {} # Unconstrained
+        MTVEC_BASE_ALIGNMENT_VECTORED: {} # Unconstrained
+        ARCH_ID: {} # Unconstrained
+        IMP_ID: {} # Unconstrained
+        VENDOR_ID_BANK: {} # Unconstrained
+        VENDOR_ID_OFFSET: {} # Unconstrained
+        MISA_CSR_IMPLEMENTED: {} # Unconstrained
+        MTVAL_WIDTH: {} # Unconstrained
+        MTVEC_MODES: {} # Unconstrained
+        PHYS_ADDR_WIDTH: {} # Unconstrained
+        CONFIG_PTR_ADDRESS:
+          schema:
+            const: 0xdeadbeef
+          note: "This parameter and its associated CSR shouldn't be here. See GitHub issue #53."
+        PRECISE_SYNCHRONOUS_EXCEPTIONS:
+          schema:
+            const: true
+        TRAP_ON_ECALL_FROM_M:
+          schema:
+            const: true
+        TRAP_ON_EBREAK:
+          schema:
+            const: true
+        M_MODE_ENDIANESS:
+          schema:
+            const: little
+        XLEN:
+          schema:
+            const: 32
 
   requirement_groups:
     - name: MC-Unpriv