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

Author: Shehrozkashif

.clang-format

@@ -0,0 +1,15 @@
+---
+BasedOnStyle: Google
+IndentWidth: 2
+Language: Cpp
+# AlignConsecutiveAssignments: true
+# AlignConsecutiveDeclarations: true
+# AlignEscapedNewlines: Right
+# AlignOperands: true
+# AlignTrailingComments: true
+# AllowShortBlocksOnASingleLine: false
+# AllowShortCaseLabelsOnASingleLine: true
+# AlwaysBreakTemplateDeclarations: Yes
+
+FixNamespaceComments: true
+NamespaceIndentation: All

.devcontainer/Dockerfile

@@ -6,19 +6,35 @@ WORKDIR /workspace
 
 RUN export DEBIAN_FRONTEND=noninteractive
 RUN apt-get update
-RUN apt-get install -y --no-install-recommends git gh
-RUN apt-get install -y --no-install-recommends less
-RUN apt-get install -y --no-install-recommends python3
-RUN apt-get install -y --no-install-recommends python3.12-venv
-RUN apt-get install -y --no-install-recommends python3-pip
-RUN apt-get install -y --no-install-recommends build-essential
-RUN apt-get install -y --no-install-recommends ruby
-RUN apt-get install -y --no-install-recommends ruby-dev
-RUN apt-get install -y --no-install-recommends bundler
-RUN apt-get install -y --no-install-recommends nodejs
-RUN apt-get install -y --no-install-recommends npm
-RUN apt-get install -y --no-install-recommends ditaa
-RUN apt-get install -y --no-install-recommends libyaml-dev
+
+# please keep pkgs sorted
+RUN apt-get install -y --no-install-recommends \
+    build-essential \
+    bundler \
+    clang-format \
+    clang-tidy \
+    cmake \
+    ditaa \
+    g++ \
+    gcc-riscv64-linux-gnu \
+    gcc-riscv64-unknown-elf \
+    gdb \
+    gh \
+    git \
+    less \
+    libc6-dev-riscv64-cross \
+    libelf-dev \
+    libgmp-dev \
+    libyaml-dev \
+    nodejs \
+    npm \
+    python3 \
+    python3-pip \
+    python3.12-venv \
+    ruby \
+    ruby-dev \
+    shellcheck
+
 RUN apt-get clean autoclean
 RUN apt-get autoremove -y
 RUN rm -rf /var/lib/{apt,dpkg,cache,log}/*

.devcontainer/devcontainer.json

@@ -31,7 +31,7 @@
         "zhwu95.riscv",
         "mathematic.vscode-pdf",
         "CraigMaslowski.erb",
-        "HowerLimited.idl-vscode"
+        "HowerLimited.udb-extension-pack-vscode"
       ]
     }
   },

.github/workflows/container.yml

@@ -0,0 +1,82 @@
+name: Publish container
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+jobs:
+  publish-singularity-container:
+    runs-on: ubuntu-latest
+    env:
+      SINGULARITY: 1
+    steps:
+      - name: Clone Github Repo Action
+        uses: actions/checkout@v4
+
+      - name: Setup apptainer
+        uses: eWaterCycle/[email protected]
+        with:
+          apptainer-version: 1.4.0
+
+      - name: Get container tag
+        run: |
+          TAG=$(cat bin/.container-tag)
+          echo "TAG=$TAG" >> $GITHUB_ENV
+
+      - 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: Upload singularity container
+        run: |
+          apptainer registry login -u ${{ secrets.DOCKERHUB_USERNAME }} -p ${{ secrets.DOCKERHUB_TOKEN }} oras://docker.io
+          apptainer push .singularity/image.sif oras://docker.io/riscvintl/spec-generator:${{ env.TAG }}
+
+  publish-docker-container:
+    runs-on: ubuntu-latest
+    env:
+      DOCKER: 1
+    steps:
+      - name: Clone Github Repo Action
+        uses: actions/checkout@v4
+
+      - name: Get container tag
+        run: |
+          TAG=$(cat bin/.container-tag)
+          echo "TAG=$TAG" >> $GITHUB_ENV
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          push: true
+          file: ./.devcontainer/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          tags: riscvintl/udb:${{ env.TAG }}

.github/workflows/regress.yml

@@ -103,7 +103,7 @@ jobs:
         name: Build container
         run: ./bin/build_container
       - name: Generate HTML ISA manual
-        run: ./do gen:html[generic_rv64]
+        run: ./do gen:html[example_rv64_with_overlay]
   regress-gen-ext-pdf:
     runs-on: ubuntu-latest
     env:
@@ -191,3 +191,31 @@ jobs:
         run: ./bin/build_container
       - name: Generate extension PDF
         run: ./do gen:profile[MockProfileRelease]
+  regress-gen-go:
+    runs-on: ubuntu-latest
+    env:
+      SINGULARITY: 1
+    steps:
+      - name: Clone Github Repo Action
+        uses: actions/checkout@v4
+      - 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 Go code
+        run: ./do gen:go

.gitignore

@@ -7,6 +7,8 @@
 .stamps
 .venv
 .asciidoctor
+.vscode/*
+!.vscode/launch.json
 .container-type
 diag-ditaa-*
 arch/manual/isa/**/riscv-isa-manual

