Merge remote-tracking branch 'origin/main' into 332-create-better-profile-comparisons

Author: james-ball-qualcomm

.devcontainer/Dockerfile

@@ -1,17 +1,26 @@
-FROM ubuntu:24.04 AS spython-base
+FROM ubuntu:24.04
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+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 python3-pip
+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 ruby-dev
+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
 RUN apt-get clean autoclean
 RUN apt-get autoremove -y
-RUN rm -rf /var/lib/{apt, dpkg, cache, log}
+RUN rm -rf /var/lib/{apt,dpkg,cache,log}/*
+
+WORKDIR /workspace

.github/workflows/nightly.yml

@@ -26,6 +26,8 @@ jobs:
     needs: check_date
     if: ${{ needs.check_date.outputs.should_run != 'false' }}
     runs-on: ubuntu-latest
+    env:
+      SINGULARITY: 1
     steps:
       - name: Clone Github Repo Action
         uses: actions/checkout@v4

.github/workflows/regress.yml

@@ -13,6 +13,8 @@ jobs:
       - uses: pre-commit/[email protected]
   regress-smoke:
     runs-on: ubuntu-latest
+    env:
+      SINGULARITY: 1
     steps:
       - name: Clone Github Repo Action
         uses: actions/checkout@v4
@@ -45,6 +47,7 @@ jobs:
     env:
       MANUAL_NAME: isa
       VERSIONS: all
+      SINGULARITY: 1
     steps:
       - name: Clone Github Repo Action
         uses: actions/checkout@v4
@@ -75,6 +78,7 @@ jobs:
     env:
       EXT: B
       VERSION: latest
+      SINGULARITY: 1
     steps:
       - name: Clone Github Repo Action
         uses: actions/checkout@v4
@@ -102,6 +106,8 @@ jobs:
   regress-gen-certificate:
     runs-on: ubuntu-latest
     needs: regress-smoke
+    env:
+      SINGULARITY: 1
     steps:
       - name: Clone Github Repo Action
         uses: actions/checkout@v4
@@ -129,6 +135,8 @@ jobs:
   regress-gen-profile:
     runs-on: ubuntu-latest
     needs: regress-smoke
+    env:
+      SINGULARITY: 1
     steps:
       - name: Clone Github Repo Action
         uses: actions/checkout@v4

.gitignore

@@ -7,6 +7,7 @@
 .stamps
 .venv
 .asciidoctor
+.container-type
 diag-ditaa-*
 arch/manual/isa/**/riscv-isa-manual
 gen

arch/csr/Smrnmi/mncause.yaml

@@ -0,0 +1,43 @@
+# yaml-language-server: $schema=../../../schemas/csr_schema.json
+
+$schema: csr_schema.json#
+kind: csr
+name: mncause
+long_name: Resumable NMI cause
+address: 0x742
+priv_mode: M
+length: MXLEN
+definedBy: Smrnmi
+description: |
+  The mncause CSR holds the reason for the NMI.
+  If the reason is an interrupt, bit MXLEN-1 is set to 1, and the NMI cause is encoded in
+  the least-significant bits.
+  If the reason is an interrupt and NMI causes are not supported,
+  bit MXLEN-1 is set to 1, and zero is written to the least-significant bits.
+  If the reason is an exception within M-mode that results in a double trap as
+  specified in the Smdbltrp extension, bit MXLEN-1 is set to 0 and the least-significant
+  bits are set to the cause code corresponding to the exception that precipitated the
+  double trap.
+fields:
+  INT:
+    location_rv32: 31
+    location_rv64: 63
+    description: |
+      Written by hardware when a resumable NMI is taken into M-mode.
+
+      When set, the last non-maskable exception was caused by an asynchronous Interrupt.
+
+      [when,"TRAP_ON_ILLEGAL_WLRL == true"]
+      If `mcause` is written with an undefined cause (combination of `mcause.INT` and `mcause.CODE`), an `Illegal Instruction` exception occurs.
+
+      [when,"TRAP_ON_ILLEGAL_WLRL == false"]
+      If `mcause` is written with an undefined cause (combination of `mcause.INT` and `mcause.CODE`), neither `mcause.INT` nor `mcause.CODE` are modified.
+    type: RW-H
+    reset_value: UNDEFINED_LEGAL
+  CODE:
+    location_rv32: 30-0
+    location_rv64: 62-0
+    description: |
+      TODO
+    type: RW-H
+    reset_value: UNDEFINED_LEGAL

backends/common_templates/adoc/csr.adoc.erb

