RISC-V Opcodes Data Cross-Validation

.github/workflows/regress.yml

@@ -185,3 +185,42 @@ jobs:
         run: ./bin/build_container
       - name: Generate extension PDF
         run: ./do gen:profile[MockProfileRelease]
+  regress-gen-opcode:
+      runs-on: ubuntu-latest
+      env:
+        SINGULARITY: 1
+      steps:
+        - name: Clone Github Repo Action
+          uses: actions/checkout@v4
+        - name: Cache riscv-opcodes submodule
+          id: cache-opcodes
+          uses: actions/cache@v4
+          with:
+            path: ext/riscv-opcodes
+            key: ${{ runner.os }}-submodule-riscv-opcodes-${{ hashFiles('.gitmodules') }}
+        - if: steps.cache-opcodes.outputs.cache-hit != 'true'
+          name: Checkout riscv-opcodes submodule
+          run: |
+            git submodule init ext/riscv-opcodes
+            git submodule update ext/riscv-opcodes
+        - name: Setup apptainer
+          uses: eWaterCycle/[email protected]
+        - name: Get container from cache
+          id: cache-sif
+          uses: actions/cache@v4
+          with:
+            path: .singularity/image.sif
+            key: ${{ hashFiles('container.def', 'bin/.container-tag') }}
+        - name: Get gems and node files from cache
+          id: cache-bundle-npm
+          uses: actions/cache@v4
+          with:
+            path: |
+              .home/.gems
+              node_modules
+            key: ${{ hashFiles('Gemfile.lock') }}-${{ hashFiles('package-lock.json') }}
+        - if: ${{ steps.cache-sif.outputs.cache-hit != 'true' }}
+          name: Build container
+          run: ./bin/build_container
+        - name: Generate opcode outputs
+          run: ./do gen:opcode_outputs

Rakefile

@@ -10,6 +10,7 @@ require "yard"
 require "minitest/test_task"
 
 require_relative $root / "lib" / "architecture"
+$opcode_outputs = $root / "gen" / "opcodes_outputs"
 
 directory "#{$root}/.stamps"
 
@@ -39,6 +40,28 @@ file "#{$root}/.stamps/dev_gems" => ["#{$root}/.stamps"] do |t|
   FileUtils.touch t.name
 end
 
+namespace :gen do
+  desc "Generate opcode outputs, optionally specify YAML_DIR=path/to/yaml"
+  task :opcode_outputs do
+    yaml_dir = ENV['YAML_DIR'] || "#{$root}/arch/inst"
+    mkdir_p $opcode_outputs
+    sh "#{$root}/.home/.venv/bin/python3 #{$root}/backends/opcodes_maker/yaml_to_json.py #{yaml_dir} #{$opcode_outputs}"
+    sh "#{$root}/.home/.venv/bin/python3 #{$root}/backends/opcodes_maker/generator.py #{$opcode_outputs}/instr_dict.json -c -chisel -spinalhdl -sverilog -rust -go -latex"
+
+    # Move generated files to output dir
+    Dir.chdir("#{$root}") do
+      mv "encoding.out.h", "#{$opcode_outputs}/", force: true
+      mv "inst.chisel", "#{$opcode_outputs}/", force: true
+      mv "inst.spinalhdl", "#{$opcode_outputs}/", force: true
+      mv "inst.sverilog", "#{$opcode_outputs}/", force: true
+      mv "inst.rs", "#{$opcode_outputs}/", force: true
+      mv "inst.go", "#{$opcode_outputs}/", force: true
+      mv "instr-table.tex", "#{$opcode_outputs}/", force: true
+      mv "priv-instr-table.tex", "#{$opcode_outputs}/", force: true
+    end
+  end
+ end
+
 namespace :gen do
   desc "Generate documentation for the ruby tooling"
   task tool_doc: "#{$root}/.stamps/dev_gems" do
