Skip to contentSkip to conversation

lib:sbi: Enhance CSR Handling in system_opcode_insn

PATCH New [email protected] 2 participants 3 messages Jul 18, 2024 – Aug 23, 2024 RISC-V

lore
Share & tools
lore
#0 lore raw

v2 cover lib:sbi: Enhance CSR Handling in system_opcode_insn

From: Dongdong Zhang <[email protected]>

Changes in v2:
- Accepted Vivian's suggestion regarding the funct3 check. The code has been simplified to: if (funct3 == 0 || funct3 == 4) for better clarity and conciseness.

Dongdong Zhang (1):
lib:sbi: Enhance CSR Handling in system_opcode_insn

 include/sbi/riscv_encoding.h | 19 +++++++++++++++++-
 include/sbi/riscv_fp.h       |  1 -
 lib/sbi/sbi_illegal_insn.c   | 37 +++++++++++++++++++++++-------------
 3 files changed, 42 insertions(+), 15 deletions(-)
Signature · 1 line
2.17.1
#1 lore raw

PATCH v2 1/1 lib:sbi: Enhance CSR Handling in system_opcode_insn

From: Dongdong Zhang <[email protected]>

- Completed TODO in system_opcode_insn to ensure CSR read/write instruction handling.
- Refactored to use new macros GET_RS1_NUM and GET_CSR_NUM.
- Updated GET_RM macro and replaced hardcoded funct3 values with constants (CSRRW, CSRRS, CSRRC, etc.).
- Removed redundant GET_RM from riscv_fp.h.
- Improved validation and error handling for CSR instructions.

This patch enhances the clarity and correctness of CSR handling in system_opcode_insn.

---
 include/sbi/riscv_encoding.h | 19 +++++++++++++++++-
 include/sbi/riscv_fp.h       |  1 -
 lib/sbi/sbi_illegal_insn.c   | 37 +++++++++++++++++++++++-------------
 3 files changed, 42 insertions(+), 15 deletions(-)
include/sbi/riscv_encoding.h +18 -1
index 477fa3a..5146654 100644
@@ -947,7 +947,10 @@
 #define REG_PTR(insn, pos, regs)	\
 	(ulong *)((ulong)(regs) + REG_OFFSET(insn, pos))
 
-#define GET_RM(insn)			(((insn) >> 12) & 7)
+#define GET_RM(insn) ((insn & MASK_FUNCT3) >> SHIFT_FUNCT3)
+
+#define GET_RS1_NUM(insn)		((insn & MASK_RS1) >> 15)
+#define GET_CSR_NUM(insn)		((insn & MASK_CSR) >> SHIFT_CSR)
 
 #define GET_RS1(insn, regs)		(*REG_PTR(insn, SH_RS1, regs))
 #define GET_RS2(insn, regs)		(*REG_PTR(insn, SH_RS2, regs))
@@ -959,7 +962,21 @@
 #define IMM_I(insn)			((s32)(insn) >> 20)
 #define IMM_S(insn)			(((s32)(insn) >> 25 << 5) | \
 					 (s32)(((insn) >> 7) & 0x1f))
+
 #define MASK_FUNCT3			0x7000
+#define MASK_RS1			0xf8000
+#define MASK_CSR            0xfff
+
+#define SHIFT_FUNCT3    12
+#define SHIFT_CSR       20
+
+
+#define CSRRW 1
+#define CSRRS 2
+#define CSRRC 3
+#define CSRRWI 5
+#define CSRRSI 6
+#define CSRRCI 7
 
 /* clang-format on */
 
include/sbi/riscv_fp.h +0 -1
index 3141c1c..f523c56 100644
@@ -15,7 +15,6 @@
 #include <sbi/sbi_types.h>
 
 #define GET_PRECISION(insn) (((insn) >> 25) & 3)
-#define GET_RM(insn) (((insn) >> 12) & 7)
 #define PRECISION_S 0
 #define PRECISION_D 1
 
lib/sbi/sbi_illegal_insn.c +24 -13
index ed6f111..e4acf05 100644
@@ -48,9 +48,10 @@ static int misc_mem_opcode_insn(ulong insn, struct sbi_trap_regs *regs)
 
 static int system_opcode_insn(ulong insn, struct sbi_trap_regs *regs)
 {
-	int do_write, rs1_num = (insn >> 15) & 0x1f;
-	ulong rs1_val = GET_RS1(insn, regs);
-	int csr_num   = (u32)insn >> 20;
+	bool do_write	= false;
+	int rs1_num	= GET_RS1_NUM(insn);
+	ulong rs1_val	= GET_RS1(insn, regs);
+	int csr_num	= GET_CSR_NUM((u32)insn);
 	ulong prev_mode = (regs->mstatus & MSTATUS_MPP) >> MSTATUS_MPP_SHIFT;
 	ulong csr_val, new_csr_val;
 
@@ -60,32 +61,42 @@ static int system_opcode_insn(ulong insn, struct sbi_trap_regs *regs)
 		return SBI_EFAIL;
 	}
 
