Fix privileged instructions... all coming back to me now

Author: theandrew168

bronzebeard/asm.py

@@ -163,6 +163,7 @@ def r_type(rd, rs1, rs2, *, opcode, funct3, funct7):
 
     return code
 
+
 # r-type variation for privileged instructions
 def rp_type(rs1, rs2, *, rd, opcode, funct3, funct7):
     rd = lookup_register(rd)
@@ -832,15 +833,15 @@ def cj_type(imm, *, opcode, funct3, cs=None):
 C_SWSP     = partial(css_type, opcode=0b10, funct3=0b110)
 
 # RV32 Priv: Trap-Return Instructions
-SRET  = partial(rp_type, opcode=0b1110011, rd=0, funct3=0b000, rs1=0, rs2=0b00010, funct7=0b0001000)  # special syntax
-MRET  = partial(rp_type, opcode=0b1110011, rd=0, funct3=0b000, rs1=0, rs2=0b00010, funct7=0b0011000)  # special syntax
-MNRET = partial(rp_type, opcode=0b1110011, rd=0, funct3=0b000, rs1=0, rs2=0b00010, funct7=0b0111000)  # special syntax
+SRET  = partial(i_type, opcode=0b1110011, rd=0, funct3=0b000, rs1=0, imm=0b000100000010)  # special syntax
+MRET  = partial(i_type, opcode=0b1110011, rd=0, funct3=0b000, rs1=0, imm=0b001100000010)  # special syntax
+MNRET = partial(i_type, opcode=0b1110011, rd=0, funct3=0b000, rs1=0, imm=0b011100000010)  # special syntax
 
 # RV32 Priv: Interrupt-Management Instructions
-WFI = partial(rp_type, opcode=0b1110011, rd=0, funct3=0b000, rs1=0, rs2=0b00101, funct7=0b0001000)  # special syntax
+WFI = partial(i_type, opcode=0b1110011, rd=0, funct3=0b000, rs1=0, imm=0b000100000101)  # special syntax
 
 # RV32 Priv: Control Transfer Records Management Instructions
-SCTRCLR = partial(rp_type, opcode=0b1110011, rd=0, funct3=0b000, rs1=0, rs2=0b00100, funct7=0b0001000)  # special syntax
+SCTRCLR = partial(i_type, opcode=0b1110011, rd=0, funct3=0b000, rs1=0, imm=0b000100000100)  # special syntax
 
 # RV32 Priv: Supervisor Memory-Management Instructions
 SFENCE_VMA = partial(rp_type, opcode=0b1110011, rd=0, funct3=0b000,funct7=0b0001001)  # special syntax
@@ -863,8 +864,8 @@ def cj_type(imm, *, opcode, funct3, cs=None):
 
 # RV32 Priv: Svinval Memory-Management Extension
 SINVAL_VMA      = partial(rp_type, opcode=0b1110011, rd=0, funct3=0b000, funct7=0b0001011)  # special syntax
-SFENCE_W_INVAL  = partial(rp_type, opcode=0b1110011, rd=0, funct3=0b000, rs1=0, rs2=0, funct7=0b0001100)  # special syntax
-SFENCE_INVAL_IR = partial(rp_type, opcode=0b1110011, rd=0, funct3=0b000, rs1=0, rs2=1, funct7=0b0001100)  # special syntax
+SFENCE_W_INVAL  = partial(i_type, opcode=0b1110011, rd=0, funct3=0b000, rs1=0, imm=0b000110000000)  # special syntax
+SFENCE_INVAL_IR = partial(i_type, opcode=0b1110011, rd=0, funct3=0b000, rs1=0, imm=0b000110000001)  # special syntax
 HINVAL_VVMA     = partial(rp_type, opcode=0b1110011, rd=0, funct3=0b000, funct7=0b0010011)  # special syntax
 HINVAL_GVMA     = partial(rp_type, opcode=0b1110011, rd=0, funct3=0b000, funct7=0b0110011)  # special syntax
 
@@ -892,6 +893,19 @@ def cj_type(imm, *, opcode, funct3, cs=None):
     'remu':   REMU,
 }
 
+RP_TYPE_INSTRUCTIONS = {
+    # Privileged Instructions
+    'sfence.vma':  SFENCE_VMA,
+    'hfence.vvma': HFENCE_VVMA,
+    'hfence.gvma': HFENCE_GVMA,
+    'hsv.b':       HSV_B,
+    'hsv.h':       HSV_H,
+    'hsv.w':       HSV_W,
+    'sinval.vma':  SINVAL_VMA,
+    'hinval.vvma': HINVAL_VVMA,
+    'hinval.gvma': HINVAL_GVMA,
+}
+
 I_TYPE_INSTRUCTIONS = {
     'jalr':   JALR,
     'lb':     LB,
@@ -913,10 +927,30 @@ def cj_type(imm, *, opcode, funct3, cs=None):
     'csrrci': CSRRCI,
 }
 
