From 5eba8168fa68883f11afbfb7145193b609da0c68 Mon Sep 17 00:00:00 2001
From: Dmitry Selyutin <ghostmansd@gmail.com>
Date: Mon, 12 Sep 2022 22:28:52 +0300
Subject: [PATCH] power_insn: refactor RM mapping

---
 src/openpower/decoder/power_insn.py | 444 ++++++++++++++--------------
 1 file changed, 215 insertions(+), 229 deletions(-)

diff --git a/src/openpower/decoder/power_insn.py b/src/openpower/decoder/power_insn.py
index 1917dcf8..3c9ff73d 100644
--- a/src/openpower/decoder/power_insn.py
+++ b/src/openpower/decoder/power_insn.py
@@ -1180,18 +1180,77 @@ class PrefixedInstruction(Instruction):
 
 class Mode(_Mapping):
     _: _Field = range(0, 5)
-    sel: _Field = range(0, 2)
 
 
-class NormalMode(Mode):
-    class simple(Mode):
+class Extra(_Mapping):
+    _: _Field = range(0, 9)
+
+
+class Extra2(Extra):
+    idx0: _Field = range(0, 2)
+    idx1: _Field = range(2, 4)
+    idx2: _Field = range(4, 6)
+    idx3: _Field = range(6, 8)
+
+    def __getitem__(self, key):
+        return {
+            0: self.idx0,
+            1: self.idx1,
+            2: self.idx2,
+            3: self.idx3,
+            _SVExtra.Idx0: self.idx0,
+            _SVExtra.Idx1: self.idx1,
+            _SVExtra.Idx2: self.idx2,
+            _SVExtra.Idx3: self.idx3,
+        }[key]
+
+    def __setitem__(self, key, value):
+        self[key].assign(value)
+
+
+class Extra3(Extra):
+    idx0: _Field = range(0, 3)
+    idx1: _Field = range(3, 6)
+    idx2: _Field = range(6, 9)
+
+    def __getitem__(self, key):
+        return {
+            0: self.idx0,
+            1: self.idx1,
+            2: self.idx2,
+            _SVExtra.Idx0: self.idx0,
+            _SVExtra.Idx1: self.idx1,
+            _SVExtra.Idx2: self.idx2,
+        }[key]
+
+    def __setitem__(self, key, value):
+        self[key].assign(value)
+
+
+class BaseRM(_Mapping):
+    _: _Field = range(24)
+    mmode: _Field = (0,)
+    mask: _Field = range(1, 4)
+    elwidth: _Field = range(4, 6)
+    ewsrc: _Field = range(6, 8)
+    subvl: _Field = range(8, 10)
+    mode: Mode.remap(range(19, 24))
+    smask: _Field = range(16, 19)
+
+    extra: Extra.remap(range(10, 19))
+    extra2: Extra2.remap(range(10, 19))
+    extra3: Extra3.remap(range(10, 19))
+
+
+class NormalRM(BaseRM):
+    class simple(BaseRM):
         """simple mode"""
-        dz: Mode[3]
-        sz: Mode[4]
+        dz: BaseRM.mode[3]
+        sz: BaseRM.mode[4]
 
     class smr(Mode):
         """scalar reduce mode (mapreduce), SUBVL=1"""
-        RG: Mode[4]
+        RG: BaseRM.mode[4]
 
     class pmr(Mode):
         """parallel reduce mode (mapreduce), SUBVL=1"""
@@ -1199,55 +1258,55 @@ class NormalMode(Mode):
 
     class svmr(Mode):
         """subvector reduce mode, SUBVL>1"""
-        SVM: Mode[3]
+        SVM: BaseRM.mode[3]
 
     class pu(Mode):
         """Pack/Unpack mode, SUBVL>1"""
-        SVM: Mode[3]
+        SVM: BaseRM.mode[3]
 
     class ffrc1(Mode):
         """Rc=1: ffirst CR sel"""
-        inv: Mode[2]
-        CRbit: Mode[3, 4]
+        inv: BaseRM.mode[2]
+        CR: BaseRM.mode[3, 4]
 
     class ffrc0(Mode):
         """Rc=0: ffirst z/nonz"""
-        inv: Mode[2]
-        VLi: Mode[3]
-        RC1: Mode[4]
+        inv: BaseRM.mode[2]
+        VLi: BaseRM.mode[3]
+        RC1: BaseRM.mode[4]
 
     class sat(Mode):
         """sat mode: N=0/1 u/s, SUBVL=1"""