@@ -67,7 +67,7 @@ This CSR has no fields. However, it must still exist (not cause an `Illegal Inst
 
 <%- csr.fields.each do |field| -%>
 [[<%=csr.name%>-<%=field.name%>-def]]
-===== `<%= field.name %>`
+=== `<%= field.name %>`
 
 [example]
 ****

backends/ext_pdf_doc/tasks.rake

@@ -55,6 +55,7 @@ rule %r{#{$root}/gen/ext_pdf_doc/.*/pdf/.*_extension\.pdf} => proc { |tname|
   config_name = Pathname.new(tname).relative_path_from("#{$root}/gen/ext_pdf_doc").to_s.split("/")[0]
   ext_name = Pathname.new(tname).basename(".pdf").to_s.split("_")[0..-2].join("_")
   [
+    ENV["THEME"],
     "#{$root}/ext/docs-resources/themes/riscv-pdf.yml",
     "#{$root}/gen/ext_pdf_doc/#{config_name}/adoc/#{ext_name}_extension.adoc"
   ]
@@ -70,7 +71,7 @@ rule %r{#{$root}/gen/ext_pdf_doc/.*/pdf/.*_extension\.pdf} => proc { |tname|
     "-v",
     "-a toc",
     "-a compress",
-    "-a pdf-theme=#{$root}/ext/docs-resources/themes/riscv-pdf.yml",
+    "-a pdf-theme=#{ENV['THEME']}",
     "-a pdf-fontsdir=#{$root}/ext/docs-resources/fonts",
     "-a imagesdir=#{$root}/ext/docs-resources/images",
     "-r asciidoctor-diagram",
@@ -128,7 +129,7 @@ rule %r{#{$root}/gen/ext_pdf_doc/.*/adoc/.*_extension\.adoc} => proc { |tname|
 } do |t|
   config_name = Pathname.new(t.name).relative_path_from("#{$root}/gen/ext_pdf_doc").to_s.split("/")[0]
 
-  cfg_arch = cfg_arch_for("_")
+  cfg_arch = cfg_arch_for(config_name)
 
   ext_name = Pathname.new(t.name).basename(".adoc").to_s.split("_")[0..-2].join("_")
 
@@ -143,11 +144,13 @@ rule %r{#{$root}/gen/ext_pdf_doc/.*/adoc/.*_extension\.adoc} => proc { |tname|
       ext.versions
     else
       vs = ext.versions.select do |ext_ver|
-        version_strs.include?(ext_ver.version_spec.to_s)
+        version_strs.any? { |v| v != "latest" && ext_ver.version_spec == VersionSpec.new(v) }
       end
       vs << ext.max_version if version_strs.include?("latest")
       vs.uniq
     end
+  raise "No version matches #{ENV['VERSION']}" if versions.empty?
+
   max_version = versions.max { |a, b| a.version <=> b.version }
   FileUtils.mkdir_p File.dirname(t.name)
   File.write t.name, AsciidocUtils.resolve_links(cfg_arch.find_replace_links(erb.result(binding)))
@@ -164,29 +167,36 @@ namespace :gen do
      * EXT - The extension name
      * CFG - The config name, required only when an overlay is required
      * VERSION - A list of versions to include. May also be "all" or "latest".
+     * THEME - path to an AsciidocPDF theme file. If not set, will use default RVI theme.
 
     Examples:
 
-     ./do gen:ext_pdf EXT=Xqci CFG=qc_iu VERSION=latest
+     ./do gen:ext_pdf EXT=Xqci CFG=qc_iu VERSION=latest THEME=cfgs/qc_iu/qc_theme.yaml
      ./do gen:ext_pdf EXT=B VERSION=all
      ./do gen:ext_pdf EXT=B VERSION=1.0.0
      ./do gen:ext_pdf EXT=B VERSION=1.0.0,1.1.0
 
   DESC
-  task :ext_pdf, [:extension] do |_t, args|
+  task :ext_pdf do
     raise ArgumentError, "Missing required argument EXT" if ENV["EXT"].nil?
 
     extension = ENV["EXT"]
     cfg = ENV["CFG"]
     version = ENV["VERSION"]
+    ENV["THEME"] =
+      if ENV["THEME"].nil?
+        "#{$root}/ext/docs-resources/themes/riscv-pdf.yml"
+      else
+        Pathname.new(ENV["THEME"]).realpath.to_s
+      end
 
     versions = version.split(",")
     raise ArgumentError, "Nothing else should be specified with 'all'" if versions.include?("all") && versions.size > 1
 
     if cfg.nil?
       Rake::Task[$root / "gen" / "ext_pdf_doc" / "_" / "pdf" / "#{extension}_extension.pdf"].invoke
     else
-      Rake::Task[$root / "gen" / "ext_pdf_doc" / cfg / "pdf" / "#{extension}_extension.pdf"].invoke(args)
+      Rake::Task[$root / "gen" / "ext_pdf_doc" / cfg / "pdf" / "#{extension}_extension.pdf"].invoke
     end
   end