fix: cfgs with custom overlays; was broken by refactoring (riscv-software-src#908)

- Fixes the generation of an extension PDF when a custom overlay is
involved
- Fixes some minor IDL issues in Xqci that were revealed by recent
compiler improvements
- Adds the Xqci document generation to regression tests

Author: dhower-qc

.github/workflows/regress.yml

@@ -201,6 +201,17 @@ jobs:
         uses: ./.github/actions/singularity-setup
       - name: Run cpp unit tests
         run: ./do test:cpp_hart CONFIG=rv64 JOBS=4
+  regress-xqci-doc:
+    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: Run cpp unit tests
+        run: ./do gen:ext_pdf EXT=Xqci CFG=qc_iu.yaml VERSION=latest
   call-deploy:
     uses: ./.github/workflows/merge.yml
     with:

backends/ext_pdf_doc/tasks.rake

@@ -34,6 +34,7 @@ rule %r{#{$resolver.gen_path}/ext_pdf_doc/.*/pdf/.*_extension\.pdf} => proc { |t
     "-a pdf-theme=#{ENV['THEME']}",
     "-a pdf-fontsdir=#{$root}/ext/docs-resources/fonts",
     "-a imagesdir=#{$root}/ext/docs-resources/images",
+    "-a wavedrom=#{$root}/node_modules/.bin/wavedrom-cli",
     "-r asciidoctor-diagram",
     "-r idl_highlighter",
     "-o #{t.name}",
@@ -62,6 +63,7 @@ rule %r{#{$resolver.gen_path}/ext_pdf_doc/.*/html/.*_extension\.html} => proc {
     "-v",
     "-a toc",
     "-r asciidoctor-diagram",
+    "-a wavedrom=#{$root}/node_modules/.bin/wavedrom-cli",
     "-o #{t.name}",
     adoc_file
   ].join(" ")
@@ -74,7 +76,7 @@ rule %r{#{$resolver.gen_path}/ext_pdf_doc/.*/adoc/.*_extension\.adoc} => proc {
   config_name = Pathname.new(tname).relative_path_from("#{$resolver.gen_path}/ext_pdf_doc").to_s.split("/")[0]
   arch_yaml_paths = Dir.glob("#{$resolver.resolved_spec_path(config_name)}/**/*.yaml")
   cfg_path = $resolver.gen_path / "ext_pdf_doc" / "#{config_name}.yaml"
-  cfg = Udb::AbstractConfig.create(cfg_path)
+  cfg = Udb::AbstractConfig.create(cfg_path, $resolver.cfg_info(config_name))
   arch_yaml_paths += Dir.glob("#{cfg.arch_overlay_abs}/**/*.yaml") unless cfg.arch_overlay.nil?
   [
     (EXT_PDF_DOC_DIR / "templates" / "ext_pdf.adoc.erb").to_s,

backends/ext_pdf_doc/templates/ext_pdf.adoc.erb

@@ -47,7 +47,6 @@
 // Settings
 :experimental:
 :reproducible:
-:wavedrom: <%= $root %>/node_modules/.bin/wavedrom-cli
 // needs to be changed
 :imagesoutdir: images
 :icons: font

backends/portfolio/tasks.rake

@@ -13,13 +13,12 @@ require "idlc/passes/gen_adoc"
 
 require "udb/config"
 
-# @return [Architecture]
+sig { returns(Udb::ConfiguredArchitecture) }
 def pf_create_arch
   $resolver.cfg_arch_for("_")
 end
 
-# @param portfolio_grp_with_arch [PortfolioGroup] Contains one or more Portfolio objects that have an arch (not a cfg_arch).
-# @return [ConfiguredArchitecture]
+# @param portfolio_grp_with_arch Contains one or more Portfolio objects that have an arch (not a cfg_arch).
 sig { params(portfolio_grp_with_arch: Udb::PortfolioGroup).returns(Udb::ConfiguredArchitecture) }
 def pf_create_cfg_arch(portfolio_grp_with_arch)
   # Create a ConfiguredArchitecture object and provide it a PortfolioGroupConfig object to implement the AbstractConfig API.
@@ -29,8 +28,7 @@ def pf_create_cfg_arch(portfolio_grp_with_arch)
   # object can require that the PortfolioGroup DatabaseObjects contain a ConfiguredArchitecture.
   Udb::ConfiguredArchitecture.new(
     portfolio_grp_with_arch.name,
-    Udb::AbstractConfig.create(portfolio_grp_with_arch),
-    $resolver.gen_path / "resolved_spec" / "_"
+    Udb::AbstractConfig.create(portfolio_grp_with_arch, $resolver.cfg_info("_"))
   )
 end
 

spec/custom/isa/qc_iu/inst/Xqci/qc.addsat.yaml

@@ -34,13 +34,13 @@ access:
   vs: always
   vu: always
 operation(): |
-  Bits<xlen()+1> sum = X[rs1] `+ X[rs2];
-  Bits<xlen()+1> most_negative_number = {2'b11,{(xlen()-1){1'b0}}};
-  Bits<xlen()+1> most_positive_number = {2'b00,{(xlen()-1){1'b1}}};
+  Bits<MXLEN+1> sum = X[rs1] `+ X[rs2];
+  Bits<MXLEN+1> most_negative_number = {2'b11,{(xlen()-1){1'b0}}};
+  Bits<MXLEN+1> most_positive_number = {2'b00,{(xlen()-1){1'b1}}};
   # overflow occurs if the operands are the same sign and the result is a different sign
   if (X[rs1][xlen()-1] == X[rs2][xlen()-1]) {
     if (sum[xlen()-1] != X[rs1][xlen()-1]) {
-      if ($signed(X[rs1]) < 0) {
+      if ($signed(X[rs1]) < 's0) {
         sum = most_negative_number;
       } else {
         sum = most_positive_number;

spec/custom/isa/qc_iu/inst/Xqci/qc.addusat.yaml

@@ -34,8 +34,8 @@ access:
   vs: always
   vu: always
 operation(): |
-  Bits<xlen()+1> sum = X[rs1] `+ X[rs2];
-  Bits<xlen()+1> largest_unsigned_value = {1'b0, {xlen(){1'b1}}};
+  Bits<MXLEN+1> sum = X[rs1] `+ X[rs2];
+  Bits<MXLEN+1> largest_unsigned_value = {1'b0, {xlen(){1'b1}}};
 
   if (sum > largest_unsigned_value) {
     X[rd] = largest_unsigned_value[(xlen() - 1):0];

spec/custom/isa/qc_iu/inst/Xqci/qc.shlsat.yaml

@@ -34,10 +34,10 @@ access:
   vs: always
   vu: always
 operation(): |
-  Bits<xlen()`*2> sext_double_width_rs1 = {{xlen(){X[rs1][xlen()-1]}}, X[rs1]};
-  Bits<xlen()`*2> shifted_value = sext_double_width_rs1 << X[rs2][4:0];
-  Bits<xlen()`*2> most_negative_number = {{(xlen()+1){1'b1}}, {(xlen()-1){1'b0}}};
-  Bits<xlen()`*2> most_positive_number = {{(xlen()+1){1'b0}}, {(xlen()-1){1'b1}}};
+  Bits<MXLEN`*2> sext_double_width_rs1 = {{xlen(){X[rs1][xlen()-1]}}, X[rs1]};
+  Bits<MXLEN`*2> shifted_value = sext_double_width_rs1 << X[rs2][4:0];
+  Bits<MXLEN`*2> most_negative_number = {{(xlen()+1){1'b1}}, {(xlen()-1){1'b0}}};
+  Bits<MXLEN`*2> most_positive_number = {{(xlen()+1){1'b0}}, {(xlen()-1){1'b1}}};
 
   if ($signed(shifted_value) < $signed(most_negative_number)) {
     X[rd] = most_negative_number[(xlen() - 1):0];

spec/custom/isa/qc_iu/inst/Xqci/qc.shlusat.yaml

@@ -34,9 +34,9 @@ access:
   vs: always
   vu: always
 operation(): |
-  Bits<xlen()`*2> zext_double_width_rs1 = {{xlen(){1'b0}}, X[rs1]};
-  Bits<xlen()`*2> shifted_value = zext_double_width_rs1 << X[rs2][4:0];
-  Bits<xlen()`*2> largest_unsigned_value = {{xlen(){1'b0}}, {xlen(){1'b1}}};
+  Bits<MXLEN`*2> zext_double_width_rs1 = {{xlen(){1'b0}}, X[rs1]};
+  Bits<MXLEN`*2> shifted_value = zext_double_width_rs1 << X[rs2][4:0];
+  Bits<MXLEN`*2> largest_unsigned_value = {{xlen(){1'b0}}, {xlen(){1'b1}}};
 
   if (shifted_value > largest_unsigned_value) {
     X[rd] = largest_unsigned_value[(xlen() - 1):0];

spec/custom/isa/qc_iu/inst/Xqci/qc.subsat.yaml

@@ -34,14 +34,14 @@ access:
   vs: always
   vu: always
 operation(): |
-  Bits<xlen()+1> result = X[rs1] `- X[rs2];
-  Bits<xlen()+1> most_negative_number = {2'b11,{(xlen()-1){1'b0}}};
-  Bits<xlen()+1> most_positive_number = {2'b00,{(xlen()-1){1'b1}}};
+  Bits<MXLEN+1> result = X[rs1] `- X[rs2];
+  Bits<MXLEN+1> most_negative_number = {2'b11,{(xlen()-1){1'b0}}};
+  Bits<MXLEN+1> most_positive_number = {2'b00,{(xlen()-1){1'b1}}};
 
   # overflow occurs if the operands have different signs and the result is a different sign than the first operand
   if (X[rs1][xlen()-1] != X[rs2][xlen()-1]) {
     if (result[xlen()-1] != X[rs1][xlen()-1]) {
-      if ($signed(X[rs1]) < 0) {
+      if ($signed(X[rs1]) < 's0) {
         result = most_negative_number;
       } else {
         result = most_positive_number;

spec/custom/isa/qc_iu/inst/Xqci/qc.wrap.yaml

@@ -38,6 +38,6 @@ operation(): |
   XReg rs1_value = X[rs1];
   X[rd] = ($signed(rs1_value) >= $signed(X[rs2]))
     ? rs1_value - X[rs2]
-    : (($signed(rs1_value) < 0)
+    : (($signed(rs1_value) < 's0)
        ? (rs1_value + X[rs2])
        : rs1_value);