-        N: Mode[2]
-        dz: Mode[3]
-        sz: Mode[4]
+        N: BaseRM.mode[2]
+        dz: BaseRM.mode[3]
+        sz: BaseRM.mode[4]
 
     class satx(Mode):
         """sat mode: N=0/1 u/s, SUBVL>1"""
-        N: Mode[2]
-        zz: Mode[3]
-        dz: Mode[3]
-        sz: Mode[3]
+        N: BaseRM.mode[2]
+        zz: BaseRM.mode[3]
+        dz: BaseRM.mode[3]
+        sz: BaseRM.mode[3]
 
     class satpu(Mode):
         """Pack/Unpack sat mode: N=0/1 u/s, SUBVL>1"""
-        N: Mode[2]
-        zz: Mode[3]
-        dz: Mode[3]
-        sz: Mode[3]
+        N: BaseRM.mode[2]
+        zz: BaseRM.mode[3]
+        dz: BaseRM.mode[3]
+        sz: BaseRM.mode[3]
 
     class prrc1(Mode):
         """Rc=1: pred-result CR sel"""
-        inv: Mode[2]
-        CRbit: Mode[3, 4]
+        inv: BaseRM.mode[2]
+        CR: BaseRM.mode[3, 4]
 
     class prrc0(Mode):
         """Rc=0: pred-result z/nonz"""
-        inv: Mode[2]
-        zz: Mode[3]
-        RC1: Mode[4]
-        dz: Mode[3]
-        sz: Mode[3]
+        inv: BaseRM.mode[2]
+        zz: BaseRM.mode[3]
+        RC1: BaseRM.mode[4]
+        dz: BaseRM.mode[3]
+        sz: BaseRM.mode[3]
 
     simple: simple
     smr: smr
@@ -1263,50 +1322,50 @@ class NormalMode(Mode):
     prrc0: prrc0
 
 
-class LDSTImmMode(Mode):
+class LDSTImmRM(BaseRM):
     class simple(Mode):
         """simple mode"""
-        zz: Mode[3]
-        els: Mode[4]
-        dz: Mode[3]
-        sz: Mode[3]
+        zz: BaseRM.mode[3]
+        els: BaseRM.mode[4]
+        dz: BaseRM.mode[3]
+        sz: BaseRM.mode[3]
 
     class spu(Mode):
         """Structured Pack/Unpack"""
-        zz: Mode[3]
-        els: Mode[4]
-        dz: Mode[3]
-        sz: Mode[3]
+        zz: BaseRM.mode[3]
+        els: BaseRM.mode[4]
+        dz: BaseRM.mode[3]
+        sz: BaseRM.mode[3]
 
     class ffrc1(Mode):
         """Rc=1: ffirst CR sel"""
-        inv: Mode[2]
-        CRbit: Mode[3, 4]
+        inv: BaseRM.mode[2]
+        CR: BaseRM.mode[3, 4]
 
     class ffrc0(Mode):
         """Rc=0: ffirst z/nonz"""
-        inv: Mode[2]
-        els: Mode[3]
-        RC1: Mode[4]
+        inv: BaseRM.mode[2]
+        els: BaseRM.mode[3]
+        RC1: BaseRM.mode[4]
 
     class sat(Mode):
         """sat mode: N=0/1 u/s"""
-        N: Mode[2]
-        zz: Mode[3]
-        els: Mode[4]
-        dz: Mode[3]
-        sz: Mode[3]
+        N: BaseRM.mode[2]
+        zz: BaseRM.mode[3]
+        els: BaseRM.mode[4]
+        dz: BaseRM.mode[3]
+        sz: BaseRM.mode[3]
 
     class prrc1(Mode):
         """Rc=1: pred-result CR sel"""
-        inv: Mode[2]
-        CRbit: Mode[3, 4]
+        inv: BaseRM.mode[2]
+        CR: BaseRM.mode[3, 4]
 
     class prrc0(Mode):
         """Rc=0: pred-result z/nonz"""
-        inv: Mode[2]
-        els: Mode[3]
-        RC1: Mode[4]
+        inv: BaseRM.mode[2]
+        els: BaseRM.mode[3]
+        RC1: BaseRM.mode[4]
 
     simple: simple
     spu: spu
@@ -1317,37 +1376,37 @@ class LDSTImmMode(Mode):
     prrc0: prrc0
 
 