+IP_TYPE_INSTRUCTIONS = {
+    # Privileged Instructions
+    'hlv.b':   HLV_B,
+    'hlv.bu':  HLV_BU,
+    'hlv.h':   HLV_H,
+    'hlv.hu':  HLV_HU,
+    'hlv.w':   HLV_W,
+    'hlvx.hu': HLVX_HU,
+    'hlvx.wu': HLVX_WU,
+}
+
 IE_TYPE_INSTRUCTIONS = {
     'ecall':   ECALL,
     'ebreak':  EBREAK,
     'fence.i': FENCE_I,
+
+    # Privileged Instructions
+    'sret':            SRET,
+    'mret':            MRET,
+    'mnret':           MNRET,
+    'wfi':             WFI,
+    'sctrclr':         SCTRCLR,
+    'sfence.w.inval':  SFENCE_W_INVAL,
+    'sfence.inval.ir': SFENCE_INVAL_IR,
 }
 
 S_TYPE_INSTRUCTIONS = {
@@ -1030,41 +1064,11 @@ def cj_type(imm, *, opcode, funct3, cs=None):
     'c.j':   C_J,
 }
 
-PRIV_INSTRUCTIONS = {
-    'sret': SRET,
-    'mret': MRET,
-    'mnret': MNRET,
-
-    'wfi': WFI,
-
-    'sctrclr': SCTRCLR,
-
-    'sfence.vma': SFENCE_VMA,
-
-    'hfence.vvma': HFENCE_VVMA,
-    'hfence.gvma': HFENCE_GVMA,
-
-    'hlv.b':   HLV_B,
-    'hlv.bu':  HLV_BU,
-    'hlv.h':   HLV_H,
-    'hlv.hu':  HLV_HU,
-    'hlv.w':   HLV_W,
-    'hlvx.hu': HLVX_HU,
-    'hlvx.wu': HLVX_WU,
-    'hsv.b':   HSV_B,
-    'hsv.h':   HSV_H,
-    'hsv.w':   HSV_W,
-
-    'sinval.vma':      SINVAL_VMA,
-    'sfence.w.inval':  SFENCE_W_INVAL,
-    'sfence.inval.ir': SFENCE_INVAL_IR,
-    'hinval.vvma':     HINVAL_VVMA,
-    'hinval.gvma':     HINVAL_GVMA,
-}
-
 INSTRUCTIONS = {}
 INSTRUCTIONS.update(R_TYPE_INSTRUCTIONS)
+INSTRUCTIONS.update(RP_TYPE_INSTRUCTIONS)
 INSTRUCTIONS.update(I_TYPE_INSTRUCTIONS)
+INSTRUCTIONS.update(IP_TYPE_INSTRUCTIONS)
 INSTRUCTIONS.update(IE_TYPE_INSTRUCTIONS)
 INSTRUCTIONS.update(S_TYPE_INSTRUCTIONS)
 INSTRUCTIONS.update(B_TYPE_INSTRUCTIONS)
@@ -1086,7 +1090,6 @@ def cj_type(imm, *, opcode, funct3, cs=None):
 INSTRUCTIONS.update(CA_TYPE_INSTRUCTIONS)
 INSTRUCTIONS.update(CB_TYPE_INSTRUCTIONS)
 INSTRUCTIONS.update(CJ_TYPE_INSTRUCTIONS)