-	/* TODO: Ensure that we got CSR read/write instruction */
+	/* Ensure that we got CSR read/write instruction */
+	int funct3 = GET_RM(insn);
+	if (funct3 == 0 || funct3 == 4) {
+		sbi_printf("%s: Invalid opcode for CSR read/write instruction",
+			   __func__);
+		return truly_illegal_insn(insn, regs);
+	}
 
 	if (sbi_emulate_csr_read(csr_num, regs, &csr_val))
 		return truly_illegal_insn(insn, regs);
 
 	do_write = rs1_num;
-	switch (GET_RM(insn)) {
-	case 1:
+	switch (funct3) {
+	case CSRRW:
 		new_csr_val = rs1_val;
-		do_write    = 1;
+		do_write    = true;
 		break;
-	case 2:
+	case CSRRS:
 		new_csr_val = csr_val | rs1_val;
+		do_write    = (rs1_num != 0);
 		break;
-	case 3:
+	case CSRRC:
 		new_csr_val = csr_val & ~rs1_val;
+		do_write    = (rs1_num != 0);
 		break;
-	case 5:
+	case CSRRWI:
 		new_csr_val = rs1_num;
-		do_write    = 1;
+		do_write    = true;
 		break;
-	case 6:
+	case CSRRSI:
 		new_csr_val = csr_val | rs1_num;
+		do_write    = (rs1_num != 0);
 		break;
-	case 7:
+	case CSRRCI:
 		new_csr_val = csr_val & ~rs1_num;
+		do_write    = (rs1_num != 0);
 		break;
 	default:
 		return truly_illegal_insn(insn, regs);
Signature · 1 line
2.17.1
Applied
#2 lore raw

PATCH v2 1/1 lib:sbi: Enhance CSR Handling in system_opcode_insn

Quoted 26 lines · On Thu, Jul 18, 2024 at 11:14?AM <[email protected]> wrote:

From: Dongdong Zhang <[email protected]>

- Completed TODO in system_opcode_insn to ensure CSR read/write instruction handling.
- Refactored to use new macros GET_RS1_NUM and GET_CSR_NUM.
- Updated GET_RM macro and replaced hardcoded funct3 values with constants (CSRRW, CSRRS, CSRRC, etc.).
- Removed redundant GET_RM from riscv_fp.h.
- Improved validation and error handling for CSR instructions.

This patch enhances the clarity and correctness of CSR handling in system_opcode_insn.

---
 include/sbi/riscv_encoding.h | 19 +++++++++++++++++-
 include/sbi/riscv_fp.h       |  1 -
 lib/sbi/sbi_illegal_insn.c   | 37 +++++++++++++++++++++++-------------
 3 files changed, 42 insertions(+), 15 deletions(-)
include/sbi/riscv_encoding.h +0 -0
index 477fa3a..5146654 100644

include/sbi/riscv_encoding.h line 950

Quoted 5 lines
include/sbi/riscv_encoding.h +1 -1
@@ -947,7 +947,10 @@
 #define REG_PTR(insn, pos, regs)       \
        (ulong *)((ulong)(regs) + REG_OFFSET(insn, pos))
 
-#define GET_RM(insn)                   (((insn) >> 12) & 7)
+#define GET_RM(insn) ((insn & MASK_FUNCT3) >> SHIFT_FUNCT3)

Use tabs for macro alignment

Quoted 7 lines
include/sbi/riscv_encoding.h +3 -0
+
+#define GET_RS1_NUM(insn)              ((insn & MASK_RS1) >> 15)
+#define GET_CSR_NUM(insn)              ((insn & MASK_CSR) >> SHIFT_CSR)
 
 #define GET_RS1(insn, regs)            (*REG_PTR(insn, SH_RS1, regs))
 #define GET_RS2(insn, regs)            (*REG_PTR(insn, SH_RS2, regs))

include/sbi/riscv_encoding.h line 968

Quoted 7 lines
include/sbi/riscv_encoding.h +3 -0
@@ -959,7 +962,21 @@
 #define IMM_I(insn)                    ((s32)(insn) >> 20)
 #define IMM_S(insn)                    (((s32)(insn) >> 25 << 5) | \
                                         (s32)(((insn) >> 7) & 0x1f))
+
 #define MASK_FUNCT3                    0x7000
+#define MASK_RS1                       0xf8000
+#define MASK_CSR            0xfff

This define should be 0xfff00000

include/sbi/riscv_encoding.h line 973

Quoted 5 lines
include/sbi/riscv_encoding.h +5 -0
+
+#define SHIFT_FUNCT3    12
+#define SHIFT_CSR       20
+
+

Redundant newline.

Quoted 46 lines
include/sbi/riscv_encoding.h +6 -0
+#define CSRRW 1
+#define CSRRS 2
+#define CSRRC 3
+#define CSRRWI 5
+#define CSRRSI 6
+#define CSRRCI 7
 
 /* clang-format on */
 
include/sbi/riscv_fp.h +0 -1
index 3141c1c..f523c56 100644
@@ -15,7 +15,6 @@
 #include <sbi/sbi_types.h>
 
 #define GET_PRECISION(insn) (((insn) >> 25) & 3)
-#define GET_RM(insn) (((insn) >> 12) & 7)
 #define PRECISION_S 0
 #define PRECISION_D 1
 
lib/sbi/sbi_illegal_insn.c +6 -4
index ed6f111..e4acf05 100644
@@ -48,9 +48,10 @@ static int misc_mem_opcode_insn(ulong insn, struct sbi_trap_regs *regs)
 
 static int system_opcode_insn(ulong insn, struct sbi_trap_regs *regs)
 {
-       int do_write, rs1_num = (insn >> 15) & 0x1f;
-       ulong rs1_val = GET_RS1(insn, regs);
-       int csr_num   = (u32)insn >> 20;
+       bool do_write   = false;
+       int rs1_num     = GET_RS1_NUM(insn);
+       ulong rs1_val   = GET_RS1(insn, regs);
+       int csr_num     = GET_CSR_NUM((u32)insn);
        ulong prev_mode = (regs->mstatus & MSTATUS_MPP) >> MSTATUS_MPP_SHIFT;
        ulong csr_val, new_csr_val;
 
@@ -60,32 +61,42 @@ static int system_opcode_insn(ulong insn, struct sbi_trap_regs *regs)
                return SBI_EFAIL;
        }
 
-       /* TODO: Ensure that we got CSR read/write instruction */
+       /* Ensure that we got CSR read/write instruction */
+       int funct3 = GET_RM(insn);

lib/sbi/sbi_illegal_insn.c static int system_opcode_insn(ulong insn, struct sbi_trap_regs *regs) · line 75

Quoted 10 lines
lib/sbi/sbi_illegal_insn.c +5 -0
+       if (funct3 == 0 || funct3 == 4) {
+               sbi_printf("%s: Invalid opcode for CSR read/write instruction",
+                          __func__);
+               return truly_illegal_insn(insn, regs);
+       }
 
        if (sbi_emulate_csr_read(csr_num, regs, &csr_val))
                return truly_illegal_insn(insn, regs);
 
        do_write = rs1_num;

No need for this assignment.

Quoted 40 lines
lib/sbi/sbi_illegal_insn.c +13 -10
-       switch (GET_RM(insn)) {
-       case 1:
+       switch (funct3) {
+       case CSRRW:
                new_csr_val = rs1_val;
-               do_write    = 1;
+               do_write    = true;
                break;
-       case 2:
+       case CSRRS:
                new_csr_val = csr_val | rs1_val;
+               do_write    = (rs1_num != 0);
                break;
-       case 3:
+       case CSRRC:
                new_csr_val = csr_val & ~rs1_val;
+               do_write    = (rs1_num != 0);
                break;
-       case 5:
+       case CSRRWI:
                new_csr_val = rs1_num;
-               do_write    = 1;
+               do_write    = true;
                break;
-       case 6:
+       case CSRRSI:
                new_csr_val = csr_val | rs1_num;
+               do_write    = (rs1_num != 0);
                break;
-       case 7:
+       case CSRRCI:
                new_csr_val = csr_val & ~rs1_num;
+               do_write    = (rs1_num != 0);
                break;
        default:
                return truly_illegal_insn(insn, regs);
--

2.17.1

Quoted 4 lines

--
opensbi mailing list
opensbi at lists.infradead.org
http://lists.infradead.org/mailman/listinfo/opensbi

I have addressed the above comments at the time of merging this patch.

Applied this patch to the riscv/opensbi repo.

Thanks,
Anup