-class LDSTIdxMode(Mode):
+class LDSTIdxRM(BaseRM):
     class simple(Mode):
         """simple mode"""
-        SEA: Mode[2]
-        sz: Mode[3]
-        dz: Mode[3]
+        SEA: BaseRM.mode[2]
+        sz: BaseRM.mode[3]
+        dz: BaseRM.mode[3]
 
     class stride(Mode):
         """strided (scalar only source)"""
-        SEA: Mode[2]
-        dz: Mode[3]
-        sz: Mode[4]
+        SEA: BaseRM.mode[2]
+        dz: BaseRM.mode[3]
+        sz: BaseRM.mode[4]
 
     class sat(Mode):
         """sat mode: N=0/1 u/s"""
-        N: Mode[2]
-        dz: Mode[3]
-        sz: Mode[4]
+        N: BaseRM.mode[2]
+        dz: BaseRM.mode[3]
+        sz: BaseRM.mode[4]
 
     class prrc1(Mode):
         """Rc=1: pred-result CR sel"""
-        inv: Mode[2]
-        CRbit: Mode[3, 4]
+        inv: BaseRM.mode[2]
+        CR: BaseRM.mode[3, 4]
 
     class prrc0(Mode):
         """Rc=0: pred-result z/nonz"""
-        inv: Mode[2]
-        zz: Mode[3]
-        RC1: Mode[4]
-        dz: Mode[3]
-        sz: Mode[3]
+        inv: BaseRM.mode[2]
+        zz: BaseRM.mode[3]
+        RC1: BaseRM.mode[4]
+        dz: BaseRM.mode[3]
+        sz: BaseRM.mode[3]
 
     simple: simple
     stride: stride
@@ -1356,82 +1415,10 @@ class LDSTIdxMode(Mode):
     prrc0: prrc0
 
 
-class Extra(_Mapping):
-    _: _Field = range(0, 9)
-
-
-class Extra2(Extra):
-    idx0: _Field = range(0, 2)
-    idx1: _Field = range(2, 4)
-    idx2: _Field = range(4, 6)
-    idx3: _Field = range(6, 8)
-
-    def __getitem__(self, key):
-        return {
-            0: self.idx0,
-            1: self.idx1,
-            2: self.idx2,
-            3: self.idx3,
-            _SVExtra.Idx0: self.idx0,
-            _SVExtra.Idx1: self.idx1,
-            _SVExtra.Idx2: self.idx2,
-            _SVExtra.Idx3: self.idx3,
-        }[key]
-
-    def __setitem__(self, key, value):
-        self[key].assign(value)
-
-
-class Extra3(Extra):
-    idx0: _Field = range(0, 3)
-    idx1: _Field = range(3, 6)
-    idx2: _Field = range(6, 9)
-
-    def __getitem__(self, key):
-        return {
-            0: self.idx0,
-            1: self.idx1,
-            2: self.idx2,
-            _SVExtra.Idx0: self.idx0,
-            _SVExtra.Idx1: self.idx1,
-            _SVExtra.Idx2: self.idx2,
-        }[key]
-
-    def __setitem__(self, key, value):
-        self[key].assign(value)
-
-
-class RMBase(_Mapping):
-    _: _Field = range(24)
-    mmode: _Field = (0,)
-    mask: _Field = range(1, 4)
-    elwidth: _Field = range(4, 6)
-    ewsrc: _Field = range(6, 8)
-    subvl: _Field = range(8, 10)
-    mode: Mode.remap(range(19, 24))
-    smask: _Field = range(16, 19)
-
-    extra: Extra.remap(range(10, 19))
-    extra2: Extra2.remap(range(10, 19))
-    extra3: Extra3.remap(range(10, 19))
-
-
-class RMNormal(RMBase):
-    mode: NormalMode
-
-
-class RMLDSTImm(RMBase):
-    mode: LDSTImmMode
-
-
-class RMLDSTIdx(RMBase):
-    mode: LDSTIdxMode
-
-
-class RM(RMBase):
-    normal: RMNormal
-    ldst_imm: RMLDSTImm
-    ldst_idx: RMLDSTIdx
+class RM(BaseRM):
+    normal: NormalRM
+    ldst_imm: LDSTImmRM
+    ldst_idx: LDSTIdxRM
 
 
 class SVP64Instruction(PrefixedInstruction):