-INSTRUCTIONS.update(PRIV_INSTRUCTIONS)
 
 PSEUDO_INSTRUCTIONS = {
     'nop',
@@ -1638,6 +1641,29 @@ def args(self):
         return [self.rd, self.rs1, self.rs2]
 
 
+# custom syntax for privileged instructions
+class RPTypeInstruction(Instruction):
+
+    def __init__(self, line, name, rs1, rs2):
+        super().__init__(line)
+        self.name = name
+        self.rs1 = rs1
+        self.rs2 = rs2
+
+    def __repr__(self):
+        s = '{}({!r}, rs1={!r}, rs2={!r})'
+        s = s.format(type(self).__name__, self.name, self.rs1, self.rs2)
+        return s
+
+    def __str__(self):
+        s = '{} {}, {}'
+        s = s.format(self.name, self.rs1, self.rs2)
+        return s
+
+    def args(self):
+        return [self.rs1, self.rs2]
+
+
 class ITypeInstruction(Instruction):
 
     def __init__(self, line, name, rd, rs1, imm, is_auipc_jump=False):
@@ -1662,6 +1688,29 @@ def args(self):
         return [self.rd, self.rs1, self.imm]
 
 
+# custom syntax for privileged instructions
+class IPTypeInstruction(Instruction):
+
+    def __init__(self, line, name, rd, rs1):
+        super().__init__(line)
+        self.name = name
+        self.rd = rd
+        self.rs1 = rs1
+
+    def __repr__(self):
+        s = '{}({!r}, rd={!r}, rs1={!r})'
+        s = s.format(type(self).__name__, self.name, self.rd, self.rs1)
+        return s
+
+    def __str__(self):
+        s = '{} {}, {}'
+        s = s.format(self.name, self.rd, self.rs1)
+        return s
+
+    def args(self):
+        return [self.rd, self.rs1]
+
+
 # custom syntax for: ecall, ebreak, fence.i
 class IETypeInstruction(Instruction):
 
@@ -2361,6 +2410,13 @@ def parse_item(line_tokens):
         name, rd, rs1, rs2 = tokens
         name = name.lower()
         return RTypeInstruction(line, name, rd, rs1, rs2)
+    # rp-type instructions
+    elif head in RP_TYPE_INSTRUCTIONS:
+        if len(tokens) != 3:
+            raise AssemblerError('rp-type instructions require exactly 2 args', line)
+        name, rs1, rs2 = tokens
+        name = name.lower()
+        return RPTypeInstruction(line, name, rs1, rs2)
     # i-type instructions
     elif head in I_TYPE_INSTRUCTIONS:
         # check for jalr PI
@@ -2376,6 +2432,13 @@ def parse_item(line_tokens):
         name = name.lower()
         imm = parse_immediate(imm, line)
         return ITypeInstruction(line, name, rd, rs1, imm)
+    # ip-type instructions
+    elif head in IP_TYPE_INSTRUCTIONS:
+        if len(tokens) != 3:
+            raise AssemblerError('ip-type instructions require exactly 2 args', line)
+        name, rd, rs1 = tokens
+        name = name.lower()
+        return IPTypeInstruction(line, name, rd, rs1)
     # ie-type instructions
     elif head in IE_TYPE_INSTRUCTIONS:
         name, = tokens
@@ -2567,7 +2630,6 @@ def parse_item(line_tokens):
             imm = ['%offset', reference]
         imm = parse_immediate(imm, line)
         return CJTypeInstruction(line, name, imm)
-
     # pseudo instructions
     elif head in PSEUDO_INSTRUCTIONS:
         name, *args = tokens

tests/test_isa_priv.py

@@ -1,3 +1,5 @@
+import struct
+
 import pytest
 
 from bronzebeard import asm
@@ -204,4 +206,34 @@ def test_hinval_vvma(rs1, rs2, code):
     (31,  31,  0b01100111111111111000000001110011),
 ])
 def test_hinval_gvma(rs1, rs2, code):
-    assert asm.HINVAL_GVMA(rs1, rs2) == code
+    assert asm.HINVAL_GVMA(rs1, rs2) == code
+
+
+@pytest.mark.parametrize(
+    'source,              expected', [
+    ('sret',              asm.SRET()),
+    ('mret',              asm.MRET()),
+    ('mnret',             asm.MNRET()),
+    ('wfi',               asm.WFI()),
+    ('sctrclr',           asm.SCTRCLR()),
+    ('sfence.vma x0 x1',  asm.SFENCE_VMA('x0', 'x1')),
+    ('hfence.vvma x0 x1', asm.HFENCE_VVMA('x0', 'x1')),
+    ('hfence.gvma x0 x1', asm.HFENCE_GVMA('x0', 'x1')),
+    ('hlv.b x0 x1',       asm.HLV_B('x0', 'x1')),
+    ('hlv.bu x0 x1',      asm.HLV_BU('x0', 'x1')),
+    ('hlv.h x0 x1',       asm.HLV_H('x0', 'x1')),
+    ('hlv.hu x0 x1',      asm.HLV_HU('x0', 'x1')),
+    ('hlv.w x0 x1',       asm.HLV_W('x0', 'x1')),
+    ('hlvx.hu x0 x1',     asm.HLVX_HU('x0', 'x1')),
+    ('hlvx.wu x0 x1',     asm.HLVX_WU('x0', 'x1')),
+    ('hsv.b x0 x1',       asm.HSV_B('x0', 'x1')),
+    ('hsv.h x0 x1',       asm.HSV_H('x0', 'x1')),
+    ('hsv.w x0 x1',       asm.HSV_W('x0', 'x1')),
+    ('sinval.vma x0 x1',  asm.SINVAL_VMA('x0', 'x1')),
+    ('sfence.w.inval',    asm.SFENCE_W_INVAL()),
+    ('sfence.inval.ir',   asm.SFENCE_INVAL_IR()),
+])
+def test_assemble_priv(source, expected):
+    binary = asm.assemble(source)
+    target = struct.pack('<I', expected)
+    assert binary == target