@@ -319,6 +342,8 @@ namespace :test do
 
     Rake::Task["gen:html"].invoke("generic_rv64")
 
+    Rake::Task["gen:opcode_outputs"].invoke
+
     Rake::Task["#{$root}/gen/certificate_doc/pdf/MockCertificateModel.pdf"].invoke
     Rake::Task["#{$root}/gen/profile_doc/pdf/MockProfileRelease.pdf"].invoke
 

arch/inst/C/c.add.yaml

@@ -17,8 +17,9 @@ encoding:
   variables:
     - name: rs2
       location: 6-2
-    - name: rd
+    - name: rd/rs1
       location: 11-7
+      not: 0
 access:
   s: always
   u: always

arch/inst/C/c.addi.yaml

@@ -20,7 +20,7 @@ encoding:
     - name: imm
       location: 12|6-2
       not: 0
-    - name: rd
+    - name: rd/rs1
       location: 11-7
       not: 0
 access:

arch/inst/C/c.addiw.yaml

@@ -20,7 +20,7 @@ encoding:
   variables:
     - name: imm
       location: 12|6-2
-    - name: rd
+    - name: rd/rs1
       location: 11-7
       not: 0
 access:

arch/inst/C/c.addw.yaml

@@ -19,7 +19,7 @@ encoding:
   variables:
     - name: rs2
       location: 4-2
-    - name: rd
+    - name: rd/rs1
       location: 9-7
 access:
   s: always

arch/inst/C/c.and.yaml

@@ -18,7 +18,7 @@ encoding:
   variables:
     - name: rs2
       location: 4-2
-    - name: rd
+    - name: rd/rs1
       location: 9-7
 access:
   s: always

arch/inst/C/c.andi.yaml

@@ -18,7 +18,7 @@ encoding:
   variables:
     - name: imm
       location: 12|6-2
-    - name: rd
+    - name: rd/rs1
       location: 9-7
 access:
   s: always

arch/inst/C/c.or.yaml

@@ -18,7 +18,7 @@ encoding:
   variables:
     - name: rs2
       location: 4-2
-    - name: rd
+    - name: rd/rs1
       location: 9-7
 access:
   s: always

arch/inst/C/c.slli.yaml

@@ -18,7 +18,7 @@ encoding:
   variables:
     - name: shamt
       location: 12|6-2
-    - name: rd
+    - name: rd/rs1
       location: 11-7
       not: 0
 access:

arch/inst/C/c.srai.yaml

@@ -19,7 +19,7 @@ encoding:
   variables:
     - name: shamt
       location: 12|6-2
-    - name: rd
+    - name: rd/rs1
       location: 9-7
 access:
   s: always

arch/inst/C/c.srli.yaml

@@ -19,7 +19,7 @@ encoding:
   variables:
     - name: shamt
       location: 12|6-2
-    - name: rd
+    - name: rd/rs1
       location: 9-7
 access:
   s: always

arch/inst/C/c.sub.yaml

@@ -18,7 +18,7 @@ encoding:
   variables:
     - name: rs2
       location: 4-2
-    - name: rd
+    - name: rd/rs1
       location: 9-7
 access:
   s: always

arch/inst/C/c.subw.yaml

@@ -19,7 +19,7 @@ encoding:
   variables:
     - name: rs2
       location: 4-2
-    - name: rd
+    - name: rd/rs1
       location: 9-7
 access:
   s: always

arch/inst/C/c.xor.yaml

@@ -18,7 +18,7 @@ encoding:
   variables:
     - name: rs2
       location: 4-2
-    - name: rd
+    - name: rd/rs1
       location: 9-7
 access:
   s: always

arch/inst/V/vsetivli.yaml

@@ -11,9 +11,9 @@ assembly: xd, imm
 encoding:
   match: 11---------------111-----1010111
   variables:
-    - name: zimm10
+    - name: imm
       location: 29-20