@@ -1456,7 +1443,7 @@ class SVP64Instruction(PrefixedInstruction):
             bits.append(bit)
         return "".join(map(str, bits))
 
-    def mode(self, db):
+    def rm(self, db):
         record = self.record(db=db)
 
         Rc = False
@@ -1465,111 +1452,110 @@ class SVP64Instruction(PrefixedInstruction):
 
         record = self.record(db=db)
         subvl = self.prefix.rm.subvl
-        mode = self.prefix.rm.mode
-        sel = mode.sel
+        rm = self.prefix.rm
 
         if record.svp64.mode is _SVMode.BRANCH:
-            return (self.prefix.rm.mode, "branch")
+            return (rm, "branch")
 
         elif record.svp64.mode is _SVMode.CROP:
-            return (self.prefix.rm.mode, "crop")
+            return (rm, "crop")
 
         elif record.svp64.mode is _SVMode.NORMAL:
-            mode = self.prefix.rm.normal.mode
-            if sel == 0b00:
-                if mode[2] == 0b0:
-                    mode = mode.simple
+            rm = rm.normal
+            if rm.mode[0:2] == 0b00:
+                if rm.mode[2] == 0b0:
+                    rm = rm.simple
                 else:
                     if subvl == 0b00:
-                        if mode[3] == 0b0:
-                            mode = mode.smr
+                        if rm.mode[3] == 0b0:
+                            rm = rm.smr
                         else:
-                            mode = mode.pmr
+                            rm = rm.pmr
                     else:
-                        if mode[4] == 0b0:
-                            mode = mode.svmr
+                        if rm.mode[4] == 0b0:
+                            rm = rm.svmr
                         else:
-                            mode = mode.pu
-            elif sel == 0b01:
+                            rm = rm.pu
+            elif rm.mode[0:2] == 0b01:
                 if Rc:
-                    mode = mode.ffrc1
+                    rm = rm.ffrc1
                 else:
-                    mode = mode.ffrc0
-            elif sel == 0b10:
+                    rm = rm.ffrc0
+            elif rm.mode[0:2] == 0b10:
                 if subvl == 0b00:
-                    mode = mode.sat
+                    rm = rm.sat
                 else:
-                    if mode[4]:
-                        mode = mode.satx
+                    if rm.mode[4]:
+                        rm = rm.satx
                     else:
-                        mode = mode.satpu
-            elif sel == 0b11:
+                        rm = rm.satpu
+            elif rm.mode[0:2] == 0b11:
                 if Rc:
-                    mode = mode.prrc1
+                    rm = rm.prrc1
                 else:
-                    mode = mode.prrc0
+                    rm = rm.prrc0
         elif record.svp64.mode is _SVMode.LDST_IMM:
-            mode = self.prefix.rm.ldst_imm.mode
-            if sel == 0b00:
-                if mode[2] == 0b0:
-                    mode = mode.simple
+            rm = rm.ldst_imm
+            if rm.mode[0:2] == 0b00:
+                if rm.mode[2] == 0b0:
+                    rm = rm.simple
                 else:
-                    mode = mode.spu
-            elif sel == 0b01:
+                    rm = rm.spu
+            elif rm.mode[0:2] == 0b01:
                 if Rc:
-                    mode = mode.ffrc1
+                    rm = rm.ffrc1
                 else:
-                    mode = mode.ffrc0
-            elif sel == 0b10:
-                mode = mode.sat
-            elif sel == 0b11:
+                    rm = rm.ffrc0
+            elif rm.mode[0:2] == 0b10:
+                rm = rm.sat
+            elif rm.mode[0:2] == 0b11:
                 if Rc:
-                    mode = mode.prrc1
+                    rm = rm.prrc1
                 else:
-                    mode = mode.prrc0
+                    rm = rm.prrc0
         elif record.svp64.mode is _SVMode.LDST_IMM:
-            mode = self.prefix.rm.ldst_idx.mode
-            if mode.sel == 0b00:
-                mode = mode.simple
-            elif mode.sel == 0b01:
-                mode = mode.stride
-            elif mode.sel == 0b10:
-                mode = mode.sat
-            elif mode.sel == 0b11:
+            rm = rm.ldst_idx
+            if rm.mode[0:2] == 0b00:
+                rm = rm.simple
+            elif rm.mode[0:2] == 0b01:
+                rm = rm.stride
+            elif rm.mode[0:2] == 0b10:
+                rm = rm.sat
+            elif rm.mode[0:2] == 0b11:
                 if Rc:
-                    mode = mode.prrc1
+                    rm = rm.prrc1
                 else:
-                    mode = mode.prrc0
-
-        modes = {
-            NormalMode.simple: "normal: simple",
-            NormalMode.smr: "normal: smr",
-            NormalMode.pmr: "normal: pmr",
-            NormalMode.svmr: "normal: svmr",
-            NormalMode.pu: "normal: pu",
-            NormalMode.ffrc1: "normal: ffrc1",
-            NormalMode.ffrc0: "normal: ffrc0",
-            NormalMode.sat: "normal: sat",
-            NormalMode.satx: "normal: satx",
-            NormalMode.satpu: "normal: satpu",
-            NormalMode.prrc1: "normal: prrc1",
-            NormalMode.prrc0: "normal: prrc0",
-            LDSTImmMode.simple: "ld/st imm: simple",
-            LDSTImmMode.spu: "ld/st imm: spu",
-            LDSTImmMode.ffrc1: "ld/st imm: ffrc1",
-            LDSTImmMode.ffrc0: "ld/st imm: ffrc0",
-            LDSTImmMode.sat: "ld/st imm: sat",
-            LDSTImmMode.prrc1: "ld/st imm: prrc1",
-            LDSTImmMode.prrc0: "ld/st imm: prrc0",
-            LDSTIdxMode.simple: "ld/st idx simple",
-            LDSTIdxMode.stride: "ld/st idx stride",
-            LDSTIdxMode.sat: "ld/st idx sat",
-            LDSTIdxMode.prrc1: "ld/st idx prrc1",
-            LDSTIdxMode.prrc0: "ld/st idx prrc0",
+                    rm = rm.prrc0
+
+        table = {
+            NormalRM.simple: "normal: simple",
+            NormalRM.smr: "normal: smr",
+            NormalRM.pmr: "normal: pmr",
+            NormalRM.svmr: "normal: svmr",
+            NormalRM.pu: "normal: pu",
+            NormalRM.ffrc1: "normal: ffrc1",
+            NormalRM.ffrc0: "normal: ffrc0",
+            NormalRM.sat: "normal: sat",
+            NormalRM.satx: "normal: satx",
+            NormalRM.satpu: "normal: satpu",
+            NormalRM.prrc1: "normal: prrc1",
+            NormalRM.prrc0: "normal: prrc0",
+            LDSTImmRM.simple: "ld/st imm: simple",
+            LDSTImmRM.spu: "ld/st imm: spu",
+            LDSTImmRM.ffrc1: "ld/st imm: ffrc1",
+            LDSTImmRM.ffrc0: "ld/st imm: ffrc0",
+            LDSTImmRM.sat: "ld/st imm: sat",
+            LDSTImmRM.prrc1: "ld/st imm: prrc1",
+            LDSTImmRM.prrc0: "ld/st imm: prrc0",
+            LDSTIdxRM.simple: "ld/st idx: simple",
+            LDSTIdxRM.stride: "ld/st idx: stride",
+            LDSTIdxRM.sat: "ld/st idx: sat",
+            LDSTIdxRM.prrc1: "ld/st idx: prrc1",
+            LDSTIdxRM.prrc0: "ld/st idx: prrc0",
         }
-        for (cls, desc) in modes.items():
-            if isinstance(mode, cls):
-                return (mode, desc)
+        for (cls, desc) in table.items():
+            if isinstance(rm, cls):
+                return (rm, desc)
 
         raise ValueError(self)
 
@@ -1601,7 +1587,7 @@ class SVP64Instruction(PrefixedInstruction):
         if blob_suffix:
             yield f"{blob_suffix}"
 
-        (mode, mode_desc) = self.mode(db=db)
+        (rm, rm_desc) = self.rm(db=db)
 
         if verbosity >= Verbosity.VERBOSE:
             indent = (" " * 4)
@@ -1628,8 +1614,8 @@ class SVP64Instruction(PrefixedInstruction):
                 yield from operand.disassemble(insn=self, record=record,
                     verbosity=verbosity, indent=indent)
 
-            yield f"{indent}mode"
-            yield f"{indent}{indent}{mode_desc}"
+            yield f"{indent}RM"
+            yield f"{indent}{indent}{rm_desc}"
             yield ""
 
 
-- 
2.30.2