Decoder attr

.github/workflows/pr.yml

@@ -163,7 +163,10 @@ jobs:
           ref: ${{ github.event.pull_request.head.sha }}
       - name: "Run testcases"
         run: |
-          nix run ".#ci-helper" -- runTests --jobs "${{ matrix.jobs }}"
+          nix develop -c t1-helper runTests --jobs "${{ matrix.jobs }}"
+      - name: "Run OM tests"
+        run: |
+          nix develop -c t1-helper runOMTests --jobs "${{ matrix.jobs }}"
 
   report:
     name: "Report CI result"

configgen/generated/blastoise.json

@@ -5,6 +5,7 @@
     "extensions": [
       "Zve32f"
     ],
+    "t1customInstructions": [],
     "lsuBankParameters": [
       {
         "name": "scalar",

configgen/generated/machamp.json

@@ -5,6 +5,7 @@
     "extensions": [
       "Zve32x"
     ],
+    "t1customInstructions": [],
     "lsuBankParameters": [
       {
         "name": "scalar",

configgen/generated/sandslash.json

@@ -5,6 +5,7 @@
     "extensions": [
       "Zve32x"
     ],
+    "t1customInstructions": [],
     "lsuBankParameters": [
       {
         "name": "scalar",

configgen/src/Main.scala

@@ -8,8 +8,10 @@ import chisel3.util.{BitPat, log2Ceil}
 import chisel3.util.experimental.BitSet
 import mainargs._
 import org.chipsalliance.t1.rtl._
+import org.chipsalliance.t1.rtl.decoder.T1CustomInstruction
 import org.chipsalliance.t1.rtl.lsu.LSUInstantiateParameter
 import org.chipsalliance.t1.rtl.vrf.RamType
+
 import java.util.LinkedHashMap
 
 object Main {
@@ -67,6 +69,7 @@ object Main {
       vLen,
       dLen,
       extensions = Seq("Zve32f"),
+      t1customInstructions = Nil,
       lsuBankParameters =
         // scalar bank 0-1G
         Seq(
@@ -138,6 +141,7 @@ object Main {
       vLen,
       dLen,
       extensions = Seq("Zve32x"),
+      t1customInstructions = Nil,
       // banks=8 dLen=512 beatbyte16
       lsuBankParameters =
         // scalar bank 0-1G
@@ -215,6 +219,7 @@ object Main {
       vLen,
       dLen,
       extensions = Seq("Zve32x"),
+      t1customInstructions = Nil,
       lsuBankParameters =
         // scalar bank 0-1G
         Seq(

ipemu/src/TestBench.scala

@@ -5,11 +5,27 @@ package org.chipsalliance.t1.ipemu
 
 import chisel3._
 import chisel3.experimental.SerializableModuleGenerator
-import chisel3.probe._
+import chisel3.experimental.hierarchy.{Instance, Instantiate, instantiable, public}
+import chisel3.properties.{AnyClassType, Class, ClassType, Property}
 import org.chipsalliance.t1.ipemu.dpi._
 import org.chipsalliance.t1.rtl.{T1, T1Parameter}
 
+@instantiable
+class TestBenchOM extends Class {
+  @public
+  val t1 = IO(Output(Property[AnyClassType]()))
+  @public
+  val t1In = IO(Input(Property[AnyClassType]()))
+  t1 := t1In
+}
+
 class TestBench(generator: SerializableModuleGenerator[T1, T1Parameter]) extends RawModule {
+  val omInstance: Instance[TestBenchOM] = Instantiate(new TestBenchOM)
+  val omType: ClassType = omInstance.toDefinition.getClassType
+  @public
+  val om: Property[ClassType] = IO(Output(Property[omType.Type]()))
+  om := omInstance.getPropertyReference
+
   // Scheduler to schedule different DPI calls for online difftest,
   // TODO: after switching to offline version, everything should be cleaned up.
   val clockRate = 5
@@ -32,6 +48,7 @@ class TestBench(generator: SerializableModuleGenerator[T1, T1Parameter]) extends
 
   val dut: T1 = withClockAndReset(clock, reset)(Module(generator.module()))
   dut.storeBufferClear := true.B
+  omInstance.t1In := Property(dut.om.asAnyClassType)
 
   val laneProbes = dut.laneProbes.zipWithIndex.map{case (p, idx) =>
     val wire = Wire(p.cloneType).suggestName(s"lane${idx}Probe")

nix/t1/default.nix

@@ -34,7 +34,7 @@ lib.makeScope newScope
     configgen = _millOutput.configgen // { meta.mainProgram = "configgen"; };
     t1package = _millOutput.t1package;
 
-    omreader = self.callPackage ./omreader.nix { };
+    omreader-unwrapped = self.callPackage ./omreader.nix { };
     submodules = self.callPackage ./submodules.nix { };
 
     riscv-opcodes-src = self.submodules.sources.riscv-opcodes.src;
@@ -65,10 +65,14 @@ lib.makeScope newScope
           elaborate = innerSelf.callPackage ./elaborate.nix { target = "ip"; /* use-binder = true; */ };
           mlirbc = innerSelf.callPackage ./mlirbc.nix { inherit elaborate; };
           rtl = innerSelf.callPackage ./rtl.nix { inherit mlirbc; };
+
+          omreader = self.omreader-unwrapped.mkWrapper { inherit mlirbc; };
+
           om = innerSelf.callPackage ./om.nix { inherit mlirbc; };
 
           emu-elaborate = innerSelf.callPackage ./elaborate.nix { target = "ipemu"; /* use-binder = true; */ };
           emu-mlirbc = innerSelf.callPackage ./mlirbc.nix { elaborate = emu-elaborate; };
+          emu-omreader = self.omreader-unwrapped.mkWrapper { mlirbc = emu-mlirbc; };
           emu-rtl = innerSelf.callPackage ./rtl.nix { mlirbc = emu-mlirbc; };
 
           emu = innerSelf.callPackage ./ipemu.nix { rtl = ip.emu-rtl; stdenv = moldStdenv; };

nix/t1/omreader.nix

@@ -1,5 +1,6 @@
 { lib
 , stdenv
+, runCommand
 , fetchMillDeps
 , makeWrapper
 , jdk21
@@ -41,12 +42,22 @@ let
       nativeBuildInputs = [ submodules.setupHook ];
     };
 
-    passthru.editable = self.overrideAttrs (_: {
-      shellHook = ''
-        setupSubmodulesEditable
-        mill mill.bsp.BSP/install 0
-      '';
-    });
+    passthru = {
+      editable = self.overrideAttrs (_: {
+        shellHook = ''
+          setupSubmodulesEditable
+          mill mill.bsp.BSP/install 0
+        '';
+      });
+
+      mkWrapper = { mlirbc }: runCommand "wrap-omreader"
+        { nativeBuildInputs = [ makeWrapper ]; meta.mainProgram = "omreader"; }
+        ''
+          mkdir -p "$out/bin"
+          mlirbc=$(find ${mlirbc}/ -type f)
+          makeWrapper ${self}/bin/omreader "$out/bin/omreader" --append-flags "--mlirbc-file $mlirbc"
+        '';
+    };
 
     shellHook = ''
       setupSubmodules

omreader/src/Main.scala

@@ -47,6 +47,16 @@ object Main {
     println(simplyGetT1Reader(mlirbcFile).dlen)
   }
 
+  @main
+  def decoderInstructionsJson(@arg(name = "mlirbc-file") mlirbcFile: os.Path) = {
+    println(simplyGetT1Reader(mlirbcFile).decoderInstructionsJson)
+  }
+
+  @main
+  def decoderInstructionsJsonPretty(@arg(name = "mlirbc-file") mlirbcFile: os.Path) = {
+    println(simplyGetT1Reader(mlirbcFile).decoderInstructionsJsonPretty)
+  }
+
   def simplyGetT1Reader(mlirbcFile: os.Path) = OMReader.fromFile(mlirbcFile).t1Reader
 
   def main(args: Array[String]): Unit = ParserForMethods(this).runOrExit(args)

omreaderlib/src/Interface.scala

@@ -44,6 +44,31 @@ class T1Reader private[omreaderlib](evaluator: PanamaCIRCTOMEvaluator, basePath:
 
   def vlen: Long = t1.field("vlen").asInstanceOf[PanamaCIRCTOMEvaluatorValuePrimitiveInteger].integer
   def dlen: Long = t1.field("dlen").asInstanceOf[PanamaCIRCTOMEvaluatorValuePrimitiveInteger].integer
+  private def decoderInstructionsJsonImpl: ujson.Value = {
+    val decoder = t1.field("decoder").asInstanceOf[PanamaCIRCTOMEvaluatorValueObject]
+    val instructions = decoder.field("instructions").asInstanceOf[PanamaCIRCTOMEvaluatorValueList]
+
+    instructions.elements.map(instruction => {
+      val instr = instruction.asInstanceOf[PanamaCIRCTOMEvaluatorValueObject]
+      val attributes = instr.field("attributes").asInstanceOf[PanamaCIRCTOMEvaluatorValueList]
+
+      ujson.Obj(
+        "attributes" -> attributes.elements.map(attribute => {
+          val attr = attribute.asInstanceOf[PanamaCIRCTOMEvaluatorValueObject]
+          val description = attr.field("description").asInstanceOf[PanamaCIRCTOMEvaluatorValuePrimitiveString].toString
+          val identifier = attr.field("identifier").asInstanceOf[PanamaCIRCTOMEvaluatorValuePrimitiveString].toString
+          val value = attr.field("value").asInstanceOf[PanamaCIRCTOMEvaluatorValuePrimitiveString].toString
+          ujson.Obj(
+            "description" -> description,
+            "identifier" -> identifier,
+            "value" -> value
+          )
+        })
+      )
+    })
+  }
+  def decoderInstructionsJson: String = ujson.write(decoderInstructionsJsonImpl)
+  def decoderInstructionsJsonPretty: String = ujson.write(decoderInstructionsJsonImpl, 2)
 
   def dumpMethods(): Unit = {
     val mirror = runtimeMirror(getClass.getClassLoader).reflect(this)
@@ -52,7 +77,13 @@ class T1Reader private[omreaderlib](evaluator: PanamaCIRCTOMEvaluator, basePath:
     )
     methods.foreach(method => {
       if (!method.name.toString.startsWith("dump")) {
-        val value = mirror.reflectMethod(method.asMethod)()
+        var value = mirror.reflectMethod(method.asMethod)().toString.replace("\n", "\\n")
+
+        val displayLength = 80
+        if (value.length > displayLength) {
+          value = value.take(displayLength) + s" (... ${value.length - displayLength} characters)"
+        }
+
         println(s"${method.name} = $value")
       }
     })