.gitmodules

@@ -7,3 +7,6 @@
 [submodule "ext/riscv-isa-manual"]
 	path = ext/riscv-isa-manual
 	url = https://github.com/riscv/riscv-isa-manual
+[submodule "ext/riscv-tests"]
+	path = ext/riscv-tests
+	url = https://github.com/riscv-software-src/riscv-tests.git

.pre-commit-config.yaml

@@ -30,7 +30,7 @@ repos:
         exclude: schemas/json-schema-draft-07.json
 
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.31.3
+    rev: 0.32.1
     hooks:
       - id: check-jsonschema
         alias: check-jsonschema-inst
@@ -58,6 +58,12 @@ repos:
       #   files: ^arch/manual/.*\.(yaml|yml)$
       #   args: ["--schemafile", "schemas/manual_version_schema.json"]
 
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: "v20.1.0"
+    hooks:
+      - id: clang-format
+        types_or: [c++, c]
+        files: \.(hpp|cpp)$
   - repo: https://github.com/psf/black-pre-commit-mirror
     rev: 25.1.0
     hooks:
@@ -68,11 +74,14 @@ repos:
     hooks:
       - id: pyupgrade
 
-  # - repo: https://github.com/koalaman/shellcheck-precommit
-  #   rev: v0.10.0
-  #   hooks:
-  #     - id: shellcheck
-  #       args: ["--severity=error"]
+  - repo: local
+    hooks:
+      - id: shellcheck
+        name: shellcheck
+        types: [shell]
+        language: system
+        entry: shellcheck
+        args: ["--severity=error"]
 
   - repo: https://github.com/scop/pre-commit-shfmt
     rev: v3.11.0-1

.vscode/launch.json

@@ -27,6 +27,46 @@
       "script": "gen:profile[RVA20]",
       "args": [],
       "askParameters": false
+    },
+    {
+      "type": "cppdbg",
+      "name": "Run MC100-32 iss",
+      "request": "launch",
+      "program": "${workspaceFolder}/gen/cpp_hart_gen/MC100-32_Debug/build/iss",
+      "setupCommands": [
+        {
+          "text": "set output-radix 16",
+          "description": "Display hex by default"
+        }
+      ],
+      "cwd": "${workspaceFolder}",
+      "args": [
+        "-m", "MC100-32", "-c",
+        "${workspaceFolder}/cfgs/mc100-32-full-example.yaml",
+        "ext/riscv-tests/isa/rv32mi-p-mcsr"
+      ],
+      "linux": {
+        "MIMode": "gdb",
+        "miDebuggerPath": "${workspaceFolder}/bin/gdb"
+      }
+    },
+    {
+      "type": "cppdbg",
+      "name": "Run MC100-32 coremark",
+      "request": "launch",
+      "program": "${workspaceFolder}/gen/cpp_hart_gen/MC100-32_Debug/build/iss",
+      "setupCommands": [
+        {
+          "text": "set output-radix 16",
+          "description": "Display hex by default"
+        }
+      ],
+      "cwd": "${workspaceFolder}",
+      "args": ["-m", "MC100-32", "-c", "${workspaceFolder}/cfgs/mc100-32-full-example.yaml", "ext/riscv-coremark/coremark/coremark.bare.riscv"],
+      "linux": {
+        "MIMode": "gdb",
+        "miDebuggerPath": "${workspaceFolder}/bin/gdb"
+      }
     }
   ]
 }

Gemfile

@@ -9,8 +9,9 @@ gem "asciidoctor-diagram", "~> 2.2"
 gem "asciidoctor-pdf"
 gem "base64"
 gem "bigdecimal"
+gem "concurrent-ruby", require: "concurrent"
+gem "concurrent-ruby-ext"
 gem "json_schemer", "~> 1.0"
-gem "minitest"
 gem "pygments.rb"
 gem "rake", "~> 13.0"
 gem "rouge"
@@ -21,10 +22,12 @@ gem "webrick"
 gem "yard"
 
 group :development do
+  gem "awesome_print"
   gem "debug"
+  gem "minitest"
   gem "rdbg"
   gem "rubocop-minitest"
   gem "ruby-prof"
-  gem "ruby-prof-flamegraph"
+  gem "ruby-prof-flamegraph", git: "https://github.com/oozou/ruby-prof-flamegraph.git", ref: "fc3c437", require: false
   gem "solargraph"
 end