-    - name: uimm
+    - name: imm
       location: 19-15
     - name: rd
       location: 11-7

arch/inst/V/vsetvli.yaml

@@ -11,7 +11,7 @@ assembly: xs1, xd, imm
 encoding:
   match: 0----------------111-----1010111
   variables:
-    - name: zimm11
+    - name: imm
       location: 30-20
     - name: rs1
       location: 19-15

arch/inst/Zicsr/csrrwi.yaml

@@ -13,7 +13,7 @@ description: |
   If `rd=x0`, then the instruction shall not read the CSR and shall not
   cause any of the side effects that might occur on a CSR read.
 definedBy: Zicsr
-assembly: xd, zimm, csr
+assembly: xd, imm, csr
 encoding:
   match: -----------------101-----1110011
   variables:

arch/inst/Zvbb/vwsll.vi.yaml

@@ -16,7 +16,7 @@ encoding:
       location: 25-25
     - name: vs2
       location: 24-20
-    - name: zimm5
+    - name: imm
       location: 19-15
     - name: vd
       location: 11-7

arch/inst/Zvkn/vaeskf1.vi.yaml

@@ -14,7 +14,7 @@ encoding:
   variables:
     - name: vs2
       location: 24-20
-    - name: zimm5
+    - name: imm
       location: 19-15
     - name: vd
       location: 11-7

arch/inst/Zvkn/vaeskf2.vi.yaml

@@ -14,7 +14,7 @@ encoding:
   variables:
     - name: vs2
       location: 24-20
-    - name: zimm5
+    - name: imm
       location: 19-15
     - name: vd
       location: 11-7

arch/inst/Zvks/vsm3c.vi.yaml

@@ -14,7 +14,7 @@ encoding:
   variables:
     - name: vs2
       location: 24-20
-    - name: zimm5
+    - name: imm
       location: 19-15
     - name: vd
       location: 11-7

arch/inst/Zvks/vsm4k.vi.yaml

@@ -14,7 +14,7 @@ encoding:
   variables:
     - name: vs2
       location: 24-20
-    - name: zimm5
+    - name: imm
       location: 19-15
     - name: vd
       location: 11-7

backends/instr_isa_manual/tasks.rake

@@ -0,0 +1,35 @@
+# tasks.rake
+
+# Define the manual generation directory constant
+ISA_INDEX_GEN_DIR = $root / "gen" / "instr_isa_manual/index"
+
+# Rule to create the instructions index page (all instructions with details)
+rule %r{#{ISA_INDEX_GEN_DIR}/.*/antora/modules/insts/pages/instructions_index\.adoc} => [
+  __FILE__,
+  ($root / "backends" / "instr_isa_manual" / "templates" / "instr_index.adoc.erb").to_s
+] do |t|
+  cfg_arch = cfg_arch_for("_")
+  # Collect all instructions sorted by name
+  instructions = cfg_arch.instructions.sort_by(&:name)
+  template_path = $root / "backends" / "instr_isa_manual" / "templates" / "instr_index.adoc.erb"
+  erb = ERB.new(template_path.read, trim_mode: "-")
+  erb.filename = template_path.to_s
+
+  FileUtils.mkdir_p(File.dirname(t.name))
+  File.write(t.name, AsciidocUtils.resolve_links(cfg_arch.find_replace_links(erb.result(binding))))
+end
+
+# Rake task to generate the instructions index page.
+namespace :gen do
+  desc "Generate the instructions index page (with index and full instruction details)"
+  task :instructions_index do
+    # Use provided version or default to "latest"
+    version = ENV["VERSION"] || "latest"
+    target = ISA_INDEX_GEN_DIR / version / "antora/modules/insts/pages/instructions_index.adoc"
+
+    # Invoke the rule to generate the file
+    Rake::Task[target.to_s].invoke
+
+    puts "SUCCESS: Instructions index generated at '#{target}'"
+  end
+end