Merge branch 'riscv-software-src:main' into H_CSRs

Author: Shehrozkashif

.devcontainer/Dockerfile

@@ -5,10 +5,11 @@ ENV DEBIAN_FRONTEND=noninteractive
 WORKDIR /workspace
 
 RUN export DEBIAN_FRONTEND=noninteractive
-RUN apt-get update
 
 # please keep pkgs sorted
-RUN apt-get install -y --no-install-recommends \
+RUN \
+  apt-get update && \
+  apt-get install -y --no-install-recommends --fix-missing \
     build-essential \
     bundler \
     clang-format \
@@ -28,6 +29,7 @@ RUN apt-get install -y --no-install-recommends \
     libyaml-dev \
     nodejs \
     npm \
+    parallel \
     python3 \
     python3-pip \
     python3.12-venv \

.devcontainer/devcontainer.json

@@ -25,13 +25,13 @@
         "asciidoc.antora.showEnableAntoraPrompt": true
       },
       "extensions": [
-        "castwide.solargraph",
-        "redhat.vscode-yaml",
         "asciidoctor.asciidoctor-vscode",
-        "zhwu95.riscv",
-        "mathematic.vscode-pdf",
+        "castwide.solargraph",
         "CraigMaslowski.erb",
-        "HowerLimited.udb-extension-pack-vscode"
+        "HowerLimited.udb-extension-pack-vscode",
+        "mathematic.vscode-pdf",
+        "redhat.vscode-yaml",
+        "zhwu95.riscv"
       ]
     }
   },

.github/workflows/regress.yml

@@ -36,8 +36,6 @@ jobs:
         with:
           path: ext/llvm-project/riscv.json
           key: ${{ runner.os }}-riscv-json-${{ env.LLVM_SHA }}
-          restore-keys: |
-            ${{ runner.os }}-riscv-json-
       - name: singularity setup
         uses: ./.github/actions/singularity-setup
       - name: Run smoke
@@ -64,8 +62,10 @@ jobs:
         uses: actions/checkout@v4
       - name: singularity setup
         uses: ./.github/actions/singularity-setup
-      - name: Generate instruction appendix
-        run: ./do gen:instruction_appendix
+      - name: Generate instruction appendix asciidoc
+        run: ./do gen:instruction_appendix_adoc
+      - name: Check instruction appendix result
+        run: ./do test:instruction_appendix
   regress-cfg-manual:
     runs-on: ubuntu-latest
     env:
@@ -130,14 +130,12 @@ jobs:
         with:
           path: ext/llvm-project/riscv.json
           key: ${{ runner.os }}-riscv-json-${{ env.LLVM_SHA }}
-          restore-keys: |
-            ${{ runner.os }}-riscv-json-
       - name: Initialize LLVM submodule (shallow + sparse)
         if: ${{ steps.cache-riscv.outputs.cache-hit != 'true' }}
         run: |
+          rm -rf ext/llvm-project
           git submodule sync --recursive
           git submodule update --init --recursive --depth=1 ext/llvm-project
-
       - name: Check for required directories and files
         if: ${{ steps.cache-riscv.outputs.cache-hit != 'true' }}
         run: |
@@ -161,6 +159,11 @@ jobs:
             -o ext/llvm-project/riscv.json
       - name: Show riscv.json output
         run: ls -l ext/llvm-project/riscv.json
+      - name: Upload RISC-V JSON as Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: riscv-json
+          path: ext/llvm-project/riscv.json
   regress-gen-go:
     runs-on: ubuntu-latest
     env:
@@ -172,6 +175,17 @@ jobs:
         uses: ./.github/actions/singularity-setup
       - name: Generate Go code
         run: ./do gen:go
+  regress-gen-c-header:
+    runs-on: ubuntu-latest
+    env:
+      SINGULARITY: 1
+    steps:
+      - name: Clone Github Repo Action
+        uses: actions/checkout@v4
+      - name: singularity setup
+        uses: ./.github/actions/singularity-setup
+      - name: Generate c_header code
+        run: ./do gen:c_header
   regress-cpp-unit:
     runs-on: ubuntu-latest
     env:
@@ -182,4 +196,4 @@ jobs:
       - name: singularity setup
         uses: ./.github/actions/singularity-setup
       - name: Run cpp unit tests
-        run: ./do test:cpp_hart CONFIG=rv64
+        run: ./do test:cpp_hart CONFIG=rv64 JOBS=4

.gitignore

@@ -9,6 +9,7 @@
 .asciidoctor
 .vscode/*
 !.vscode/launch.json
+!.vscode/extensions.json
 .container-type
 diag-ditaa-*
 arch/manual/isa/**/riscv-isa-manual
@@ -21,3 +22,4 @@ __pycache__/
 .pytest_cache/
 *.bak
 *.log
+sorbet

.gitmodules

@@ -14,3 +14,6 @@
 [submodule "ext/riscv-tests"]
 	path = ext/riscv-tests
 	url = https://github.com/riscv-software-src/riscv-tests.git
+[submodule "ext/rbi-central"]
+	path = ext/rbi-central
+	url = https://github.com/Shopify/rbi-central

.pre-commit-config.yaml

@@ -19,6 +19,7 @@ repos:
         stages: [pre-commit]
       - id: end-of-file-fixer
         stages: [pre-commit]
+        exclude: \.golden.adoc$
       - id: trailing-whitespace
         stages: [pre-commit]
         args: [--markdown-linebreak-ext=md]
@@ -119,6 +120,7 @@ repos:
     rev: v5.0.2
     hooks:
       - id: reuse-lint-file
+        exclude: COMMIT_EDITMSG|MERGE_MSG
 
   - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
     rev: v9.22.0

.sorbet-config

@@ -0,0 +1,8 @@
+--dir
+.
+--ignore
+ext
+--ignore
+.home/.gems
+--ignore
+node_modules

.tapioca-config.yml

@@ -0,0 +1,27 @@
+gem:
+  outdir: .home/.sorbet/rbi/gems
+  file_header: true
+  exclude:
+    [
+      rdoc,
+      asciidoctor-pdf,
+      solargraph,
+      webrick,
+      ttfunk,
+      tapioca,
+      rubocop,
+      rubocop-minitest,
+      spoom,
+      rdbg,
+      parser,
+    ]
+dsl:
+  outdir: .home/.sorbet/rbi/dsl
+  # Add your `dsl` command parameters here:
+  #
+  # exclude:
+  # - SomeGeneratorName
+  # workers: 5
+annotations:
+  sources:
+    - ext/rbi-central

.vscode/extensions.json

@@ -0,0 +1,11 @@
+{
+  "recommendations": [
+    "asciidoctor.asciidoctor-vscode",
+    "castwide.solargraph",
+    "CraigMaslowski.erb",
+    "HowerLimited.udb-extension-pack-vscode",
+    "mathematic.vscode-pdf",
+    "redhat.vscode-yaml",
+    "zhwu95.riscv"
+  ]
+}

Gemfile

@@ -16,6 +16,7 @@ gem "pygments.rb"
 gem "rake", "~> 13.0"
 gem "rouge"
 gem "ruby-progressbar", "~> 1.13"
+gem "sorbet-runtime"
 gem "treetop", "1.6.12"
 gem "ttfunk", "1.7" # needed to avoid having asciidoctor-pdf dependencies pulling in a buggy version of ttunk (1.8)
 gem "webrick"
@@ -31,4 +32,7 @@ group :development do
   gem "ruby-prof"
   gem "ruby-prof-flamegraph", git: "https://github.com/oozou/ruby-prof-flamegraph.git", ref: "fc3c437", require: false
   gem "solargraph"
+  gem "sorbet"
+  gem "spoom"
+  gem "tapioca", require: false
 end